quick_book_gateway 0.0.4 → 0.0.7

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 40de0d4b980aae3a0595197f6428558780babf934ee6099ff6329402889a674c
+  data.tar.gz: 4a3500f27e7926a2228f7f9cea979e7fa9b39499285fa158196378faa9e1cce8
+SHA512:
+  metadata.gz: d5541aff318047474721bd540daa4b35961a93970344bc9fd08939d2bc92cf1ad523e02480a5817aa8e4fb19da4091fd4af7573d10529c16c0f218dd8b320d80
+  data.tar.gz: fa9c338cbc688398cbc7ca9d66c9f8b14fae2e09bfd20666bb925958bacef78b365892acd749d0b9ea641ec3ae86c464e5f88dcc2a21e3e6a39208d0a51696d7

data/README

@@ -1,8 +1,8 @@
 ## Requirements
 
 * Ruby >= 0
-* OAuth
-* Quickbook tokens
+* OAuth2
+* Quickbook refresh token, can generate via Quickbook playground https://developer.intuit.com/app/developer/playground 
 
 
 ## Installation
@@ -19,13 +19,12 @@
 
 2. Configure Quickbook by adding below line to your ruby program
 
-    Gateway::Quickbook.connect(
-            :qb_key       =>   Quickbook Key,
-            :qb_secret    =>   Quickbook Secret,
-            :token        =>   Access Token,
-            :secret       =>   Access Sceret,
-            :company_id   =>   Quickbook Company ID,
-            :environment  =>   ENVIRONMENT::SANDBOX or ENVIRONMENT::PRODUCTION
+        Gateway::Quickbook.connect(
+            :client_id      =>   QuickBook App Client ID,
+            :client_secret  =>   QuickBook App Client Secret,
+            :refresh_token  =>   Can generate from playground https://developer.intuit.com/app/developer/playground, validate for 100 days
+            :company_id     =>   QuickBook Company ID,
+            :environment    =>   ENVIRONMENT::SANDBOX or ENVIRONMENT::PRODUCTION
         )
 
 3.  Create classes with names provided on Quickbook website 
@@ -37,22 +36,22 @@
 
 4. Inherit all classes with Service::Record Class, class should look like below
 
-    class Customer < Service::Record
-    end
+        class Customer < Service::Record
+        end
 
-    class Vendor < Service::Record
-    end
+        class Vendor < Service::Record
+        end
 
-    class Item < Service::Record
-    end
+        class Item < Service::Record
+        end
 
 5.  You are ready to create, fetch or modify any data on Quickbook.
     
     For ex.
 
-    customer = Customer.find(DisplayName: "Kunal")
-    customer.CompanyName = "Kunal Lalge"
-    customer.save!
+        customer = Customer.find(DisplayName: "Kunal")
+        customer.CompanyName = "Kunal Lalge"
+        customer.save!
 
 6.  For attributes reference read Documentation reference for each class on Quickbook link provided above.
 
@@ -60,24 +59,17 @@
   
 7.  One can also use callbacks, below are list of callbacks:
 
-    
-    before_save         -   Executes every time before object save
-
-    after_save          -   Executes every time after object save
+        before_save         -   Executes every time before object save
+        after_save          -   Executes every time after object save
+        before_create       -   Executes only before new object save
+        after_create        -   Executes only after new object save
+        before_update       -   Executes only before existing object save
+        after_update        -   Executes only after existing object save
+        before_destroy      -   Executes every time before destroy an object
+        after_destroy       -   Executes every time after destroy an object
 
-    before_create       -   Executes only before new object save
+    Example 
 
-    after_create        -   Executes only after new object save
-
-    before_update       -   Executes only before existing object save
-
-    after_update        -   Executes only after existing object save
-
-    before_destroy      -   Executes every time before destroy an object
-
-    after_destroy       -   Executes every time after destroy an object
-
-    Ex. 
         class Customer < Service::Record
             def after_create
                 puts "New customer is created on QB"
@@ -89,6 +81,8 @@
 
 0.0.4   - find_all will fetch all records using pagination
 
+0.0.5   - Quickbook OAuth 2.0 security upgradation implemented
+
 
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,

data/lib/gateway/quickbook.rb

@@ -1,4 +1,4 @@
-require 'oauth'
+require 'oauth2'
 
 module Gateway
   class Quickbook < Result
@@ -32,34 +32,27 @@ module Gateway
     #Options are as follow
     #   String: Environment ENVIRONMENT::SANDBOX or ENVIRONMENT::PRODUCTION. AutoLoad QuickBook key, secret, access token, access secret, company ID from config/quickbook.yml corresponding to environment given.
     #   Hash: 
-    #     :qb_key       =>   QuickBook Key,
-    #     :qb_secret    =>   QuickBook Secret,
-    #     :token        =>   Access Token,
-    #     :secret       =>   Access Sceret,
-    #     :company_id   =>   QuickBook Company ID,
-    #     :environment  =>   ENVIRONMENT::SANDBOX or ENVIRONMENT::PRODUCTION
+    #     :client_id      =>   QuickBook App Client ID,
+    #     :client_secret  =>   QuickBook App Client Secret,
+    #     :refresh_token  =>   Can generate from playground https://developer.intuit.com/app/developer/playground, validate for 100 days
+    #     :company_id     =>   QuickBook Company ID,
+    #     :environment    =>   ENVIRONMENT::SANDBOX or ENVIRONMENT::PRODUCTION
     def self.connect(options)   
       if(options.class == String)
         configuration = YAML.load_file("config/quickbook.yml")
         environment = options
         options = Hash.new
-        options[:qb_key] = configuration[environment]["key"]
-        options[:qb_secret] =   configuration[environment]["secret"]
-        options[:token] =   configuration[environment]["access_token"]
-        options[:secret] =   configuration[environment]["access_secret"]
+        options[:client_id] = configuration[environment]["client_id"]
+        options[:client_secret] =   configuration[environment]["client_secret"]
+        options[:refresh_token] =   configuration[environment]["refresh_token"]
         options[:company_id] =   configuration[environment]["company_id"]
         options[:environment] = environment
       end
       
       gateway = new
-      gateway.consumer = OAuth::Consumer.new(options[:qb_key], options[:qb_secret], {
-          :site                 => "https://oauth.intuit.com",
-          :request_token_path   => "/oauth/v1/get_request_token",
-          :authorize_url        => "https://appcenter.intuit.com/Connect/Begin",
-          :access_token_path    => "/oauth/v1/get_access_token"
-        })
-      
-      gateway.access_token = OAuth::AccessToken.new(gateway.consumer, options[:token], options[:secret])
+      gateway.consumer = OAuth2::Client.new(options[:client_id], options[:client_secret], {:token_url => 'https://oauth.platform.intuit.com/oauth2/v1/tokens/bearer', auth_scheme: :basic_auth})
+      gateway.access_token = OAuth2::AccessToken.new(gateway.consumer, nil, {refresh_token: options[:refresh_token]})
+      gateway.access_token = gateway.access_token.refresh!
       
       gateway.company_id = options[:company_id]
       
@@ -81,7 +74,7 @@ module Gateway
     
     public
     def get(path, parameters = {})
-      return handle_query_result(self.access_token.get(url(path, parameters), {"Accept" => HTTP::JSON}))
+      return handle_query_result(self.access_token.get(url(path, parameters), {headers: {"Accept" => HTTP::JSON}}))
     end
     
     def query_data(query)
@@ -89,7 +82,7 @@ module Gateway
     end
     
     def post(path, parameters, body)
-      return handle_query_result(self.access_token.post(url(path, parameters), body,  {"Content-Type" => HTTP::JSON, "Accept" => HTTP::JSON}))
+      return handle_query_result(self.access_token.post(url(path, parameters), {body: body, headers: {"Content-Type" => HTTP::JSON, "Accept" => HTTP::JSON}}))
     end
   end
 end

data/lib/gateway/result.rb

@@ -6,7 +6,7 @@ module Gateway
     include Errors
     
     def handle_query_result(response)
-      if(response.code == "200")
+      if(response.status.to_i == 200)
         result = JSON.parse(response.body)
         
         if result["Fault"]

data/lib/service/finder.rb

@@ -90,6 +90,7 @@ module Service
       
       qb_record = find(options.dup)
       
+      options.delete(:conditions)
       qb_record = new(options) unless qb_record
       
       return qb_record

metadata

@@ -1,74 +1,69 @@
 --- !ruby/object:Gem::Specification
 name: quick_book_gateway
 version: !ruby/object:Gem::Version
-  version: 0.0.4
-  prerelease: 
+  version: 0.0.7
 platform: ruby
 authors:
 - Kunal Lalge
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-25 00:00:00.000000000 Z
+date: 2020-02-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: oauth
+  name: oauth2
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-description: ! 'Connect to QuickBook Online and easily synchronize data. Please read
-  README file to know how to use located at gems-directory/quick_book_gateway-0.0.2/README '
+        version: '1'
+description: 'Connect to QuickBook Online and easily synchronize data. Please read
+  README file to know how to use located at gems-directory/quick_book_gateway-0.0.7/README '
 email: kunallalge@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/quick_book_gateway.rb
-- lib/errors.rb
-- lib/core_ext/string.rb
+- README
 - lib/core_ext/hash.rb
 - lib/core_ext/nil.rb
+- lib/core_ext/string.rb
+- lib/errors.rb
 - lib/gateway/quickbook.rb
 - lib/gateway/result.rb
-- lib/service/query.rb
-- lib/service/finder.rb
+- lib/quick_book_gateway.rb
 - lib/service/callback.rb
+- lib/service/finder.rb
 - lib/service/persistence.rb
+- lib/service/query.rb
 - lib/service/record.rb
-- README
-homepage: https://rubygems.org/gems/quick_book_gateway
+homepage: https://github.com/KunalLalge/quick_book_gateway
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 3.1.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: QuickBook Online Gateway
 test_files: []