qbo_api 1.8.0 → 1.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4c9489158fdcc87c75c395c4e51c4f6faa6850c5
-  data.tar.gz: a4ed41891faaa78efd78a540937b0e444287e88e
+  metadata.gz: 67f39d1f93ec40aaaf360187cd576f68d9cc5c06
+  data.tar.gz: 37b06114ee6d7f18b4fd18fc795804ed252d0176
 SHA512:
-  metadata.gz: 8f35f5150430bab828dc43853cd2640fd81ec1ce175e08600e286489abf79e85f9939e1cebde2ae825874865cd343b312f0b5d94d7e0e8d9be837301ccc16347
-  data.tar.gz: a58e610b9fef2f7f0756534b1898549beb66df6dabc955d75c349db6c391f17b33844fb9ece8b7c9c431d3eddf4178e7f9147ec4cd438d0af3f8edaa1d284768
+  metadata.gz: 11d28f4225f8565b01dc097cc602a77f2249d54879204536a9372fc67b0a344110c9da63323605c6e7703fa90ac9714bcd4d947fc653879268b3f88743fc5d82
+  data.tar.gz: 172082e7b1e7772eae2d5450ec9e726a37178fc5c3ff357ba6fd9a0facc953177ac758568094f5e41c53ceb70b8ea942038ecacf5da6eb38d8be79b8de308ea3

data/lib/qbo_api.rb

@@ -22,42 +22,46 @@ class QboApi
   include Attachment
   include ApiMethods
 
-  attr_reader :realm_id
+  attr_accessor :realm_id
+  attr_accessor :endpoint
 
-  REQUEST_TOKEN_URL          = 'https://oauth.intuit.com/oauth/v1/get_request_token'
-  ACCESS_TOKEN_URL           = 'https://oauth.intuit.com/oauth/v1/get_access_token'
-  APP_CENTER_BASE            = 'https://appcenter.intuit.com'
-  APP_CENTER_URL             =  APP_CENTER_BASE + '/Connect/Begin?oauth_token='
   V3_ENDPOINT_BASE_URL       = 'https://sandbox-quickbooks.api.intuit.com/v3/company/'
   PAYMENTS_API_BASE_URL      = 'https://sandbox.api.intuit.com/quickbooks/v4/payments'
-  APP_CONNECTION_URL         = APP_CENTER_BASE + '/api/v1/connection'
   LOG_TAG = "[QuickBooks]"
 
-  def initialize(token: nil, token_secret: nil, access_token: nil, realm_id:,
-                 consumer_key: nil, consumer_secret: nil, endpoint: :accounting)
-    @consumer_key = consumer_key || (defined?(CONSUMER_KEY) ? CONSUMER_KEY : nil)
-    @consumer_secret = consumer_secret || (defined?(CONSUMER_SECRET) ? CONSUMER_SECRET : nil)
-    @token = token
-    @token_secret = token_secret
-    @access_token = access_token
-    @realm_id = realm_id
-    @endpoint = endpoint
+  # @param attributes [Hash<Symbol,String>]
+  def initialize(attributes = {})
+    raise ArgumentError, "missing keyword: realm_id" unless attributes.key?(:realm_id)
+    attributes = default_attributes.merge!(attributes)
+    attributes.each do |attribute, value|
+      public_send("#{attribute}=", value)
+    end
     @endpoint_url = get_endpoint
   end
 
-  def connection(url: @endpoint_url)
+  def default_attributes
+    {
+      endpoint: :accounting
+    }
+  end
+
+  def connection(url: endpoint_url)
     @connection ||= authorized_json_connection(url)
   end
 
+  def endpoint_url
+    @endpoint_url.dup
+  end
+
   private
 
   def get_endpoint
     prod = self.class.production
-    case @endpoint
-    when :accounting
-      prod ? V3_ENDPOINT_BASE_URL.sub("sandbox-", '') : V3_ENDPOINT_BASE_URL
-    when :payments
-      prod ? PAYMENTS_API_BASE_URL.sub("sandbox.", '') : PAYMENTS_API_BASE_URL
+    {
+      accounting: prod ? V3_ENDPOINT_BASE_URL.sub("sandbox-", '') : V3_ENDPOINT_BASE_URL,
+      payments: prod ? PAYMENTS_API_BASE_URL.sub("sandbox.", '') : PAYMENTS_API_BASE_URL
+    }.fetch(endpoint) do
+      raise KeyError, "Invalid endpoint: #{endpoint.inspect}"
     end
   end
 end

data/lib/qbo_api/attachment.rb

@@ -17,7 +17,7 @@ class QboApi
     end
 
     def attachment_connection
-      @attachment_connection ||= authorized_multipart_connection(@endpoint_url)
+      @attachment_connection ||= authorized_multipart_connection(endpoint_url)
     end
 
   end

data/lib/qbo_api/connection.rb

@@ -4,6 +4,11 @@ require 'faraday/detailed_logger'
 
 class QboApi
   module Connection
+    AUTHORIZATION_MIDDLEWARES = []
+
+    def Connection.add_authorization_middleware(strategy_name)
+      Connection::AUTHORIZATION_MIDDLEWARES << strategy_name
+    end
 
     def authorized_json_connection(url, headers: nil)
       headers ||= {}
@@ -81,20 +86,6 @@ class QboApi
       end
     end
 
-    # Part of the OAuth1 API
-    # https://developer.intuit.com/docs/0100_quickbooks_online/0100_essentials/0085_develop_quickbooks_apps/0004_authentication_and_authorization/oauth_management_api#/Reconnect
-    def disconnect
-      path = "#{APP_CONNECTION_URL}/disconnect"
-      request(:get, path: path)
-    end
-
-    # Part of the OAuth1 API
-    # https://developer.intuit.com/docs/0100_quickbooks_online/0100_essentials/0085_develop_quickbooks_apps/0004_authentication_and_authorization/oauth_management_api#/Reconnect
-    def reconnect
-      path = "#{APP_CONNECTION_URL}/reconnect"
-      request(:get, path: path)
-    end
-
     private
 
     def entity_response(data, entity)
@@ -125,33 +116,22 @@ class QboApi
     end
 
     def add_authorization_middleware(conn)
-      if @token != nil
-        # Part of the OAuth1 API
-        gem 'simple_oauth'
-        require 'simple_oauth'
-        conn.request :oauth, oauth_data
-      elsif @access_token != nil
-        conn.request :oauth2, @access_token, token_type: 'bearer'
-      else
-        raise QboApi::Error.new error_body: 'Must set either the token or access_token'
+      Connection::AUTHORIZATION_MIDDLEWARES.find(proc do
+        raise QboApi::Error.new error_body: 'Add a configured authorization_middleware'
+      end) do |strategy_name|
+        next unless public_send("use_#{strategy_name}_middleware?")
+        public_send("add_#{strategy_name}_authorization_middleware", conn)
+        true
       end
     end
 
-    # Part of the OAuth1 API
-    # Use with simple_oauth OAuth1 middleware
-    # @see #add_authorization_middleware
-    def oauth_data
-      {
-        consumer_key: @consumer_key,
-        consumer_secret: @consumer_secret,
-        token: @token,
-        token_secret: @token_secret
-      }
-    end
-
     def entity_name(entity)
       singular(entity)
     end
 
+    require_relative 'connection/oauth1'
+    include OAuth1
+    require_relative 'connection/oauth2'
+    include OAuth2
   end
 end

data/lib/qbo_api/connection/oauth1.rb

@@ -0,0 +1,60 @@
+class QboApi
+  APP_CENTER_BASE            = 'https://appcenter.intuit.com'
+  APP_CENTER_URL             =  APP_CENTER_BASE + '/Connect/Begin?oauth_token='
+  APP_CONNECTION_URL         = APP_CENTER_BASE + '/api/v1/connection'
+
+  attr_accessor :token, :token_secret
+  attr_accessor :consumer_key, :consumer_secret
+
+  module Connection::OAuth1
+
+    def self.included(*)
+      QboApi::Connection.add_authorization_middleware :oauth1
+      super
+    end
+
+    def default_attributes
+      super.merge!(
+        token: nil, token_secret: nil,
+        consumer_key: defined?(CONSUMER_KEY) ? CONSUMER_KEY : nil,
+        consumer_secret: defined?(CONSUMER_SECRET) ? CONSUMER_SECRET : nil,
+      )
+    end
+
+    def add_oauth1_authorization_middleware(conn)
+      gem 'simple_oauth'
+      require 'simple_oauth'
+      conn.request :oauth, oauth_data
+    end
+
+    def use_oauth1_middleware?
+      token != nil
+    end
+
+    # https://developer.intuit.com/docs/0100_quickbooks_online/0100_essentials/0085_develop_quickbooks_apps/0004_authentication_and_authorization/oauth_management_api#/Reconnect
+    def disconnect
+      path = "#{APP_CONNECTION_URL}/disconnect"
+      request(:get, path: path)
+    end
+
+    # https://developer.intuit.com/docs/0100_quickbooks_online/0100_essentials/0085_develop_quickbooks_apps/0004_authentication_and_authorization/oauth_management_api#/Reconnect
+    def reconnect
+      path = "#{APP_CONNECTION_URL}/reconnect"
+      request(:get, path: path)
+    end
+
+    private
+
+    # Use with simple_oauth OAuth1 middleware
+    # @see #add_authorization_middleware
+    def oauth_data
+      {
+        consumer_key: @consumer_key,
+        consumer_secret: @consumer_secret,
+        token: @token,
+        token_secret: @token_secret
+      }
+    end
+
+  end
+end

data/lib/qbo_api/connection/oauth2.rb

@@ -0,0 +1,24 @@
+class QboApi
+  attr_accessor :access_token
+
+  module Connection::OAuth2
+
+    def self.included(*)
+      QboApi::Connection.add_authorization_middleware :oauth2
+      super
+    end
+
+    def default_attributes
+      super.merge!(
+        access_token: nil
+      )
+    end
+    def add_oauth2_authorization_middleware(conn)
+      conn.request :oauth2, access_token, token_type: 'bearer'
+    end
+
+    def use_oauth2_middleware?
+      access_token != nil
+    end
+  end
+end

data/lib/qbo_api/version.rb

@@ -1,3 +1,3 @@
 class QboApi
-  VERSION = "1.8.0"
+  VERSION = "1.8.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: qbo_api
 version: !ruby/object:Gem::Version
-  version: 1.8.0
+  version: 1.8.1
 platform: ruby
 authors:
 - Christian Pelczarski
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-03-24 00:00:00.000000000 Z
+date: 2018-03-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -276,6 +276,8 @@ files:
 - lib/qbo_api/attachment.rb
 - lib/qbo_api/configuration.rb
 - lib/qbo_api/connection.rb
+- lib/qbo_api/connection/oauth1.rb
+- lib/qbo_api/connection/oauth2.rb
 - lib/qbo_api/entity.rb
 - lib/qbo_api/error.rb
 - lib/qbo_api/raise_http_exception.rb