my_john_deere_api 3.0.0 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b36f05ba98236dbdddfcab7086fa13c6af8d673dc8c2d2c1f185abcbf0f1ceeb
-  data.tar.gz: d5bda4fae253a293fd58b44045eacf2b7eba8dd142560aa3813da3deb334bc7c
+  metadata.gz: ba2b1a3274a3f5ae20bdfeaf13a770db0aa6b5b5cf9a0d87b0894e99a17d2423
+  data.tar.gz: 806bb77756d614db71ebdc06d3ffd68e7ea1a4afc5dac0612444501acafafc22
 SHA512:
-  metadata.gz: 454ac16787a9448ce1fb0d5db1bc4f2b39b9c0c729552fe9c0730093d681dc442fc33b21cdbb8aea79678a1a2e1fd1bdab2ff042b931251818435cbcbd7a54e9
-  data.tar.gz: b90f4aa488daa2e0c99c31ede5045769f6d7cd04fce875d92375b369318845737fc5dbf9d9e4824b048980261e6ccc1880e8b4803a01cd9f0be4299d826cd491
+  metadata.gz: cba9de4b20f90959a9c9c3103515345cad97346fd1515d8d2d6e1aaa5e44e463e9d991724b52d9b7f58f5cee27960e512c0def8715eea00782a5cbaaeb47ef5f
+  data.tar.gz: 81273181c21ecd1ceba98f265f5d7c22f9050e96e036e2899fe1ccaa66a6855ccb1bf190c454920890daca38872359753c828f80f8431b0ee5a8e7b9bdbcc66f

data/lib/my_john_deere_api/authorize.rb

@@ -13,6 +13,25 @@ module MyJohnDeereApi
     #
     # This is used to obtain authentication an access key/secret
     # on behalf of a user.
+    #
+    # parameters:
+    #
+    #     api_key - required JD API key for client application
+    #     api_secret - required JD API secret for client application
+    #     options - options hash, see below for details
+    #
+    # options:
+    #
+    #     :environment - one of [:live, :staging]
+    #     :scope - a space-delimited list of scopes requested
+    #     :scopes - an array of scopes requested. 'offline_access' will be added if
+    #               it isn't included already. This will overwrite :scope option if
+    #               both are provided.
+    #     :state -  a unique identifier for this request. JD will return this when
+    #               it redirects back after authorization, so that the client can identify
+    #               which of its users this request belongs to.
+    #     :redirect_uri - the uri for JD to redirect back to, after authorization.
+
 
     def initialize(api_key, api_secret, options = {})
       @options = DEFAULTS.merge(options)
@@ -62,7 +81,7 @@ module MyJohnDeereApi
       token = oauth_client.auth_code.get_token(code, redirect_uri: options[:redirect_uri])
 
       # normalize hash
-      @token_hash = JSON.parse(token.to_hash.to_json)
+      @token_hash = token.to_hash.transform_keys(&:to_s)
     end
 
     ##

data/lib/my_john_deere_api/helpers/case_conversion.rb

@@ -7,12 +7,13 @@ module MyJohnDeereApi::Helpers::CaseConversion
   # convert a text or camelcase string to underscore
 
   def underscore(something)
-    something = something.to_s if something.is_a?(Symbol)
-
-    if something.is_a?(String)
-      something.gsub(/([a-z])([A-Z])/, '\1_\2').gsub(/\s+/, '_').gsub(/_+/, '_').downcase
-    elsif something.is_a?(Hash)
+    case something
+    when Symbol, String
+      something.to_s.gsub(/([a-z])([A-Z])/, '\1_\2').gsub(/\s+/, '_').gsub(/_+/, '_').downcase
+    when Hash
       something.transform_keys{ |key| underscore(key) }
+    when Array
+      something.map{|element| underscore(element)}
     end
   end
 
@@ -20,11 +21,9 @@ module MyJohnDeereApi::Helpers::CaseConversion
   # convert text or underscored string to camelcase
 
   def camelize(something)
-    something = something.to_s if something.is_a?(Symbol)
-
     case something
-    when String
-      list = something.strip.split(/[_\s]+/)
+    when Symbol, String
+      list = something.to_s.strip.split(/[_\s]+/)
 
       # preserve case of the first element
       new_list = [list.shift]

data/lib/my_john_deere_api/model/base.rb

@@ -3,7 +3,7 @@ module MyJohnDeereApi
     include Helpers::CaseConversion
     include Helpers::UriHelpers
 
-    attr_reader :id, :record_type, :client, :links
+    attr_reader :id, :record, :record_type, :client, :links
 
     ##
     # arguments:
@@ -19,6 +19,7 @@ module MyJohnDeereApi
       verify_record_type(record['@type'])
 
       @id = record['id']
+      @record = record
       @record_type = record['@type']
       @client = client
       @unsaved = false

data/lib/my_john_deere_api/model/organization.rb

@@ -28,6 +28,20 @@ module MyJohnDeereApi
       @assets = MyJohnDeereApi::Request::Collection::Assets.new(client, organization: id)
     end
 
+    ##
+    # whether this organization still needs to be approved in JD "connections"
+
+    def needs_connection?
+      links.key?('connections')
+    end
+
+    ##
+    # the URI for JD connections page, if available
+
+    def connections_uri
+      record['links'].detect{|link| link['rel'] == 'connections'}&.fetch('uri')
+    end
+
     private
 
     def map_attributes(record)
@@ -40,4 +54,4 @@ module MyJohnDeereApi
       'Organization'
     end
   end
-end
+end

data/lib/my_john_deere_api/version.rb

@@ -1,3 +1,3 @@
 module MyJohnDeereApi
-  VERSION='3.0.0'
+  VERSION='3.1.0'
 end

data/test/lib/my_john_deere_api/authorize_test.rb

@@ -85,7 +85,7 @@ describe 'MyJohnDeereApi::Authorize' do
       new_hash = VCR.use_cassette('get_refresh_token') { subject }
 
       # normalize response hash
-      new_hash = JSON.parse(new_hash.to_json)
+      new_hash = new_hash.transform_keys(&:to_s)
 
       assert_equal new_access_token, new_hash['access_token']
     end

data/test/lib/my_john_deere_api/helpers/case_conversion_test.rb

@@ -34,6 +34,15 @@ describe 'Helpers::CaseConversion' do
       assert_equal new_hash['asset_type'], hash[:assetType]
     end
 
+    it 'converts the elements of an array' do
+      array = ['assetCategory', 'assetType']
+
+      new_array = object.send(:underscore, array)
+
+      assert_includes new_array, 'asset_category'
+      assert_includes new_array, 'asset_type'
+    end
+
     it 'handles leading uppercase' do
       string = object.send(:underscore, 'CamelCaseExample')
       assert_equal 'camel_case_example', string
@@ -88,6 +97,15 @@ describe 'Helpers::CaseConversion' do
       assert_equal new_hash['assetType'], hash[:asset_type]
     end
 
+    it 'converts the elements of an array' do
+      array = ['asset_category', 'asset_type']
+
+      new_array = object.send(:camelize, array)
+
+      assert_includes new_array, 'assetCategory'
+      assert_includes new_array, 'assetType'
+    end
+
     it 'is a private method' do
       exception = assert_raises(NoMethodError) { object.camelize('test') }
       assert_includes exception.message, 'private method'

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

@@ -4,6 +4,7 @@ describe 'MyJohnDeereApi::Model::Organization' do
   include JD::LinkHelpers
 
   let(:klass) { JD::Model::Organization }
+  let(:object) { klass.new(client, record) }
 
   let(:record) do
     {
@@ -12,44 +13,54 @@ describe 'MyJohnDeereApi::Model::Organization' do
       "type"=>"customer",
       "member"=>true,
       "id"=>"123456",
-      "links"=>[
-        {"@type"=>"Link", "rel"=>"self", "uri"=>"https://sandboxapi.deere.com/platform/organizations/#{organization_id}"},
-        {"@type"=>"Link", "rel"=>"machines", "uri"=>"https://sandboxapi.deere.com/platform/organizations/#{organization_id}/machines"},
-        {"@type"=>"Link", "rel"=>"wdtCapableMachines", "uri"=>"https://sandboxapi.deere.com/platform/organizations/#{organization_id}/machines?capability=wdt"},
-        {"@type"=>"Link", "rel"=>"files", "uri"=>"https://sandboxapi.deere.com/platform/organizations/#{organization_id}/files"},
-        {"@type"=>"Link", "rel"=>"transferableFiles", "uri"=>"https://sandboxapi.deere.com/platform/organizations/#{organization_id}/files?transferable=true"},
-        {"@type"=>"Link", "rel"=>"uploadFile", "uri"=>"https://sandboxapi.deere.com/platform/organizations/#{organization_id}/files"},
-        {"@type"=>"Link", "rel"=>"sendFileToMachine", "uri"=>"https://sandboxapi.deere.com/platform/organizations/#{organization_id}/fileTransfers"},
-        {"@type"=>"Link", "rel"=>"addMachine", "uri"=>"https://sandboxapi.deere.com/platform/organizations/#{organization_id}/machines"},
-        {"@type"=>"Link", "rel"=>"addField", "uri"=>"https://sandboxapi.deere.com/platform/organizations/#{organization_id}/fields"},
-        {"@type"=>"Link", "rel"=>"assets", "uri"=>"https://sandboxapi.deere.com/platform/organizations/#{organization_id}/assets"},
-        {"@type"=>"Link", "rel"=>"fields", "uri"=>"https://sandboxapi.deere.com/platform/organizations/#{organization_id}/fields"},
-        {"@type"=>"Link", "rel"=>"farms", "uri"=>"https://sandboxapi.deere.com/platform/organizations/#{organization_id}/farms"},
-        {"@type"=>"Link", "rel"=>"boundaries", "uri"=>"https://sandboxapi.deere.com/platform/organizations/#{organization_id}/boundaries"},
-        {"@type"=>"Link", "rel"=>"clients", "uri"=>"https://sandboxapi.deere.com/platform/organizations/#{organization_id}/clients"},
-        {"@type"=>"Link", "rel"=>"controllers", "uri"=>"https://sandboxapi.deere.com/platform/organizations/#{organization_id}/orgController"}
-      ]
+      "links"=> links,
+    }
+  end
+
+  let(:links) do
+    [
+      {"@type"=>"Link", "rel"=>"self", "uri"=>"https://sandboxapi.deere.com/platform/organizations/#{organization_id}"},
+      {"@type"=>"Link", "rel"=>"machines", "uri"=>"https://sandboxapi.deere.com/platform/organizations/#{organization_id}/machines"},
+      {"@type"=>"Link", "rel"=>"wdtCapableMachines", "uri"=>"https://sandboxapi.deere.com/platform/organizations/#{organization_id}/machines?capability=wdt"},
+      {"@type"=>"Link", "rel"=>"files", "uri"=>"https://sandboxapi.deere.com/platform/organizations/#{organization_id}/files"},
+      {"@type"=>"Link", "rel"=>"transferableFiles", "uri"=>"https://sandboxapi.deere.com/platform/organizations/#{organization_id}/files?transferable=true"},
+      {"@type"=>"Link", "rel"=>"uploadFile", "uri"=>"https://sandboxapi.deere.com/platform/organizations/#{organization_id}/files"},
+      {"@type"=>"Link", "rel"=>"sendFileToMachine", "uri"=>"https://sandboxapi.deere.com/platform/organizations/#{organization_id}/fileTransfers"},
+      {"@type"=>"Link", "rel"=>"addMachine", "uri"=>"https://sandboxapi.deere.com/platform/organizations/#{organization_id}/machines"},
+      {"@type"=>"Link", "rel"=>"addField", "uri"=>"https://sandboxapi.deere.com/platform/organizations/#{organization_id}/fields"},
+      {"@type"=>"Link", "rel"=>"assets", "uri"=>"https://sandboxapi.deere.com/platform/organizations/#{organization_id}/assets"},
+      {"@type"=>"Link", "rel"=>"fields", "uri"=>"https://sandboxapi.deere.com/platform/organizations/#{organization_id}/fields"},
+      {"@type"=>"Link", "rel"=>"farms", "uri"=>"https://sandboxapi.deere.com/platform/organizations/#{organization_id}/farms"},
+      {"@type"=>"Link", "rel"=>"boundaries", "uri"=>"https://sandboxapi.deere.com/platform/organizations/#{organization_id}/boundaries"},
+      {"@type"=>"Link", "rel"=>"clients", "uri"=>"https://sandboxapi.deere.com/platform/organizations/#{organization_id}/clients"},
+      {"@type"=>"Link", "rel"=>"controllers", "uri"=>"https://sandboxapi.deere.com/platform/organizations/#{organization_id}/orgController"}
+    ]
+  end
+
+  let(:connections_link) do
+    {
+      "@type"=>"Link",
+      "rel"=>"connections",
+      "uri"=>"https://connections.deere.com/connections/johndeere-0000000000000000000000000000000000000000/organizations"
     }
   end
 
   describe '#initialize(record, client = nil)' do
     it 'sets the attributes from the given record' do
-      organization = klass.new(client, record)
-
-      assert_equal client, organization.client
-      assert_equal accessor, organization.accessor
+      assert_equal client, object.client
+      assert_equal accessor, object.accessor
 
       # basic attributes
-      assert_equal record['name'], organization.name
-      assert_equal record['type'], organization.type
-      assert_equal record['member'], organization.member?
-      assert_equal record['id'], organization.id
+      assert_equal record['name'], object.name
+      assert_equal record['type'], object.type
+      assert_equal record['member'], object.member?
+      assert_equal record['id'], object.id
 
       # links to other things
-      assert_kind_of Hash, organization.links
+      assert_kind_of Hash, object.links
 
       ['fields', 'machines', 'files', 'assets', 'farms', 'boundaries', 'clients', 'controllers'].each do |association|
-        assert_link_for(organization, association)
+        assert_link_for(object, association)
       end
     end
   end
@@ -79,4 +90,40 @@ describe 'MyJohnDeereApi::Model::Organization' do
       end
     end
   end
+
+  describe '#needs_connection?' do
+    subject { object.needs_connection? }
+
+    describe 'when user needs to connect organization within JD platform' do
+      let(:links) { [connections_link] }
+
+      it 'returns true' do
+        assert subject
+      end
+    end
+
+    describe "when user doesn't need to connect org" do
+      it 'returns false' do
+        refute subject
+      end
+    end
+  end
+
+  describe '#connections_uri' do
+    subject { object.connections_uri }
+
+    describe 'when user needs to connect organization within JD platform' do
+      let(:links) { [connections_link] }
+
+      it 'returns the URI for JD connections' do
+        assert_includes subject, 'https://connections.deere.com/connections'
+      end
+    end
+
+    describe "when user doesn't need to connect org" do
+      it 'returns nil' do
+        assert_nil subject
+      end
+    end
+  end
 end

data/test/support/vcr_setup.rb

@@ -170,13 +170,23 @@ class VcrSetup
   def token_hash
     return @token_hash if defined?(@token_hash)
 
-    @token_hash = JSON.parse(File.read(token_file))
+    if File.exist?(token_file)
+      @token_hash = JSON.parse(File.read(token_file))
 
-    token = OAuth2::AccessToken.from_hash(auth_client, @token_hash)
+      token = OAuth2::AccessToken.from_hash(auth_client, @token_hash)
 
-    if token.expired?
-      new_token = token.refresh!
-      set_token_hash(new_token)
+      if token.expired?
+        new_token = token.refresh!
+        set_token_hash(new_token)
+      end
+    else
+      @token_hash = {
+        "token_type": "Bearer",
+        "scope": "ag2 ag1 offline_access ag3",
+        "access_token": access_token,
+        "refresh_token": refresh_token,
+        "expires_at": 1616484631
+      }
     end
 
     @token_hash

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: my_john_deere_api
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.1.0
 platform: ruby
 authors:
 - Jaime Bellmyer
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-03-22 00:00:00.000000000 Z
+date: 2021-03-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: vcr