qbo_api 1.8.5 → 3.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f304a44d0c7d7231a3f5ef101e1005652bc9cd801d7263b6dc70138a52229c56
-  data.tar.gz: 2a4544537ec874555c7e1aba96f0ebf2457a1bb34af0f3da651e86b9e38fdbff
+  metadata.gz: b9924b785fa2755f09e92bf26198280b198dee80d2621d8c86b4e4f2fdb1cc1d
+  data.tar.gz: 26b76ad24f8760ebb5c39385e9798b3799645cbe6d3d69230a6d720ee9676514
 SHA512:
-  metadata.gz: 4b02f2de3f7192ad90a5beb5b491be6fa05923f6c12c5b6c6f1a040f8a857013cd7201cfe3cfd50e7088a4b664976d3b87ecb9e33a567f79c4d95847e1885b8f
-  data.tar.gz: 346a13001298cb240678ecbe151844181c7504d97263e16e6e118d9509d3962978bee1556a346d76c265b034189afbc8030c35b8c7885ac7f5c52c1902b3d415
+  metadata.gz: 827f3a675049aa20889d6e7e7cf9b8e2b05df79c0410b9bbef0c9bcd2c57eb81f77f88f5e5c2b9f161318bbd899ccb94bec9a9d2e199977b8545bd16cb8163e6
+  data.tar.gz: e52c00f610340f0a0d13c711782629c56b80fcc6300b05e5f97705de63545c6cb59dbeba33fb15cbe2770628c38458c2535eabfd00e7e74a87223c267c5229e8

data/.env.test

@@ -1,6 +1,2 @@
-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

data/.gitignore

@@ -19,3 +19,4 @@ todo.txt
 spec/temp/spec_status.txt
 *.swp
 scrap.txt
+.tool-versions

data/.travis.yml

@@ -1,8 +1,12 @@
 sudo: false
 language: ruby
 rvm:
-  - 2.2.2
-  - 2.3.0
+  - 2.6.8
+  - 2.7.4
+  - 3.0.2
+
+before_install:
+  - gem install bundler
 
 before_script:
   - cp .env.test .env
@@ -10,7 +14,6 @@ before_script:
 script:
   - bundle exec rspec spec/
 
-
 notifications:
   email:
     - christian@minimul.com

data/README.md

@@ -1,20 +1,11 @@
 # QboApi
 
 Ruby client for the QuickBooks Online API version 3.
-- Built on top of the excellent Faraday gem.
 - JSON only support.
   - Please don't ask about XML support. [Intuit has stated](https://github.com/ruckus/quickbooks-ruby/issues/257#issuecomment-126834454) that JSON is the primary data format for the QuickBooks API (v3 and beyond). This gem will specialize in JSON only. The [`quickbooks-ruby`](https://github.com/ruckus/quickbooks-ruby) gem has fantastic support for those who favor XML.
 - Features specs built directly against a QuickBooks Online Sandbox via the VCR gem.
 - Robust error handling.
 
-## Tutorials and Screencasts
-- <a href="http://minimul.com/introducing-a-new-ruby-quickbooks-online-client.html" target="_blank">Why qbo_api is a better choice </a> than the <a href="https://github.com/ruckus/quickbooks-ruby" target="_blank">quickbooks-ruby</a> gem.
-- <a href="http://minimul.com/getting-started-with-the-modern-ruby-quickbooks-online-client-qbo_api-part-1.html" target="_blank">Part 1</a>: Learn how to spin up the <a href="https://github.com/minimul/qbo_api#spin-up-an-example">example app</a>.
-- <a href="http://minimul.com/the-modern-ruby-quickbooks-client-part-2.html" target="_blank">Part 2</a>: <a href="https://github.com/minimul/qbo_api#running-the-specs">Running the specs</a> to aid you in understanding a QuickBooks API transaction.
-- <a href="http://minimul.com/the-modern-ruby-quickbooks-client-contributing.html" target="_blank">Part 3</a>: <a href="https://github.com/minimul/qbo_api#creating-new-specs-or-modifying-existing-spec-that-have-been-recorded-using-the-vcr-gem">Contributing to the gem</a>.
-### Important Note: The videos are out of date.
-If you signed up for a Intuit developer account after July 17th, 2017 then you will have to
-follow <a href='#OAuth2-example'>OAuth2: Spin up an example</a>
 ## The Book
 
 <a href="https://leanpub.com/minimul-qbo-guide-vol-1" target="_blank">
@@ -22,7 +13,7 @@ follow <a href='#OAuth2-example'>OAuth2: Spin up an example</a>
 </a>
 
 
-## Ruby >= 2.2.2 required
+## Ruby >= 2.6 required
 
 ## Installation
 
@@ -43,41 +34,22 @@ 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,
-                       token_secret: q.secret,
-                       realm_id: q.companyid,
-                       consumer_key: '*****',
-                       consumer_secret: '********')
-```
-#### OAuth2
 ```ruby
   qbo_api = QboApi.new(access_token: 'REWR342532asdfae!$4asdfa', realm_id: 32095430444)
+- qbo_api.get :customer, 1
 ```
 
-### Super fast way to use QboApi no matter your current tech stack as long as Ruby > 2.2.2 is installed
+### Super fast way to use QboApi as long as Ruby >= 2.5 is installed
 ```
 - cd ~/<local dir>
 - git clone git@github.com:minimul/qbo_api.git && cd qbo_api
 - 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
+- qbo_api = QboApi.new(access_token: "qyprd2uvCOdRq8xzoSSiiiiii", realm_id: "12314xxxxxx7")
+- qbo_api.get :customer, 1
 ```
 
-### TLS v1.2
-Intuit will be [requiring](https://developer.intuit.com/hub/blog/2017/08/03/upgrading-your-apps-to-support-tls-1-2) API client connections to be negotiated over TLS1.2 by December 31st, 2017. Using the default HTTP client (Net::HTTP) with Faraday this is the case with QboApi, however, if you are using another HTTP client you may need to directly set the TLS version negotiation manually.
-
 ### DateTime serialization
 Some QBO entities have attributes of type DateTime (e.g., Time Activities with StartTime and EndTime). All DateTimes passed to the QBO API must be serialized in ISO 8601 format.
 If ActiveSupport is loaded, you can achieve proper serialization with the following configuration:
@@ -119,7 +91,6 @@ QboApi.minor_version = 8
   # Works with .get, .create, .update, .query methods
 ```
 
-
 ### Create
 ```ruby
   invoice = {
@@ -191,6 +162,40 @@ QboApi.minor_version = 8
   p response.size # => 28
 ```
 
+### Import/retrieve all
+*Note: There is some overlap with the `all` and the `get` methods. The `get` method is limited to 1000 results where the `all` method will return all the results no matter the number.*
+```ruby
+  # retrieves all active customers
+  qbo_api.all(:customers).each do |c|
+    p "#{c['Id']} #{c['DisplayName']}"
+  end
+
+  # retrieves all active or inactive employees
+  qbo_api.all(:employees, inactive: true).each do |e|
+    p "#{e['Id']} #{e['DisplayName']}"
+  end
+
+  # retrieves all vendors by groups of 5
+  qbo_api.all(:vendor, max: 5).each do |v|
+    p v['DisplayName']
+  end
+
+  # retrieves all customers by groups of 2 using a custom select query
+  where = "WHERE Id IN ('5', '6', '7', '8', '9', '10')"
+  qbo_api.all(:customer, max: 2, select: "SELECT * FROM Customer #{where}").each do |c|
+    p c['DisplayName']
+  end
+```
+
+#### Note: .all() returns a Ruby Enumerator
+
+```
+api.all(:clients).take(50).each { |c| p c["Id"] }
+api.all(:clients).count
+api.all(:clients).first
+api.all(:clients).to_a
+```
+
 ### Search with irregular characters
 ```ruby
   # Use the .esc() method
@@ -201,6 +206,12 @@ QboApi.minor_version = 8
   p response['Id'] # => 1
 ```
 
+
+### Email a transaction entity
+```ruby
+api.send_invoice(invoice_id: 1, email_address: 'billy@joe.com')
+```
+
 ### Uploading an attachment
 ```ruby
   payload = {"AttachableRef":
@@ -264,7 +275,7 @@ Be aware that any errors will not raise a `QboApi::Error`, but will be returned
         }
       ]
   }
-  response = api.batch(payload)
+  response = qbo_api.batch(payload)
   expect(response['BatchItemResponse'].size).to eq 2
   expect(batch_response.detect{ |b| b["bId"] == "bid1" }["Vendor"]["DisplayName"]).to eq "Smith Family Store"
 ```
@@ -273,7 +284,7 @@ Be aware that any errors will not raise a `QboApi::Error`, but will be returned
 
 ```ruby
         params = { start_date: '2015-01-01', end_date: '2015-07-31', customer: 1, summarize_column_by: 'Customers' }
-        response = api.reports(name: 'ProfitAndLoss', params: params)
+        response = qbo_api.reports(name: 'ProfitAndLoss', params: params)
         p response["Header"]["ReportName"]) #=> 'ProfitAndLoss'
 ```
 
@@ -310,31 +321,6 @@ See [docs](https://developer.intuit.com/docs/0100_quickbooks_online/0100_essenti
   end
 ```
 
-### Import/retrieve all
-*Note: There is some overlap with the `all` and the `get` methods. The `get` method is limited to 1000 results where the `all` method will return all the results no matter the number.*
-```ruby
-  # retrieves all active customers
-  qbo_api.all(:customers).each do |c|
-    p "#{c['Id']} #{c['DisplayName']}"
-  end
-
-  # retrieves all active or inactive employees
-  qbo_api.all(:employees, inactive: true).each do |e|
-    p "#{e['Id']} #{e['DisplayName']}"
-  end
-
-  # retrieves all vendors by groups of 5
-  qbo_api.all(:vendor, max: 5).each do |v|
-    p v['DisplayName']
-  end
-
-  # retrieves all customers by groups of 2 using a custom select query
-  where = "WHERE Id IN ('5', '6', '7', '8', '9', '10')"
-  qbo_api.all(:customer, max: 2, select: "SELECT * FROM Customer #{where}").each do |c|
-    p c['DisplayName']
-  end
-```
-
 ### What kind of QuickBooks entity?
 ```ruby
   p qbo_api.is_transaction_entity?(:invoice) # => true
@@ -343,9 +329,8 @@ 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
 ```
-## <a name='OAuth2-example'>OAuth2: Spin up an example</a>
-### If you signed up for a Intuit developer account after July 17th, 2017 follow this example
-- <a href="http://minimul.com/access-the-quickbooks-online-api-with-oauth2.html" target="_blank">Check out this article on spinning up the OAuth2 example</a>.
+## <a name='OAuth2-example'>Spin up an example</a>
+- <a href="http://minimul.com/access-the-quickbooks-online-api-with-oauth2.html" target="_blank">Check out this article on spinning up the example</a>.
 - `git clone git://github.com/minimul/qbo_api && cd qbo_api`
 - `bundle`
 - Create a `.env` file
@@ -360,7 +345,7 @@ See [docs](https://developer.intuit.com/docs/0100_quickbooks_online/0100_essenti
 - 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
+- Start up the example 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).
@@ -370,35 +355,13 @@ See [docs](https://developer.intuit.com/docs/0100_quickbooks_online/0100_essenti
 - 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
-- <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`
-- Create a `.env` file
-  - `cp .env.example_app.oauth1 .env`
-  - 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
-  as QBO_API_CONSUMER_KEY and QBO_API_CONSUMER_SECRET respectively.
-- Start up the example app
-  - `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/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:
+- With the example app running, run:
   `ngrok http 9393 -subdomain=somereasonablyuniquenamehere`
 
 - Go to the [`Development` tab](https://developer.intuit.com/v2/ui#/app/dashboard)
@@ -408,9 +371,9 @@ for how to install ngrok and what it is.
 - 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)
+- 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_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.
 
@@ -421,6 +384,28 @@ for how to install ngrok and what it is.
   "POST /webhooks HTTP/1.1" 200 - 0.0013
   ```
 
+### Just For Hackers
+
+- Using the build_connection method
+```
+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.response :json
+  conn.use QboApi::RaiseHttpException
+end
+
+raw_response = connection.post do |req|
+  req.body = { grant_type: :refresh_token, refresh_token: current_refresh_token }
+  req.url '/oauth2/v1/tokens/bearer'
+end
+```
+- Once your .env file is completely filled out you can use the console to play around in your sandbox
+```
+bin/console test
+>> @qbo_api.get :customer, 1
+```
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/minimul/qbo_api.
@@ -438,11 +423,6 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/minimu
 - All specs that require interaction with the API must be recorded against your personal QuickBooks sandbox. More coming on how to create or modifying existing specs against your sandbox.
 - <a href="http://minimul.com/the-modern-ruby-quickbooks-client-contributing.html" target="_blank">Check out this tutorial and screencast on contributing to qbo_api</a>.
 
-#### Protip: Once your .env file is completely filled out you can use the console to play around in your sandbox
-```
-bin/console test
->> @qbo_api.get :customer, 1
-```
 
 ## License
 

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'
@@ -25,6 +26,7 @@ BASE_APP_CONFIG = proc do
   configure do
     $VERBOSE = nil # silence redefined constant warning
     register Sinatra::Reloader
+    set :public_folder => "#{__dir__}/public"
   end
 
   set :sessions, :true

data/example/oauth2.rb

@@ -24,16 +24,29 @@ class OAuth2App < Sinatra::Base
       Rack::OAuth2::Client.new(
         identifier: CLIENT_ID,
         secret: CLIENT_SECRET,
-        redirect_uri: "http://localhost:#{PORT}/oauth2-redirect",
+        redirect_uri: redirect_url,
         authorization_endpoint: "https://appcenter.intuit.com/connect/oauth2",
         token_endpoint: "https://oauth.platform.intuit.com/oauth2/v1/tokens/bearer"
       )
     end
+
+    def authorize_url(state:)
+      oauth2_client.authorization_uri(
+        client_id: CLIENT_ID,
+        scope: "com.intuit.quickbooks.accounting",
+        redirect_uri: redirect_url,
+        response_type: "code",
+        state: state
+      )
+    end
+
+    def redirect_url
+      "http://localhost:#{PORT}/oauth2-redirect"
+    end
   end
 
   get '/oauth2' do
     session[:state] = SecureRandom.uuid
-    @client = oauth2_client
     erb :oauth2
   end
 

data/example/public/connect-to-qbo.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" style="isolation:isolate" viewBox="0 0 775.39 132"><defs><clipPath id="a"><path d="M0 0h775.39v132H0z"/></clipPath></defs><g clip-path="url(#a)"><path d="M775.395 124c0 4.4-3.6 8-8 8H8c-4.4 0-8-3.6-8-8V8c0-4.4 3.6-8 8-8h759.395c4.4 0 8 3.6 8 8v116z" fill="#328538"/><path d="M775.395 124c0 4.4-3.6 8-8 8H8c-4.4 0-8-3.6-8-8V8c0-4.4 3.6-8 8-8h759.395c4.4 0 8 3.6 8 8v116z" fill="none" vector-effect="non-scaling-stroke" stroke-width="4" stroke="#328538" stroke-miterlimit="10"/><path d="M178.168 56.127c-1.033-1.4-2.38-2.424-4.039-3.07-1.66-.645-3.284-.968-4.869-.968-2.028 0-3.872.368-5.532 1.106a13.005 13.005 0 0 0-4.287 3.042c-1.198 1.292-2.121 2.804-2.766 4.538-.646 1.733-.968 3.614-.968 5.642 0 2.14.313 4.093.941 5.864.627 1.771 1.521 3.291 2.683 4.563a12.012 12.012 0 0 0 4.176 2.96c1.622.703 3.448 1.052 5.477 1.052 2.103 0 3.964-.415 5.588-1.244 1.623-.831 2.932-1.928 3.928-3.292l5.587 3.926a17.878 17.878 0 0 1-6.362 5.063c-2.509 1.198-5.441 1.799-8.796 1.799-3.062 0-5.873-.508-8.437-1.523-2.564-1.014-4.767-2.433-6.611-4.258-1.844-1.826-3.282-4.002-4.314-6.53-1.034-2.524-1.55-5.318-1.55-8.38 0-3.134.544-5.965 1.632-8.492 1.088-2.527 2.582-4.674 4.482-6.445 1.898-1.77 4.14-3.135 6.721-4.094 2.581-.958 5.384-1.437 8.408-1.437 1.255 0 2.564.119 3.928.359 1.365.24 2.675.608 3.928 1.105a19.141 19.141 0 0 1 3.541 1.855 11.42 11.42 0 0 1 2.82 2.654l-5.309 4.205m13.056 16.597c0 1.032.156 2.065.471 3.097a8.468 8.468 0 0 0 1.41 2.767 7.381 7.381 0 0 0 2.378 1.991c.96.517 2.102.774 3.43.774 1.328 0 2.471-.257 3.43-.774a7.42 7.42 0 0 0 2.38-1.991 8.566 8.566 0 0 0 1.41-2.767 10.66 10.66 0 0 0 .47-3.097c0-1.033-.158-2.056-.47-3.071a8.637 8.637 0 0 0-1.41-2.738 7.1 7.1 0 0 0-2.38-1.963c-.959-.5-2.102-.748-3.43-.748-1.328 0-2.47.248-3.43.748a7.063 7.063 0 0 0-2.378 1.963 8.536 8.536 0 0 0-1.41 2.738 10.303 10.303 0 0 0-.471 3.071zm-6.749 0c0-2.103.377-4.011 1.134-5.726.755-1.714 1.779-3.181 3.07-4.398 1.29-1.217 2.821-2.157 4.592-2.821 1.77-.664 3.65-.996 5.642-.996 1.992 0 3.872.332 5.643.996 1.771.664 3.3 1.604 4.592 2.821 1.291 1.217 2.313 2.684 3.071 4.398.754 1.715 1.133 3.623 1.133 5.726 0 2.103-.379 4.02-1.133 5.753-.758 1.733-1.78 3.218-3.071 4.454-1.292 1.236-2.821 2.203-4.592 2.903-1.771.7-3.651 1.052-5.643 1.052s-3.872-.352-5.642-1.052c-1.771-.7-3.302-1.667-4.592-2.903-1.291-1.236-2.315-2.721-3.07-4.454-.757-1.733-1.134-3.65-1.134-5.753m33.91-13.167h6.307v4.26h.111c.589-1.328 1.612-2.498 3.069-3.513 1.457-1.015 3.181-1.521 5.173-1.521 1.734 0 3.218.303 4.454.912 1.234.609 2.249 1.412 3.042 2.408a9.715 9.715 0 0 1 1.742 3.429 14.43 14.43 0 0 1 .554 3.983v16.597h-6.638V71.396c0-.775-.056-1.586-.167-2.435a6.59 6.59 0 0 0-.719-2.294 4.775 4.775 0 0 0-1.521-1.688c-.647-.443-1.504-.664-2.572-.664-1.071 0-1.992.212-2.767.637a5.872 5.872 0 0 0-1.908 1.631 7.188 7.188 0 0 0-1.134 2.296 9.124 9.124 0 0 0-.387 2.628v14.605h-6.639V59.557m30.814 0h6.306v4.26h.111c.588-1.328 1.612-2.498 3.069-3.513 1.458-1.015 3.182-1.521 5.174-1.521 1.732 0 3.217.303 4.452.912 1.236.609 2.25 1.412 3.044 2.408a9.713 9.713 0 0 1 1.741 3.429c.369 1.292.553 2.619.553 3.983v16.597h-6.638V71.396c0-.775-.055-1.586-.166-2.435a6.569 6.569 0 0 0-.718-2.294 4.788 4.788 0 0 0-1.522-1.688c-.646-.443-1.504-.664-2.572-.664-1.07 0-1.992.212-2.766.637a5.851 5.851 0 0 0-1.908 1.631 7.169 7.169 0 0 0-1.135 2.296 9.124 9.124 0 0 0-.387 2.628v14.605h-6.638V59.557m49.51 10.622c0-.848-.12-1.66-.358-2.435a5.614 5.614 0 0 0-1.135-2.047c-.516-.588-1.171-1.06-1.964-1.411-.793-.349-1.724-.525-2.793-.525-1.992 0-3.679.6-5.063 1.799-1.383 1.198-2.148 2.737-2.295 4.619h13.608zm6.639 2.988v.885c0 .294-.019.589-.055.884h-20.192c.072.96.322 1.836.747 2.628a6.69 6.69 0 0 0 1.687 2.048 8.437 8.437 0 0 0 2.378 1.355 7.86 7.86 0 0 0 2.767.497c1.659 0 3.06-.304 4.204-.912a7.856 7.856 0 0 0 2.821-2.518l4.426 3.541c-2.619 3.541-6.418 5.311-11.396 5.311-2.066 0-3.964-.323-5.698-.969-1.734-.644-3.236-1.557-4.509-2.738-1.272-1.179-2.268-2.627-2.987-4.342-.72-1.716-1.078-3.661-1.078-5.837 0-2.139.358-4.084 1.078-5.836.719-1.752 1.706-3.245 2.96-4.481 1.254-1.235 2.738-2.194 4.452-2.878 1.716-.681 3.57-1.022 5.56-1.022 1.844 0 3.55.303 5.118.912a11.122 11.122 0 0 1 4.066 2.71c1.143 1.2 2.038 2.693 2.683 4.483.645 1.788.968 3.881.968 6.279m23.179-6.252c-.518-.738-1.291-1.355-2.324-1.852-1.032-.5-2.084-.748-3.152-.748-1.218 0-2.288.248-3.21.748a6.992 6.992 0 0 0-2.296 1.962 8.446 8.446 0 0 0-1.354 2.739 10.907 10.907 0 0 0-.443 3.07c0 1.033.156 2.057.471 3.07a8.538 8.538 0 0 0 1.409 2.739 7.183 7.183 0 0 0 2.352 1.964c.94.498 2.037.746 3.292.746a8.386 8.386 0 0 0 3.097-.608c1.032-.405 1.862-.996 2.49-1.77l4.149 4.204c-1.107 1.181-2.517 2.094-4.232 2.738-1.715.646-3.568.969-5.56.969-1.956 0-3.808-.314-5.56-.941-1.752-.626-3.283-1.549-4.592-2.766-1.309-1.218-2.341-2.691-3.097-4.426-.756-1.733-1.134-3.707-1.134-5.919 0-2.138.378-4.074 1.134-5.809.756-1.733 1.778-3.208 3.07-4.425a13.728 13.728 0 0 1 4.508-2.821c1.715-.664 3.55-.996 5.506-.996 1.954 0 3.844.369 5.67 1.106 1.826.738 3.272 1.752 4.342 3.043l-4.536 3.983m6.417-2.047v-5.311h4.647v-7.689h6.528v7.689h6.638v5.311h-6.638v12.336c0 1.181.212 2.157.636 2.932.424.774 1.373 1.161 2.849 1.161.443 0 .921-.045 1.439-.137a5.718 5.718 0 0 0 1.382-.415l.222 5.2c-.591.222-1.291.395-2.103.526-.811.129-1.585.194-2.323.194-1.77 0-3.209-.25-4.314-.748-1.107-.497-1.984-1.18-2.628-2.047-.646-.865-1.088-1.862-1.328-2.986a17.355 17.355 0 0 1-.36-3.624V64.868h-4.647m29.872 0v-5.311h4.648v-7.689h6.527v7.689h6.638v5.311h-6.638v12.336c0 1.181.212 2.157.637 2.932.423.774 1.373 1.161 2.849 1.161.443 0 .92-.045 1.438-.137a5.704 5.704 0 0 0 1.382-.415l.222 5.2c-.591.222-1.291.395-2.102.526-.812.129-1.586.194-2.324.194-1.77 0-3.208-.25-4.314-.748-1.107-.497-1.983-1.18-2.628-2.047-.646-.865-1.088-1.862-1.328-2.986a17.356 17.356 0 0 1-.359-3.624V64.868h-4.648m26.444 7.856c0 1.032.156 2.065.469 3.097a8.512 8.512 0 0 0 1.412 2.767 7.381 7.381 0 0 0 2.378 1.991c.958.517 2.102.774 3.43.774 1.328 0 2.471-.257 3.43-.774a7.392 7.392 0 0 0 2.378-1.991 8.531 8.531 0 0 0 1.412-2.767 10.66 10.66 0 0 0 .47-3.097c0-1.033-.158-2.056-.47-3.071a8.601 8.601 0 0 0-1.412-2.738 7.072 7.072 0 0 0-2.378-1.963c-.959-.5-2.102-.748-3.43-.748-1.328 0-2.472.248-3.43.748a7.063 7.063 0 0 0-2.378 1.963 8.58 8.58 0 0 0-1.412 2.738 10.365 10.365 0 0 0-.469 3.071zm-6.749 0c0-2.103.377-4.011 1.133-5.726.756-1.714 1.779-3.181 3.071-4.398 1.29-1.217 2.821-2.157 4.592-2.821 1.77-.664 3.65-.996 5.642-.996 1.992 0 3.872.332 5.643.996 1.771.664 3.3 1.604 4.592 2.821 1.291 1.217 2.313 2.684 3.071 4.398.754 1.715 1.133 3.623 1.133 5.726 0 2.103-.379 4.02-1.133 5.753-.758 1.733-1.78 3.218-3.071 4.454-1.292 1.236-2.821 2.203-4.592 2.903-1.771.7-3.651 1.052-5.643 1.052s-3.872-.352-5.642-1.052c-1.771-.7-3.302-1.667-4.592-2.903-1.292-1.236-2.315-2.721-3.071-4.454-.756-1.733-1.133-3.65-1.133-5.753" fill="#FFF"/><path d="M449.899 52.2c-1.882 0-3.643.351-5.283 1.051-1.641.701-3.053 1.658-4.233 2.876-1.18 1.217-2.111 2.674-2.794 4.371-.682 1.697-1.024 3.541-1.024 5.531 0 2.103.323 4.011.968 5.727.646 1.715 1.551 3.18 2.712 4.397 1.162 1.217 2.554 2.167 4.176 2.85 1.623.682 3.412 1.022 5.367 1.022 1.917 0 3.696-.34 5.339-1.022 1.64-.683 3.05-1.633 4.232-2.85 1.178-1.217 2.101-2.682 2.765-4.397.664-1.716.996-3.624.996-5.727 0-1.99-.313-3.834-.94-5.531-.628-1.697-1.521-3.154-2.683-4.371-1.162-1.218-2.554-2.175-4.177-2.876-1.623-.7-3.429-1.051-5.421-1.051zm23.51 33.912h-23.621c-3.136 0-5.984-.452-8.548-1.356-2.563-.904-4.757-2.213-6.583-3.928-1.825-1.715-3.236-3.818-4.232-6.307-.996-2.489-1.493-5.318-1.493-8.492 0-2.986.525-5.707 1.576-8.16 1.052-2.452 2.517-4.564 4.399-6.333 1.88-1.771 4.101-3.144 6.665-4.123 2.564-.976 5.339-1.464 8.327-1.464 2.986 0 5.753.488 8.298 1.464 2.544.979 4.748 2.352 6.611 4.123 1.861 1.769 3.309 3.881 4.341 6.333 1.034 2.453 1.551 5.174 1.551 8.16 0 1.771-.204 3.393-.609 4.868-.407 1.476-.932 2.813-1.578 4.011a15.475 15.475 0 0 1-2.212 3.155 16.224 16.224 0 0 1-2.573 2.294v.111h9.681v5.644m27.439 0h-6.307v-4.261h-.11c-.591 1.328-1.614 2.498-3.07 3.513-1.457 1.015-3.181 1.522-5.173 1.522-1.733 0-3.217-.305-4.453-.913-1.236-.609-2.25-1.41-3.042-2.408a9.677 9.677 0 0 1-1.744-3.429 14.461 14.461 0 0 1-.553-3.983V59.557h6.639v14.716c0 .773.056 1.586.166 2.434.111.849.351 1.613.719 2.296a4.767 4.767 0 0 0 1.521 1.686c.646.443 1.503.664 2.572.664 1.034 0 1.946-.212 2.74-.636.792-.424 1.438-.968 1.936-1.632a7.23 7.23 0 0 0 1.134-2.296 9.19 9.19 0 0 0 .386-2.626V59.557h6.639v26.555m6.693-26.555h6.639v26.555h-6.639V59.557zm-.941-9.017c0-1.069.397-2 1.189-2.795.794-.792 1.799-1.188 3.016-1.188 1.218 0 2.24.379 3.07 1.134.83.757 1.245 1.705 1.245 2.849 0 1.143-.415 2.093-1.245 2.849-.83.756-1.852 1.133-3.07 1.133-1.217 0-2.222-.395-3.016-1.188-.792-.793-1.189-1.724-1.189-2.794zm32.419 16.375c-.518-.738-1.291-1.355-2.324-1.852-1.032-.5-2.084-.748-3.154-.748-1.217 0-2.286.248-3.208.748a6.962 6.962 0 0 0-2.296 1.962 8.47 8.47 0 0 0-1.356 2.739 10.978 10.978 0 0 0-.442 3.07c0 1.033.157 2.057.47 3.07a8.583 8.583 0 0 0 1.411 2.739 7.183 7.183 0 0 0 2.352 1.964c.94.498 2.036.746 3.291.746a8.395 8.395 0 0 0 3.098-.608c1.032-.405 1.862-.996 2.49-1.77l4.149 4.204c-1.107 1.181-2.517 2.094-4.232 2.738-1.716.646-3.568.969-5.56.969-1.956 0-3.809-.314-5.56-.941-1.752-.626-3.283-1.549-4.592-2.766-1.309-1.218-2.343-2.691-3.097-4.426-.758-1.733-1.135-3.707-1.135-5.919 0-2.138.377-4.074 1.135-5.809.754-1.733 1.778-3.208 3.07-4.425a13.718 13.718 0 0 1 4.508-2.821c1.715-.664 3.55-.996 5.504-.996 1.955 0 3.846.369 5.671 1.106 1.825.738 3.272 1.752 4.343 3.043l-4.536 3.983m7.578-22.627h6.639v26.444h.165l10.07-11.175h8.518l-11.506 12.006 12.225 14.549h-8.795l-10.512-13.609h-.165v13.609h-6.639V44.288zm35.847 35.958h6.252c.885 0 1.843-.063 2.876-.193a9.396 9.396 0 0 0 2.849-.802 5.593 5.593 0 0 0 2.158-1.77c.572-.774.857-1.808.857-3.097 0-2.065-.701-3.504-2.101-4.316-1.403-.811-3.523-1.217-6.363-1.217h-6.528v11.395zm0-17.37h6.196c2.324 0 4.093-.46 5.311-1.383 1.217-.921 1.826-2.23 1.826-3.928 0-1.77-.628-3.022-1.881-3.761-1.255-.739-3.209-1.107-5.864-1.107h-5.588v10.179zm-6.969-15.932h15.268c1.474 0 2.932.175 4.37.525 1.439.351 2.719.923 3.844 1.715 1.126.793 2.038 1.817 2.739 3.071.7 1.253 1.052 2.765 1.052 4.536 0 2.213-.628 4.038-1.881 5.477-1.255 1.439-2.896 2.471-4.924 3.097v.111c2.47.332 4.5 1.292 6.085 2.877 1.585 1.587 2.379 3.707 2.379 6.363 0 2.139-.424 3.936-1.272 5.393-.85 1.456-1.964 2.627-3.348 3.512-1.383.886-2.968 1.522-4.756 1.91a25.792 25.792 0 0 1-5.45.581h-14.106V46.944m39.277 25.78c0 1.032.156 2.065.469 3.097a8.49 8.49 0 0 0 1.411 2.767 7.395 7.395 0 0 0 2.379 1.991c.958.517 2.102.774 3.43.774 1.327 0 2.47-.257 3.43-.774a7.413 7.413 0 0 0 2.378-1.991 8.51 8.51 0 0 0 1.411-2.767c.313-1.032.471-2.065.471-3.097 0-1.033-.158-2.056-.471-3.071a8.578 8.578 0 0 0-1.411-2.738 7.092 7.092 0 0 0-2.378-1.963c-.96-.5-2.103-.748-3.43-.748-1.328 0-2.472.248-3.43.748a7.076 7.076 0 0 0-2.379 1.963 8.558 8.558 0 0 0-1.411 2.738 10.365 10.365 0 0 0-.469 3.071zm-6.749 0c0-2.103.377-4.011 1.133-5.726.756-1.714 1.779-3.181 3.071-4.398 1.29-1.217 2.821-2.157 4.59-2.821 1.771-.664 3.652-.996 5.644-.996 1.991 0 3.872.332 5.643.996 1.769.664 3.3 1.604 4.591 2.821 1.29 1.217 2.314 2.684 3.07 4.398.756 1.715 1.135 3.623 1.135 5.726 0 2.103-.379 4.02-1.135 5.753-.756 1.733-1.78 3.218-3.07 4.454-1.291 1.236-2.822 2.203-4.591 2.903-1.771.7-3.652 1.052-5.643 1.052-1.992 0-3.873-.352-5.644-1.052-1.769-.7-3.3-1.667-4.59-2.903-1.292-1.236-2.315-2.721-3.071-4.454-.756-1.733-1.133-3.65-1.133-5.753m39.11 0c0 1.032.156 2.065.471 3.097a8.47 8.47 0 0 0 1.411 2.767 7.367 7.367 0 0 0 2.377 1.991c.96.517 2.103.774 3.431.774 1.328 0 2.47-.257 3.429-.774a7.41 7.41 0 0 0 2.38-1.991 8.588 8.588 0 0 0 1.411-2.767c.312-1.032.469-2.065.469-3.097 0-1.033-.157-2.056-.469-3.071a8.66 8.66 0 0 0-1.411-2.738 7.09 7.09 0 0 0-2.38-1.963c-.959-.5-2.101-.748-3.429-.748-1.328 0-2.471.248-3.431.748a7.05 7.05 0 0 0-2.377 1.963 8.538 8.538 0 0 0-1.411 2.738 10.303 10.303 0 0 0-.471 3.071zm-6.749 0c0-2.103.377-4.011 1.135-5.726.754-1.714 1.778-3.181 3.069-4.398 1.291-1.217 2.821-2.157 4.592-2.821 1.771-.664 3.651-.996 5.643-.996s3.872.332 5.642.996c1.771.664 3.3 1.604 4.592 2.821 1.291 1.217 2.314 2.684 3.071 4.398.755 1.715 1.133 3.623 1.133 5.726 0 2.103-.378 4.02-1.133 5.753-.757 1.733-1.78 3.218-3.071 4.454-1.292 1.236-2.821 2.203-4.592 2.903-1.77.7-3.65 1.052-5.642 1.052-1.992 0-3.872-.352-5.643-1.052-1.771-.7-3.301-1.667-4.592-2.903-1.291-1.236-2.315-2.721-3.069-4.454-.758-1.733-1.135-3.65-1.135-5.753m34.021-28.436h6.638v26.444h.166l10.068-11.175h8.52l-11.506 12.006 12.226 14.549H691.7l-10.511-13.609h-.166v13.609h-6.638V44.288z" fill="#F4F5F5"/><path d="M717.149 66.639c-.589-.775-1.402-1.448-2.433-2.02a6.867 6.867 0 0 0-3.376-.858c-1.069 0-2.047.222-2.932.664-.885.443-1.328 1.182-1.328 2.214 0 1.033.489 1.759 1.467 2.185.976.424 2.405.856 4.288 1.298.996.222 2 .518 3.014.886 1.014.369 1.936.857 2.767 1.467a7.23 7.23 0 0 1 2.019 2.268c.516.903.773 2.001.773 3.291 0 1.623-.303 2.997-.912 4.122a7.773 7.773 0 0 1-2.433 2.739c-1.015.7-2.196 1.208-3.542 1.52a18.318 18.318 0 0 1-4.177.471c-2.064 0-4.075-.379-6.029-1.134-1.956-.756-3.579-1.835-4.868-3.237l4.37-4.094c.738.96 1.695 1.752 2.876 2.379 1.18.628 2.49.94 3.928.94.479 0 .968-.055 1.466-.165.498-.111.96-.286 1.384-.526.424-.24.764-.561 1.024-.968.256-.406.386-.904.386-1.493 0-1.107-.508-1.9-1.521-2.379-1.016-.48-2.536-.96-4.564-1.438a21.777 21.777 0 0 1-2.904-.859 9.374 9.374 0 0 1-2.517-1.383 6.382 6.382 0 0 1-1.771-2.129c-.443-.848-.664-1.899-.664-3.154 0-1.474.304-2.746.912-3.817a7.867 7.867 0 0 1 2.408-2.628c.995-.682 2.12-1.188 3.373-1.52a15.082 15.082 0 0 1 3.874-.498c1.917 0 3.789.332 5.614.996 1.827.664 3.274 1.677 4.343 3.042l-4.315 3.818" fill="#F4F5F5"/><path d="M95.897 66.634c0-9.662-7.862-17.524-17.525-17.524h-1.604v6.157h1.604c6.269 0 11.368 5.1 11.368 11.367 0 6.27-5.099 11.37-11.368 11.37h-5.507v-37.37h-6.157V84.16h11.664c9.663 0 17.525-7.862 17.525-17.526zM62.793 49.11H51.13c-9.663 0-17.525 7.862-17.525 17.524 0 9.664 7.862 17.526 17.525 17.526h1.604v-6.156H51.13c-6.269 0-11.369-5.1-11.369-11.37 0-6.267 5.1-11.367 11.369-11.367h5.506v37.367h6.157V49.11zm45.991 17.557c0 24.301-19.7 44-44 44-24.301 0-44-19.699-44-44 0-24.3 19.699-44 44-44 24.3 0 44 19.7 44 44z" fill="#FFF"/></g></svg>

data/example/views/oauth2.erb

@@ -3,20 +3,10 @@
   <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>
-
-    <ipp:connectToIntuit></ipp:connectToIntuit>
+  <body style="padding:15px;">
+    <a href="<%= authorize_url(state: session[:state]) %>">
+      <img src="connect-to-qbo.svg" alt="Connect to QuickBooks Online Button" width="400">
+    </a>
   </body>
 </html>

data/lib/qbo_api/api_methods.rb

@@ -1,9 +1,8 @@
 class QboApi
   module ApiMethods
-
     def all(entity, max: 1000, select: nil, inactive: false, params: nil, &block)
-      enumerator = create_all_enumerator(entity, max: max, select: select, inactive: inactive, params: params)
-
+      enumerator = create_all_enumerator(entity, max: max, select: select,
+                                         inactive: inactive, params: params)
       if block_given?
         enumerator.each(&block)
       else
@@ -17,9 +16,6 @@ class QboApi
       request(:get, entity: entity, path: path, params: params)
     end
 
-    # @example
-    #   get(:customer, 5)
-    # @see #get_by_query_filter
     def get(entity, id_or_query_filter_args, params: nil)
       if id_or_query_filter_args.is_a?(Array)
         get_by_query_filter(entity, id_or_query_filter_args, params: params)
@@ -29,11 +25,6 @@ class QboApi
       end
     end
 
-    # @example
-    #   get_by_query_filter(:customer, ["DisplayName", "Dukes Basketball Camp"])
-    #   get_by_query_filter(:customer, ["DisplayName", "LIKE", "Dukes%"])
-    #   get_by_query_filter(:vendor, ["DisplayName", "IN", "(true, false)"])
-    #   get_by_query_filter(:customer, ["DisplayName", "Amy's Bird Sanctuary"])
     def get_by_query_filter(entity, query_filter_args, params: nil)
       query_str = get_query_str(entity, query_filter_args)
       if resp = query(query_str, params: params)
@@ -67,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)
@@ -143,6 +142,5 @@ class QboApi
       resp = get(entity, id)
       build_deactivate(entity, resp)
     end
-
   end
 end

data/lib/qbo_api/attachment.rb

@@ -1,5 +1,11 @@
 class QboApi
   module Attachment
+    def read_attachment(id:)
+      raw_response = connection.get do |request|
+        request.url "#{realm_id}/attachable/#{id}"
+      end
+      response(raw_response, entity: :attachable)
+    end
 
     def upload_attachment(payload:, attachment:)
       content_type = payload['ContentType'] || payload[:ContentType]
@@ -7,19 +13,28 @@ class QboApi
       raw_response = attachment_connection.post do |request|
         request.url "#{realm_id}/upload"
         request.body = {
-            'file_metadata_01':
-                Faraday::UploadIO.new(StringIO.new(payload.to_json), 'application/json', 'attachment.json'),
-            'file_content_01':
-                Faraday::UploadIO.new(attachment, content_type, file_name)
+          'file_metadata_01':
+              Faraday::UploadIO.new(StringIO.new(payload.to_json), 'application/json', 'attachment.json'),
+          'file_content_01':
+              Faraday::UploadIO.new(attachment, content_type, file_name)
         }
       end
       response(raw_response, entity: :attachable)
     end
 
+    # The `attachable` must be the full payload returned in the read response
+    def delete_attachment(attachable:)
+      raw_response = connection.post do |request|
+        request.url "#{realm_id}/attachable?operation=delete"
+        request.body = attachable.to_json
+      end
+
+      response(raw_response, entity: :attachable)
+    end
+
     def attachment_connection
       @attachment_connection ||= authorized_multipart_connection(endpoint_url)
     end
-
   end
 end
 

data/lib/qbo_api/configuration.rb

@@ -1,6 +1,5 @@
 class QboApi
   module Configuration
-
     def logger
       @logger ||= ::Logger.new($stdout)
     end

data/lib/qbo_api/connection.rb

@@ -1,23 +1,20 @@
 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
-    AUTHORIZATION_MIDDLEWARES = []
-
-    def Connection.add_authorization_middleware(strategy_name)
-      Connection::AUTHORIZATION_MIDDLEWARES << strategy_name
-    end
-
     def authorized_json_connection(url, headers: nil)
       headers ||= {}
-      headers['Accept'] ||= 'application/json' # required "we'll only accept JSON". Can be changed to any `+json` media type.
-      headers['Content-Type'] ||= 'application/json;charset=UTF-8' # required when request has a body, else harmless
+      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
@@ -28,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
@@ -35,17 +33,6 @@ class QboApi
       end
     end
 
-    # @example
-    #   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
-    #   end
-    #   raw_response = connection.post {|req|
-    #     req.body = { grant_type: :refresh_token, refresh_token: current_refresh_token }
-    #     req.url '/oauth2/v1/tokens/bearer'
-    #   }
     def build_connection(url, headers: nil)
       Faraday.new(url: url) { |conn|
         conn.response :detailed_logger, QboApi.logger, LOG_TAG if QboApi.log
@@ -54,14 +41,17 @@ class QboApi
       }
     end
 
-    def request(method, path:, entity: nil, payload: nil, params: nil)
-      raw_response = raw_request(method, conn: connection, path: path, params: params, payload: payload)
+    def request(method, path:, entity: nil, payload: nil, params: nil, headers: nil)
+      raw_response = raw_request(method, conn: connection, path: path, params: params, payload: payload, headers: headers)
       response(raw_response, entity: entity)
     end
 
-    def raw_request(method, conn:, path:, payload: nil, params: nil)
+    def raw_request(method, conn:, path:, payload: nil, params: nil, headers: nil)
       path = finalize_path(path, method: method, params: params)
+
       conn.public_send(method) do |req|
+        req.headers = headers if headers
+
         case method
         when :get, :delete
           req.url path
@@ -74,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)
@@ -115,26 +97,18 @@ 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)
-      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
+      conn.request :authorization, 'Bearer', access_token
     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/entity.rb

@@ -1,6 +1,5 @@
 class QboApi
   module Entity
-
     def singular(entity)
       e = snake_to_camel(entity)
       case e
@@ -21,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
@@ -96,6 +108,5 @@ class QboApi
             .tr("-", "_")
             .downcase
     end
-
   end
 end

data/lib/qbo_api/error.rb

@@ -1,4 +1,3 @@
-
 #200 OK	The request succeeded.  However, the response body may contain a <Fault> element, indicating an error.
 #400 Bad request	Generally, the request cannot be fulfilled due to bad syntax. In some cases, this response code is returned for a request with bad authorization data.
 #401 Unauthorized	Authentication or authorization has failed.
@@ -8,10 +7,12 @@
 #500 Internal Server Error	An error occurred on the server while processing the request.  Resubmit request once; if it persists, contact developer support.
 #502 Bad Gateway	The server, while acting as a gateway or proxy, received an invalid response from an inbound server it accessed while attempting to fulfill the request.
 #503 Service Unavailable	The service is temporarily unavailable.
+#504 Gateway Timeout
 # Custom error class for rescuing from all QuickBooks Online errors
 class QboApi
   class Error < StandardError
     attr_reader :fault
+
     def initialize(errors = nil)
       if errors
         @fault = errors
@@ -46,4 +47,7 @@ class QboApi
 
   # Raised when QuickBooks Online returns the HTTP status code 503
   class ServiceUnavailable < Error; end
+
+  # Raised when QuickBooks Online returns the HTTP status code 504
+  class GatewayTimeout < Error; end
 end

data/lib/qbo_api/raise_http_exception.rb

@@ -1,31 +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))
-        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
 
@@ -35,12 +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)
+        method: env.method,
+        url: env.url,
+        status: env.status,
+        error_body: error_body(env.body),
+        intuit_tid: env[:response_headers]['intuit_tid']
       }
     end
 
@@ -78,6 +92,5 @@ module FaradayMiddleware
         }
       end
     end
-
   end
 end

data/lib/qbo_api/supporting.rb

@@ -1,6 +1,5 @@
 class QboApi
   module Supporting
-
     def cdc(entities:, changed_since:)
       path = "#{realm_id}/cdc"
       path = add_params_to_path(path: path, params: { entities: entities, changedSince: cdc_time(changed_since) })
@@ -18,5 +17,19 @@ class QboApi
       request(:get, path: path)
     end
 
+    def deliver(entity, entity_id:, email_address: nil)
+      valid_entities = %i(invoice estimate purchaseorder creditmemo salesreceipt refundreceipt)
+      unless valid_entities.include?(entity.to_sym)
+        raise ArgumentError, "Invalid entity type '#{entity}'. Must be one of: #{valid_entities.join(', ')}"
+      end
+
+      path = "#{realm_id}/#{entity}/#{entity_id}/send"
+      unless email_address.nil?
+        params = { minorversion: 63, sendTo: email_address }
+        path = add_params_to_path(path: path, params: params)
+      end
+      headers = { 'Content-Type' => 'application/octet-stream' }
+      request(:post, path: path, headers: headers)
+    end
   end
 end

data/lib/qbo_api/util.rb

@@ -53,7 +53,6 @@ class QboApi
       end
       uri.to_s
     end
-
   end
 end
 

data/lib/qbo_api/version.rb

@@ -1,3 +1,3 @@
 class QboApi
-  VERSION = "1.8.5"
+  VERSION = "3.0.1"
 end

data/lib/qbo_api.rb

@@ -22,15 +22,15 @@ class QboApi
   include Attachment
   include ApiMethods
 
-  attr_accessor :realm_id
+  attr_accessor :access_token, :realm_id
   attr_accessor :endpoint
 
   V3_ENDPOINT_BASE_URL       = 'https://sandbox-quickbooks.api.intuit.com/v3/company/'
   PAYMENTS_API_BASE_URL      = 'https://sandbox.api.intuit.com/quickbooks/v4/payments'
   LOG_TAG = "[QuickBooks]"
 
-  # @param attributes [Hash<Symbol,String>]
   def initialize(attributes = {})
+    raise ArgumentError, "missing keyword: access_token" unless attributes.key?(:access_token)
     raise ArgumentError, "missing keyword: realm_id" unless attributes.key?(:realm_id)
     attributes = default_attributes.merge!(attributes)
     attributes.each do |attribute, value|

data/qbo_api.gemspec

@@ -18,16 +18,15 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.10"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec"
   spec.add_development_dependency 'webmock'
-  spec.add_development_dependency 'simple_oauth'
   spec.add_development_dependency 'dotenv'
   spec.add_development_dependency 'vcr'
-  spec.add_development_dependency 'awesome_print'
-  spec.add_runtime_dependency 'faraday'
-  spec.add_runtime_dependency 'faraday_middleware'
+  spec.add_development_dependency 'amazing_print'
+  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,45 +1,31 @@
 --- !ruby/object:Gem::Specification
 name: qbo_api
 version: !ruby/object:Gem::Version
-  version: 1.8.5
+  version: 3.0.1
 platform: ruby
 authors:
 - Christian Pelczarski
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2019-08-13 00:00:00.000000000 Z
+date: 2023-01-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.0'
-- !ruby/object:Gem::Dependency
-  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -53,7 +39,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: webmock
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -67,7 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: simple_oauth
+  name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -109,7 +95,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: awesome_print
+  name: amazing_print
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -128,16 +114,16 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.10.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.10.0
 - !ruby/object:Gem::Dependency
-  name: faraday_middleware
+  name: faraday-detailed_logger
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -151,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:
     - - ">="
@@ -178,14 +164,13 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description:
 email:
 - christian@minimul.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".env.example_app.oauth1"
 - ".env.example_app.oauth2"
 - ".env.test"
 - ".gitignore"
@@ -197,8 +182,8 @@ files:
 - bin/console
 - bin/setup
 - example/base.rb
-- example/oauth.rb
 - example/oauth2.rb
+- example/public/connect-to-qbo.svg
 - example/views/customer.erb
 - example/views/index.erb
 - example/views/oauth2.erb
@@ -208,8 +193,6 @@ 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
@@ -221,7 +204,7 @@ homepage: https://github.com/minimul/qbo_api
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -236,8 +219,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.4
-signing_key: 
+rubygems_version: 3.2.22
+signing_key:
 specification_version: 4
 summary: Ruby JSON-only client for QuickBooks Online API v3. Built on top of the Faraday
   gem.

data/.env.example_app.oauth1

@@ -1,2 +0,0 @@
-export QBO_API_CONSUMER_KEY=<Your QuickBooks apps consumer key>
-export QBO_API_CONSUMER_SECRET=<Your QuickBooks apps consumer secret>

data/example/oauth.rb

@@ -1,62 +0,0 @@
-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/lib/qbo_api/connection/oauth1.rb

@@ -1,60 +0,0 @@
-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

@@ -1,24 +0,0 @@
-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