fmrest-core 0.13.0

data/lib/fmrest/v1/utils.rb

@@ -0,0 +1,113 @@
+# 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).
+      #
+      # @param script_options [String, Hash, Array] The script parameters to
+      # convert to canonical form
+      #
+      # @return [Hash] The converted script parameters
+      #
+      # @example
+      #   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
+
+      # Borrowed from `ERB::Util`
+      #
+      # This method is preferred to escape Data API URIs components over
+      # `URI.encode_www_form_component` (and similar methods) because the
+      # latter converts spaces to `+` instead of `%20`, which the Data API
+      # doesn't seem to like.
+      #
+      # @param s [String] An URL component to encode
+      # @return [String] The URL-encoded string
+      def url_encode(s)
+        s.to_s.b.gsub(/[^a-zA-Z0-9_\-.]/n) { |m|
+          sprintf("%%%02X", m.unpack("C")[0])
+        }
+      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

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module FmRest
+  VERSION = "0.13.0"
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: fmrest-core
+version: !ruby/object:Gem::Version
+  version: 0.13.0
+platform: ruby
+authors:
+- Pedro Carbajal
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-02-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: fmrest-core is a FileMaker Data API client built with Faraday. It handles
+  authentication as well as providing many utilities for working with the Data API.
+  An ORM library built on top of fmrest-core is also available.
+email:
+- pedro_c@beezwax.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".yardopts"
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- lib/fmrest-core.rb
+- lib/fmrest-spyke.rb
+- lib/fmrest.rb
+- lib/fmrest/connection_settings.rb
+- lib/fmrest/errors.rb
+- lib/fmrest/string_date.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/moneta.rb
+- lib/fmrest/token_store/null.rb
+- lib/fmrest/token_store/redis.rb
+- lib/fmrest/v1.rb
+- lib/fmrest/v1/auth.rb
+- lib/fmrest/v1/connection.rb
+- lib/fmrest/v1/container_fields.rb
+- lib/fmrest/v1/dates.rb
+- lib/fmrest/v1/paths.rb
+- lib/fmrest/v1/raise_errors.rb
+- lib/fmrest/v1/token_session.rb
+- lib/fmrest/v1/token_store/active_record.rb
+- lib/fmrest/v1/token_store/memory.rb
+- lib/fmrest/v1/type_coercer.rb
+- lib/fmrest/v1/utils.rb
+- lib/fmrest/version.rb
+homepage: https://github.com/beezwax/fmrest-ruby
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.3
+signing_key:
+specification_version: 4
+summary: FileMaker Data API client using Faraday, core library
+test_files: []