fmrest 0.9.0 → 0.12.0

data/lib/fmrest/v1.rb

@@ -4,16 +4,20 @@ require "fmrest/v1/connection"
 require "fmrest/v1/paths"
 require "fmrest/v1/container_fields"
 require "fmrest/v1/utils"
+require "fmrest/v1/dates"
+require "fmrest/v1/auth"
 
 module FmRest
   module V1
-    DEFAULT_DATE_FORMAT = "MM/dd/yyyy"
-    DEFAULT_TIME_FORMAT = "HH:mm:ss"
-    DEFAULT_TIMESTAMP_FORMAT = "#{DEFAULT_DATE_FORMAT} #{DEFAULT_TIME_FORMAT}"
-
     extend Connection
     extend Paths
     extend ContainerFields
     extend Utils
+    extend Dates
+    extend Auth
+
+    autoload :TokenSession, "fmrest/v1/token_session"
+    autoload :RaiseErrors, "fmrest/v1/raise_errors"
+    autoload :TypeCoercer, "fmrest/v1/type_coercer"
   end
 end

data/lib/fmrest/v1/auth.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module FmRest
+  module V1
+    module Auth
+      # Requests a token through basic auth
+      #
+      # @param connection [Faraday] the auth connection to use for
+      #   the request
+      # @return The token if successful
+      # @return `false` if authentication failed
+      def request_auth_token(connection = FmRest::V1.auth_connection)
+        request_auth_token!(connection)
+      rescue FmRest::APIError::AccountError
+        false
+      end
+
+      # Requests a token through basic auth, raising
+      # `FmRest::APIError::AccountError` if auth fails
+      #
+      # @param (see #request_auth_token)
+      # @return The token if successful
+      # @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"]
+      end
+    end
+  end
+end

data/lib/fmrest/v1/connection.rb

@@ -7,21 +7,21 @@ module FmRest
     module Connection
       BASE_PATH = "/fmi/data/v1/databases"
 
+      AUTH_HEADERS = { "Content-Type" => "application/json" }.freeze
+
       # Builds a complete DAPI Faraday connection with middleware already
       # configured to handle authentication, JSON parsing, logging and DAPI
       # error handling. A block can be optionally given for additional
       # middleware configuration
       #
-      # @option options [String] :username The username for DAPI authentication
-      # @option options [String] :account_name Alias of :username for
-      #   compatibility with Rfm gem
-      # @option options [String] :password The password for DAPI authentication
       # @option (see #base_connection)
       # @return (see #base_connection)
-      def build_connection(options = FmRest.default_connection_settings, &block)
-        base_connection(options) do |conn|
+      def build_connection(settings = FmRest.default_connection_settings, &block)
+        settings = ConnectionSettings.wrap(settings)
+
+        base_connection(settings) do |conn|
           conn.use RaiseErrors
-          conn.use TokenSession, options
+          conn.use TokenSession, settings
 
           # The EncodeJson and Multipart middlewares only encode the request
           # when the content type matches, so we can have them both here and
@@ -33,13 +33,13 @@ module FmRest
 
           # Allow overriding the default response middleware
           if block_given?
-            yield conn, options
+            yield conn, settings
           else
-            conn.use TypeCoercer, options
+            conn.use TypeCoercer, settings
             conn.response :json
           end
 
-          if options[:log]
+          if settings.log
             conn.response :logger, nil, bodies: true, headers: true
           end
 
@@ -47,18 +47,46 @@ module FmRest
         end
       end
 
+      # Builds a Faraday connection to use for DAPI basic auth login
+      #
+      # @option (see #base_connection)
+      # @return (see #base_connection)
+      def auth_connection(settings = FmRest.default_connection_settings)
+        settings = ConnectionSettings.wrap(settings)
+
+        base_connection(settings, { headers: AUTH_HEADERS }) do |conn|
+          conn.use RaiseErrors
+
+          conn.basic_auth settings.username!, settings.password!
+
+          if settings.log
+            conn.response :logger, nil, bodies: true, headers: true
+          end
+
+          conn.response :json
+          conn.adapter Faraday.default_adapter
+        end
+      end
+
       # Builds a base Faraday connection with base URL constructed from
-      # connection options and passes it the given block
+      # connection settings and passes it the given block
       #
-      # @option options [String] :host The hostname for the FM server
-      # @option options [String] :database The FM database name
-      # @option options [String] :ssl SSL options to forward to the Faraday
+      # @option settings [String] :host The hostname for the FM server
+      # @option settings [String] :database The FM database name
+      # @option settings [String] :username The username for DAPI authentication
+      # @option settings [String] :account_name Alias of :username for
+      #   compatibility with Rfm gem
+      # @option settings [String] :password The password for DAPI authentication
+      # @option settings [String] :ssl SSL settings to forward to the Faraday
       #   connection
-      # @option options [String] :proxy Proxy options to forward to the Faraday
+      # @option settings [String] :proxy Proxy options to forward to the Faraday
       #   connection
+      # @param faraday_options [Hash] additional options for Faraday object
       # @return [Faraday] The new Faraday connection
-      def base_connection(options = FmRest.default_connection_settings, &block)
-        host = options.fetch(:host)
+      def base_connection(settings = FmRest.default_connection_settings, faraday_options = nil, &block)
+        settings = ConnectionSettings.wrap(settings)
+
+        host = settings.host!
 
         # Default to HTTPS
         scheme = "https"
@@ -70,12 +98,14 @@ module FmRest
           scheme = uri.scheme
         end
 
-        faraday_options = {}
-        faraday_options[:ssl] = options[:ssl] if options.key?(:ssl)
-        faraday_options[:proxy] = options[:proxy] if options.key?(:proxy)
+        faraday_options = (faraday_options || {}).dup
+        faraday_options[:ssl] = settings.ssl if settings.ssl?
+        faraday_options[:proxy] = settings.proxy if settings.proxy?
+
+        database = URI.encode_www_form_component(settings.database!)
 
         Faraday.new(
-          "#{scheme}://#{host}#{BASE_PATH}/#{URI.escape(options.fetch(:database))}/".freeze,
+          "#{scheme}://#{host}#{BASE_PATH}/#{database}/".freeze,
           faraday_options,
           &block
         )
@@ -83,7 +113,3 @@ module FmRest
     end
   end
 end
-
-require "fmrest/v1/token_session"
-require "fmrest/v1/raise_errors"
-require "fmrest/v1/type_coercer"

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