fmrest-spyke 0.14.0 → 0.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d7208f6230222ff9227d220c31f445337ad1c09a485b4a6dd752f8fed5f94aef
-  data.tar.gz: 2a7424c4c6bc8f2b6ab218ebaab92efa1da644616eaa650e347d680e6008209e
+  metadata.gz: 48d4905462bd97acb37ec58ef98ef8ef58cc4362aa52adfc496de521231f8937
+  data.tar.gz: f99542f9578cfdbb894f4a9a5e6635da077f272f7cfa73911cc1e1563604b7e1
 SHA512:
-  metadata.gz: 3551a71b87620e499a666b70f3ca1ae7f39ecd67602c778628254b4155d3c3136650d69063b6d3e3d2d26ada8e16d261a0b16ba4186efc997d045f92a65fd322
-  data.tar.gz: 43cca2d89fb4bd051d8fbe0d75f54f65960e707e93488e3815cb849a3637162e1b8ef570b1d9e501045cd29c8c1546c4dafbde6737a98647f888154fe482b890
+  metadata.gz: 4a9c6772950abe865cf776c4cf3bba052bdb49f744429e475555d18e16289c39ed14a65e8251ecceb324d0ddc5d96c637dc1ce16e924af20dd44135fac41dbd6
+  data.tar.gz: bf8b8ab7ec6b55daf2ba55a5930fcb2323cff7823853c671139ec1e30feda7a7bc81657ab511ef0aa75730e4e98e95d7562df3f2a44252a8bd550ad9c749d584

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 ## Changelog
 
+### 0.15.0
+
+* Much improved querying API (see documentation on querying), adding new
+  `.query` capabilities, as well as two new methods: `.match` and `.or`
+
 ### 0.14.0
 
 * Aliased `FmRest::Spyke::Base` as `FmRest::Layout` (now preferred), and

data/README.md

@@ -54,13 +54,28 @@ class Honeybee < FmRest::Layout("Honeybees Web")
   }
 
   # Mapped attributes
-  attributes name: "Bee Name", age: "Bee Age"
+  attributes name: "Bee Name", age: "Bee Age", created_on: "Created On"
 
-  # Portals
-  has_portal :flowers
+  # Portal associations
+  has_portal :tasks
 
-  # File container
+  # File containers
   container :photo, field_name: "Bee Photo"
+
+  # Scopes
+  scope :can_legally_fly, -> { query(age: ">18") }
+
+  # Client-side validations
+  validates :name, presence: true
+
+  # Callbacks
+  before_save :set_created_on
+
+  private
+
+  def set_created_on
+    self.created_on = Date.today
+  end
 end
 
 # Find a record by id
@@ -69,7 +84,7 @@ bee = Honeybee.find(9)
 bee.name = "Hutch"
 
 # Add a new record to portal
-bee.flowers.build(name: "Daisy")
+bee.tasks.build(urgency: "Today")
 
 bee.save
 ```
@@ -129,9 +144,9 @@ You can also pass a `:log` option for basic request logging, see the section on
 Option              | Description                                | Format                      | Default
 --------------------|--------------------------------------------|-----------------------------|--------
 `:host`             | Hostname with optional port, e.g. `"example.com:9000"` | String          | None
-`:database`         |                                            | String                      | None
-`:username`         |                                            | String                      | None
-`:password`         |                                            | String                      | None
+`:database`         | The name of the database to connect to     | String                      | None
+`:username`         | A Data API-ready account                   | String                      | None
+`:password`         | Your password                              | String                      | None
 `:account_name`     | Alias of `:username`                       | String                      | None
 `:ssl`              | SSL options to be forwarded to Faraday     | Faraday SSL options         | None
 `:proxy`            | Proxy options to be forwarded to Faraday   | Faraday proxy options       | None
@@ -288,7 +303,8 @@ class Honeybee < FmRest::Layout
 end
 ```
 
-Alternatively, you can set the layout name in the class definition line:
+Alternatively, if you're inheriting from `FmRest::Layout` directly you can set
+the layout name in the class definition line:
 
 ```ruby
 class Honeybee < FmRest::Layout("Honeybees Web")
@@ -388,8 +404,8 @@ Guides](https://guides.rubyonrails.org/active_model_basics.html#dirty).
 Since Spyke is API-agnostic it only provides a wide-purpose `.where` method for
 passing arbitrary parameters to the REST backend. fmrest-ruby however is well
 aware of its backend API, so it extends Spkye models with a bunch of useful
-querying methods: `.query`, `.limit`, `.offset`, `.sort`, `.portal`, `.script`,
-etc.
+querying methods: `.query`, `.match`, `.omit`, `.limit`, `.offset`, `.sort`,
+`.portal`, `.script`, etc.
 
 See the [main document on querying](docs/Querying.md) for detailed information
 on the query API methods.

data/lib/fmrest/spyke.rb

@@ -1,12 +1,6 @@
 # frozen_string_literal: true
 
-begin
-  require "spyke"
-rescue LoadError => e
-  e.message << " (Did you include Spyke in your Gemfile?)" unless e.message.frozen?
-  raise e
-end
-
+require "spyke"
 require "fmrest"
 require "fmrest/spyke/spyke_formatter"
 require "fmrest/spyke/model"

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

@@ -26,10 +26,10 @@ module FmRest
 
         class_methods do
           # Methods delegated to `FmRest::Spyke::Relation`
-          delegate :limit, :offset, :sort, :order, :query, :omit, :portal,
-                   :portals, :includes, :with_all_portals, :without_portals,
-                   :script, :find_one, :first, :any, :find_some,
-                   :find_in_batches, :find_each, to: :all
+          delegate :limit, :offset, :sort, :order, :query, :match, :omit,
+            :portal, :portals, :includes, :with_all_portals, :without_portals,
+            :script, :find_one, :first, :any, :find_some, :find_in_batches,
+            :find_each, to: :all
 
           # Spyke override -- Use FmRest's Relation instead of Spyke's vanilla
           # one

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

@@ -4,9 +4,6 @@ module FmRest
   module Spyke
     module Model
       module Serialization
-        FM_DATE_FORMAT = "%m/%d/%Y"
-        FM_DATETIME_FORMAT = "#{FM_DATE_FORMAT} %H:%M:%S"
-
         # Spyke override -- Return FM Data API's expected JSON format,
         # including only modified fields.
         #
@@ -79,10 +76,10 @@ module FmRest
         def serialize_values!(params)
           params.transform_values! do |value|
             case value
-            when *datetime_classes
-              convert_datetime_timezone(value.to_datetime).strftime(FM_DATETIME_FORMAT)
-            when *date_classes
-              value.strftime(FM_DATE_FORMAT)
+            when *FmRest::V1.datetime_classes
+              FmRest::V1.convert_datetime_timezone(value.to_datetime, fmrest_config.timezone).strftime(FmRest::V1::Dates::FM_DATETIME_FORMAT)
+            when *FmRest::V1.date_classes
+              value.strftime(FmRest::V1::Dates::FM_DATE_FORMAT)
             else
               value
             end
@@ -90,25 +87,6 @@ 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/spyke/relation.rb

@@ -5,6 +5,8 @@ module FmRest
     class Relation < ::Spyke::Relation
       SORT_PARAM_MATCHER = /(.*?)(!|__desc(?:end)?)?\Z/.freeze
 
+      class UnknownQueryKey < ArgumentError; end
+
       # NOTE: We need to keep limit, offset, sort, query and portal accessors
       # separate from regular params because FM Data API uses either "limit" or
       # "_limit" (or "_offset", etc.) as param keys depending on the type of
@@ -12,7 +14,7 @@ module FmRest
 
 
       attr_accessor :limit_value, :offset_value, :sort_params, :query_params,
-                    :included_portals, :portal_params, :script_params
+                    :or_flag, :included_portals, :portal_params, :script_params
 
       def initialize(*_args)
         super
@@ -161,16 +163,111 @@ module FmRest
         portal(false)
       end
 
+      # Sets conditions for a find request. Conditions must be given in
+      # `{ field: condition }` format, where `condition` is normally a string
+      # sent raw to the Data API server, so you can use FileMaker find
+      # operators. You can also pass Ruby range or date/datetime objects for
+      # condition values, and they'll be converted to the appropriate Data API
+      # representation.
+      #
+      # Passing `omit: true` in a conditions set will negate all conditions in
+      # that set.
+      #
+      # You can modify the way conditions are added (i.e. through logical AND
+      # or OR) by pre-chaining `.or`. By default it adds conditions through
+      # logical AND.
+      #
+      # Note that because of the way the Data API works, logical AND conditions
+      # on a single field are not possible. Because of that, if you try to set
+      # two AND conditions for the same field, the previously existing one will
+      # be overwritten with the new condition.
+      #
+      # It is recommended that you learn how the Data API represents conditions
+      # in its find requests (i.e. an array of JSON objects with conditions on
+      # fields). This method internally uses that same representation, which
+      # you can view by inspecting the resulting relations. Understanding that
+      # representation will also make the limitations of this Ruby API clear.
+      #
+      # @example
+      #   Person.query(name: "=Alice") # Simple query
+      #   Person.query(age: (20..29)) # Query using a Ruby range
+      #   Person.query(created_on: Date.today..Date.today-1)
+      #   Person.query(name: "=Alice", age: ">20") # Query multiple fields (logical AND)
+      #   Person.query(name: "=Alice").query(age: ">20") # Same effect as above example
+      #   Person.query(name: "=Bob", omit: true) # Negate a query (i.e. find people not named Bob)
+      #   Person.query(pets: { name: "=Snuggles" }) # Query portal fields
+      #   Person.query({ name: "=Alice" }, { name: "=Bob" }) # Separate conditions through logical OR
+      #   Person.query(name: "=Alice").or.query(name: "=Bob") # Same effect as above example
+      # @return [FmRest::Spyke::Relation] a new relation with the given find
+      #   conditions applied
       def query(*params)
         with_clone do |r|
-          r.query_params += params.flatten.map { |p| normalize_query_params(p) }
+          params = params.flatten.map { |p| normalize_query_params(p) }
+
+          if r.or_flag || r.query_params.empty?
+            r.query_params += params
+            r.or_flag = nil
+          elsif params.length > r.query_params.length
+            params[0, r.query_params.length].each_with_index do |p, i|
+              r.query_params[i].merge!(p)
+            end
+
+            remainder = params.length - r.query_params.length
+            r.query_params += params[-remainder, remainder]
+          else
+            params.each_with_index { |p, i| r.query_params[i].merge!(p) }
+          end
         end
       end
 
+      # Similar to `.query`, but sets exact string match queries (i.e.
+      # prefixes queries with ==) and escapes find operators in the given
+      # queries using `FmRest.e`.
+      #
+      # @example
+      #   Person.query(email: "bob@example.com") # Find exact email
+      # @return [FmRest::Spyke::Relation] a new relation with the exact match
+      #   conditions applied
+      def match(*params)
+        query(transform_query_values(params) { |v| "==#{FmRest::V1.escape_find_operators(v)}" })
+      end
+
+      # Negated version of `.query`, sets conditions to omit in a find request.
+      #
+      # This is the same as passing `omit: true` to `.query`.
+      #
+      # @return [FmRest::Spyke::Relation] a new relation with the given find
+      #   conditions applied negated
       def omit(params)
         query(params.merge(omit: true))
       end
 
+      # Signals that the next query conditions to be set (through `.query`,
+      # `.match`, etc.) should be added as a logical OR relative to previously
+      # set conditions (rather than the default AND).
+      #
+      # In practice this means the JSON query request will have a new
+      # conditions object appended, e.g.:
+      #
+      # ```
+      # {"query": [{"field": "condition"}, {"field": "OR-added condition"}]}
+      # ```
+      #
+      # You can call this method with or without parameters. If parameters are
+      # given they will be passed down to `.query` (and those conditions
+      # immediately set), otherwise it just prepares the next
+      # conditions-setting method to use OR.
+      #
+      # @example
+      #   # Add conditions directly in .or call:
+      #   Person.query(name: "=Alice").or(name: "=Bob")
+      #   # Add exact match conditions through method chaining
+      #   Person.match(email: "alice@example.com").or.match(email: "bob@example.com")
+      def or(*params)
+        clone = with_clone { |r| r.or_flag = true }
+        params.empty? ? clone : clone.query(*params)
+      end
+
       # @return [Boolean] whether a query was set on this relation
       def has_query?
         query_params.present?
@@ -328,11 +425,91 @@ module FmRest
             next
           end
 
-          # TODO: Raise ArgumentError if an attribute given as symbol isn't defiend
-          if k.kind_of?(Symbol) && klass.mapped_attributes.has_key?(k)
-            normalized[klass.mapped_attributes[k].to_s] = v
+          # Portal fields query (nested hash), e.g. { contact: { name: "Hutch" } }
+          if v.kind_of?(Hash)
+            if k.kind_of?(Symbol)
+              portal_key, = klass.portal_options.find { |_, opts| opts[:name].to_s == k.to_s }
+
+              if portal_key
+                portal_model = klass.associations[k].klass
+
+                portal_normalized = v.each_with_object({}) do |(pk, pv), h|
+                  normalize_single_query_param_for_model(portal_model, pk, pv, h)
+                end
+
+                normalized.merge!(portal_normalized.transform_keys { |pf| "#{portal_key}::#{pf}" })
+              else
+                raise UnknownQueryKey, "No portal matches the query key `:#{k}` on #{klass.name}. If you are trying to use the literal string '#{k}' pass it as a string instead of a symbol."
+              end
+            else
+              normalized.merge!(v.transform_keys { |pf| "#{k}::#{pf}" })
+            end
+
+            next
+          end
+
+          # Attribute query (scalar values), e.g. { name: "Hutch" }
+          normalize_single_query_param_for_model(klass, k, v, normalized)
+        end
+      end
+
+      def normalize_single_query_param_for_model(model, k, v, hash)
+        if k.kind_of?(Symbol)
+          if model.mapped_attributes.has_key?(k)
+            hash[model.mapped_attributes[k].to_s] = format_query_condition(v)
+          else
+            raise UnknownQueryKey, "No attribute matches the query key `:#{k}` on #{model.name}. If you are trying to use the literal string '#{k}' pass it as a string instead of a symbol."
+          end
+        else
+          hash[k.to_s] = format_query_condition(v)
+        end
+      end
+
+      # Transforms various Ruby data types to FileMaker search condition
+      # strings
+      #
+      def format_query_condition(condition)
+        case condition
+        when nil
+          "=" # Search for empty field
+        when Range
+          format_range_condition(condition)
+        when *FmRest::V1.datetime_classes
+          FmRest::V1.convert_datetime_timezone(condition.to_datetime, klass.fmrest_config.timezone)
+            .strftime(FmRest::V1::Dates::FM_DATETIME_FORMAT)
+        when *FmRest::V1.date_classes
+          condition.strftime(FmRest::V1::Dates::FM_DATE_FORMAT)
+        else
+          condition
+        end
+      end
+
+      def format_range_condition(range)
+        if range.first.kind_of?(Numeric)
+          if range.first == Float::INFINITY || range.end == -Float::INFINITY
+            raise ArgumentError, "Can't search for a range that begins at +Infinity or ends at -Infinity"
+          elsif range.first == -Float::INFINITY
+            if range.end == Float::INFINITY || range.end.nil?
+              "*" # Search for non-empty field
+            else
+              range.exclude_end? ? "<#{range.end}" : "<=#{range.end}"
+            end
+          elsif range.end == Float::INFINITY || range.end.nil?
+            ">=#{range.first}"
+          elsif range.exclude_end? && range.last.respond_to?(:pred)
+            "#{range.first}..#{range.last.pred}"
           else
-            normalized[k.to_s] = v
+            "#{range.first}..#{range.last}"
+          end
+        else
+          "#{format_query_condition(range.first)}..#{format_query_condition(range.last)}"
+        end
+      end
+
+      def transform_query_values(*params, &block)
+        params.flatten.map do |p|
+          p.transform_values do |v|
+            v.kind_of?(Hash) ? v.transform_values(&block) : yield(v)
           end
         end
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fmrest-spyke
 version: !ruby/object:Gem::Version
-  version: 0.14.0
+  version: 0.15.0
 platform: ruby
 authors:
 - Pedro Carbajal
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-03-23 00:00:00.000000000 Z
+date: 2021-04-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fmrest-core
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.14.0
+        version: 0.15.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.14.0
+        version: 0.15.0
 - !ruby/object:Gem::Dependency
   name: spyke
   requirement: !ruby/object:Gem::Requirement