fmrest 0.6.0 → 0.10.0

data/lib/fmrest/v1.rb

@@ -4,12 +4,18 @@ require "fmrest/v1/connection"
 require "fmrest/v1/paths"
 require "fmrest/v1/container_fields"
 require "fmrest/v1/utils"
+require "fmrest/v1/dates"
 
 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
   end
 end

data/lib/fmrest/v1/connection.rb

@@ -5,7 +5,7 @@ require "uri"
 module FmRest
   module V1
     module Connection
-      BASE_PATH = "/fmi/data/v1/databases".freeze
+      BASE_PATH = "/fmi/data/v1/databases"
 
       # Builds a complete DAPI Faraday connection with middleware already
       # configured to handle authentication, JSON parsing, logging and DAPI
@@ -19,7 +19,6 @@ module FmRest
       # @option (see #base_connection)
       # @return (see #base_connection)
       def build_connection(options = FmRest.default_connection_settings, &block)
-
         base_connection(options) do |conn|
           conn.use RaiseErrors
           conn.use TokenSession, options
@@ -32,17 +31,18 @@ module FmRest
           conn.request :multipart
           conn.request :json
 
-          if options[:log]
-            conn.response :logger, nil, bodies: true, headers: true
-          end
-
           # Allow overriding the default response middleware
           if block_given?
-            yield conn
+            yield conn, options
           else
+            conn.use TypeCoercer, options
             conn.response :json
           end
 
+          if options[:log]
+            conn.response :logger, nil, bodies: true, headers: true
+          end
+
           conn.adapter Faraday.default_adapter
         end
       end
@@ -86,3 +86,4 @@ 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/token_session.rb

@@ -14,6 +14,8 @@ module FmRest
       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)
         super(app)
         @options = options

data/lib/fmrest/v1/type_coercer.rb

@@ -0,0 +1,192 @@
+# frozen_string_literal: true
+
+require "fmrest/string_date"
+
+module FmRest
+  module V1
+    class TypeCoercer < Faraday::Response::Middleware
+      # 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)
+        super(app)
+        @options = options
+      end
+
+      def on_complete(env)
+        return unless enabled?
+        return unless env.body.kind_of?(Hash)
+
+        data = env.body.dig("response", "data") || env.body.dig(:response, :data)
+
+        return unless data
+
+        data.each do |record|
+          field_data = record["fieldData"] || record[:fieldData]
+          portal_data = record["portalData"] || record[:portalData]
+
+          coerce_fields(field_data)
+
+          portal_data.try(:each_value) do |portal_records|
+            portal_records.each do |pr|
+              coerce_fields(pr)
+            end
+          end
+        end
+      end
+
+      private
+
+      def coerce_fields(hash)
+        hash.each do |k, v|
+          next unless v.is_a?(String)
+          next if k == "recordId" || k == :recordId || k == "modId" || k == :modId
+
+          if quick_check_timestamp(v)
+            begin
+              hash[k] = coerce_timestamp(v)
+              next
+            rescue ArgumentError
+            end
+          end
+
+          if quick_check_date(v)
+            begin
+              hash[k] = date_class.strptime(v, date_strptime_format)
+              next
+            rescue ArgumentError
+            end
+          end
+
+          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
+          when *COERCE_HYBRID
+            StringDate
+          when *COERCE_FULL
+            Date
+          end
+      end
+
+      def datetime_class
+        @datetime_class ||=
+          case coerce_dates
+          when *COERCE_HYBRID
+            StringDateTime
+          when *COERCE_FULL
+            DateTime
+          end
+      end
+
+      def date_fm_format
+        @options[:date_format] || DEFAULT_DATE_FORMAT
+      end
+
+      def timestamp_fm_format
+        @options[:timestamp_format] || DEFAULT_TIMESTAMP_FORMAT
+      end
+
+      def time_fm_format
+        @options[:time_format] || DEFAULT_TIME_FORMAT
+      end
+
+      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 local_timezone?
+        @local_timezone ||= @options.fetch(:timezone, nil).try(:to_sym) == :local
+      end
+
+      def coerce_dates
+        @options.fetch(:coerce_dates, false)
+      end
+
+      alias_method :enabled?, :coerce_dates
+    end
+  end
+end

data/lib/fmrest/v1/utils.rb

@@ -72,6 +72,7 @@ module FmRest
         params
       end
 
+
       private
 
       def convert_script_arguments(script_arguments, suffix = nil)

data/lib/fmrest/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fmrest
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.10.0
 platform: ruby
 authors:
 - Pedro Carbajal
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-05-05 00:00:00.000000000 Z
+date: 2020-05-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -231,7 +231,6 @@ files:
 - ".travis.yml"
 - ".yardopts"
 - CHANGELOG.md
-- CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -242,20 +241,22 @@ files:
 - 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/auth.rb
 - lib/fmrest/spyke/model/connection.rb
 - lib/fmrest/spyke/model/container_fields.rb
+- lib/fmrest/spyke/model/global_fields.rb
 - lib/fmrest/spyke/model/http.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/spyke/spyke_formatter.rb
 - lib/fmrest/spyke/validation_error.rb
+- lib/fmrest/string_date.rb
 - lib/fmrest/token_store.rb
 - lib/fmrest/token_store/active_record.rb
 - lib/fmrest/token_store/base.rb
@@ -265,11 +266,13 @@ files:
 - lib/fmrest/v1.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

data/CODE_OF_CONDUCT.md

@@ -1,74 +0,0 @@
-# Contributor Covenant Code of Conduct
-
-## Our Pledge
-
-In the interest of fostering an open and welcoming environment, we as
-contributors and maintainers pledge to making participation in our project and
-our community a harassment-free experience for everyone, regardless of age, body
-size, disability, ethnicity, gender identity and expression, level of experience,
-nationality, personal appearance, race, religion, or sexual identity and
-orientation.
-
-## Our Standards
-
-Examples of behavior that contributes to creating a positive environment
-include:
-
-* Using welcoming and inclusive language
-* Being respectful of differing viewpoints and experiences
-* Gracefully accepting constructive criticism
-* Focusing on what is best for the community
-* Showing empathy towards other community members
-
-Examples of unacceptable behavior by participants include:
-
-* The use of sexualized language or imagery and unwelcome sexual attention or
-advances
-* Trolling, insulting/derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or electronic
-  address, without explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
-  professional setting
-
-## Our Responsibilities
-
-Project maintainers are responsible for clarifying the standards of acceptable
-behavior and are expected to take appropriate and fair corrective action in
-response to any instances of unacceptable behavior.
-
-Project maintainers have the right and responsibility to remove, edit, or
-reject comments, commits, code, wiki edits, issues, and other contributions
-that are not aligned to this Code of Conduct, or to ban temporarily or
-permanently any contributor for other behaviors that they deem inappropriate,
-threatening, offensive, or harmful.
-
-## Scope
-
-This Code of Conduct applies both within project spaces and in public spaces
-when an individual is representing the project or its community. Examples of
-representing a project or community include using an official project e-mail
-address, posting via an official social media account, or acting as an appointed
-representative at an online or offline event. Representation of a project may be
-further defined and clarified by project maintainers.
-
-## Enforcement
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting the project team at pedro_c@beezwax.net. All
-complaints will be reviewed and investigated and will result in a response that
-is deemed necessary and appropriate to the circumstances. The project team is
-obligated to maintain confidentiality with regard to the reporter of an incident.
-Further details of specific enforcement policies may be posted separately.
-
-Project maintainers who do not follow or enforce the Code of Conduct in good
-faith may face temporary or permanent repercussions as determined by other
-members of the project's leadership.
-
-## Attribution
-
-This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
-available at [http://contributor-covenant.org/version/1/4][version]
-
-[homepage]: http://contributor-covenant.org
-[version]: http://contributor-covenant.org/version/1/4/