my_john_deere_api 1.2.2 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 323b2dbcafff1df5b7b99acdeca601dadbac2c505dcbc1083409c5140b24d004
-  data.tar.gz: '08836d5ef6a97a75a41819be9e0b4bc03e5b278c495c42e660e063dcd432f4c4'
+  metadata.gz: d50aa3fc0ca62985954cd44e295bded9e99d4c4dfe0f54476790d67a8c9ec9c7
+  data.tar.gz: ff0e198656370bf7db40d83d389750c02fc9bf687f721f1aa1633ea3ea62dafa
 SHA512:
-  metadata.gz: e2649b788f9abdad89c05f5335a181be1d2df328d1c093325c9e1dfc9ef728f87115ab2a5c386c509fecc649de5040aa64407c5d038258cee5b4fcf5ff26d604
-  data.tar.gz: baa8f6cf444d43be11907b42c618ff70b43a27e11c811c656c163ce56b7c7b4b9055281023603f4108d670cc8d5ec002e2f24398876210418208a9fe81fc4856
+  metadata.gz: cc0e69436e3a50c0f3c14cbe472415478d7fa1ee79ad308c12054da7a5c03d6e298f0c85aebfdc32edf42c0ff4abc50b8cba1908f308564adfa75fdf57928adc
+  data.tar.gz: 18f7ba0176b534e2af940205145b97172dd64c4083b2c43fdf586ce602742fc6110e059dff26fbbf1e408d43a9cf67488eae7b7e0ec10166288b5bf137f400ec

data/README.md

@@ -467,5 +467,16 @@ client.delete('/assets/123123')
 
 John Deere's standard response is a 204 HTTP status code, with the message "No Content". This method returns the full Net::HTTP response.
 
-
-More details coming soon.
+### Contributing to This Gem
+
+The easiest way to contribute is:
+
+* Clone the repo
+* Create a feature branch
+* Grep for "raise NotYetImplementedError" in the lib directory
+* Replace one of these exceptions with working code, following the conventions used in the rest of the app
+* Run tests.
+  * You may need to regenerate all VCR cassettes from scratch.
+  * All VCR cassettes should be pre-recorded in `vcr_setup`
+  * Anything that is created in the JD sandbox as a result of running the tests should be removed, also in `vcr_setup`.
+* When tests are passing, submit a Pull Request.

data/lib/my_john_deere_api/errors.rb

@@ -1,6 +1,7 @@
 module MyJohnDeereApi::Errors
   require           'my_john_deere_api/errors/access_token_error'
   require           'my_john_deere_api/errors/invalid_record_error'
+  require           'my_john_deere_api/errors/not_yet_implemented_error'
   require           'my_john_deere_api/errors/type_mismatch_error'
   require           'my_john_deere_api/errors/unsupported_environment_error'
 end

data/lib/my_john_deere_api/errors/not_yet_implemented_error.rb

@@ -0,0 +1,12 @@
+module MyJohnDeereApi
+  ##
+  # This error is used in a context that will fail in the absence of
+  # a valid oAuth access token. We have classes that may only need 
+  # access tokens for some use cases.
+
+  class NotYetImplementedError < StandardError
+    def initialize(message = 'This is not yet implemented. View README to help make this gem better!')
+      super
+    end
+  end
+end

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

@@ -15,5 +15,19 @@ module MyJohnDeereApi::Request
     def model
       MyJohnDeereApi::Model::Flag
     end
+
+    ##
+    # Create a new flag (NOT YET IMPLEMENTED)
+
+    def create(attributes)
+      raise NotImplementedError
+    end
+
+    ##
+    # Retrieve an flag from JD (NOT YET IMPLEMENTED)
+
+    def find(asset_id)
+      raise NotImplementedError
+    end
   end
 end

data/lib/my_john_deere_api/version.rb

@@ -1,3 +1,3 @@
 module MyJohnDeereApi
-  VERSION='1.2.2'
+  VERSION='1.3.0'
 end

data/test/lib/my_john_deere_api/errors/not_yet_implemented_error_test.rb

@@ -0,0 +1,13 @@
+require 'support/helper'
+
+describe 'MyJohnDeereApi::NotYetImplementedError' do
+  it 'inherits from StandardError' do
+    error = MyJohnDeereApi::NotYetImplementedError.new
+    assert_kind_of StandardError, error
+  end
+
+  it 'has a default message' do
+    error = MyJohnDeereApi::NotYetImplementedError.new
+    assert_includes error.message, 'This is not yet implemented. View README to help make this gem better!'
+  end
+end

data/test/lib/my_john_deere_api/errors_test.rb

@@ -10,6 +10,10 @@ describe 'MyJohnDeereApi Errors' do
       assert JD::InvalidRecordError
     end
 
+    it 'loads NotYetImplementedError' do
+      assert JD::NotYetImplementedError
+    end
+
     it 'loads TypeMismatchError' do
       assert JD::TypeMismatchError
     end

data/test/lib/my_john_deere_api/request/collection/flags_test.rb

@@ -57,6 +57,18 @@ describe 'MyJohnDeereApi::Request::Collection::Flags' do
     end
   end
 
+  describe '#create(attributes)' do
+    it 'raises an error, not yet implemented' do
+      assert_raises(NotImplementedError) { collection.create({}) }
+    end
+  end
+
+  describe '#find(id)' do
+    it 'raises an error, not yet implemented' do
+      assert_raises(NotImplementedError) { collection.find(123) }
+    end
+  end
+
   describe 'results' do
     let(:flag_geometries) do
       contents = File.read('test/support/vcr/get_flags.yml')

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: my_john_deere_api
 version: !ruby/object:Gem::Version
-  version: 1.2.2
+  version: 1.3.0
 platform: ruby
 authors:
 - Jaime Bellmyer
@@ -109,6 +109,7 @@ files:
 - lib/my_john_deere_api/errors.rb
 - lib/my_john_deere_api/errors/access_token_error.rb
 - lib/my_john_deere_api/errors/invalid_record_error.rb
+- lib/my_john_deere_api/errors/not_yet_implemented_error.rb
 - lib/my_john_deere_api/errors/type_mismatch_error.rb
 - lib/my_john_deere_api/errors/unsupported_environment_error.rb
 - lib/my_john_deere_api/helpers.rb
@@ -151,6 +152,7 @@ files:
 - test/lib/my_john_deere_api/consumer_test.rb
 - test/lib/my_john_deere_api/errors/access_token_error_test.rb
 - test/lib/my_john_deere_api/errors/invalid_record_error_test.rb
+- test/lib/my_john_deere_api/errors/not_yet_implemented_error_test.rb
 - test/lib/my_john_deere_api/errors/type_mismatch_error_test.rb
 - test/lib/my_john_deere_api/errors/unsupported_environment_error_test.rb
 - test/lib/my_john_deere_api/errors_test.rb