qbo_api 1.8.2 → 1.8.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 706590c1ebea65c87b5bd12452dca43fa3746bbc
-  data.tar.gz: 7d815c391cca1e6f11ff95d804bc6f17692be548
+  metadata.gz: 1a14e9e5e66c903adfe8068876926ab4a7cb1a6a
+  data.tar.gz: 81dea94865459c92b103ae0b6804b85f2287e23c
 SHA512:
-  metadata.gz: 10c69ee5b8e677a9dc58bb1c6c5e9b24e806bd76bf9e5070cd2f99614446c9d5ba5a5f9fca44a4ab50199e20b8f047e1c246bce9f2180e8029df036809ad6c74
-  data.tar.gz: 9352623cd9286a26149cfbb8cb5bbdeeb77f95882b938d7bd5774957bae1cdcbe51e766212bae4f13335c1664ac64fe4dec91114091b1465f72502b57ce78397
+  metadata.gz: 5c7a3e681f058684ccec7da9db94da92ce20f010f6762b91eb7e87cf10b83a320897a8fcd84f882d841544ec17b08ab3e90711c3674ef0662669861e3108ed58
+  data.tar.gz: 5ffdd016f2ef8f8d83b9b700d76a835cdb86fd39a85621976fc0fef99a69c9dff30b5c4b0a40bbf2624a5fd163bfe71753aebc2058ca03f55a6f76b90e8615f2

data/Gemfile

@@ -1,4 +1,3 @@
 source 'https://rubygems.org'
 
-# Specify your gem's dependencies in qbo_api.gemspec
 gemspec

data/README.md

@@ -353,16 +353,22 @@ See [docs](https://developer.intuit.com/docs/0100_quickbooks_online/0100_essenti
   - 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.
-- 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`
+  - Go to the [`Development` tab](https://developer.intuit.com/v2/ui#/app/dashboard)
+  and copy the 'Client ID' and the 'Client 'Secret' to your .env
+  as QBO_API_CLIENT_ID and QBO_API_CLIENT_SECRET respectively
+- Add a Redirect URI: `http://localhost:9393/oauth2-redirect` (or whatever PORT= is in your .env)
+- Create a new Company ([from the manage sandboxes page](https://developer.intuit.com/v2/ui#/sandbox))
+  Don't use it for anything else besides testing this app.
+-. Copy the 'Company ID' to your .env as QBO_API_COMPANY_ID
+- Start up the example OAuth2 app
+  - `ruby example/oauth2.rb`
+- Go to `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:
+- After successfully connecting to your sandbox go to :
   - `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.
+- Checkout [`example/oauth2.rb`](https://github.com/minimul/qbo_api/blob/master/example/oauth2.rb)
+  to see what is going on under the hood.
 
 ## OAuth1: Spin up an example
 ### OLD LEGACY - SEE OAUTH2 EXAMPLE ABOVE
@@ -374,20 +380,47 @@ See [docs](https://developer.intuit.com/docs/0100_quickbooks_online/0100_essenti
   - 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 consumer key and secret into the `.env` file.
-- Note: the `.env` file will be automatically loaded after you run the next step.
+  - Go to the `Development` tab and copy and paste the consumer key and secret into the `.env` file
+  as QBO_API_CONSUMER_KEY and QBO_API_CONSUMER_SECRET respectively.
 - Start up the example app
-  - `ruby example/app.rb`
-- Goto `http://localhost:9393`
+  - `ruby example/oauth.rb`
+- Go to `http://localhost:9393`
 - 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/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.
+- Checkout [`example/oauth.rb`](https://github.com/minimul/qbo_api/blob/master/example/oauth.rb)
+  to see what is going on under the hood.
 
 ## Webhooks
 - <a href="http://minimul.com/getting-started-with-quickbooks-online-webhooks.html" target="_blank">Check out this tutorial and screencast on handling a webhook request</a>. Also checkout [`example/app.rb`](https://github.com/minimul/qbo_api/blob/master/example/app.rb) for the request handling code.
 
+See https://www.twilio.com/blog/2015/09/6-awesome-reasons-to-use-ngrok-when-testing-webhooks.html
+for how to install ngrok and what it is.
+
+- With either the oauth1 or oauth2 examples running, run:
+  `ngrok http 9393 -subdomain=somereasonablyuniquenamehere`
+
+- Go to the [`Development` tab](https://developer.intuit.com/v2/ui#/app/dashboard)
+- Add a webhook, Select all triggers and enter the https url from the ngrok output
+  `https://somereasonablyuniquenamehere/webhooks`
+
+- After saving the webhook, click 'show token'.
+  Add the token to your .env as QBO_API_VERIFIER_TOKEN
+
+- In another tab, create a customer via the (OAuth2) 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)
+
+  There could be a delay of up to a minute before the webhook fires.
+
+  It'll appear in your logs like:
+  ```
+  {"eventNotifications"=>[{"realmId"=>"XXXX", "dataChangeEvent"=>{"entities"=>[{"name"=>"Customer", "id"=>"62", "operation"=>"Create", "lastUpdated"=>"2018-04-08T04:14:39.000Z"}]}}]}
+  Verified: true
+  "POST /webhooks HTTP/1.1" 200 - 0.0013
+  ```
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/minimul/qbo_api.
@@ -408,9 +441,7 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/minimu
 #### Protip: Once your .env file is completely filled out you can use the console to play around in your sandbox
 ```
 bin/console test
->> q = QboApi.new(creds.to_h)
->> q = QboApi.new(oauth2_creds.to_h) # FOR OAuth2
->> q.get :customer, 1
+>> @qbo_api.get :customer, 1
 ```
 
 ## License

data/bin/console

@@ -6,6 +6,7 @@ require "qbo_api"
 if ARGV[0] == "test"
   require_relative '../spec/support/credentials'
   ARGV[0] = nil # needed to avoid irb error
+  instance_variable_set(:@qbo_api, QboApi.new(creds.to_h))
 end
 
 # You can add fixtures and/or initialization code here to make experimenting

data/example/base.rb

@@ -0,0 +1,54 @@
+BASE_GEMS = proc do
+  gem 'qbo_api', path: '.'
+  # This app
+  gem 'sinatra'
+  gem 'sinatra-contrib'
+
+  # Creds from ../.env
+  gem 'dotenv'
+end
+
+BASE_SETUP = proc do
+  # Webhook support
+  require 'json'
+  require 'openssl'
+  require 'base64'
+
+  Dotenv.load "#{__dir__}/../.env"
+end
+
+BASE_APP_CONFIG = proc do
+  PORT  = ENV.fetch("PORT", 9393)
+  # WebHook verifier token
+  VERIFIER_TOKEN = ENV['QBO_API_VERIFIER_TOKEN']
+
+  configure do
+    $VERBOSE = nil # silence redefined constant warning
+    register Sinatra::Reloader
+  end
+
+  set :sessions, :true
+  set :port, PORT
+
+  before do
+    # Rewrite trailing slashes
+    next unless request.path_info =~ %r{/(.+)/$}
+    redirect(Regexp.last_match[1], 301)
+  end
+
+  post '/webhooks' do
+    request.body.rewind
+    data = request.body.read
+    puts JSON.parse data
+    verified = verify_webhook(data, env['HTTP_INTUIT_SIGNATURE'])
+    puts "Verified: #{verified}"
+  end
+
+  helpers do
+    def verify_webhook(data, hmac_header)
+      digest  = OpenSSL::Digest.new('sha256')
+      calculated_hmac = Base64.encode64(OpenSSL::HMAC.digest(digest, VERIFIER_TOKEN, data)).strip
+      calculated_hmac == hmac_header
+    end
+  end
+end

data/example/oauth.rb

@@ -0,0 +1,62 @@
+require 'bundler/inline'
+
+require File.expand_path(File.join('..', 'base'), __FILE__)
+
+install_gems = true
+gemfile(install_gems) do
+  source 'https://rubygems.org'
+
+  instance_eval(&BASE_GEMS)
+
+  gem 'omniauth'
+  gem 'omniauth-quickbooks'
+end
+
+instance_eval(&BASE_SETUP)
+
+class OAuthApp < Sinatra::Base
+  instance_eval(&BASE_APP_CONFIG)
+
+  CONSUMER_KEY = ENV['QBO_API_CONSUMER_KEY']
+  CONSUMER_SECRET = ENV['QBO_API_CONSUMER_SECRET']
+
+  use Rack::Session::Cookie, secret: '34233adasf/qewrq453agqr9(lasfa)'
+  use OmniAuth::Builder do
+    provider :quickbooks, CONSUMER_KEY, CONSUMER_SECRET
+  end
+
+  get '/' do
+    @app_center = QboApi::APP_CENTER_BASE
+    @auth_data = oauth_data
+    @port = PORT
+    erb :index
+  end
+
+  get '/customer/:id' do
+    if session[:token]
+      api = QboApi.new(oauth_data)
+      @resp = api.get :customer, params[:id]
+    end
+    erb :customer
+  end
+
+  get '/auth/quickbooks/callback' do
+    auth = env["omniauth.auth"][:credentials]
+    session[:token] = auth[:token]
+    session[:secret] = auth[:secret]
+    session[:realm_id] = params['realmId']
+    '<!DOCTYPE html><html lang="en"><head></head><body><script>window.opener.location.reload(); window.close();</script></body></html>'
+  end
+
+  def oauth_data
+    {
+      consumer_key: CONSUMER_KEY,
+      consumer_secret: CONSUMER_SECRET,
+      token: session[:token],
+      token_secret: session[:secret],
+      realm_id: session[:realm_id]
+    }
+  end
+end
+
+OAuthApp.run!

data/example/oauth2.rb

@@ -0,0 +1,69 @@
+require 'bundler/inline'
+
+require File.expand_path(File.join('..', 'base'), __FILE__)
+
+install_gems = true
+gemfile(install_gems) do
+  source 'https://rubygems.org'
+
+  instance_eval(&BASE_GEMS)
+
+  gem 'rack-oauth2'
+end
+
+instance_eval(&BASE_SETUP)
+
+class OAuth2App < Sinatra::Base
+  instance_eval(&BASE_APP_CONFIG)
+
+  CLIENT_ID = ENV['QBO_API_CLIENT_ID']
+  CLIENT_SECRET = ENV['QBO_API_CLIENT_SECRET']
+
+  helpers do
+    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 '/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[:refresh_token] = resp.refresh_token
+        session[:access_token] = resp.access_token
+        session[:realm_id] = params[:realmId]
+        erb :oauth2_redirect
+      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
+end
+
+OAuth2App.run!

data/example/views/index.erb

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

data/lib/qbo_api/version.rb

@@ -1,3 +1,3 @@
 class QboApi
-  VERSION = "1.8.2"
+  VERSION = "1.8.3"
 end

data/qbo_api.gemspec

@@ -22,12 +22,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake", "~> 10.0"
   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 'simple_oauth'
-  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.8.2
+  version: 1.8.3
 platform: ruby
 authors:
 - Christian Pelczarski
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-04-03 00:00:00.000000000 Z
+date: 2018-04-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: sinatra
-  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: 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: simple_oauth
   requirement: !ruby/object:Gem::Requirement
@@ -108,48 +80,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: omniauth
-  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-quickbooks
-  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: 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
@@ -266,7 +196,9 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
-- example/app.rb
+- example/base.rb
+- example/oauth.rb
+- example/oauth2.rb
 - example/views/customer.erb
 - example/views/index.erb
 - example/views/oauth2.erb

data/example/app.rb

@@ -1,118 +0,0 @@
-require "bundler/setup"
-require 'sinatra'
-require 'json'
-require 'openssl'
-require 'base64'
-require 'omniauth'
-require 'omniauth-quickbooks'
-require 'dotenv'
-require 'rack/oauth2'
-require 'qbo_api'
-
-Dotenv.load "#{__dir__}/../.env"
-
-PORT  = ENV.fetch("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/qewrq453agqr9(lasfa)'
-use OmniAuth::Builder do
-  provider :quickbooks, CONSUMER_KEY, CONSUMER_SECRET
-end
-
-helpers do
-  def verify_webhook(data, hmac_header)
-    digest  = OpenSSL::Digest.new('sha256')
-    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
-  @app_center = QboApi::APP_CENTER_BASE
-  @auth_data = oauth_data
-  @port = PORT
-  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[:refresh_token] = resp.refresh_token
-      session[:access_token] = resp.access_token
-      session[:realm_id] = params[:realmId]
-      erb :oauth2_redirect
-    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)
-    @resp = api.get :customer, params[:id]
-  end
-  erb :customer
-end
-
-post '/webhooks' do
-  request.body.rewind
-  data = request.body.read
-  puts JSON.parse data
-  verified = verify_webhook(data, env['HTTP_INTUIT_SIGNATURE'])
-  puts "Verified: #{verified}"
-end
-
-def oauth_data
-  {
-    consumer_key: CONSUMER_KEY,
-    consumer_secret: CONSUMER_SECRET,
-    token: session[:token],
-    token_secret: session[:secret],
-    realm_id: session[:realm_id]
-  }
-end
-
-get '/auth/quickbooks/callback' do
-  auth = env["omniauth.auth"][:credentials]
-  session[:token] = auth[:token]
-  session[:secret] = auth[:secret]
-  session[:realm_id] = params['realmId']
-  '<!DOCTYPE html><html lang="en"><head></head><body><script>window.opener.location.reload(); window.close();</script></body></html>'
-end