my_john_deere_api 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0a4a505a402a82195b10345e48301897a6af477a4ba60711c33caee9d77ba764
-  data.tar.gz: 4f3f21b7b110b76be7bcc99195b380a3d05154443cbab36732e1f32a0dc830b2
+  metadata.gz: d9e4802c00252cf2770981858362b93cd8b97791e33107bcb7f5edb75c4466bc
+  data.tar.gz: bb0b07d289995ecd438978c6b5754e9e348e8f2cf7073d865f0e4b19c4afb934
 SHA512:
-  metadata.gz: 19b70538ef4d795113246f269c97f6efe22cd2ccb79903d5433ee8aad79fc5823eb383e047bac8409f37f73a01658519a2fa3ceb10740416945833db8e9f6388
-  data.tar.gz: f0bbf336465ab99361e74e5102abd2dc6ebb2b74116988e5c9b8319aa28a2bf104a02c5209d2759904624ddd340aa9db019f819d93d20a63f2a5d82ae1b6450d
+  metadata.gz: 46140b980eff6e3c8c8299b290219e168c822b4b91a405a6685af3453717e0d93e49e0eb9fba2fc601022279488802d638d5416dc8a406dda7fce2035bb5e275
+  data.tar.gz: ad162f92e55a7012997a15ee91b1c6040af309455e78bf25fcc7114770534f53cceb9fe69d1def94cc6ff0ab053de7c7459efc8776100abac55192ecad5e165a

data/lib/my_john_deere_api/authorize.rb

@@ -1,36 +1,84 @@
 class MyJohnDeereApi::Authorize
-  attr_reader :api_key, :api_secret, :request_token, :request_secret
+  attr_reader :api_key, :api_secret, :request_token, :request_secret, :access_token, :access_secret, :environment
   attr_accessor :base_url
 
+  URLS = {
+    sandbox: 'https://sandboxapi.deere.com',
+    production: 'https://api.soa-proxy.deere.com',
+  }
+
   DEFAULTS = {
-    base_url: 'https://api.soa-proxy.deere.com',
+    environment: :production,
   }
 
+  ##
+  # Create an Authorize object using your John Deere API key/secret.
+  #
+  # Options:
+  #
+  # [:environment] *:production* or *:sandbox*, determines the base url
+  #                used to make oauth requests.
+  #
+  # [:base_url] set the base url directly, since in the future,
+  #             *environment* may affect other things.
+
   def initialize(api_key, api_secret, options={})
+    options = DEFAULTS.merge(options)
+
     @api_key = api_key
     @api_secret = api_secret
-    @base_url = options[:base_url] || ENV['MY_JOHN_DEERE_URL'] || DEFAULTS[:base_url]
+    @environment = options[:environment]
+    @base_url = options[:base_url] || URLS[@environment]
   end
 
+  ##
+  # Option a url which may be used to obtain a verification
+  # code from the oauth server.
+
   def authorize_url
     return @authorize_url if defined?(@authorize_url)
 
     requester = app_consumer.get_request_token
-
     @request_token = requester.token
     @request_secret = requester.secret
 
     @authorize_url = requester.authorize_url
   end
 
+  ##
+  # Turn a verification code into access tokens. If this is
+  # run from a separate process than the one that created
+  # the initial RequestToken, the request token/secret
+  # can be passed in.
+
+  def verify(code, token=nil, secret=nil)
+    token ||= request_token
+    secret ||= request_secret
+
+    requester = OAuth::RequestToken.new(app_consumer, token, secret)
+    access_object = requester.get_access_token(oauth_verifier: code)
+    @access_token = access_object.token
+    @access_secret = access_object.secret
+    nil
+  end
+
+  ##
+  # oAuth Consumer which uses just the base url, for
+  # app-wide, non user-specific requests.
+
   def app_consumer
     @app_consumer ||= consumer(base_url)
   end
 
+  ##
+  # oAuth Consumer which uses the proper url for user-specific requests.
+
   def user_consumer
     @user_consumer ||= consumer("#{base_url}/platform")
   end
 
+  private
+
   def consumer(site)
     OAuth::Consumer.new(
       api_key,
@@ -68,8 +116,6 @@ class MyJohnDeereApi::Authorize
       @links
   end
 
-  private
-
   def header
     {accept: 'application/vnd.deere.axiom.v3+json'}
   end

data/lib/my_john_deere_api/version.rb

@@ -1,3 +1,3 @@
 module MyJohnDeereApi
-  VERSION='0.0.2'
+  VERSION='0.0.3'
 end

data/test/lib/test_authorize.rb

@@ -2,7 +2,6 @@ require 'uri'
 require 'cgi'
 require 'support/helper'
 
-URL_ENV = 'MY_JOHN_DEERE_URL'
 TOKEN_PATTERN = /^[0-9a-z\-]+$/
 SECRET_PATTERN = /^[0-9A-Za-z\-+=\/]+$/
 API_KEY = ENV['API_KEY']
@@ -13,7 +12,7 @@ def contains_parameters?(uri)
 end
 
 def create_authorize
-  JD::Authorize.new(API_KEY, API_SECRET, base_url: 'https://sandboxapi.deere.com')
+  JD::Authorize.new(API_KEY, API_SECRET, environment: :sandbox)
 end
 
 def fancy_url
@@ -29,18 +28,24 @@ class AuthorizeTest < MiniTest::Test
       assert_equal 'secret', authorize.api_secret
     end
 
-    it "can set the base_url" do
-      authorize = JD::Authorize.new('key', 'secret', base_url: fancy_url)
-      assert_equal fancy_url, authorize.base_url
+    it 'defaults to production environment' do
+      authorize = JD::Authorize.new('key', 'secret')
+      assert_equal :production, authorize.environment
     end
 
-    it 'prefers passed-in base_url over ENV variable' do
-      ENV[URL_ENV] = 'https://example.com/disposable'
+    it 'defaults to production oauth url' do
+      authorize = JD::Authorize.new('key', 'secret')
+      assert_equal 'https://api.soa-proxy.deere.com', authorize.base_url
+    end
 
-      authorize = JD::Authorize.new('key', 'secret', base_url: fancy_url)
-      assert_equal fancy_url, authorize.base_url
+    it "can set the environment" do
+      authorize = JD::Authorize.new('key', 'secret', environment: :sandbox)
+      assert_equal :sandbox, authorize.environment
+    end
 
-      ENV.delete(URL_ENV)
+    it "can set the base_url via the environment" do
+      authorize = JD::Authorize.new('key', 'secret', environment: :sandbox)
+      assert_equal 'https://sandboxapi.deere.com', authorize.base_url
     end
   end
 
@@ -50,7 +55,7 @@ class AuthorizeTest < MiniTest::Test
 
       url = VCR.use_cassette('get_request_token') { authorize.authorize_url }
 
-      assert_includes url, "#{authorize.links[:authorize_request_token]}?oauth_token="
+      assert_includes url, "#{authorize.send(:links)[:authorize_request_token]}?oauth_token="
 
       query = URI.parse(url).query
       params = CGI::parse(query)
@@ -68,11 +73,24 @@ class AuthorizeTest < MiniTest::Test
     end
   end
 
+  describe '#verify(code, token, secret)' do
+    it 'sets the access token/secret' do
+      authorize = create_authorize
+      code = 'VERIFY'
+
+      VCR.use_cassette('get_request_token') { authorize.authorize_url }
+      VCR.use_cassette('get_access_token') { authorize.verify(code) }
+
+      assert_match TOKEN_PATTERN, authorize.access_token
+      assert_match SECRET_PATTERN, authorize.access_secret
+    end
+  end
+
   describe '#links' do
     it "returns a list of catalog urls" do
       authorize = create_authorize
 
-      links = VCR.use_cassette("catalog"){ authorize.links }
+      links = VCR.use_cassette("catalog"){ authorize.send(:links) }
 
       assert_kind_of Hash, links
 
@@ -95,15 +113,6 @@ class AuthorizeTest < MiniTest::Test
 
       assert_equal fancy_url, authorize.base_url
     end
-
-    it 'can be set via environment variable' do
-      ENV[URL_ENV] = fancy_url
-
-      authorize = JD::Authorize.new('key', 'secret')
-      assert_equal fancy_url, authorize.base_url
-
-      ENV.delete(URL_ENV)
-    end
   end
 
   describe '#app_consumer' do

data/test/support/vcr/get_access_token.yml

@@ -0,0 +1,41 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://sandboxapi.deere.com/platform/oauth/access_token
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      User-Agent:
+      - OAuth gem v0.5.4
+      Authorization:
+      - OAuth oauth_consumer_key="johndeere-wgmADngYCRmfpEbVgSyc709wnyRux5J7PAv8SE7B",
+        oauth_nonce="MLB5WFGhx3XqZSEqSLLMqN0rmZzVrpIcJifmmkHY", oauth_signature="EQuzjWYlzL2BdLApWuDmSIGWsuU%3D",
+        oauth_signature_method="HMAC-SHA1", oauth_timestamp="1578342382", oauth_token="e9d13b08-0c49-412c-8d65-b705b2a6172a",
+        oauth_verifier="VERIFY", oauth_version="1.0"
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Mon, 06 Jan 2020 20:26:22 GMT
+      Content-Type:
+      - text/plain;charset=UTF-8
+      X-Deere-Handling-Server:
+      - ip-10-214-44-17
+      Vary:
+      - Accept-Encoding
+      Transfer-Encoding:
+      - chunked
+    body:
+      encoding: ASCII-8BIT
+      string: oauth_token=47bbb9c9-41a8-4bec-8127-e3c5760af2f6&oauth_token_secret=ih3PKeoCJFbAeHcEpxn6l8cTAaQJSVzzRtemOvekXLGOsQCLUOifPOyQqZSrcYpiBXI3eJ2r0JUaCv79vsxTe1ngvrllBPjveSLg4%2Bsajmk%3D
+    http_version:
+  recorded_at: Mon, 06 Jan 2020 20:26:22 GMT
+recorded_with: VCR 5.0.0

data/test/support/vcr/get_request_token.yml

@@ -15,23 +15,23 @@ http_interactions:
       - OAuth gem v0.5.4
       Authorization:
       - OAuth oauth_consumer_key="johndeere-wgmADngYCRmfpEbVgSyc709wnyRux5J7PAv8SE7B",
-        oauth_nonce="bA9m9jeEEXtDVO6t3evCoJcxWV6ask0dqv90ULA", oauth_signature="URbHoE5qi3YLnZlA5FiS6mloDPE%3D",
-        oauth_signature_method="HMAC-SHA1", oauth_timestamp="1578170525", oauth_version="1.0"
+        oauth_nonce="33cQ0E7MKtFZJ8sv9mSSQ9Yvmg1YaEV9fSbrZ2qLns", oauth_signature="0GPAESRHRjGfHXaZQ%2BYrOjn3%2BMc%3D",
+        oauth_signature_method="HMAC-SHA1", oauth_timestamp="1578342367", oauth_version="1.0"
   response:
     status:
       code: 200
       message: OK
     headers:
       Date:
-      - Sat, 04 Jan 2020 20:42:06 GMT
+      - Mon, 06 Jan 2020 20:26:07 GMT
       Content-Type:
       - application/vnd.deere.axiom.v3+json;charset=UTF-8
       X-Deere-Handling-Server:
-      - ip-10-214-45-13
+      - ip-10-214-44-57
       X-Frame-Options:
       - SAMEORIGIN
       X-Deere-Elapsed-Ms:
-      - '14'
+      - '17'
       Cache-Control:
       - no-store
       Content-Language:
@@ -42,7 +42,7 @@ http_interactions:
       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://my.deere.com/consentToUseOfData?oauth_token={token}"},{"@type":"Link","rel":"oauthAccessToken","uri":"https://sandboxapi.deere.com/platform/oauth/access_token"},{"@type":"Link","rel":"agencies","uri":"https://sandboxapi.deere.com/platform/agencies"}]}'
     http_version: 
-  recorded_at: Sat, 04 Jan 2020 20:42:07 GMT
+  recorded_at: Mon, 06 Jan 2020 20:26:08 GMT
 - request:
     method: get
     uri: https://sandboxapi.deere.com/platform/oauth/request_token
@@ -58,26 +58,26 @@ http_interactions:
       - OAuth gem v0.5.4
       Authorization:
       - OAuth oauth_callback="oob", oauth_consumer_key="johndeere-wgmADngYCRmfpEbVgSyc709wnyRux5J7PAv8SE7B",
-        oauth_nonce="D1Wa1SttrwCzWrFAAoEDUUyRmzVRkd6ka8rpAmWw8", oauth_signature="HciHAu%2Bojp4olApwEKk14WrhMt0%3D",
-        oauth_signature_method="HMAC-SHA1", oauth_timestamp="1578170527", oauth_version="1.0"
+        oauth_nonce="U5e97z9K7RNHoENuAOeS5f2xK2m4znRsPh8Ynh2hQ", oauth_signature="eqQGoXU45sfdoiq%2BghH8xMjv8Ek%3D",
+        oauth_signature_method="HMAC-SHA1", oauth_timestamp="1578342368", oauth_version="1.0"
   response:
     status:
       code: 200
       message: OK
     headers:
       Date:
-      - Sat, 04 Jan 2020 20:42:07 GMT
+      - Mon, 06 Jan 2020 20:26:08 GMT
       Content-Type:
       - text/plain;charset=UTF-8
       X-Deere-Handling-Server:
-      - ip-10-214-45-13
+      - ip-10-214-44-190
       Vary:
       - Accept-Encoding
       Transfer-Encoding:
       - chunked
     body:
       encoding: ASCII-8BIT
-      string: oauth_token=27f8a03d-cda3-4b80-a42d-8f10065448e5&oauth_token_secret=mAsr2Tfy4YGUOrZG1%2BhIMefCIqom1yCQ90mXsQm7TOEjh%2B3HpRKgif8DrCdhNcKB31lpZqKbxX%2FKSD3xseT1BsFeFRlJPADHGd78B1mWtJI%3D&oauth_callback_confirmed=true
+      string: oauth_token=e9d13b08-0c49-412c-8d65-b705b2a6172a&oauth_token_secret=IWI0xnmlsYi1bqgqXvrVlfWmC0d4teqtjs7W0fZT6ofObcOLcrLDxDnVE2gBYZUepY%2BPE6r97Li8bgbNWYauVMnnDMenFW93Twb%2B%2FVpaUjQ%3D&oauth_callback_confirmed=true
     http_version: 
-  recorded_at: Sat, 04 Jan 2020 20:42:08 GMT
+  recorded_at: Mon, 06 Jan 2020 20:26:08 GMT
 recorded_with: VCR 5.0.0

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: my_john_deere_api
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Jaime. Bellmyer
@@ -103,6 +103,7 @@ files:
 - test/support/helper.rb
 - test/support/vcr/app_consumer.yml
 - test/support/vcr/catalog.yml
+- test/support/vcr/get_access_token.yml
 - test/support/vcr/get_request_token.yml
 - test/test_my_john_deere_api.rb
 homepage: https://github.com/Intellifarm/my_john_deere_api