qbo_api 1.6.2 → 1.6.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a0ccc44f499b0c5078b99f8eea04d58ee52f8094
-  data.tar.gz: 87980a9894552ed9bae5ffbe320d63f2ab2e96bd
+  metadata.gz: 3025022857f508d3f6522d3ab13c2d0237e6ac67
+  data.tar.gz: b264a7c95043b9337b94075b315c7fc74be3f72b
 SHA512:
-  metadata.gz: e57bc51406e94051033b1d01baba6e70eb9c56ff96e9cfd7677adc5826f70d69fd48641e159fd7ba0f1094822eb44e0733c54fd9aee0f64d4a60a19315648345
-  data.tar.gz: cea01f2127b4974417dffa7f95a4fdcf134d144b228642fa2c327e359f74df191114902ff8e78f5b880fdc772e3b24f70f83d70d1256c57469f87b92bff3b69d
+  metadata.gz: d9831b0aab6fd731849cb16dad761d5f4e1ef81f5494342af591edea5fa965133034d3b61b18d10e63df80100f08a72e7c3294887973dcd8d5adad4b426fc78c
+  data.tar.gz: 7ff2bba02f51e0cdce47086208a13e7d2f5a65e64cf9ed60ff24613fef0477f0dce092e12493522b1cbb2a2683a4597407045cfd52699d31d8ec19249fadf450

data/README.md

@@ -156,17 +156,40 @@ QboApi.minor_version = 8
   p response['Active'] # => false
 ```
 
-### Search with irregular characters
-```ruby
-  name = qbo_api.esc "Amy's Bird Sanctuary"
-  response = qbo_api.query(%{SELECT * FROM Customer WHERE DisplayName = '#{name}'})
-```
 ### Get an entity by its id
 ```ruby
   response = qbo_api.get(:customer, 5)
   p response['DisplayName'] # => "Dukes Basketball Camp"
 ```
 
+### Get an entity by one its Filter attributes
+```ruby
+  response = qbo_api.get(:customer, ["DisplayName", "Dukes Basketball Camp"])
+  p response['Id'] # => 5
+```
+
+### Get an entity by one its Filter attributes using a LIKE search
+```ruby
+  response = qbo_api.get(:customer, ["DisplayName", "LIKE", "Dukes%"])
+  p response['Id'] # => 5
+```
+
+### Get an entity by one its Filter attributes using a IN search
+```ruby
+  response = qbo_api.get(:vendor, ["DisplayName", "IN", "(true, false)"])
+  p response.size # => 28
+```
+
+### Search with irregular characters
+```ruby
+  # Use the .esc() method
+  name = qbo_api.esc "Amy's Bird Sanctuary"
+  response = qbo_api.query(%{SELECT * FROM Customer WHERE DisplayName = '#{name}'})
+  # OR USE .get() method, which will automatically escape
+  response = qbo_api.get(:customer, ["DisplayName", "Amy's Bird Sanctuary"])
+  p response['Id'] # => 1
+```
+
 ### Uploading an attachment
 ```ruby
   payload = {"AttachableRef":
@@ -277,6 +300,7 @@ See [docs](https://developer.intuit.com/docs/0100_quickbooks_online/0100_essenti
 ```
 
 ### Import/retrieve all
+*Note: There is some overlap with the `all` and the `get` methods. The `get` method is limited to 1000 results where the `all` method will return all the results no matter the number.*
 ```ruby
   # retrieves all active customers
   qbo_api.all(:customers).each do |c|

data/lib/qbo_api.rb

@@ -15,6 +15,8 @@ require_relative 'qbo_api/util'
 require_relative 'qbo_api/attachment'
 require_relative 'qbo_api/setter'
 require_relative 'qbo_api/builder'
+require_relative 'qbo_api/finder'
+require_relative 'qbo_api/all'
 
 class QboApi
   extend Configuration
@@ -24,6 +26,8 @@ class QboApi
   include Attachment
   include Setter
   include Builder
+  include Finder
+  include All
 
   attr_reader :realm_id
 
@@ -64,17 +68,6 @@ class QboApi
     end
   end
 
-  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, params: params)
-  end
-
-  def get(entity, id, params: nil)
-    path = "#{entity_path(entity)}/#{id}"
-    request(:get, entity: entity, path: path, params: params)
-  end
-
   def create(entity, payload:, params: nil)
     request(:post, entity: entity, path: entity_path(entity), payload: payload, params: params)
   end
@@ -110,16 +103,6 @@ class QboApi
     request(:get, path: path)
   end
 
-  def all(entity, max: 1000, select: nil, inactive: false, &block)
-    enumerator = create_all_enumerator(entity, max: max, select: select, inactive: inactive)
-
-    if block_given?
-      enumerator.each(&block)
-    else
-      enumerator
-    end
-  end
-
   def request(method, path:, entity: nil, payload: nil, params: nil)
     raw_response = connection.send(method) do |req|
       path = finalize_path(path, method: method, params: params)
@@ -148,20 +131,6 @@ class QboApi
 
   private
 
-  def create_all_enumerator(entity, max: 1000, select: nil, inactive: false)
-    Enumerator.new do |enum_yielder|
-      select = build_all_query(entity, select: select, inactive: inactive)
-      pos = 0
-      begin
-        pos = pos == 0 ? pos + 1 : pos + max
-        results = query("#{select} MAXRESULTS #{max} STARTPOSITION #{pos}")
-        results.each do |entry|
-          enum_yielder.yield(entry)
-        end if results
-      end while (results ? results.size == max : false)
-    end
-  end
-
   def entity_response(data, entity)
     if qr = data['QueryResponse']
       qr.empty? ? nil : qr.fetch(singular(entity))

data/lib/qbo_api/all.rb

@@ -0,0 +1,31 @@
+class QboApi
+  module All
+
+    def all(entity, max: 1000, select: nil, inactive: false, &block)
+      enumerator = create_all_enumerator(entity, max: max, select: select, inactive: inactive)
+
+      if block_given?
+        enumerator.each(&block)
+      else
+        enumerator
+      end
+    end
+
+    private
+
+    def create_all_enumerator(entity, max: 1000, select: nil, inactive: false)
+      Enumerator.new do |enum_yielder|
+        select = build_all_query(entity, select: select, inactive: inactive)
+        pos = 0
+        begin
+          pos = pos == 0 ? pos + 1 : pos + max
+          results = query("#{select} MAXRESULTS #{max} STARTPOSITION #{pos}")
+          results.each do |entry|
+            enum_yielder.yield(entry)
+          end if results
+        end while (results ? results.size == max : false)
+      end
+    end
+
+  end
+end

data/lib/qbo_api/finder.rb

@@ -0,0 +1,47 @@
+class QboApi
+  module Finder
+
+    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, params: params)
+    end
+    
+    def get(entity, type, params: nil)
+      if type.is_a?(Array)
+        query_str = get_query_str(entity, type)
+        if resp = query(query_str, params: params)
+          resp.size == 1 ? resp[0] : resp
+        else
+          false
+        end
+      else
+        path = "#{entity_path(entity)}/#{type}"
+        request(:get, entity: entity, path: path, params: params)
+      end
+    end
+
+    def to_quote_or_not(str)
+      inside_parens_regex = '\(.*\)'
+      if str.match(/^(#{inside_parens_regex}|true|false|CURRENT_DATE)$/)
+        str
+      else
+        %{'#{esc(str)}'}
+      end
+    end
+
+    private
+
+    def get_query_str(entity, type)
+      if type.size == 2
+        operator = '='
+        value = type[1]
+      else
+        operator = type[1]
+        value = type[2]
+      end
+      "SELECT * FROM #{singular(entity)} WHERE #{type[0]} #{operator} #{to_quote_or_not(value)}" 
+    end
+
+  end
+end

data/lib/qbo_api/version.rb

@@ -1,3 +1,3 @@
 class QboApi
-  VERSION = "1.6.2"
+  VERSION = "1.6.5"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: qbo_api
 version: !ruby/object:Gem::Version
-  version: 1.6.2
+  version: 1.6.5
 platform: ruby
 authors:
 - Christian Pelczarski
@@ -269,11 +269,13 @@ files:
 - example/views/oauth2.erb
 - example/views/oauth2_redirect.erb
 - lib/qbo_api.rb
+- lib/qbo_api/all.rb
 - lib/qbo_api/attachment.rb
 - lib/qbo_api/builder.rb
 - lib/qbo_api/configuration.rb
 - lib/qbo_api/entity.rb
 - lib/qbo_api/error.rb
+- lib/qbo_api/finder.rb
 - lib/qbo_api/raise_http_exception.rb
 - lib/qbo_api/setter.rb
 - lib/qbo_api/supporting.rb