Module: Quickbooks::Service::ServiceCrud
- Included in:
- BaseService
- Defined in:
- lib/quickbooks/service/service_crud.rb
Instance Method Summary collapse
-
#all(object_query = nil, options = {}) ⇒ Object
fetch all records, returns an array of models.
- #create(entity, options = {}) ⇒ Object (also: #update)
- #delete(entity) ⇒ Object
- #delete_by_query_string(entity, options = {}) ⇒ Object
- #exists?(field, selector, options = {}) ⇒ Boolean
- #fetch_by_id(id, params = {}) ⇒ Object
- #find_by(field, selector, options = {}) ⇒ Object
- #query(object_query = nil, options = {}) ⇒ Object
- #query_in_batches(object_query = nil, options = {}) ⇒ Object
Instance Method Details
#all(object_query = nil, options = {}) ⇒ Object
fetch all records, returns an array of models
10 11 12 13 14 15 16 |
# File 'lib/quickbooks/service/service_crud.rb', line 10 def all(object_query=nil, ={}) collection = [] self.query_in_batches(object_query, ) do |batch| collection << batch.entries end collection.flatten end |
#create(entity, options = {}) ⇒ Object Also known as: update
48 49 50 51 52 53 54 55 56 57 58 |
# File 'lib/quickbooks/service/service_crud.rb', line 48 def create(entity, = {}) raise Quickbooks::InvalidModelException.new(entity.errors..join(',')) unless entity.valid? xml = entity.to_xml_ns() response = do_http_post(url_for_resource(model.resource_for_singular), valid_xml_document(xml), [:query]) if response.code.to_i == 200 model.from_xml(parse_singular_entity_response(model, response.plain_body)) else nil end end |
#delete(entity) ⇒ Object
61 62 63 |
# File 'lib/quickbooks/service/service_crud.rb', line 61 def delete(entity) raise NotImplementedError end |
#delete_by_query_string(entity, options = {}) ⇒ Object
65 66 67 68 69 70 71 72 73 74 75 |
# File 'lib/quickbooks/service/service_crud.rb', line 65 def delete_by_query_string(entity, = {}) url = "#{url_for_resource(model::REST_RESOURCE)}?operation=delete" xml = entity.to_xml_ns() response = do_http_post(url, valid_xml_document(xml)) if response.code.to_i == 200 parse_singular_entity_response_for_delete(model, response.plain_body) else false end end |
#exists?(field, selector, options = {}) ⇒ Boolean
28 29 30 |
# File 'lib/quickbooks/service/service_crud.rb', line 28 def exists?(field, selector, ={}) find_by(field, selector, ).count > 0 end |
#fetch_by_id(id, params = {}) ⇒ Object
43 44 45 46 |
# File 'lib/quickbooks/service/service_crud.rb', line 43 def fetch_by_id(id, params = {}) url = "#{url_for_resource(model.resource_for_singular)}/#{id}" fetch_object(model, url, params) end |
#find_by(field, selector, options = {}) ⇒ Object
32 33 34 35 36 37 38 39 40 41 |
# File 'lib/quickbooks/service/service_crud.rb', line 32 def find_by(field, selector, ={}) if field.class == Symbol field = field.to_s.camelcase end clause = Quickbooks::Util::QueryBuilder.new.clause(field, '=', selector) q = "select * from %s where %s" % [model.resource_for_singular, clause] self.query(q, ) end |
#query(object_query = nil, options = {}) ⇒ Object
5 6 7 |
# File 'lib/quickbooks/service/service_crud.rb', line 5 def query(object_query = nil, = {}) fetch_collection(object_query, model, ) end |
#query_in_batches(object_query = nil, options = {}) ⇒ Object
18 19 20 21 22 23 24 25 26 |
# File 'lib/quickbooks/service/service_crud.rb', line 18 def query_in_batches(object_query=nil, ={}) page = 0 per_page = .delete(:per_page) || 1_000 begin page += 1 results = query(object_query, page: page, per_page: per_page) yield results if results.count > 0 end until results.count < per_page end |