Introduce ActiveRecord like methods to Quickbooks Models #330
Conversation
…customer defined variable.
|
|
||
| # where | ||
| Quickbooks::Model::Customer.where('') #=> runs default query and returns first 20 customers | ||
| Quickbooks::Model::Customer.where(id: 170) #=> runs a conditional query and returns first 20 customers having id equal to 170 |
There was a problem hiding this comment.
This doesn't seem like a great example because you shouldn't have multiple customers with the same id.
| # where | ||
| Quickbooks::Model::Customer.where('') #=> runs default query and returns first 20 customers | ||
| Quickbooks::Model::Customer.where(id: 170) #=> runs a conditional query and returns first 20 customers having id equal to 170 | ||
| Quickbooks::Model::Customer.where(id: 170, skip_pagination: true) #=> runs the conditional query and returns all customers having id equal to 170 without pagination |
There was a problem hiding this comment.
Same here, would be better to use a more realistic value to demonstrate the filtering. I'm not clear what "without pagination" means? The pagination will happen behind inside that method call right?
| The general approach is you first instantiate a `Service` object based on the entity you would like to retrieve. Lets retrieve a list of Customers: | ||
| There are two approaches to retrieve results from Quickbooks. However, you're encouraged to use the first approach as we'll be removing the second approach in the long run. | ||
|
|
||
| ###### Approach 1 |
There was a problem hiding this comment.
This seems like it should be a heading level 3, e.g. ###
| end | ||
|
|
||
| def find_by(options = {}) | ||
| where(options).first |
There was a problem hiding this comment.
seems like this should do a limit 1 to avoid fetching and parsing records that aren't used.
| end | ||
|
|
||
| def first | ||
| all.first |
There was a problem hiding this comment.
should this really be calling all? seems wasteful if you just want one record
| end | ||
|
|
||
| module ClassMethods | ||
| def all(query = nil, options = {}) |
There was a problem hiding this comment.
i'm not sure this quite matches up with active record: http://api.rubyonrails.org/classes/ActiveRecord/Scoping/Named/ClassMethods.html#method-i-all
This PR is an improvement to previous PR that was merged but then reverted because of an issue. The previous PR is #264
all, where, find_by, find, count, save, firstmethods to quickbooks models. This change eliminates the requirement of using services to query something from Quickbooks. You can directly callQuickbooks::Models::Invoice.allto get all the invoices.Another settingallow_paginationis introduced in this PR. This is a boolean setting which is set totrueby default. If user sets this setting tofalsethen no pagination will be applied and all the records will be returned on any query.allow_paginationhas been removed which I introduced in my last commit. Instead of that, I've introduced another option to skip pagination on each request basis i.e.skip_pagination. This setting will be available in both the conventional query method and the new methods introduced in this PR.README.mdfile.