my_john_deere_api 2.4.1 → 2.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 75b86b9b093f4aa0cc586ce56fb961654b1b91577947acf48392d8d2294c85b9
-  data.tar.gz: b5879b20c85891180747ba42657ffa399da981596820c813a7049d680240dd39
+  metadata.gz: ba69ef151796a688f69eba0f6a396d277baa893aa9e589922f2f2eac7b4e3a6a
+  data.tar.gz: e0539d88ae84a348113be06e9f81299b64a5c74598428e9d2a33ec00b0b49584
 SHA512:
-  metadata.gz: 6a8c729311baa853f8ae1039573f673cb01cc084d0fc9b662ce592dd1b907a85b153f04d07ebd6bf346558efb708242f5c13f3464f3c4c5b03a4c21a2479c2d9
-  data.tar.gz: cf5dd0b1e590baeb06ead7ffeffb4a7501de17b8b56596a297797186f1bc85aa33b196f58f19162f6027e40a27b023f9ad18ad3aa25e07b61fcd383612c0bbaa
+  metadata.gz: 9a40c8720b6e44da21bb5c2d0247055cf8b4f7d04e5b6d9e5d6db03778af368e64b5d2ba375aa02aa671aebdbf3d64d87c8090beb958bb7dc83ef5b1da52196e
+  data.tar.gz: 77bac482b0518e59b534d1916b9155c2a59e75308cc71e93354c9a3d071fa10c35362ee836f3eb456b15f612b73d503f06c735d7af942d220415a39c6943c606

data/lib/my_john_deere_api/net_http_retry.rb

@@ -1,2 +1,4 @@
 require 'my_john_deere_api/net_http_retry/decorator'
+
+require 'my_john_deere_api/net_http_retry/invalid_response_error'
 require 'my_john_deere_api/net_http_retry/max_retries_exceeded_error'

data/lib/my_john_deere_api/net_http_retry/decorator.rb

@@ -1,30 +1,35 @@
 module MyJohnDeereApi
   module NetHttpRetry
     class Decorator
-      attr_reader :object, :request_methods, :retry_delay_exponent, :max_retries, :response_codes
+      attr_reader :object, :request_methods, :retry_delay_exponent, :max_retries, :retry_codes, :valid_codes
 
       DEFAULTS = {
         request_methods:      [:get, :post, :put, :delete],
         retry_delay_exponent: 2,
         max_retries: 12,
-        response_codes: ['429', '503']
+        retry_codes: ['429', '503'],
+        valid_codes: ['200', '201', '204'],
       }
 
       def initialize(object, options={})
         @object = object
 
+        # defaults that can be used as-is
         [:request_methods, :retry_delay_exponent, :max_retries].each do |option|
           instance_variable_set(:"@#{option}", options[option] || DEFAULTS[option])
         end
 
-        @response_codes = (options[:response_codes] || DEFAULTS[:response_codes]).map(&:to_s)
+        # defaults that require casting as string arrays
+        [:retry_codes, :valid_codes].each do |option|
+          instance_variable_set(:"@#{option}", (options[option] || DEFAULTS[option]).map(&:to_s))
+        end
       end
 
       def request(method_name, *args)
         retries = 0
         result = object.send(method_name, *args)
 
-        while response_codes.include?(result.code)
+        while retry_codes.include?(result.code)
           if retries >= max_retries
             raise MaxRetriesExceededError.new(method_name, "#{result.code} #{result.message}")
           end
@@ -36,6 +41,10 @@ module MyJohnDeereApi
           retries += 1
         end
 
+        unless valid_codes.include?(result.code)
+          raise InvalidResponseError.new(result)
+        end
+
         result
       end
 

data/lib/my_john_deere_api/net_http_retry/invalid_response_error.rb

@@ -0,0 +1,23 @@
+module MyJohnDeereApi
+  module NetHttpRetry
+    ##
+    # This error is used when a single request has exceeded
+    # the number of retries allowed by NetHttpRetry::Decorator::MAX_RETRIES.
+
+    class InvalidResponseError < StandardError
+
+      ##
+      # argument is a string which describes the attempted request
+
+      def initialize(response)
+        message = {
+          code: response.code,
+          message: response.message,
+          body: response.body,
+        }.to_json
+
+        super(message)
+      end
+    end
+  end
+end

data/lib/my_john_deere_api/version.rb

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

data/test/lib/my_john_deere_api/net_http_retry/decorator_test.rb

@@ -18,14 +18,16 @@ describe 'JD::NetHttpRetry::Decorator' do
       request_methods: request_methods,
       retry_delay_exponent: retry_delay_exponent,
       max_retries: max_retries,
-      response_codes: response_codes
+      retry_codes: retry_codes,
+      valid_codes: valid_codes
     }
   end
 
   let(:request_methods) { nil }
   let(:retry_delay_exponent) { nil }
   let(:max_retries) { nil }
-  let(:response_codes) { nil }
+  let(:retry_codes) { nil }
+  let(:valid_codes) { nil }
 
   let(:retry_values) { [13, 17, 19, 23] }
   let(:exponential_retries) { (0..klass::DEFAULTS[:max_retries]-1).map{|i| 2 ** i} }
@@ -77,25 +79,50 @@ describe 'JD::NetHttpRetry::Decorator' do
       end
     end
 
-    describe 'when response_codes are specified' do
-      let(:response_codes) { ['200', '201'] }
+    describe 'when retry_codes are specified' do
+      let(:retry_codes) { ['200', '201'] }
 
       it 'uses the supplied values' do
-        assert_equal response_codes, object.response_codes
+        assert_equal retry_codes, object.retry_codes
       end
     end
 
-    describe 'when response_codes are specified as integers' do
-      let(:response_codes) { [200, 201] }
+    describe 'when retry_codes are specified as integers' do
+      let(:retry_codes) { [200, 201] }
 
       it 'uses the stringified versions of the supplied values' do
-        assert_equal response_codes.map(&:to_s), object.response_codes
+        assert_equal retry_codes.map(&:to_s), object.retry_codes
       end
     end
 
-    describe 'when response_codes are not specified' do
+    describe 'when retry_codes are not specified' do
       it 'uses the default values' do
-        assert_equal klass::DEFAULTS[:response_codes], object.response_codes
+        assert_equal klass::DEFAULTS[:retry_codes], object.retry_codes
+      end
+    end
+
+    describe 'when valid_codes are specified' do
+      let(:valid_codes) { ['123', '234'] }
+
+      it 'uses the supplied values' do
+        assert_equal valid_codes, object.valid_codes
+      end
+    end
+
+    describe 'when valid_codes are specified as integers' do
+      let(:valid_codes) { [123, 234] }
+
+      it 'uses the stringified versions of the supplied values' do
+        assert_equal valid_codes.map(&:to_s), object.valid_codes
+      end
+    end
+
+    describe 'when valid_codes are not specified' do
+      it 'uses the default values' do
+        assert_kind_of Array, klass::DEFAULTS[:valid_codes]
+        refute klass::DEFAULTS[:valid_codes].empty?
+
+        assert_equal klass::DEFAULTS[:valid_codes], object.valid_codes
       end
     end
   end
@@ -160,4 +187,22 @@ describe 'JD::NetHttpRetry::Decorator' do
       end
     end
   end
+
+  describe 'when an invalid response code is returned' do
+    REQUEST_METHODS.each do |request_method|
+      it "returns an error for #{request_method.to_s.upcase} requests" do
+        exception = assert_raises(JD::NetHttpRetry::InvalidResponseError) do
+          VCR.use_cassette("accessor/#{request_method}_invalid") do
+            accessor.send(request_method, REQUESTS[request_method])
+          end
+        end
+
+        exception_json = JSON.parse(exception.message)
+
+        assert_equal '500', exception_json['code']
+        assert_equal 'Internal Error', exception_json['message']
+        assert_equal 'You Have Died of Dysentery', exception_json['body']
+      end
+    end
+  end
 end

data/test/lib/my_john_deere_api/net_http_retry/invalid_response_error_test.rb

@@ -0,0 +1,19 @@
+require 'support/helper'
+
+describe 'JD::NetHttpRetry::InvalidResponseError' do
+  let(:klass) { JD::NetHttpRetry::InvalidResponseError }
+  let(:response) { stub(response_content) }
+  let(:response_content) { {code: '123', message: 'failed', body: 'body'} }
+
+  it 'inherits from StandardError' do
+    error = klass.new(response)
+    assert_kind_of StandardError, error
+  end
+
+  it 'accepts a response object, and includes pertinent info' do
+    expected_message = response_content.to_json
+    actual_message = klass.new(response).message
+
+    assert_equal expected_message, actual_message
+  end
+end

data/test/support/vcr/accessor/delete_invalid.yml

@@ -0,0 +1,39 @@
+---
+http_interactions:
+- request:
+    method: delete
+    uri: https://sandboxapi.deere.com/platform/assets/00000000-0000-0000-0000-000000000000
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - application/vnd.deere.axiom.v3+json
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      User-Agent:
+      - OAuth gem v0.5.4
+      Authorization:
+      - OAuth oauth_consumer_key="johndeere-0000000000000000000000000000000000000000",
+        oauth_nonce="000000000000000000000000000000000000000000", oauth_signature="0000000000000000000000000000",
+        oauth_signature_method="HMAC-SHA1", oauth_timestamp="1581334172", oauth_token="00000000-0000-0000-0000-000000000000",
+        oauth_version="1.0"
+  response:
+    status:
+      code: 500
+      message: Internal Error
+    headers:
+      Date:
+      - Mon, 10 Feb 2020 17:29:36 GMT
+      X-Deere-Handling-Server:
+      - ip-10-214-45-99
+      X-Frame-Options:
+      - SAMEORIGIN
+      X-Deere-Elapsed-Ms:
+      - '96'
+    body:
+      encoding: UTF-8
+      string: You Have Died of Dysentery
+    http_version: 
+  recorded_at: Mon, 10 Feb 2020 17:29:36 GMT
+recorded_with: VCR 5.0.0

data/test/support/vcr/accessor/get_invalid.yml

@@ -0,0 +1,46 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://sandboxapi.deere.com/platform/
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - application/vnd.deere.axiom.v3+json
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      User-Agent:
+      - OAuth gem v0.5.4
+      Authorization:
+      - OAuth oauth_consumer_key="johndeere-0000000000000000000000000000000000000000",
+        oauth_nonce="000000000000000000000000000000000000000000", oauth_signature="0000000000000000000000000000",
+        oauth_signature_method="HMAC-SHA1", oauth_timestamp="1581334172", oauth_version="1.0"
+  response:
+    status:
+      code: 500
+      message: Internal Error
+    headers:
+      Date:
+      - Mon, 10 Feb 2020 17:29:28 GMT
+      Content-Type:
+      - application/vnd.deere.axiom.v3+json;charset=UTF-8
+      X-Deere-Handling-Server:
+      - ip-10-214-44-28
+      X-Frame-Options:
+      - SAMEORIGIN
+      X-Deere-Elapsed-Ms:
+      - '11'
+      Cache-Control:
+      - no-store
+      Content-Language:
+      - en-US
+      Transfer-Encoding:
+      - chunked
+    body:
+      encoding: ASCII-8BIT
+      string: You Have Died of Dysentery
+    http_version: 
+  recorded_at: Mon, 10 Feb 2020 17:29:28 GMT
+recorded_with: VCR 5.0.0

data/test/support/vcr/accessor/post_invalid.yml

@@ -0,0 +1,49 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://sandboxapi.deere.com/platform/organizations/000000/assets
+    body:
+      encoding: UTF-8
+      string: '{"title":"Asset Title","assetCategory":"DEVICE","assetType":"SENSOR","assetSubType":"ENVIRONMENTAL","links":[{"@type":"Link","rel":"contributionDefinition","uri":"https://sandboxapi.deere.com/platform/contributionDefinitions/00000000-0000-0000-0000-000000000000"}]}'
+    headers:
+      Accept:
+      - application/vnd.deere.axiom.v3+json
+      Content-Type:
+      - application/vnd.deere.axiom.v3+json
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      User-Agent:
+      - OAuth gem v0.5.4
+      Content-Length:
+      - '265'
+      Authorization:
+      - OAuth oauth_body_hash="hObY6LROUn9S1WS8S28eTTfqmWk%3D", oauth_consumer_key="johndeere-0000000000000000000000000000000000000000",
+        oauth_nonce="000000000000000000000000000000000000000000", oauth_signature="0000000000000000000000000000",
+        oauth_signature_method="HMAC-SHA1", oauth_timestamp="1581334172", oauth_token="00000000-0000-0000-0000-000000000000",
+        oauth_version="1.0"
+  response:
+    status:
+      code: 500
+      message: Internal Error
+    headers:
+      Date:
+      - Mon, 10 Feb 2020 17:29:25 GMT
+      Content-Type:
+      - application/vnd.deere.axiom.v3+json
+      X-Deere-Handling-Server:
+      - ip-10-214-45-213
+      X-Frame-Options:
+      - SAMEORIGIN
+      Location:
+      - https://sandboxapi.deere.com/platform/assets/00000000-0000-0000-0000-000000000000
+      X-Deere-Elapsed-Ms:
+      - '121'
+      Transfer-Encoding:
+      - chunked
+    body:
+      encoding: ASCII-8BIT
+      string: You Have Died of Dysentery
+    http_version: 
+  recorded_at: Mon, 10 Feb 2020 17:29:26 GMT
+recorded_with: VCR 5.0.0

data/test/support/vcr/accessor/put_invalid.yml

@@ -0,0 +1,44 @@
+---
+http_interactions:
+- request:
+    method: put
+    uri: https://sandboxapi.deere.com/platform/assets/00000000-0000-0000-0000-000000000000
+    body:
+      encoding: UTF-8
+      string: '{"assetCategory":"DEVICE","assetType":"SENSOR","assetSubType":"ENVIRONMENTAL","title":"i
+        REALLY like turtles!","links":[{"@type":"Link","rel":"contributionDefinition","uri":"https://sandboxapi.deere.com/contributionDefinitions/00000000-0000-0000-0000-000000000000"}]}'
+    headers:
+      Accept:
+      - application/vnd.deere.axiom.v3+json
+      Content-Type:
+      - application/vnd.deere.axiom.v3+json
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      User-Agent:
+      - OAuth gem v0.5.4
+      Content-Length:
+      - '267'
+      Authorization:
+      - OAuth oauth_body_hash="JXqhMr0ayK5gfHyej3M1xuUfSbw%3D", oauth_consumer_key="johndeere-0000000000000000000000000000000000000000",
+        oauth_nonce="000000000000000000000000000000000000000000", oauth_signature="0000000000000000000000000000",
+        oauth_signature_method="HMAC-SHA1", oauth_timestamp="1581334172", oauth_token="00000000-0000-0000-0000-000000000000",
+        oauth_version="1.0"
+  response:
+    status:
+      code: 500
+      message: Internal Error
+    headers:
+      Date:
+      - Mon, 10 Feb 2020 17:29:30 GMT
+      X-Deere-Handling-Server:
+      - ip-10-214-44-33
+      X-Frame-Options:
+      - SAMEORIGIN
+      X-Deere-Elapsed-Ms:
+      - '185'
+    body:
+      encoding: UTF-8
+      string: You Have Died of Dysentery
+    http_version: 
+  recorded_at: Mon, 10 Feb 2020 17:29:30 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: 2.4.1
+  version: 2.5.0
 platform: ruby
 authors:
 - Jaime Bellmyer
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-21 00:00:00.000000000 Z
+date: 2020-07-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: vcr
@@ -128,6 +128,7 @@ files:
 - lib/my_john_deere_api/model/organization.rb
 - lib/my_john_deere_api/net_http_retry.rb
 - lib/my_john_deere_api/net_http_retry/decorator.rb
+- lib/my_john_deere_api/net_http_retry/invalid_response_error.rb
 - lib/my_john_deere_api/net_http_retry/max_retries_exceeded_error.rb
 - lib/my_john_deere_api/request.rb
 - lib/my_john_deere_api/request/collection.rb
@@ -162,7 +163,6 @@ files:
 - test/lib/my_john_deere_api/client_test.rb
 - test/lib/my_john_deere_api/consumer_test.rb
 - test/lib/my_john_deere_api/errors/invalid_record_error_test.rb
-- test/lib/my_john_deere_api/errors/max_retries_exceeded_error_test.rb
 - test/lib/my_john_deere_api/errors/missing_contribution_definition_id_error_test.rb
 - test/lib/my_john_deere_api/errors/not_yet_implemented_error_test.rb
 - test/lib/my_john_deere_api/errors/type_mismatch_error_test.rb
@@ -183,6 +183,8 @@ files:
 - test/lib/my_john_deere_api/model/organization_test.rb
 - test/lib/my_john_deere_api/model_test.rb
 - test/lib/my_john_deere_api/net_http_retry/decorator_test.rb
+- test/lib/my_john_deere_api/net_http_retry/invalid_response_error_test.rb
+- test/lib/my_john_deere_api/net_http_retry/max_retries_exceeded_error_test.rb
 - test/lib/my_john_deere_api/request/collection/asset_locations_test.rb
 - test/lib/my_john_deere_api/request/collection/assets_test.rb
 - test/lib/my_john_deere_api/request/collection/base_test.rb
@@ -215,18 +217,22 @@ files:
 - test/my_john_deere_api_test.rb
 - test/support/helper.rb
 - test/support/vcr/accessor/delete_failed.yml
+- test/support/vcr/accessor/delete_invalid.yml
 - test/support/vcr/accessor/delete_max_failed.yml
 - test/support/vcr/accessor/delete_retry.yml
 - test/support/vcr/accessor/delete_retry_too_soon.yml
 - test/support/vcr/accessor/get_failed.yml
+- test/support/vcr/accessor/get_invalid.yml
 - test/support/vcr/accessor/get_max_failed.yml
 - test/support/vcr/accessor/get_retry.yml
 - test/support/vcr/accessor/get_retry_too_soon.yml
 - test/support/vcr/accessor/post_failed.yml
+- test/support/vcr/accessor/post_invalid.yml
 - test/support/vcr/accessor/post_max_failed.yml
 - test/support/vcr/accessor/post_retry.yml
 - test/support/vcr/accessor/post_retry_too_soon.yml
 - test/support/vcr/accessor/put_failed.yml
+- test/support/vcr/accessor/put_invalid.yml
 - test/support/vcr/accessor/put_max_failed.yml
 - test/support/vcr/accessor/put_retry.yml
 - test/support/vcr/accessor/put_retry_too_soon.yml