my_john_deere_api 2.5.0 → 3.0.0

data/test/support/vcr/get_refresh_token.yml

@@ -0,0 +1,159 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://sandboxapi.deere.com/platform
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - Faraday v1.3.0
+      Accept:
+      - application/vnd.deere.axiom.v3+json
+      Authorization:
+      - Bearer AccessToken0123456789abcdefghijklmnopqrstuvwxyz
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Wed, 17 Mar 2021 21:38:22 GMT
+      Content-Type:
+      - application/vnd.deere.axiom.v3+json;charset=UTF-8
+      X-Frame-Options:
+      - DENY
+      Cache-Control:
+      - no-store
+      Strict-Transport-Security:
+      - max-age=31536000 ; includeSubDomains
+      X-Xss-Protection:
+      - 1; mode=block
+      X-Content-Type-Options:
+      - nosniff
+      Content-Language:
+      - en
+      Transfer-Encoding:
+      - chunked
+    body:
+      encoding: ASCII-8BIT
+      string: '{"@type":"ApiCatalog","links":[{"@type":"Link","rel":"oauthRequestToken","uri":"https://sandboxapi.deere.com/platform/oauth/request_token"},{"@type":"Link","rel":"oauthAuthorizeRequestToken","uri":"https://operationscenter.deere.com/consentToUseOfData?oauth_token={token}"},{"@type":"Link","rel":"oauthAccessToken","uri":"https://sandboxapi.deere.com/platform/oauth/access_token"},{"@type":"Link","rel":"currentUser","uri":"https://sandboxapi.deere.com/platform/users/@currentUser"},{"@type":"Link","rel":"organizations","uri":"https://sandboxapi.deere.com/platform/organizations"},{"@type":"Link","rel":"currentToken","uri":"https://sandboxapi.deere.com/platform/oauthTokens/@currentToken"},{"@type":"Link","rel":"contributionProducts","uri":"https://sandboxapi.deere.com/platform/contributionProducts"},{"@type":"Link","rel":"contributionDefinitions","uri":"https://sandboxapi.deere.com/platform/contributionDefinitions"},{"@type":"Link","rel":"assetCatalog","uri":"https://sandboxapi.deere.com/platform/assetCatalog"},{"@type":"Link","rel":"agencies","uri":"https://sandboxapi.deere.com/platform/agencies"}]}'
+    http_version: 
+  recorded_at: Wed, 17 Mar 2021 21:38:22 GMT
+- request:
+    method: get
+    uri: https://signin.johndeere.com/oauth2/aus78tnlaysMraFhC1t7/.well-known/oauth-authorization-server
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - Faraday v1.3.0
+      Accept:
+      - application/vnd.deere.axiom.v3+json
+      Authorization:
+      - Bearer AccessToken0123456789abcdefghijklmnopqrstuvwxyz
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Wed, 17 Mar 2021 21:38:22 GMT
+      Server:
+      - nginx
+      Content-Type:
+      - application/json
+      X-Xss-Protection:
+      - '0'
+      P3p:
+      - CP="HONK"
+      Expect-Ct:
+      - report-uri="https://oktaexpectct.report-uri.com/r/t/ct/reportOnly", max-age=0
+      Cache-Control:
+      - max-age=86400, must-revalidate
+      Expires:
+      - Thu, 18 Mar 2021 21:37:54 GMT
+      X-Content-Type-Options:
+      - nosniff
+      Strict-Transport-Security:
+      - max-age=315360000; includeSubDomains
+      X-Okta-Request-Id:
+      - YFJ2zq-5EtNqLxyo29u@LgAABaM
+      Transfer-Encoding:
+      - chunked
+    body:
+      encoding: UTF-8
+      string: '{"issuer":"https://signin.johndeere.com/oauth2/aus78tnlaysMraFhC1t7","authorization_endpoint":"https://signin.johndeere.com/oauth2/aus78tnlaysMraFhC1t7/v1/authorize","token_endpoint":"https://signin.johndeere.com/oauth2/aus78tnlaysMraFhC1t7/v1/token","registration_endpoint":"https://signin.johndeere.com/oauth2/v1/clients","jwks_uri":"https://signin.johndeere.com/oauth2/aus78tnlaysMraFhC1t7/v1/keys","response_types_supported":["code","token","id_token","code
+        id_token","code token","id_token token","code id_token token"],"response_modes_supported":["query","fragment","form_post","okta_post_message"],"grant_types_supported":["authorization_code","implicit","refresh_token","password","client_credentials"],"subject_types_supported":["public"],"scopes_supported":["ag1","ag2","ag3","eq1","eq2","files","jobs","org1","org2","openid","profile","email","address","phone","offline_access"],"token_endpoint_auth_methods_supported":["client_secret_basic","client_secret_post","client_secret_jwt","private_key_jwt","none"],"claims_supported":["ver","jti","iss","aud","iat","exp","cid","uid","scp","sub"],"code_challenge_methods_supported":["S256"],"introspection_endpoint":"https://signin.johndeere.com/oauth2/aus78tnlaysMraFhC1t7/v1/introspect","introspection_endpoint_auth_methods_supported":["client_secret_basic","client_secret_post","client_secret_jwt","private_key_jwt","none"],"revocation_endpoint":"https://signin.johndeere.com/oauth2/aus78tnlaysMraFhC1t7/v1/revoke","revocation_endpoint_auth_methods_supported":["client_secret_basic","client_secret_post","client_secret_jwt","private_key_jwt","none"],"end_session_endpoint":"https://signin.johndeere.com/oauth2/aus78tnlaysMraFhC1t7/v1/logout","request_parameter_supported":true,"request_object_signing_alg_values_supported":["HS256","HS384","HS512","RS256","RS384","RS512","ES256","ES384","ES512"]}'
+    http_version: 
+  recorded_at: Wed, 17 Mar 2021 21:38:22 GMT
+- request:
+    method: post
+    uri: https://signin.johndeere.com/oauth2/aus78tnlaysMraFhC1t7/v1/token
+    body:
+      encoding: UTF-8
+      string: client_id=johndeere-0000000000000000000000000000000000000000&client_secret=0000000000000000000000000000000000000000000000000000000000000000&grant_type=refresh_token&refresh_token=RefreshToken0123456789abcdefghijklmnopqrstuvwxyz
+    headers:
+      User-Agent:
+      - Faraday v1.3.0
+      Content-Type:
+      - application/x-www-form-urlencoded
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Thu, 18 Mar 2021 01:58:10 GMT
+      Server:
+      - nginx
+      Content-Type:
+      - application/json
+      X-Okta-Request-Id:
+      - YFKzsvsT9HdRXpnes1ay1gAAAkw
+      X-Xss-Protection:
+      - '0'
+      P3p:
+      - CP="HONK"
+      X-Rate-Limit-Limit:
+      - '2000'
+      X-Rate-Limit-Remaining:
+      - '1525'
+      X-Rate-Limit-Reset:
+      - '1581334172'
+      Cache-Control:
+      - no-cache, no-store
+      Pragma:
+      - no-cache
+      Expires:
+      - '0'
+      Expect-Ct:
+      - report-uri="https://oktaexpectct.report-uri.com/r/t/ct/reportOnly", max-age=0
+      X-Content-Type-Options:
+      - nosniff
+      Strict-Transport-Security:
+      - max-age=315360000; includeSubDomains
+      X-Robots-Tag:
+      - none
+      Set-Cookie:
+      - JSESSIONID=89716561F6888C4A6EA6D6BD268E0BE7; Path=/; Secure; HttpOnly
+      - sid=""; Expires=Thu, 01-Jan-1970 00:00:10 GMT; Path=/
+      Transfer-Encoding:
+      - chunked
+    body:
+      encoding: UTF-8
+      string: '{"token_type":"Bearer","expires_in":43200,"access_token":"NewAccessToken0123456789abcdefghijklmnopqrstuvwxyz","scope":"ag2
+        ag1 offline_access ag3","refresh_token":"RefreshToken0123456789abcdefghijklmnopqrstuvwxyz"}'
+    http_version: 
+  recorded_at: Thu, 18 Mar 2021 01:58:10 GMT
+recorded_with: VCR 5.0.0

data/test/support/vcr/get_request_url.yml

@@ -0,0 +1,51 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://signin.johndeere.com/oauth2/aus78tnlaysMraFhC1t7/.well-known/oauth-authorization-server
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - Faraday v1.3.0
+      Accept:
+      - application/vnd.deere.axiom.v3+json
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Tue, 16 Mar 2021 21:12:20 GMT
+      Server:
+      - nginx
+      Content-Type:
+      - application/json
+      X-Xss-Protection:
+      - '0'
+      P3p:
+      - CP="HONK"
+      Expect-Ct:
+      - report-uri="https://oktaexpectct.report-uri.com/r/t/ct/reportOnly", max-age=0
+      Cache-Control:
+      - max-age=86400, must-revalidate
+      Expires:
+      - Wed, 17 Mar 2021 21:12:08 GMT
+      X-Content-Type-Options:
+      - nosniff
+      Strict-Transport-Security:
+      - max-age=315360000; includeSubDomains
+      X-Okta-Request-Id:
+      - YFEfNKAOG6XT8F4E1py7RwAACrM
+      Transfer-Encoding:
+      - chunked
+    body:
+      encoding: UTF-8
+      string: '{"issuer":"https://signin.johndeere.com/oauth2/aus78tnlaysMraFhC1t7","authorization_endpoint":"https://signin.johndeere.com/oauth2/aus78tnlaysMraFhC1t7/v1/authorize","token_endpoint":"https://signin.johndeere.com/oauth2/aus78tnlaysMraFhC1t7/v1/token","registration_endpoint":"https://signin.johndeere.com/oauth2/v1/clients","jwks_uri":"https://signin.johndeere.com/oauth2/aus78tnlaysMraFhC1t7/v1/keys","response_types_supported":["code","token","id_token","code
+        id_token","code token","id_token token","code id_token token"],"response_modes_supported":["query","fragment","form_post","okta_post_message"],"grant_types_supported":["authorization_code","implicit","refresh_token","password","client_credentials"],"subject_types_supported":["public"],"scopes_supported":["ag1","ag2","ag3","eq1","eq2","files","jobs","org1","org2","openid","profile","email","address","phone","offline_access"],"token_endpoint_auth_methods_supported":["client_secret_basic","client_secret_post","client_secret_jwt","private_key_jwt","none"],"claims_supported":["ver","jti","iss","aud","iat","exp","cid","uid","scp","sub"],"code_challenge_methods_supported":["S256"],"introspection_endpoint":"https://signin.johndeere.com/oauth2/aus78tnlaysMraFhC1t7/v1/introspect","introspection_endpoint_auth_methods_supported":["client_secret_basic","client_secret_post","client_secret_jwt","private_key_jwt","none"],"revocation_endpoint":"https://signin.johndeere.com/oauth2/aus78tnlaysMraFhC1t7/v1/revoke","revocation_endpoint_auth_methods_supported":["client_secret_basic","client_secret_post","client_secret_jwt","private_key_jwt","none"],"end_session_endpoint":"https://signin.johndeere.com/oauth2/aus78tnlaysMraFhC1t7/v1/logout","request_parameter_supported":true,"request_object_signing_alg_values_supported":["HS256","HS384","HS512","RS256","RS384","RS512","ES256","ES384","ES512"]}'
+    http_version: 
+  recorded_at: Tue, 16 Mar 2021 21:12:21 GMT
+recorded_with: VCR 5.0.0

data/test/support/vcr_setup.rb

@@ -12,14 +12,14 @@ require 'date'
 ##########################################################################
 
 class VcrSetup
-  attr_reader :api_key, :api_secret, :access_token, :access_secret, :verify_code,
-              :contribution_product_id, :contribution_definition_id,
+  attr_reader :api_key, :api_secret, :access_token, :new_access_token, :refresh_token,
+              :verify_code, :contribution_product_id, :contribution_definition_id,
               :placeholders, :organization_id, :asset_id, :field_id, :flag_id
 
-  AUTH_CASSETTES = [:catalog, :get_request_token, :get_access_token]
+  AUTH_CASSETTES = [:catalog, :get_request_url, :get_access_token, :get_refresh_token]
 
   GENERATED_CASSETTES = [
-    :catalog, :get_request_token, :get_access_token,
+    :catalog, :get_request_url, :get_access_token, :get_refresh_token,
     :get_contribution_products, :get_contribution_product,
     :get_contribution_definitions, :get_contribution_definition,
     :get_organizations, :get_organization,
@@ -39,8 +39,9 @@ class VcrSetup
     @uuid = '00000000-0000-0000-0000-000000000000'
     @api_key = 'johndeere-0000000000000000000000000000000000000000'
     @api_secret = '0' * 64
-    @access_token = @uuid
-    @access_secret = '0' * 107 + '='
+    @access_token = 'AccessToken0123456789abcdefghijklmnopqrstuvwxyz'
+    @new_access_token = 'NewAccessToken0123456789abcdefghijklmnopqrstuvwxyz'
+    @refresh_token = 'RefreshToken0123456789abcdefghijklmnopqrstuvwxyz'
     @contribution_product_id = @uuid
     @contribution_definition_id = @uuid
     @organization_id = '000000'
@@ -60,15 +61,16 @@ class VcrSetup
     unless all_cassettes_generated?
       puts "\ngenerating:"
 
-      unless ENV['ACCESS_TOKEN'] && ENV['ACCESS_SECRET']
+      unless File.exist?(token_file)
         generate_cassettes(AUTH_CASSETTES)
       end
 
       @placeholders.merge!(
         ENV['API_KEY'] => @api_key,
         ENV['API_SECRET'] => @api_secret,
-        ENV['ACCESS_TOKEN'] => @access_token,
-        ENV['ACCESS_SECRET'] => @access_secret
+        current_access_token => @access_token,
+        new_access_token => @new_access_token,
+        current_refresh_token => @refresh_token
       )
 
       VCR.use_cassette('temp') do
@@ -77,7 +79,7 @@ class VcrSetup
         set_organization_id
       end
 
-      File.unlink("#{@vcr_dir}/temp.yml")
+      File.unlink("#{@vcr_dir}/temp.yml") if File.exist?("#{@vcr_dir}/temp.yml")
 
       generate_cassettes(GENERATED_CASSETTES)
     end
@@ -92,7 +94,8 @@ class VcrSetup
       api_secret,
       contribution_definition_id: contribution_definition_id,
       environment: :sandbox,
-      access: [access_token, access_secret]
+      token_hash: token_hash,
+      raise_errors: false,
     )
   end
 
@@ -164,6 +167,21 @@ class VcrSetup
     @url = JD::Consumer::URLS[:sandbox]
   end
 
+  def token_hash
+    return @token_hash if defined?(@token_hash)
+
+    @token_hash = JSON.parse(File.read(token_file))
+
+    token = OAuth2::AccessToken.from_hash(auth_client, @token_hash)
+
+    if token.expired?
+      new_token = token.refresh!
+      set_token_hash(new_token)
+    end
+
+    @token_hash
+  end
+
   private
 
   def generate_cassettes(list)
@@ -191,25 +209,61 @@ class VcrSetup
       ENV['API_SECRET'],
       environment: :sandbox,
       contribution_definition_id: ENV['CONTRIBUTION_DEFINITION_ID'],
-      access: [ENV['ACCESS_TOKEN'], ENV['ACCESS_SECRET']]
+      token_hash: token_hash,
+      raise_errors: false,
+    )
+  end
+
+  def token_file
+    './tmp/token_hash.json'
+  end
+
+  def current_access_token
+    token_hash['access_token']
+  end
+
+  def current_refresh_token
+    token_hash['refresh_token']
+  end
+
+  def set_token_hash(token)
+    @token_hash = token.is_a?(Hash) ? token : token.to_hash
+    File.write(token_file, @token_hash.to_json)
+  end
+
+  def auth_client
+    OAuth2::Client.new(
+      ENV['API_KEY'],
+      ENV['API_SECRET'],
+      site: 'https://sandboxapi.deere.com',
+      authorize_url: 'https://signin.johndeere.com/oauth2/aus78tnlaysMraFhC1t7/v1/authorize',
+      token_url: 'https://signin.johndeere.com/oauth2/aus78tnlaysMraFhC1t7/v1/token',
+      raise_errors: false,
     )
   end
 
   def catalog
-    new_client.get('/')
+    new_client.get('/platform')
+    new_client.get('https://signin.johndeere.com/oauth2/aus78tnlaysMraFhC1t7/.well-known/oauth-authorization-server')
   end
 
-  def get_request_token
+  def get_request_url
     @temporary_authorize = JD::Authorize.new(
       ENV['API_KEY'],
       ENV['API_SECRET'],
-      environment: :sandbox
+      environment: :sandbox,
+      scopes: ['ag1', 'ag2', 'ag3'],
+      redirect_uri: 'http://localhost'
     )
 
     @temporary_authorize_url = @temporary_authorize.authorize_url
   end
 
   def get_access_token
+    unless defined?(@temporary_authorize_url)
+      VCR.use_cassette(:get_request_url) { get_request_url }
+    end
+
     puts "\n\n----\nFOLLOW THIS LINK, AND ENTER THE VERIFICATION CODE:\n#{@temporary_authorize_url}\n----\n\n"
     $stdout.print 'Verification Code: '; $stdout.flush
     code = $stdin.gets.chomp
@@ -217,12 +271,19 @@ class VcrSetup
 
     placeholders[code] = verify_code
 
-    @temporary_authorize.verify(code)
+    token = @temporary_authorize.verify(code)
+    set_token_hash(token)
+  end
 
-    unless ENV['ACCESS_TOKEN'] && ENV['ACCESS_SECRET']
-      set_env 'ACCESS_TOKEN', @temporary_authorize.access_token
-      set_env 'ACCESS_SECRET', @temporary_authorize.access_secret
+  def get_refresh_token
+    unless defined?(@temporary_authorize_url)
+      VCR.use_cassette(:get_request_url) { get_request_url }
     end
+
+    old_hash = @temporary_authorize.token_hash || token_hash
+    new_hash = @temporary_authorize.refresh_from_hash(old_hash)
+
+    set_token_hash(new_hash)
   end
 
   def get_contribution_products

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: my_john_deere_api
 version: !ruby/object:Gem::Version
-  version: 2.5.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Jaime Bellmyer
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-31 00:00:00.000000000 Z
+date: 2021-03-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: vcr
@@ -54,19 +54,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 3.7.6
 - !ruby/object:Gem::Dependency
-  name: oauth
+  name: oauth2
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.4
+        version: 1.4.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.4
+        version: 1.4.4
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
@@ -89,7 +89,7 @@ dependencies:
         version: '2.1'
 description: |
   This gem interacts with the My John Deere API. It handles the hard work of
-  John Deere's oAuth 1.0 authentication. It provides REST request methods for
+  John Deere's oAuth 2.0 authentication. It provides REST request methods for
   GET, POST, PUT, and DELETE that abstract away the John Deere-specific headers
   and protocols. It provides convenience methods similar to ActiveRecord so
   you can write things like: `client.organizations.find(123).assets` or
@@ -216,6 +216,8 @@ files:
 - test/lib/my_john_deere_api/version_test.rb
 - test/my_john_deere_api_test.rb
 - test/support/helper.rb
+- test/support/link_helpers.rb
+- test/support/response_helpers.rb
 - test/support/vcr/accessor/delete_failed.yml
 - test/support/vcr/accessor/delete_invalid.yml
 - test/support/vcr/accessor/delete_max_failed.yml
@@ -251,7 +253,8 @@ files:
 - test/support/vcr/get_flags.yml
 - test/support/vcr/get_organization.yml
 - test/support/vcr/get_organizations.yml
-- test/support/vcr/get_request_token.yml
+- test/support/vcr/get_refresh_token.yml
+- test/support/vcr/get_request_url.yml
 - test/support/vcr/post_asset_locations.yml
 - test/support/vcr/post_assets.yml
 - test/support/vcr/put_asset.yml
@@ -276,7 +279,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Interact with John Deere's Developer API