my_john_deere_api 0.11.0 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e13eed76fb39d6bd0905710f9fdfdd5ce55d9a942f241adcd757cb5390ba3107
-  data.tar.gz: f14973d9655407f66123cf3829bfa37e3d4a8a75f5221cf6745d4b2c64461fbb
+  metadata.gz: 43721caccbde8bfdc7a91686c00d8b312d3c93f28c6e3b9a3e06575028102d0c
+  data.tar.gz: '09599905c0d5e75026cc716646361b4d4061c56c7fdbba079f149b51b215f3a5'
 SHA512:
-  metadata.gz: 69774e1c0b8cc27697a7d6c51a922f84559e9cfaf3e0b799f86d6abb688422aa3807bbda82512bcf595803eef24b848fe1b26729262bdaa1277dd533425e1843
-  data.tar.gz: f5d9513614d9d5230883668364841b85a28d3603e0eff718065de0bf81d9d38c047a13f639ba6355d39c3b85d2904d6b473959c4e743d506df26da81edb55c47
+  metadata.gz: 39d9d9f4394a30f4e2fe3bf7672af804c7f0979b5ef57237068afaee997c37c94ac68b6ccadec71a8205b2a3646306aa7e1dab8baa0835e29f0a8d37a4618796
+  data.tar.gz: c737bd823842d703840a8e3d54f23b12f6ed3a8945ff67e40ce93902485b6277ee7d8f54c80e15314be3fbe575aad68a8fb51e75d2feec7ee5dd8975c78e6f0c

data/README.md

@@ -2,4 +2,10 @@
 
 [![CircleCI](https://circleci.com/gh/Intellifarm/my_john_deere_api.svg?style=svg)](https://circleci.com/gh/Intellifarm/my_john_deere_api)
 
-Interact with John Deere's Developer API. More instructions coming soon.
+This client allows you to connect the MyJohnDeere API without having to code your own oauth process, API requests, and pagination. 
+
+* Supports both sandbox and live mode
+* Simplifies the oAuth negotiation process
+* Uses ruby enumerables to handle pagination behind the scenes. Calls like `each`, `map`, etc will fetch new pages of data as needed.
+
+More details coming soon.

data/lib/my_john_deere_api/authorize.rb

@@ -5,7 +5,7 @@ class MyJohnDeereApi::Authorize
     :environment, :options
 
   DEFAULTS = {
-    environment: :production
+    environment: :live
   }
 
   ##
@@ -19,7 +19,7 @@ class MyJohnDeereApi::Authorize
 
     @api_key = api_key
     @api_secret = api_secret
-    @environment = @options[:environment].to_sym
+    self.environment = @options[:environment]
   end
 
   ##
@@ -62,4 +62,14 @@ class MyJohnDeereApi::Authorize
     @access_secret = access_object.secret
     nil
   end
+
+  private
+
+  ##
+  # intelligently sets the environment
+
+  def environment=(value)
+    value = value.to_sym
+    @environment = value == :production ? :live : value
+  end
 end

data/lib/my_john_deere_api/client.rb

@@ -2,7 +2,7 @@ class MyJohnDeereApi::Client
   attr_reader :api_key, :api_secret, :access_token, :access_secret, :environment
 
   DEFAULTS = {
-    environment: :production
+    environment: :live
   }
 
   ##
@@ -12,7 +12,7 @@ class MyJohnDeereApi::Client
   #
   # options:
   #
-  # [:environment] :sandbox or :production
+  # [:environment] :sandbox or :live
   #
   # [:access] an array with two elements, the access_token
   #           and the access_secret of the given user
@@ -27,7 +27,7 @@ class MyJohnDeereApi::Client
       @access_token, @access_secret = options[:access]
     end
 
-    @environment = options[:environment]
+    self.environment = options[:environment]
   end
 
   ##
@@ -81,6 +81,13 @@ class MyJohnDeereApi::Client
 
   private
 
+  ##
+  # allows :production param to be a synonym for :live
+
+  def environment=(value)
+    @environment = value == :production ? :live : value
+  end
+
   ##
   # Returns an oAuth consumer which can be used to build requests
 

data/lib/my_john_deere_api/consumer.rb

@@ -7,11 +7,11 @@ module MyJohnDeereApi
     # valid API urls
     URLS = {
       sandbox: 'https://sandboxapi.deere.com',
-      production: 'https://api.soa-proxy.deere.com',
+      live: 'https://api.soa-proxy.deere.com',
     }
 
     DEFAULTS = {
-      environment: :production
+      environment: :live
     }
 
     def initialize(api_key, api_secret, options={})
@@ -20,7 +20,7 @@ module MyJohnDeereApi
       @api_key = api_key
       @api_secret = api_secret
 
-      @environment = options[:environment].to_sym
+      self.environment = options[:environment]
       @base_url = options[:base_url] || URLS[@environment]
     end
 
@@ -41,6 +41,14 @@ module MyJohnDeereApi
 
     private
 
+    ##
+    # intelligently sets the environment
+
+    def environment=(value)
+      value = value.to_sym
+      @environment = value == :production ? :live : value
+    end
+
     def consumer(site)
       OAuth::Consumer.new(
         api_key,

data/lib/my_john_deere_api/version.rb

@@ -1,3 +1,3 @@
 module MyJohnDeereApi
-  VERSION='0.11.0'
+  VERSION='0.12.0'
 end

data/test/lib/my_john_deere_api/authorize_test.rb

@@ -23,13 +23,27 @@ describe 'MyJohnDeereApi::Authorize' do
       assert_equal API_SECRET, authorize.api_secret
     end
 
-    it 'sets the environment' do
+    it 'sets the sandbox environment' do
       environment = :sandbox
 
       authorize = VCR.use_cassette('catalog') { JD::Authorize.new(API_KEY, API_SECRET, environment: environment) }
       assert_equal environment, authorize.environment
     end
 
+    it 'sets the live environment' do
+      environment = :live
+
+      authorize = VCR.use_cassette('catalog') { JD::Authorize.new(API_KEY, API_SECRET, environment: environment) }
+      assert_equal environment, authorize.environment
+    end
+
+    it 'accepts production as a synonym for live environment' do
+      environment = :production
+
+      authorize = VCR.use_cassette('catalog') { JD::Authorize.new(API_KEY, API_SECRET, environment: environment) }
+      assert_equal :live, authorize.environment
+    end
+
     it 'converts environment to symbol' do
       environment = 'sandbox'
 
@@ -37,8 +51,8 @@ describe 'MyJohnDeereApi::Authorize' do
       assert_equal environment.to_sym, authorize.environment
     end
 
-    it 'defaults the environment to production' do
-      environment = :production
+    it 'defaults to live environment' do
+      environment = :live
 
       authorize = VCR.use_cassette('catalog') { JD::Authorize.new(API_KEY, API_SECRET) }
       assert_equal environment, authorize.environment

data/test/lib/my_john_deere_api/client_test.rb

@@ -19,16 +19,30 @@ describe 'MyJohnDeereApi::Client' do
       assert_equal access_secret, client.access_secret
     end
 
-    it 'accepts environment' do
+    it 'accepts sandbox environment' do
       environment = :sandbox
 
       client = JD::Client.new(API_KEY, API_SECRET, environment: environment)
       assert_equal environment, client.environment
     end
 
-    it 'defaults the environment to production' do
+    it 'accepts live environment' do
+      environment = :live
+
+      client = JD::Client.new(API_KEY, API_SECRET, environment: environment)
+      assert_equal environment, client.environment
+    end
+
+    it 'accepts production as a synonym for live' do
       environment = :production
 
+      client = JD::Client.new(API_KEY, API_SECRET, environment: environment)
+      assert_equal :live, client.environment
+    end
+
+    it 'defaults to live environment' do
+      environment = :live
+
       client = JD::Client.new(API_KEY, API_SECRET)
       assert_equal environment, client.environment
     end

data/test/lib/my_john_deere_api/consumer_test.rb

@@ -17,16 +17,24 @@ describe 'JD::Consumer' do
       assert_equal JD::Consumer::URLS[environment], consumer.base_url
     end
 
-    it 'accepts production environment' do
-      environment = :production
+    it 'accepts live environment' do
+      environment = :live
       consumer = JD::Consumer.new(API_KEY, API_SECRET, environment: environment)
 
       assert_equal environment, consumer.environment
       assert_equal JD::Consumer::URLS[environment], consumer.base_url
     end
 
-    it 'defaults to production environment' do
-      default_environment = :production
+    it 'accepts production as a synonym for live environment' do
+      environment = :production
+      consumer = JD::Consumer.new(API_KEY, API_SECRET, environment: environment)
+
+      assert_equal :live, consumer.environment
+      assert_equal JD::Consumer::URLS[:live], consumer.base_url
+    end
+
+    it 'defaults to live environment' do
+      default_environment = :live
       consumer = JD::Consumer.new(API_KEY, API_SECRET)
 
       assert_equal default_environment, consumer.environment

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: my_john_deere_api
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 0.12.0
 platform: ruby
 authors:
 - Jaime Bellmyer
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-01-27 00:00:00.000000000 Z
+date: 2020-01-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: vcr