my_john_deere_api 1.3.6 → 1.3.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a060cb86023a65bf70b80bf717e86c725cb436e13d31d88bbd9148a235ab03c2
-  data.tar.gz: 95198638b33c2402679745aa2c43322af1fe039b446388b1ec800b3f8be451c7
+  metadata.gz: 347239b756637538b1565dac76ef8d922b11fe4d473811b14a9e8f7edf134902
+  data.tar.gz: 670ee3f6c1ad3f8845166f9c82d8f46ad21a1c5faf4f0cd05da6b24ffc3a4fd5
 SHA512:
-  metadata.gz: db67993c3685f8e9a2519fefdc2e790a5d94c6e7accca6c94fc4a6daa9fe4ec6009e9eb23e12adfb987fd437038bd861a9542516a0a9a8e7089dd071ee59b1a6
-  data.tar.gz: 4bc3a3fe87d49f052c87d3f5fa746886a7c9b2edfb7db9972a507334c212d232c9d4091ae2f3c594864050ec5ce8bf9689762a2201ec7d16554dc67e50ec4488
+  metadata.gz: 4ee286908de1b144b7d00687e28025e6d92a9d19bf7468bfbf3e4489a8c0340b69cb92f1177b2738d13ab16e6c6b908f2cfcd57be4e00c03d954a62679dd36a8
+  data.tar.gz: 73308deefd549de1ff76220b14a0a267b2583fe2c2f5216a423091faaff9cebe9ea06cf20b02df63407af3f7a916de9198c21152e92eed60f8812ae10d5e3058

data/lib/my_john_deere_api/client.rb

@@ -34,6 +34,15 @@ module MyJohnDeereApi
       self.environment = options[:environment]
     end
 
+    ##
+    # Returns an oAuth AccessToken object which can be used to make
+    # user-specific API requests
+
+    def accessor
+      return @accessor if defined?(@accessor)
+      @accessor = OAuth::AccessToken.new(consumer.user_get, access_token, access_secret)
+    end
+
     ##
     # generic user-specific GET request method that returns JSON
 
@@ -95,7 +104,7 @@ module MyJohnDeereApi
 
     def organizations
       return @organizations if defined?(@organizations)
-      @organizations = MyJohnDeereApi::Request::Collection::Organizations.new(accessor)
+      @organizations = MyJohnDeereApi::Request::Collection::Organizations.new(self)
     end
 
     ##
@@ -103,7 +112,7 @@ module MyJohnDeereApi
 
     def contribution_products
       return @contribution_products if defined?(@contribution_products)
-      @contribution_products = MyJohnDeereApi::Request::Collection::ContributionProducts.new(accessor)
+      @contribution_products = MyJohnDeereApi::Request::Collection::ContributionProducts.new(self)
     end
 
     private
@@ -116,15 +125,6 @@ module MyJohnDeereApi
       @consumer = MyJohnDeereApi::Consumer.new(@api_key, @api_secret, environment: environment)
     end
 
-    ##
-    # Returns an oAuth AccessToken object which can be used to make
-    # user-specific API requests
-
-    def accessor
-      return @accessor if defined?(@accessor)
-      @accessor = OAuth::AccessToken.new(consumer.user_get, access_token, access_secret)
-    end
-
     def headers
       @headers ||= {accept: 'application/vnd.deere.axiom.v3+json'}
     end

data/lib/my_john_deere_api/model/asset.rb

@@ -22,7 +22,7 @@ module MyJohnDeereApi
       raise AccessTokenError unless accessor
 
       return @locations if defined?(@locations)
-      @locations = MyJohnDeereApi::Request::Collection::AssetLocations.new(accessor, asset: id)
+      @locations = MyJohnDeereApi::Request::Collection::AssetLocations.new(client, asset: id)
     end
 
     private

data/lib/my_john_deere_api/model/base.rb

@@ -3,23 +3,24 @@ module MyJohnDeereApi
     include Helpers::CaseConversion
     include Helpers::UriHelpers
 
-    attr_reader :id, :record_type, :accessor, :links
+    attr_reader :id, :record_type, :client, :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*.
+    # [client] the client, because it contains all the config info.
+    #          The alternative would be a true Config block, but then
+    #          settings would be app-wide. This allows one app to have
+    #          multiple clients with different settings.
 
-    def initialize(record, accessor = nil)
+    def initialize(record, client = nil)
       verify_record_type(record['@type'])
 
       @id = record['id']
       @record_type = record['@type']
-      @accessor = accessor
+      @client = client
 
       map_attributes(record)
 
@@ -30,6 +31,14 @@ module MyJohnDeereApi
       end
     end
 
+    ##
+    # The client accessor
+
+    def accessor
+      return @accessor if defined?(@accessor)
+      @accessor = client&.accessor
+    end
+
     private
 
     ##

data/lib/my_john_deere_api/model/contribution_product.rb

@@ -10,7 +10,7 @@ module MyJohnDeereApi
 
     def contribution_definitions
       return @contribution_definitions if defined?(@contribution_definitions)
-      @contribution_definitions = Request::Collection::ContributionDefinitions.new(accessor, contribution_product: id)
+      @contribution_definitions = Request::Collection::ContributionDefinitions.new(client, contribution_product: id)
     end
 
     private

data/lib/my_john_deere_api/model/field.rb

@@ -17,7 +17,7 @@ module MyJohnDeereApi
       raise AccessTokenError unless accessor
 
       return @flags if defined?(@flags)
-      @flags = Request::Collection::Flags.new(accessor, organization: organization_id, field: id)
+      @flags = Request::Collection::Flags.new(client, organization: organization_id, field: id)
     end
 
     private

data/lib/my_john_deere_api/model/organization.rb

@@ -19,7 +19,7 @@ module MyJohnDeereApi
       raise AccessTokenError unless accessor
 
       return @fields if defined?(@fields)
-      @fields = MyJohnDeereApi::Request::Collection::Fields.new(accessor, organization: id)
+      @fields = MyJohnDeereApi::Request::Collection::Fields.new(client, organization: id)
     end
 
     ##
@@ -29,7 +29,7 @@ module MyJohnDeereApi
       raise AccessTokenError unless accessor
 
       return @assets if defined?(@assets)
-      @assets = MyJohnDeereApi::Request::Collection::Assets.new(accessor, organization: id)
+      @assets = MyJohnDeereApi::Request::Collection::Assets.new(client, organization: id)
     end
 
     private

data/lib/my_john_deere_api/request/collection/asset_locations.rb

@@ -21,7 +21,7 @@ module MyJohnDeereApi::Request
 
     def create(attributes)
       merged_attributes = attributes.merge(asset_id: associations[:asset])
-      Create::AssetLocation.new(accessor, merged_attributes).object
+      Create::AssetLocation.new(client, merged_attributes).object
     end
   end
 end

data/lib/my_john_deere_api/request/collection/assets.rb

@@ -21,14 +21,14 @@ module MyJohnDeereApi::Request
 
     def create(attributes)
       merged_attributes = attributes.merge(organization_id: associations[:organization])
-      Create::Asset.new(accessor, merged_attributes).object
+      Create::Asset.new(client, merged_attributes).object
     end
 
     ##
     # Retrieve an asset from JD
 
     def find(asset_id)
-      Individual::Asset.new(accessor, asset_id).object
+      Individual::Asset.new(client, asset_id).object
     end
   end
 end

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

@@ -3,18 +3,26 @@ module MyJohnDeereApi
     include Enumerable
     include Helpers::UriHelpers
 
-    attr_reader :accessor, :associations
+    attr_reader :client, :associations
 
     ##
-    # accessor is an OAuth::AccessToken object which has the necessary
-    # credentials to make the desired requests.
+    # client is the original client instance which contains
+    # the necessary config info.
 
-    def initialize(accessor, associations = {})
-      @accessor = accessor
+    def initialize(client, associations = {})
+      @client = client
       @associations = associations
       @items = []
     end
 
+    ##
+    # client accessor
+
+    def accessor
+      return @accessor if defined?(@accessor)
+      @accessor = client&.accessor
+    end
+
     ##
     # Iterate lazily through all records in the collection, fetching
     # additional pages as needed.
@@ -46,7 +54,7 @@ module MyJohnDeereApi
     def first_page
       return @first_page if defined?(@first_page)
 
-      @first_page = JSON.parse(@accessor.get(resource, headers).body)
+      @first_page = JSON.parse(accessor.get(resource, headers).body)
       extract_page_contents(@first_page)
 
       @first_page
@@ -55,7 +63,7 @@ module MyJohnDeereApi
     def fetch
       return unless @next_page
 
-      page = JSON.parse(@accessor.get(@next_page, headers).body)
+      page = JSON.parse(accessor.get(@next_page, headers).body)
       extract_page_contents(page)
     end
 
@@ -69,7 +77,7 @@ module MyJohnDeereApi
     end
 
     def add_items_from_page(page)
-      @items += page['values'].map{|record| model.new(record, accessor) }
+      @items += page['values'].map{|record| model.new(record, client) }
     end
 
     def set_next_page(page)

data/lib/my_john_deere_api/request/collection/contribution_definitions.rb

@@ -20,7 +20,7 @@ module MyJohnDeereApi::Request
     # Retrieve an item from JD
 
     def find(item_id)
-      Individual::ContributionDefinition.new(accessor, item_id).object
+      Individual::ContributionDefinition.new(client, item_id).object
     end
   end
 end

data/lib/my_john_deere_api/request/collection/contribution_products.rb

@@ -20,7 +20,7 @@ module MyJohnDeereApi::Request
     # Retrieve an item from JD
 
     def find(item_id)
-      Individual::ContributionProduct.new(accessor, item_id).object
+      Individual::ContributionProduct.new(client, item_id).object
     end
   end
 end

data/lib/my_john_deere_api/request/collection/fields.rb

@@ -20,7 +20,7 @@ module MyJohnDeereApi::Request
     # Retrieve a field from JD
 
     def find(field_id)
-      Individual::Field.new(accessor, field_id, organization: associations[:organization]).object
+      Individual::Field.new(client, field_id, organization: associations[:organization]).object
     end
   end
 end

data/lib/my_john_deere_api/request/collection/organizations.rb

@@ -20,7 +20,7 @@ module MyJohnDeereApi::Request
     # Retrieve an organization from JD
 
     def find(organization_id)
-      Individual::Organization.new(accessor, organization_id).object
+      Individual::Organization.new(client, organization_id).object
     end
   end
 end

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

@@ -2,18 +2,26 @@ require 'json'
 
 module MyJohnDeereApi
   class Request::Create::Base
-    attr_reader :accessor, :attributes, :response
+    attr_reader :client, :attributes, :response
 
     ##
     # Accepts a valid oAuth AccessToken, and a hash of attributes.
 
-    def initialize(accessor, attributes)
-      @accessor = accessor
+    def initialize(client, attributes)
+      @client = client
       @attributes = attributes
 
       process_attributes
     end
 
+    ##
+    # client accessor
+
+    def accessor
+      return @accessor if defined?(@accessor)
+      @accessor = client&.accessor
+    end
+
     ##
     # Make the request, if the instance is valid
 
@@ -31,7 +39,7 @@ module MyJohnDeereApi
 
       request unless response
 
-      @object = model.new(fetch_record, accessor)
+      @object = model.new(fetch_record, client)
     end
 
     ##

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

@@ -2,16 +2,24 @@ require 'json'
 
 module MyJohnDeereApi::Request
   class Individual::Base
-    attr_reader :accessor, :id, :associations, :response
+    attr_reader :client, :id, :associations, :response
 
     ##
-    # Initialize with an accessor, and asset id
+    # Initialize with a client, and asset id
 
-    def initialize(accessor, id, associations = {})
-      @accessor = accessor
+    def initialize(client, id, associations = {})
+      @client = client
       @id = id
       @associations = associations
     end
+    
+    ##
+    # client accessor
+    
+    def accessor
+      return @accessor if defined?(@accessor)
+      @accessor = client&.accessor
+    end
 
     ##
     # The object being requested, an asset in this case
@@ -20,7 +28,7 @@ module MyJohnDeereApi::Request
       return @object if defined?(@object)
 
       request unless response
-      @object = model.new(JSON.parse(response.body), accessor)
+      @object = model.new(JSON.parse(response.body), client)
     end
 
     private

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

@@ -4,7 +4,7 @@ module MyJohnDeereApi
   class Request::Update::Base
     include Validators::Base
 
-    attr_reader :accessor, :item, :attributes, :response
+    attr_reader :client, :item, :attributes, :response
 
     ##
     # Accepts a valid oAuth AccessToken, the item to be updated, 
@@ -12,14 +12,22 @@ module MyJohnDeereApi
     #
     # category/type/subtype must be a recognized combination as defined above.
 
-    def initialize(accessor, item, attributes)
-      @accessor = accessor
+    def initialize(client, item, attributes)
+      @client = client
       @item = item
       @attributes = item.attributes.merge(attributes)
 
       process_attributes
     end
 
+    #
+    # client accessor
+
+    def accessor
+      return @accessor if defined?(@accessor)
+      @accessor = client&.accessor
+    end
+
     ##
     # Make the request, if the instance is valid
 

data/lib/my_john_deere_api/version.rb

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

data/test/lib/my_john_deere_api/client_test.rb

@@ -34,7 +34,6 @@ describe 'MyJohnDeereApi::Client' do
 
   describe '#get' do
     it 'returns the response as a Hash' do
-      VCR.use_cassette('catalog') { client.send(:accessor) }
       response = VCR.use_cassette('get_organizations') { client.get('/organizations') }
 
       assert_kind_of Hash, response
@@ -44,7 +43,6 @@ describe 'MyJohnDeereApi::Client' do
     end
 
     it 'prepends the leading slash if needed' do
-      VCR.use_cassette('catalog') { client.send(:accessor) }
       response = VCR.use_cassette('get_organizations') { client.get('organizations') }
 
       assert_kind_of Hash, response
@@ -54,7 +52,6 @@ describe 'MyJohnDeereApi::Client' do
     end
 
     it 'allows symbols for simple resources' do
-      VCR.use_cassette('catalog') { client.send(:accessor) }
       response = VCR.use_cassette('get_organizations') { client.get(:organizations) }
 
       assert_kind_of Hash, response

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

@@ -2,6 +2,8 @@ require 'support/helper'
 require 'json'
 
 describe 'MyJohnDeereApi::Model::AssetLocation' do
+  let(:klass) { JD::Model::AssetLocation }
+
   let(:record) do
     {
       '@type' => 'ContributedAssetLocation',
@@ -18,7 +20,7 @@ describe 'MyJohnDeereApi::Model::AssetLocation' do
     end
 
     it 'sets the attributes from the given record' do
-      location = JD::Model::AssetLocation.new(record)
+      location = klass.new(record)
 
       assert_nil location.accessor
 
@@ -32,11 +34,9 @@ describe 'MyJohnDeereApi::Model::AssetLocation' do
       assert_equal 0, location.links.size
     end
 
-    it 'accepts an optional accessor' do
-      mock_accessor = 'mock-accessor'
-
-      location = JD::Model::AssetLocation.new(record, mock_accessor)
-      assert_equal mock_accessor, location.accessor
+    it 'accepts an optional client' do
+      location = klass.new(record, client)
+      assert_equal client, location.client
     end
   end
 end

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

@@ -1,6 +1,8 @@
 require 'support/helper'
 
 describe 'MyJohnDeereApi::Model::Asset' do
+  let(:klass) { JD::Model::Asset }
+
   let(:record) do
     {
       "@type"=>"ContributedAsset",
@@ -24,7 +26,7 @@ describe 'MyJohnDeereApi::Model::Asset' do
     end
 
     it 'sets the attributes from the given record' do
-      asset = JD::Model::Asset.new(record)
+      asset = klass.new(record)
 
       assert_nil asset.accessor
 
@@ -44,17 +46,15 @@ describe 'MyJohnDeereApi::Model::Asset' do
       end
     end
 
-    it 'accepts an optional accessor' do
-      mock_accessor = 'mock-accessor'
-
-      asset = JD::Model::Asset.new(record, mock_accessor)
-      assert_equal mock_accessor, asset.accessor
+    it 'accepts an optional client' do
+      asset = klass.new(record, client)
+      assert_equal client, asset.client
     end
   end
 
   describe '#attributes' do
     it 'converts properties back to an attributes hash' do
-      asset = JD::Model::Asset.new(record)
+      asset = klass.new(record)
       attributes = asset.attributes
 
       assert_equal asset.id, attributes[:id]
@@ -67,7 +67,6 @@ describe 'MyJohnDeereApi::Model::Asset' do
 
   describe '#locations' do
     it 'returns a collection of locations for this asset' do
-      accessor
       organization = VCR.use_cassette('get_organizations') { client.organizations.first }
       asset = VCR.use_cassette('get_assets') { organization.assets.first }
 
@@ -84,7 +83,7 @@ describe 'MyJohnDeereApi::Model::Asset' do
     end
 
     it 'raises an exception if an accessor is not available' do
-      asset = JD::Model::Asset.new(record)
+      asset = klass.new(record)
 
       exception = assert_raises(JD::AccessTokenError) { asset.locations }
       assert_includes exception.message, 'Access Token must be supplied'

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

@@ -9,7 +9,8 @@ class SampleModel < JD::Model::Base
 end
 
 describe 'MyJohnDeereApi::Model::Base' do
-  let(:object) { JD::Model::Base.new(record, accessor) }
+  let(:klass) { JD::Model::Base }
+  let(:object) { klass.new(record, client) }
 
   let(:record) do
     {
@@ -29,7 +30,7 @@ describe 'MyJohnDeereApi::Model::Base' do
     assert_includes object.private_methods, :id_from_uri
   end
 
-  describe '#initialize(record, accessor = nil)' do
+  describe '#initialize(record, client)' do
     def link_for label
       record['links'].detect{|link| link['rel'] == label}['uri'].gsub('https://sandboxapi.deere.com/platform', '')
     end
@@ -40,14 +41,14 @@ describe 'MyJohnDeereApi::Model::Base' do
         'links'=>[]
       }
 
-      exception = assert_raises(JD::TypeMismatchError) { JD::Model::Base.new(record) }
+      exception = assert_raises(JD::TypeMismatchError) { klass.new(record) }
       assert_equal "Expected record of type 'Base', but received type 'WrongType'", exception.message
     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
+      assert_equal client, object.client
     end
 
     it 'sets the links' do
@@ -65,9 +66,9 @@ describe 'MyJohnDeereApi::Model::Base' do
       assert_equal 'somevalue', object.somefield
     end
 
-    it 'does not require accessor' do
-      object = JD::Model::Base.new(record)
-      assert_nil object.accessor
+    it 'does not require client' do
+      object = klass.new(record)
+      assert_nil object.client
     end
   end
 end

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

@@ -46,11 +46,9 @@ describe 'MyJohnDeereApi::Model::ContributionDefinition' do
       end
     end
 
-    it 'accepts an optional accessor' do
-      mock_accessor = 'mock-accessor'
-
-      asset = klass.new(record, mock_accessor)
-      assert_equal mock_accessor, asset.accessor
+    it 'accepts an optional client' do
+      asset = klass.new(record, client)
+      assert_equal client, asset.client
     end
   end
 end

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

@@ -1,6 +1,8 @@
 require 'support/helper'
 
 describe 'MyJohnDeereApi::Model::ContributionProduct' do
+  let(:klass) { JD::Model::ContributionProduct }
+
   let(:record) do
     {
       "@type" => "ContributionProduct",
@@ -36,7 +38,7 @@ describe 'MyJohnDeereApi::Model::ContributionProduct' do
     end
 
     it 'sets the attributes from the given record' do
-      product = JD::Model::ContributionProduct.new(record)
+      product = klass.new(record)
 
       # basic attributes
       assert_equal record['id'], product.id
@@ -51,24 +53,22 @@ describe 'MyJohnDeereApi::Model::ContributionProduct' do
     end
 
     it 'links to other things' do
-      product = JD::Model::ContributionProduct.new(record)
+      product = klass.new(record)
 
       ['self', 'contribution_definition'].each do |association|
         assert_equal link_for(association), product.links[association]
       end
     end
 
-    it 'accepts an optional accessor' do
-      mock_accessor = 'mock-accessor'
-
-      asset = JD::Model::ContributionProduct.new(record, mock_accessor)
-      assert_equal mock_accessor, asset.accessor
+    it 'accepts an optional client' do
+      asset = klass.new(record, client)
+      assert_equal client, asset.client
     end
   end
 
   describe '#contribution_definitions' do
     it 'returns a collection of contribution definitions for this contributon product' do
-      product = JD::Model::ContributionProduct.new(record, accessor)
+      product = klass.new(record, client)
 
       contribution_definitions = VCR.use_cassette('get_contribution_definitions') do
         product.contribution_definitions.all; product.contribution_definitions