qbo_api 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 93e327269409bb7956e548ad03f37dd9a39d2bcd
-  data.tar.gz: 6aed50f15871f495593fc3818bc545e6e99d613e
+  metadata.gz: 4e13df877cf63f1959afcef602f250f85f16c73f
+  data.tar.gz: cffab533c3c65f5db86830a721341b2680cafac9
 SHA512:
-  metadata.gz: 9cba0e85a274833fb6a27c859a9201803c0c2bc47243a5baca9c671be31c41820d356afd7c8616121f12ca4165e4a9389ef818c887bbd521ec69230695b38b55
-  data.tar.gz: 0c3eae6343927f9cec48061cb8b4a1281c26933b6aff6bccfa674f2222685ce62bf3d60c8bc7c1421335dd14a2737b905c0a094e1eab67a297cdb112f64cf048
+  metadata.gz: 95c7b44ab0590fbc503f9b38dbd1d7b34cb46319ff932b7954de8803b275a05b4f3a62e776e7d18e11b472d0aba2460cd6e641459c7c43136395760e06c97daa
+  data.tar.gz: c758d9dfabd28aa45bed53da9deadb18ae942246c80ca267fa98e12765723a6ab40c821a57f29dccd9a95c5057bd3fb1bdc4dd89d804b4e95cc092bf03c6bed4

data/README.md

@@ -71,10 +71,25 @@ QboApi.log = true
 ```ruby
 QboApi.logger = Rails.logger
 ```
-- To run all create, modify, and delete requests with unique [RequestIds](https://developer.intuit.com/hub/blog/2015/04/06/15346).
+- To run all requests with unique [RequestIds](https://developer.intuit.com/hub/blog/2015/04/06/15346).
 ```ruby
 QboApi.request_id = true
 ```
+- To run individual requests with a RequestId then do something like this:
+```ruby
+  resp = qbo_api.create(:bill, payload: bill_hash, params: { requestid: qbo_api.uuid })
+  # Works with .get, .create, .update, .query methods
+```
+- To run all requests with a [Minor version](https://developer.intuit.com/docs/0100_quickbooks_online/0200_dev_guides/accounting/minor_versions).
+```ruby
+QboApi.minor_version = 8
+```
+- To run individual requests with a minor version then do something like this:
+```ruby
+  resp = qbo_api.get(:item, 8, params: { minorversion: 8 })
+  # Works with .get, .create, .update, .query methods
+```
+
 
 ### Create
 ```ruby

data/lib/qbo_api.rb

@@ -50,24 +50,24 @@ class QboApi
     end
   end
 
-  def query(query)
+  def query(query, params: nil)
     path = "#{realm_id}/query?query=#{CGI.escape(query)}"
     entity = extract_entity_from_query(query, to_sym: true)
-    request(:get, entity: entity, path: path)
+    request(:get, entity: entity, path: path, params: params)
   end
 
-  def get(entity, id)
+  def get(entity, id, params: nil)
     path = "#{entity_path(entity)}/#{id}"
-    request(:get, entity: entity, path: path)
+    request(:get, entity: entity, path: path, params: params)
   end
 
-  def create(entity, payload:)
-    request(:post, entity: entity, path: entity_path(entity), payload: payload)
+  def create(entity, payload:, params: nil)
+    request(:post, entity: entity, path: entity_path(entity), payload: payload, params: params)
   end
 
-  def update(entity, id:, payload:)
+  def update(entity, id:, payload:, params: nil)
     payload.merge!(set_update(entity, id))
-    request(:post, entity: entity, path: entity_path(entity), payload: payload)
+    request(:post, entity: entity, path: entity_path(entity), payload: payload, params: params)
   end
 
   def delete(entity, id:)
@@ -109,13 +109,14 @@ class QboApi
     end while (results ? results.size == max : false)
   end
 
-  def request(method, path:, entity: nil, payload: nil)
+  def request(method, path:, entity: nil, payload: nil, params: nil)
     raw_response = connection.send(method) do |req|
+      path = finalize_path(path, params: params)
       case method
       when :get, :delete
         req.url path
       when :post, :put
-        req.url add_request_id_to(path)
+        req.url path
         req.body = JSON.generate(payload)
       end
     end

data/lib/qbo_api/configuration.rb

@@ -32,5 +32,13 @@ class QboApi
     def request_id=(value)
       @request_id = value
     end
+
+    def minor_version
+      @minor_version ||= false
+    end
+
+    def minor_version=(value)
+      @minor_version = value
+    end
   end
 end

data/lib/qbo_api/util.rb

@@ -17,6 +17,13 @@ class QboApi
       SecureRandom.uuid
     end
 
+    def finalize_path(path, params: nil)
+      path = add_request_id_to(path)
+      path = add_minor_version_to(path)
+      path = add_params_to_path(path: path, params: params) if params
+      path
+    end
+
     def add_request_id_to(path)
       if QboApi.request_id
         add_params_to_path(path: path, params: { "requestid" => uuid })
@@ -25,6 +32,14 @@ class QboApi
       end
     end
 
+    def add_minor_version_to(path)
+      if minor_version = QboApi.minor_version
+        add_params_to_path(path: path, params: { "minorversion" => minor_version })
+      else
+        path
+      end
+    end
+
     def add_params_to_path(path:, params:)
       uri = URI.parse(path)
       params.each do |p|

data/lib/qbo_api/version.rb

@@ -1,3 +1,3 @@
 class QboApi
-  VERSION = "1.3.0"
+  VERSION = "1.4.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: qbo_api
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Christian Pelczarski
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-10-28 00:00:00.000000000 Z
+date: 2016-12-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler