fmrest 0.8.0 → 0.11.1

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/raise_errors.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require "fmrest/errors"
-
 module FmRest
   module V1
     # FM Data API response middleware for raising exceptions on API response
@@ -23,9 +21,11 @@ module FmRest
         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

data/lib/fmrest/v1/token_session.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require "fmrest/v1/connection"
-require "fmrest/errors"
 
 module FmRest
   module V1
@@ -10,15 +9,15 @@ module FmRest
     class TokenSession < Faraday::Middleware
       class NoSessionTokenSet < FmRest::Error; end
 
-      HEADER_KEY = "Authorization".freeze
+      HEADER_KEY = "Authorization"
       TOKEN_STORE_INTERFACE = [:load, :store, :delete].freeze
       LOGOUT_PATH_MATCHER = %r{\A(#{FmRest::V1::Connection::BASE_PATH}/[^/]+/sessions/)[^/]+\Z}.freeze
 
       # @param app [#call]
-      # @param options [Hash]
-      def initialize(app, options = FmRest.default_connection_settings)
+      # @param settings [FmRest::ConnectionSettings]
+      def initialize(app, settings)
         super(app)
-        @options = options
+        @settings = settings
       end
 
       # Entry point for the middleware when sending a request
@@ -32,27 +31,37 @@ module FmRest
 
         @app.call(env).on_complete do |response_env|
           if response_env[:status] == 401 # Unauthorized
-            env[:body] = request_body
-            token_store.delete(token_store_key)
-            set_auth_header(env)
-            return @app.call(env)
+            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 = token_store.load(token_store_key)
+        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|
-          if response_env[:status] == 200
-            token_store.delete(token_store_key)
-          end
+          delete_token_store_key if response_env[:status] == 200
         end
       end
 
@@ -65,43 +74,33 @@ module FmRest
         env.request_headers[HEADER_KEY] = "Bearer #{token}"
       end
 
-      # Tries to get an existing token from the token store,
+      # 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
 
-        if token = request_token
-          token_store.store(token_store_key, token)
-          return token
-        end
+        return nil unless @settings.autologin
 
-        # TODO: Make this a custom exception class
-        raise "Filemaker auth failed"
+        token = V1.request_auth_token!(auth_connection)
+        token_store.store(token_store_key, token)
+        token
       end
 
-      # Requests a token through basic auth
-      #
-      def request_token
-        resp = auth_connection.post do |req|
-          req.url V1.session_path
-          req.headers["Content-Type"] = "application/json"
-        end
-        return resp.body["response"]["token"] if resp.success?
-        false
-      end
-
-      # The key to use to store a token, uses the format host:database
+      # 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 = @options.fetch(:host)
+            host = @settings.host!
             host = URI(host).hostname if host =~ /\Ahttps?:\/\//
-            "#{host}:#{@options.fetch(:database)}"
+            "#{host}:#{@settings.database!}:#{@settings.username!}"
           end
       end
 
@@ -111,31 +110,23 @@ module FmRest
             if TOKEN_STORE_INTERFACE.all? { |method| token_store_option.respond_to?(method) }
               token_store_option
             elsif token_store_option.kind_of?(Class)
-              token_store_option.new
+              if token_store_option.respond_to?(:instance)
+                token_store_option.instance
+              else
+                token_store_option.new
+              end
             else
-              require "fmrest/token_store/memory"
-              TokenStore::Memory.new
+              FmRest::TokenStore::Memory.new
             end
           end
       end
 
       def token_store_option
-        @options[:token_store] || FmRest.token_store
+        @settings.token_store || FmRest.token_store
       end
 
       def auth_connection
-        @auth_connection ||= V1.base_connection(@options) do |conn|
-          username = @options.fetch(:account_name) { @options.fetch(:username) }
-
-          conn.basic_auth username, @options.fetch(:password)
-
-          if @options[:log]
-            conn.response :logger, nil, bodies: true, headers: true
-          end
-
-          conn.response :json
-          conn.adapter Faraday.default_adapter
-        end
+        @auth_connection ||= V1.auth_connection(@settings)
       end
     end
   end

data/lib/fmrest/v1/type_coercer.rb

@@ -5,17 +5,18 @@ require "fmrest/string_date"
 module FmRest
   module V1
     class TypeCoercer < Faraday::Response::Middleware
-      # We use this date to represent a time for consistency with ginjo-rfm
+      # 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 options [Hash]
-      def initialize(app, options = FmRest.default_connection_settings)
+      # @param settings [FmRest::ConnectionSettings]
+      def initialize(app, settings)
         super(app)
-        @options = options
+        @settings = settings
       end
 
       def on_complete(env)
@@ -30,15 +31,13 @@ module FmRest
           field_data = record["fieldData"] || record[:fieldData]
           portal_data = record["portalData"] || record[:portalData]
 
-          # Build an enumerator that iterates over hashes of fields
-          enum = Enumerator.new { |y| y << field_data }
-          if portal_data
-            portal_data.each_value do |portal_records|
-              enum += portal_records.to_enum
+          coerce_fields(field_data)
+
+          portal_data.try(:each_value) do |portal_records|
+            portal_records.each do |pr|
+              coerce_fields(pr)
             end
           end
-
-          enum.each { |hash| coerce_fields(hash) }
         end
       end
 
@@ -49,29 +48,49 @@ module FmRest
           next unless v.is_a?(String)
           next if k == "recordId" || k == :recordId || k == "modId" || k == :modId
 
-          begin
-            str_timestamp = datetime_class.strptime(v, datetime_format)
-            hash[k] = str_timestamp
-            next
-          rescue ArgumentError
+          if quick_check_timestamp(v)
+            begin
+              hash[k] = coerce_timestamp(v)
+              next
+            rescue ArgumentError
+            end
           end
 
-          begin
-            str_date = date_class.strptime(v, date_format)
-            hash[k] = str_date
-            next
-          rescue ArgumentError
+          if quick_check_date(v)
+            begin
+              hash[k] = date_class.strptime(v, date_strptime_format)
+              next
+            rescue ArgumentError
+            end
           end
 
-          begin
-            str_time = datetime_class.strptime("#{JULIAN_ZERO_DAY} #{v}", time_format)
-            hash[k] = str_time
-            next
-          rescue ArgumentError
+          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
@@ -92,23 +111,79 @@ module FmRest
           end
       end
 
-      def date_format
-        @date_format ||=
-          FmRest::V1.convert_date_time_format(@options[:date_format] || DEFAULT_DATE_FORMAT)
+      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 datetime_format
-        @datetime_format ||=
-          FmRest::V1.convert_date_time_format(@options[:timestamp_format] || DEFAULT_TIMESTAMP_FORMAT)
+      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 time_format
-        @time_format ||=
-          "%Y/%m/%d " + FmRest::V1.convert_date_time_format(@options[:time_format] || DEFAULT_TIME_FORMAT)
+      def local_timezone?
+        @local_timezone ||= @settings.timezone.try(:to_sym) == :local
       end
 
       def coerce_dates
-        @options.fetch(:coerce_dates, false)
+        @settings.coerce_dates
       end
 
       alias_method :enabled?, :coerce_dates