fmrest 0.11.1 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d087824f401c6c36c5f0ac00acf9e3ee12fced43d002000533ba0b97e579d89d
-  data.tar.gz: 2c3f0018686f48f02c6e177cc10ba0cbdecd584523776c9269023bb7192eb271
+  metadata.gz: 725c8356fc5933f0484f7d04a4458ecc85c638838c8d9869d039a6e09b0b15f6
+  data.tar.gz: 2a8047594d93d13b0f6d9981159c16b1afdcaa19713c054391fc08ca1fa68633
 SHA512:
-  metadata.gz: 9746926229c22793428d1c0d76c7d0b373cee751c15d83389e3a426ca434773524e1f8133d65914b0301d47c7e6c22f893f14850377bb8b665f065ce377f972f
-  data.tar.gz: a8d32edd04361bb9a4f8add3cc8ecd9e89cf1bcbcf0437cfcc3d30cba652c67b935d58091246f1657041dc0678ce0b01c3685d300b6a699fea3bb73dfb131846
+  metadata.gz: 7a41a3e747bf6ccfe0de7e5541b0db35d30d9723b7a0eeb895fbe9e21f4c2c7e6f08ccd3012c1e6f4edaa5403966e2a7563b74490327c721990fbdd4ab79608a
+  data.tar.gz: 16fb2868c102905a58632b1183581dcf4617d4e6c9f7529abad12916b78b3c692d21a469eaf7b23101d53ff55e8c9ccbfc1167556cc09855516647ce00565ea8

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 ## Changelog
 
+### 0.12.0
+
+* Rename `FmRest::Spyke::Base#id=` to `FmRest::Spyke::Base#__record_id=` to
+  prevent clobbering of FileMaker layout-defined fields
+* Better yard documentation
+
 ### 0.11.1
 
 * Fix a couple crashes due to missing constants

data/UPGRADING

@@ -0,0 +1,15 @@
+=======================================
+ Notes on upgrading from fmrest < 0.12
+=======================================
+
+There's a small breaking change in fmrest 0.12 that will most likely not affect
+you, but you may want to be aware of:
+
+Previous to this version the record ID on an FmRest::Spyke::Base instance could
+be set with `id=`. This caused problems in cases where a FileMaker layout had a
+field named `id`, so `id=` got renamed to `__record_id=`. Setting the record ID
+by hand however isn't something useful or that should be done at all, so it's
+very unlikely that this change will affect your existing code at all.
+
+Thanks for using fmrest-ruby!
+

data/fmrest.gemspec

@@ -14,23 +14,34 @@ Gem::Specification.new do |spec|
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
-    f.match(%r{^(test|spec|features|bin)/})
+    f.match(%r{^(\.github|test|spec|features|bin)/})
   end
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
+  if File.exist?('UPGRADING')
+    spec.post_install_message = File.read("UPGRADING")
+  end
+
   spec.add_dependency 'faraday', '>= 0.9.0', '< 2.0'
   spec.add_dependency 'faraday_middleware', '>= 0.9.1', '< 2.0'
 
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "spyke"
+  spec.add_development_dependency "spyke", ">= 5.3.3"
   spec.add_development_dependency "webmock"
   spec.add_development_dependency "pry-byebug"
   spec.add_development_dependency "activerecord", ENV["ACTIVE_RECORD_VERSION"]
-  spec.add_development_dependency "sqlite3", ENV["SQLITE3_VERSION"]
+
+  sqlite3_version = if (4.2..5.2).include?(ENV["ACTIVE_RECORD_VERSION"].to_s.gsub(/[^\d.]/, "").to_f)
+                      "~> 1.3.0"
+                    else
+                      "~> 1.4.0"
+                    end
+
+  spec.add_development_dependency "sqlite3", sqlite3_version
   spec.add_development_dependency "mock_redis"
   spec.add_development_dependency "moneta"
   spec.add_development_dependency "yard"

data/lib/fmrest/spyke/base.rb

@@ -5,19 +5,5 @@ module FmRest
     class Base < ::Spyke::Base
       include FmRest::Spyke::Model
     end
-
-    class << self
-      def Base(config = nil)
-        warn "[DEPRECATION] Inheriting from `FmRest::Spyke::Base(config)` is deprecated and will be removed, inherit from `FmRest::Spyke::Base` (without arguments) and use `fmrest_config=` instead"
-
-        if config
-          return Class.new(::FmRest::Spyke::Base) do
-                   self.fmrest_config = config
-                 end
-        end
-
-        ::FmRest::Spyke::Base
-      end
-    end
   end
 end

data/lib/fmrest/spyke/container_field.rb

@@ -42,7 +42,7 @@ module FmRest
           )
 
         # Update mod id on record
-        @base.mod_id = response.body[:data][:mod_id]
+        @base.__mod_id = response.body[:data][:__mod_id]
 
         true
       end
@@ -52,7 +52,7 @@ module FmRest
       # @param repetition [Integer]
       # @return [String] the path for uploading a file to the container
       def upload_path(repetition)
-        FmRest::V1.container_field_path(@base.class.layout, @base.id, name, repetition)
+        FmRest::V1.container_field_path(@base.class.layout, @base.__record_id, name, repetition)
       end
     end
   end

data/lib/fmrest/spyke/model.rb

@@ -2,6 +2,7 @@
 
 require "fmrest/spyke/model/connection"
 require "fmrest/spyke/model/uri"
+require "fmrest/spyke/model/record_id"
 require "fmrest/spyke/model/attributes"
 require "fmrest/spyke/model/serialization"
 require "fmrest/spyke/model/associations"
@@ -17,7 +18,8 @@ module FmRest
       extend ::ActiveSupport::Concern
 
       include Connection
-      include Uri
+      include URI
+      include RecordID
       include Attributes
       include Serialization
       include Associations
@@ -26,11 +28,6 @@ module FmRest
       include GlobalFields
       include Http
       include Auth
-
-      included do
-        # @return [Integer] the record's modId
-        attr_accessor :mod_id
-      end
     end
   end
 end

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

@@ -5,6 +5,8 @@ require "fmrest/spyke/portal"
 module FmRest
   module Spyke
     module Model
+      # This module adds portal support to Spyke models.
+      #
       module Associations
         extend ::ActiveSupport::Concern
 
@@ -22,17 +24,18 @@ module FmRest
         end
 
         class_methods do
-          # Based on +has_many+, but creates a special Portal association
+          # Based on `has_many`, but creates a special Portal association
           # instead.
           #
-          # Custom options:
+          # @option :portal_key [String] The key used for the portal in the FM
+          #   Data JSON portalData
+          # @option :attribute_prefix [String] The prefix used for portal
+          #   attributes in the FM Data JSON
           #
-          # * <tt>:portal_key</tt> - The key used for the portal in the FM Data JSON portalData.
-          # * <tt>:attribute_prefix</tt> - The prefix used for portal attributes in the FM Data JSON.
-          #
-          # Example:
-          #
-          #   has_portal :jobs, portal_key: "JobsTable", attribute_prefix: "Job"
+          # @example
+          #   class Person < FmRest::Spyke::Base
+          #     has_portal :jobs, portal_key: "JobsTable", attribute_prefix: "Job"
+          #   end
           #
           def has_portal(name, options = {})
             create_association(name, Portal, options)
@@ -47,9 +50,8 @@ module FmRest
           end
         end
 
-        # Override Spyke's association reader to keep a cache of loaded
-        # portals. Spyke's default behavior is to reload the association
-        # each time.
+        # Spyke override -- Keep a cache of loaded portals. Spyke's default
+        # behavior is to reload the association each time.
         #
         def association(name)
           @loaded_portals ||= {}
@@ -64,6 +66,8 @@ module FmRest
           end
         end
 
+        # Spyke override -- Add portals awareness
+        #
         def reload(*_)
           super.tap { @loaded_portals = nil }
         end

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

@@ -5,6 +5,10 @@ require "fmrest/spyke/model/orm"
 module FmRest
   module Spyke
     module Model
+      # Extends Spyke models with support for mapped attributes,
+      # `ActiveModel::Dirty` and forbidden attributes (e.g. Rails'
+      # `params.permit`).
+      #
       module Attributes
         extend ::ActiveSupport::Concern
 
@@ -20,9 +24,6 @@ module FmRest
           # by Spyke
           self.attribute_method_matchers.shift
 
-          # ActiveModel::Dirty methods for id
-          define_attribute_method(:id)
-
           # Keep track of attribute mappings so we can get the FM field names
           # for changed attributes
           class_attribute :mapped_attributes, instance_writer: false, instance_predicate: false
@@ -36,10 +37,12 @@ module FmRest
         end
 
         class_methods do
+          # Spyke override
+          #
           # Similar to Spyke::Base.attributes, but allows defining attribute
           # methods that map to FM attributes with different names.
           #
-          # Example:
+          # @example
           #
           #   class Person < Spyke::Base
           #     include FmRest::Spyke::Model
@@ -61,9 +64,10 @@ module FmRest
 
           private
 
-          # Override Spyke::Base.new_or_return (private), called whenever
-          # loading records from the HTTP API, so we can reset dirty info on
-          # freshly loaded records
+          # Spyke override (private)
+          #
+          # Called whenever loading records from the HTTP API, so we can reset
+          # dirty info on freshly loaded records
           #
           # See: https://github.com/balvig/spyke/blob/master/lib/spyke/http.rb
           #
@@ -88,8 +92,6 @@ module FmRest
           end
 
           def _fmrest_define_attribute(from, to)
-            raise ArgumentError, "attribute name `id' is reserved for the recordId" if from.to_s == "id"
-
             # We use a setter here instead of injecting the hash key/value pair
             # directly with #[]= so that we don't change the mapped_attributes
             # hash on the parent class. The resulting hash is frozen for the
@@ -112,35 +114,25 @@ module FmRest
           end
         end
 
-        def id=(value)
-          id_will_change! unless value == id
-          super
-        end
-
+        # Spyke override -- Adds AM::Dirty support
+        #
         def reload(*args)
           super.tap { |r| clear_changes_information }
         end
 
+        # Spyke override -- Adds AM::Dirty support
+        #
         def save(*args)
           super.tap { |r| changes_applied_after_save if r }
         end
 
-        # ActiveModel::Dirty since version 5.2 assumes that if there's an
-        # @attributes instance variable set we must be using ActiveRecord, so
-        # we override the instance variable name used by Spyke to avoid issues.
-        #
-        # TODO: Submit a pull request to Spyke so this isn't needed
-        #
-        def attributes
-          @_spyke_attributes
-        end
-
-        # In addition to the comments above on `attributes`, this also adds
-        # support for forbidden attributes
+        # Spyke override -- Adds support for forbidden attributes (i.e. Rails'
+        # `params.permit`, etc.)
         #
         def attributes=(new_attributes)
-          @_spyke_attributes ||= ::Spyke::Attributes.new(scope.params)
-          use_setters(sanitize_for_mass_assignment(new_attributes)) if new_attributes && !new_attributes.empty?
+          @spyke_attributes ||= ::Spyke::Attributes.new(scope.params)
+          return unless new_attributes && !new_attributes.empty?
+          use_setters(sanitize_for_mass_assignment(new_attributes))
         end
 
         private
@@ -153,7 +145,7 @@ module FmRest
           mapped_attributes.values_at(*changed)
         end
 
-        # Use known mapped_attributes for inspect
+        # Spyke override (private) -- Use known mapped_attributes for inspect
         #
         def inspect_attributes
           mapped_attributes.except(primary_key).map do |k, v|

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

@@ -3,6 +3,9 @@
 module FmRest
   module Spyke
     module Model
+      # This module provides methods for configuring the Farday connection for
+      # the model, as well as setting up the connection itself.
+      #
       module Connection
         extend ActiveSupport::Concern
 
@@ -10,7 +13,7 @@ module FmRest
           class_attribute :faraday_block, instance_accessor: false, instance_predicate: false
           class << self; private :faraday_block, :faraday_block=; end
 
-          # FM Data API expects PATCH for updates (Spyke's default is PUT)
+          # FM Data API expects PATCH for updates (Spyke uses PUT by default)
           self.callback_methods = { create: :post, update: :patch }.freeze
         end
 
@@ -23,28 +26,37 @@ module FmRest
             FmRest.default_connection_settings
           end
 
-          # Behaves similar to ActiveSupport's class_attribute, redefining the
-          # reader method so it can be inherited and overwritten in subclasses
+          # Sets the FileMaker connection settings for the model.
+          #
+          # Behaves similar to ActiveSupport's `class_attribute`, so it can be
+          # inherited and safely overwritten in subclasses.
+          #
+          # @param settings [Hash] The settings hash
           #
           def fmrest_config=(settings)
             settings = ConnectionSettings.new(settings, skip_validation: true)
 
-            redefine_singleton_method(:fmrest_config) do
+            singleton_class.redefine_method(:fmrest_config) do
               overlay = fmrest_config_overlay
               return settings.merge(overlay, skip_validation: true) if overlay
               settings
             end
           end
 
-          # Allows overwriting some connection settings in a thread-local
+          # Allows overriding some connection settings in a thread-local
           # manner. Useful in the use case where you want to connect to the
           # same database using different accounts (e.g. credentials provided
-          # by users in a web app context)
+          # by users in a web app context).
+          #
+          # @param (see #fmrest_config=)
           #
           def fmrest_config_overlay=(settings)
             Thread.current[fmrest_config_overlay_key] = settings
           end
 
+          # @return [FmRest::ConnectionSettings] the connection settings
+          #   overlay if any is in use
+          #
           def fmrest_config_overlay
             Thread.current[fmrest_config_overlay_key] || begin
               superclass.fmrest_config_overlay
@@ -53,10 +65,23 @@ module FmRest
             end
           end
 
+          # Clears the connection settings overlay.
+          #
           def clear_fmrest_config_overlay
             Thread.current[fmrest_config_overlay_key] = nil
           end
 
+          # Runs a block of code in the context of the given connection
+          # settings without affecting the connection settings outside said
+          # block.
+          #
+          # @param (see #fmrest_config=)
+          #
+          # @example
+          #   Honeybee.with_overlay(username: "...", password: "...") do
+          #     Honeybee.query(...)
+          #   end
+          #
           def with_overlay(settings, &block)
             Fiber.new do
               begin
@@ -68,19 +93,22 @@ module FmRest
             end.resume
           end
 
+          # Spyke override -- Defaults to `fmrest_connection`
+          #
           def connection
             super || fmrest_connection
           end
 
           # Sets a block for injecting custom middleware into the Faraday
-          # connection. Example usage:
+          # connection.
           #
-          #     class MyModel < FmRest::Spyke::Base
-          #       faraday do |conn|
-          #         # Set up a custom logger for the model
-          #         conn.response :logger, MyApp.logger, bodies: true
-          #       end
+          # @example
+          #   class MyModel < FmRest::Spyke::Base
+          #     faraday do |conn|
+          #       # Set up a custom logger for the model
+          #       conn.response :logger, MyApp.logger, bodies: true
           #     end
+          #   end
           #
           def faraday(&block)
             self.faraday_block = block

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

@@ -5,10 +5,25 @@ require "fmrest/spyke/container_field"
 module FmRest
   module Spyke
     module Model
+      # This module adds support for container fields.
+      #
       module ContainerFields
         extend ::ActiveSupport::Concern
 
         class_methods do
+          # Defines a container field on the model.
+          #
+          # @param name [Symbol] the name of the container field
+          #
+          # @option options [String] :field_name (nil) the name of the container
+          #   field in the FileMaker layout (only needed if it doesn't match
+          #   the name given)
+          #
+          # @example
+          #   class Honeybee < FmRest::Spyke::Base
+          #     container :photo, field_name: "Beehive Photo ID"
+          #   end
+          #
           def container(name, options = {})
             field_name = options[:field_name] || name
 

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

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require "fmrest/spyke/relation"
-
 module FmRest
   module Spyke
     module Model
@@ -15,6 +13,8 @@ module FmRest
           # execution results after a save, etc.
 
 
+          # Spyke override -- Keeps metadata in thread-local class variable.
+          #
           def request(*args)
             super.tap do |r|
               Thread.current[last_request_metadata_key] = r.metadata
@@ -32,6 +32,46 @@ module FmRest
           end
         end
       end
+
+      # Spyke override -- Uses `__record_id` for building the record URI.
+      #
+      def uri
+        ::Spyke::Path.new(@uri_template, fmrest_uri_attributes) if @uri_template
+      end
+
+      private
+
+      # Spyke override (private) -- Use `__record_id` instead of `id`
+      #
+      def resolve_path_from_action(action)
+        case action
+        when Symbol then uri.join(action)
+        when String then ::Spyke::Path.new(action, fmrest_uri_attributes)
+        else uri
+        end
+      end
+
+      def fmrest_uri_attributes
+        if persisted?
+          { __record_id: __record_id }
+        else
+          # NOTE: it seems silly to be calling attributes.slice(:__record_id)
+          # when the record is supposed to not have a record_id set (since
+          # persisted? is false here), but it makes sense in the context of how
+          # Spyke works:
+          #
+          # When calling Model.find(id), Spyke will internally create a scope
+          # with .where(primary_key => id) and call .find_one on it. Then,
+          # somewhere down the line Spyke creates a new empty instance of the
+          # current model class to get its .uri property (the one we're
+          # partially building through this method and which contains these URI
+          # attributes). When initializing a record Spyke first forcefully
+          # assigns the .where()-set attributes from the current scope onto
+          # that instance's attributes hash, which then leads us right here,
+          # where we might have __record_id assigned as a scope attribute:
+          attributes.slice(:__record_id)
+        end
+      end
     end
   end
 end

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

@@ -6,6 +6,10 @@ require "fmrest/spyke/validation_error"
 module FmRest
   module Spyke
     module Model
+      # This module adds and extends various ORM features in Spyke models,
+      # including custom query methods, remote script execution and
+      # exception-raising persistence methods.
+      #
       module Orm
         extend ::ActiveSupport::Concern
 
@@ -21,22 +25,25 @@ module FmRest
         end
 
         class_methods do
-          # Methods delegated to FmRest::Spyke::Relation
+          # 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
 
+          # Spyke override -- Use FmRest's Relation instead of Spyke's vanilla
+          # one
+          #
           def all
-            # Use FmRest's Relation instead of Spyke's vanilla one
             current_scope || Relation.new(self, uri: uri)
           end
 
-          # Extended fetch to allow properly setting limit, offset and other
+          # Spyke override -- allows properly setting limit, offset and other
           # options, as well as using the appropriate HTTP method/URL depending
-          # on whether there's a query present in the current scope, e.g.:
+          # on whether there's a query present in the current scope.
           #
-          #     Person.query(first_name: "Stefan").fetch # POST .../_find
+          # @example
+          #   Person.query(first_name: "Stefan").fetch # -> POST .../_find
           #
           def fetch
             if current_scope.has_query?
@@ -62,12 +69,21 @@ module FmRest
             self.current_scope = previous
           end
 
-          # API-error-raising version of #create
+          # Exception-raising version of `#create`
+          #
+          # @param attributes [Hash] the attributes to initialize the
+          #   record with
           #
           def create!(attributes = {})
             new(attributes).tap(&:save!)
           end
 
+          # Requests execution of a FileMaker script.
+          #
+          # @param script_name [String] the name of the FileMaker script to
+          #   execute
+          # @param param [String] an optional paramater for the script
+          #
           def execute_script(script_name, param: nil)
             params = {}
             params = {"script.param" => param} unless param.nil?
@@ -108,12 +124,20 @@ module FmRest
           end
         end
 
-        # Overwrite Spyke's save to provide a number of features:
+        # Spyke override -- Adds a number of features to original `#save`:
         #
         # * Validations
         # * Data API scripts execution
         # * Refresh of dirty attributes
         #
+        # @option options [String] :script the name of a FileMaker script to execute
+        #   upon saving
+        # @option options [Boolean] :raise_validation_errors whether to raise an
+        #   exception if validations fail
+        #
+        # @return [true] if saved successfully
+        # @return [false] if validations or persistence failed
+        #
         def save(options = {})
           callback = persisted? ? :update : :create
 
@@ -123,11 +147,34 @@ module FmRest
           true
         end
 
+        # Exception-raising version of `#save`.
+        #
+        # @option (see #save)
+        #
+        # @return [true] if saved successfully
+        #
+        # @raise if validations or presistence failed
+        #
         def save!(options = {})
           save(options.merge(raise_validation_errors: true))
         end
 
-        # Overwrite Spyke's destroy to provide Data API script execution
+        # Exception-raising version of `#update`.
+        #
+        # @param new_attributes [Hash] a hash of record attributes to update
+        #   the record with
+        #
+        # @option (see #save)
+        #
+        def update!(new_attributes, options = {})
+          self.attributes = new_attributes
+          save!(options)
+        end
+
+        # Spyke override -- Adds support for Data API script execution.
+        #
+        # @option options [String] :script the name of a FileMaker script to execute
+        #   upon deletion
         #
         def destroy(options = {})
           # For whatever reason the Data API wants the script params as query
@@ -142,22 +189,19 @@ module FmRest
           self.attributes = delete(uri.to_s + script_query_string)
         end
 
-        # API-error-raising version of #update
+        # (see #destroy)
+        #
+        # @option (see #destroy)
         #
-        def update!(new_attributes, options = {})
-          self.attributes = new_attributes
-          save!(options)
-        end
-
         def reload(options = {})
           scope = self.class
           scope = scope.script(options[:script]) if options.has_key?(:script)
-          reloaded = scope.find(id)
+          reloaded = scope.find(__record_id)
           self.attributes = reloaded.attributes
-          self.mod_id = reloaded.mod_id
+          self.__mod_id = reloaded.mod_id
         end
 
-        # ActiveModel 5+ implements this method, so we only needed if we're in
+        # ActiveModel 5+ implements this method, so we only need it if we're in
         # the older AM4
         if ActiveModel::VERSION::MAJOR == 4
           def validate!(context = nil)

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

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+module FmRest
+  module Spyke
+    module Model
+      # Modifies Spyke models to use `__record_id` instead of `id` as the
+      # "primary key" method, so that we can map a model class to a FM layout
+      # with a field named `id` without clobbering it.
+      #
+      # The `id` reader method still maps to the record ID for backwards
+      # compatibility and because Spyke hardcodes its use at various points
+      # through its codebase, but it can be safely overwritten (e.g. to map to
+      # a FM field).
+      #
+      # The recommended way to deal with a layout that maps an `id` attribute
+      # is to remap it in the model to something else, e.g. `unique_id`.
+      #
+      module RecordID
+        extend ::ActiveSupport::Concern
+
+        included do
+          # @return [Integer] the record's recordId
+          attr_accessor :__record_id
+          alias_method :record_id, :__record_id
+          alias_method :id, :__record_id
+
+          # @return [Integer] the record's modId
+          attr_accessor :__mod_id
+          alias_method :mod_id, :__mod_id
+
+          # Get rid of Spyke's id= setter method, as we'll be using __record_id=
+          # instead
+          undef_method :id=
+
+          # Tell Spyke that we want __record_id as the PK
+          self.primary_key = :__record_id
+        end
+
+        def __record_id?
+          __record_id.present?
+        end
+        alias_method :record_id?, :__record_id?
+        alias_method :persisted?, :__record_id?
+
+        # Spyke override -- Use `__record_id` instead of `id`
+        #
+        def hash
+          __record_id.hash
+        end
+
+        # Spyke override -- Renders class string with layout name and
+        # `record_id`.
+        #
+        # @return [String] A string representation of the class
+        #
+        def inspect
+          "#<#{self.class}(layout: #{self.class.layout}) record_id: #{__record_id.inspect} #{inspect_attributes}>"
+        end
+
+        # Spyke override -- Use `__record_id` instead of `id`
+        #
+        # @param id [Integer] The id of the record to destroy
+        #
+        def destroy(id = nil)
+          new(__record_id: id).destroy
+        end
+
+        private
+
+        # Spyke override (private)
+        #
+        def conflicting_ids?(attributes)
+          false
+        end
+      end
+    end
+  end
+end

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

@@ -7,8 +7,8 @@ module FmRest
         FM_DATE_FORMAT = "%m/%d/%Y"
         FM_DATETIME_FORMAT = "#{FM_DATE_FORMAT} %H:%M:%S"
 
-        # Override Spyke's to_params to return FM Data API's expected JSON
-        # format, and including only modified fields
+        # Spyke override -- Return FM Data API's expected JSON format,
+        # including only modified fields.
         #
         def to_params
           params = {

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

@@ -3,7 +3,7 @@
 module FmRest
   module Spyke
     module Model
-      module Uri
+      module URI
         extend ::ActiveSupport::Concern
 
         class_methods do
@@ -14,13 +14,12 @@ module FmRest
             @layout ||= model_name.name
           end
 
-          # Extend uri acccessor to default to FM Data schema
+          # Spyke override -- Extends `uri` to default to FM Data's URI schema
           #
           def uri(uri_template = nil)
             if @uri.nil? && uri_template.nil?
-              return FmRest::V1.record_path(layout) + "(/:id)"
+              return FmRest::V1.record_path(layout) + "(/:#{primary_key})"
             end
-
             super
           end
         end

data/lib/fmrest/spyke/spyke_formatter.rb

@@ -63,8 +63,8 @@ module FmRest
         response = json[:response]
 
         data = {}
-        data[:mod_id] = response[:modId] if response[:modId]
-        data[:id]     = response[:recordId].to_i if response[:recordId]
+        data[:__mod_id] = response[:modId] if response[:modId]
+        data[:__record_id] = response[:recordId].to_i if response[:recordId]
 
         build_base_hash(json, true).merge!(data: data)
       end
@@ -188,7 +188,7 @@ module FmRest
       # @param json_data [Hash]
       # @return [Hash] the record data in Spyke format
       def prepare_record_data(json_data)
-        out = { id: json_data[:recordId].to_i, mod_id: json_data[:modId] }
+        out = { __record_id: json_data[:recordId].to_i, __mod_id: json_data[:modId] }
         out.merge!(json_data[:fieldData])
         out.merge!(prepare_portal_data(json_data[:portalData])) if json_data[:portalData]
         out
@@ -213,8 +213,8 @@ module FmRest
 
           out[portal_name] =
             portal_records.map do |portal_fields|
-              attributes = { id: portal_fields[:recordId].to_i }
-              attributes[:mod_id] = portal_fields[:modId] if portal_fields[:modId]
+              attributes = { __record_id: portal_fields[:recordId].to_i }
+              attributes[:__mod_id] = portal_fields[:modId] if portal_fields[:modId]
 
               prefix = portal_options[:attribute_prefix] || portal_name
               prefix_matcher = /\A#{prefix}::/

data/lib/fmrest/token_store/null.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require "singleton"
+
+module FmRest
+  module TokenStore
+    module Null < Base
+      include Singleton
+
+      def delete(key)
+      end
+
+      def load(key)
+      end
+
+      def store(key, value)
+      end
+    end
+  end
+end

data/lib/fmrest/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fmrest
 version: !ruby/object:Gem::Version
-  version: 0.11.1
+  version: 0.12.0
 platform: ruby
 authors:
 - Pedro Carbajal
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-09-24 00:00:00.000000000 Z
+date: 2020-11-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -98,14 +98,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 5.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 5.3.3
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
@@ -152,16 +152,16 @@ dependencies:
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.4.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.4.0
 - !ruby/object:Gem::Dependency
   name: mock_redis
   requirement: !ruby/object:Gem::Requirement
@@ -226,7 +226,6 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
@@ -236,6 +235,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- UPGRADING
 - fmrest.gemspec
 - lib/fmrest.rb
 - lib/fmrest/connection_settings.rb
@@ -252,6 +252,7 @@ files:
 - lib/fmrest/spyke/model/global_fields.rb
 - lib/fmrest/spyke/model/http.rb
 - lib/fmrest/spyke/model/orm.rb
+- lib/fmrest/spyke/model/record_id.rb
 - lib/fmrest/spyke/model/serialization.rb
 - lib/fmrest/spyke/model/uri.rb
 - lib/fmrest/spyke/portal.rb
@@ -264,6 +265,7 @@ files:
 - 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
@@ -282,7 +284,22 @@ homepage: https://github.com/beezwax/fmrest-ruby
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message: |+
+  =======================================
+   Notes on upgrading from fmrest < 0.12
+  =======================================
+
+  There's a small breaking change in fmrest 0.12 that will most likely not affect
+  you, but you may want to be aware of:
+
+  Previous to this version the record ID on an FmRest::Spyke::Base instance could
+  be set with `id=`. This caused problems in cases where a FileMaker layout had a
+  field named `id`, so `id=` got renamed to `__record_id=`. Setting the record ID
+  by hand however isn't something useful or that should be done at all, so it's
+  very unlikely that this change will affect your existing code at all.
+
+  Thanks for using fmrest-ruby!
+
 rdoc_options: []
 require_paths:
 - lib
@@ -302,3 +319,4 @@ signing_key:
 specification_version: 4
 summary: FileMaker Data API client using Faraday
 test_files: []
+...

data/.github/workflows/ci.yml

@@ -1,33 +0,0 @@
-# This workflow uses actions that are not certified by GitHub.
-# They are provided by a third-party and are governed by
-# separate terms of service, privacy policy, and support
-# documentation.
-# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
-# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
-
-name: CI
-
-on:
-  push:
-    branches: [ master ]
-  pull_request:
-    branches: [ master ]
-
-jobs:
-  test:
-
-    runs-on: ubuntu-latest
-
-    steps:
-    - uses: actions/checkout@v2
-    - name: Set up Ruby
-    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
-    # change this to (see https://github.com/ruby/setup-ruby#versioning):
-    # uses: ruby/setup-ruby@v1
-      uses: ruby/setup-ruby@ec106b438a1ff6ff109590de34ddc62c540232e0
-      with:
-        ruby-version: 2.6
-    - name: Install dependencies
-      run: bundle install
-    - name: Run specs
-      run: bundle exec rspec spec