qbo_api 2.0.1 → 2.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 922f5a2dd0bb1020d9366c1a993686aa5febdb50e54a5b4c2a6160e572612def
-  data.tar.gz: '032848b350e352d8edaf376cd49b41fbaae20bccf902473d775e90c513fc0ff5'
+  metadata.gz: a9e249e7e48339a74b585f7afd97711407c8b814c0670e417b4792b465e59515
+  data.tar.gz: ef17013bf8fd40513f0f4ddb7ffa9653baa2b686f7091a1ba82a8f0cfb79e9ed
 SHA512:
-  metadata.gz: c4f17dcf8f2fe0680c34dbb8cf9c864d7d42887f291a968023e1538902a8460cc13d968f669777b53efbc21000d1db44b6e78d21ad8619514dd62c7c0375ba10
-  data.tar.gz: f2d7a86d02a465e6cc9ce8de0110c250c0e500a5d02b7e0cbc402e3cae37ae11832592ecef08d6c58de8735fd0081fbc8adae277efff3698416fc40da4d02274
+  metadata.gz: c31a1c1e627e8f1677323d74e959bb377338984c8cd73c49ebdb95253a97986e7634e20ced251a67e18321bda1827d67e759add75dece2bcb052b2411132bcba
+  data.tar.gz: b8c46643f89b9be3e285dd4d8e9bf030af7b75b3872e21937afc6d0c5bfbe59c23038e9bc4431f1efa762888f408d240dd0149c4035f9e19a35ee63c1dbf2847

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/README.md

@@ -206,6 +206,12 @@ api.all(:clients).to_a
   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":
@@ -366,8 +372,8 @@ for how to install ngrok and what it is.
   Add the token to your .env as QBO_API_VERIFIER_TOKEN
 
 - In another tab, create a customer via the API:
-  `bundle exec ruby -rqbo_api -rdotenv -e 'Dotenv.load; p QboApi.new(access_token: ENV.fetch("QBO_API_OAUTH2_ACCESS_TOKEN"), realm_id: ENV.fetch("QBO_API_COMPANY_ID")).create(:customer, payload: { DisplayName: "TestCustomer" })'`
-  (You'll also need to have added the QBO_API_COMPANY_ID and QBO_API_OAUTH2_ACCESS_TOKEN to your .env)
+  `bundle exec ruby -rqbo_api -rdotenv -e 'Dotenv.load; p QboApi.new(access_token: ENV.fetch("QBO_API_ACCESS_TOKEN"), realm_id: ENV.fetch("QBO_API_COMPANY_ID")).create(:customer, payload: { DisplayName: "TestCustomer" })'`
+  (You'll also need to have added the QBO_API_COMPANY_ID and QBO_API_ACCESS_TOKEN to your .env)
 
   There could be a delay of up to a minute before the webhook fires.
 

data/example/base.rb

@@ -3,6 +3,7 @@ BASE_GEMS = proc do
   # This app
   gem 'sinatra'
   gem 'sinatra-contrib'
+  gem 'puma'
 
   # Creds from ../.env
   gem 'dotenv'

data/lib/qbo_api/api_methods.rb

@@ -58,6 +58,14 @@ class QboApi
       request(:post, entity: entity, path: entity_path(entity), payload: payload)
     end
 
+    def void(entity, id:)
+      err_msg = "Void is only for voidable transaction entities. Use .delete or .deactivate instead"
+      raise QboApi::NotImplementedError.new, err_msg unless is_voidable_transaction_entity?(entity)
+      path = add_params_to_path(path: entity_path(entity), params: { operation: :void })
+      payload = set_update(entity, id)
+      request(:post, entity: entity, path: path, payload: payload)
+    end
+
     private
 
     def get_query_str(entity, query_filter_args)

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/entity.rb

@@ -20,6 +20,19 @@ class QboApi
       sym.to_s.split('_').collect(&:capitalize).join
     end
 
+    def is_voidable_transaction_entity?(entity)
+      voidable_transaction_entities.include?(singular(entity))
+    end
+
+    def voidable_transaction_entities
+      %w{
+        BillPayment
+        Invoice
+        Payment
+        SalesReceipt
+      }
+    end
+
     def is_transaction_entity?(entity)
       transaction_entities.include?(singular(entity))
     end

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.1"
+  VERSION = "2.1.1"
 end

data/qbo_api.gemspec

@@ -22,12 +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 'rexml'
-  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.1
+  version: 2.1.1
 platform: ruby
 authors:
 - Christian Pelczarski
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-10-02 00:00:00.000000000 Z
+date: 2022-09-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -66,34 +66,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: rexml
-  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: 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
@@ -140,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
@@ -247,7 +219,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+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