my_john_deere_api 2.4.1

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

@@ -0,0 +1,93 @@
+require 'support/helper'
+
+class AssetValidatorTest
+  include JD::Validators::Asset
+
+  attr_reader :attributes
+
+  def initialize(attributes)
+    @attributes = attributes
+  end
+end
+
+describe 'MyJohnDeereApi::Validators::Asset' do
+  let(:klass) { AssetValidatorTest }
+  let(:object) { klass.new(attributes) }
+  let(:attributes) { valid_attributes }
+
+  let(:valid_attributes) do
+    {
+      organization_id: '000000',
+      title: "Bob's Stuff"
+    }
+  end
+
+  it 'exists' do
+    assert JD::Validators::Asset
+  end
+
+  it 'inherits from MyJohnDeereApi::Validators::Base' do
+    [:validate!, :valid?].each{ |method_name| assert object.respond_to?(method_name) }
+  end
+
+  it 'requires several attributes' do
+    [:organization_id, :title].each do |attr|
+      object = klass.new(valid_attributes.merge(attr => nil))
+
+      refute object.valid?
+      exception = assert_raises(JD::InvalidRecordError) { object.validate! }
+
+      assert_includes exception.message, "#{attr} is required"
+      assert_includes object.errors[attr], 'is required'
+    end
+  end
+
+  it 'requires a valid combination of category/type/subtype' do
+    valid_combos = [
+      ['DEVICE', 'SENSOR', 'ENVIRONMENTAL'],
+      ['DEVICE', 'SENSOR', 'GRAIN_BIN'],
+      ['DEVICE', 'SENSOR', 'IRRIGATION_PIVOT'],
+      ['DEVICE', 'SENSOR', 'OTHER'],
+      ['EQUIPMENT', 'MACHINE', 'PICKUP_TRUCK'],
+      ['EQUIPMENT', 'MACHINE', 'UTILITY_VEHICLE'],
+      ['EQUIPMENT', 'OTHER', 'ANHYDROUS_AMMONIA_TANK'],
+      ['EQUIPMENT', 'OTHER', 'NURSE_TRUCK'],
+      ['EQUIPMENT', 'OTHER', 'NURSE_WAGON'],
+      ['EQUIPMENT', 'OTHER', 'TECHNICIAN_TRUCK']
+    ]
+
+    error_message = 'requires valid combination of category/type/subtype'
+
+    # cycle through all possible permutations, only proving valid if
+    # listed above
+
+    ['DEVICE', 'EQUIPMENT', 'RANDOM_INVALID'].each do |category|
+      ['MACHINE', 'OTHER', 'SENSOR', 'RANDOM_INVALID'].each do |type|
+        [
+          'ANHYDROUS_AMMONIA_TANK', 'ENVIRONMENTAL', 'GRAIN_BIN',
+          'IRRIGATION_PIVOT', 'NURSE_TRUCK', 'NURSE_WAGON',
+          'OTHER', 'PICKUP_TRUCK', 'TECHNICIAN_TRUCK',
+          'UTILITY_VEHICLE', 'RANDOM_INVALID'
+        ].each do |subtype|
+          categories = {
+            asset_category: category,
+            asset_type: type,
+            asset_sub_type: subtype
+          }
+
+          object = klass.new(valid_attributes.merge(categories))
+
+          if valid_combos.include?([category, type, subtype])
+            assert object.valid?
+          else
+            refute object.valid?
+            exception = assert_raises(JD::InvalidRecordError) { object.validate! }
+
+            assert_includes exception.message, "asset_category #{error_message}"
+            assert_includes object.errors[:asset_category], error_message
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,92 @@
+require 'support/helper'
+
+module BaseValidatorTest
+  class Base
+    include JD::Validators::Base
+
+    attr_reader :attributes
+
+    def initialize(attributes)
+      @attributes = attributes
+    end
+  end
+
+  class Vanilla < Base
+  end
+
+  class WithRequiredAttributes < Base
+    def required_attributes
+      [:name]
+    end
+  end
+
+  class WithCustomValidations < Base
+    def validate_attributes
+      errors[:name] = 'is not Bob' unless attributes[:name] == 'Bob'
+    end
+  end
+end
+
+describe 'MyJohnDeereApi::Validators::Base' do
+  let(:klass) { BaseValidatorTest::Vanilla }
+  let(:object) { klass.new(attributes) }
+  let(:valid_attributes) { {name: 'Bob'} }
+  let(:attributes) { valid_attributes }
+
+  it 'exists' do
+    assert klass
+  end
+
+  describe '#validate!' do
+    it 'returns true when valid' do
+      assert object.validate!
+    end
+  end
+
+  describe 'with required attributes' do
+    let(:klass) { BaseValidatorTest::WithRequiredAttributes }
+
+    it 'returns true when valid' do
+      assert object.validate!
+    end
+
+    describe 'without required attribute' do
+      let(:attributes) { {} }
+
+      it 'raises an error' do
+        exception = assert_raises(JD::InvalidRecordError) { object.validate! }
+
+        assert_includes exception.message, 'name is required'
+        assert_includes object.errors[:name], 'is required'
+      end
+
+      describe 'with unrequired attributes' do
+        let(:attributes) { valid_attributes.merge(age: 101) }
+
+        it 'returns true' do
+          assert object.validate!
+        end
+      end
+    end
+  end
+
+  describe 'custom validations' do
+    let(:klass) { BaseValidatorTest::WithCustomValidations }
+    let(:attributes) { valid_attributes.merge(name: 'Bob') }
+
+    it 'returns true when valid' do
+      assert object.validate!
+    end
+
+    describe 'when custom validation fails' do
+      let(:attributes) { valid_attributes.merge(name: 'Turtles') }
+
+      it 'raises an error' do
+        exception = assert_raises(JD::InvalidRecordError) { object.validate! }
+
+        assert_includes exception.message, 'name is not Bob'
+        assert_includes object.errors[:name], 'is not Bob'
+      end
+    end
+  end
+end

data/test/lib/my_john_deere_api/validators_test.rb

@@ -0,0 +1,17 @@
+require 'support/helper'
+
+describe 'MyJohnDeereApi::Validators' do
+  describe 'loading dependencies' do
+    it 'loads Validators::Base' do
+      assert JD::Validators::Base
+    end
+
+    it 'loads Validators::Asset' do
+      assert JD::Validators::Asset
+    end
+
+    it 'loads Validators::AssetLocation' do
+      assert JD::Validators::AssetLocation
+    end
+  end
+end

data/test/lib/my_john_deere_api/version_test.rb

@@ -0,0 +1,9 @@
+require 'support/helper'
+
+class VersionTest < MiniTest::Test
+  describe 'VERSION' do
+    it 'conforms to the semantic version format' do
+      assert_match(/^\d+\.\d+\.\d+$/, MyJohnDeereApi::VERSION)
+    end
+  end
+end

data/test/my_john_deere_api_test.rb

@@ -0,0 +1,37 @@
+require 'support/helper'
+
+class MyJohnDeereApiTest < MiniTest::Test
+  describe 'loading dependencies' do
+    it 'loads VERSION' do
+      assert JD::VERSION
+    end
+
+    it 'loads Authorize' do
+      assert JD::Authorize
+    end
+
+    it 'loads Client' do
+      assert JD::Client
+    end
+
+    it 'loads Consumer' do
+      assert JD::Consumer
+    end
+
+    it 'loads Request' do
+      assert JD::Request
+    end
+
+    it 'loads Model' do
+      assert JD::Model
+    end
+
+    it 'loads Helpers' do
+      assert JD::Helpers
+    end
+
+    it 'loads Validators' do
+      assert JD::Validators
+    end
+  end
+end

data/test/support/helper.rb

@@ -0,0 +1,97 @@
+require 'rubygems'
+require 'webmock'
+require 'dotenv/load'
+require 'minitest/autorun'
+require 'minitest/reporters'
+require 'my_john_deere_api'
+require 'mocha/minitest'
+
+require 'support/vcr_setup'
+
+Minitest::Reporters.use! [Minitest::Reporters::DefaultReporter.new(:color => true)]
+
+# shortcut for long module name
+JD = MyJohnDeereApi
+
+TOKEN_PATTERN = /^[0-9a-z\-]+$/
+SECRET_PATTERN = /^[0-9A-Za-z\-+=\/]+$/
+
+CONFIG = VcrSetup.new
+
+class Minitest::Spec
+  class << self
+    def inherits_from klass
+      it "inherits from #{klass}" do
+        public_methods = Hash.new([]).merge({
+          JD::Request::Create::Base => [:request, :object, :valid?, :validate!],
+          JD::Request::Collection::Base => [:each, :all, :count],
+        })
+
+        assert_kind_of klass, object
+
+        public_methods[klass].each do |method_name|
+          assert object.respond_to?(method_name)
+        end
+      end
+    end
+  end
+
+  # Helpers from CONFIG
+
+  def client
+    @_client ||= CONFIG.client
+  end
+
+  def accessor
+    @_accessor ||= VCR.use_cassette('catalog') { client.accessor }
+  end
+
+  def base_url
+    @base_url ||= accessor.consumer.site
+  end
+
+  def api_key
+    CONFIG.api_key
+  end
+
+  def api_secret
+    CONFIG.api_secret
+  end
+
+  def access_token
+    CONFIG.access_token
+  end
+
+  def access_secret
+    CONFIG.access_secret
+  end
+
+  def contribution_product_id
+    CONFIG.contribution_product_id
+  end
+
+  def contribution_definition_id
+    CONFIG.contribution_definition_id
+  end
+
+  def organization_id
+    CONFIG.organization_id
+  end
+
+  def asset_id
+    CONFIG.asset_id
+  end
+
+  def field_id
+    CONFIG.field_id
+  end
+
+  def verify_code
+    CONFIG.verify_code
+  end
+
+  # pre-load the accessor so the info is available in all specs without
+  # a special call to accessor
+  before { accessor }
+end
+

data/test/support/vcr/accessor/delete_failed.yml

@@ -0,0 +1,327 @@
+---
+http_interactions:
+- request:
+    method: delete
+    uri: https://sandboxapi.deere.com/platform/assets/00000000-0000-0000-0000-000000000000
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - application/vnd.deere.axiom.v3+json
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      User-Agent:
+      - OAuth gem v0.5.4
+      Authorization:
+      - OAuth oauth_consumer_key="johndeere-0000000000000000000000000000000000000000",
+        oauth_nonce="000000000000000000000000000000000000000000", oauth_signature="0000000000000000000000000000",
+        oauth_signature_method="HMAC-SHA1", oauth_timestamp="1581334172", oauth_token="00000000-0000-0000-0000-000000000000",
+        oauth_version="1.0"
+  response:
+    status:
+      code: 429
+      message: Too Many Requests
+    headers:
+      Date:
+      - Mon, 10 Feb 2020 17:29:36 GMT
+      X-Deere-Handling-Server:
+      - ip-10-214-45-99
+      X-Frame-Options:
+      - SAMEORIGIN
+      X-Deere-Elapsed-Ms:
+      - '96'
+    body:
+      encoding: UTF-8
+      string: ''
+    http_version: 
+  recorded_at: Mon, 10 Feb 2020 17:29:36 GMT
+- request:
+    method: delete
+    uri: https://sandboxapi.deere.com/platform/assets/00000000-0000-0000-0000-000000000000
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - application/vnd.deere.axiom.v3+json
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      User-Agent:
+      - OAuth gem v0.5.4
+      Authorization:
+      - OAuth oauth_consumer_key="johndeere-0000000000000000000000000000000000000000",
+        oauth_nonce="000000000000000000000000000000000000000000", oauth_signature="0000000000000000000000000000",
+        oauth_signature_method="HMAC-SHA1", oauth_timestamp="1581334172", oauth_token="00000000-0000-0000-0000-000000000000",
+        oauth_version="1.0"
+  response:
+    status:
+      code: 429
+      message: Too Many Requests
+    headers:
+      Date:
+      - Mon, 10 Feb 2020 17:29:36 GMT
+      X-Deere-Handling-Server:
+      - ip-10-214-45-99
+      X-Frame-Options:
+      - SAMEORIGIN
+      X-Deere-Elapsed-Ms:
+      - '96'
+    body:
+      encoding: UTF-8
+      string: ''
+    http_version: 
+  recorded_at: Mon, 10 Feb 2020 17:29:36 GMT
+- request:
+    method: delete
+    uri: https://sandboxapi.deere.com/platform/assets/00000000-0000-0000-0000-000000000000
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - application/vnd.deere.axiom.v3+json
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      User-Agent:
+      - OAuth gem v0.5.4
+      Authorization:
+      - OAuth oauth_consumer_key="johndeere-0000000000000000000000000000000000000000",
+        oauth_nonce="000000000000000000000000000000000000000000", oauth_signature="0000000000000000000000000000",
+        oauth_signature_method="HMAC-SHA1", oauth_timestamp="1581334172", oauth_token="00000000-0000-0000-0000-000000000000",
+        oauth_version="1.0"
+  response:
+    status:
+      code: 503
+      message: Service Unavailable
+    headers:
+      Date:
+      - Mon, 10 Feb 2020 17:29:36 GMT
+      X-Deere-Handling-Server:
+      - ip-10-214-45-99
+      X-Frame-Options:
+      - SAMEORIGIN
+      X-Deere-Elapsed-Ms:
+      - '96'
+    body:
+      encoding: UTF-8
+      string: ''
+    http_version: 
+  recorded_at: Mon, 10 Feb 2020 17:29:36 GMT
+- request:
+    method: delete
+    uri: https://sandboxapi.deere.com/platform/assets/00000000-0000-0000-0000-000000000000
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - application/vnd.deere.axiom.v3+json
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      User-Agent:
+      - OAuth gem v0.5.4
+      Authorization:
+      - OAuth oauth_consumer_key="johndeere-0000000000000000000000000000000000000000",
+        oauth_nonce="000000000000000000000000000000000000000000", oauth_signature="0000000000000000000000000000",
+        oauth_signature_method="HMAC-SHA1", oauth_timestamp="1581334172", oauth_token="00000000-0000-0000-0000-000000000000",
+        oauth_version="1.0"
+  response:
+    status:
+      code: 503
+      message: Service Unavailable
+    headers:
+      Date:
+      - Mon, 10 Feb 2020 17:29:36 GMT
+      X-Deere-Handling-Server:
+      - ip-10-214-45-99
+      X-Frame-Options:
+      - SAMEORIGIN
+      X-Deere-Elapsed-Ms:
+      - '96'
+    body:
+      encoding: UTF-8
+      string: ''
+    http_version: 
+  recorded_at: Mon, 10 Feb 2020 17:29:36 GMT
+- request:
+    method: delete
+    uri: https://sandboxapi.deere.com/platform/assets/00000000-0000-0000-0000-000000000000
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - application/vnd.deere.axiom.v3+json
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      User-Agent:
+      - OAuth gem v0.5.4
+      Authorization:
+      - OAuth oauth_consumer_key="johndeere-0000000000000000000000000000000000000000",
+        oauth_nonce="000000000000000000000000000000000000000000", oauth_signature="0000000000000000000000000000",
+        oauth_signature_method="HMAC-SHA1", oauth_timestamp="1581334172", oauth_token="00000000-0000-0000-0000-000000000000",
+        oauth_version="1.0"
+  response:
+    status:
+      code: 429
+      message: Too Many Requests
+    headers:
+      Date:
+      - Mon, 10 Feb 2020 17:29:36 GMT
+      X-Deere-Handling-Server:
+      - ip-10-214-45-99
+      X-Frame-Options:
+      - SAMEORIGIN
+      X-Deere-Elapsed-Ms:
+      - '96'
+    body:
+      encoding: UTF-8
+      string: ''
+    http_version: 
+  recorded_at: Mon, 10 Feb 2020 17:29:36 GMT
+- request:
+    method: delete
+    uri: https://sandboxapi.deere.com/platform/assets/00000000-0000-0000-0000-000000000000
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - application/vnd.deere.axiom.v3+json
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      User-Agent:
+      - OAuth gem v0.5.4
+      Authorization:
+      - OAuth oauth_consumer_key="johndeere-0000000000000000000000000000000000000000",
+        oauth_nonce="000000000000000000000000000000000000000000", oauth_signature="0000000000000000000000000000",
+        oauth_signature_method="HMAC-SHA1", oauth_timestamp="1581334172", oauth_token="00000000-0000-0000-0000-000000000000",
+        oauth_version="1.0"
+  response:
+    status:
+      code: 429
+      message: Too Many Requests
+    headers:
+      Date:
+      - Mon, 10 Feb 2020 17:29:36 GMT
+      X-Deere-Handling-Server:
+      - ip-10-214-45-99
+      X-Frame-Options:
+      - SAMEORIGIN
+      X-Deere-Elapsed-Ms:
+      - '96'
+    body:
+      encoding: UTF-8
+      string: ''
+    http_version: 
+  recorded_at: Mon, 10 Feb 2020 17:29:36 GMT
+- request:
+    method: delete
+    uri: https://sandboxapi.deere.com/platform/assets/00000000-0000-0000-0000-000000000000
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - application/vnd.deere.axiom.v3+json
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      User-Agent:
+      - OAuth gem v0.5.4
+      Authorization:
+      - OAuth oauth_consumer_key="johndeere-0000000000000000000000000000000000000000",
+        oauth_nonce="000000000000000000000000000000000000000000", oauth_signature="0000000000000000000000000000",
+        oauth_signature_method="HMAC-SHA1", oauth_timestamp="1581334172", oauth_token="00000000-0000-0000-0000-000000000000",
+        oauth_version="1.0"
+  response:
+    status:
+      code: 503
+      message: Service Unavailable
+    headers:
+      Date:
+      - Mon, 10 Feb 2020 17:29:36 GMT
+      X-Deere-Handling-Server:
+      - ip-10-214-45-99
+      X-Frame-Options:
+      - SAMEORIGIN
+      X-Deere-Elapsed-Ms:
+      - '96'
+    body:
+      encoding: UTF-8
+      string: ''
+    http_version: 
+  recorded_at: Mon, 10 Feb 2020 17:29:36 GMT
+- request:
+    method: delete
+    uri: https://sandboxapi.deere.com/platform/assets/00000000-0000-0000-0000-000000000000
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - application/vnd.deere.axiom.v3+json
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      User-Agent:
+      - OAuth gem v0.5.4
+      Authorization:
+      - OAuth oauth_consumer_key="johndeere-0000000000000000000000000000000000000000",
+        oauth_nonce="000000000000000000000000000000000000000000", oauth_signature="0000000000000000000000000000",
+        oauth_signature_method="HMAC-SHA1", oauth_timestamp="1581334172", oauth_token="00000000-0000-0000-0000-000000000000",
+        oauth_version="1.0"
+  response:
+    status:
+      code: 503
+      message: Service Unavailable
+    headers:
+      Date:
+      - Mon, 10 Feb 2020 17:29:36 GMT
+      X-Deere-Handling-Server:
+      - ip-10-214-45-99
+      X-Frame-Options:
+      - SAMEORIGIN
+      X-Deere-Elapsed-Ms:
+      - '96'
+    body:
+      encoding: UTF-8
+      string: ''
+    http_version: 
+  recorded_at: Mon, 10 Feb 2020 17:29:36 GMT
+- request:
+    method: delete
+    uri: https://sandboxapi.deere.com/platform/assets/00000000-0000-0000-0000-000000000000
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - application/vnd.deere.axiom.v3+json
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      User-Agent:
+      - OAuth gem v0.5.4
+      Authorization:
+      - OAuth oauth_consumer_key="johndeere-0000000000000000000000000000000000000000",
+        oauth_nonce="000000000000000000000000000000000000000000", oauth_signature="0000000000000000000000000000",
+        oauth_signature_method="HMAC-SHA1", oauth_timestamp="1581334172", oauth_token="00000000-0000-0000-0000-000000000000",
+        oauth_version="1.0"
+  response:
+    status:
+      code: 204
+      message: No Content
+    headers:
+      Date:
+      - Mon, 10 Feb 2020 17:29:36 GMT
+      X-Deere-Handling-Server:
+      - ip-10-214-45-99
+      X-Frame-Options:
+      - SAMEORIGIN
+      X-Deere-Elapsed-Ms:
+      - '96'
+    body:
+      encoding: UTF-8
+      string: ''
+    http_version: 
+  recorded_at: Mon, 10 Feb 2020 17:29:36 GMT
+recorded_with: VCR 5.0.0