my_john_deere_api 2.4.1

data/test/lib/my_john_deere_api/helpers_test.rb

@@ -0,0 +1,21 @@
+require 'support/helper'
+
+describe 'MyJohnDeereApi::Helpers' do
+  describe 'loading dependencies' do
+    it 'loads Helpers::UriHelpers' do
+      assert JD::Helpers::UriHelpers
+    end
+
+    it 'loads Helpers::CaseConversion' do
+      assert JD::Helpers::CaseConversion
+    end
+
+    it 'loads Helpers::EnvironmentHelper' do
+      assert JD::Helpers::EnvironmentHelper
+    end
+
+    it 'loads Helpers::ValidateContributionDefinition' do
+      assert JD::Helpers::ValidateContributionDefinition
+    end
+  end
+end

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

@@ -0,0 +1,38 @@
+require 'support/helper'
+require 'json'
+
+describe 'MyJohnDeereApi::Model::AssetLocation' do
+  let(:klass) { JD::Model::AssetLocation }
+
+  let(:record) do
+    {
+      '@type' => 'ContributedAssetLocation',
+      'timestamp' => CONFIG.timestamp,
+      'geometry' => CONFIG.geometry.to_json,
+      'measurementData' => CONFIG.measurement_data,
+      'links' => []
+    }
+  end
+
+  describe '#initialize' do
+    def link_for label
+      record['links'].detect{|link| link['rel'] == label}['uri'].gsub('https://sandboxapi.deere.com/platform', '')
+    end
+
+    it 'sets the attributes from the given record' do
+      location = klass.new(client, record)
+
+      assert_equal client, location.client
+      assert_equal accessor, location.accessor
+
+      # basic attributes
+      assert_equal record['timestamp'], location.timestamp
+      assert_equal JSON.parse(record['geometry']), location.geometry
+      assert_equal record['measurementData'], location.measurement_data
+
+      # links to other things
+      assert_kind_of Hash, location.links
+      assert_equal 0, location.links.size
+    end
+  end
+end

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

@@ -0,0 +1,133 @@
+require 'support/helper'
+
+describe 'MyJohnDeereApi::Model::Asset' do
+  let(:klass) { JD::Model::Asset }
+
+  let(:record) do
+    {
+      "@type"=>"ContributedAsset",
+      "title"=>"Happy Device",
+      "assetCategory"=>"DEVICE",
+      "assetType"=>"SENSOR",
+      "assetSubType"=>"OTHER",
+      "id"=>asset_id,
+      "lastModifiedDate"=>"2018-01-31T20:36:16.727Z",
+      "links"=>[
+        {"@type"=>"Link", "rel"=>"self", "uri"=>"https://sandboxapi.deere.com/platform/assets/#{asset_id}"},
+        {"@type"=>"Link", "rel"=>"organization", "uri"=>"https://sandboxapi.deere.com/platform/organizations/#{organization_id}"},
+        {"@type"=>"Link", "rel"=>"locations", "uri"=>"https://sandboxapi.deere.com/platform/assets/#{asset_id}/locations"},
+      ]
+    }
+  end
+
+  describe '#initialize' do
+    def link_for label
+      record['links'].detect{|link| link['rel'] == label}['uri'].gsub('https://sandboxapi.deere.com/platform', '')
+    end
+
+    it 'sets the attributes from the given record' do
+      asset = klass.new(client, record)
+
+      assert_equal client, asset.client
+      assert_equal accessor, asset.accessor
+
+      # basic attributes
+      assert_equal record['id'], asset.id
+      assert_equal record['title'], asset.title
+      assert_equal record['assetCategory'], asset.asset_category
+      assert_equal record['assetType'], asset.asset_type
+      assert_equal record['assetSubType'], asset.asset_sub_type
+      assert_equal record['lastModifiedDate'], asset.last_modified_date
+
+      # links to other things
+      assert_kind_of Hash, asset.links
+
+      ['self', 'organization', 'locations'].each do |association|
+        assert_equal link_for(association), asset.links[association]
+      end
+    end
+  end
+
+  describe '#attributes' do
+    it 'converts properties back to an attributes hash' do
+      asset = klass.new(client, 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 '#save' do
+    it 'sends any recent updates to John Deere' do
+      asset = klass.new(client, record)
+      new_title = 'i REALLY like turtles!'
+
+      asset.title = new_title
+      assert_equal new_title, asset.title
+
+      response = VCR.use_cassette('put_asset') { asset.save }
+      assert_kind_of Net::HTTPNoContent, response
+    end
+
+    it 'does not make a JD request if nothing has changed' do
+      asset = klass.new(client, record)
+      response = asset.save
+
+      assert_nil response
+    end
+
+    it 'marks the record as saved' do
+      asset = klass.new(client, record)
+      asset.title = 'i REALLY like turtles!'
+
+      response = VCR.use_cassette('put_asset') { asset.save }
+      assert_kind_of Net::HTTPNoContent, response
+
+      response = asset.save
+      assert_nil response
+    end
+  end
+
+  describe '#update' do
+    it 'updates the attributes' do
+      asset = klass.new(client, record)
+
+      new_title = 'i REALLY like turtles!'
+      VCR.use_cassette('put_asset') { asset.update(title: new_title) }
+
+      assert_equal new_title, asset.title
+      assert_equal new_title, asset.attributes[:title]
+    end
+
+    it 'sends the update to John Deere' do
+      asset = klass.new(client, record)
+
+      new_title = 'i REALLY like turtles!'
+      response = VCR.use_cassette('put_asset') { asset.update(title: new_title) }
+
+      assert_kind_of Net::HTTPNoContent, response
+    end
+  end
+
+  describe '#locations' do
+    it 'returns a collection of locations for this asset' do
+      organization = VCR.use_cassette('get_organizations') { client.organizations.first }
+      asset = VCR.use_cassette('get_assets') { organization.assets.first }
+
+      locations = VCR.use_cassette('get_asset_locations') do
+        asset.locations.all
+        asset.locations
+      end
+
+      assert_kind_of Array, locations.all
+
+      locations.each do |location|
+        assert_kind_of JD::Model::AssetLocation, location
+      end
+    end
+  end
+end

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

@@ -0,0 +1,76 @@
+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(:klass) { JD::Model::Base }
+  let(:object) { klass.new(client, record) }
+
+  let(:record) do
+    {
+      '@type'=>'Base',
+      'id'=>'123',
+      'somefield'=>'somevalue',
+      "links"=>[
+        {"@type"=>"Link", "rel"=>"self", "uri"=>"https://sandboxapi.deere.com/platform/assets/#{asset_id}"},
+        {"@type"=>"Link", "rel"=>"organization", "uri"=>"https://sandboxapi.deere.com/platform/organizations/#{organization_id}"},
+        {"@type"=>"Link", "rel"=>"locations", "uri"=>"https://sandboxapi.deere.com/platform/assets/#{asset_id}/locations"},
+      ]
+    }
+  end
+
+  it 'includes UriHelpers' do
+    assert_includes object.private_methods, :uri_path
+    assert_includes object.private_methods, :id_from_uri
+  end
+
+  describe '#initialize(client, record)' do
+    def link_for label
+      record['links'].detect{|link| link['rel'] == label}['uri'].gsub('https://sandboxapi.deere.com/platform', '')
+    end
+
+    describe 'when the wrong record type is passed' do
+      let(:record) do
+        {
+          '@type'=>'WrongType',
+          'links'=>[]
+        }
+      end
+
+      it 'raises a TypeMismatch error' do
+        exception = assert_raises(JD::TypeMismatchError) { object }
+        assert_equal "Expected record of type 'Base', but received type 'WrongType'", exception.message
+      end
+    end
+
+    it 'sets the base attributes' do
+      assert_equal client, object.client
+      assert_equal accessor, object.accessor
+
+      assert_equal record['id'], object.id
+      assert_equal record['@type'], object.record_type
+      assert_equal client, object.client
+    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(client, record)
+      assert_equal 'somevalue', object.somefield
+    end
+  end
+end

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

@@ -0,0 +1,52 @@
+require 'support/helper'
+
+describe 'MyJohnDeereApi::Model::ContributionDefinition' do
+  let(:klass) { JD::Model::ContributionDefinition }
+
+  let(:record) do
+    {
+      "@type" => "ContributionDefinition",
+      "name" => "Definition Name",
+      "actionDefinitions" => [],
+      "id" => "00000000-0000-0000-0000-000000000000",
+      "links" => [
+        {
+          "@type" => "Link",
+          "rel" => "self",
+          "uri" => "https://sandboxapi.deere.com/platform/contributionDefinitions/00000000-0000-0000-0000-000000000000"
+        },
+        {
+          "@type" => "Link",
+          "rel" => "contributionProduct",
+          "uri" => "https://sandboxapi.deere.com/platform/contributionProducts/00000000-0000-0000-0000-000000000000"
+        }
+      ]
+    }
+  end
+
+  describe '#initialize' do
+    def link_for label
+      camel_label = label.gsub(/_(.)/){|m| m[1].upcase}
+      record['links'].detect{|link| link['rel'] == camel_label}['uri'].gsub('https://sandboxapi.deere.com/platform', '')
+    end
+
+    it 'sets the attributes from the given record' do
+      definition = klass.new(client, record)
+
+      assert_equal client, definition.client
+      assert_equal accessor, definition.accessor
+
+      # basic attributes
+      assert_equal record['id'], definition.id
+      assert_equal record['name'], definition.name
+    end
+
+    it 'links to other things' do
+      product = klass.new(client, record)
+
+      ['self', 'contribution_product'].each do |association|
+        assert_equal link_for(association), product.links[association]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,82 @@
+require 'support/helper'
+
+describe 'MyJohnDeereApi::Model::ContributionProduct' do
+  let(:klass) { JD::Model::ContributionProduct }
+
+  let(:record) do
+    {
+      "@type" => "ContributionProduct",
+      "marketPlaceName" => "SpiffyApp",
+      "marketPlaceDescription" => "SpiffyApp",
+      "marketPlaceLogo" => "https://example.com/logo.png",
+      "defaultLocale" => "en-us",
+      "currentStatus" => "APPROVED",
+      "activationCallback" => "https://example.com/activation_callback",
+      "previewImages" => ["https://example.com/preview.png"],
+      "supportedRegions" => ["US"],
+      "supportedOperationCenters" => ["something"],
+      "id" => "#{contribution_product_id}",
+      "links" => [
+        {
+          "@type" => "Link",
+          "rel" => "self",
+          "uri" => "https://sandboxapi.deere.com/platform/contributionProducts/#{contribution_product_id}"
+        },
+        {
+          "@type" => "Link",
+          "rel" => "contributionDefinition",
+          "uri" => "https://sandboxapi.deere.com/platform/contributionProducts/#{contribution_product_id}/contributionDefinitions"
+        }
+      ]
+    }
+  end
+
+  describe '#initialize' do
+    def link_for label
+      camel_label = label.gsub(/_(.)/){|m| m[1].upcase}
+      record['links'].detect{|link| link['rel'] == camel_label}['uri'].gsub('https://sandboxapi.deere.com/platform', '')
+    end
+
+    it 'sets the attributes from the given record' do
+      product = klass.new(client, record)
+      
+      assert_equal client, product.client
+      assert_equal accessor, product.accessor
+
+      # basic attributes
+      assert_equal record['id'], product.id
+      assert_equal record['marketPlaceName'], product.market_place_name
+      assert_equal record['marketPlaceDescription'], product.market_place_description
+      assert_equal record['defaultLocale'], product.default_locale
+      assert_equal record['currentStatus'], product.current_status
+      assert_equal record['activationCallback'], product.activation_callback
+      assert_equal record['previewImages'], product.preview_images
+      assert_equal record['supportedRegions'], product.supported_regions
+      assert_equal record['supportedOperationCenters'], product.supported_operation_centers
+    end
+
+    it 'links to other things' do
+      product = klass.new(client, record)
+
+      ['self', 'contribution_definition'].each do |association|
+        assert_equal link_for(association), product.links[association]
+      end
+    end
+  end
+
+  describe '#contribution_definitions' do
+    it 'returns a collection of contribution definitions for this contributon product' do
+      product = klass.new(client, record)
+
+      contribution_definitions = VCR.use_cassette('get_contribution_definitions') do
+        product.contribution_definitions.all; product.contribution_definitions
+      end
+
+      assert_kind_of JD::Request::Collection::ContributionDefinitions, contribution_definitions
+
+      contribution_definitions.each do |contribution_definition|
+        assert_kind_of JD::Model::ContributionDefinition, contribution_definition
+      end
+    end
+  end
+end

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

@@ -0,0 +1,65 @@
+require 'support/helper'
+
+describe 'MyJohnDeereApi::Model::Field' do
+  let(:klass) { JD::Model::Field }
+
+  let(:record) do
+    {
+      "@type"=>"Field",
+      "name"=>"Happy Field",
+      "archived"=>false,
+      "id"=>"123456",
+      "links"=>[
+        {"@type"=>"Link", "rel"=>"self", "uri"=>"https://sandboxapi.deere.com/platform/organizations/#{organization_id}/fields/#{field_id}"},
+        {"@type"=>"Link", "rel"=>"clients", "uri"=>"https://sandboxapi.deere.com/platform/organizations/#{organization_id}/fields/#{field_id}/clients"},
+        {"@type"=>"Link", "rel"=>"notes", "uri"=>"https://sandboxapi.deere.com/platform/organizations/#{organization_id}/fields/#{field_id}/notes"},
+      ]
+    }
+  end
+
+  describe '#initialize' do
+    def link_for label
+      record['links'].detect{|link| link['rel'] == label}['uri'].gsub('https://sandboxapi.deere.com/platform', '')
+    end
+
+    it 'sets the attributes from the given record' do
+      field = klass.new(client, record)
+
+      assert_equal client, field.client
+      assert_equal accessor, field.accessor
+
+      # basic attributes
+      assert_equal record['name'], field.name
+      assert_equal record['archived'], field.archived?
+      assert_equal record['id'], field.id
+
+      # links to other things
+      assert_kind_of Hash, field.links
+
+      ['clients', 'notes'].each do |association|
+        assert_equal link_for(association), field.links[association]
+      end
+    end
+  end
+
+  describe '#flags' do
+    it 'returns a collection of flags for this organization' do
+      organization = VCR.use_cassette('get_organizations') { client.organizations.first }
+      field = VCR.use_cassette('get_fields') { organization.fields.first }
+      flags = VCR.use_cassette('get_flags') { field.flags.all }
+
+      assert_kind_of Array, flags
+
+      flags.each do |flag|
+        assert_kind_of JD::Model::Flag, flag
+      end
+    end
+  end
+
+  describe 'private #organization_id' do
+    it "infers the organization_id from links" do
+      field = klass.new(client, record)
+      assert_equal organization_id, field.send(:organization_id)
+    end
+  end
+end