my_john_deere_api 2.1.0 → 2.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1d5b6f6ff281312c3efbe68e816e2269a173fff59d55f39e9269d820affa7875
-  data.tar.gz: 9d84f97611bffd3c251bb1ffd1b277451b0b1486abfd67645666081f41253205
+  metadata.gz: b404eb35593809c27e7f5932317e89a182416efbbf5c9ab017a2eb98a0a2b28a
+  data.tar.gz: 6b051603fecfa6893230de4fb2a4e5828b4e42ebd4ed59709e46e5681888964a
 SHA512:
-  metadata.gz: bb4d195bfce24eda5d4de27a35170fc884fbccc101f91691765429c57031ebb75597b3454d93d52a1dbf81464a699af6507ab2dc7237f5b03583fdb608dbc61b
-  data.tar.gz: 5cacd41ef1c3ba3ffd5551d8a1d28839f7bc073a949913f7b58300d8cb9607bbe7e9433503b2aa3d28bf02b80ddd9491b2f7af6afe21a548154d394031a8725a
+  metadata.gz: 0b46d15e4f6e5321eed51f4855a10aa618c3637dc7179faae2e4545d7dc3eec41aceaf4f5c08642257f550b60ae2bdfd44d6161be4bd97ae7be150c7eb0617e6
+  data.tar.gz: 05faaa3f5d5784797a53a96c2dea408fdc844b8c14120054c6ff9f6e594de3a1278aece5fc3ac13e03bc3e7a4290f381131a4e3f28bd2dd3fe0f2e9795e5ab09

data/README.md

@@ -113,6 +113,10 @@ client = JD::Client.new(
   # the chosen environment (:sandbox or :live)
   environment: :sandbox,
 
+  # optional contribution_definition_id. This is needed for some requests,
+  # but the client can be created without it, in order to find it.
+  contribution_definition_id: CONTRIBUTION_DEFINITION_ID,
+
   # the user's access credentials
   access: [ACCESS_TOKEN, ACCESS_SECRET]
 )
@@ -145,16 +149,17 @@ client
     ├── first
     └── find(organization_id)
         ├── assets(attributes)
+        |   ├── create(attributes)
         |   ├── count
         |   ├── all
         |   ├── first
-        |   ├── find(asset_id)
-        |   |   └── locations
-        |   |       ├── count
-        |   |       ├── all
-        |   |       ├── first
-        |   |       └── create(attributes)
-        |   └── create(attributes)
+        |   └── find(asset_id)
+        |       ├── update(attributes)
+        |       └── locations
+        |           ├── create(attributes)
+        |           ├── count
+        |           ├── all
+        |           └── first
         └── fields
             ├── count
             ├── all
@@ -170,7 +175,7 @@ client
 #### [Contribution Products](https://developer.deere.com/#!documentation&doc=.%2Fmyjohndeere%2Fproducts.htm)
 
 Contribution Product collections act like a list. In addition to all the methods included via Ruby's
-[Enumerable Module](https://ruby-doc.org/core-2.7.0/Enumerable.html), contribution product 
+[Enumerable Module](https://ruby-doc.org/core-2.7.0/Enumerable.html), contribution product
 collections support the following methods:
 
 * all
@@ -310,11 +315,11 @@ organization.fields
 
 Handles an organization's assets. Asset collections support the following methods:
 
+* create(attributes)
 * all
 * count
 * first
 * find(asset\_id)
-* create(attributes)
 
 An individual asset supports the following methods and associations:
 
@@ -324,6 +329,7 @@ An individual asset supports the following methods and associations:
 * type
 * sub\_type
 * links
+* update(attributes)
 * location (collection of this asset's locations)
 
 ```ruby
@@ -352,13 +358,10 @@ asset.links
 # => a hash of API urls related to this asset
 ```
 
-Creating an asset requires a contribution\_definition\_id, in addition to the attributes listed in the
-[John Deere API docs](https://developer.deere.com/#!documentation). This method creates the asset in
-the John Deere platform, and returns the newly created record.
+The `create` method creates the asset in the John Deere platform, and returns the newly created record.
 
 ```ruby
 asset = organization.assets.create(
-  contribution_definition_id: ENV['CONTRIBUTION_DEFINITION_ID'],
   title: 'Asset Title',
   asset_category: 'DEVICE',
   asset_type: 'SENSOR',
@@ -369,6 +372,15 @@ asset.title
 # => 'Asset Title'
 ```
 
+The `update` method updates the local object, and also the asset on the John Deere platform.
+Only the title of an asset can be updated.
+
+```ruby
+asset.update(title: 'New Title')
+asset.title
+# => 'New Title', also John Deere record is updated
+```
+
 
 ### Direct API Requests
 

data/lib/my_john_deere_api/version.rb

@@ -1,3 +1,3 @@
 module MyJohnDeereApi
-  VERSION='2.1.0'
+  VERSION='2.1.1'
 end

metadata

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