my_john_deere_api 0.12.1 → 0.12.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f9297ea3e898d79d691a1e856e58ee625b21d49e60a9f8b04cdf28b569d2239d
-  data.tar.gz: ae7cc6bf71c857613ea576971cefafb81f7dca8d5fc1481334f3869a41644e63
+  metadata.gz: 19b47734d5e6b4ad385e8ab7a23f2335da7a55cd615e9b893e7a01d32594cedf
+  data.tar.gz: 409d9106defce29a80ef99b98bb958cada379df66c4e01a1c81d44d47b2e96fc
 SHA512:
-  metadata.gz: fee3ddddb9dab9d75125d803ca8a8faab7bbe1086eb77a0b09f03e980c12b1454ddb9ef14800eefe0bd980fd9476481fa761c66830fbc4eb58b2ba4b2d14fe3a
-  data.tar.gz: a1536a1ea130a74590d8345c8e8f58f253bdd36676826e79726b83309e737252c10c7c57f2715a9e74652471d0a3bbd7d6e6b8dd008694f8bc655d4806d74c77
+  metadata.gz: 8d0133e30516d2a70e9fbd466ed74b2a6aefc8dbcbf69cd84cf935742e682d4077571db4839bcfd49ee2a707f901bfa87012b3c49e07f5d3176a36f7277de490
+  data.tar.gz: e3e87c29522b6e70fca48b612ac13a19d78abcfc9c27f2f755f8a601630f336092dc325f932b98db7985755f931a6d1041fb9df6a437e58c6aba6c0bb7c67183

data/lib/my_john_deere_api/authorize.rb

@@ -1,75 +1,69 @@
-class MyJohnDeereApi::Authorize
-  attr_reader :api_key, :api_secret,
-    :request_token, :request_secret,
-    :access_token, :access_secret,
-    :environment, :options
-
-  DEFAULTS = {
-    environment: :live
-  }
-
-  ##
-  # Create an Authorize object.
-  #
-  # This is used to obtain authentication an access key/secret
-  # on behalf of a user.
-
-  def initialize(api_key, api_secret, options = {})
-    @options = DEFAULTS.merge(options)
-
-    @api_key = api_key
-    @api_secret = api_secret
-    self.environment = @options[: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)
-
-    request_options = options.slice(:oauth_callback)
-
-    requester = consumer.get_request_token(request_options)
-    @request_token = requester.token
-    @request_secret = requester.secret
-
-    @authorize_url = requester.authorize_url(request_options)
-  end
-
-  ##
-  # API consumer that makes non-user-specific GET requests
-
-  def consumer
-    return @consumer if defined?(@consumer)
-    @consumer = MyJohnDeereApi::Consumer.new(@api_key, @api_secret, environment: environment).app_get
-  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(consumer, token, secret)
-    access_object = requester.get_access_token(oauth_verifier: code)
-    @access_token = access_object.token
-    @access_secret = access_object.secret
-    nil
-  end
-
-  private
-
-  ##
-  # intelligently sets the environment
-
-  def environment=(value)
-    value = value.to_sym
-    @environment = value == :production ? :live : value
+module MyJohnDeereApi
+  class Authorize
+    include Helpers::EnvironmentHelper
+
+    attr_reader :api_key, :api_secret,
+      :request_token, :request_secret,
+      :access_token, :access_secret,
+      :environment, :options
+
+    DEFAULTS = {
+      environment: :live
+    }
+
+    ##
+    # Create an Authorize object.
+    #
+    # This is used to obtain authentication an access key/secret
+    # on behalf of a user.
+
+    def initialize(api_key, api_secret, options = {})
+      @options = DEFAULTS.merge(options)
+
+      @api_key = api_key
+      @api_secret = api_secret
+      self.environment = @options[: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)
+
+      request_options = options.slice(:oauth_callback)
+
+      requester = consumer.get_request_token(request_options)
+      @request_token = requester.token
+      @request_secret = requester.secret
+
+      @authorize_url = requester.authorize_url(request_options)
+    end
+
+    ##
+    # API consumer that makes non-user-specific GET requests
+
+    def consumer
+      return @consumer if defined?(@consumer)
+      @consumer = MyJohnDeereApi::Consumer.new(@api_key, @api_secret, environment: environment).app_get
+    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(consumer, token, secret)
+      access_object = requester.get_access_token(oauth_verifier: code)
+      @access_token = access_object.token
+      @access_secret = access_object.secret
+      nil
+    end
   end
 end

data/lib/my_john_deere_api/client.rb

@@ -1,115 +1,112 @@
-class MyJohnDeereApi::Client
-  attr_reader :api_key, :api_secret, :access_token, :access_secret, :environment
-
-  DEFAULTS = {
-    environment: :live
-  }
-
-  ##
-  # Creates the client with everthing it needs to perform API requests.
-  # User-specific credentials are optional, but user-specific API
-  # requests are only possible if they are supplied.
-  #
-  # options:
-  #
-  # [:environment] :sandbox or :live
-  #
-  # [:access] an array with two elements, the access_token
-  #           and the access_secret of the given user
-
-  def initialize(api_key, api_secret, options = {})
-    options = DEFAULTS.merge(options)
-
-    @api_key = api_key
-    @api_secret = api_secret
-
-    if options.has_key?(:access) && options[:access].is_a?(Array)
-      @access_token, @access_secret = options[:access]
+module MyJohnDeereApi
+  class Client
+    include Helpers::EnvironmentHelper
+
+    attr_reader :api_key, :api_secret, :access_token, :access_secret, :environment
+
+    DEFAULTS = {
+      environment: :live
+    }
+
+    ##
+    # Creates the client with everthing it needs to perform API requests.
+    # User-specific credentials are optional, but user-specific API
+    # requests are only possible if they are supplied.
+    #
+    # options:
+    #
+    # [:environment] :sandbox or :live
+    #
+    # [:access] an array with two elements, the access_token
+    #           and the access_secret of the given user
+
+    def initialize(api_key, api_secret, options = {})
+      options = DEFAULTS.merge(options)
+
+      @api_key = api_key
+      @api_secret = api_secret
+
+      if options.has_key?(:access) && options[:access].is_a?(Array)
+        @access_token, @access_secret = options[:access]
+      end
+
+      self.environment = options[:environment]
     end
 
-    self.environment = options[:environment]
-  end
-
-  ##
-  # generic user-specific GET request method that returns JSON
-
-  def get resource
-    resource = resource.to_s
-    resource = "/#{resource}" unless resource =~ /^\//
-    response = accessor.get(resource, headers)
-
-    JSON.parse(response.body)
-  end
-
-  ##
-  # generic user-specific POST request method that returns JSON
+    ##
+    # generic user-specific GET request method that returns JSON
 
-  def post resource, body
-    resource = resource.to_s
-    resource = "/#{resource}" unless resource =~ /^\//
-    response = accessor.post(resource, body.to_json, post_headers)
+    def get resource
+      resource = resource.to_s
+      resource = "/#{resource}" unless resource =~ /^\//
+      response = accessor.get(resource, headers)
 
-    if response.body.size > 0
       JSON.parse(response.body)
-    else
-      {}
     end
-  end
 
-  ##
-  # generic user-specific DELETE request method
+    ##
+    # generic user-specific POST request method that returns JSON
 
-  def delete resource
-    resource = resource.to_s
-    resource = "/#{resource}" unless resource =~ /^\//
-    response = accessor.delete(resource, headers)
+    def post resource, body
+      resource = resource.to_s
+      resource = "/#{resource}" unless resource =~ /^\//
+      response = accessor.post(resource, body.to_json, post_headers)
 
-    if response.body && response.body.size > 0
-      JSON.parse(response.body)
-    else
-      {}
+      if response.body.size > 0
+        JSON.parse(response.body)
+      else
+        {}
+      end
     end
-  end
 
-  ##
-  # organizations associated with this access
+    ##
+    # generic user-specific DELETE request method
 
-  def organizations
-    return @organizations if defined?(@organizations)
-    @organizations = MyJohnDeereApi::Request::Collection::Organizations.new(accessor).all
-  end
+    def delete resource
+      resource = resource.to_s
+      resource = "/#{resource}" unless resource =~ /^\//
+      response = accessor.delete(resource, headers)
 
-  private
+      if response.body && response.body.size > 0
+        JSON.parse(response.body)
+      else
+        {}
+      end
+    end
 
-  ##
-  # allows :production param to be a synonym for :live
+    ##
+    # organizations associated with this access
 
-  def environment=(value)
-    @environment = value == :production ? :live : value
-  end
+    def organizations
+      return @organizations if defined?(@organizations)
+      @organizations = MyJohnDeereApi::Request::Collection::Organizations.new(accessor).all
+    end
 
-  ##
-  # Returns an oAuth consumer which can be used to build requests
+    private
 
-  def consumer
-    return @consumer if defined?(@consumer)
-    @consumer = MyJohnDeereApi::Consumer.new(@api_key, @api_secret, environment: environment)
-  end
+    ##
+    # Returns an oAuth consumer which can be used to build requests
 
-  ##
-  # Returns an oAuth AccessToken object which can be used to make
-  # user-specific API requests
+    def consumer
+      return @consumer if defined?(@consumer)
+      @consumer = MyJohnDeereApi::Consumer.new(@api_key, @api_secret, environment: environment)
+    end
 
-  def accessor
-    return @accessor if defined?(@accessor)
-    @accessor = OAuth::AccessToken.new(consumer.user_get, access_token, access_secret)
-  end
+    ##
+    # Returns an oAuth AccessToken object which can be used to make
+    # user-specific API requests
 
-  def headers
-    @headers ||= {accept: 'application/vnd.deere.axiom.v3+json'}
-  end
+    def accessor
+      return @accessor if defined?(@accessor)
+      @accessor = OAuth::AccessToken.new(consumer.user_get, access_token, access_secret)
+    end
 
-  def post_headers
-    @post_headers ||= headers.merge({'Content-Type' => 'application/vnd.deere.axiom.v3+json'})
+    def headers
+      @headers ||= {accept: 'application/vnd.deere.axiom.v3+json'}
+    end
+
+    def post_headers
+      @post_headers ||= headers.merge({'Content-Type' => 'application/vnd.deere.axiom.v3+json'})
+    end
   end
 end

data/lib/my_john_deere_api/consumer.rb

@@ -1,6 +1,7 @@
 module MyJohnDeereApi
   class Consumer
     include Helpers::CaseConversion
+    include Helpers::EnvironmentHelper
 
     attr_reader :api_key, :api_secret, :environment, :base_url
 
@@ -41,14 +42,6 @@ module MyJohnDeereApi
 
     private
 
-    ##
-    # intelligently sets the environment
-
-    def environment=(value)
-      value = value.to_sym
-      @environment = value == :production ? :live : value
-    end
-
     def consumer(site)
       OAuth::Consumer.new(
         api_key,

data/lib/my_john_deere_api/errors/unsupported_environment_error.rb

@@ -0,0 +1,18 @@
+module MyJohnDeereApi
+  ##
+  # This error is used when an unsupported environment has been requested.
+  # Supported environments currently include :sandbox, :live, and :production
+  # as a synonym for :live.
+
+  class UnsupportedEnvironmentError < StandardError
+    def initialize(environment = nil)
+      message = if environment
+        "The #{environment.inspect} environment is not supported."
+      else
+        'This environment is not supported.'
+      end
+
+      super(message)
+    end
+  end
+end

data/lib/my_john_deere_api/errors.rb

@@ -2,4 +2,5 @@ module MyJohnDeereApi::Errors
   require           'my_john_deere_api/errors/access_token_error'
   require           'my_john_deere_api/errors/invalid_record_error'
   require           'my_john_deere_api/errors/type_mismatch_error'
+  require           'my_john_deere_api/errors/unsupported_environment_error'
 end

data/lib/my_john_deere_api/helpers/environment_helper.rb

@@ -0,0 +1,25 @@
+require 'uri'
+
+module MyJohnDeereApi
+  module Helpers::EnvironmentHelper
+    attr_reader :environment
+
+    private
+
+    ##
+    # Intelligently set the environment
+
+    def environment=(value)
+      value = (value || :live).to_sym
+
+      @environment = case value
+      when :sandbox, :live
+        value
+      when :production
+        :live
+      else
+        raise UnsupportedEnvironmentError, value
+      end
+    end
+  end
+end

data/lib/my_john_deere_api/helpers.rb

@@ -1,4 +1,5 @@
 module MyJohnDeereApi::Helpers
   autoload :UriHelpers,        'my_john_deere_api/helpers/uri_helpers'
   autoload :CaseConversion, 'my_john_deere_api/helpers/case_conversion'
+  autoload :EnvironmentHelper, 'my_john_deere_api/helpers/environment_helper'
 end

data/lib/my_john_deere_api/version.rb

@@ -1,3 +1,3 @@
 module MyJohnDeereApi
-  VERSION='0.12.1'
+  VERSION='0.12.2'
 end

data/test/lib/my_john_deere_api/authorize_test.rb

@@ -23,40 +23,12 @@ describe 'MyJohnDeereApi::Authorize' do
       assert_equal API_SECRET, authorize.api_secret
     end
 
-    it 'sets the sandbox environment' do
+    it 'accepts the environment' do
       environment = :sandbox
 
       authorize = VCR.use_cassette('catalog') { JD::Authorize.new(API_KEY, API_SECRET, environment: environment) }
       assert_equal environment, authorize.environment
     end
-
-    it 'sets the live environment' do
-      environment = :live
-
-      authorize = VCR.use_cassette('catalog') { JD::Authorize.new(API_KEY, API_SECRET, environment: environment) }
-      assert_equal environment, authorize.environment
-    end
-
-    it 'accepts production as a synonym for live environment' do
-      environment = :production
-
-      authorize = VCR.use_cassette('catalog') { JD::Authorize.new(API_KEY, API_SECRET, environment: environment) }
-      assert_equal :live, authorize.environment
-    end
-
-    it 'converts environment to symbol' do
-      environment = 'sandbox'
-
-      authorize = VCR.use_cassette('catalog') { JD::Authorize.new(API_KEY, API_SECRET, environment: environment) }
-      assert_equal environment.to_sym, authorize.environment
-    end
-
-    it 'defaults to live environment' do
-      environment = :live
-
-      authorize = VCR.use_cassette('catalog') { JD::Authorize.new(API_KEY, API_SECRET) }
-      assert_equal environment, authorize.environment
-    end
   end
 
   describe '#consumer' do

data/test/lib/my_john_deere_api/client_test.rb

@@ -19,33 +19,12 @@ describe 'MyJohnDeereApi::Client' do
       assert_equal access_secret, client.access_secret
     end
 
-    it 'accepts sandbox environment' do
+    it 'accepts the environment' do
       environment = :sandbox
 
       client = JD::Client.new(API_KEY, API_SECRET, environment: environment)
       assert_equal environment, client.environment
     end
-
-    it 'accepts live environment' do
-      environment = :live
-
-      client = JD::Client.new(API_KEY, API_SECRET, environment: environment)
-      assert_equal environment, client.environment
-    end
-
-    it 'accepts production as a synonym for live' do
-      environment = :production
-
-      client = JD::Client.new(API_KEY, API_SECRET, environment: environment)
-      assert_equal :live, client.environment
-    end
-
-    it 'defaults to live environment' do
-      environment = :live
-
-      client = JD::Client.new(API_KEY, API_SECRET)
-      assert_equal environment, client.environment
-    end
   end
 
   describe '#get' do

data/test/lib/my_john_deere_api/consumer_test.rb

@@ -9,7 +9,7 @@ describe 'JD::Consumer' do
       assert_equal API_SECRET, consumer.api_secret
     end
 
-    it 'accepts sandbox environment' do
+    it 'accepts the environment' do
       environment = :sandbox
       consumer = JD::Consumer.new(API_KEY, API_SECRET, environment: environment)
 
@@ -17,38 +17,6 @@ describe 'JD::Consumer' do
       assert_equal JD::Consumer::URLS[environment], consumer.base_url
     end
 
-    it 'accepts live environment' do
-      environment = :live
-      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 production as a synonym for live environment' do
-      environment = :production
-      consumer = JD::Consumer.new(API_KEY, API_SECRET, environment: environment)
-
-      assert_equal :live, consumer.environment
-      assert_equal JD::Consumer::URLS[:live], consumer.base_url
-    end
-
-    it 'defaults to live environment' do
-      default_environment = :live
-      consumer = JD::Consumer.new(API_KEY, API_SECRET)
-
-      assert_equal default_environment, consumer.environment
-      assert_equal JD::Consumer::URLS[default_environment], consumer.base_url
-    end
-
-    it 'converts environment string to symbol' do
-      environment = 'sandbox'
-      consumer = JD::Consumer.new(API_KEY, API_SECRET, environment: environment)
-
-      assert_equal environment.to_sym, consumer.environment
-      assert_equal JD::Consumer::URLS[environment.to_sym], 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)

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

@@ -13,5 +13,9 @@ describe 'MyJohnDeereApi Errors' do
     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/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_test.rb

@@ -9,5 +9,9 @@ describe 'MyJohnDeereApi::Helpers' do
     it 'loads Helpers::CaseConversion' do
       assert JD::Helpers::CaseConversion
     end
+
+    it 'loads Helpers::EnvironmentHelper' do
+      assert JD::Helpers::EnvironmentHelper
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: my_john_deere_api
 version: !ruby/object:Gem::Version
-  version: 0.12.1
+  version: 0.12.2
 platform: ruby
 authors:
 - Jaime Bellmyer
@@ -110,8 +110,10 @@ files:
 - lib/my_john_deere_api/errors/access_token_error.rb
 - lib/my_john_deere_api/errors/invalid_record_error.rb
 - lib/my_john_deere_api/errors/type_mismatch_error.rb
+- lib/my_john_deere_api/errors/unsupported_environment_error.rb
 - lib/my_john_deere_api/helpers.rb
 - lib/my_john_deere_api/helpers/case_conversion.rb
+- lib/my_john_deere_api/helpers/environment_helper.rb
 - lib/my_john_deere_api/helpers/uri_helpers.rb
 - lib/my_john_deere_api/model.rb
 - lib/my_john_deere_api/model/asset.rb
@@ -142,8 +144,10 @@ files:
 - test/lib/my_john_deere_api/errors/access_token_error_test.rb
 - test/lib/my_john_deere_api/errors/invalid_record_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
 - test/lib/my_john_deere_api/errors_test.rb
 - test/lib/my_john_deere_api/helpers/case_conversion_test.rb
+- test/lib/my_john_deere_api/helpers/environment_helper_test.rb
 - test/lib/my_john_deere_api/helpers/uri_helpers_test.rb
 - test/lib/my_john_deere_api/helpers_test.rb
 - test/lib/my_john_deere_api/model/asset_location_test.rb