my_john_deere_api 2.5.0 → 3.0.0

data/lib/my_john_deere_api/version.rb

@@ -1,3 +1,3 @@
 module MyJohnDeereApi
-  VERSION='2.5.0'
+  VERSION='3.0.0'
 end

data/test/lib/my_john_deere_api/authorize_test.rb

@@ -31,13 +31,12 @@ describe 'MyJohnDeereApi::Authorize' do
     end
   end
 
-  describe '#consumer' do
-    it "returns a non-user-specific consumer configured for GET requests" do
+  describe '#oauth_client' do
+    it "returns a non-user-specific client" do
       authorize = create_authorize
-      consumer = VCR.use_cassette('catalog') { authorize.consumer }
+      consumer = VCR.use_cassette('catalog') { authorize.oauth_client }
 
-      assert_kind_of OAuth::Consumer, consumer
-      assert_equal :get, consumer.http_method
+      assert_kind_of OAuth2::Client, consumer
     end
   end
 
@@ -45,37 +44,50 @@ describe 'MyJohnDeereApi::Authorize' do
     it 'retrieves a request url' do
       authorize = create_authorize
 
-      url = VCR.use_cassette('get_request_token') { authorize.authorize_url }
-      links = VCR.use_cassette('catalog') { JD::Consumer.new(api_key, api_secret, environment: :sandbox).send(:links) }
+      url = VCR.use_cassette('get_request_url') { authorize.authorize_url }
+      links = VCR.use_cassette('catalog') { JD::Consumer.new(api_key, api_secret, environment: :sandbox).send(:authorization_links) }
 
-      assert_includes url, links[:authorize_request_token]
-
-      query = URI.parse(url).query
-      params = CGI::parse(query)
-
-      assert_match(TOKEN_PATTERN, params['oauth_token'].first)
+      assert_includes url, links[:authorization]
     end
+  end
 
-    it 'sets the request token/secret' do
+  describe '#verify(code)' do
+    it 'sets the access/refresh token hash' do
       authorize = create_authorize
+      code = 'VERIFY'
+
+      VCR.use_cassette('get_request_url') { authorize.authorize_url }
+      VCR.use_cassette('get_access_token') { authorize.verify(code) }
 
-      VCR.use_cassette('get_request_token') { authorize.authorize_url }
+      hash = authorize.token_hash
 
-      assert_match TOKEN_PATTERN, authorize.request_token
-      assert_match SECRET_PATTERN, authorize.request_secret
+      assert_match TOKEN_PATTERN, hash['access_token']
+      assert_match TOKEN_PATTERN, hash['refresh_token']
     end
   end
 
-  describe '#verify(code, token, secret)' do
-    it 'sets the access token/secret' do
-      authorize = create_authorize
-      code = 'VERIFY'
+  describe '#refresh_from_hash(old_token_hash)' do
+    let(:authorize) { create_authorize }
+
+    let(:old_hash) do
+      {
+        "token_type": "Bearer",
+        "scope": "ag2 ag1 offline_access ag3",
+        "access_token": access_token,
+        "refresh_token": refresh_token,
+        "expires_at": 1616484631
+      }
+    end
 
-      VCR.use_cassette('get_request_token') { authorize.authorize_url }
-      VCR.use_cassette('get_access_token') { authorize.verify(code) }
+    subject { authorize.refresh_from_hash(old_hash) }
+
+    it "fetches a new token hash using OAuth2's refresh! method" do
+      new_hash = VCR.use_cassette('get_refresh_token') { subject }
+
+      # normalize response hash
+      new_hash = JSON.parse(new_hash.to_json)
 
-      assert_match TOKEN_PATTERN, authorize.access_token
-      assert_match SECRET_PATTERN, authorize.access_secret
+      assert_equal new_access_token, new_hash['access_token']
     end
   end
 end

data/test/lib/my_john_deere_api/client_test.rb

@@ -1,6 +1,8 @@
 require 'support/helper'
 
 describe 'MyJohnDeereApi::Client' do
+  include JD::ResponseHelpers
+
   it 'includes the CaseConversion helper' do
     client = JD::Client.new(api_key, api_secret)
     assert_equal 'thisIsATest', client.send(:camelize, :this_is_a_test)
@@ -14,14 +16,10 @@ describe 'MyJohnDeereApi::Client' do
       assert_equal api_secret, client.api_secret
     end
 
-    it 'accepts access token/secret' do
-      access_token = 'token'
-      access_secret = 'secret'
-
-      client = JD::Client.new(api_key, api_secret, access: [access_token, access_secret])
+    it 'accepts token_hash' do
+      client = JD::Client.new(api_key, api_secret, token_hash: token_hash)
 
-      assert_equal access_token, client.access_token
-      assert_equal access_secret, client.access_secret
+      assert_equal token_hash, client.token_hash
     end
 
     it 'accepts the environment' do
@@ -45,7 +43,7 @@ describe 'MyJohnDeereApi::Client' do
           api_secret,
           contribution_definition_id: contribution_definition_id,
           environment: :sandbox,
-          access: [access_token, access_secret],
+          token_hash: token_hash,
           http_retry: {max_retries: custom_retries}
         )
 
@@ -66,7 +64,7 @@ describe 'MyJohnDeereApi::Client' do
 
   describe '#get' do
     it 'returns the response as a Hash' do
-      response = VCR.use_cassette('get_organizations') { client.get('/organizations') }
+      response = VCR.use_cassette('get_organizations') { client.get('/platform/organizations') }
 
       assert_kind_of Hash, response
       assert_kind_of Integer, response['total']
@@ -75,16 +73,7 @@ describe 'MyJohnDeereApi::Client' do
     end
 
     it 'prepends the leading slash if needed' do
-      response = VCR.use_cassette('get_organizations') { client.get('organizations') }
-
-      assert_kind_of Hash, response
-      assert_kind_of Integer, response['total']
-      assert response['values'].all?{|value| value['@type'] == 'Organization'}
-      assert response['values'].all?{|value| value.has_key?('links')}
-    end
-
-    it 'allows symbols for simple resources' do
-      response = VCR.use_cassette('get_organizations') { client.get(:organizations) }
+      response = VCR.use_cassette('get_organizations') { client.get('platform/organizations') }
 
       assert_kind_of Hash, response
       assert_kind_of Integer, response['total']
@@ -108,22 +97,20 @@ describe 'MyJohnDeereApi::Client' do
 
     it 'returns the response as a Hash' do
       response = VCR.use_cassette('post_assets') do
-        client.post("/organizations/#{organization_id}/assets", attributes)
+        client.post("/platform/organizations/#{organization_id}/assets", attributes)
       end
 
-      assert_equal '201', response.code
-      assert_equal 'Created', response.message
-      assert_equal "#{base_url}/assets/#{asset_id}", response['Location']
+      assert_created response
+      assert_equal "#{base_url}/platform/assets/#{asset_id}", response.response.headers['Location']
     end
 
     it 'prepends the leading slash if needed' do
       response = VCR.use_cassette('post_assets') do
-        client.post("organizations/#{organization_id}/assets", attributes)
+        client.post("platform/organizations/#{organization_id}/assets", attributes)
       end
 
-      assert_equal '201', response.code
-      assert_equal 'Created', response.message
-      assert_equal "#{base_url}/assets/#{asset_id}", response['Location']
+      assert_created response
+      assert_equal "#{base_url}/platform/assets/#{asset_id}", response.response.headers['Location']
     end
   end
 
@@ -146,33 +133,29 @@ describe 'MyJohnDeereApi::Client' do
     end
 
     it 'sends the request' do
-      response = VCR.use_cassette('put_asset') { client.put("/assets/#{asset_id}", attributes) }
+      response = VCR.use_cassette('put_asset') { client.put("/platform/assets/#{asset_id}", attributes) }
 
-      assert_equal '204', response.code
-      assert_equal 'No Content', response.message
+      assert_no_content response
     end
 
     it 'prepends the leading slash if needed' do
-      response = VCR.use_cassette('put_asset') { client.put("assets/#{asset_id}", attributes) }
+      response = VCR.use_cassette('put_asset') { client.put("platform/assets/#{asset_id}", attributes) }
 
-      assert_equal '204', response.code
-      assert_equal 'No Content', response.message
+      assert_no_content response
     end
   end
 
   describe '#delete' do
     it 'sends the request' do
-      response = VCR.use_cassette('delete_asset') { client.delete("/assets/#{asset_id}") }
+      response = VCR.use_cassette('delete_asset') { client.delete("/platform/assets/#{asset_id}") }
 
-      assert_equal '204', response.code
-      assert_equal 'No Content', response.message
+      assert_no_content response
     end
 
     it 'prepends the leading slash if needed' do
-      response = VCR.use_cassette('delete_asset') { client.delete("assets/#{asset_id}") }
+      response = VCR.use_cassette('delete_asset') { client.delete("platform/assets/#{asset_id}") }
 
-      assert_equal '204', response.code
-      assert_equal 'No Content', response.message
+      assert_no_content response
     end
   end
 
@@ -200,26 +183,9 @@ describe 'MyJohnDeereApi::Client' do
     end
   end
 
-  describe '#consumer' do
-    it 'receives the api key/secret and environment of the client' do
-      environment = :sandbox
-
-      client = JD::Client.new(api_key, api_secret, environment: environment)
-      consumer = client.send :consumer
-
-      assert_kind_of JD::Consumer, consumer
-      assert_equal api_key, consumer.api_key
-      assert_equal api_secret, consumer.api_secret
-      assert_equal environment, consumer.environment
-    end
-  end
-
   describe '#accessor' do
     it 'returns an object that can make user-specific requests' do
       assert_kind_of JD::NetHttpRetry::Decorator, accessor
-      assert_kind_of OAuth::Consumer, accessor.consumer
-      assert_equal access_token, accessor.token
-      assert_equal access_secret, accessor.secret
     end
   end
 end

data/test/lib/my_john_deere_api/consumer_test.rb

@@ -14,45 +14,33 @@ describe 'JD::Consumer' do
       consumer = JD::Consumer.new(api_key, api_secret, environment: environment)
 
       assert_equal environment, consumer.environment
-      assert_equal JD::Consumer::URLS[environment], consumer.base_url
+      assert_equal JD::Consumer::URLS[environment], consumer.site
     end
 
-    it 'accepts an arbitrary base_url' do
-      base_url = 'https://example.com'
-      consumer = JD::Consumer.new(api_key, api_secret, base_url: base_url)
+    it 'accepts an arbitrary site' do
+      site = 'https://example.com'
+      consumer = JD::Consumer.new(api_key, api_secret, site: site)
 
-      assert_equal base_url, consumer.base_url
+      assert_equal site, consumer.site
     end
 
-    it 'uses specified base_url regardless of specified environment' do
-      base_url = 'https://example.com'
-      consumer = JD::Consumer.new(api_key, api_secret, base_url: base_url, environment: :sandbox)
+    it 'uses specified site regardless of specified environment' do
+      site = 'https://example.com'
+      consumer = JD::Consumer.new(api_key, api_secret, site: site, environment: :sandbox)
 
-      assert_equal base_url, consumer.base_url
+      assert_equal site, consumer.site
     end
   end
 
-  describe '#app_get' do
-    it 'creates a working oAuth consumer for non-user-specific GET requests' do
+  describe '#platform_client' do
+    it 'creates a working oAuth client' do
       consumer = JD::Consumer.new(api_key, api_secret, environment: :sandbox)
-      app_get = VCR.use_cassette('catalog') { consumer.app_get }
+      platform_client = VCR.use_cassette('catalog') { consumer.platform_client }
 
-      assert_kind_of OAuth::Consumer, app_get
-      assert_equal api_key, app_get.key
-      assert_equal api_secret, app_get.secret
-      assert_equal JD::Consumer::URLS[:sandbox], app_get.site
-    end
-  end
-
-  describe '#user_get' do
-    it 'creates a working oAuth consumer for user-specific GET requests' do
-      consumer = JD::Consumer.new(api_key, api_secret, environment: :sandbox)
-      user_get = VCR.use_cassette('catalog') { consumer.user_get }
-
-      assert_kind_of OAuth::Consumer, user_get
-      assert_equal api_key, user_get.key
-      assert_equal api_secret, user_get.secret
-      assert_equal "#{JD::Consumer::URLS[:sandbox]}/platform", user_get.site
+      assert_kind_of OAuth2::Client, platform_client
+      assert_equal api_key, platform_client.id
+      assert_equal api_secret, platform_client.secret
+      assert_equal JD::Consumer::URLS[:sandbox], platform_client.site
     end
   end
 end

data/test/lib/my_john_deere_api/helpers/uri_helpers_test.rb

@@ -17,16 +17,6 @@ describe 'UriHelpers' do
       assert_equal '/turtles', path
     end
 
-    it 'removes leading /platform from the path' do
-      path = object.send(:uri_path, 'https://example.com/platform/turtles')
-      assert_equal '/turtles', path
-    end
-
-    it 'preserves /platform in any other part of the path' do
-      path = object.send(:uri_path, 'https://example.com/platform/turtles/platform')
-      assert_equal '/turtles/platform', path
-    end
-
     it 'is a private method' do
       exception = assert_raises(NoMethodError) { object.uri_path('https://example.com/turtles')}
       assert_includes exception.message, 'private method'

data/test/lib/my_john_deere_api/model/asset_location_test.rb

@@ -15,10 +15,6 @@ describe 'MyJohnDeereApi::Model::AssetLocation' do
   end
 
   describe '#initialize' do
-    def link_for label
-      record['links'].detect{|link| link['rel'] == label}['uri'].gsub('https://sandboxapi.deere.com/platform', '')
-    end
-
     it 'sets the attributes from the given record' do
       location = klass.new(client, record)
 

data/test/lib/my_john_deere_api/model/asset_test.rb

@@ -1,6 +1,9 @@
 require 'support/helper'
 
 describe 'MyJohnDeereApi::Model::Asset' do
+  include JD::ResponseHelpers
+  include JD::LinkHelpers
+
   let(:klass) { JD::Model::Asset }
 
   let(:record) do
@@ -21,10 +24,6 @@ describe 'MyJohnDeereApi::Model::Asset' do
   end
 
   describe '#initialize' do
-    def link_for label
-      record['links'].detect{|link| link['rel'] == label}['uri'].gsub('https://sandboxapi.deere.com/platform', '')
-    end
-
     it 'sets the attributes from the given record' do
       asset = klass.new(client, record)
 
@@ -43,7 +42,7 @@ describe 'MyJohnDeereApi::Model::Asset' do
       assert_kind_of Hash, asset.links
 
       ['self', 'organization', 'locations'].each do |association|
-        assert_equal link_for(association), asset.links[association]
+        assert_link_for(asset, association)
       end
     end
   end
@@ -70,7 +69,7 @@ describe 'MyJohnDeereApi::Model::Asset' do
       assert_equal new_title, asset.title
 
       response = VCR.use_cassette('put_asset') { asset.save }
-      assert_kind_of Net::HTTPNoContent, response
+      assert_no_content response
     end
 
     it 'does not make a JD request if nothing has changed' do
@@ -85,7 +84,9 @@ describe 'MyJohnDeereApi::Model::Asset' do
       asset.title = 'i REALLY like turtles!'
 
       response = VCR.use_cassette('put_asset') { asset.save }
-      assert_kind_of Net::HTTPNoContent, response
+
+      assert_equal 204, response.response.status
+      assert_equal 'No Content', response.response.reason_phrase
 
       response = asset.save
       assert_nil response
@@ -109,7 +110,7 @@ describe 'MyJohnDeereApi::Model::Asset' do
       new_title = 'i REALLY like turtles!'
       response = VCR.use_cassette('put_asset') { asset.update(title: new_title) }
 
-      assert_kind_of Net::HTTPNoContent, response
+      assert_no_content response
     end
   end
 

data/test/lib/my_john_deere_api/model/base_test.rb

@@ -9,6 +9,8 @@ class SampleModel < JD::Model::Base
 end
 
 describe 'MyJohnDeereApi::Model::Base' do
+  include JD::LinkHelpers
+
   let(:klass) { JD::Model::Base }
   let(:object) { klass.new(client, record) }
 
@@ -31,10 +33,6 @@ describe 'MyJohnDeereApi::Model::Base' do
   end
 
   describe '#initialize(client, record)' do
-    def link_for label
-      record['links'].detect{|link| link['rel'] == label}['uri'].gsub('https://sandboxapi.deere.com/platform', '')
-    end
-
     describe 'when the wrong record type is passed' do
       let(:record) do
         {
@@ -59,12 +57,10 @@ describe 'MyJohnDeereApi::Model::Base' do
     end
 
     it 'sets the links' do
-      links = object.links
-
-      assert_kind_of Hash, links
+      assert_kind_of Hash, object.links
 
       ['self', 'organization', 'locations'].each do |link|
-        assert_equal link_for(link), links[link]
+        assert_link_for(object, link)
       end
     end
 

data/test/lib/my_john_deere_api/model/contribution_definition_test.rb

@@ -1,6 +1,8 @@
 require 'support/helper'
 
 describe 'MyJohnDeereApi::Model::ContributionDefinition' do
+  include JD::LinkHelpers
+
   let(:klass) { JD::Model::ContributionDefinition }
 
   let(:record) do
@@ -25,16 +27,10 @@ describe 'MyJohnDeereApi::Model::ContributionDefinition' do
   end
 
   describe '#initialize' do
-    def link_for label
-      camel_label = label.gsub(/_(.)/){|m| m[1].upcase}
-      record['links'].detect{|link| link['rel'] == camel_label}['uri'].gsub('https://sandboxapi.deere.com/platform', '')
-    end
-
     it 'sets the attributes from the given record' do
       definition = klass.new(client, record)
 
       assert_equal client, definition.client
-      assert_equal accessor, definition.accessor
 
       # basic attributes
       assert_equal record['id'], definition.id
@@ -45,7 +41,7 @@ describe 'MyJohnDeereApi::Model::ContributionDefinition' do
       product = klass.new(client, record)
 
       ['self', 'contribution_product'].each do |association|
-        assert_equal link_for(association), product.links[association]
+        assert_link_for product, association
       end
     end
   end