fmrest-core 0.14.0 → 0.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cba0e445e2ed4490aff12280984c77731b69c293df1a9d2e4e5f67c87b256a6c
-  data.tar.gz: c1ab4d1a181fe2a0430f77e70094a5b56690401cae73610ddd16c269fc28bb19
+  metadata.gz: ffafc2aecdab7b90059a7cc7a9a3687fbb557178d1cba164ca98feccf675cad1
+  data.tar.gz: df5a41ca5a2601a0bf4f9635ba42b14240aaeea10ced1b035a376fff12c0327e
 SHA512:
-  metadata.gz: c25310aa7a1ff1dfc74519551eb91f78fdead52c90e35841f8c356e0f9fc10599aade957b99ee87c86730a12b7a58027f26e7781acfe7258be32840c49155f99
-  data.tar.gz: a5553c69a3e238c49d548f7e749d86fc226525ef626d8b00f6f0f529efdb19fc3d7b117e80098193dc2a56169dec804207d466630ab36ef4bd48cd6f69115782
+  metadata.gz: effc1532b7060e3167c726771bf057fa9154fd61e77517628e2d4ae9da716555e6bf0aa0a3fac29a1d5a7bbd6c6f53b9db138472af64b19b685e00d3a49ff52b
+  data.tar.gz: 3dc285d1ed51eb1a12203f90ad27655e8c24810391c0dbcb9223cbff80c0ed694c32ff86f6dd9f41f4170e399ec4aeabd79b7b4119b578fa3e1f9ef7e24ad500

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.rb

@@ -32,5 +32,13 @@ module FmRest
       warn "[DEPRECATION] `FmRest.config` is deprecated, use `FmRest.default_connection_settings` instead"
       default_connection_settings
     end
+
+    # Shortcut for FmRest::V1.escape_find_operators
+    #
+    # @param (see FmRest::V1.escape_find_operators
+    # @return (see FmRest::V1.escape_find_operators
+    def e(s)
+      V1.escape_find_operators(s)
+    end
   end
 end

data/lib/fmrest/v1/dates.rb

@@ -3,6 +3,8 @@
 module FmRest
   module V1
     module Dates
+      FM_DATE_FORMAT = "%m/%d/%Y"
+      FM_DATETIME_FORMAT = "#{FM_DATE_FORMAT} %H:%M:%S"
       FM_DATETIME_FORMAT_MATCHER = /MM|mm|dd|HH|ss|yyyy/.freeze
 
       FM_DATE_TO_STRPTIME_SUBSTITUTIONS = {
@@ -55,8 +57,8 @@ module FmRest
       # 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.
+      # 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
@@ -76,6 +78,40 @@ module FmRest
 
         Rational(time.utc_offset, 86400) # seconds in one day (24*60*60)
       end
+
+      # Returns a list of all datetime classes recognized by fmrest-ruby,
+      # including `FmRest::StringDateTime` if defined. Useful for using in a
+      # `case .. when` statement.
+      #
+      def datetime_classes
+        [DateTime, Time, defined?(FmRest::StringDateTime) && FmRest::StringDateTime].compact.freeze
+      end
+
+      # Returns a list of all date classes recognized by fmrest-ruby, including
+      # `FmRest::StringDate` if defined. Useful for using in a `case .. when`
+      # statement.
+      #
+      def date_classes
+        [Date, defined?(FmRest::StringDate) && FmRest::StringDate].compact.freeze
+      end
+
+      # Converts the given DateTime dt to the specified timezone setting offset,
+      # leaving everything else intact.
+      #
+      # @param dt [DateTime] The datetime to convert
+      # @param timezone [nil, Symbol, String] Accepted values are `:utc`,
+      #   `:local`, or `nil` (in which case it leaves the given datetime intact)
+      # @return [DateTime] A new datetime with converted timezone
+      def convert_datetime_timezone(dt, timezone)
+        case 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
     end
   end
 end

data/lib/fmrest/v1/utils.rb

@@ -5,6 +5,9 @@ module FmRest
     module Utils
       VALID_SCRIPT_KEYS = [:prerequest, :presort, :after].freeze
 
+      # See https://help.claris.com/en/pro-help/content/finding-text.html
+      FM_FIND_OPERATORS_RE = /([@\*#\?!=<>"])/
+
       # Converts custom script options to a hash with the Data API's expected
       # JSON script format.
       #
@@ -91,6 +94,16 @@ module FmRest
         }
       end
 
+      # Escapes FileMaker find operators from the given string in order to use
+      # it in a find request.
+      #
+      # @param s [String] The string to escape
+      # @return [String] A new string with find operators escaped with
+      #   backslashes
+      def escape_find_operators(s)
+        s.gsub(FM_FIND_OPERATORS_RE, "\\\\\\1")
+      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.14.0"
+  VERSION = "0.15.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fmrest-core
 version: !ruby/object:Gem::Version
-  version: 0.14.0
+  version: 0.15.0
 platform: ruby
 authors:
 - Pedro Carbajal
 autorequire:
 bindir: exe
 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: faraday