fmrest-core 0.16.0 → 0.18.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 02e8b51abdf2fc9a5b7df29cdad8d5acef8f04b5c6167d7ff94040a716117449
-  data.tar.gz: 6a78ce64f39cd5e41910114eb22948eb5c4f26d26a892ab2b09c0bdcaa6c3fb3
+  metadata.gz: 27b42f06b36c99b967649c4257ea1b4df30e70f3e30efce3c1a82e74b511a368
+  data.tar.gz: 46cade48892b6cedca8f18fc40ccb88c3da2e1893bb09df020fcc0847782ede4
 SHA512:
-  metadata.gz: 3bdd91f7e25de359a7a28746d4c7be4eae7a684b63d909eacae6dd48a7053666386ff6dd3b87895aaf315e6a6b923aadcf0b8713aefa696fadbef25656dbae3b
-  data.tar.gz: 37d292af43be4a6a42b4f4044d3078ec40edff189622e3d4390d4a9ec65e34b0b910b2542ca4293ea3d3925eea8c84f1c944a5d7c7cc22f47bf989113b1017d7
+  metadata.gz: 79335b4c02f13f90dde6052998cd2f11e29ff4da10a6622b8d789f7ec443828afea5a869c10b7f40c79f10cf4b16b88f69691eab0e7605a6372b69ec24b07f6b
+  data.tar.gz: 7f3a11e55de51d92680a76812a63b6e3e2fa8ecbc3ac37949af7a365c67911d7867625781c4f5947c6079d1a99f31a499a354a3999d6d3415e5a08a982cc08a1

data/CHANGELOG.md

@@ -1,13 +1,29 @@
 ## Changelog
 
+### 0.18.0
+
+* Better support for portals with mismatching field qualifiers
+* Defining an attribute on a model that would collide with an existing method
+  now raises an error
+
+### 0.17.1
+
+* Fixed crash when `fmid_token` is set but `username` isn't
+
+### 0.17.0
+
+* Added support for Claris ID token login
+* Added ability to use procs in settings
+* Added `Rescuable` mixin
+
 ### 0.16.0
 
-* Add `FmRest.logger=`
+* Added `FmRest.logger=`
 * Handle serialization of `nil`, `true` and `false` values
 
 ### 0.15.2
 
-* Fix autoloading of `FmRest::Layout`
+* Fixed autoloading of `FmRest::Layout`
 
 ### 0.15.0
 
@@ -23,13 +39,13 @@
 
 ### 0.13.1
 
-* Fix downloading of container field data from FMS19+
+* Fixed downloading of container field data from FMS19+
 
 ### 0.13.0
 
 * Split `fmrest` gem into `fmrest-core` and `fmrest-spyke`. `fmrest` becomes a
   wrapper for the two new gems.
-* Fix bug preventing connection databases with spaces in their names.
+* Fixed bug preventing connection databases with spaces in their names.
 * Improved portal support with ability to delete portal records, and better
   refreshing of portal records after saving the parent.
 * `FmRest::Spyke::Base#__record_id` and `FmRest::Spyke::Base#__mod_id` now
@@ -44,7 +60,7 @@
 
 ### 0.11.1
 
-* Fix a couple crashes due to missing constants
+* Fixed a couple crashes due to missing constants
 
 ### 0.11.0
 
@@ -59,7 +75,7 @@
 
 ### 0.10.1
 
-* Fix `URI.escape` obsolete warning messages in Ruby 2.7 by replacing it with
+* Fixed `URI.escape` obsolete warning messages in Ruby 2.7 by replacing it with
   `URI.encode_www_form_component`
   ([PR#40](https://github.com/beezwax/fmrest-ruby/pull/40))
 
@@ -133,20 +149,20 @@
 
 ### 0.3.2
 
-* Fix support for ActiveSupport < 5.2
+* Fixed support for ActiveSupport < 5.2
   ([#27](https://github.com/beezwax/fmrest-ruby/issues/27))
 
 ### 0.3.0
 
-* Add Moneta token store
+* Added Moneta token store
 
 ### 0.2.5
 
-* Fix crash in `fetch_container_data` when no proxy options were set
+* Fixed crash in `fetch_container_data` when no proxy options were set
 
 ### 0.2.4
 
 * Use `String#=~` instead of `String#match?` for Ruby <2.4 compatibility (Fixes
   [#26](https://github.com/beezwax/fmrest-ruby/issues/26))
-* Deprecate `FmRest.config` in favor of `FmRest.default_connection_settings`
+* Deprecated `FmRest.config` in favor of `FmRest.default_connection_settings`
 * Honor Faraday SSL and proxy settings when fetching container files

data/README.md

@@ -125,6 +125,10 @@ 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:
@@ -149,6 +153,7 @@ 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`
@@ -283,10 +288,12 @@ Also, if not set, your model will try to use
 #### Connection settings overlays
 
 There may be cases where you want to use a different set of connection settings
-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.
+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.
 
 To solve this scenario, fmrest-ruby provides a way of defining thread-local and
 reversible connection settings overlays through
@@ -323,7 +330,7 @@ Requests a Data API session token using the connection settings in
 
 You normally don't need to use this method as fmrest-ruby will automatically
 request and store session tokens for you (provided that `:autologin` is
-`true`).
+`true` in the connection settings, which it is by default).
 
 ### FmRest::Layout.logout
 
@@ -452,6 +459,41 @@ field values on the database that model is configured for.
 See the [main document on setting global field values](docs/GlobalFields.md)
 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.
+
+```ruby
+class BeeBase < FmRest::Layout
+  include FmRest::Spyke::Model::Rescuable
+
+  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
+end
+```
+
+Since `Rescuable` uses `ActiveSupport::Rescuable` internally, you may want to
+check [Rails'
+documentation](https://api.rubyonrails.org/classes/ActiveSupport/Rescuable/ClassMethods.html)
+too for details on how it works.
+
+One caveat of using `rescue_from` is that it always catches exceptions at the
+class level, so if you pass a method name to `with:` that method has to be a
+class method. Also note that this will only catch exceptions raised during an
+API call to the Data API server (in other words, only on actions that perform
+an HTTP request).
+
 ## Logging
 
 If using `fmrest-spyke` with Rails then pretty log output will be set up for
@@ -501,6 +543,10 @@ class LoggyBee < FmRest::Layout
 end
 ```
 
+## Gotchas
+
+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/
@@ -510,7 +556,7 @@ FM Data API reference: https://fmhelp.filemaker.com/docs/18/en/dataapi/
 | 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 a FileMaker ID account | No                            | No                          |
+| Log in using Claris ID account      | Yes                           | Yes                         |
 | Log out                             | Yes                           | Yes                         |
 | Get product information             | Manual*                       | No                          |
 | Get database names                  | Manual*                       | No                          |

data/lib/fmrest/connection_settings.rb

@@ -18,6 +18,7 @@ module FmRest
       database
       username
       password
+      fmid_token
       token
       token_store
       autologin
@@ -69,13 +70,12 @@ module FmRest
 
     PROPERTIES.each do |p|
       define_method(p) do
-        get(p)
+        get_eval(p)
       end
 
       define_method("#{p}!") do
-        r = get(p)
-        raise MissingSetting, "Missing required setting: `#{p}'" if r.nil?
-        r
+        raise MissingSetting, "Missing required setting: `#{p}'" if get(p).nil?
+        get_eval(p)
       end
 
       define_method("#{p}?") do
@@ -85,7 +85,7 @@ module FmRest
 
     def [](key)
       raise ArgumentError, "Unknown setting `#{key}'" unless PROPERTIES.include?(key.to_sym)
-      get(key)
+      get_eval(key)
     end
 
     def to_h
@@ -104,13 +104,18 @@ module FmRest
       missing = REQUIRED.select { |r| get(r).nil? }.map { |m| "`#{m}'" }
       raise MissingSetting, "Missing required setting(s): #{missing.join(', ')}" unless missing.empty?
 
-      unless username? || token?
-        raise MissingSetting, "A minimum of `username' or `token' are required to be able to establish a connection"
+      unless username? || fmid_token? || token?
+        raise MissingSetting, "A minimum of `username', `fmid_token' or `token' are required to be able to establish a connection"
       end
     end
 
     private
 
+    def get_eval(key)
+      c = get(key)
+      c.kind_of?(Proc) ? c.call : c
+    end
+
     def get(key)
       return @settings[key.to_sym] if @settings.has_key?(key.to_sym)
       return @settings[key.to_s] if @settings.has_key?(key.to_s)

data/lib/fmrest/v1/auth.rb

@@ -3,6 +3,8 @@
 module FmRest
   module V1
     module Auth
+      ACCESS_TOKEN_HEADER = "X-FM-Data-Access-Token"
+
       # Requests a token through basic auth
       #
       # @param connection [Faraday] the auth connection to use for
@@ -23,7 +25,7 @@ module FmRest
       # @raise [FmRest::APIError::AccountError] if authentication failed
       def request_auth_token!(connection = FmRest.V1.auth_connection)
         resp = connection.post(V1.session_path)
-        resp.body["response"]["token"]
+        resp.headers[ACCESS_TOKEN_HEADER] || resp.body["response"]["token"]
       end
     end
   end

data/lib/fmrest/v1/connection.rb

@@ -9,6 +9,7 @@ module FmRest
       DATABASES_PATH = "#{BASE_PATH}/databases"
 
       AUTH_HEADERS = { "Content-Type" => "application/json" }.freeze
+      CLARIS_ID_HTTP_AUTH_TYPE = "FMID"
 
       # Builds a complete DAPI Faraday connection with middleware already
       # configured to handle authentication, JSON parsing, logging and DAPI
@@ -58,7 +59,11 @@ module FmRest
         base_connection(settings, { headers: AUTH_HEADERS }) do |conn|
           conn.use RaiseErrors
 
-          conn.basic_auth settings.username!, settings.password!
+          if settings.fmid_token?
+            conn.authorization CLARIS_ID_HTTP_AUTH_TYPE, settings.fmid_token
+          else
+            conn.basic_auth settings.username!, settings.password!
+          end
 
           if settings.log
             conn.response :logger, FmRest.logger, bodies: true, headers: true, log_level: settings.log_level

data/lib/fmrest/v1/token_session.rb

@@ -100,7 +100,13 @@ module FmRest
             # Strip the host part to just the hostname (i.e. no scheme or port)
             host = @settings.host!
             host = URI(host).hostname if host =~ /\Ahttps?:\/\//
-            "#{host}:#{@settings.database!}:#{@settings.username!}"
+            identity_segment = if fmid_token = @settings.fmid_token
+                                 require "digest"
+                                 Digest::SHA256.hexdigest(fmid_token)
+                               else
+                                 @settings.username!
+                               end
+            "#{host}:#{@settings.database!}:#{identity_segment}"
           end
       end
 

data/lib/fmrest/v1/utils.rb

@@ -8,6 +8,8 @@ module FmRest
       # See https://help.claris.com/en/pro-help/content/finding-text.html
       FM_FIND_OPERATORS_RE = /([@\*#\?!=<>"])/
 
+      FULLY_QUALIFIED_FIELD_NAME_MATCHER = /\A[^:]+::[^:]+\Z/.freeze
+
       # Converts custom script options to a hash with the Data API's expected
       # JSON script format.
       #
@@ -104,6 +106,18 @@ module FmRest
         s.gsub(FM_FIND_OPERATORS_RE, "\\\\\\1")
       end
 
+      # Returns whether the given FileMaker field name is a fully-qualified
+      # name. In other words, whether it contains the string "::".
+      #
+      # Note that this is a simple naive check which doesn't account for
+      # invalid field names.
+      #
+      # @param field_name [String] The field name to test
+      # @return [Boolean] Whether the field is a FQN
+      def is_fully_qualified?(field_name)
+        FULLY_QUALIFIED_FIELD_NAME_MATCHER === field_name.to_s
+      end
+
       private
 
       def convert_script_arguments(script_arguments, suffix = nil)

data/lib/fmrest/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fmrest-core
 version: !ruby/object:Gem::Version
-  version: 0.16.0
+  version: 0.18.0.rc1
 platform: ruby
 authors:
 - Pedro Carbajal
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-04-14 00:00:00.000000000 Z
+date: 2021-09-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -104,11 +104,11 @@ 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.0.6
+rubygems_version: 3.2.3
 signing_key:
 specification_version: 4
 summary: FileMaker Data API client using Faraday, core library