fmrest 0.1.0 → 0.2.0

data/lib/fmrest/v1/token_session.rb

@@ -1,9 +1,12 @@
+# frozen_string_literal: true
+
 module FmRest
   module V1
     # FM Data API authentication middleware using the credentials strategy
     #
     class TokenSession < Faraday::Middleware
       HEADER_KEY = "Authorization".freeze
+      TOKEN_STORE_INTERFACE = [:load, :store, :delete].freeze
 
       def initialize(app, options = FmRest.config)
         super(app)
@@ -20,7 +23,7 @@ module FmRest
         @app.call(env).on_complete do |response_env|
           if response_env[:status] == 401 # Unauthorized
             env[:body] = request_body
-            token_store.clear
+            token_store.delete(token_store_key)
             set_auth_header(env)
             return @app.call(env)
           end
@@ -38,11 +41,11 @@ module FmRest
       # otherwise raises an exception.
       #
       def token
-        token = token_store.fetch
+        token = token_store.load(token_store_key)
         return token if token
 
         if token = request_token
-          token_store.store(token)
+          token_store.store(token_store_key, token)
           return token
         end
 
@@ -61,19 +64,36 @@ module FmRest
         false
       end
 
-      def token_store
-        @token_store ||= token_store_class.new(@options.fetch(:host), @options.fetch(:database))
+      # The key to use to store a token, uses the format host:database
+      #
+      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 = URI(host).hostname if host.match?(/\Ahttps?:\/\//)
+            "#{host}:#{@options.fetch(:database)}"
+          end
       end
 
-      def token_store_class
-        FmRest.token_store ||
+      def token_store
+        @token_store ||=
           begin
-            # TODO: Make this less ugly
-            require "fmrest/v1/token_store/memory"
-            TokenStore::Memory
+            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
+            else
+              require "fmrest/token_store/memory"
+              TokenStore::Memory.new
+            end
           end
       end
 
+      def token_store_option
+        @options[:token_store] || FmRest.token_store
+      end
+
       def auth_connection
         @auth_connection ||= V1.base_connection(@options) do |conn|
           conn.basic_auth @options.fetch(:username), @options.fetch(:password)
@@ -82,8 +102,8 @@ module FmRest
             conn.response :logger, nil, bodies: true, headers: true
           end
 
-          conn.response   :json
-          conn.adapter    Faraday.default_adapter
+          conn.response :json
+          conn.adapter Faraday.default_adapter
         end
       end
     end

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

@@ -1,73 +1,13 @@
-require "fmrest/v1/token_store/base"
+# 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
-      # Heavily inspired by Moneta's ActiveRecord store:
-      #
-      #   https://github.com/minad/moneta/blob/master/lib/moneta/adapters/activerecord.rb
-      #
-      class ActiveRecord < Base
-        DEFAULT_TABLE_NAME = "fmrest_session_tokens".freeze
-
-        @connection_lock = ::Mutex.new
-        class << self
-          attr_reader :connection_lock
-        end
-
-        attr_reader :connection_pool, :model
-
-        delegate :with_connection, to: :connection_pool
-
-        def initialize(host, database, options = {})
-          super
-
-          @connection_pool = ::ActiveRecord::Base.connection_pool
-
-          create_table
-
-          @model = Class.new(::ActiveRecord::Base)
-          @model.table_name = table_name
-        end
-
-        def clear
-          model.where(scope: scope).delete_all
-        end
-
-        def fetch
-          model.where(scope: scope).pluck(:token).first
-        end
-
-        def store(token)
-          record = model.find_or_initialize_by(scope: scope)
-          record.token = token
-          record.save!
-          token
-        end
-
-        private
-
-        def create_table
-          with_connection do |conn|
-            return if conn.table_exists?(table_name)
-
-            # Prevent multiple connections from attempting to create the table simultaneously.
-            self.class.connection_lock.synchronize do
-              conn.create_table(table_name, id: false) do |t|
-                t.string :scope, null: false
-                t.string :token, null: false
-                t.datetime :updated_at
-              end
-              conn.add_index(table_name, :scope, unique: true)
-              conn.add_index(table_name, [:scope, :token])
-            end
-          end
-        end
-
-        def table_name
-          options[:table_name] || DEFAULT_TABLE_NAME
-        end
-      end
+      ActiveRecord = ::FmRest::TokenStore::ActiveRecord
     end
   end
 end

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

@@ -1,26 +1,13 @@
-require "fmrest/v1/token_store/base"
+# 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
-      class Memory < Base
-        def initialize(host, database, options = {})
-          super
-          @tokens = {}
-        end
-
-        def clear
-          @tokens.delete(scope)
-        end
-
-        def fetch
-          @tokens[scope]
-        end
-
-        def store(token)
-          @tokens[scope] = token
-        end
-      end
+      Memory = ::FmRest::TokenStore::Memory
     end
   end
 end

data/lib/fmrest/v1/utils.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+module FmRest
+  module V1
+    module Utils
+      VALID_SCRIPT_KEYS = [:prerequest, :presort, :after].freeze
+
+      # Converts custom script options to a hash with the Data API's expected
+      # JSON script format.
+      #
+      # If script_options is a string or symbol it will be passed as the name
+      # of the script to execute (after the action, e.g. save).
+      #
+      # If script_options is an array the first element will be the name of the
+      # script to execute (after the action) and the second element (if any)
+      # will be its param value.
+      #
+      # If script_options is a hash it will expect to contain one or more of
+      # the following keys: :prerequest, :presort, :after
+      #
+      # Any of those keys should contain either a string/symbol or array, which
+      # will be treated as described above, except for their own script
+      # execution order (prerequest, presort or after action).
+      #
+      # Examples:
+      #
+      #     convert_script_params("My Script")
+      #     # => { "script": "My Script" }
+      #
+      #     convert_script_params(["My Script", "the param"])
+      #     # => { "script": "My Script", "script.param": "the param" }
+      #
+      #     convert_script_params(after: "After Script", prerequest: "Prerequest Script")
+      #     # => { "script": "After Script", "script.prerequest": "Prerequest Script" }
+      #
+      #     convert_script_params(presort: ["Presort Script", "foo"], prerequest: "Prerequest Script")
+      #     # => {
+      #     #      "script.presort": "After Script",
+      #     #      "script.presort.param": "foo",
+      #     #      "script.prerequest": "Prerequest Script"
+      #     #    }
+      #
+      def convert_script_params(script_options)
+        params = {}
+
+        case script_options
+        when String, Symbol
+          params[:script] = script_options.to_s
+
+        when Array
+          params.merge!(convert_script_arguments(script_options))
+
+        when Hash
+          script_options.each_key do |key|
+            next if VALID_SCRIPT_KEYS.include?(key)
+            raise ArgumentError, "Invalid script option #{key.inspect}"
+          end
+
+          if script_options.has_key?(:prerequest)
+            params.merge!(convert_script_arguments(script_options[:prerequest], :prerequest))
+          end
+
+          if script_options.has_key?(:presort)
+            params.merge!(convert_script_arguments(script_options[:presort], :presort))
+          end
+
+          if script_options.has_key?(:after)
+            params.merge!(convert_script_arguments(script_options[:after]))
+          end
+        end
+
+        params
+      end
+
+      private
+
+      def convert_script_arguments(script_arguments, suffix = nil)
+        base = suffix ? "script.#{suffix}".to_sym : :script
+
+        {}.tap do |params|
+          case script_arguments
+          when String, Symbol
+            params[base] = script_arguments.to_s
+          when Array
+            params[base] = script_arguments.first.to_s
+            params["#{base}.param".to_sym] = script_arguments[1] if script_arguments[1]
+          else
+            raise ArgumentError, "Script arguments are expected as a String, Symbol or Array"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/fmrest/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module FmRest
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fmrest
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Pedro Carbajal
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-01-10 00:00:00.000000000 Z
+date: 2019-06-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -148,6 +148,48 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.6
+- !ruby/object:Gem::Dependency
+  name: mock_redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: FileMaker Data API client using Faraday, with optional ActiveRecord-like
   ORM based on Spyke
 email:
@@ -159,6 +201,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- ".yardopts"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
@@ -166,23 +209,35 @@ files:
 - Rakefile
 - fmrest.gemspec
 - lib/fmrest.rb
+- lib/fmrest/errors.rb
 - lib/fmrest/spyke.rb
 - lib/fmrest/spyke/base.rb
+- lib/fmrest/spyke/container_field.rb
 - lib/fmrest/spyke/json_parser.rb
 - lib/fmrest/spyke/model.rb
 - lib/fmrest/spyke/model/associations.rb
 - lib/fmrest/spyke/model/attributes.rb
 - lib/fmrest/spyke/model/connection.rb
+- lib/fmrest/spyke/model/container_fields.rb
 - lib/fmrest/spyke/model/orm.rb
+- lib/fmrest/spyke/model/serialization.rb
 - lib/fmrest/spyke/model/uri.rb
 - lib/fmrest/spyke/portal.rb
 - lib/fmrest/spyke/relation.rb
+- lib/fmrest/token_store.rb
+- lib/fmrest/token_store/active_record.rb
+- lib/fmrest/token_store/base.rb
+- lib/fmrest/token_store/memory.rb
+- lib/fmrest/token_store/redis.rb
 - lib/fmrest/v1.rb
+- lib/fmrest/v1/connection.rb
+- lib/fmrest/v1/container_fields.rb
+- lib/fmrest/v1/paths.rb
+- lib/fmrest/v1/raise_errors.rb
 - lib/fmrest/v1/token_session.rb
-- lib/fmrest/v1/token_store.rb
 - lib/fmrest/v1/token_store/active_record.rb
-- lib/fmrest/v1/token_store/base.rb
 - lib/fmrest/v1/token_store/memory.rb
+- lib/fmrest/v1/utils.rb
 - lib/fmrest/version.rb
 homepage: https://github.com/beezwax/fmrest-ruby
 licenses:
@@ -204,7 +259,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 2.7.8
 signing_key: 
 specification_version: 4
 summary: FileMaker Data API client using Faraday

data/lib/fmrest/v1/token_store.rb

@@ -1,6 +0,0 @@
-module FmRest
-  module V1
-    module TokenStore
-    end
-  end
-end

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

@@ -1,14 +0,0 @@
-module FmRest
-  module V1
-    module TokenStore
-      class Base
-        attr_reader :scope, :options
-
-        def initialize(host, database, options = {})
-          @scope = "#{host.to_s}:#{database.to_s}"
-          @options = options
-        end
-      end
-    end
-  end
-end