fmrest 0.8.0 → 0.11.1

data/lib/fmrest/errors.rb

@@ -21,6 +21,8 @@ module FmRest
   class APIError::NoMatchingRecordsError < APIError::ParameterError; end
   class APIError::ValidationError < APIError; end      # error codes 500..599
   class APIError::SystemError < APIError; end          # error codes 800..899
+  class APIError::InvalidToken < APIError; end         # error code 952
+  class APIError::MaximumDataAPICallsExceeded < APIError; end # error code 953
   class APIError::ScriptError < APIError; end          # error codes 1200..1299
   class APIError::ODBCError < APIError; end            # error codes 1400..1499
 

data/lib/fmrest/spyke/base.rb

@@ -8,6 +8,8 @@ module FmRest
 
     class << self
       def Base(config = nil)
+        warn "[DEPRECATION] Inheriting from `FmRest::Spyke::Base(config)` is deprecated and will be removed, inherit from `FmRest::Spyke::Base` (without arguments) and use `fmrest_config=` instead"
+
         if config
           return Class.new(::FmRest::Spyke::Base) do
                    self.fmrest_config = config

data/lib/fmrest/spyke/model.rb

@@ -7,6 +7,7 @@ require "fmrest/spyke/model/serialization"
 require "fmrest/spyke/model/associations"
 require "fmrest/spyke/model/orm"
 require "fmrest/spyke/model/container_fields"
+require "fmrest/spyke/model/global_fields"
 require "fmrest/spyke/model/http"
 require "fmrest/spyke/model/auth"
 
@@ -22,6 +23,7 @@ module FmRest
       include Associations
       include Orm
       include ContainerFields
+      include GlobalFields
       include Http
       include Auth
 

data/lib/fmrest/spyke/model/auth.rb

@@ -28,6 +28,14 @@ module FmRest
           rescue FmRest::V1::TokenSession::NoSessionTokenSet
             false
           end
+
+          def request_auth_token
+            FmRest::V1.request_auth_token(FmRest::V1.auth_connection(fmrest_config))
+          end
+
+          def request_auth_token!
+            FmRest::V1.request_auth_token!(FmRest::V1.auth_connection(fmrest_config))
+          end
         end
       end
     end

data/lib/fmrest/spyke/model/connection.rb

@@ -4,19 +4,70 @@ module FmRest
   module Spyke
     module Model
       module Connection
-        extend ::ActiveSupport::Concern
+        extend ActiveSupport::Concern
 
         included do
-          class_attribute :fmrest_config, instance_accessor: false, instance_predicate: false
-
           class_attribute :faraday_block, instance_accessor: false, instance_predicate: false
           class << self; private :faraday_block, :faraday_block=; end
 
-          # FM Data API expects PATCH for updates (Spyke's default was PUT)
+          # FM Data API expects PATCH for updates (Spyke's default is PUT)
           self.callback_methods = { create: :post, update: :patch }.freeze
         end
 
         class_methods do
+          def fmrest_config
+            if fmrest_config_overlay
+              return FmRest.default_connection_settings.merge(fmrest_config_overlay, skip_validation: true)
+            end
+
+            FmRest.default_connection_settings
+          end
+
+          # Behaves similar to ActiveSupport's class_attribute, redefining the
+          # reader method so it can be inherited and overwritten in subclasses
+          #
+          def fmrest_config=(settings)
+            settings = ConnectionSettings.new(settings, skip_validation: true)
+
+            redefine_singleton_method(:fmrest_config) do
+              overlay = fmrest_config_overlay
+              return settings.merge(overlay, skip_validation: true) if overlay
+              settings
+            end
+          end
+
+          # Allows overwriting some connection settings in a thread-local
+          # manner. Useful in the use case where you want to connect to the
+          # same database using different accounts (e.g. credentials provided
+          # by users in a web app context)
+          #
+          def fmrest_config_overlay=(settings)
+            Thread.current[fmrest_config_overlay_key] = settings
+          end
+
+          def fmrest_config_overlay
+            Thread.current[fmrest_config_overlay_key] || begin
+              superclass.fmrest_config_overlay
+            rescue NoMethodError
+              nil
+            end
+          end
+
+          def clear_fmrest_config_overlay
+            Thread.current[fmrest_config_overlay_key] = nil
+          end
+
+          def with_overlay(settings, &block)
+            Fiber.new do
+              begin
+                self.fmrest_config_overlay = settings
+                yield
+              ensure
+                self.clear_fmrest_config_overlay
+              end
+            end.resume
+          end
+
           def connection
             super || fmrest_connection
           end
@@ -38,26 +89,45 @@ module FmRest
           private
 
           def fmrest_connection
-            @fmrest_connection ||=
-              begin
-                config = fmrest_config || FmRest.default_connection_settings
+            memoize = false
+
+            # Don't memoize the connection if there's an overlay, since
+            # overlays are thread-local and so should be the connection
+            unless fmrest_config_overlay
+              return @fmrest_connection if @fmrest_connection
+              memoize = true
+            end
 
-                FmRest::V1.build_connection(config) do |conn|
-                  faraday_block.call(conn) if faraday_block
+            config = ConnectionSettings.wrap(fmrest_config)
 
-                  # Pass the class to SpykeFormatter's initializer so it can have
-                  # access to extra context defined in the model, e.g. a portal
-                  # where name of the portal and the attributes prefix don't match
-                  # and need to be specified as options to `portal`
-                  conn.use FmRest::Spyke::SpykeFormatter, self
+            connection =
+              FmRest::V1.build_connection(config) do |conn|
+                faraday_block.call(conn) if faraday_block
 
-                  conn.use FmRest::V1::TypeCoercer, config
+                # Pass the class to SpykeFormatter's initializer so it can have
+                # access to extra context defined in the model, e.g. a portal
+                # where name of the portal and the attributes prefix don't match
+                # and need to be specified as options to `portal`
+                conn.use FmRest::Spyke::SpykeFormatter, self
 
-                  # FmRest::Spyke::JsonParse expects symbol keys
-                  conn.response :json, parser_options: { symbolize_names: true }
-                end
+                conn.use FmRest::V1::TypeCoercer, config
+
+                # FmRest::Spyke::JsonParse expects symbol keys
+                conn.response :json, parser_options: { symbolize_names: true }
               end
+
+            @fmrest_connection = connection if memoize
+
+            connection
           end
+
+          def fmrest_config_overlay_key
+            :"#{object_id}.fmrest_config_overlay"
+          end
+        end
+
+        def fmrest_config
+          self.class.fmrest_config
         end
       end
     end

data/lib/fmrest/spyke/model/global_fields.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module FmRest
+  module Spyke
+    module Model
+      module GlobalFields
+        extend ::ActiveSupport::Concern
+
+        FULLY_QUALIFIED_FIELD_NAME_MATCHER = /\A[^:]+::[^:]+\Z/.freeze
+
+        class_methods do
+          def set_globals(values_hash)
+            connection.patch(FmRest::V1.globals_path, {
+              globalFields: normalize_globals_hash(values_hash)
+            })
+          end
+
+          private
+
+          def normalize_globals_hash(hash)
+            hash.each_with_object({}) do |(k, v), normalized|
+              if v.kind_of?(Hash)
+                v.each do |k2, v2|
+                  normalized["#{k}::#{k2}"] = v2
+                end
+                next
+              end
+
+              unless FULLY_QUALIFIED_FIELD_NAME_MATCHER === k.to_s
+                raise ArgumentError, "global fields must be given in fully qualified format (table name::field name)"
+              end
+
+              normalized[k] = v
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/fmrest/spyke/model/serialization.rb

@@ -4,8 +4,8 @@ module FmRest
   module Spyke
     module Model
       module Serialization
-        FM_DATE_FORMAT = "%m/%d/%Y".freeze
-        FM_DATETIME_FORMAT = "#{FM_DATE_FORMAT} %H:%M:%S".freeze
+        FM_DATE_FORMAT = "%m/%d/%Y"
+        FM_DATETIME_FORMAT = "#{FM_DATE_FORMAT} %H:%M:%S"
 
         # Override Spyke's to_params to return FM Data API's expected JSON
         # format, and including only modified fields
@@ -63,9 +63,9 @@ module FmRest
         def serialize_values!(params)
           params.transform_values! do |value|
             case value
-            when DateTime, Time
-              value.strftime(FM_DATETIME_FORMAT)
-            when Date
+            when *datetime_classes
+              convert_datetime_timezone(value.to_datetime).strftime(FM_DATETIME_FORMAT)
+            when *date_classes
               value.strftime(FM_DATE_FORMAT)
             else
               value
@@ -74,6 +74,25 @@ module FmRest
 
           params
         end
+
+        def convert_datetime_timezone(dt)
+          case fmrest_config.timezone
+          when :utc, "utc"
+            dt.new_offset(0)
+          when :local, "local"
+            dt.new_offset(FmRest::V1.local_offset_for_datetime(dt))
+          when nil
+            dt
+          end
+        end
+
+        def datetime_classes
+          [DateTime, Time, defined?(FmRest::StringDateTime) && FmRest::StringDateTime].compact
+        end
+
+        def date_classes
+          [Date, defined?(FmRest::StringDate) && FmRest::StringDate].compact
+        end
       end
     end
   end

data/lib/fmrest/string_date.rb

@@ -79,17 +79,24 @@ module FmRest
     class InvalidDate < ArgumentError; end
 
     class << self
-      alias_method :strptime, :new
+      def strptime(str, date_format, *_)
+        begin
+          date = self::DELEGATE_CLASS.strptime(str, date_format)
+        rescue ArgumentError
+          raise InvalidDate
+        end
+
+        new(str, date)
+      end
     end
 
-    def initialize(str, date_format, **str_args)
+    def initialize(str, date, **str_args)
+      raise ArgumentError, "str must be of class String" unless str.is_a?(String)
+      raise ArgumentError, "date must be of class #{self.class::DELEGATE_CLASS.name}" unless date.is_a?(self.class::DELEGATE_CLASS)
+
       super(str, **str_args)
 
-      begin
-        @delegate = self.class::DELEGATE_CLASS.strptime(str, date_format)
-      rescue ArgumentError
-        raise InvalidDate
-      end
+      @delegate = date
 
       freeze
     end
@@ -178,4 +185,36 @@ module FmRest
       @delegate
     end
   end
+
+  module StringDateAwareness
+    def _parse(v, *_)
+      if v.is_a?(StringDateTime)
+        return { year: v.year, mon: v.month, mday: v.mday, hour: v.hour, min: v.min, sec: v.sec, sec_fraction: v.sec_fraction, offset: v.offset }
+      end
+      if v.is_a?(StringDate)
+        return { year: v.year, mon: v.month, mday: v.mday }
+      end
+      super
+    end
+
+    def parse(v, *_)
+      if v.is_a?(StringDate)
+        return self == ::DateTime ? v.to_datetime : v.to_date
+      end
+      super
+    end
+
+    # Overriding case equality method so that it returns true for
+    # `FmRest::StringDate` instances
+    #
+    # Calls superclass method
+    #
+    def ===(other)
+      super || other.is_a?(StringDate)
+    end
+
+    def self.enable(classes: [Date, DateTime])
+      classes.each { |klass| klass.singleton_class.prepend(self) }
+    end
+  end
 end

data/lib/fmrest/token_store.rb

@@ -2,5 +2,11 @@
 
 module FmRest
   module TokenStore
+    autoload :Base,         "fmrest/token_store/base"
+    autoload :Memory,       "fmrest/token_store/memory"
+    autoload :Null,         "fmrest/token_store/null"
+    autoload :ActiveRecord, "fmrest/token_store/active_record"
+    autoload :Moneta,       "fmrest/token_store/moneta"
+    autoload :Redis,        "fmrest/token_store/redis"
   end
 end

data/lib/fmrest/token_store/base.rb

@@ -10,15 +10,15 @@ module FmRest
       end
 
       def load(key)
-        raise "Not implemented"
+        raise NotImplementedError
       end
 
       def store(key, value)
-        raise "Not implemented"
+        raise NotImplementedError
       end
 
       def delete(key)
-        raise "Not implemented"
+        raise NotImplementedError
       end
     end
   end

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"