fmrest-core 0.17.1 → 0.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4fe47fc97c28e7098accafef4a2974e959f8f910619fdec2177abb8048a9cf53
-  data.tar.gz: 4439686866ddd5023f98b8d1651992fbb068e36b0872d47d66923303c2eeaee7
+  metadata.gz: fdfc316e5474cc3abbf196051aa48846f6b04452e0864a320445079a09a3f449
+  data.tar.gz: d23a6c290f33ab9c43f149de58af85825859aae9f0bc781200395bc883f66009
 SHA512:
-  metadata.gz: f0d1c9af0e393ac39c7a4625afcf1301d9756116e511baf80f313cff15ffaa75bf1e4fbbbad60d548a8fe4101bfad59704aa0d40e08a334881cfec68ad823d7f
-  data.tar.gz: c1e372106b999c00d93d83e8ae14ef5bf06b094c6c53eabca44ee7d56d1f1f67114614d0adc323c5b4b817494be14a5f25518e57a392f21c73aafa1130fe59f0
+  metadata.gz: 48ddb1505f075011675b5bfbeb437d42e70dff62912a6c44b0ac454c205332e8e61da6a628c0ae0cda095214d54dded125f8f98fa0af711d2e8e34b1d24332e1
+  data.tar.gz: 16623334ee707adb60e479d6db8bff23f22aa23cac397e32b839d4dceaa7aed4a2e94558684d08b1eaaa1fb008093b9628014a73b8b7dbe93f3d2cd1bc3498fc

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 ## Changelog
 
+### 0.18.0
+
+* Better support for portals with mismatching field qualifiers
+* Better ergonomics for script execution, improved documentation
+* Defining an attribute on a model that would collide with an existing method
+  now raises an error
+* Cleared Faraday deprecation messages on authentication methods
+* Handle FileMaker Cloud case where HTTP 401 Unauthorized with content-type
+  text/html is returned after token expiry
+* Add retry option to Rescuable mixin
+* Added fmrest-ruby/VERSION to User-Agent headers
+
 ### 0.17.1
 
 * Fixed crash when `fmid_token` is set but `username` isn't

data/README.md

@@ -543,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/

data/lib/fmrest/v1/connection.rb

@@ -8,7 +8,8 @@ module FmRest
       BASE_PATH = "/fmi/data/v1"
       DATABASES_PATH = "#{BASE_PATH}/databases"
 
-      AUTH_HEADERS = { "Content-Type" => "application/json" }.freeze
+      DEFAULT_HEADERS = { "User-Agent" => "fmrest-ruby/#{::FmRest::VERSION} Faraday/#{::Faraday::VERSION}" }.freeze
+      AUTH_CONNECTION_HEADERS = DEFAULT_HEADERS.merge("Content-Type" => "application/json").freeze
       CLARIS_ID_HTTP_AUTH_TYPE = "FMID"
 
       # Builds a complete DAPI Faraday connection with middleware already
@@ -21,7 +22,7 @@ module FmRest
       def build_connection(settings = FmRest.default_connection_settings, &block)
         settings = ConnectionSettings.wrap(settings)
 
-        base_connection(settings) do |conn|
+        base_connection(settings, headers: DEFAULT_HEADERS) do |conn|
           conn.use RaiseErrors
           conn.use TokenSession, settings
 
@@ -38,7 +39,7 @@ module FmRest
             yield conn, settings
           else
             conn.use TypeCoercer, settings
-            conn.response :json
+            conn.response :json, content_type: /\bjson$/
           end
 
           if settings.log
@@ -56,20 +57,20 @@ module FmRest
       def auth_connection(settings = FmRest.default_connection_settings)
         settings = ConnectionSettings.wrap(settings)
 
-        base_connection(settings, { headers: AUTH_HEADERS }) do |conn|
+        base_connection(settings, headers: AUTH_CONNECTION_HEADERS) do |conn|
           conn.use RaiseErrors
 
           if settings.fmid_token?
-            conn.authorization CLARIS_ID_HTTP_AUTH_TYPE, settings.fmid_token
+            conn.request :authorization, CLARIS_ID_HTTP_AUTH_TYPE, settings.fmid_token
           else
-            conn.basic_auth settings.username!, settings.password!
+            conn.request :basic_auth, settings.username!, settings.password!
           end
 
           if settings.log
             conn.response :logger, FmRest.logger, bodies: true, headers: true, log_level: settings.log_level
           end
 
-          conn.response :json
+          conn.response :json, content_type: /\bjson$/
           conn.adapter Faraday.default_adapter
         end
       end

data/lib/fmrest/v1/raise_errors.rb

@@ -5,10 +5,9 @@ module FmRest
     # FM Data API response middleware for raising exceptions on API response
     # errors
     #
-    # https://fmhelp.filemaker.com/help/17/fmp/en/index.html#page/FMP_Help/error-codes.html
-    #
     class RaiseErrors < Faraday::Response::Middleware
-      # https://fmhelp.filemaker.com/help/17/fmp/en/index.html#page/FMP_Help/error-codes.html
+      # Error codes reference:
+      # https://help.claris.com/en/pro-help/content/error-codes.html
       ERROR_RANGES = {
         -1         => APIError::UnknownError,
         100        => APIError::ResourceMissingError,
@@ -28,6 +27,17 @@ module FmRest
       }.freeze
 
       def on_complete(env)
+        # Sometimes, especially when using FileMaker Cloud, a failed
+        # authorization request will return a 401 (Unauthorized) with text/html
+        # content-type instead of the regular JSON, so we need to catch it
+        # manually here, emulating a regular account error
+        if !(/\bjson$/ === env.response_headers["content-type"]) && env.status == 401
+          raise FmRest::APIError::AccountError.new(212, "Authentication failed (HTTP 401: Unauthorized)")
+        end
+
+        # From this point on we want JSON
+        return unless env.body.is_a?(Hash)
+
         # Sniff for either straight JSON parsing or Spyke's format
         if env.body[:metadata] && env.body[:metadata][:messages]
           check_errors(env.body[:metadata][:messages])

data/lib/fmrest/v1/token_session.rb

@@ -132,7 +132,10 @@ module FmRest
       end
 
       def auth_connection
-        @auth_connection ||= V1.auth_connection(@settings)
+        # NOTE: this is purposely not memoized so that settings can be
+        # refreshed (since proc-based settings will not be automatically
+        # re-eval'd, for example for fmid_token-based auth)
+        V1.auth_connection(@settings)
       end
     end
   end

data/lib/fmrest/v1/type_coercer.rb

@@ -21,7 +21,7 @@ module FmRest
 
       def on_complete(env)
         return unless enabled?
-        return unless env.body.kind_of?(Hash)
+        return unless env.body.is_a?(Hash)
 
         data = env.body.dig("response", "data") || env.body.dig(:response, :data)
 

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.17.1"
+  VERSION = "0.18.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fmrest-core
 version: !ruby/object:Gem::Version
-  version: 0.17.1
+  version: 0.18.0
 platform: ruby
 authors:
 - Pedro Carbajal
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-08-29 00:00:00.000000000 Z
+date: 2021-09-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday