qbo_api 1.4.2 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 75b86eaa49027fe32fde7711c739153a4ac00e1e
-  data.tar.gz: 4f8035cd4bd8bb1ac1095bf936152095734afc8d
+  metadata.gz: 602ff37e3feee0e447a15566efe439d1f9beb61b
+  data.tar.gz: c709006d7f4bd704e9a1011824da9812b0edb6da
 SHA512:
-  metadata.gz: bbac4bcb348aac0099de83caa41dd55ab846cbce0c8b854ce03311a8fd3c84d769f8179a6ece9c4ef2f6a17ebd3b12fbedf34bba1ab56ba252af110633b03342
-  data.tar.gz: 7dafeab7cca38c3bb8da2bd5b7a88215fb469a02b843297e45c3d9be6c624476628ef39b603549a8072005270d86abdfe59d8ba52b4c7584cb80d855c5726ffe
+  metadata.gz: 5511399b404ad719752fc1a5fd6359e8be2386fdcc9d2e99e792abebeca3fd1e470cf838d6a6c4ecb5e9fd9a29bf25175f892a0d4fca872b1da6f39af18cd440
+  data.tar.gz: 32dcda594b2f9a63395a67d5e38cf76eee7dbbf00e85f6184d6fd690becbbe3c371cf47514a8269909b775cd55777b709c816fd77aafa2d11ddb99d4dbe51f58

data/README.md

@@ -41,6 +41,7 @@ Or install it yourself as:
 ## Usage
 
 ### Initialize
+#### OAuth
 ```ruby
   q = account.qbo_account # or wherever you are storing the OAuth creds
   qbo_api = QboApi.new(token: q.token,
@@ -49,6 +50,10 @@ Or install it yourself as:
                        consumer_key: '*****',
                        consumer_secret: '********')
 ```
+#### OAuth2
+```ruby
+  qbo_api = QboApi.new(access_token: 'REWR342532asdfae!$4asdfa', realm_id: 32095430444)
+```
 
 ### Super fast way to use QboApi no matter your current tech stack as long as Ruby > 2.2.2 is installed
 ```
@@ -57,11 +62,14 @@ Or install it yourself as:
 - bundle
 - bin/console
 - QboApi.production = true
+- # OAuth 1
 - qboapi = QboApi.new(token: "qyprd2uvCOdRq8xzoSSiiiiii",
                       token_secret:"g8wcyQEtwxxxxxxm",
                       realm_id: "12314xxxxxx7",
                       consumer_key: "qyprdwzcxxxxxxbIWsIMIy9PYI",
                       consumer_secret: "CyDN4wpxxxxxxxPMv7hDhmh4")
+- # OAuth 2
+- qboapi = QboApi.new(access_token: "qyprd2uvCOdRq8xzoSSiiiiii", realm_id: "12314xxxxxx7")
 - qboapi.get :customer, 1
 ```
 
@@ -264,8 +272,31 @@ See [docs](https://developer.intuit.com/docs/0100_quickbooks_online/0100_essenti
   p qbo_api.is_transaction_entity?(:customer) # => false
   p qbo_api.is_name_list_entity?(:vendors) # => true
 ```
+## OAuth2: Spin up an example
+### If you signed up for a Intuit developer account after July 17th, 2017 follow this example
+- `git clone git://github.com/minimul/qbo_api && cd qbo_api`
+- `bundle`
+- Create a `.env` file
+  - If needed create an account at [https://developer.intuit.com](https://developer.intuit.com)
+  - Click `Get started coding`
+  - Create an app with both the `Accounting` & `Payments` selected.
+  - Go to the `Development` tab and copy and paste the client id and client secret into the `.env` file.
+```ruby
+export QBO_API_CLIENT_ID=<Your QuickBooks Apps Client ID>
+export QBO_API_CONSUMER_SECRET=<Your QuickBooks Apps Client Secret>
+```
+- Note: the `.env` file will be automatically loaded after you run the next step.
+- Start up the example app
+  - `ruby example/app.rb`
+- Goto `http://localhost:9393/oauth2`
+- Use the `Connect to QuickBooks` button to connect to your QuickBooks sandbox, which you receive when signing up at [https://developer.intuit.com](https://developer.intuit.com).
+- After successfully connecting to your sandbox run:
+  - `http://localhost:9393/oauth2/customer/5`
+  - You should see "Dukes Basketball Camp" displayed
+- Checkout [`example/app.rb`](https://github.com/minimul/qbo_api/blob/master/example/app.rb) to see what is going on under the hood.
 
-## Spin up an example
+## OAuth1: Spin up an example
+### OLD LEGACY - SEE OAUTH2 EXAMPLE ABOVE
 - <a href="http://minimul.com/getting-started-with-the-modern-ruby-quickbooks-online-client-qbo_api-part-1.html" target="_blank">Check out this tutorial and screencast on spinning up an example</a>.
 - `git clone git://github.com/minimul/qbo_api && cd qbo_api`
 - `bundle`
@@ -306,6 +337,7 @@ 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
 ```
 - `bundle exec rspec spec/`

data/example/app.rb

@@ -6,16 +6,20 @@ require 'base64'
 require 'omniauth'
 require 'omniauth-quickbooks'
 require 'dotenv'
+require 'rack/oauth2'
 require 'qbo_api'
+
 Dotenv.load "#{__dir__}/../.env"
 
 PORT  = 9393
 CONSUMER_KEY = ENV['QBO_API_CONSUMER_KEY']
 CONSUMER_SECRET = ENV['QBO_API_CONSUMER_SECRET']
+CLIENT_ID = ENV['QBO_API_CLIENT_ID']
+CLIENT_SECRET = ENV['QBO_API_CLIENT_SECRET']
 VERIFIER_TOKEN = ENV['QBO_API_VERIFIER_TOKEN']
 
 set :port, PORT
-use Rack::Session::Cookie, secret: '34233adasf'
+use Rack::Session::Cookie, secret: '34233adasf/qewrq453agqr9(lasfa)'
 use OmniAuth::Builder do
   provider :quickbooks, CONSUMER_KEY, CONSUMER_SECRET
 end
@@ -26,6 +30,16 @@ helpers do
     calculated_hmac = Base64.encode64(OpenSSL::HMAC.digest(digest, VERIFIER_TOKEN, data)).strip
     calculated_hmac == hmac_header
   end
+
+  def oauth2_client
+    client = Rack::OAuth2::Client.new(
+      identifier: CLIENT_ID,
+      secret: CLIENT_SECRET,
+      redirect_uri: "http://localhost:#{PORT}/oauth2-redirect",
+      authorization_endpoint: "https://appcenter.intuit.com/connect/oauth2",
+      token_endpoint: "https://oauth.platform.intuit.com/oauth2/v1/tokens/bearer"
+    )
+  end
 end
 
 get '/' do
@@ -35,6 +49,39 @@ get '/' do
   erb :index
 end
 
+get '/oauth2' do
+  session[:state] = SecureRandom.uuid
+  @client = oauth2_client
+  erb :oauth2
+end
+
+get '/oauth2-redirect' do
+  state = params[:state]
+  error = params[:error]
+  code = params[:code]
+  if state == session[:state]
+    client = oauth2_client
+    client.authorization_code = code
+    if resp = client.access_token!
+      session[:access_token] = resp.access_token
+      session[:realm_id] = params[:realmId]
+      "<p>Success! Here is your access_token => #{resp.access_token}</p><p><a href='/oauth2/customer/5'>Click here</a> to make an API call</p>"
+    else
+      "Something went wrong. Try the process again"
+    end
+  else
+    "Error: #{error}"
+  end
+end
+
+get '/oauth2/customer/:id' do
+  if access_token = session[:access_token]
+    api = QboApi.new(access_token: access_token, realm_id: session[:realm_id])
+    @resp = api.get :customer, params[:id]
+  end
+  erb :customer
+end
+
 get '/customer/:id' do
   if session[:token]
     api = QboApi.new(oauth_data)

data/example/qbo_oauth2.rb

@@ -0,0 +1,38 @@
+require 'omniauth-oauth2'
+
+module OmniAuth
+	module Strategies
+		class QboOAuth2 < OmniAuth::Strategies::OAuth2
+			# Give your strategy a name.
+			option :name, "qbo"
+
+			# This is where you pass the options you would pass when
+			# initializing your consumer from the OAuth gem.
+      option :client_options, {:site => "https://appcenter.intuit.com/connect/oauth2"}
+
+			# These are called after authentication has succeeded. If
+			# possible, you should try to set the UID without making
+			# additional calls (if the user id is returned with the token
+			# or as a URI parameter). This may not be possible with all
+			# providers.
+			uid{ raw_info['id'] }
+
+			info do
+				{
+					:name => raw_info['name'],
+					:email => raw_info['email']
+				}
+			end
+
+			extra do
+				{
+					'raw_info' => raw_info
+				}
+			end
+
+			def raw_info
+				@raw_info ||= access_token.get('/me').parsed
+			end
+		end
+	end
+end

data/example/views/index.erb

@@ -21,5 +21,6 @@
   <% end %>
 
 <ipp:connectToIntuit></ipp:connectToIntuit>
+  <p><a href="/oauth2">OAuth2 Connect Page</a></p>
 </body>
 </html>

data/example/views/oauth2.erb

@@ -0,0 +1,25 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <meta charset="UTF-8">
+  <title>QBO Connect via OAuth2</title>
+
+  <script type="text/javascript" src="<%= QboApi::APP_CENTER_BASE %>/Content/IA/intuit.ipp.anywhere-1.3.1.js"></script>
+  <script>
+    intuit.ipp.anywhere.setup({
+      grantUrl: "<%= @client.authorization_uri(scope: 'com.intuit.quickbooks.accounting', state: session[:state]) %>",
+      datasources: {
+        quickbooks : true,
+        payments : true
+      }
+    });
+  </script>
+</head>
+<body>
+  <% if session[:token] %>
+    <p><%= @auth_data %></p>
+  <% end %>
+
+<ipp:connectToIntuit></ipp:connectToIntuit>
+</body>
+</html>

data/lib/qbo_api.rb

@@ -28,12 +28,13 @@ class QboApi
   PAYMENTS_API_BASE_URL      = 'https://sandbox.api.intuit.com/quickbooks/v4/payments'
   APP_CONNECTION_URL         = APP_CENTER_BASE + '/api/v1/connection'
 
-  def initialize(token:, token_secret:, realm_id:, consumer_key: CONSUMER_KEY, 
-                 consumer_secret: CONSUMER_SECRET, endpoint: :accounting)
-    @consumer_key = consumer_key
-    @consumer_secret = consumer_secret
+  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
   end
@@ -42,7 +43,13 @@ class QboApi
     Faraday.new(url: url) do |faraday|
       faraday.headers['Content-Type'] = 'application/json;charset=UTF-8'
       faraday.headers['Accept'] = "application/json"
-      faraday.request :oauth, oauth_data 
+      if @token != nil
+        faraday.request :oauth, oauth_data
+      elsif @access_token != nil
+        faraday.request :oauth2, @access_token, token_type: 'bearer'
+      else
+        raise QboApi::Error.new error_body: "Must set either the token or access_token"
+      end
       faraday.request :url_encoded
       faraday.use FaradayMiddleware::RaiseHttpException
       faraday.response :detailed_logger, QboApi.logger if QboApi.log

data/lib/qbo_api/version.rb

@@ -1,3 +1,3 @@
 class QboApi
-  VERSION = "1.4.2"
+  VERSION = "1.5.0"
 end

data/qbo_api.gemspec

@@ -23,8 +23,10 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rspec"
   spec.add_development_dependency 'webmock'
   spec.add_development_dependency 'sinatra'
+  spec.add_development_dependency 'rack-oauth2'
   spec.add_development_dependency 'omniauth'
   spec.add_development_dependency 'omniauth-quickbooks'
+  spec.add_development_dependency 'shotgun'
   spec.add_development_dependency 'dotenv'
   spec.add_development_dependency 'vcr'
   spec.add_development_dependency 'awesome_print'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: qbo_api
 version: !ruby/object:Gem::Version
-  version: 1.4.2
+  version: 1.5.0
 platform: ruby
 authors:
 - Christian Pelczarski
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-03-29 00:00:00.000000000 Z
+date: 2017-07-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -80,6 +80,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack-oauth2
+  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: omniauth
   requirement: !ruby/object:Gem::Requirement
@@ -108,6 +122,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: shotgun
+  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
@@ -236,8 +264,10 @@ files:
 - bin/console
 - bin/setup
 - example/app.rb
+- example/qbo_oauth2.rb
 - example/views/customer.erb
 - example/views/index.erb
+- example/views/oauth2.erb
 - lib/qbo_api.rb
 - lib/qbo_api/configuration.rb
 - lib/qbo_api/entity.rb