my_john_deere_api 2.3.4 → 2.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0b6ea750328ecdcb653d61bbadf19ab4ab23ef2fb712963bda1351736ffedb37
-  data.tar.gz: '059eab2d2bbb7d8d716bde8f61f5ce935c46039dfbe6c82b933041e4f90fd072'
+  metadata.gz: d94f50a7c306efa861fb855b0c8a90d1b070c8ad230e05fc0ba298118b5d91c4
+  data.tar.gz: f105e3d4c42cc755db700ce5ceeaecd2a9edf2292b8ddb4ff4e559913a68fd89
 SHA512:
-  metadata.gz: d9e2285aa182a610b45b757707a26edad1e2ae342ce7ba62609c6a486f247fe3beaaad9e7df39a2ce2077b099b1a31edd53b1732fcdcde1d5b7253da648a7bdb
-  data.tar.gz: a9fad3831aa447433ee0969eb839d8e21245a29e955b1602ba560b75a989c8737c10c1489474d3982a7f71398407adfb9900968a240fd3cd677b05990e9dc3de
+  metadata.gz: d35cdcecd45fef14e1e78f454846a115c29b2c8e20543407540ca5ebd44f82e76a796e01b14fe4c02b70a725b9fad726d97d06f938dd6f00da5dcd5a779d5fe3
+  data.tar.gz: 8b33a28e57f5e0d08bc71d975be12e7c0fc71fa596a1cceb4b2fe611c31d3a1422ac2d2b7e314a6f6bc692ef5c2a268dbb8c00158daa9eff37893cc4e24233a0

data/README.md

@@ -24,6 +24,7 @@ without having to code your own oAuth process, API requests, and pagination.
   * [Organizations](#organizations)
   * [Assets](#assets)
   * [Asset Locations](#asset-locations)
+  * [Fields](#fields)
 * [Direct API Requests](#direct-api-requests)
   * [GET](#get)
   * [POST](#post)
@@ -346,7 +347,7 @@ organization.links
 # =>  {
 #       'self' => 'https://sandboxapi.deere.com/platform/organizations/1234',
 #       'machines' => 'https://sandboxapi.deere.com/platform/organizations/1234/machines',
-#       'wdtCapableMachines' => 'ttps://sandboxapi.deere.com/platform/organizations/1234/machines?capability=wdt'   
+#       'wdtCapableMachines' => 'https://sandboxapi.deere.com/platform/organizations/1234/machines?capability=wdt'   
 #     }
 
 organization.assets
@@ -558,6 +559,54 @@ Note that locations are called "Asset Locations" in John Deere, but we call the
 `asset.locations`, for brevity.
 
 
+### [Fields](https://developer.deere.com/#!documentation&doc=myjohndeere%2FfieldsADS.htm)
+
+Handles an organization's fields. Field collections support the following methods:
+
+* all
+* count
+* first
+* find(field\_id)
+
+An individual field supports the following methods and associations:
+
+* id
+* name
+* archived?
+* links
+* flags (collection of this field's flags)
+
+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. Fields can be
+created via the API, but there is no `create` method on this collection yet.
+
+```ruby
+organization.fields
+# => collection of fields under this organization
+
+organization.fields.count
+# => 15
+
+organization.fields.first
+# => an individual field object
+
+field = organization.fields.find(1234)
+# => an individual field object, fetched by ID
+
+field.name
+# => 'Smith Field'
+
+field.archived?
+# => false
+
+field.links
+# => a hash of API urls related to this asset
+
+field.flags
+# => collection of flags belonging to this field
+```
+
+
 ## Direct API Requests
 
 While the goal of the client is to eliminate the need to make/interpret calls to the John Deere API, it's important

data/lib/my_john_deere_api/version.rb

@@ -1,3 +1,3 @@
 module MyJohnDeereApi
-  VERSION='2.3.4'
+  VERSION='2.3.5'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: my_john_deere_api
 version: !ruby/object:Gem::Version
-  version: 2.3.4
+  version: 2.3.5
 platform: ruby
 authors:
 - Jaime Bellmyer
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-02-18 00:00:00.000000000 Z
+date: 2020-02-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: vcr