my_john_deere_api 2.2.2 → 2.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f2a0ea6da39733c6548ab2876234e2151e81a6e6014de61fa8fa84658d2d71fb
-  data.tar.gz: feda45426448cabf22f6cbbcdf08fd69e6c4d78921e2837a85407c54dec852a5
+  metadata.gz: b21ab5fade7543a53cfb56a48d2cc251d397ad66ce5fc7642921084683b6a767
+  data.tar.gz: f6cac8a2d165caa91171d8f495faaa1013867c50402fb327fcd0ac272806ed93
 SHA512:
-  metadata.gz: 8f19da2c83408ef7613ef628c9a15d97d6d15a248bef875ca5d4e9976b8d5d51b471a5673a1a6aaa77a3adbc87f1e9fb6ba8837a3d9aeda7df55dd8a80619ad6
-  data.tar.gz: be95fdfa597c60f743f8125e9cbb02a316bc9f6c1e52bf8265b2300ae04f7d59bc065198aee99971f5c7dbcdf0511aad0727e27331850d205a60bb0b9068d79d
+  metadata.gz: d09890868c851fa39c64a7934d1060e167d980d05a058e84b699c0916642d2b485f996efea49ad20210d9d61173870a301e42a81891695a04bd0616feba0cbf0
+  data.tar.gz: 6fdd6b0bee46bb7a6e375259ae21c1ddf2c9113d7b2343f518e6716bf06d1c0811b4d7e3de75aa02cc90c05a76564e50d872d05e5078ec676b2b4d0d20ae49b2

data/README.md

@@ -490,6 +490,24 @@ 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.
 
+
+### Errors
+
+Custom errors help clearly identify problems when using the client:
+
+* **UnsupportedEnvironmentError** is raised when you attempt to instantiate a client with an
+  unrecognized environment. Valid environments are `:sandbox` or `:production`.
+* **InvalidRecordError** is raised when bad input has been given, in an attempt to create or update
+  a record on the John Deere platform.
+* **TypeMismatchError** is raised when a model is instantiated, typically when a record is received
+  from John Deere and is being converted into a Ruby object. Model instantiation is normally handled
+  by request objects, but this error is helpful if you're instantiating your own models for advanced
+  usage.
+* **NotYetImplementedError** is raised when you attempt to use a feature that is earmarked for future
+  development, but hasn't been implemented in this client yet. These are a great chance to contribute
+  to this gem!
+
+
 ### Contributing to This Gem
 
 The easiest way to contribute is:

data/lib/my_john_deere_api/request/create/base.rb

@@ -2,6 +2,8 @@ require 'json'
 
 module MyJohnDeereApi
   class Request::Create::Base
+    include Validators::Base
+
     attr_reader :client, :attributes, :response
 
     ##
@@ -42,36 +44,8 @@ module MyJohnDeereApi
       @object = model.new(client, fetch_record)
     end
 
-    ##
-    # Runs validations, adding to the errors hash as needed. Returns true
-    # if the errors hash is still empty after all validations have been run.
-
-    def valid?
-      return @is_valid if defined?(@is_valid)
-
-      validate_required
-      validate_attributes
-
-      @is_valid = errors.empty?
-    end
-
-    ##
-    # Raises an error if the record is invalid. Passes the errors hash
-    # to the error, in order to build a useful message string.
-
-    def validate!
-      raise(InvalidRecordError, errors) unless valid?
-    end
-
     private
 
-    ##
-    # Run validations unique to a given model. This should be overridden
-    # by children where needed.
-
-    def validate_attributes
-    end
-
     ##
     # Convert inputs into working attributes. This allows us to auto-create
     # some attributes from others, or set defaults, on a class-by-class basis.
@@ -80,22 +54,6 @@ module MyJohnDeereApi
     def process_attributes
     end
 
-    ##
-    # Attributes that must be specified, override in child class
-
-    def required_attributes
-      []
-    end
-
-    ##
-    # Validates required attributes
-
-    def validate_required
-      required_attributes.each do |attr|
-        errors[attr] = 'is required' unless attributes[attr]
-      end
-    end
-
     ##
     # Headers for POST request
 

data/lib/my_john_deere_api/version.rb

@@ -1,3 +1,3 @@
 module MyJohnDeereApi
-  VERSION='2.2.2'
+  VERSION='2.2.3'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: my_john_deere_api
 version: !ruby/object:Gem::Version
-  version: 2.2.2
+  version: 2.2.3
 platform: ruby
 authors:
 - Jaime Bellmyer