my_john_deere_api 1.3.5 → 1.3.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7f60f0a940a61665a81f8e64a2cbb8762beb8136e4e37f13a0ebf66ead20fcac
-  data.tar.gz: 45fb772147464452fdfd3ab37b75548ed9708369d374ba5c69c20ad03a428f51
+  metadata.gz: a060cb86023a65bf70b80bf717e86c725cb436e13d31d88bbd9148a235ab03c2
+  data.tar.gz: 95198638b33c2402679745aa2c43322af1fe039b446388b1ec800b3f8be451c7
 SHA512:
-  metadata.gz: 0166fd3c8b08975d9c5b548f459710bebd2cca464ffad209abe812e5c01c4057a4ec980faf11d0a8201b21fe4d6a24cd6ffe55a86ec70ac87fda429347b55ec7
-  data.tar.gz: b6e4f47f306adfaf52b6bf05054d11285f2a2382ce7f846e86479e6f12eda3bc7194874140036efa35e992f2132906bcd0349ecb58a17c5f6403b7818ac011fd
+  metadata.gz: db67993c3685f8e9a2519fefdc2e790a5d94c6e7accca6c94fc4a6daa9fe4ec6009e9eb23e12adfb987fd437038bd861a9542516a0a9a8e7089dd071ee59b1a6
+  data.tar.gz: 4bc3a3fe87d49f052c87d3f5fa746886a7c9b2edfb7db9972a507334c212d232c9d4091ae2f3c594864050ec5ce8bf9689762a2201ec7d16554dc67e50ec4488

data/lib/my_john_deere_api/model/asset.rb

@@ -2,6 +2,19 @@ module MyJohnDeereApi
   class Model::Asset < Model::Base
     attr_reader :title, :asset_category, :asset_type, :asset_sub_type, :last_modified_date
 
+    ##
+    # A listing of attributes that can be passed back to John Deere
+
+    def attributes
+      {
+        id: id,
+        title: title,
+        asset_category: asset_category,
+        asset_type: asset_type,
+        asset_sub_type: asset_sub_type
+      }
+    end
+
     ##
     # locations associated with this asset
 

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

@@ -1,89 +1,37 @@
 require 'json'
 
-module MyJohnDeereApi::Request
-  module Update::Asset
-    # ##
-    # # Make the request, if the instance is valid
-    #
-    # # def request
-    # #   validate!
-    # #
-    # #   @response = accessor.post(resource, request_body.to_json, headers)
-    # # end
-    #
-    # ##
-    # # Object created by request
-    #
-    # # def object
-    # #   return @object if defined?(@object)
-    # #
-    # #   request unless response
-    # #
-    # #   @object = model.new(fetch_record, accessor)
-    # # end
-    #
-    # ##
-    # # Runs validations, adding to the errors hash as needed. Returns true
-    # # if the errors hash is still empty after all validations have been run.
-    #
-    # # def valid?
-    # #   return @is_valid if defined?(@is_valid)
-    # #
-    # #   validate_required
-    # #   validate_attributes
-    # #
-    # #   @is_valid = errors.empty?
-    # # end
-    #
-    # ##
-    # # Raises an error if the record is invalid. Passes the errors hash
-    # # to the error, in order to build a useful message string.
-    #
-    # # def validate!
-    # #   raise(InvalidRecordError, errors) unless valid?
-    # # end
-    #
-    # private
-    #
-    # ##
-    # # Run validations unique to a given model. This should be overridden
-    # # by children where needed.
-    #
-    # # def validate_attributes
-    # # end
-    #
-    # ##
-    # # Convert inputs into working attributes. This allows us to auto-create
-    # # some attributes from others, or set defaults, on a class-by-class basis.
-    # # See Request::Create::AssetLocation for an example.
-    #
-    # def process_attributes
-    # end
-    #
-    # ##
-    # # Attributes that must be specified, override in child class
-    #
-    # def required_attributes
-    #   []
-    # end
-    #
-    # ##
-    # # Validates required attributes
-    #
-    # def validate_required
-    #   required_attributes.each do |attr|
-    #     errors[attr] = 'is required' unless attributes[attr]
-    #   end
-    # end
-    #
-    # ##
-    # # Headers for PUT request
-    #
-    # def headers
-    #   @headers ||= {
-    #     'Accept'        => 'application/vnd.deere.axiom.v3+json',
-    #     'Content-Type'  => 'application/vnd.deere.axiom.v3+json'
-    #   }
-    # end
+module MyJohnDeereApi
+  class Request::Update::Asset < Request::Update::Base
+    include Validators::Asset
+
+    private
+
+    ##
+    # Path supplied to API
+
+    def resource
+      @resource ||= "/assets/#{attributes[:id]}"
+    end
+
+    ##
+    # Request body
+
+    def request_body
+      return @body if defined?(@body)
+
+      @body = {
+        title: attributes[:title],
+        assetCategory: attributes[:asset_category],
+        assetType: attributes[:asset_type],
+        assetSubType: attributes[:asset_sub_type],
+        links: [
+          {
+            '@type' => 'Link',
+            'rel' => 'contributionDefinition',
+            'uri' => "#{accessor.consumer.site}/contributionDefinitions/#{attributes[:contribution_definition_id]}"
+          }
+        ]
+      }
+    end
   end
 end

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

@@ -1,8 +1,10 @@
 require 'json'
 
-module MyJohnDeereApi::Request
-  class Update::Base
-    attr_reader :accessor, :item, :attributes, :errors, :response
+module MyJohnDeereApi
+  class Request::Update::Base
+    include Validators::Base
+
+    attr_reader :accessor, :item, :attributes, :response
 
     ##
     # Accepts a valid oAuth AccessToken, the item to be updated, 
@@ -13,63 +15,29 @@ module MyJohnDeereApi::Request
     def initialize(accessor, item, attributes)
       @accessor = accessor
       @item = item
-      @attributes = attributes
+      @attributes = item.attributes.merge(attributes)
 
       process_attributes
-
-      @errors = {}
     end
 
     ##
     # Make the request, if the instance is valid
 
-    # def request
-    #   validate!
-    #
-    #   @response = accessor.post(resource, request_body.to_json, headers)
-    # end
+    def request
+      validate!
 
-    ##
-    # Object created by request
-
-    # def object
-    #   return @object if defined?(@object)
-    #
-    #   request unless response
-    #
-    #   @object = model.new(fetch_record, accessor)
-    # end
-
-    ##
-    # Runs validations, adding to the errors hash as needed. Returns true
-    # if the errors hash is still empty after all validations have been run.
-
-    # def valid?
-    #   return @is_valid if defined?(@is_valid)
-    #
-    #   validate_required
-    #   validate_attributes
-    #
-    #   @is_valid = errors.empty?
-    # end
+      @response = accessor.put(resource, request_body.to_json, headers)
+    end
 
     ##
-    # Raises an error if the record is invalid. Passes the errors hash
-    # to the error, in order to build a useful message string.
+    # Object, same as item for updates
 
-    # def validate!
-    #   raise(InvalidRecordError, errors) unless valid?
-    # end
+    def object
+      @object ||= item
+    end
 
     private
 
-    ##
-    # Run validations unique to a given model. This should be overridden
-    # by children where needed.
-
-    # def validate_attributes
-    # end
-
     ##
     # Convert inputs into working attributes. This allows us to auto-create
     # some attributes from others, or set defaults, on a class-by-class basis.
@@ -78,22 +46,6 @@ module MyJohnDeereApi::Request
     def process_attributes
     end
 
-    ##
-    # Attributes that must be specified, override in child class
-
-    def required_attributes
-      []
-    end
-
-    ##
-    # Validates required attributes
-
-    def validate_required
-      required_attributes.each do |attr|
-        errors[attr] = 'is required' unless attributes[attr]
-      end
-    end
-
     ##
     # Headers for PUT request
 

data/lib/my_john_deere_api/version.rb

@@ -1,3 +1,3 @@
 module MyJohnDeereApi
-  VERSION='1.3.5'
+  VERSION='1.3.6'
 end

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

@@ -52,6 +52,19 @@ describe 'MyJohnDeereApi::Model::Asset' do
     end
   end
 
+  describe '#attributes' do
+    it 'converts properties back to an attributes hash' do
+      asset = JD::Model::Asset.new(record)
+      attributes = asset.attributes
+
+      assert_equal asset.id, attributes[:id]
+      assert_equal asset.title, attributes[:title]
+      assert_equal asset.asset_category, attributes[:asset_category]
+      assert_equal asset.asset_type, attributes[:asset_type]
+      assert_equal asset.asset_sub_type, attributes[:asset_sub_type]
+    end
+  end
+
   describe '#locations' do
     it 'returns a collection of locations for this asset' do
       accessor

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

@@ -1,35 +1,90 @@
 require 'support/helper'
 
 describe 'MyJohnDeereApi::Request::Update::Asset' do
-  # let(:object) { JD::Request::Update::Base.new(accessor, item, attributes) }
-  # let(:item) { 'item' }
-  # let(:attributes) { {} }
-  #
-  # describe '#initialize(access_token, item, attributes)' do
-  #   it 'accepts an accessor, item and attributes' do
-  #     object = JD::Request::Update::Base.new(accessor, item, attributes)
-  #
-  #     assert_equal accessor, object.accessor
-  #     assert_equal item, object.item
-  #     assert_equal attributes, object.attributes
-  #   end
-  #
-  #   it 'creates an empty error hash' do
-  #     object = JD::Request::Update::Base.new(accessor, item, {})
-  #     assert_equal({}, object.errors)
-  #   end
-  # end
-  #
-  # describe '#headers' do
-  #   it 'sets the accept and content-type headers' do
-  #     object = JD::Request::Update::Base.new(accessor, item, attributes)
-  #     headers = object.send(:headers)
-  #
-  #     expected = 'application/vnd.deere.axiom.v3+json'
-  #
-  #     assert_kind_of Hash, headers
-  #     assert_equal expected, headers['Accept']
-  #     assert_equal expected, headers['Content-Type']
-  #   end
-  # end
+  let(:klass) { JD::Request::Update::Asset }
+  let(:object) { klass.new(accessor, item, attributes) }
+  let(:item) { JD::Model::Asset.new(record, accessor) }
+
+  let(:attributes) do
+    {
+      organization_id: organization_id,
+      contribution_definition_id: contribution_definition_id
+    }
+  end
+
+  let(:record) do
+    {
+      '@type' => 'ContributedAsset',
+      'id' => asset_id,
+      'title' => 'Bob',
+      'assetCategory' => 'DEVICE',
+      'assetType' => 'SENSOR',
+      'assetSubType' => 'ENVIRONMENTAL',
+      'lastModifiedDate' => CONFIG.timestamp,
+      'links' => []
+    }
+  end
+
+  inherits_from MyJohnDeereApi::Request::Update::Base
+
+  describe '#initialize(access_token, item, attributes)' do
+    it 'accepts an accessor, item and attributes' do
+      assert_equal accessor, object.accessor
+      assert_equal item, object.item
+      assert_equal item.attributes.merge(attributes), object.attributes
+    end
+
+    it 'includes validation' do
+      [:validate!, :valid?].each do |method_name|
+        assert object.respond_to?(method_name)
+      end
+    end
+  end
+
+  describe '#resource' do
+    it 'is /assets/<asset_id>' do
+      assert_equal "/assets/#{asset_id}", object.send(:resource)
+    end
+  end
+
+  describe '#headers' do
+    it 'sets the accept and content-type headers' do
+      object = JD::Request::Update::Asset.new(accessor, item, attributes)
+      headers = object.send(:headers)
+
+      expected = 'application/vnd.deere.axiom.v3+json'
+
+      assert_kind_of Hash, headers
+      assert_equal expected, headers['Accept']
+      assert_equal expected, headers['Content-Type']
+    end
+  end
+
+  describe '#request_body' do
+    it 'properly forms the request body' do
+      body = object.send(:request_body)
+
+      assert_equal item.attributes[:title], body[:title]
+      assert_equal item.attributes[:asset_category], body[:assetCategory]
+      assert_equal item.attributes[:asset_type], body[:assetType]
+      assert_equal item.attributes[:asset_sub_type], body[:assetSubType]
+
+      assert_kind_of Array, body[:links]
+      assert_equal 1, body[:links].size
+
+      assert_kind_of Hash, body[:links].first
+      assert_equal 'Link', body[:links].first['@type']
+      assert_equal 'contributionDefinition', body[:links].first['rel']
+      assert_equal  "#{base_url}/contributionDefinitions/#{contribution_definition_id}",
+                    body[:links].first['uri']
+    end
+  end
+
+  describe '#request' do
+    it 'makes the request' do
+      VCR.use_cassette('put_asset') { object.request }
+
+      assert_kind_of Net::HTTPNoContent, object.response
+    end
+  end
 end

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

@@ -2,23 +2,44 @@ require 'support/helper'
 require 'yaml'
 require 'json'
 
+class UpdateBaseItem
+  attr_reader :attributes
+
+  def initialize
+    @attributes = {
+      name: 'Bob',
+      age: 21
+    }
+  end
+end
+
 describe 'MyJohnDeereApi::Request::Update::Base' do
   let(:object) { JD::Request::Update::Base.new(accessor, item, attributes) }
-  let(:item) { 'item' }
+  let(:item) { UpdateBaseItem.new }
   let(:attributes) { {} }
 
   describe '#initialize(access_token, item, attributes)' do
     it 'accepts an accessor, item and attributes' do
-      object = JD::Request::Update::Base.new(accessor, item, attributes)
-
       assert_equal accessor, object.accessor
       assert_equal item, object.item
-      assert_equal attributes, object.attributes
     end
 
-    it 'creates an empty error hash' do
-      object = JD::Request::Update::Base.new(accessor, item, {})
-      assert_equal({}, object.errors)
+    describe 'when a new attribute (ie, name) is passed in' do
+      let(:attributes) { {name: 'John'} }
+
+      it 'merges name with item attributes' do
+        assert_equal attributes[:name], object.attributes[:name]
+        assert_equal item.attributes[:age], object.attributes[:age]
+      end
+    end
+
+    describe 'when a new attribute (ie, age) is passed in' do
+      let(:attributes) { {age: 99} }
+
+      it 'merges name with item attributes' do
+        assert_equal item.attributes[:name], object.attributes[:name]
+        assert_equal attributes[:age], object.attributes[:age]
+      end
     end
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: my_john_deere_api
 version: !ruby/object:Gem::Version
-  version: 1.3.5
+  version: 1.3.6
 platform: ruby
 authors:
 - Jaime Bellmyer
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-02-13 00:00:00.000000000 Z
+date: 2020-02-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: vcr