my_john_deere_api 0.5.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8f27839609fe2e86e82d918edae99dd77d78cb9d7dad78c061d8ab198837953d
-  data.tar.gz: b302429624cc3f1a504e77235c105f94af9363bc075809f46f1659bf1b59859c
+  metadata.gz: 73cbc5de675267d73f21bf1adc0624236ad833ff0e7174dcec7e7198d9b1d1cb
+  data.tar.gz: '0840ae125650b4f307f74e21b4b255d5bc50878fd748ec1e1835bbf2e17c885c'
 SHA512:
-  metadata.gz: 3b2509a126cf7aef80dc4984865660eb20285a4ccbb5aaec61a622449eebc3eb0628d1a44f3de78bfc95af42f639bbecd5a5796219b3d8be3ea4be7612e90b96
-  data.tar.gz: 2b401cacbc5c4fc8e9b224c89639689ceb681d8b697dfdd1b1f3ff62b1b91c5ea40508a2de61ade9ad8744773a90358067e9240faaa3f4088803c3caac1eb196
+  metadata.gz: 07e8d738e0ecc1e3ba071cf4e09d61be831e8851c190bc805d9cc11903a445126d0a66f5c414043d4cea3bf203c014d8bd377bde18ea79ba6312fbeda3a061d7
+  data.tar.gz: d590a803bf509ac80ff6dc3ab1645ccacc580a733ca9cf8d53bb6d5e7ea1cfd4f2d61a6fc495ca7dc8d509fc1dede65307dbd59cb0024dd4b65d1f466e2d5af8

data/lib/my_john_deere_api/errors.rb

@@ -1,3 +1,4 @@
 module MyJohnDeereApi::Errors
   require           'my_john_deere_api/errors/access_token_error'
+  require           'my_john_deere_api/errors/type_mismatch_error'
 end

data/lib/my_john_deere_api/errors/type_mismatch_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 TypeMismatchError < StandardError
+    def initialize(message = "Record type does not match what was expected")
+      super
+    end
+  end
+end

data/lib/my_john_deere_api/model.rb

@@ -1,4 +1,5 @@
 module MyJohnDeereApi::Model
+  autoload :Base,                'my_john_deere_api/model/base'
   autoload :Asset,               'my_john_deere_api/model/asset'
   autoload :AssetLocation,       'my_john_deere_api/model/asset_location'
   autoload :Organization,        'my_john_deere_api/model/organization'

data/lib/my_john_deere_api/model/asset.rb

@@ -1,34 +1,6 @@
 module MyJohnDeereApi
-  class Model::Asset
-    include Helpers::UriHelpers
-
-    attr_reader :accessor, :id, :title, :asset_category, :asset_type, :asset_sub_type, :last_modified_date, :links
-
-    ##
-    # arguments:
-    #
-    # [record] a JSON object of type 'Field', returned from the API.
-    #
-    # [accessor (optional)] a valid oAuth Access Token. This is only
-    #                       needed if further API requests are going
-    #                       to be made, as is the case with *flags*.
-
-    def initialize(record, accessor = nil)
-      @accessor = accessor
-
-      @id = record['id']
-      @title = record['title']
-      @asset_category = record['assetCategory']
-      @asset_type = record['assetType']
-      @asset_sub_type = record['assetSubType']
-      @last_modified_date = record['lastModifiedDate']
-
-      @links = {}
-
-      record['links'].each do |association|
-        @links[association['rel']] = uri_path(association['uri'])
-      end
-    end
+  class Model::Asset < Model::Base
+    attr_reader :title, :asset_category, :asset_type, :asset_sub_type, :last_modified_date
 
     ##
     # locations associated with this asset
@@ -39,5 +11,15 @@ module MyJohnDeereApi
       return @locations if defined?(@locations)
       @locations = MyJohnDeereApi::Request::Collection::AssetLocations.new(accessor, asset: id).all
     end
+
+    private
+
+    def map_attributes(record)
+      @title = record['title']
+      @asset_category = record['assetCategory']
+      @asset_type = record['assetType']
+      @asset_sub_type = record['assetSubType']
+      @last_modified_date = record['lastModifiedDate']
+    end
   end
 end

data/lib/my_john_deere_api/model/asset_location.rb

@@ -1,27 +1,15 @@
 require 'json'
 
 module MyJohnDeereApi
-  class Model::AssetLocation
-    include Helpers::UriHelpers
+  class Model::AssetLocation < Model::Base
+    attr_reader :timestamp, :geometry, :measurement_data
 
-    attr_reader :accessor, :timestamp, :geometry, :measurement_data, :links
-
-    ##
-    # arguments:
-    #
-    # [record] a JSON object of type 'Field', returned from the API.
-    #
-    # [accessor (optional)] a valid oAuth Access Token. This is only
-    #                       needed if further API requests are going
-    #                       to be made, as is the case with *flags*.
-
-    def initialize(record, accessor = nil)
-      @accessor = accessor
+    private
 
+    def map_attributes(record)
       @timestamp = record['timestamp']
       @geometry = JSON.parse(record['geometry'])
       @measurement_data = record['measurementData']
-      @links = {}
     end
   end
 end

data/lib/my_john_deere_api/model/base.rb

@@ -0,0 +1,49 @@
+module MyJohnDeereApi
+  class Model::Base
+    include Helpers::CaseConversion
+    include Helpers::UriHelpers
+
+    attr_reader :id, :record_type, :accessor, :links
+
+    ##
+    # arguments:
+    #
+    # [record] a JSON object of type 'Field', returned from the API.
+    #
+    # [accessor (optional)] a valid oAuth Access Token. This is only
+    #                       needed if further API requests are going
+    #                       to be made, as is the case with *flags*.
+
+    def initialize(record, accessor = nil)
+      @id = record['id']
+      @record_type = record['@type']
+      @accessor = accessor
+
+      map_attributes(record)
+
+      @links = {}
+
+      record['links'].each do |association|
+        @links[underscore(association['rel'])] = uri_path(association['uri'])
+      end
+    end
+
+    private
+
+    ##
+    # This method receives the full record hash and extracts whatever extra
+    # attributes are needed for the given base class. This is intended to
+    # be overridden by child classes instead of monkeypatching #initialize.
+
+    def map_attributes(record)
+
+    end
+
+    ##
+    # Expected record type. Override in child classes.
+
+    def expected_record_type
+      'Base'
+    end
+  end
+end

data/lib/my_john_deere_api/model/field.rb

@@ -1,31 +1,6 @@
 module MyJohnDeereApi
-  class Model::Field
-    include Helpers::UriHelpers
-
-    attr_reader :name, :id, :links, :accessor
-
-    ##
-    # arguments:
-    #
-    # [record] a JSON object of type 'Field', returned from the API.
-    #
-    # [accessor (optional)] a valid oAuth Access Token. This is only
-    #                       needed if further API requests are going
-    #                       to be made, as is the case with *flags*.
-
-    def initialize(record, accessor = nil)
-      @accessor = accessor
-
-      @name = record['name']
-      @id = record['id']
-      @archived = record['archived']
-
-      @links = {}
-
-      record['links'].each do |association|
-        @links[association['rel']] = uri_path(association['uri'])
-      end
-    end
+  class Model::Field < Model::Base
+    attr_reader :name
 
     ##
     # Since the archived attribute is boolean, we reflect this in the
@@ -47,6 +22,11 @@ module MyJohnDeereApi
 
     private
 
+    def map_attributes(record)
+      @name = record['name']
+      @archived = record['archived']
+    end
+
     ##
     # Infer the organization_id from the 'self' link
 

data/lib/my_john_deere_api/model/flag.rb

@@ -1,36 +1,8 @@
 require 'json'
 
 module MyJohnDeereApi
-  class Model::Flag
-    include Helpers::CaseConversion
-    include Helpers::UriHelpers
-
-    attr_reader :id, :notes, :geometry, :links, :accessor
-
-    ##
-    # arguments:
-    #
-    # [record] a JSON object of type 'Flag', returned from the API.
-    #
-    # [accessor (optional)] a valid oAuth Access Token. This is only
-    #                       needed if further API requests are going
-    #                       to be made.
-
-    def initialize(record, accessor = nil)
-      @accessor = accessor
-
-      @id = record['id']
-      @notes = record['notes']
-      @geometry =JSON.parse(record['geometry'])
-      @proximity_alert_enabled = record['proximityAlertEnabled']
-      @archived = record['archived']
-
-      @links = {}
-
-      record['links'].each do |association|
-        @links[underscore(association['rel'])] = uri_path(association['uri'])
-      end
-    end
+  class Model::Flag < Model::Base
+    attr_reader :notes, :geometry
 
     ##
     # Since the archived attribute is boolean, we reflect this in the
@@ -47,5 +19,14 @@ module MyJohnDeereApi
     def proximity_alert_enabled?
       @proximity_alert_enabled
     end
+
+    private
+
+    def map_attributes(record)
+      @notes = record['notes']
+      @geometry =JSON.parse(record['geometry'])
+      @proximity_alert_enabled = record['proximityAlertEnabled']
+      @archived = record['archived']
+    end
   end
 end

data/lib/my_john_deere_api/model/organization.rb

@@ -1,34 +1,8 @@
 require 'uri'
 
 module MyJohnDeereApi
-  class Model::Organization
-    include Helpers::UriHelpers
-
-    attr_reader :name, :type, :id, :links, :accessor
-
-    ##
-    # arguments:
-    #
-    # [record] a JSON object of type 'Organization', returned from the API.
-    #
-    # [accessor (optional)] a valid oAuth Access Token. This is only
-    #                       needed if further API requests are going
-    #                       to be made, as is the case with *fields*.
-
-    def initialize(record, accessor = nil)
-      @accessor = accessor
-
-      @name = record['name']
-      @type = record['type']
-      @id = record['id']
-      @member = record['member']
-
-      @links = {}
-
-      record['links'].each do |association|
-        @links[association['rel']] = uri_path(association['uri'])
-      end
-    end
+  class Model::Organization < Model::Base
+    attr_reader :name, :type
 
     ##
     # Since the member attribute is boolean, we reflect this in the
@@ -57,5 +31,13 @@ module MyJohnDeereApi
       return @assets if defined?(@assets)
       @assets = MyJohnDeereApi::Request::Collection::Assets.new(accessor, organization: id).all
     end
+
+    private
+
+    def map_attributes(record)
+      @name = record['name']
+      @type = record['type']
+      @member = record['member']
+    end
   end
 end

data/lib/my_john_deere_api/version.rb

@@ -1,3 +1,3 @@
 module MyJohnDeereApi
-  VERSION='0.5.0'
+  VERSION='0.5.1'
 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_test.rb

@@ -5,5 +5,9 @@ describe 'MyJohnDeereApi Errors' do
     it 'loads AccessTokenError' do
       assert JD::AccessTokenError
     end
+
+    it 'loads TypeMismatchError' do
+      assert JD::TypeMismatchError
+    end
   end
 end

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

@@ -0,0 +1,64 @@
+require 'support/helper'
+
+class SampleModel < JD::Model::Base
+  attr_reader :somefield
+
+  def map_attributes(record)
+    @somefield = record['somefield']
+  end
+end
+
+describe 'MyJohnDeereApi::Model::Base' do
+  let(:object) { JD::Model::Base.new(record, accessor) }
+  let(:accessor) { 'accessor' }
+
+  let(:record) do
+    {
+      '@type'=>'Base',
+      'id'=>'123',
+      'somefield'=>'somevalue',
+      "links"=>[
+        {"@type"=>"Link", "rel"=>"self", "uri"=>"https://sandboxapi.deere.com/platform/assets/123456"},
+        {"@type"=>"Link", "rel"=>"organization", "uri"=>"https://sandboxapi.deere.com/platform/organizations/234567"},
+        {"@type"=>"Link", "rel"=>"locations", "uri"=>"https://sandboxapi.deere.com/platform/assets/123456/locations"},
+      ]
+    }
+  end
+
+  it 'includes UriHelpers' do
+    assert_includes object.private_methods, :uri_path
+    assert_includes object.private_methods, :id_from_uri
+  end
+
+  describe '#initialize(record, accessor = nil)' do
+    def link_for label
+      record['links'].detect{|link| link['rel'] == label}['uri'].gsub('https://sandboxapi.deere.com/platform', '')
+    end
+
+    it 'sets the base attributes' do
+      assert_equal record['id'], object.id
+      assert_equal record['@type'], object.record_type
+      assert_equal accessor, object.accessor
+    end
+
+    it 'sets the links' do
+      links = object.links
+
+      assert_kind_of Hash, links
+
+      ['self', 'organization', 'locations'].each do |link|
+        assert_equal link_for(link), links[link]
+      end
+    end
+
+    it 'maps additional fields in subclasses' do
+      object = SampleModel.new(record)
+      assert_equal 'somevalue', object.somefield
+    end
+
+    it 'does not require accessor' do
+      object = JD::Model::Base.new(record)
+      assert_nil object.accessor
+    end
+  end
+end

data/test/lib/my_john_deere_api/model_test.rb

@@ -2,6 +2,10 @@ require 'support/helper'
 
 describe 'MyJohnDeereApi::Model' do
   describe 'loading dependencies' do
+    it 'loads Model::Base' do
+      assert JD::Model::Base
+    end
+
     it 'loads Model::Asset' do
       assert JD::Model::Asset
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: my_john_deere_api
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.1
 platform: ruby
 authors:
 - Jaime. Bellmyer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-01-10 00:00:00.000000000 Z
+date: 2020-01-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: vcr
@@ -101,12 +101,14 @@ files:
 - lib/my_john_deere_api/consumer.rb
 - lib/my_john_deere_api/errors.rb
 - lib/my_john_deere_api/errors/access_token_error.rb
+- lib/my_john_deere_api/errors/type_mismatch_error.rb
 - lib/my_john_deere_api/helpers.rb
 - lib/my_john_deere_api/helpers/case_conversion.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
 - lib/my_john_deere_api/model/asset_location.rb
+- lib/my_john_deere_api/model/base.rb
 - lib/my_john_deere_api/model/field.rb
 - lib/my_john_deere_api/model/flag.rb
 - lib/my_john_deere_api/model/organization.rb
@@ -123,12 +125,14 @@ 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/access_token_error_test.rb
+- test/lib/my_john_deere_api/errors/type_mismatch_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/uri_helpers_test.rb
 - test/lib/my_john_deere_api/helpers_test.rb
 - test/lib/my_john_deere_api/model/asset_location_test.rb
 - test/lib/my_john_deere_api/model/asset_test.rb
+- test/lib/my_john_deere_api/model/base_test.rb
 - test/lib/my_john_deere_api/model/field_test.rb
 - test/lib/my_john_deere_api/model/flag_test.rb
 - test/lib/my_john_deere_api/model/organization_test.rb