RubyGems - my_john_deere_api - Versions diffs - 0.0.4 → 0.1.0 - Mend

my_john_deere_api 0.0.4 → 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (6) hide show

checksums.yaml +4 -4
data/lib/my_john_deere_api/client.rb +15 -0
data/lib/my_john_deere_api/version.rb +1 -1
data/test/lib/test_client.rb +35 -1
data/test/support/vcr/get_organizations.yml +49 -0
metadata +2 -1

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1972b07d8f4e72723a8984e459a5fc97e7587914b06415dcd2ce181d6db3c43b
-  data.tar.gz: 6ecea1bd5fef0c60e04c510674c54adae3dd80967f3132fbba68e54d199a57e9
+  metadata.gz: dbad97d98f7f86489ff758e97b1f8e596db52adef1a0948618e073cacd393f6d
+  data.tar.gz: 268f2309b43dc543268d5ad97151b4a4f6fb4e84ba8a7a6504e4f35a78177616
 SHA512:
-  metadata.gz: 905162ea13bdb92ef6a7a1c0d86db73e351c0edf8f3b8420a8cb93193eb6e0e4e717436ca535b705636c0fe01256ee2797e9ae20f9e020b515cc15ad0e649c3b
-  data.tar.gz: 28a612aab3944a40bf19e23bc3640db8cdcff1e78faed99e374320df64ceb7441df5b92171e5aa2c0beb56ef90c26aa3dd2bae3cd5a061d4c3ba96277142f837
+  metadata.gz: 02cdd40ea10657f8a4102c185fce3114da462fb68e52688dfb219ff4dbf36ab9a621f2e6be6bd1713312097a8ebeb7466dd3976a019a803b1300e51a5b1a7bfa
+  data.tar.gz: 13c524f8779b12210e40fcf632ecb171e088a942b30215a1d049559bdacf7bd4e3211c26d0ea9fa29fecacca5f948cae4703dc423803e63d80e21198b19fc236

data/lib/my_john_deere_api/client.rb CHANGED Viewed

@@ -30,6 +30,17 @@ class MyJohnDeereApi::Client
     @environment = options[:environment]
   end
+  ##
+  # generic user-specific GET request method that returns JSON
+  def get resource
+    resource = resource.to_s
+    resource = "/#{resource}" unless resource =~ /^\//
+    response = accessor.get(resource, headers)
+    JSON.parse(response.body)
+  end
   private
   ##
@@ -48,4 +59,8 @@ class MyJohnDeereApi::Client
     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
 end

data/lib/my_john_deere_api/version.rb CHANGED Viewed

@@ -1,3 +1,3 @@
 module MyJohnDeereApi
-  VERSION='0.0.4'
+  VERSION='0.1.0'
 end

data/test/lib/test_client.rb CHANGED Viewed

@@ -34,6 +34,41 @@ describe 'MyJohnDeereApi::Client' do
     end
   end
+  describe '#get' do
+    it 'returns the response as a Hash' do
+      client = JD::Client.new(API_KEY, API_SECRET, environment: :sandbox, access: [ACCESS_TOKEN, ACCESS_SECRET])
+      VCR.use_cassette('catalog') { client.send(:accessor) }
+      response = VCR.use_cassette('get_organizations') { client.get('/organizations') }
+      assert_kind_of Hash, response
+      assert_equal 2, response['total']
+      assert response['values'].all?{|value| value['@type'] == 'Organization'}
+      assert response['values'].all?{|value| value.has_key?('links')}
+    end
+    it 'prepends the leading slash if needed' do
+      client = JD::Client.new(API_KEY, API_SECRET, environment: :sandbox, access: [ACCESS_TOKEN, ACCESS_SECRET])
+      VCR.use_cassette('catalog') { client.send(:accessor) }
+      response = VCR.use_cassette('get_organizations') { client.get('organizations') }
+      assert_kind_of Hash, response
+      assert_equal 2, response['total']
+      assert response['values'].all?{|value| value['@type'] == 'Organization'}
+      assert response['values'].all?{|value| value.has_key?('links')}
+    end
+    it 'allows symbols for simple resources' do
+      client = JD::Client.new(API_KEY, API_SECRET, environment: :sandbox, access: [ACCESS_TOKEN, ACCESS_SECRET])
+      VCR.use_cassette('catalog') { client.send(:accessor) }
+      response = VCR.use_cassette('get_organizations') { client.get(:organizations) }
+      assert_kind_of Hash, response
+      assert_equal 2, response['total']
+      assert response['values'].all?{|value| value['@type'] == 'Organization'}
+      assert response['values'].all?{|value| value.has_key?('links')}
+    end
+  end
   describe '#consumer' do
     it 'receives the api key/secret and environment of the client' do
       environment = :sandbox
@@ -51,7 +86,6 @@ describe 'MyJohnDeereApi::Client' do
   describe '#accessor' do
     it 'returns an object that can make user-specific requests' do
       client = JD::Client.new(API_KEY, API_SECRET, environment: :sandbox, access: [ACCESS_TOKEN, ACCESS_SECRET])
-      consumer = client.send(:consumer)
       accessor = VCR.use_cassette('catalog') { client.send :accessor }
       assert_kind_of OAuth::AccessToken, accessor

data/test/support/vcr/get_organizations.yml ADDED Viewed

@@ -0,0 +1,49 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://sandboxapi.deere.com/platform/organizations
+    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="kndkJ0Y5SmSiWKPLw7e1peNgotFj5t2hHkpX89mmQWk", oauth_signature="uSxP9P%2BZcpG7dZwZhOQM7noYcTI%3D",
+        oauth_signature_method="HMAC-SHA1", oauth_timestamp="1578435671", oauth_token="47bbb9c9-41a8-4bec-8127-e3c5760af2f6",
+        oauth_version="1.0"
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Tue, 07 Jan 2020 22:21:12 GMT
+      Content-Type:
+      - application/vnd.deere.axiom.v3+json;charset=UTF-8
+      X-Deere-Handling-Server:
+      - ip-10-214-44-238
+      X-Frame-Options:
+      - SAMEORIGIN
+      X-Deere-Elapsed-Ms:
+      - '115'
+      Cache-Control:
+      - no-store
+      Content-Language:
+      - en-US
+      Transfer-Encoding:
+      - chunked
+    body:
+      encoding: ASCII-8BIT
+      string: '{"links":[{"rel":"self","uri":"https://sandboxapi.deere.com/platform/organizations"}],"total":2,"values":[{"@type":"Organization","name":"Century
+        Farms","type":"customer","member":true,"id":"444563","links":[{"@type":"Link","rel":"self","uri":"https://sandboxapi.deere.com/platform/organizations/444563"},{"@type":"Link","rel":"machines","uri":"https://sandboxapi.deere.com/platform/organizations/444563/machines"},{"@type":"Link","rel":"wdtCapableMachines","uri":"https://sandboxapi.deere.com/platform/organizations/444563/machines?capability=wdt"},{"@type":"Link","rel":"files","uri":"https://sandboxapi.deere.com/platform/organizations/444563/files"},{"@type":"Link","rel":"transferableFiles","uri":"https://sandboxapi.deere.com/platform/organizations/444563/files?transferable=true"},{"@type":"Link","rel":"uploadFile","uri":"https://sandboxapi.deere.com/platform/organizations/444563/files"},{"@type":"Link","rel":"sendFileToMachine","uri":"https://sandboxapi.deere.com/platform/organizations/444563/fileTransfers"},{"@type":"Link","rel":"addMachine","uri":"https://sandboxapi.deere.com/platform/organizations/444563/machines"},{"@type":"Link","rel":"addField","uri":"https://sandboxapi.deere.com/platform/organizations/444563/fields"},{"@type":"Link","rel":"assets","uri":"https://sandboxapi.deere.com/platform/organizations/444563/assets"},{"@type":"Link","rel":"fields","uri":"https://sandboxapi.deere.com/platform/organizations/444563/fields"},{"@type":"Link","rel":"farms","uri":"https://sandboxapi.deere.com/platform/organizations/444563/farms"},{"@type":"Link","rel":"boundaries","uri":"https://sandboxapi.deere.com/platform/organizations/444563/boundaries"},{"@type":"Link","rel":"clients","uri":"https://sandboxapi.deere.com/platform/organizations/444563/clients"},{"@type":"Link","rel":"controllers","uri":"https://sandboxapi.deere.com/platform/organizations/444563/orgController"}]},{"@type":"Organization","name":"JJ''s
+        Farm","type":"customer","member":true,"id":"443911","links":[{"@type":"Link","rel":"self","uri":"https://sandboxapi.deere.com/platform/organizations/443911"},{"@type":"Link","rel":"machines","uri":"https://sandboxapi.deere.com/platform/organizations/443911/machines"},{"@type":"Link","rel":"wdtCapableMachines","uri":"https://sandboxapi.deere.com/platform/organizations/443911/machines?capability=wdt"},{"@type":"Link","rel":"files","uri":"https://sandboxapi.deere.com/platform/organizations/443911/files"},{"@type":"Link","rel":"transferableFiles","uri":"https://sandboxapi.deere.com/platform/organizations/443911/files?transferable=true"},{"@type":"Link","rel":"uploadFile","uri":"https://sandboxapi.deere.com/platform/organizations/443911/files"},{"@type":"Link","rel":"sendFileToMachine","uri":"https://sandboxapi.deere.com/platform/organizations/443911/fileTransfers"},{"@type":"Link","rel":"addMachine","uri":"https://sandboxapi.deere.com/platform/organizations/443911/machines"},{"@type":"Link","rel":"addField","uri":"https://sandboxapi.deere.com/platform/organizations/443911/fields"},{"@type":"Link","rel":"assets","uri":"https://sandboxapi.deere.com/platform/organizations/443911/assets"},{"@type":"Link","rel":"fields","uri":"https://sandboxapi.deere.com/platform/organizations/443911/fields"},{"@type":"Link","rel":"farms","uri":"https://sandboxapi.deere.com/platform/organizations/443911/farms"},{"@type":"Link","rel":"boundaries","uri":"https://sandboxapi.deere.com/platform/organizations/443911/boundaries"},{"@type":"Link","rel":"clients","uri":"https://sandboxapi.deere.com/platform/organizations/443911/clients"},{"@type":"Link","rel":"controllers","uri":"https://sandboxapi.deere.com/platform/organizations/443911/orgController"}]}]}'
+    http_version:
+  recorded_at: Tue, 07 Jan 2020 22:21:13 GMT
+recorded_with: VCR 5.0.0

metadata CHANGED Viewed

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: my_john_deere_api
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.1.0
 platform: ruby
 authors:
 - Jaime. Bellmyer
@@ -108,6 +108,7 @@ files:
 - test/support/vcr/app_consumer.yml
 - test/support/vcr/catalog.yml
 - test/support/vcr/get_access_token.yml
+- test/support/vcr/get_organizations.yml
 - test/support/vcr/get_request_token.yml
 - test/test_my_john_deere_api.rb
 homepage: https://github.com/Intellifarm/my_john_deere_api