fmrest 0.18.0 → 0.20.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 58ffd613bfae5200d8b15e7b7162853dd368b0d796efbb9fa96e2052f38c8485
-  data.tar.gz: b74adcfb5301dec79cbb182dc0d2df66bacd6c91d2fbc7054a006143c1f2fe7c
+  metadata.gz: 6c4b366640593f14ee48c1e4443f92aeb68edfe089cad7c7108c27526c1771cc
+  data.tar.gz: 4e772c3d19b64e030e8e572a30ef251715db66f94082ed95becd2d97eed790ae
 SHA512:
-  metadata.gz: 1ead00587af99dc9bb0c749521cf64d69cc02d704ff83f11e410a04be4514919ea3276e461a47ba3d764bf38e82b96a14c915a599cf5ce5b1c8f7963a673a9a6
-  data.tar.gz: b0348dabc27395bbc05a0d745fd29927a67c7ebaed4875327f361f9af83ae9bbf78081f0da01b1b0cc73424646f54a927c5c737855239139d416581fbd930596
+  metadata.gz: 413b4820538640c3c68f2c03cd14e624f4883da55b36810e58d71928d2712b51b6c1a85a93136a53fab695bd02d96ef2cc6d6ad2cf4b7ca63af08cb6957b5dab
+  data.tar.gz: 74b50c3faf532012b775e1dbe21df8a0455d044fcd46cb26213eef21f608d82eed995be9fb941dbebdaf388497ad549ed596fbced218832da0c5f21081b9e1d2

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 ## Changelog
 
+### 0.20.0
+
+* Forward proxy options to AWS Client when using `fmrest-cloud` gem
+
+### 0.19.0
+
+* Added native support for FileMaker Cloud through the `fmrest-cloud` gem
+
 ### 0.18.0
 
 * Better support for portals with mismatching field qualifiers

data/README.md

@@ -5,14 +5,30 @@
 [![Yard Docs](http://img.shields.io/badge/yard-docs-blue.svg)](https://rubydoc.info/github/beezwax/fmrest-ruby)
 
 A Ruby client for
-[FileMaker 18 and 19's Data API](https://help.claris.com/en/data-api-guide)
-using
-[Faraday](https://github.com/lostisland/faraday) and with optional
-ActiveRecord-ish ORM features through [Spyke](https://github.com/balvig/spyke).
-
-fmrest-ruby only partially implements FileMaker 19's Data API.
-See the [implementation completeness table](#api-implementation-completeness-table)
-to see if a feature you need is natively supported by the gem.
+[FileMaker's Data API](https://help.claris.com/en/data-api-guide)
+with ActiveRecord-ish ORM features.
+
+While pretty feature-rich, fmrest-ruby doesn't yet support 100% of FileMaker
+19's Data API features. See the [implementation completeness
+table](#api-implementation-completeness-table) to check if a feature you need
+is natively supported by the gem.
+
+Need Ruby or FileMaker consulting? Contact us at
+[Beezwax.net](https://beezwax.net/)
+
+## Contents
+
+* [Gems](#gems)
+* [Installation](#installation)
+* [Simple example](#simple-example)
+* [Connection settings](#connection-settings)
+* [Session token store](#session-token-store)
+* [Date fields and timezones](#date-fields-and-timezones)
+* [ActiveRecord-like ORM (fmrest-spyke)](#activerecord-like-orm-fmrest-spyke)
+* [Logging](#logging)
+* [Gotchas](#gotchas)
+* [API implementation completeness table](#api-implementation-completeness-table)
+* [Supported Ruby versions](#supported-ruby-versions)
 
 ## Gems
 
@@ -20,28 +36,26 @@ The `fmrest` gem is a wrapper for two other gems:
 
 * `fmrest-spyke`, providing an ActiveRecord-like ORM library built on top
   of `fmrest-core` and [Spyke](https://github.com/balvig/spyke).
-* `fmrest-core`, providing the core Faraday connection builder, session
+* `fmrest-core`, providing the core
+  [Faraday](https://github.com/lostisland/faraday) connection builder, session
   management, and other core utilities.
 
+In addition, the optional `fmrest-cloud` gem adds support for FileMaker Cloud.
+See the [main document on connecting to FileMaker
+Cloud](docs/FileMakerCloud.md).
+
 ## Installation
 
-Add this to your Gemfile:
+In your Gemfile:
 
 ```ruby
 gem 'fmrest'
-```
-
-Or if you just want to use the Faraday connection without the ORM features:
 
-```ruby
-gem 'fmrest-core'
+# Optional: if your files are hosted on FileMaker Cloud
+gem 'fmrest-cloud'
 ```
 
-## Simple examples
-
-### ORM example
-
-Most people would want to use the ORM features:
+## Simple example
 
 ```ruby
 # A Layout model connecting to the "Honeybees Web" FileMaker layout
@@ -90,32 +104,9 @@ bee.tasks.build(urgency: "Today")
 bee.save
 ```
 
-### Barebones connection example (without ORM)
-
-In case you don't need the advanced ORM features (e.g. if you only need minimal
-Data API interaction and just want a lightweight solution) you can simply use
-the Faraday connection provided by `fmrest-core`:
-
-```ruby
-connection = FmRest::V1.build_connection(
-  host:     "…",
-  database: "…",
-  username: "…",
-  password: "…"
-)
-
-# Get all records (as parsed JSON)
-connection.get("layouts/FancyLayout/records")
-
-# Create new record
-connection.post do |req|
-  req.url "layouts/FancyLayout/records"
-
-  # You can just pass a hash for the JSON body
-  req.body = { … }
-end
-```
-
+In case you don't want the ORM features (i.e. you only need authentication and
+JSON parsing, and are comfortable writing the API requests manually without the
+ORM overhead) you can use the Faraday connection provided by `fmrest-core`.
 See the [main document on using the base
 connection](docs/BaseConnectionUsage.md) for more.
 
@@ -125,10 +116,6 @@ The minimum required connection settings are `:host`, `:database`, `:username`
 and `:password`, but fmrest-ruby has many other options you can pass when
 setting up a connection (see [full list](#full-list-of-available-options) below).
 
-If you're using FileMaker Cloud you may need to pass `:fmid_token` instead
-of the regular `:username` and `:password`. See the [main document on
-connecting to FileMaker Cloud](docs/FileMakerCloud.md) for more info.
-
 `:ssl` and `:proxy` are forwarded to the underlying
 [Faraday](https://github.com/lostisland/faraday) connection. You can use this
 to, for instance, disable SSL verification:
@@ -153,9 +140,8 @@ Option              | Description                                | Format
 `:username`         | A Data API-ready account                   | String                      | None
 `:password`         | Your password                              | String                      | None
 `:account_name`     | Alias of `:username`                       | String                      | None
-`:fmid_token`       | Claris ID token (only needed for FileMaker Cloud) | String               | None
 `:ssl`              | SSL options to be forwarded to Faraday     | Faraday SSL options         | None
-`:proxy`            | Proxy options to be forwarded to Faraday   | Faraday proxy options       | None
+`:proxy`            | Proxy URI e.g. `http://username:password@proxy.host:5000` | String / URI | None
 `:log`              | Log JSON responses to STDOUT               | Boolean                     | `false`
 `:log_level`        | Which log level to log into                | Values accepted by `Logger#level=` | `:debug`
 `:coerce_dates`     | See section on [date fields](#date-fields-and-timezones) | Boolean \| `:hybrid` \| `:full` | `false`
@@ -165,6 +151,11 @@ Option              | Description                                | Format
 `:timezone`         | The timezone for the FM server             | `:local` \| `:utc` \| `nil` | `nil`
 `:autologin`        | Whether to automatically start Data API sessions | Boolean               | `true`
 `:token`            | Used to manually provide a session token (e.g. if `:autologin` is `false`) | String | None
+`:fmid_token`       | Claris ID token (only needed if manually obtaining the token) | String   | None
+`:cloud`            | Specifies whether the host is using FileMaker Cloud | `:auto` \| Boolean | `:auto`
+`:cognito_client_id`| Overwrites the hardcoded FileMaker Cloud Cognito Client ID | String      | None
+`:cognito_pool_id`  | Overwrites the hardcoded FileMaker Cloud Cognito Pool ID | String        | None
+`:aws_region`       | Overwrites the hardcoded FileMaker Cloud AWS Region | String             | None
 
 ### Default connection settings
 
@@ -207,7 +198,7 @@ See the [main document on date fields](docs/DateFields.md) for more info.
 ## ActiveRecord-like ORM (fmrest-spyke)
 
 [Spyke](https://github.com/balvig/spyke) is an ActiveRecord-like gem for
-building REST ORM models. fmrest-ruby builds its ORM features atop Spyke,
+building REST ORM models. fmrest-ruby uses it to build its ORM features,
 bundled in the `fmrest-spyke` gem (already included if you're using the
 `fmrest` gem).
 
@@ -265,39 +256,33 @@ class Honeybee < FmRest::Layout
 end
 ```
 
-This will automatically create a proper Faraday connection using those
-connection settings, so you don't have to worry about setting that up.
-
-Note that these settings are inheritable, so you could create a base class that
+These settings are class-inheritable, so you could create a base class that
 does the initial connection setup and then inherit from it in models using that
 same connection. E.g.:
 
 ```ruby
-class BeeBase < FmRest::Layout
+class ApplicationFmLayout < FmRest::Layout
   self.fmrest_config = { host: "…", database: "…", … }
 end
 
-class Honeybee < BeeBase
-  # This model will use the same connection as BeeBase
+class Honeybee < ApplicationFmLayout
+  # This model will use the same connection as ApplicationFmLayout
 end
 ```
 
-Also, if not set, your model will try to use
+If `fmrest_config` is not set, your model will try to use
 `FmRest.default_connection_settings` instead.
 
 #### Connection settings overlays
 
 There may be cases where you want to use a different set of connection settings
-depending on context, or simply change the connection settings over time. For
-example, if you want to use username and password provided by the user in a web
-application, or if you're connecting using an expiring Claris ID token. Since
-`.fmrest_config` is set at the class level, changing the username/password for
-the model in one context would also change it in all other contexts, leading to
-security issues.
+depending on context. For example, if you want to use username and password
+provided by the user in a web application. Since `.fmrest_config` is set at the
+class level, changing the username/password for the model in one context would
+also change it in all other contexts, leading to security issues.
 
-To solve this scenario, fmrest-ruby provides a way of defining thread-local and
-reversible connection settings overlays through
-`.fmrest_config_overlay=`.
+To solve this scenario, fmrest-ruby provides a way of defining thread-local,
+reversible connection settings overlays through `.fmrest_config_overlay=`.
 
 See the [main document on connection setting overlays](docs/ConfigOverlays.md)
 for details on how it works.
@@ -461,12 +446,10 @@ for details.
 
 ### Rescuable mixin
 
-Sometimes you may want to handle Data API errors at the model level. For
-instance, if you're logging in to a file hosted by FileMaker Cloud using a
-Claris ID token, and you want to be able to renew said token when it fails to
-log you in. For such cases fmrest-ruby provides an off-by-default mixin called
-`Rescuable` that provides convenience macros for that. If you've used Ruby on
-Rails you may be familiar with its syntax from controllers. E.g.
+Sometimes you may want to handle Data API errors at the model level. For such
+cases fmrest-ruby provides an off-by-default mixin called `Rescuable` that
+provides convenience macros for that. If you've used Ruby on Rails you may be
+familiar with its syntax from controllers. E.g.
 
 ```ruby
 class BeeBase < FmRest::Layout
@@ -474,9 +457,6 @@ class BeeBase < FmRest::Layout
 
   rescue_from FmRest::APIError::SystemError, with: :notify_admin_of_system_error
 
-  # Shorthand for rescue_with FmRest::APIError::AccountError, ...
-  rescue_account_error { ClarisIDTokenManager.expire_token }
-
   def self.notify_admin_of_system_error(e)
     # Shoot an email to the FM admin...
   end
@@ -549,14 +529,14 @@ Read about unexpected scenarios in the [gotchas doc](docs/Gotchas.md).
 
 ## API implementation completeness table
 
-FM Data API reference: https://fmhelp.filemaker.com/docs/18/en/dataapi/
+FM Data API reference: https://help.claris.com/en/data-api-guide/
 
-| FM 18 Data API feature              | Supported by basic connection | Supported by FmRest::Layout |
+| FM 19 Data API feature              | Supported by basic connection | Supported by FmRest::Layout |
 |-------------------------------------|-------------------------------|-----------------------------|
 | Log in using HTTP Basic Auth        | Yes                           | Yes                         |
 | Log in using OAuth                  | No                            | No                          |
 | Log in to an external data source   | No                            | No                          |
-| Log in using Claris ID account      | Yes                           | Yes                         |
+| Log in using Claris ID account (FileMaker Cloud) | Yes              | Yes                         |
 | Log out                             | Yes                           | Yes                         |
 | Get product information             | Manual*                       | No                          |
 | Get database names                  | Manual*                       | No                          |
@@ -592,9 +572,9 @@ the following Ruby implementations:
 ## Gem development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run
-`rake spec` to run the tests. You can also run `bin/console` for an interactive
-prompt that will allow you to experiment (it will auto-load all fixtures in
-spec/fixtures).
+`bundle exec rspec` to run the specs. You can also run `bin/console` for an
+interactive prompt that will allow you to experiment (it will auto-load all
+fixtures in spec/fixtures).
 
 To install all gems onto your local machine, run
 `bundle exec rake all:install`. To release a new version, update the version
@@ -602,12 +582,6 @@ number in `lib/fmrest/version.rb`, and then run `bundle exec rake all:release`,
 which will create a git tag for the version, push git commits and tags, and
 push the `.gem` files to [rubygems.org](https://rubygems.org).
 
-## License
-
-The gem is available as open source under the terms of the
-[MIT License](https://opensource.org/licenses/MIT).
-See [LICENSE.txt](LICENSE.txt).
-
 ## Disclaimer
 
 This project is not sponsored by or otherwise affiliated with Claris

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fmrest
 version: !ruby/object:Gem::Version
-  version: 0.18.0
+  version: 0.20.0
 platform: ruby
 authors:
 - Pedro Carbajal
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-09-16 00:00:00.000000000 Z
+date: 2021-10-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fmrest-core
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.18.0
+        version: 0.20.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.18.0
+        version: 0.20.0
 - !ruby/object:Gem::Dependency
   name: fmrest-spyke
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.18.0
+        version: 0.20.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.18.0
+        version: 0.20.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -206,7 +206,8 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 'fmrest is just a wrapper for two other gems: fmrest-core and fmrest-spyke.'
+description: 'FileMaker Data API client with ORM features. This gem is a wrapper for
+  two other gems: fmrest-core and fmrest-spyke.'
 email:
 - pedro_c@beezwax.net
 executables: []