qbo_api 2.1.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bdae2e1e7049a7b71c286a5e3b36056a100c89c8fad4a85690b174457f9b1072
-  data.tar.gz: 36baaf4f27090e11b630a620c0b08fe2f531ccd25436a7ea4d5f4156f2d53c12
+  metadata.gz: ccab347179fd3c5d7ec6ae6ab5099be4c7732418f220f30f6dd593e2b670b3e8
+  data.tar.gz: 461041430eaaf924ce437df17173137fe3975cd6849cac73caf7270a66e84885
 SHA512:
-  metadata.gz: c7402792bd0691b386469c65543c729799a5aedd150a4a06e726c50d382cd7342a4215676cbb13b20898f93f1501525c03ea8481627003fd311d6332d828c03a
-  data.tar.gz: f3d4d4ba01db6d69dfccb22c5f4225d0b68e91c5e591384516971154b837aa06b370f822a8dc20f5c859ace71fe4c033bec002b44224505773c208459f44a1f4
+  metadata.gz: 7c78fdb98214a4a0c0eaee625ee7fb2215396bc296cabf2788414716b15137bf2aef79fd213328ddd9e9dfb249aa38ab04c962737126c9667d2ed4cbfcc1c82f
+  data.tar.gz: 4a9bc0e915eff633eeaa89d6fea2ea45c979ad162e8188ebb0458380e9b146668b74af24dc0cbcd44e72b203794c87e82e2116761d9e3919015a5aa6481f2ac1

data/README.md

@@ -372,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.
 
@@ -391,8 +391,8 @@ for how to install ngrok and what it is.
 connection = build_connection('https://oauth.platform.intuit.com', headers: { 'Accept' => 'application/json' }) do |conn|
   conn.basic_auth(client_id, client_secret)
   conn.request :url_encoded # application/x-www-form-urlencoded
-  conn.use FaradayMiddleware::ParseJson, parser_options: { symbolize_names: true }
-  conn.use Faraday::Response::RaiseError
+  conn.response :json
+  conn.use QboApi::RaiseHttpException
 end
 
 raw_response = connection.post do |req|

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

@@ -1,6 +1,8 @@
 require 'faraday'
-require 'faraday_middleware'
+require 'faraday/response/json'
+require 'qbo_api/raise_http_exception'
 require 'faraday/detailed_logger'
+require 'faraday/multipart'
 
 class QboApi
   module Connection
@@ -9,9 +11,10 @@ class QboApi
       headers['Accept'] ||= 'application/json'
       headers['Content-Type'] ||= 'application/json;charset=UTF-8'
       build_connection(url, headers: headers) do |conn|
+        conn.response :json
         add_authorization_middleware(conn)
-        add_exception_middleware(conn)
         conn.request :url_encoded
+        add_exception_middleware(conn)
         add_connection_adapter(conn)
       end
     end
@@ -22,6 +25,7 @@ class QboApi
         'Accept' => 'application/json'
       }
       build_connection(url, headers: headers) do |conn|
+        conn.response :json
         add_authorization_middleware(conn)
         add_exception_middleware(conn)
         conn.request :multipart
@@ -60,21 +64,13 @@ class QboApi
     end
 
     def response(resp, entity: nil)
-      data = parse_response_body(resp)
+      data = resp.body
       entity ? entity_response(data, entity) : data
     rescue => e
       QboApi.logger.debug { "#{LOG_TAG} response parsing error: entity=#{entity.inspect} body=#{resp.body.inspect} exception=#{e.inspect}" }
       data
     end
 
-    def parse_response_body(resp)
-      body = resp.body
-      case resp.headers['Content-Type']
-      when /json/ then JSON.parse(body)
-      else body
-      end
-    end
-
     private
 
     def entity_response(data, entity)
@@ -101,11 +97,14 @@ class QboApi
     end
 
     def add_exception_middleware(conn)
-      conn.use FaradayMiddleware::RaiseHttpException
+      conn.use QboApi::RaiseHttpException
     end
 
+    # Faraday 2 deprecated the FaradayMiddleware gem. Middleware is
+    # now part of Faraday itself, and :authorization can be used to pass
+    # the Bearer token.
     def add_authorization_middleware(conn)
-      conn.request :oauth2, access_token, token_type: 'bearer'
+      conn.request :authorization, access_token, token_type: 'bearer'
     end
 
     def entity_name(entity)

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

@@ -1,32 +1,44 @@
 require 'faraday'
+require 'faraday/response'
 require 'nokogiri'
 # @private
-module FaradayMiddleware
+class QboApi
   # @private
-  class RaiseHttpException < Faraday::Middleware
-    def call(env)
-      @app.call(env).on_complete do |response|
-        case response.status
-        when 200
-        when 400
-          raise QboApi::BadRequest.new(error_message(response))
-        when 401
-          raise QboApi::Unauthorized.new(error_message(response))
-        when 403
-          raise QboApi::Forbidden.new(error_message(response))
-        when 404
-          raise QboApi::NotFound.new(error_message(response))
-        when 429
-          raise QboApi::TooManyRequests.new(error_message(response))
-        when 500
-          raise QboApi::InternalServerError.new(error_message(response))
-        when 502
-          raise QboApi::BadGateway.new({ error_body: response.reason_phrase })
-        when 503
-          raise QboApi::ServiceUnavailable.new(error_message(response))
-        when 504
-          raise QboApi::GatewayTimeout.new(error_message(response))
-        end
+  class RaiseHttpException < Faraday::Response::RaiseError
+    def on_complete(env)
+      case env[:status]
+      when 400
+        raise QboApi::BadRequest.new(error_message(env))
+      when 401
+        raise QboApi::Unauthorized.new(error_message(env))
+      when 403
+        raise QboApi::Forbidden.new(error_message(env))
+      when 404
+        raise QboApi::NotFound.new(error_message(env))
+      when 407
+        # mimic the behavior that we get with proxy requests with HTTPS
+        msg = %(407 "Proxy Authentication Required")
+        raise Faraday::ProxyAuthError.new(msg, response_values(env))
+      when 409
+        raise Faraday::ConflictError, response_values(env)
+      when 422
+        raise Faraday::UnprocessableEntityError, response_values(env)
+      when 429
+        raise QboApi::TooManyRequests.new(error_message(env))
+      when 500
+        raise QboApi::InternalServerError.new(error_message(env))
+      when 502
+        raise QboApi::BadGateway.new({ error_body: env.reason_phrase })
+      when 503
+        raise QboApi::ServiceUnavailable.new(error_message(env))
+      when 504
+        raise QboApi::GatewayTimeout.new(error_message(env))
+      when ClientErrorStatuses
+        raise Faraday::ClientError, response_values(env)
+      when ServerErrorStatuses
+        raise Faraday::ServerError, response_values(env)
+      when nil
+        raise Faraday::NilStatusError, response_values(env)
       end
     end
 
@@ -36,13 +48,13 @@ module FaradayMiddleware
 
     private
 
-    def error_message(response)
+    def error_message(env)
       {
-        method: response.method,
-        url: response.url,
-        status: response.status,
-        error_body: error_body(response.body),
-        intuit_tid: response[:response_headers]['intuit_tid']
+        method: env.method,
+        url: env.url,
+        status: env.status,
+        error_body: error_body(env.body),
+        intuit_tid: env[:response_headers]['intuit_tid']
       }
     end
 

data/lib/qbo_api/version.rb

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

data/qbo_api.gemspec

@@ -25,8 +25,8 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'dotenv'
   spec.add_development_dependency 'vcr'
   spec.add_development_dependency 'amazing_print'
-  spec.add_runtime_dependency 'faraday', '~> 1.10.0'
-  spec.add_runtime_dependency 'faraday_middleware'
+  spec.add_runtime_dependency 'faraday', '>= 1.10.0'
   spec.add_runtime_dependency 'faraday-detailed_logger'
+  spec.add_runtime_dependency 'faraday-multipart'
   spec.add_runtime_dependency 'nokogiri'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: qbo_api
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Christian Pelczarski
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-07-12 00:00:00.000000000 Z
+date: 2023-01-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -112,18 +112,18 @@ dependencies:
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.10.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.10.0
 - !ruby/object:Gem::Dependency
-  name: faraday_middleware
+  name: faraday-detailed_logger
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -137,7 +137,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: faraday-detailed_logger
+  name: faraday-multipart
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="