my_john_deere_api 2.3.1 → 2.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8b7e56857d5db19f8704d06453efd6c258a59301fbfd046fa9fc6f97f7ae0ae6
-  data.tar.gz: a6c869c73bc36401c52334c207964b34b4753cedef3dcd227c6f7f3afa81a53b
+  metadata.gz: da3d6b3ad58337a3842a1789a14401a2511de3a5fa0afddfe97dc6160d966c2b
+  data.tar.gz: d71594d268b6afcd7c4d949ead108815201b717ba63b5f435666b6775c4b6d6e
 SHA512:
-  metadata.gz: e8efc6cc4fc3e1609baff17d01c41c58d022dc1a5c144b012f2f4a813e059bdee5b4c6b648ceab217586176179e5e51a7e568ff52e250a7e1ed089f247131c4a
-  data.tar.gz: 82ad3bebb98fbd194cf6f5e2772203548c52be2f203e1cd6564562cc2d8c24045f45be8f9616243113f84537561f28b08798c556a17b8b32608e4e01b5fd913f
+  metadata.gz: 7f407f316f53015f4ce095a851fbd10e7e07a4d0e6c348e5a528aa5dbb89d6faa17978b500071b5d5c601b0bd294f63bd121f658096e3bb9eefe61a8c649aefe
+  data.tar.gz: baeb71aa75157da5f550e4f7532294fbbdcb79d348491191893433365996605124174e885792979fb29b9b73c15373068e2d74eede9d944da7d5f0b5bb3fd76c

data/README.md

@@ -12,7 +12,28 @@ without having to code your own oauth process, API requests, and pagination.
 * Provides `get`, `create`, `put`, and `delete` methods to make easy, authenticated, direct API calls
 * Uses ruby enumerables to handle pagination behind the scenes. Calls like `each`, `map`, etc will fetch new pages of data as needed.
 
-## Documentation
+## Table of Contents
+
+* [How to Read This Documentation](#how-to-read-this-documentation)
+* [Authorizing with John Deere via oAuth 1.0](#authorizing-with-john-deere-via-oauth-10)
+* [Interacting with the User's John Deere Account](#interacting-with-the-users-john-deere-account)
+* [Using the Client to Do Stuff](#using-the-client-to-do-stuff)
+  * [Contribution Products](#contribution-products)
+  * [Contribution Definitions](#contribution-definitions)
+  * [Organizations](#organizations)
+  * [Assets](#assets)
+* [Direct API Requests](#direct-api-requests)
+  * [GET](#get)
+  * [POST](#post)
+  * [PUT](#put)
+  * [DELETE](#delete)
+* [Errors](#errors)
+* [How Can I Help?](#how-can-i-help)
+  * [Give Us a Star!](#give-us-a-star)
+  * [Contribute to This Gem](#contribute-to-this-gem)
+
+
+## How To Read This Documentation
 
 We provide RDoc documentation, but here is a helpful guide for getting started. Because the gem name is long, all examples are going
 to assume this shortcut:
@@ -32,7 +53,7 @@ It really means:
 MyJohnDeereApi::Authorize
 ```
 
-### Authorizing with John Deere via Auth 1.0
+## Authorizing with John Deere via oAuth 1.0
 
 This is the simplest path to authorization, though your user has to jump through an extra hoop of giving you the verification code:
 
@@ -96,7 +117,7 @@ authorize = JD::Authorize.new(API_KEY, API_SECRET, environment: :sandbox)
 authorize.verify(params[:oauth_verifier])
 ```
 
-### Interacting with the user's John Deere account
+## Interacting with the User's John Deere Account
 
 After authorization is complete, the `Client` object will provide most of the interface for this library. A client can
 be used with or without user credentials, because some API calls are specific to your application's relationship
@@ -123,7 +144,7 @@ client = JD::Client.new(
 ```
 
 
-### Using the Client to Do Stuff
+## Using the Client to Do Stuff
 
 Once you're connected, the client works like a simplified version of ActiveRecord. JSON hashes from the API are
 converted into objects to be easier to work with. Collections of things, like organizations, handle pagination
@@ -173,7 +194,7 @@ client
 ```
 
 
-#### [Contribution Products](https://developer.deere.com/#!documentation&doc=.%2Fmyjohndeere%2Fproducts.htm)
+### [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
@@ -219,7 +240,7 @@ contribution_product.contribution_definitions
 ```
 
 
-#### [Contribution Definitions](https://developer.deere.com/#!documentation&doc=.%2Fmyjohndeere%2Fproducts.htm)
+### [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:
 
@@ -252,7 +273,7 @@ contribution_definition.name
 ```
 
 
-#### [Organizations](https://developer.deere.com/#!documentation&doc=myjohndeere%2Forganizations.htm)
+### [Organizations](https://developer.deere.com/#!documentation&doc=myjohndeere%2Forganizations.htm)
 
 Handles an account's organizations. Organization collections support the following methods:
 
@@ -312,7 +333,7 @@ organization.fields
 ```
 
 
-#### [Assets](https://developer.deere.com/#!documentation&doc=.%2Fmyjohndeere%2Fassets.htm)
+### [Assets](https://developer.deere.com/#!documentation&doc=.%2Fmyjohndeere%2Fassets.htm)
 
 Handles an organization's assets. Asset collections support the following methods:
 
@@ -331,7 +352,7 @@ An individual asset supports the following methods and associations:
 * sub\_type
 * links
 * update(attributes)
-* location (collection of this asset's locations)
+* locations (collection of this asset's locations)
 
 ```ruby
 organization = client.organizations.first
@@ -391,13 +412,13 @@ asset.save
 ```
 
 
-### Direct API Requests
+## 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
 to be able to make calls that are not yet fully supported by the client. Or sometimes, you need to troubleshoot.
 
 
-#### GET
+### GET
 
 
 GET requests require only a resource path.
@@ -428,7 +449,7 @@ Abbreviated sample response:
 This won't provide any client goodies like pagination or validation, but it does parse the returned JSON.
 
 
-#### POST
+### POST
 
 POST requests require a resource path, and a hash for the request body. The client will camelize the keys, and convert to JSON.
 
@@ -454,7 +475,7 @@ client.post(
 John Deere's standard response is a 201 HTTP status code, with the message "Created". This method returns the full Net::HTTP response.
 
 
-#### PUT
+### PUT
 
 PUT requests require a resource path, and a hash for the request body. The client will camelize the keys, and convert to JSON.
 
@@ -480,7 +501,7 @@ client.put(
 John Deere's standard response is a 204 HTTP status code, with the message "No Content". This method returns the full Net::HTTP response.
 
 
-#### DELETE
+### DELETE
 
 DELETE requests require only a resource path.
 
@@ -491,7 +512,7 @@ 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
+## Errors
 
 Custom errors help clearly identify problems when using the client:
 
@@ -511,16 +532,16 @@ Custom errors help clearly identify problems when using the client:
   to this gem!
 
 
-### How Can I Help?
+## How Can I Help?
 
-#### Give Us a Star!
+### Give Us a Star!
 
 *Star* this gem on [GitHub](https://github.com/Intellifarm/my_john_deere_api). It helps developers
 find and choose this gem over others that may be out there. To our knowledge, there are no other
 John Deere gems that are being actively maintained.
 
 
-#### Contribute to This Gem
+### Contribute to This Gem
 
 The easiest way to contribute is:
 

data/lib/my_john_deere_api/version.rb

@@ -1,3 +1,3 @@
 module MyJohnDeereApi
-  VERSION='2.3.1'
+  VERSION='2.3.2'
 end

metadata

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