minimul / qbo_api

Ruby JSON-only client for QuickBooks Online API v3. Built on top of the Faraday gem.
MIT License
85 stars 46 forks source link

Documentation / Default Behavior Complaint => Default QboApi.minor_version = false #131

Open roboyeti opened 8 months ago

roboyeti commented 8 months ago

Problem:

While technically, this does fix it, not being compatible with a much more recent QBO minor version makes the QB API docs substantially worthless and confusing to users of this Gem when the API docs don't actually do what they expect from this api interface.

Not having your Gem API match the latest documentation makes this Gem frustrating, which is presumably the opposite of desired results.

I have not crawled thru the code to see if there is a way to change the default behavior and just use the latest minor version, so with that fact, my current suggestions are:

Solutions: 1.> fixed to operate automatically, or with a boolean, to use the latest minor version without specifying a specific version, and then use minor_version to lock someone in to an older version (code change) Or 2.> The documentation should explicitly state that they probably SHOULD change the minor version, so it matches at all with the online docs API ... AND ... maybe it is time to add a default minor_version (as a side note, changing minor_version from a boolean to an integer is a little strange IMHO).

The advantage of #1 is that the online documentation and this api gem will not grow out of sync with every advancing day.

Presumably, Intuit isn't so obnoxious as to add breaking changes to the API on minor versions ... but I don't know, this is my first experience with their API ... which hasn't been very happy, lol.

This would also be more consistent with gem use, where you typically want to automatically use the latest sub versions of a gem, but can lock in a specific one if bugs appear.

If someone is still active enough around here to merge changes, I can certainly make the doc change or make the code change (presuming there is a way to get minor version list from from QB API ...?).

minimul commented 8 months ago

Let's go with your second suggestion.