fmrest-spyke 0.21.0.rc1 → 0.23.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4034ed2549cfbfb4acd3e9adedaa0adbdc9ff15264ee37558389fbed227a8132
-  data.tar.gz: c3d62e198342a7dd043bb27da0b0883e6c6b5ea05021c47113fe1aed918662f9
+  metadata.gz: f9956beb060ba224625cbc91c6d15169fcc24002d8868c8736fa8ee474d64afc
+  data.tar.gz: 9991f5c849f766a9a0660c3072f2ac6cb677d311888a9d536ecbe0c0c18dfeb5
 SHA512:
-  metadata.gz: 520f8c2b00b1a30b673fadc3fdb7cfb1a9a37b434114757a00d375fd838e00096c3a5094dfdc6a797f77b557aabee15a94a0126615fa7b95a582dde042d4a7c0
-  data.tar.gz: 0a1f3b4c7641d80a81e85f74d054bb1cd0385d6815afcf19c687f1fcda5b72fac9a723e00bec06c7dd2ff0b034351031fc12a7843238fd85665a9628b493dbd9
+  metadata.gz: b11f7d8f9e582185534aec7ba8497d2f74a371a8bc5322e4f48849ec8fe84f841bca705cf0cfb884b8f96298c677883ccaaf98e5816a7923b414a4dd6f815bc3
+  data.tar.gz: 41063c5e3993b525131ab84c27eda309eadfec7fe5ba4c0458605221a707e1e60ce87e3ba7f6737476e7cdb2b735fe686aeba68064b66e130b905a5d6550e3d3

data/.yardopts

@@ -1,5 +1,6 @@
 --markup markdown
 --plugin activesupport-concern
-lib/**/*.rb
+--exclude lib/generators/*
 -
+lib/**/*.rb
 docs/*

data/CHANGELOG.md

@@ -1,5 +1,20 @@
 ## Changelog
 
+### 0.23.0
+
+* Add `find_one!` (aliased as `first!`) exception-raising method
+* Add mapping of API exceptions to HTTP responses in Rails
+
+### 0.22.0 
+
+* Add `fmrest-rails` gem with Rails integration (initializer, generators)
+
+### 0.21.0
+
+* Support for Spyke 7 and Faraday 2
+* Drop support for Faraday 1
+* Drop support for Ruby 2.5
+
 ### 0.20.0
 
 * Forward proxy options to AWS Client when using `fmrest-cloud` gem

data/README.md

@@ -19,13 +19,14 @@ Need Ruby or FileMaker consulting? Contact us at
 
 ## Gems
 
-The `fmrest` gem is a wrapper for two other gems:
+The `fmrest` gem is a wrapper for these gems:
 
 * `fmrest-spyke`, providing an ActiveRecord-like ORM library built on top
   of `fmrest-core` and [Spyke](https://github.com/balvig/spyke).
 * `fmrest-core`, providing the core
   [Faraday](https://github.com/lostisland/faraday) connection builder, session
   management, and other core utilities.
+* `fmrest-rails`, providing Rails integration.
 
 In addition, the optional `fmrest-cloud` gem adds support for FileMaker Cloud.
 See the [main document on connecting to FileMaker
@@ -42,6 +43,12 @@ gem 'fmrest'
 gem 'fmrest-cloud'
 ```
 
+If you're using Rails you can now run:
+
+```
+rails generate fmrest:config
+```
+
 ## Simple example
 
 ```ruby

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

@@ -18,10 +18,6 @@ module FmRest
           class_attribute :default_limit, instance_accessor: false, instance_predicate: false
 
           class_attribute :default_sort, instance_accessor: false, instance_predicate: false
-
-          # Whether to raise an FmRest::APIError::NoMatchingRecordsError when a
-          # _find request has no results
-          class_attribute :raise_on_no_matching_records, instance_accessor: false, instance_predicate: false
         end
 
         class_methods do
@@ -42,10 +38,14 @@ module FmRest
           # options, as well as using the appropriate HTTP method/URL depending
           # on whether there's a query present in the current scope.
           #
+          # @option options [Boolean] :raise_on_no_matching_records whether to
+          #   raise `APIError::NoMatchingRecordsError` when no records match (FM
+          #   error 401). If not given it returns an empty resultset.
+          #
           # @example
           #   Person.query(first_name: "Stefan").fetch # -> POST .../_find
           #
-          def fetch
+          def fetch(options = {})
             if current_scope.has_query?
               scope = extend_scope_with_fm_params(current_scope, prefixed: false)
               scope = scope.where(query: scope.query_params)
@@ -60,9 +60,9 @@ module FmRest
             # nothing matches a _find request, so we need to catch it in order
             # to provide sane behavior (i.e. return an empty resultset)
             begin
-              current_scope.has_query? ? scoped_request(:post) : super
+              current_scope.has_query? ? scoped_request(:post) : super()
             rescue FmRest::APIError::NoMatchingRecordsError => e
-              raise e if raise_on_no_matching_records
+              raise e if options[:raise_on_no_matching_records]
               ::Spyke::Result.new({})
             end
           ensure

data/lib/fmrest/spyke/relation.rb

@@ -276,13 +276,15 @@ module FmRest
       # Finds a single instance of the model by forcing limit = 1, or simply
       # fetching the record by id if the primary key was set
       #
+      # @option (see FmRest::Spyke::Model::ORM.fetch)
+      #
       # @return [FmRest::Spyke::Base]
-      def find_one
+      def find_one(options = {})
         @find_one ||=
           if primary_key_set?
-            without_collection_params { super }
+            without_collection_params { super() }
           else
-            klass.new_collection_from_result(limit(1).fetch).first
+            klass.new_collection_from_result(limit(1).fetch(options)).first
           end
       rescue ::Spyke::ConnectionError => error
         fallback_or_reraise(error, default: nil)
@@ -290,6 +292,18 @@ module FmRest
       alias_method :first, :find_one
       alias_method :any, :find_one
 
+      # Same as `#find_one`, but raises `APIError::NoMatchingRecordsError` when
+      # no records match.
+      # Equivalent to calling `find_one(raise_on_no_matching_records: true)`.
+      #
+      # @option (see FmRest::Spyke::Model::ORM.fetch)
+      #
+      # @return [FmRest::Spyke::Base]
+      def find_one!(options = {})
+        find_one(options.merge(raise_on_no_matching_records: true))
+      end
+      alias_method :first!, :find_one!
+
       # Yields each batch of records that was found by the find options.
       #
       # NOTE: By its nature, batch processing is subject to race conditions if

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fmrest-spyke
 version: !ruby/object:Gem::Version
-  version: 0.21.0.rc1
+  version: 0.23.0
 platform: ruby
 authors:
 - Pedro Carbajal
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-05-12 00:00:00.000000000 Z
+date: 2022-06-24 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.21.0.rc1
+        version: 0.23.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.21.0.rc1
+        version: 0.23.0
 - !ruby/object:Gem::Dependency
   name: spyke
   requirement: !ruby/object:Gem::Requirement
@@ -88,9 +88,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.3.3
 signing_key: