fmrest-core 0.13.0

data/lib/fmrest/v1/dates.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+module FmRest
+  module V1
+    module Dates
+      FM_DATETIME_FORMAT_MATCHER = /MM|mm|dd|HH|ss|yyyy/.freeze
+
+      FM_DATE_TO_STRPTIME_SUBSTITUTIONS = {
+        "MM"   => "%m",
+        "dd"   => "%d",
+        "yyyy" => "%Y",
+        "HH"   => "%H",
+        "mm"   => "%M",
+        "ss"   => "%S"
+      }.freeze
+
+      FM_DATE_TO_REGEXP_SUBSTITUTIONS = {
+        "MM"   => '(?:0[1-9]|1[012])',
+        "dd"   => '(?:0[1-9]|[12][0-9]|3[01])',
+        "yyyy" => '\d{4}',
+        "HH"   => '(?:[01]\d|2[0123])',
+        "mm"   => '[0-5]\d',
+        "ss"   => '[0-5]\d'
+      }.freeze
+
+      def self.extended(mod)
+        mod.instance_eval do
+          @date_strptime = {}
+          @date_regexp = {}
+        end
+      end
+
+      # Converts a FM date-time format to `DateTime.strptime` format
+      #
+      # @param fm_format [String] The FileMaker date-time format
+      # @return [String] The `DateTime.strpdate` equivalent of the given FM
+      #   date-time format
+      def fm_date_to_strptime_format(fm_format)
+        @date_strptime[fm_format] ||=
+          fm_format.gsub(FM_DATETIME_FORMAT_MATCHER, FM_DATE_TO_STRPTIME_SUBSTITUTIONS).freeze
+      end
+
+      # Converts a FM date-time format to a Regexp. This is mostly used a
+      # quicker way of checking whether a FM field is a date field than
+      # Date|DateTime.strptime
+      #
+      # @param fm_format [String] The FileMaker date-time format
+      # @return [Regexp] A reegular expression matching strings in the given FM
+      #   date-time format
+      def fm_date_to_regexp(fm_format)
+        @date_regexp[fm_format] ||= 
+          Regexp.new('\A' + fm_format.gsub(FM_DATETIME_FORMAT_MATCHER, FM_DATE_TO_REGEXP_SUBSTITUTIONS) + '\Z').freeze
+      end
+
+      # Takes a DateTime dt, and returns the correct local offset for that dt,
+      # daylight savings included, in fraction of a day.
+      #
+      # By default, if ActiveSupport's Time.zone is set it will be used instead
+      # of the system timezone.
+      #
+      # @param dt [DateTime] The DateTime to get the offset for
+      # @param zone [nil, String, TimeZone] The timezone to use to calculate
+      #   the offset (defaults to system timezone, or ActiveSupport's Time.zone
+      #   if set)
+      # @return [Rational] The offset in fraction of a day
+      def local_offset_for_datetime(dt, zone = nil)
+        dt = dt.new_offset(0)
+        time = ::Time.utc(dt.year, dt.month, dt.day, dt.hour, dt.min, dt.sec)
+
+        # Do we have ActiveSupport's TimeZone?
+        time = if time.respond_to?(:in_time_zone)
+                 time.in_time_zone(zone || ::Time.zone)
+               else
+                 time.localtime
+               end
+
+        Rational(time.utc_offset, 86400) # seconds in one day (24*60*60)
+      end
+    end
+  end
+end

data/lib/fmrest/v1/paths.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module FmRest
+  module V1
+    module Paths
+      def session_path(token = nil)
+        url = "sessions"
+        url += "/#{token}" if token
+        url
+      end
+
+      def record_path(layout, id = nil)
+        url = "layouts/#{V1.url_encode(layout)}/records"
+        url += "/#{id}" if id
+        url
+      end
+
+      def container_field_path(layout, id, field_name, field_repetition = 1)
+        url = record_path(layout, id)
+        url += "/containers/#{V1.url_encode(field_name)}"
+        url += "/#{field_repetition}" if field_repetition
+        url
+      end
+
+      def find_path(layout)
+        "layouts/#{V1.url_encode(layout)}/_find"
+      end
+
+      def script_path(layout, script)
+        "layouts/#{V1.url_encode(layout)}/script/#{V1.url_encode(script)}"
+      end
+
+      def globals_path
+        "globals"
+      end
+
+      def product_info_path
+        "#{V1::Connection::BASE_PATH}/productInfo"
+      end
+    end
+  end
+end

data/lib/fmrest/v1/raise_errors.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module FmRest
+  module V1
+    # 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_RANGES = {
+        -1         => APIError::UnknownError,
+        100        => APIError::ResourceMissingError,
+        101        => APIError::RecordMissingError,
+        102..199   => APIError::ResourceMissingError,
+        200..299   => APIError::AccountError,
+        300..399   => APIError::LockError,
+        400        => APIError::ParameterError,
+        401        => APIError::NoMatchingRecordsError,
+        402..499   => APIError::ParameterError,
+        500..599   => APIError::ValidationError,
+        800..899   => APIError::SystemError,
+        952        => APIError::InvalidToken,
+        953        => APIError::MaximumDataAPICallsExceeded,
+        1200..1299 => APIError::ScriptError,
+        1400..1499 => APIError::ODBCError
+      }.freeze
+
+      def on_complete(env)
+        # Sniff for either straight JSON parsing or Spyke's format
+        if env.body[:metadata] && env.body[:metadata][:messages]
+          check_errors(env.body[:metadata][:messages])
+        elsif env.body["messages"]
+          check_errors(env.body["messages"])
+        end
+      end
+
+      private
+
+      def check_errors(messages)
+        messages.each do |message|
+          error_code = (message["code"] || message[:code]).to_i
+
+          # Code 0 means "No Error"
+          next if error_code.zero?
+
+          error_message = message["message"] || message[:message]
+
+          *, exception_class = ERROR_RANGES.find { |k, v| k === error_code }
+
+          raise (exception_class || APIError).new(error_code, error_message)
+        end
+      end
+    end
+  end
+end

data/lib/fmrest/v1/token_session.rb

@@ -0,0 +1,133 @@
+# frozen_string_literal: true
+
+require "fmrest/v1/connection"
+
+module FmRest
+  module V1
+    # FM Data API authentication middleware using the credentials strategy
+    #
+    class TokenSession < Faraday::Middleware
+      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]
+      # @param settings [FmRest::ConnectionSettings]
+      def initialize(app, settings)
+        super(app)
+        @settings = settings
+      end
+
+      # Entry point for the middleware when sending a request
+      #
+      def call(env)
+        return handle_logout(env) if is_logout_request?(env)
+
+        set_auth_header(env)
+
+        request_body = env[:body] # After failure env[:body] is set to the response body
+
+        @app.call(env).on_complete do |response_env|
+          if response_env[:status] == 401 # Unauthorized
+            delete_token_store_key
+
+            if @settings.autologin
+              env[:body] = request_body
+              set_auth_header(env)
+              return @app.call(env)
+            end
+          end
+        end
+      end
+
+      private
+
+      def delete_token_store_key
+        token_store.delete(token_store_key)
+        # Sometimes we may want to pass the :token in settings manually, and
+        # refrain from passing a :username. In that case the call to
+        # #token_store_key above would fail as it tries to fetch :username, so
+        # we purposely ignore that error.
+      rescue FmRest::ConnectionSettings::MissingSetting
+      end
+
+      def handle_logout(env)
+        token = @settings.token? ? @settings.token : token_store.load(token_store_key)
+
+        raise NoSessionTokenSet, "Couldn't send logout request because no session token was set" unless token
+
+        env.url.path = env.url.path.gsub(LOGOUT_PATH_MATCHER, "\\1#{token}")
+
+        @app.call(env).on_complete do |response_env|
+          delete_token_store_key if response_env[:status] == 200
+        end
+      end
+
+      def is_logout_request?(env)
+        return false unless env.method == :delete
+        return env.url.path.match?(LOGOUT_PATH_MATCHER)
+      end
+
+      def set_auth_header(env)
+        env.request_headers[HEADER_KEY] = "Bearer #{token}"
+      end
+
+      # Uses the token given in connection settings if available,
+      # otherwisek tries to get an existing token from the token store,
+      # otherwise requests one through basic auth,
+      # otherwise raises an exception.
+      #
+      def token
+        return @settings.token if @settings.token?
+
+        token = token_store.load(token_store_key)
+        return token if token
+
+        return nil unless @settings.autologin
+
+        token = V1.request_auth_token!(auth_connection)
+        token_store.store(token_store_key, token)
+        token
+      end
+
+      # The key to use to store a token, uses the format host:database:username
+      #
+      def token_store_key
+        @token_store_key ||=
+          begin
+            # 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!}"
+          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
+
+      def auth_connection
+        @auth_connection ||= V1.auth_connection(@settings)
+      end
+    end
+  end
+end

data/lib/fmrest/v1/token_store/active_record.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+warn "FmRest::V1::TokenStore::ActiveRecord is deprecated, use FmRest::TokenStore::ActiveRecord instead"
+
+require "fmrest/token_store/active_record"
+
+module FmRest
+  module V1
+    module TokenStore
+      ActiveRecord = ::FmRest::TokenStore::ActiveRecord
+    end
+  end
+end

data/lib/fmrest/v1/token_store/memory.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+warn "FmRest::V1::TokenStore::Memory is deprecated, use FmRest::TokenStore::Memory instead"
+
+require "fmrest/token_store/memory"
+
+module FmRest
+  module V1
+    module TokenStore
+      Memory = ::FmRest::TokenStore::Memory
+    end
+  end
+end

data/lib/fmrest/v1/type_coercer.rb

@@ -0,0 +1,192 @@
+# frozen_string_literal: true
+
+require "fmrest/string_date"
+
+module FmRest
+  module V1
+    class TypeCoercer < Faraday::Response::Middleware
+      # We use this date to represent a FileMaker time for consistency with
+      # ginjo-rfm
+      JULIAN_ZERO_DAY = "-4712/1/1"
+
+      COERCE_HYBRID = [:hybrid, "hybrid", true].freeze
+      COERCE_FULL = [:full, "full"].freeze
+
+      # @param app [#call]
+      # @param settings [FmRest::ConnectionSettings]
+      def initialize(app, settings)
+        super(app)
+        @settings = settings
+      end
+
+      def on_complete(env)
+        return unless enabled?
+        return unless env.body.kind_of?(Hash)
+
+        data = env.body.dig("response", "data") || env.body.dig(:response, :data)
+
+        return unless data
+
+        data.each do |record|
+          field_data = record["fieldData"] || record[:fieldData]
+          portal_data = record["portalData"] || record[:portalData]
+
+          coerce_fields(field_data)
+
+          portal_data.try(:each_value) do |portal_records|
+            portal_records.each do |pr|
+              coerce_fields(pr)
+            end
+          end
+        end
+      end
+
+      private
+
+      def coerce_fields(hash)
+        hash.each do |k, v|
+          next unless v.is_a?(String)
+          next if k == "recordId" || k == :recordId || k == "modId" || k == :modId
+
+          if quick_check_timestamp(v)
+            begin
+              hash[k] = coerce_timestamp(v)
+              next
+            rescue ArgumentError
+            end
+          end
+
+          if quick_check_date(v)
+            begin
+              hash[k] = date_class.strptime(v, date_strptime_format)
+              next
+            rescue ArgumentError
+            end
+          end
+
+          if quick_check_time(v)
+            begin
+              hash[k] = datetime_class.strptime("#{JULIAN_ZERO_DAY} #{v}", time_strptime_format)
+              next
+            rescue ArgumentError
+            end
+          end
+        end
+      end
+
+      def coerce_timestamp(str)
+        str_timestamp = DateTime.strptime(str, datetime_strptime_format)
+
+        if local_timezone?
+          # Change the DateTime to the local timezone, keeping the same
+          # time and just modifying the timezone
+          offset = FmRest::V1.local_offset_for_datetime(str_timestamp)
+          str_timestamp = str_timestamp.new_offset(offset) - offset
+        end
+
+        if datetime_class == StringDateTime
+          str_timestamp = StringDateTime.new(str, str_timestamp)
+        end
+
+        str_timestamp
+      end
+
+      def date_class
+        @date_class ||=
+          case coerce_dates
+          when *COERCE_HYBRID
+            StringDate
+          when *COERCE_FULL
+            Date
+          end
+      end
+
+      def datetime_class
+        @datetime_class ||=
+          case coerce_dates
+          when *COERCE_HYBRID
+            StringDateTime
+          when *COERCE_FULL
+            DateTime
+          end
+      end
+
+      def date_fm_format
+        @settings.date_format
+      end
+
+      def timestamp_fm_format
+        @settings.timestamp_format
+      end
+
+      def time_fm_format
+        @settings.time_format
+      end
+
+      def date_strptime_format
+        FmRest::V1.fm_date_to_strptime_format(date_fm_format)
+      end
+
+      def datetime_strptime_format
+        FmRest::V1.fm_date_to_strptime_format(timestamp_fm_format)
+      end
+
+      def time_strptime_format
+        @time_strptime_format ||=
+          "%Y/%m/%d " + FmRest::V1.fm_date_to_strptime_format(time_fm_format)
+      end
+
+      # We use a string length test, followed by regexp match test to try to
+      # identify date fields. Benchmarking shows this should be between 1 and 3
+      # orders of magnitude faster for fails (i.e. non-dates) than just using
+      # Date.strptime.
+      #
+      #                       user     system      total        real
+      # strptime:         0.268496   0.000962   0.269458 (  0.270865)
+      # re=~:             0.024872   0.000070   0.024942 (  0.025057)
+      # re.match?:        0.019745   0.000095   0.019840 (  0.020058)
+      # strptime fail:    0.141309   0.000354   0.141663 (  0.142266)
+      # re=~ fail:        0.031637   0.000095   0.031732 (  0.031872)
+      # re.match? fail:   0.011249   0.000056   0.011305 (  0.011375)
+      # length fail:      0.007177   0.000024   0.007201 (  0.007222)
+      #
+      # NOTE: The faster Regexp#match? was introduced in Ruby 2.4.0, so we
+      # can't really rely on it being available
+      if //.respond_to?(:match?)
+        def quick_check_timestamp(v)
+          v.length == timestamp_fm_format.length && FmRest::V1::fm_date_to_regexp(timestamp_fm_format).match?(v)
+        end
+
+        def quick_check_date(v)
+          v.length == date_fm_format.length && FmRest::V1::fm_date_to_regexp(date_fm_format).match?(v)
+        end
+
+        def quick_check_time(v)
+          v.length == time_fm_format.length && FmRest::V1::fm_date_to_regexp(time_fm_format).match?(v)
+        end
+      else
+        def quick_check_timestamp(v)
+          v.length == timestamp_fm_format.length && FmRest::V1::fm_date_to_regexp(timestamp_fm_format) =~ v
+        end
+
+        def quick_check_date(v)
+          v.length == date_fm_format.length && FmRest::V1::fm_date_to_regexp(date_fm_format) =~ v
+        end
+
+        def quick_check_time(v)
+          v.length == time_fm_format.length && FmRest::V1::fm_date_to_regexp(time_fm_format) =~ v
+        end
+      end
+
+      def local_timezone?
+        @local_timezone ||= @settings.timezone.try(:to_sym) == :local
+      end
+
+      def coerce_dates
+        @settings.coerce_dates
+      end
+
+      alias_method :enabled?, :coerce_dates
+    end
+  end
+end