qbo_api 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d72b41eaf72084c4445833378025cd45c902ad44e5df4c3d3f43e6eb69646c58
-  data.tar.gz: 7b304ea6e41fc62e6d14f5b3bd68ff001cc8ebc1754cad02238ca86ffeba0813
+  metadata.gz: bdae2e1e7049a7b71c286a5e3b36056a100c89c8fad4a85690b174457f9b1072
+  data.tar.gz: 36baaf4f27090e11b630a620c0b08fe2f531ccd25436a7ea4d5f4156f2d53c12
 SHA512:
-  metadata.gz: e6362288c9c1e0d29b8a5f181d9f0b1ede2c2fb09804410a4e1deba35e65517c675c14a1649c2a1c4638ec0bf52ca5f0317244b1881f9654ef4b53aa842d22a4
-  data.tar.gz: 3ff300fae0442f99747d5d4a6cf2f36c97ad036a5fed351ae0447a8e915a5be265aeeedfe13a34e3dd832adf65543fd3f157d1e0d5c738eaa6f3ca4ac683e028
+  metadata.gz: c7402792bd0691b386469c65543c729799a5aedd150a4a06e726c50d382cd7342a4215676cbb13b20898f93f1501525c03ea8481627003fd311d6332d828c03a
+  data.tar.gz: f3d4d4ba01db6d69dfccb22c5f4225d0b68e91c5e591384516971154b837aa06b370f822a8dc20f5c859ace71fe4c033bec002b44224505773c208459f44a1f4

data/.env.test

@@ -1,6 +1,2 @@
-export QBO_API_CONSUMER_KEY=
-export QBO_API_CONSUMER_SECRET=
 export QBO_API_ACCESS_TOKEN=
-export QBO_API_ACCESS_TOKEN_SECRET=
-export QBO_API_OAUTH2_ACCESS_TOKEN=
 export QBO_API_COMPANY_ID=12345

data/.travis.yml

@@ -1,9 +1,9 @@
 sudo: false
 language: ruby
 rvm:
-  - 2.5.7
-  - 2.6.6
-  - 2.7.1
+  - 2.6.8
+  - 2.7.4
+  - 3.0.2
 
 before_install:
   - gem install bundler

data/README.md

@@ -13,7 +13,7 @@ Ruby client for the QuickBooks Online API version 3.
 </a>
 
 
-## Ruby >= 2.5 required
+## Ruby >= 2.6 required
 
 ## Installation
 
@@ -91,7 +91,6 @@ QboApi.minor_version = 8
   # Works with .get, .create, .update, .query methods
 ```
 
-
 ### Create
 ```ruby
   invoice = {
@@ -163,6 +162,40 @@ QboApi.minor_version = 8
   p response.size # => 28
 ```
 
+### 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|
+    p "#{c['Id']} #{c['DisplayName']}"
+  end
+
+  # retrieves all active or inactive employees
+  qbo_api.all(:employees, inactive: true).each do |e|
+    p "#{e['Id']} #{e['DisplayName']}"
+  end
+
+  # retrieves all vendors by groups of 5
+  qbo_api.all(:vendor, max: 5).each do |v|
+    p v['DisplayName']
+  end
+
+  # retrieves all customers by groups of 2 using a custom select query
+  where = "WHERE Id IN ('5', '6', '7', '8', '9', '10')"
+  qbo_api.all(:customer, max: 2, select: "SELECT * FROM Customer #{where}").each do |c|
+    p c['DisplayName']
+  end
+```
+
+#### Note: .all() returns a Ruby Enumerator
+
+```
+api.all(:clients).take(50).each { |c| p c["Id"] }
+api.all(:clients).count
+api.all(:clients).first
+api.all(:clients).to_a
+```
+
 ### Search with irregular characters
 ```ruby
   # Use the .esc() method
@@ -173,6 +206,12 @@ QboApi.minor_version = 8
   p response['Id'] # => 1
 ```
 
+
+### Email a transaction entity
+```ruby
+api.send_invoice(invoice_id: 1, email_address: 'billy@joe.com')
+```
+
 ### Uploading an attachment
 ```ruby
   payload = {"AttachableRef":
@@ -282,31 +321,6 @@ See [docs](https://developer.intuit.com/docs/0100_quickbooks_online/0100_essenti
   end
 ```
 
-### 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|
-    p "#{c['Id']} #{c['DisplayName']}"
-  end
-
-  # retrieves all active or inactive employees
-  qbo_api.all(:employees, inactive: true).each do |e|
-    p "#{e['Id']} #{e['DisplayName']}"
-  end
-
-  # retrieves all vendors by groups of 5
-  qbo_api.all(:vendor, max: 5).each do |v|
-    p v['DisplayName']
-  end
-
-  # retrieves all customers by groups of 2 using a custom select query
-  where = "WHERE Id IN ('5', '6', '7', '8', '9', '10')"
-  qbo_api.all(:customer, max: 2, select: "SELECT * FROM Customer #{where}").each do |c|
-    p c['DisplayName']
-  end
-```
-
 ### What kind of QuickBooks entity?
 ```ruby
   p qbo_api.is_transaction_entity?(:invoice) # => true

data/lib/qbo_api/connection.rb

@@ -37,14 +37,17 @@ class QboApi
       }
     end
 
-    def request(method, path:, entity: nil, payload: nil, params: nil)
-      raw_response = raw_request(method, conn: connection, path: path, params: params, payload: payload)
+    def request(method, path:, entity: nil, payload: nil, params: nil, headers: nil)
+      raw_response = raw_request(method, conn: connection, path: path, params: params, payload: payload, headers: headers)
       response(raw_response, entity: entity)
     end
 
-    def raw_request(method, conn:, path:, payload: nil, params: nil)
+    def raw_request(method, conn:, path:, payload: nil, params: nil, headers: nil)
       path = finalize_path(path, method: method, params: params)
+
       conn.public_send(method) do |req|
+        req.headers = headers if headers
+
         case method
         when :get, :delete
           req.url path

data/lib/qbo_api/supporting.rb

@@ -16,5 +16,20 @@ class QboApi
       path = add_params_to_path(path: path, params: params) if params
       request(:get, path: path)
     end
+
+    def deliver(entity, entity_id:, email_address: nil)
+      valid_entities = %i(invoice estimate purchaseorder creditmemo salesreceipt refundreceipt)
+      unless valid_entities.include?(entity.to_sym)
+        raise ArgumentError, "Invalid entity type '#{entity}'. Must be one of: #{valid_entities.join(', ')}"
+      end
+
+      path = "#{realm_id}/#{entity}/#{entity_id}/send"
+      unless email_address.nil?
+        params = { minorversion: 63, sendTo: email_address }
+        path = add_params_to_path(path: path, params: params)
+      end
+      headers = { 'Content-Type' => 'application/octet-stream' }
+      request(:post, path: path, headers: headers)
+    end
   end
 end

data/lib/qbo_api/version.rb

@@ -1,3 +1,3 @@
 class QboApi
-  VERSION = "2.0.0"
+  VERSION = "2.1.0"
 end

data/qbo_api.gemspec

@@ -22,11 +22,10 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec"
   spec.add_development_dependency 'webmock'
-  spec.add_development_dependency 'simple_oauth'
   spec.add_development_dependency 'dotenv'
   spec.add_development_dependency 'vcr'
   spec.add_development_dependency 'amazing_print'
-  spec.add_runtime_dependency 'faraday'
+  spec.add_runtime_dependency 'faraday', '~> 1.10.0'
   spec.add_runtime_dependency 'faraday_middleware'
   spec.add_runtime_dependency 'faraday-detailed_logger'
   spec.add_runtime_dependency 'nokogiri'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: qbo_api
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Christian Pelczarski
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-12-18 00:00:00.000000000 Z
+date: 2022-07-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -66,20 +66,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: simple_oauth
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: dotenv
   requirement: !ruby/object:Gem::Requirement
@@ -126,16 +112,16 @@ dependencies:
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.10.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.10.0
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
   requirement: !ruby/object:Gem::Requirement
@@ -233,7 +219,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.2.22
 signing_key:
 specification_version: 4
 summary: Ruby JSON-only client for QuickBooks Online API v3. Built on top of the Faraday