fmrest-core 0.17.0 → 0.18.0.rc3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6ba93e217eb5159973fc3e82d06c9cfd395f9f2d1bd4cee1bc0f193f661303f1
-  data.tar.gz: 151da1d88185b7a12b23bd7e8067a52ca7209fb729367682789c9c26d29808f2
+  metadata.gz: 9070ffa50e9886a1c1a46c91575c3252469ea22423bbc0658d0b4c86f325c1ac
+  data.tar.gz: 29b2bfef12c6352492aa3fbb5f19031aaf263e39dacc3e334bf6470df07de7e7
 SHA512:
-  metadata.gz: 06ded09ca8619ae8428ec534355d61f6aaca6076aa2ff7d341e6f8ce0464c50d0568b8006512eec25d3afad9591cec06adc39a9da1f2813323a116fcee7e6a0d
-  data.tar.gz: 96dc882fc26b359a7a91ce547de4f6e25b050f9e1a201c69b447e9a3677709ee49c1f113739f431d86cb1701a7603dd490756ac467332648a0562fc33b79f822
+  metadata.gz: 65ea5b666e2debed130714df05a9275e991e8127d17d44dbee94a4651a05394472ab1381e1bbf35551648234a6d3c6c174fcc4fe8025ec45148bcc27a5aef495
+  data.tar.gz: bfdc063f4701eb03ed3f8e2edc7c9b2131cb6cc82175c88462debdd67891050fd53dfa160f47f35323809d6860d4a89ec341d8116791cae6d4e69b900b7715af

data/CHANGELOG.md

@@ -1,5 +1,18 @@
 ## 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
+* Added fmrest-ruby/VERSION to User-Agent headers
+
+### 0.17.1
+
+* Fixed crash when `fmid_token` is set but `username` isn't
+
 ### 0.17.0
 
 * Added support for Claris ID token login

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
 
@@ -56,13 +57,13 @@ 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

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,

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fmrest-core
 version: !ruby/object:Gem::Version
-  version: 0.17.0
+  version: 0.18.0.rc3
 platform: ruby
 authors:
 - Pedro Carbajal
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-08-05 00:00:00.000000000 Z
+date: 2021-09-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -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: