my_john_deere_api 2.2.4 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d0922043a7c3b1569cce53369feb1aefb39c8d29667b351a02ff2e63ec5d35c5
-  data.tar.gz: 45fc68b7e4fb44ea06c22a50e1759cb6ec84e91bd278248306ede7854c1e1a00
+  metadata.gz: e4770ad629b97ce42d4a5482559e26506b78b67fcec897e6e08e849d9c38e6f7
+  data.tar.gz: af1b02dce372ce905933242226756e298553b75b6265ebb6f44d71916b20a5cd
 SHA512:
-  metadata.gz: c65a1f6b28ead9107c40f20cc466c59d200503181016a595db746380aa923bb93f00047745eee470b73f8d83421f7f629e8c2567a4e2c34d84b488fba5ed047f
-  data.tar.gz: e72bef48380aa51d14930972b8f0364e269282571adb4a0f21eaf8f35aca4a1795dcb087b50fcce48500a1802f1b8875eec23831f314f291fb407e9cd23ebaf4
+  metadata.gz: 44005e84b7c7e80ba54498e9c77f6d00e9fea447fcdc67106b55fd49e1452fc88a43d37a599506c22819e7ad4f1a166562b22a7954a966ffaba1e23d697530be
+  data.tar.gz: 964b2f971c765d5c115e7cf4f73372de6c69c77d15b7134c2b4d6137394ad78090c279305b300157228ee35916bf767f9c15f28d239d95a8c5242ae9d6cc8261

data/README.md

@@ -499,6 +499,9 @@ Custom errors help clearly identify problems when using the client:
   unrecognized environment. Valid environments are `:sandbox` or `:production`.
 * **InvalidRecordError** is raised when bad input has been given, in an attempt to create or update
   a record on the John Deere platform.
+* **MissingContributionDefinitionIdError** is raised when the optional contribution\_definition\_id
+  has not been set in the client, but an operation has been attempted that requires it - like 
+  creating an asset in the John Deere platform.
 * **TypeMismatchError** is raised when a model is instantiated, typically when a record is received
   from John Deere and is being converted into a Ruby object. Model instantiation is normally handled
   by request objects, but this error is helpful if you're instantiating your own models for advanced

data/lib/my_john_deere_api/client.rb

@@ -3,8 +3,8 @@ module MyJohnDeereApi
     include Helpers::EnvironmentHelper
     include Helpers::CaseConversion
 
-    attr_reader :api_key, :api_secret, :access_token, :access_secret,
-                :contribution_definition_id
+    attr_accessor :contribution_definition_id
+    attr_reader :api_key, :api_secret, :access_token, :access_secret
 
     DEFAULTS = {
       environment: :live

data/lib/my_john_deere_api/errors/missing_contribution_definition_id_error.rb

@@ -0,0 +1,12 @@
+module MyJohnDeereApi
+  ##
+  # This error is used in a context that will fail in the absence of
+  # a valid oAuth access token. We have classes that may only need 
+  # access tokens for some use cases.
+
+  class MissingContributionDefinitionIdError < StandardError
+    def initialize(message = "Contribution Definition ID must be set in the client to use this feature.")
+      super
+    end
+  end
+end

data/lib/my_john_deere_api/errors.rb

@@ -1,5 +1,6 @@
 module MyJohnDeereApi::Errors
   require           'my_john_deere_api/errors/invalid_record_error'
+  require           'my_john_deere_api/errors/missing_contribution_definition_id_error'
   require           'my_john_deere_api/errors/not_yet_implemented_error'
   require           'my_john_deere_api/errors/type_mismatch_error'
   require           'my_john_deere_api/errors/unsupported_environment_error'

data/lib/my_john_deere_api/request/create/asset.rb

@@ -36,6 +36,8 @@ module MyJohnDeereApi
     def request_body
       return @body if defined?(@body)
 
+      validate_contribution_definition
+
       @body = {
         title: attributes[:title],
         assetCategory: attributes[:asset_category],

data/lib/my_john_deere_api/request/create/base.rb

@@ -54,6 +54,17 @@ module MyJohnDeereApi
     def process_attributes
     end
 
+    ##
+    # Raise an error if contribution_definition_id is missing
+
+    def validate_contribution_definition
+      unless client.contribution_definition_id
+        raise MissingContributionDefinitionIdError
+      end
+
+      true
+    end
+
     ##
     # Headers for POST request
 

data/lib/my_john_deere_api/request/update/asset.rb

@@ -19,6 +19,8 @@ module MyJohnDeereApi
     def request_body
       return @body if defined?(@body)
 
+      validate_contribution_definition
+
       @body = {
         title: attributes[:title],
         assetCategory: attributes[:asset_category],

data/lib/my_john_deere_api/request/update/base.rb

@@ -54,6 +54,17 @@ module MyJohnDeereApi
     def process_attributes
     end
 
+    ##
+    # Raise an error if contribution_definition_id is missing
+
+    def validate_contribution_definition
+      unless client.contribution_definition_id
+        raise MissingContributionDefinitionIdError
+      end
+
+      true
+    end
+
     ##
     # Headers for PUT request
 

data/lib/my_john_deere_api/version.rb

@@ -1,3 +1,3 @@
 module MyJohnDeereApi
-  VERSION='2.2.4'
+  VERSION='2.3.0'
 end

data/test/lib/my_john_deere_api/client_test.rb

@@ -37,6 +37,16 @@ describe 'MyJohnDeereApi::Client' do
     end
   end
 
+  describe '#contribution_definition_id' do
+    it 'can be set after instantiation' do
+      client = JD::Client.new(api_key, api_secret)
+      assert_nil client.contribution_definition_id
+
+      client.contribution_definition_id = '123'
+      assert_equal '123', client.contribution_definition_id
+    end
+  end
+
   describe '#get' do
     it 'returns the response as a Hash' do
       response = VCR.use_cassette('get_organizations') { client.get('/organizations') }

data/test/lib/my_john_deere_api/errors/missing_contribution_definition_id_error_test.rb

@@ -0,0 +1,14 @@
+require 'support/helper'
+
+describe 'MyJohnDeereApi::MissingContributionDefinitionIdError' do
+  let(:klass) { MyJohnDeereApi::MissingContributionDefinitionIdError }
+  let(:error) { klass.new }
+
+  it 'inherits from StandardError' do
+    assert_kind_of StandardError, error
+  end
+
+  it 'has a default message' do
+    assert_includes error.message, 'Contribution Definition ID must be set in the client to use this feature.'
+  end
+end

data/test/lib/my_john_deere_api/errors_test.rb

@@ -6,6 +6,10 @@ describe 'MyJohnDeereApi Errors' do
       assert JD::InvalidRecordError
     end
 
+    it 'loads MissingContributionDefinitionIdError' do
+      assert JD::MissingContributionDefinitionIdError
+    end
+
     it 'loads NotYetImplementedError' do
       assert JD::NotYetImplementedError
     end

data/test/lib/my_john_deere_api/request/create/asset_test.rb

@@ -129,6 +129,7 @@ describe 'MyJohnDeereApi::Request::Create::Asset' do
     it 'properly forms the request body' do
       object = klass.new(client, attributes)
       body = object.send(:request_body)
+
       assert_equal attributes[:title], body[:title]
       assert_equal attributes[:asset_category], body[:assetCategory]
       assert_equal attributes[:asset_type], body[:assetType]
@@ -143,6 +144,15 @@ describe 'MyJohnDeereApi::Request::Create::Asset' do
       assert_equal  "#{base_url}/contributionDefinitions/#{contribution_definition_id}",
                     body[:links].first['uri']
     end
+
+    it 'raises an exception when contribution_definition_id is not set' do
+      client.contribution_definition_id = nil
+      object = klass.new(client, attributes)
+
+      assert_raises(JD::MissingContributionDefinitionIdError) do
+        object.send(:request_body)
+      end
+    end
   end
 
   describe '#request' do

data/test/lib/my_john_deere_api/request/create/base_test.rb

@@ -26,4 +26,20 @@ describe 'MyJohnDeereApi::Request::Create::Base' do
       assert_equal expected, headers['Content-Type']
     end
   end
+
+  describe '#validate_contribution_definition' do
+    it 'does nothing when contribution_definition_id is present' do
+      object = klass.new(client, attributes)
+      assert object.send(:validate_contribution_definition)
+    end
+
+    it 'raises an error when contribution_definition_id is missing' do
+      client.contribution_definition_id = nil
+      object = klass.new(client, attributes)
+
+      assert_raises(JD::MissingContributionDefinitionIdError) do
+        object.send(:validate_contribution_definition)
+      end
+    end
+  end
 end

data/test/lib/my_john_deere_api/request/update/asset_test.rb

@@ -78,6 +78,15 @@ describe 'MyJohnDeereApi::Request::Update::Asset' do
       assert_equal  "#{base_url}/contributionDefinitions/#{contribution_definition_id}",
                     body[:links].first['uri']
     end
+
+    it 'raises an exception when contribution_definition_id is not set' do
+      client.contribution_definition_id = nil
+      object = klass.new(client, item, attributes)
+
+      assert_raises(JD::MissingContributionDefinitionIdError) do
+        object.send(:request_body)
+      end
+    end
   end
 
   describe '#request' do

data/test/lib/my_john_deere_api/request/update/base_test.rb

@@ -57,4 +57,20 @@ describe 'MyJohnDeereApi::Request::Update::Base' do
       assert_equal expected, headers['Content-Type']
     end
   end
+
+  describe '#validate_contribution_definition' do
+    it 'does nothing when contribution_definition_id is present' do
+      object = klass.new(client, item, attributes)
+      assert object.send(:validate_contribution_definition)
+    end
+
+    it 'raises an error when contribution_definition_id is missing' do
+      client.contribution_definition_id = nil
+      object = klass.new(client, item, attributes)
+
+      assert_raises(JD::MissingContributionDefinitionIdError) do
+        object.send(:validate_contribution_definition)
+      end
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: my_john_deere_api
 version: !ruby/object:Gem::Version
-  version: 2.2.4
+  version: 2.3.0
 platform: ruby
 authors:
 - Jaime Bellmyer
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-02-16 00:00:00.000000000 Z
+date: 2020-02-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: vcr
@@ -108,6 +108,7 @@ files:
 - lib/my_john_deere_api/consumer.rb
 - lib/my_john_deere_api/errors.rb
 - lib/my_john_deere_api/errors/invalid_record_error.rb
+- lib/my_john_deere_api/errors/missing_contribution_definition_id_error.rb
 - lib/my_john_deere_api/errors/not_yet_implemented_error.rb
 - lib/my_john_deere_api/errors/type_mismatch_error.rb
 - lib/my_john_deere_api/errors/unsupported_environment_error.rb
@@ -157,6 +158,7 @@ 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/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
 - test/lib/my_john_deere_api/errors/unsupported_environment_error_test.rb