fmrest-core 0.18.0 → 0.19.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fdfc316e5474cc3abbf196051aa48846f6b04452e0864a320445079a09a3f449
-  data.tar.gz: d23a6c290f33ab9c43f149de58af85825859aae9f0bc781200395bc883f66009
+  metadata.gz: 59a37ccbd8e0d79538853d677fbab969d50c7af665f29636a53d1b3cf2a21ac2
+  data.tar.gz: 3772ee36a4f5271588d2b29b29687cb6a1a1173af7fc3603d84d2e502cc88a55
 SHA512:
-  metadata.gz: 48ddb1505f075011675b5bfbeb437d42e70dff62912a6c44b0ac454c205332e8e61da6a628c0ae0cda095214d54dded125f8f98fa0af711d2e8e34b1d24332e1
-  data.tar.gz: 16623334ee707adb60e479d6db8bff23f22aa23cac397e32b839d4dceaa7aed4a2e94558684d08b1eaaa1fb008093b9628014a73b8b7dbe93f3d2cd1bc3498fc
+  metadata.gz: 65614bc40c7b149454cc51eea9141dd6a2982d7bb068bc672f06e647244381e1a015ca495fc655e6d20169a1385c5e8358d007d40c8d40f6573be10deb4d7797
+  data.tar.gz: b824ecd703afcf6efce3d5ed3a170a1ef5f403c6c65455b1f8dc0bb9f31e8a041cd2cf3daeac92f3dada7fdfc0dc1705ddc6815b0f7be14e3fd55804f0a6bd10

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 ## Changelog
 
+### 0.19.0
+
+* Add 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,27 @@
 [![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.
+
+## 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 +33,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 +101,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 +113,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,7 +137,6 @@ 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
 `:log`              | Log JSON responses to STDOUT               | Boolean                     | `false`
@@ -165,6 +148,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 +195,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 +253,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 +443,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 +454,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 +526,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 +569,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 +579,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

data/lib/fmrest/connection_settings.rb

@@ -31,6 +31,10 @@ module FmRest
       timestamp_format
       time_format
       timezone
+      cognito_client_id
+      cognito_pool_id
+      aws_region
+      cloud
     ).freeze
 
     # NOTE: password intentionally left non-required since it's only really
@@ -51,7 +55,8 @@ module FmRest
       date_format:      DEFAULT_DATE_FORMAT,
       time_format:      DEFAULT_TIME_FORMAT,
       timestamp_format: DEFAULT_TIMESTAMP_FORMAT,
-      coerce_dates:     false
+      coerce_dates:     false,
+      cloud:            :auto,
     }.freeze
 
     def self.wrap(settings, skip_validation: false)

data/lib/fmrest/token_store/memory.rb

@@ -7,19 +7,19 @@ module FmRest
     class Memory < Base
       def initialize(*args)
         super
-        @tokens = {}
+        @@tokens ||= {}
       end
 
       def delete(key)
-        @tokens.delete(key)
+        @@tokens.delete(key)
       end
 
       def load(key)
-        @tokens[key]
+        @@tokens[key]
       end
 
       def store(key, value)
-        @tokens[key] = value
+        @@tokens[key] = value
       end
     end
   end

data/lib/fmrest/token_store/short_memory.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require "fmrest/token_store/base"
+
+module FmRest
+  module TokenStore
+    # Similar to Memory token store, but using instance vars instead of class
+    # vars. Mainly useful for specs, where we want to scope token persistance
+    # to a spec's context only
+    class ShortMemory < Base
+      def initialize(*args)
+        super
+        @tokens ||= {}
+      end
+
+      def delete(key)
+        @tokens.delete(key)
+      end
+
+      def load(key)
+        @tokens[key]
+      end
+
+      def store(key, value)
+        @tokens[key] = value
+      end
+    end
+  end
+end

data/lib/fmrest/token_store.rb

@@ -8,5 +8,29 @@ module FmRest
     autoload :ActiveRecord, "fmrest/token_store/active_record"
     autoload :Moneta,       "fmrest/token_store/moneta"
     autoload :Redis,        "fmrest/token_store/redis"
+    autoload :ShortMemory,  "fmrest/token_store/short_memory"
+
+    TOKEN_STORE_INTERFACE = [:load, :store, :delete].freeze
+
+    private
+
+    def token_store
+      @token_store ||=
+        if TOKEN_STORE_INTERFACE.all? { |method| token_store_option.respond_to?(method) }
+          token_store_option
+        elsif token_store_option.kind_of?(Class)
+          if token_store_option.respond_to?(:instance)
+            token_store_option.instance
+          else
+            token_store_option.new
+          end
+        else
+          FmRest::TokenStore::Memory.new
+        end
+    end
+
+    def token_store_option
+      raise NotImplementedError
+    end
   end
 end

data/lib/fmrest/v1/connection.rb

@@ -12,6 +12,8 @@ module FmRest
       AUTH_CONNECTION_HEADERS = DEFAULT_HEADERS.merge("Content-Type" => "application/json").freeze
       CLARIS_ID_HTTP_AUTH_TYPE = "FMID"
 
+      FILEMAKER_CLOUD_HOST_MATCHER = /\.filemaker-cloud\.com\Z/.freeze
+
       # Builds a complete DAPI Faraday connection with middleware already
       # configured to handle authentication, JSON parsing, logging and DAPI
       # error handling. A block can be optionally given for additional
@@ -57,11 +59,18 @@ module FmRest
       def auth_connection(settings = FmRest.default_connection_settings)
         settings = ConnectionSettings.wrap(settings)
 
+        if is_cloud_host = cloud_host?(settings)
+          FmRest.require_cloud_support
+        end
+
         base_connection(settings, headers: AUTH_CONNECTION_HEADERS) do |conn|
+          conn.use Cloud::AuthErrorHandler, settings if is_cloud_host
           conn.use RaiseErrors
 
           if settings.fmid_token?
-            conn.request :authorization, CLARIS_ID_HTTP_AUTH_TYPE, settings.fmid_token
+            conn.request :authorization, CLARIS_ID_HTTP_AUTH_TYPE, -> { settings.fmid_token }
+          elsif is_cloud_host
+            conn.request :authorization, CLARIS_ID_HTTP_AUTH_TYPE, -> { Cloud::ClarisIdTokenManager.new(settings).fetch_token }
           else
             conn.request :basic_auth, settings.username!, settings.password!
           end
@@ -117,6 +126,16 @@ module FmRest
           &block
         )
       end
+
+      private
+
+      def cloud_host?(settings)
+        if settings.cloud == :auto
+          return FILEMAKER_CLOUD_HOST_MATCHER =~ settings.host
+        end
+
+        settings.cloud
+      end
     end
   end
 end

data/lib/fmrest/v1/token_session.rb

@@ -7,10 +7,11 @@ module FmRest
     # FM Data API authentication middleware using the credentials strategy
     #
     class TokenSession < Faraday::Middleware
+      include TokenStore
+
       class NoSessionTokenSet < FmRest::Error; end
 
       HEADER_KEY = "Authorization"
-      TOKEN_STORE_INTERFACE = [:load, :store, :delete].freeze
       LOGOUT_PATH_MATCHER = %r{\A(#{FmRest::V1::Connection::DATABASES_PATH}/[^/]+/sessions/)[^/]+\Z}.freeze
 
       # @param app [#call]
@@ -110,23 +111,6 @@ module FmRest
           end
       end
 
-      def token_store
-        @token_store ||=
-          begin
-            if TOKEN_STORE_INTERFACE.all? { |method| token_store_option.respond_to?(method) }
-              token_store_option
-            elsif token_store_option.kind_of?(Class)
-              if token_store_option.respond_to?(:instance)
-                token_store_option.instance
-              else
-                token_store_option.new
-              end
-            else
-              FmRest::TokenStore::Memory.new
-            end
-          end
-      end
-
       def token_store_option
         @settings.token_store || FmRest.token_store
       end

data/lib/fmrest/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module FmRest
-  VERSION = "0.18.0"
+  VERSION = "0.19.0.rc1"
 end

data/lib/fmrest.rb

@@ -59,5 +59,12 @@ module FmRest
       require "fmrest/spyke"
       self.Layout(*_)
     end
+
+    def require_cloud_support
+      require "fmrest/cloud"
+    rescue LoadError => e
+      e.message << " (Did you include fmrest-cloud in your Gemfile?)" unless e.message.frozen?
+      raise e
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fmrest-core
 version: !ruby/object:Gem::Version
-  version: 0.18.0
+  version: 0.19.0.rc1
 platform: ruby
 authors:
 - Pedro Carbajal
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-09-16 00:00:00.000000000 Z
+date: 2021-10-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -16,7 +16,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.0
+        version: 1.8.0
     - - "<"
       - !ruby/object:Gem::Version
         version: '2.0'
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.0
+        version: 1.8.0
     - - "<"
       - !ruby/object:Gem::Version
         version: '2.0'
@@ -64,7 +64,6 @@ files:
 - LICENSE.txt
 - README.md
 - lib/fmrest-core.rb
-- lib/fmrest-spyke.rb
 - lib/fmrest.rb
 - lib/fmrest/connection_settings.rb
 - lib/fmrest/errors.rb
@@ -76,6 +75,7 @@ files:
 - lib/fmrest/token_store/moneta.rb
 - lib/fmrest/token_store/null.rb
 - lib/fmrest/token_store/redis.rb
+- lib/fmrest/token_store/short_memory.rb
 - lib/fmrest/v1.rb
 - lib/fmrest/v1/auth.rb
 - lib/fmrest/v1/connection.rb
@@ -104,9 +104,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubygems_version: 3.2.3
 signing_key:

data/lib/fmrest-spyke.rb

@@ -1,3 +0,0 @@
-# frozen_string_literal: true
-
-require "fmrest/spyke"