my_john_deere_api 1.2.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1841ed9de4f3726461e96a055c41eafabd02f3dbbcb095517c010e07bd10c5fb
-  data.tar.gz: a33dd588075ddf1b2e861ad7e732883a8eb3c06dbb79a9b3dd6de748411285f4
+  metadata.gz: 5c3847859a2d14a7a9f7b2a7a3bd24dcd1f8a75a46e025c856df025ae8cda773
+  data.tar.gz: ee6697cc5dbcfd946deacb535b6eafe417b6bb5c4bd705bcc797b1ad434975b6
 SHA512:
-  metadata.gz: 0effad463f6fb6fdc658f4669209167be8f117e1a5ea0b798386fa80f3cc875678072b417564560ac7114a5d11550695bdeb0d243e1a416745031e2389cc43e2
-  data.tar.gz: 65aaf8a469a137c8a59bdb66ebe18ada13e5bf557f64ec1b25306088e933b30bf7f359e441d59f6feb9d82d48c0a126eb59a1d96a2b95b70b66db85f3145259d
+  metadata.gz: f9c3426b893a24e62caff5bd56847b350e38020ddd910d481ec7ebf84b2be019dd573a1a0638819277e6327a11969818a666628bed64071c9296c46e3d6cd987
+  data.tar.gz: 11dd36324795e0c3942a02d58fe6efab452d4be514be7e01e8a83eb98bae16488b1967c67eafa3b55fb567166144f0db87e4396645ee1a17f84aefe3fca53204

data/README.md

@@ -165,15 +165,103 @@ 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 
+collections support the following methods:
+
+* all
+* count
+* first
+* find(contribution\_product\_id)
+
+An individual contribution product supports the following methods and associations:
+
+* id
+* market_place_name
+* market_place_description
+* default\_locale
+* current\_status
+* activation\_callback
+* preview\_images
+* supported\_regions
+* supported\_operation\_centers
+* links
+* contribution\_definitions (collection of this contribution product's contribution definitions)
+
+```ruby
+client.contribution_products
+# => collection of contribution products under this client
+
+client.contribution_products.count
+# => 1
+
+client.contribution_products.first
+# => an individual contribution product
+
+contribution_product = client.contribution_products.find(1234)
+# => an individual contribution product, fetched by ID
+
+contribution_product.market_place_name
+# => 'Market Place Name'
+
+contribution_product.contribution_definitions
+# => collection of contribution definitions belonging to this contribution product
+```
+
+
+#### [Contribution Definitions](https://developer.deere.com/#!documentation&doc=.%2Fmyjohndeere%2Fproducts.htm)
+
+Handles a contribution product's contribution definitions. Contribution definition collections support the following methods:
+
+* all
+* count
+* first
+* find(contribution\_definition\_id)
+
+An individual contribution definition supports the following methods and associations:
+
+* id
+* name
+* links
+
+```ruby
+contribution_product.contribution_definitions
+# => collection of contribution definitions under this contribution product
+
+client.contribution_definitions.count
+# => 1
+
+client.contribution_definitions.first
+# => an individual contribution definition
+
+contribution_definition = contribution_product.contribution_definitions.find(1234)
+# => an individual contribution definition, fetched by ID
+
+contribution_definition.name
+# => 'Contribution Definition Name'
+```
+
+
 #### [Organizations](https://developer.deere.com/#!documentation&doc=myjohndeere%2Forganizations.htm)
 
-Organization 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), organization collections support:
+Handles an account's organizations. Organization collections support the following methods:
 
 * all
 * count
 * first
-* find
+* find(organization\_id)
+
+An individual organization supports the following methods and associations:
+
+* id
+* name
+* type
+* member?
+* links
+* assets (collection of this organization's assets)
+* fields (collection of this organization's fields)
 
 The `count` method only requires loading the first page of results, so it's a relatively cheap call. On the other hand,
 `all` forces the entire collection to be loaded from John Deere's API, so use with caution. Organizations cannot be
@@ -187,10 +275,10 @@ client.organizations.count
 # => 15
 
 client.organizations.first
-# => a single organization object
+# => an individual organization object
 
 organization = client.organizations.find(1234)
-# => a specific organization object, fetched by ID
+# => an individual organization object, fetched by ID
 
 organization.name
 # => 'Smith Farms'
@@ -208,56 +296,43 @@ organization.links
 #       'wdtCapableMachines' => 'ttps://sandboxapi.deere.com/platform/organizations/1234/machines?capability=wdt'   
 #     }
 
-```
-
-This is much nicer than working with the raw API response:
+organization.assets
+# => collection of assets belonging to this organization
 
-```json
-{
-   "links": [
-      {
-         "rel": "self",
-         "uri": "https://sandboxapi.deere.com/platform/organizations/1234"
-      },
-      {
-         "rel": "machines",
-         "uri": "https://sandboxapi.deere.com/platform/organizations/1234/machines"
-      },
-      {
-         "rel": "wdtCapableMachines",
-         "uri": "https://sandboxapi.deere.com/platform/organizations/1234/machines?capability=wdt"
-      }
-   ],
-   "id": "1234",
-   "name": "Smith Farms",
-   "type": "customer",
-   "partnerships": [],
-   "member": true
-}
+organization.fields
+# => collection of fields belonging to this organization
 ```
 
-But the real power comes from daisy-chaining associations together.
-
 
 #### [Assets](https://developer.deere.com/#!documentation&doc=.%2Fmyjohndeere%2Fassets.htm)
 
-Handles an organization's assets. Supported methods:
+Handles an organization's assets. Asset collections support the following methods:
 
 * all
 * count
 * first
-* find
-* create
+* find(asset\_id)
+* create(attributes)
+
+An individual asset supports the following methods and associations:
+
+* id
+* title
+* category
+* type
+* sub\_type
+* links
+* location (collection of this asset's locations)
 
 ```ruby
 organization = client.organizations.first
 # => the first organization returned by the client
 
 organization.assets
-# => collection of assets
+# => collection of assets belonging to this organization
 
 asset = organization.assets.find(123)
-# => asset object, fetched by ID
+# => an individual asset object, fetched by ID
 
 asset.title
 # => 'AgThing Water Device'

data/lib/my_john_deere_api/version.rb

@@ -1,3 +1,3 @@
 module MyJohnDeereApi
-  VERSION='1.2.0'
+  VERSION='1.2.1'
 end

metadata

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