qbo_api 2.0.1 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 922f5a2dd0bb1020d9366c1a993686aa5febdb50e54a5b4c2a6160e572612def
-  data.tar.gz: '032848b350e352d8edaf376cd49b41fbaae20bccf902473d775e90c513fc0ff5'
+  metadata.gz: bdae2e1e7049a7b71c286a5e3b36056a100c89c8fad4a85690b174457f9b1072
+  data.tar.gz: 36baaf4f27090e11b630a620c0b08fe2f531ccd25436a7ea4d5f4156f2d53c12
 SHA512:
-  metadata.gz: c4f17dcf8f2fe0680c34dbb8cf9c864d7d42887f291a968023e1538902a8460cc13d968f669777b53efbc21000d1db44b6e78d21ad8619514dd62c7c0375ba10
-  data.tar.gz: f2d7a86d02a465e6cc9ce8de0110c250c0e500a5d02b7e0cbc402e3cae37ae11832592ecef08d6c58de8735fd0081fbc8adae277efff3698416fc40da4d02274
+  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/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":

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.1"
+  VERSION = "2.1.0"
 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.0
 platform: ruby
 authors:
 - Christian Pelczarski
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-10-02 00:00:00.000000000 Z
+date: 2022-07-12 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