my_john_deere_api 2.4.1

data/test/lib/my_john_deere_api/consumer_test.rb

@@ -0,0 +1,58 @@
+require 'support/helper'
+
+describe 'JD::Consumer' do
+  describe '#initialize' do
+    it 'requires an api key and secret' do
+      consumer = JD::Consumer.new(api_key, api_secret)
+
+      assert_equal api_key, consumer.api_key
+      assert_equal api_secret, consumer.api_secret
+    end
+
+    it 'accepts the environment' do
+      environment = :sandbox
+      consumer = JD::Consumer.new(api_key, api_secret, environment: environment)
+
+      assert_equal environment, consumer.environment
+      assert_equal JD::Consumer::URLS[environment], consumer.base_url
+    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)
+
+      assert_equal base_url, consumer.base_url
+    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)
+
+      assert_equal base_url, consumer.base_url
+    end
+  end
+
+  describe '#app_get' do
+    it 'creates a working oAuth consumer for non-user-specific GET requests' do
+      consumer = JD::Consumer.new(api_key, api_secret, environment: :sandbox)
+      app_get = VCR.use_cassette('catalog') { consumer.app_get }
+
+      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
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+require 'support/helper'
+
+describe 'MyJohnDeereApi::InvalidRecordError' do
+  it 'inherits from StandardError' do
+    error = MyJohnDeereApi::InvalidRecordError.new
+    assert_kind_of StandardError, error
+  end
+
+  it 'has a default message' do
+    error = MyJohnDeereApi::InvalidRecordError.new
+    assert_includes error.message, 'Record is invalid'
+  end
+
+  it 'accepts a hash of errors, and includes them in message' do
+    errors = {
+      name: 'must be specified',
+      age: 'must be greater than 21'
+    }
+
+    message = MyJohnDeereApi::InvalidRecordError.new(errors).message
+
+    assert_includes message, 'Record is invalid'
+    assert_includes message, 'name must be specified'
+    assert_includes message, 'age must be greater than 21'
+  end
+end

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

@@ -0,0 +1,13 @@
+require 'support/helper'
+
+describe 'JD::NetHttpRetry::MaxRetriesExceededError' do
+  it 'inherits from StandardError' do
+    error = JD::NetHttpRetry::MaxRetriesExceededError.new(:get, '503')
+    assert_kind_of StandardError, error
+  end
+
+  it 'accepts a request description, and includes in message' do
+    message = JD::NetHttpRetry::MaxRetriesExceededError.new(:get, '503 Service Unavailable').message
+    assert_equal message, "Max retries exceeded for GET request: 503 Service Unavailable"
+  end
+end

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/not_yet_implemented_error_test.rb

@@ -0,0 +1,13 @@
+require 'support/helper'
+
+describe 'MyJohnDeereApi::NotYetImplementedError' do
+  it 'inherits from StandardError' do
+    error = MyJohnDeereApi::NotYetImplementedError.new
+    assert_kind_of StandardError, error
+  end
+
+  it 'has a default message' do
+    error = MyJohnDeereApi::NotYetImplementedError.new
+    assert_includes error.message, 'This is not yet implemented. View README to help make this gem better!'
+  end
+end

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

@@ -0,0 +1,13 @@
+require 'support/helper'
+
+describe 'MyJohnDeereApi::TypeMismatchError' do
+  it 'inherits from StandardError' do
+    error = MyJohnDeereApi::TypeMismatchError.new
+    assert_kind_of StandardError, error
+  end
+
+  it 'has a default message' do
+    error = MyJohnDeereApi::TypeMismatchError.new
+    assert_includes error.message, 'Record type does not match'
+  end
+end

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

@@ -0,0 +1,18 @@
+require 'support/helper'
+
+describe 'MyJohnDeereApi::UnsupportedEnvironmentError' do
+  it 'inherits from StandardError' do
+    error = MyJohnDeereApi::UnsupportedEnvironmentError.new
+    assert_kind_of StandardError, error
+  end
+
+  it 'has a default message' do
+    error = MyJohnDeereApi::UnsupportedEnvironmentError.new
+    assert_includes error.message, 'This environment is not supported.'
+  end
+
+  it 'specifies the failing environment if supplied' do
+    error = MyJohnDeereApi::UnsupportedEnvironmentError.new(:turtles)
+    assert_includes error.message, "The :turtles environment is not supported."
+  end
+end

data/test/lib/my_john_deere_api/errors_test.rb

@@ -0,0 +1,25 @@
+require 'support/helper'
+
+describe 'MyJohnDeereApi Errors' do
+  describe 'loading dependencies' do
+    it 'loads InvalidRecordError' do
+      assert JD::InvalidRecordError
+    end
+
+    it 'loads MissingContributionDefinitionIdError' do
+      assert JD::MissingContributionDefinitionIdError
+    end
+
+    it 'loads NotYetImplementedError' do
+      assert JD::NotYetImplementedError
+    end
+
+    it 'loads TypeMismatchError' do
+      assert JD::TypeMismatchError
+    end
+
+    it 'loads UnsupportedEnvironmentError' do
+      assert JD::UnsupportedEnvironmentError
+    end
+  end
+end

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

@@ -0,0 +1,100 @@
+require 'support/helper'
+
+class CaseConversionHelperSample
+  include JD::Helpers::CaseConversion
+
+  def test
+    'test'
+  end
+end
+
+describe 'Helpers::CaseConversion' do
+  let(:object) { CaseConversionHelperSample.new }
+
+  describe '#underscore' do
+    it 'converts from camelcase' do
+      string = object.send(:underscore, 'camelCaseExample')
+      assert_equal 'camel_case_example', string
+    end
+
+    it 'converts from a symbol' do
+      string = object.send(:underscore, :camelCaseExample)
+      assert_equal 'camel_case_example', string
+    end
+
+    it 'converts the keys of a hash' do
+      hash = {
+        assetCategory: 'Asset Category',
+        assetType: 'Asset Type'
+      }
+
+      new_hash = object.send(:underscore, hash)
+
+      assert_equal new_hash['asset_category'], hash[:assetCategory]
+      assert_equal new_hash['asset_type'], hash[:assetType]
+    end
+
+    it 'handles leading uppercase' do
+      string = object.send(:underscore, 'CamelCaseExample')
+      assert_equal 'camel_case_example', string
+    end
+
+    it 'converts spaces to underscores' do
+      string = object.send(:underscore, 'camel case Example')
+      assert_equal 'camel_case_example', string
+    end
+
+    it 'removes duplicate underscores after processing' do
+      string = object.send(:underscore, 'camel  Case     Example')
+      assert_equal 'camel_case_example', string
+    end
+
+    it 'is a private method' do
+      exception = assert_raises(NoMethodError) { object.underscore('test') }
+      assert_includes exception.message, 'private method'
+    end
+  end
+
+  describe '#camelize' do
+    it 'converts from underscored' do
+      string = object.send(:camelize, 'this_is_a_test')
+      assert_equal 'thisIsATest', string
+    end
+
+    it 'converts from spaced' do
+      string = object.send(:camelize, 'this is a test')
+      assert_equal 'thisIsATest', string
+    end
+
+    it 'honors original capitalization' do
+      string = object.send(:camelize, 'This is a test')
+      assert_equal 'ThisIsATest', string
+    end
+
+    it 'converts from a symbol' do
+      string = object.send(:camelize, :this_is_a_test)
+      assert_equal 'thisIsATest', string
+    end
+
+    it 'converts the keys of a hash' do
+      hash = {
+        asset_category: 'Asset Category',
+        asset_type: 'Asset Type'
+      }
+
+      new_hash = object.send(:camelize, hash)
+
+      assert_equal new_hash['assetCategory'], hash[:asset_category]
+      assert_equal new_hash['assetType'], hash[:asset_type]
+    end
+
+    it 'is a private method' do
+      exception = assert_raises(NoMethodError) { object.camelize('test') }
+      assert_includes exception.message, 'private method'
+    end
+  end
+
+  it "preserves the public nature of the including class's other methods" do
+    assert_equal 'test', object.test
+  end
+end

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

@@ -0,0 +1,67 @@
+require 'support/helper'
+
+class EnvironmentHelperSample
+  include JD::Helpers::EnvironmentHelper
+
+  def initialize(environment = nil)
+    self.environment = environment
+  end
+end
+
+describe 'EnvironmentHelper' do
+  let(:object) { EnvironmentHelperSample.new(environment) }
+  let(:environment) { :sandbox }
+
+  it 'provides an attr_reader for :environment' do
+    assert object.environment
+  end
+
+  describe 'when no specific environment requested' do
+    let(:environment) { nil }
+
+    it 'sets the environment to :live' do
+      assert_equal :live, object.environment
+    end
+  end
+
+  describe 'when :sandbox environment requested' do
+    let(:environment) { :sandbox }
+
+    it 'sets the environment to :sandbox' do
+      assert_equal environment, object.environment
+    end
+  end
+
+  describe 'when :live environment requested' do
+    let(:environment) { :live }
+
+    it 'sets the environment to :live' do
+      assert_equal environment, object.environment
+    end
+  end
+
+  describe 'when :production synonym requested' do
+    let(:environment) { :production }
+
+    it 'sets the environment to :live' do
+      assert_equal :live, object.environment
+    end
+  end
+
+  describe 'when environment is passed as a string' do
+    let(:environment) { 'sandbox' }
+
+    it 'converts the environment to a symbol' do
+      assert_equal :sandbox, object.environment
+    end
+  end
+
+  describe 'when an unrecognized environment is requested' do
+    let(:environment) { :turtles }
+
+    it 'raises an error' do
+      exception = assert_raises(JD::UnsupportedEnvironmentError) { object }
+      assert_equal "The :turtles environment is not supported.", exception.message
+    end
+  end
+end

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

@@ -0,0 +1,58 @@
+require 'support/helper'
+
+class UriHelpersHelperSample
+  include JD::Helpers::UriHelpers
+
+  def test
+    'test'
+  end
+end
+
+describe 'UriHelpers' do
+  let(:object) { UriHelpersHelperSample.new }
+
+  describe '#uri_path' do
+    it 'extracts the path from the uri' do
+      path = object.send(:uri_path, 'https://example.com/turtles')
+      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'
+    end
+  end
+
+  describe '#id_from_uri(uri, label)' do
+    it 'extracts the id immediately following a given label' do
+      uri = 'https://example.com/cows/123/pigs/456/turtles/789/birds/012'
+      assert_equal '789', object.send(:id_from_uri, uri, 'turtles')
+    end
+
+    it 'accepts a symbol for the label' do
+      uri = 'https://example.com/cows/123/pigs/456/turtles/789/birds/012'
+      assert_equal '789', object.send(:id_from_uri, uri, :turtles)
+    end
+
+    it 'is a private method' do
+      uri = 'https://example.com/cows/123/pigs/456/turtles/789/birds/012'
+
+      exception = assert_raises(NoMethodError) { object.id_from_uri(uri, 'turtles') }
+      assert_includes exception.message, 'private method'
+    end
+  end
+
+  it "preserves the public nature of the including class's other methods" do
+    assert_equal 'test', object.test
+  end
+end

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

@@ -0,0 +1,74 @@
+require 'support/helper'
+
+class ValidateContributionDefinitionHelperSample
+  include JD::Helpers::ValidateContributionDefinition
+
+  attr_reader :client
+
+  def initialize(client)
+    @client = client
+  end
+end
+
+describe 'Helpers::ValidateContributionDefinition' do
+  let(:object) { ValidateContributionDefinitionHelperSample.new(client) }
+
+  describe '#validate_contribution_definition' do
+    it 'returns true when contribution_definition_id is present' do
+      assert object.send(:validate_contribution_definition)
+    end
+
+    it 'raises an error when contribution_definition_id is missing' do
+      client.contribution_definition_id = nil
+
+      assert_raises(JD::MissingContributionDefinitionIdError) do
+        object.send(:validate_contribution_definition)
+      end
+    end
+  end
+
+  # describe '#uri_path' do
+  #   it 'extracts the path from the uri' do
+  #     path = object.send(:uri_path, 'https://example.com/turtles')
+  #     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'
+  #   end
+  # end
+  #
+  # describe '#id_from_uri(uri, label)' do
+  #   it 'extracts the id immediately following a given label' do
+  #     uri = 'https://example.com/cows/123/pigs/456/turtles/789/birds/012'
+  #     assert_equal '789', object.send(:id_from_uri, uri, 'turtles')
+  #   end
+  #
+  #   it 'accepts a symbol for the label' do
+  #     uri = 'https://example.com/cows/123/pigs/456/turtles/789/birds/012'
+  #     assert_equal '789', object.send(:id_from_uri, uri, :turtles)
+  #   end
+  #
+  #   it 'is a private method' do
+  #     uri = 'https://example.com/cows/123/pigs/456/turtles/789/birds/012'
+  #
+  #     exception = assert_raises(NoMethodError) { object.id_from_uri(uri, 'turtles') }
+  #     assert_includes exception.message, 'private method'
+  #   end
+  # end
+  #
+  # it "preserves the public nature of the including class's other methods" do
+  #   assert_equal 'test', object.test
+  # end
+end