intuit-oauth 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 917700b85f046e6e952c1f166e3c96e0282f7c0e
-  data.tar.gz: 948f26d5fa00930af1aed91da1bf7106878b4bf7
+  metadata.gz: 984eb647d2b31559868614b3386ca08323589113
+  data.tar.gz: 7c0a99abf33f9b08c72d433f842a2b9a3f76db37
 SHA512:
-  metadata.gz: fa1cd5b48ac1ca359eafc48615b7feaca03aa050dab44b5ca26ada1cb58a7dd672a4f905741ca57a6b18d5da842321348567b1eec052da408bab577e4fd688e4
-  data.tar.gz: 3b0fb963c737087bb5ee9200f0ab3cc0f7bb49c2d0f9cd274d6fea9eff39cec46d24abd44cd47b6f243b8fa0d6c4f55af237432b3ed25f78682914cfe7876795
+  metadata.gz: 96de210f4e134fce0c26aee789dbfb95d44bc727dd1827be12327612f8c28f5f4e64f33d308b55c7fe034a4460b0c20429d6dd034287ffe8249b7bc229310620
+  data.tar.gz: ae7a0c38ca37ff3acaa563dd29765d6ed872597fe5257b4c46d4e3fb6b257348650d72387cc3cc1963de88bc521f88672d0c61d87c69fe9529ff9fd9de09b9eb

data/Gemfile.lock

@@ -2,9 +2,13 @@ GEM
   remote: https://rubygems.org/
   specs:
     diff-lcs (1.3)
-    httparty (0.16.2)
+    httparty (0.17.0)
+      mime-types (~> 3.0)
       multi_xml (>= 0.5.2)
     json (2.1.0)
+    mime-types (3.2.2)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2019.0331)
     multi_xml (0.6.0)
     rspec (3.8.0)
       rspec-core (~> 3.8.0)

data/README.md

@@ -1,107 +1,124 @@
+[![SDK Banner](views/SDK.png)](https://help.developer.intuit.com/s/SDKFeedback?cid=1130)
+
 # oauth-rubyclient
 
+[![Gem Version](https://badge.fury.io/rb/intuit-oauth.svg)](https://badge.fury.io/rb/intuit-oauth)
+
 Intuit OAuth Ruby Client
 ==========================
 
-This client library is meant to work with Intuit's OAuth and OpenID implementation. The `AuthClient` object response can be used for User Info API, Accounting API and Payments API. This library supports:
-
-- Generating Authorization URL
-- Getting OAuth2 Bearer Token 
-- Getting User Info 
-- Validating OpenID token
-- Refreshing OAuth2 Token
-- Revoking OAuth2 Token
-- Migrating tokens from OAuth1.0 to OAuth2
-
-## Installation
+This tutorial describes how to use Intuit Ruby OAuth Client Library to generate access tokens for your QuickBooks Online Companies data. The Ruby OAuth Client Library  provides a set of methods that make it easier to work with Intuit’s OAuth and OpenID protocol:
 
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'intuit-oauth'
-```
+  - Generating Authorization URL
+  - Getting OAuth2 Bearer Token
+  - Getting User Info
+  - Validating OpenID token
+  - Refreshing OAuth2 Token
+  - Revoking OAuth2 Token
+  - Migrating tokens from OAuth1.0 to OAuth2
+ 
+ If you are not familiar with Intuit OAuth protocol, please refer to [Authentication and authorization page](https://developer.intuit.com/app/developer/qbo/docs/develop/authentication-and-authorization/oauth-2.0) for general information on OAuth.
+ 
+The Ruby OAuth client would require Ruby version >= 1.9.0, and RubyGem version >= 1.3.5
 
-And then execute:
 
-    $ bundle
+### Installation
 
-Or install it yourself as:
+The Ruby OAuth library use gem for installation. To install the library, run:
 
     $ gem install 'intuit-oauth'
     
-## Usage Examples
-
-The below example tells how to construct the IntuitOAuth Client and use it to generate an OAuth 2 token.
-
-```ruby
-require 'intuit-oauth'
-
-client = IntuitOAuth::Client.new('client_id', 'client_secret', 'redirectUrl', 'environment')
-scopes = [
-    IntuitOAuth::Scopes::ACCOUNTING
-]
-
-authorizationCodeUrl = oauth_client.code.get_auth_uri(scopes)
-# => https://appcenter.intuit.com/connect/oauth2?client_id=clientId&redirect_uri=redirectUrl&response_type=code&scope=com.intuit.quickbooks.accounting&state=rMwcoDITc2N6FJsUGGO9
-
-oauth2Token = oauth_client.token.get_bearer_token('the authorization code returned from authorizationCodeUrl')
-# => #<IntuitOAuth::ClientResponse:0x00007f9152b5c418 @access_token="the access token", @expires_in=3600, @refresh_token="the refresh token", @x_refresh_token_expires_in=8726400>
-
-```
-
-### Initialize OAuth client object
+You can also download the source code and run:
 
-Create an OAuth 2 client to send requests
+    $ gem build intuit-oauth.gemspec
 
-    oauth_client = IntuitOAuth::Client.new('YourClientID', 'YourClientSecret', 'http://localhost:3000/token/new', 'sandbox')
+to build your own gem if you want to modify a certain functions in the library
+    
+### Create client instance
 
-### Add scopes
+In order to start using the library, the first step is to create a client object. Instantiate the IntuitOAuth object with app’s ClientID, ClientSecret, Redirect URL and the right environment. Valid values for environment include sandbox and production. redirect_uri should be set in your Intuit Developer app’s Keys tab under the right environment. 
 
-Define the scopes for the app
+  ```ruby
+  require 'intuit-oauth'
+  
+  oauth_client = IntuitOAuth::Client.new('client_id', 'client_secret', 'redirectUrl', 'environment')
+  ```
 
-    scopes = [
-        IntuitOAuth::Scopes::ACCOUNTING
-    ]
-    
 ### General Authorization Code URL
 
-The URL for users to click on the "Authorizate" button. An authorization code will sent to the redirect URL defined in your app
+After the client is created, use the client object to generate authorization URL by specifying scopes. It is shown below in code:
+
+ ```ruby
+  scopes = [
+    IntuitOAuth::Scopes::ACCOUNTING
+  ]
+  
+  authorizationCodeUrl = oauth_client.code.get_auth_uri(scopes)
+  # => https://appcenter.intuit.com/connect/oauth2?   client_id=clientId&redirect_uri=redirectUrl&response_type=code&scope=com.intuit.quickbooks.accounting&state=rMwcoDITc2N6FJsUGGO9
+  ```
+Redirect your users to the authorizationCodeUrl, and an authorization code will be sent to the Redirect URL defined. The authorization code will be used to exchange for an oAuth 2.0 access token later. 
 
-    url = oauth_client.code.get_auth_uri(scopes)
-    
 ### Exchange Authorization Code for OAuth 2.0 Token
 
-Once the user has authorized your app, an authorization code will be sent to your Redirect_URL defined in your client. Exchange the authorization code for an OAuth 2.0 token object.
+Once the user has authorized your app, an authorization code will be sent to your RedirectURL defined in your client. Exchange the authorization code for an OAuth 2.0 token object.
 
     result = oauth_client.token.get_bearer_token('The_authorization_code')
     
-    
 ### Refresh Token
 
-Refresh the OAuth 2.0 token using refresh token. Remember to store the OAuth 2.0 refresh token to your own database.
+Your app must keep track of when a stored access token can be used and when the token must be refreshed. Use the refresh method to refresh the token when the token expired. ALWAYS STORE THE LATEST REFRESH TOKEN RETURNED. Below is an exanmple how to use the refresh method to refresh token:
 
     newToken = oauth_client.token.refresh_tokens('Your_refresh_token')
     
+### Revoke Token
+
+If your app is disconnected by the user, you would need to revoke the token. Use revoke_tokens method to revoke the token:
+
+    trueOrFalse = oauth_client.token.revoke_tokens('the_token_you_want_to_revoke')
+
+
 ### Get User Info
 
-Get the user info based on the scopes for OpenID
+If OpenID scope is set when you generate the authorization URL, you can use get_user_info to get the user information:
 
     result=oauth_client.openid.get_user_info('accessToken')
+    
+
 
 ### Call migration method
 
 If you have migrated your OAuth 1.0 app to OAuth 2.0 app, and want to exchange your OAuth 1.0 token to OAuth 2.0 token, use migrate_tokens method
 
-    result=oauth_client.Migrate.migrate_tokens(consumer_key, consumer_secret, access_token, access_secret, scopes)
+    result=oauth_client.migration.migrate_tokens(consumer_key, consumer_secret, access_token, access_secret, scopes)
+
+### A Complete Usage Example for Creating OAuth 2.0 token
+
+The below example tells how to construct the IntuitOAuth Client and use it to generate an OAuth 2 token.
+
+```ruby
+require 'intuit-oauth'
+
+oauth_client = IntuitOAuth::Client.new('client_id', 'client_secret', 'redirectUrl', 'environment')
+scopes = [
+    IntuitOAuth::Scopes::ACCOUNTING
+]
+
+authorizationCodeUrl = oauth_client.code.get_auth_uri(scopes)
+# => https://appcenter.intuit.com/connect/oauth2?client_id=clientId&redirect_uri=redirectUrl&response_type=code&scope=com.intuit.quickbooks.accounting&state=rMwcoDITc2N6FJsUGGO9
+
+oauth2Token = oauth_client.token.get_bearer_token('the authorization code returned from authorizationCodeUrl')
+# => #<IntuitOAuth::ClientResponse:0x00007f9152b5c418 @access_token="the access token", @expires_in=3600, @refresh_token="the refresh token", @x_refresh_token_expires_in=8726400>
+
+```
     
 Issues and Contributions
 ------------------------
 
-Please open an `issue <https://github.com/intuit/oauth-rubyclient/issues>` on GitHub if you have a problem, suggestion, or other comment.
+Please open an [issue](https://github.com/intuit/oauth-rubyclient/issues) on GitHub if you have a problem, suggestion, or other comment.
 
 Pull requests are welcome and encouraged! Any contributions should include new or updated unit tests as necessary to maintain thorough test coverage.
 
 License
 -------
 
-intuit-oauth is provided under Apache 2.0 found `<https://github.intuit.com/hlu2/oauth-rubyclient/blob/master/LICENSE>`__
+Intuit-oauth Ruby gem is provided under Apache 2.0 License

data/intuit-oauth.gemspec

@@ -4,9 +4,8 @@ lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
-  spec.add_dependency 'httparty', '~> 0.16.3'
+  spec.add_dependency 'httparty', '>= 0.16.3'
   spec.add_dependency 'json', '~> 2.1'
-  spec.add_dependency 'json_web_token', '~> 0.3.5'
   spec.add_dependency 'rsa-pem-from-mod-exp', '~> 0.1.0'
 
   spec.authors       = ['Intuit Inc']
@@ -18,7 +17,7 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = '>= 1.9.0'
   spec.required_rubygems_version = '>= 1.3.5'
   spec.summary       = 'A Ruby wrapper for the OAuth 2.0 protocol.'
-  spec.version       = '1.0.0'
+  spec.version       = '1.0.1'
 
   spec.require_paths = %w[lib]
   spec.bindir        = 'exe'

data/lib/intuit-oauth/flow/openid.rb

@@ -13,7 +13,6 @@
 # limitations under the License.
 
 require 'rsa_pem'
-require 'json_web_token'
 
 require_relative '../base'
 

data/lib/intuit-oauth/migration.rb

@@ -47,6 +47,7 @@ module IntuitOAuth
         oauth1_header = IntuitOAuth::Utils.get_oauth1_header('POST', migration_endpoint, oauth1_tokens)
         headers = {
           'Content-Type': 'application/json',
+          Accept: 'application/json',
           Authorization: oauth1_header
         }
 
@@ -57,7 +58,7 @@ module IntuitOAuth
           client_secret: @client.secret
         }
 
-        IntuitOAuth::Transport.request('POST', migration_endpoint, headers, body)
+        IntuitOAuth::Transport.request('POST', migration_endpoint, headers, body.to_json)
       end
 
     end

data/views/PRSWidget.txt

@@ -0,0 +1 @@
+This is the folder for PRS view image

metadata

@@ -1,27 +1,27 @@
 --- !ruby/object:Gem::Specification
 name: intuit-oauth
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Intuit Inc
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-01-03 00:00:00.000000000 Z
+date: 2019-09-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.16.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.16.3
 - !ruby/object:Gem::Dependency
@@ -38,20 +38,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.1'
-- !ruby/object:Gem::Dependency
-  name: json_web_token
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.3.5
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.3.5
 - !ruby/object:Gem::Dependency
   name: rsa-pem-from-mod-exp
   requirement: !ruby/object:Gem::Requirement
@@ -208,6 +194,8 @@ files:
 - lib/intuit-oauth/response.rb
 - lib/intuit-oauth/transport.rb
 - lib/intuit-oauth/utils.rb
+- views/PRSWidget.txt
+- views/SDK.png
 homepage: https://github.com/intuit/oauth-rubyclient
 licenses:
 - Apache-2.0