my_john_deere_api 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e2ae704f57aab2fa5c33972e626c85de1f4c870094f5b4e3807025da0bea6325
-  data.tar.gz: 46a6f1d705a307c09829ae49b8df13cc8bdd49f7c5b650c8ea9d2d13b918ca6d
+  metadata.gz: 0a4a505a402a82195b10345e48301897a6af477a4ba60711c33caee9d77ba764
+  data.tar.gz: 4f3f21b7b110b76be7bcc99195b380a3d05154443cbab36732e1f32a0dc830b2
 SHA512:
-  metadata.gz: abbd9e17e1ed5c709595de082e120381985aff0f78dfcd836474ad0f0de3fc1481a330484cec14962625bd658f5e89235f2ad5de40546fc247393898121e1e5a
-  data.tar.gz: 4cf59f13b1cedf18648871e9e5cc623d0c43f939e0e1a440f006c2e32949bf67f6754090ecf38bfd6d9c4c1e29801f633e7b9e57cf458e6cf4cc5d55ade3a114
+  metadata.gz: 19b70538ef4d795113246f269c97f6efe22cd2ccb79903d5433ee8aad79fc5823eb383e047bac8409f37f73a01658519a2fa3ceb10740416945833db8e9f6388
+  data.tar.gz: f0bbf336465ab99361e74e5102abd2dc6ebb2b74116988e5c9b8319aa28a2bf104a02c5209d2759904624ddd340aa9db019f819d93d20a63f2a5d82ae1b6450d

data/Rakefile

@@ -2,6 +2,7 @@ require 'rake/testtask'
 
 Rake::TestTask.new do |t|
   t.libs << 'test'
+  t.pattern = 'test/**/test*.rb'
 end
 
 desc "Run tests"

data/lib/my_john_deere_api.rb

@@ -1,5 +1,8 @@
+require 'oauth'
+require 'uri'
 require 'json'
 
 module MyJohnDeereApi
   autoload :VERSION,        'my_john_deere_api/version'
+  autoload :Authorize,      'my_john_deere_api/authorize'
 end

data/lib/my_john_deere_api/authorize.rb

@@ -0,0 +1,80 @@
+class MyJohnDeereApi::Authorize
+  attr_reader :api_key, :api_secret, :request_token, :request_secret
+  attr_accessor :base_url
+
+  DEFAULTS = {
+    base_url: 'https://api.soa-proxy.deere.com',
+  }
+
+  def initialize(api_key, api_secret, options={})
+    @api_key = api_key
+    @api_secret = api_secret
+    @base_url = options[:base_url] || ENV['MY_JOHN_DEERE_URL'] || DEFAULTS[:base_url]
+  end
+
+  def authorize_url
+    return @authorize_url if defined?(@authorize_url)
+
+    requester = app_consumer.get_request_token
+
+    @request_token = requester.token
+    @request_secret = requester.secret
+
+    @authorize_url = requester.authorize_url
+  end
+
+  def app_consumer
+    @app_consumer ||= consumer(base_url)
+  end
+
+  def user_consumer
+    @user_consumer ||= consumer("#{base_url}/platform")
+  end
+
+  def consumer(site)
+    OAuth::Consumer.new(
+      api_key,
+      api_secret,
+      site: site,
+      header: header,
+      http_method: :get,
+      request_token_url: links[:request_token],
+      access_token_url: links[:access_token],
+      authorize_url: links[:authorize_request_token]
+    )
+  end
+
+  def links
+    return @links if defined?(@links)
+
+    catalog = OAuth::Consumer.new(api_key, api_secret)
+      .request(
+        :get,
+        "#{base_url}/platform/",
+        nil,
+        {},
+        header
+      ).body
+
+      @links = {}
+
+      JSON.parse(catalog)['links'].each do |link|
+        uri = URI.parse(link['uri'])
+        uri.query = nil
+
+        @links[keyify(link['rel'])] = uri.to_s
+      end
+
+      @links
+  end
+
+  private
+
+  def header
+    {accept: 'application/vnd.deere.axiom.v3+json'}
+  end
+
+  def keyify key_name
+    key_name.gsub(/^oauth/, '').gsub(/([a-z])([A-Z])/, '\1_\2').downcase.to_sym
+  end
+end

data/lib/my_john_deere_api/version.rb

@@ -1,3 +1,3 @@
 module MyJohnDeereApi
-  VERSION = '0.0.1'
-end
+  VERSION='0.0.2'
+end

data/test/lib/test_authorize.rb

@@ -0,0 +1,132 @@
+require 'uri'
+require 'cgi'
+require 'support/helper'
+
+URL_ENV = 'MY_JOHN_DEERE_URL'
+TOKEN_PATTERN = /^[0-9a-z\-]+$/
+SECRET_PATTERN = /^[0-9A-Za-z\-+=\/]+$/
+API_KEY = ENV['API_KEY']
+API_SECRET = ENV['API_SECRET']
+
+def contains_parameters?(uri)
+  !URI.parse(uri).query.nil?
+end
+
+def create_authorize
+  JD::Authorize.new(API_KEY, API_SECRET, base_url: 'https://sandboxapi.deere.com')
+end
+
+def fancy_url
+  'https://example.com/turtles'
+end
+
+class AuthorizeTest < MiniTest::Test
+  describe 'initialization' do
+    it "accepts an API key and secret" do
+      authorize = JD::Authorize.new('key', 'secret')
+
+      assert_equal 'key', authorize.api_key
+      assert_equal 'secret', authorize.api_secret
+    end
+
+    it "can set the base_url" do
+      authorize = JD::Authorize.new('key', 'secret', base_url: fancy_url)
+      assert_equal fancy_url, authorize.base_url
+    end
+
+    it 'prefers passed-in base_url over ENV variable' do
+      ENV[URL_ENV] = 'https://example.com/disposable'
+
+      authorize = JD::Authorize.new('key', 'secret', base_url: fancy_url)
+      assert_equal fancy_url, authorize.base_url
+
+      ENV.delete(URL_ENV)
+    end
+  end
+
+  describe '#authorize_url' do
+    it 'retrieves a request url' do
+      authorize = create_authorize
+
+      url = VCR.use_cassette('get_request_token') { authorize.authorize_url }
+
+      assert_includes url, "#{authorize.links[:authorize_request_token]}?oauth_token="
+
+      query = URI.parse(url).query
+      params = CGI::parse(query)
+
+      assert_match(TOKEN_PATTERN, params['oauth_token'].first)
+    end
+
+    it 'sets the request token/secret' do
+      authorize = create_authorize
+
+      VCR.use_cassette('get_request_token') { authorize.authorize_url }
+
+      assert_match TOKEN_PATTERN, authorize.request_token
+      assert_match SECRET_PATTERN, authorize.request_secret
+    end
+  end
+
+  describe '#links' do
+    it "returns a list of catalog urls" do
+      authorize = create_authorize
+
+      links = VCR.use_cassette("catalog"){ authorize.links }
+
+      assert_kind_of Hash, links
+
+      [:request_token, :authorize_request_token, :access_token].each do |link|
+        assert links.has_key?(link)
+        refute contains_parameters?(links[link])
+      end
+    end
+  end
+
+  describe '#base_url' do
+    it 'defaults to production deere url' do
+      authorize = JD::Authorize.new('key', 'secret')
+      assert_equal 'https://api.soa-proxy.deere.com', authorize.base_url
+    end
+
+    it 'can be set via accessor' do
+      authorize = create_authorize
+      authorize.base_url = fancy_url
+
+      assert_equal fancy_url, authorize.base_url
+    end
+
+    it 'can be set via environment variable' do
+      ENV[URL_ENV] = fancy_url
+
+      authorize = JD::Authorize.new('key', 'secret')
+      assert_equal fancy_url, authorize.base_url
+
+      ENV.delete(URL_ENV)
+    end
+  end
+
+  describe '#app_consumer' do
+    it 'creates a working oAuth consumer for non-user-specific requests' do
+      auth = create_authorize
+      app_consumer = VCR.use_cassette('app_consumer') { auth.app_consumer }
+
+      assert_kind_of OAuth::Consumer, app_consumer
+      assert_equal API_KEY, app_consumer.key
+      assert_equal API_SECRET, app_consumer.secret
+      assert_equal auth.base_url, app_consumer.site
+    end
+  end
+
+  describe '#user_consumer' do
+    it 'creates a working oAuth consumer for user-specific requests' do
+      auth = create_authorize
+      user_consumer = VCR.use_cassette('app_consumer') { auth.user_consumer }
+
+      assert_kind_of OAuth::Consumer, user_consumer
+      assert_equal API_KEY, user_consumer.key
+      assert_equal API_SECRET, user_consumer.secret
+      assert_equal "#{auth.base_url}/platform", user_consumer.site
+    end
+  end
+end

data/test/lib/test_version.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/support/helper.rb

@@ -0,0 +1,14 @@
+require 'rubygems'
+require 'vcr'
+require 'webmock'
+require 'dotenv/load'
+require 'minitest/autorun'
+require 'my_john_deere_api'
+
+# shortcut for long module name
+JD = MyJohnDeereApi
+
+VCR.configure do |config|
+  config.cassette_library_dir = 'test/support/vcr'
+  config.hook_into :webmock
+end

data/test/support/vcr/app_consumer.yml

@@ -0,0 +1,46 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://sandboxapi.deere.com/platform/
+    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-wgmADngYCRmfpEbVgSyc709wnyRux5J7PAv8SE7B",
+        oauth_nonce="hLAsNSIk6Q2d3ULD6bT6rVf10km1qN5edh9HvNUgSc", oauth_signature="wjrjTVSXWY3uanxn69Y251jDFn8%3D",
+        oauth_signature_method="HMAC-SHA1", oauth_timestamp="1578174980", oauth_version="1.0"
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Sat, 04 Jan 2020 21:56:21 GMT
+      Content-Type:
+      - application/vnd.deere.axiom.v3+json;charset=UTF-8
+      X-Deere-Handling-Server:
+      - ip-10-214-44-80
+      X-Frame-Options:
+      - SAMEORIGIN
+      X-Deere-Elapsed-Ms:
+      - '16'
+      Cache-Control:
+      - no-store
+      Content-Language:
+      - en-US
+      Transfer-Encoding:
+      - chunked
+    body:
+      encoding: ASCII-8BIT
+      string: '{"@type":"ApiCatalog","links":[{"@type":"Link","rel":"oauthRequestToken","uri":"https://sandboxapi.deere.com/platform/oauth/request_token"},{"@type":"Link","rel":"oauthAuthorizeRequestToken","uri":"https://my.deere.com/consentToUseOfData?oauth_token={token}"},{"@type":"Link","rel":"oauthAccessToken","uri":"https://sandboxapi.deere.com/platform/oauth/access_token"},{"@type":"Link","rel":"agencies","uri":"https://sandboxapi.deere.com/platform/agencies"}]}'
+    http_version: 
+  recorded_at: Sat, 04 Jan 2020 21:56:21 GMT
+recorded_with: VCR 5.0.0

data/test/support/vcr/catalog.yml

@@ -0,0 +1,46 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://sandboxapi.deere.com/platform/
+    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-wgmADngYCRmfpEbVgSyc709wnyRux5J7PAv8SE7B",
+        oauth_nonce="3O7ELJDsWLUeJWwOv38z2KBoobVksbYRYDspg7fpMyc", oauth_signature="TL0zdGeZxLQ%2BYKgQDqnZQ%2BBZsJA%3D",
+        oauth_signature_method="HMAC-SHA1", oauth_timestamp="1578166502", oauth_version="1.0"
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Sat, 04 Jan 2020 19:35:04 GMT
+      Content-Type:
+      - application/vnd.deere.axiom.v3+json;charset=UTF-8
+      X-Deere-Handling-Server:
+      - ip-10-214-44-145
+      X-Frame-Options:
+      - SAMEORIGIN
+      X-Deere-Elapsed-Ms:
+      - '11'
+      Cache-Control:
+      - no-store
+      Content-Language:
+      - en-US
+      Transfer-Encoding:
+      - chunked
+    body:
+      encoding: ASCII-8BIT
+      string: '{"@type":"ApiCatalog","links":[{"@type":"Link","rel":"oauthRequestToken","uri":"https://sandboxapi.deere.com/platform/oauth/request_token"},{"@type":"Link","rel":"oauthAuthorizeRequestToken","uri":"https://my.deere.com/consentToUseOfData?oauth_token={token}"},{"@type":"Link","rel":"oauthAccessToken","uri":"https://sandboxapi.deere.com/platform/oauth/access_token"},{"@type":"Link","rel":"agencies","uri":"https://sandboxapi.deere.com/platform/agencies"}]}'
+    http_version: 
+  recorded_at: Sat, 04 Jan 2020 19:35:04 GMT
+recorded_with: VCR 5.0.0

data/test/support/vcr/get_request_token.yml

@@ -0,0 +1,83 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://sandboxapi.deere.com/platform/
+    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-wgmADngYCRmfpEbVgSyc709wnyRux5J7PAv8SE7B",
+        oauth_nonce="bA9m9jeEEXtDVO6t3evCoJcxWV6ask0dqv90ULA", oauth_signature="URbHoE5qi3YLnZlA5FiS6mloDPE%3D",
+        oauth_signature_method="HMAC-SHA1", oauth_timestamp="1578170525", oauth_version="1.0"
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Sat, 04 Jan 2020 20:42:06 GMT
+      Content-Type:
+      - application/vnd.deere.axiom.v3+json;charset=UTF-8
+      X-Deere-Handling-Server:
+      - ip-10-214-45-13
+      X-Frame-Options:
+      - SAMEORIGIN
+      X-Deere-Elapsed-Ms:
+      - '14'
+      Cache-Control:
+      - no-store
+      Content-Language:
+      - en-US
+      Transfer-Encoding:
+      - chunked
+    body:
+      encoding: ASCII-8BIT
+      string: '{"@type":"ApiCatalog","links":[{"@type":"Link","rel":"oauthRequestToken","uri":"https://sandboxapi.deere.com/platform/oauth/request_token"},{"@type":"Link","rel":"oauthAuthorizeRequestToken","uri":"https://my.deere.com/consentToUseOfData?oauth_token={token}"},{"@type":"Link","rel":"oauthAccessToken","uri":"https://sandboxapi.deere.com/platform/oauth/access_token"},{"@type":"Link","rel":"agencies","uri":"https://sandboxapi.deere.com/platform/agencies"}]}'
+    http_version: 
+  recorded_at: Sat, 04 Jan 2020 20:42:07 GMT
+- request:
+    method: get
+    uri: https://sandboxapi.deere.com/platform/oauth/request_token
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      User-Agent:
+      - OAuth gem v0.5.4
+      Authorization:
+      - OAuth oauth_callback="oob", oauth_consumer_key="johndeere-wgmADngYCRmfpEbVgSyc709wnyRux5J7PAv8SE7B",
+        oauth_nonce="D1Wa1SttrwCzWrFAAoEDUUyRmzVRkd6ka8rpAmWw8", oauth_signature="HciHAu%2Bojp4olApwEKk14WrhMt0%3D",
+        oauth_signature_method="HMAC-SHA1", oauth_timestamp="1578170527", oauth_version="1.0"
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Sat, 04 Jan 2020 20:42:07 GMT
+      Content-Type:
+      - text/plain;charset=UTF-8
+      X-Deere-Handling-Server:
+      - ip-10-214-45-13
+      Vary:
+      - Accept-Encoding
+      Transfer-Encoding:
+      - chunked
+    body:
+      encoding: ASCII-8BIT
+      string: oauth_token=27f8a03d-cda3-4b80-a42d-8f10065448e5&oauth_token_secret=mAsr2Tfy4YGUOrZG1%2BhIMefCIqom1yCQ90mXsQm7TOEjh%2B3HpRKgif8DrCdhNcKB31lpZqKbxX%2FKSD3xseT1BsFeFRlJPADHGd78B1mWtJI%3D&oauth_callback_confirmed=true
+    http_version: 
+  recorded_at: Sat, 04 Jan 2020 20:42:08 GMT
+recorded_with: VCR 5.0.0

data/test/test_my_john_deere_api.rb

@@ -1,10 +1,13 @@
-require 'minitest/autorun'
-require 'my_john_deere_api'
+require 'support/helper'
 
 class MyJohnDeereApiTest < MiniTest::Test
-  describe 'VERSION' do
-    it 'conforms to the semantic version format' do
-      assert_match /^\d+\.\d+\.\d+$/, MyJohnDeereApi::VERSION
+  describe 'loading dependencies' do
+    it 'loads VERSION' do
+      assert JD::VERSION
+    end
+
+    it 'loads Authorize' do
+      assert JD::Authorize
     end
   end
 end

metadata

@@ -1,15 +1,85 @@
 --- !ruby/object:Gem::Specification
 name: my_john_deere_api
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Jaime. Bellmyer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-01-04 00:00:00.000000000 Z
-dependencies: []
+date: 2020-01-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.7.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.7.5
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.7.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.7.6
+- !ruby/object:Gem::Dependency
+  name: oauth
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.4
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
 description: |
   == My John Deere API
 
@@ -26,7 +96,14 @@ files:
 - README.md
 - Rakefile
 - lib/my_john_deere_api.rb
+- lib/my_john_deere_api/authorize.rb
 - lib/my_john_deere_api/version.rb
+- test/lib/test_authorize.rb
+- test/lib/test_version.rb
+- test/support/helper.rb
+- test/support/vcr/app_consumer.yml
+- test/support/vcr/catalog.yml
+- test/support/vcr/get_request_token.yml
 - test/test_my_john_deere_api.rb
 homepage: https://github.com/Intellifarm/my_john_deere_api
 licenses: