fmrest-core 0.21.0 → 0.23.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1dcd50851dca459061ccd7a2f55a2b3dcadea27ed5aa91aa854fb23660747667
-  data.tar.gz: ee483bb0ded64cda1342d38a9afa97789e1bcc6b813602543787c049eea038b8
+  metadata.gz: e4204d06743939015713907f35c283ff99decd257a0aaee50593ed3a660b87d9
+  data.tar.gz: ca4a4c30b8a06d0f3eb20601d9003328d2c63e651f9acf35c03838ba690fddfc
 SHA512:
-  metadata.gz: 5570a533c122bbfae3d3cbdbcee96bdf4ed1d3ebfe43691ec92acb0ed078a2b5badf0cf546afd2d6a9d877425203fefab737bf24594b92cf64639c66ebb51ba4
-  data.tar.gz: adbd2c191f65cc2a67f2db3b571f7c287c12eddbfd6c3c31e32a5d730b7d8ada2f61197c9e0df731aa748b1a2caa443ca3d17d16f483437107d16fc4440c6f79
+  metadata.gz: 58817b269adc26fa4c74f180ac4b1b8de5578bb041979bf694fa2b977a96a2830368c21617b1e82722b266f8c6829772c94332afbc527680d3e6146ebec0786c
+  data.tar.gz: 3306e169f3aad1b6c32291cc9541b354f8316baa7d08abbd3ac31fe453d8051abd0352a065a7d1b4fd9857b08f9d7bd106725ebfab5807492bad305ca437328c

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,18 @@
 ## Changelog
 
+### 0.23.1
+
+* Fix crash when booting in Rails and `config/fmrest.yml` didn't exist
+
+### 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

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

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

data/lib/fmrest.rb

@@ -48,10 +48,9 @@ module FmRest
                   end
     end
 
-    # Shortcut for FmRest::V1.escape_find_operators
+    # Shortcut for `FmRest::V1.escape_find_operators`
     #
-    # @param (see FmRest::V1.escape_find_operators
-    # @return (see FmRest::V1.escape_find_operators
+    # @see FmRest::V1.escape_find_operators
     def e(s)
       V1.escape_find_operators(s)
     end
@@ -69,3 +68,9 @@ module FmRest
     end
   end
 end
+
+begin
+  require "fmrest/railtie" if defined?(Rails::Railtie)
+# In case fmrest-rails is not installed
+rescue LoadError
+end

data/lib/generators/fmrest/config/config_generator.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+# This is capitalized differently (Fmrest vs FmRest) on purpose, so the
+# generator can be found as "fmrest:config"
+module Fmrest
+  module Generators
+    class ConfigGenerator < Rails::Generators::Base
+      source_root File.expand_path('templates', __dir__)
+
+      def copy_config_file
+        copy_file "fmrest.yml", "config/fmrest.yml"
+      end
+
+      def copy_initializer_file
+        copy_file "fmrest_initializer.rb", "config/initializers/fmrest.rb"
+      end
+    end
+  end
+end

data/lib/generators/fmrest/config/templates/fmrest.yml

@@ -0,0 +1,18 @@
+development:
+  host: 
+  database: 
+  username: 
+  password: 
+
+  # Additional options
+  #
+  # log: false
+  #
+  # ssl:
+  #   verify: true
+
+test:
+  host: 
+  database: 
+  username: 
+  password: 

data/lib/generators/fmrest/config/templates/fmrest_initializer.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+# Use ActiveRecord token store
+FmRest.token_store = FmRest::TokenStore::ActiveRecord
+
+# Use ActiveRecord token store with custom table name
+# FmRest.token_store = FmRest::TokenStore::ActiveRecord.new(table_name: "my_token_store")
+
+# Use Redis token store (requires redis gem)
+# FmRest.token_store = FmRest::TokenStore::Redis
+
+# Use Redis token store with custom prefix
+# FmRest.token_store = FmRest::TokenStore::Redis.new(prefix: "my-fmrest-token:")
+
+# Use Moneta token store (requires moneta gem)
+# FmRest.token_store = FmRest::TokenStore::Moneta.new(backend: )
+
+# Use Memory token store (not suitable for production)
+# FmRest.token_store = FmRest::TokenStore::Memory

data/lib/generators/fmrest/model/model_generator.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+# This is capitalized differently (Fmrest vs FmRest) on purpose, so the
+# generator can be found as "fmrest:config"
+module Fmrest
+  module Generators
+    class ModelGenerator < Rails::Generators::NamedBase
+      source_root File.expand_path('templates', __dir__)
+
+      def create_model_file
+        template "model.rb", "app/models/#{file_name}.rb"
+      end
+    end
+  end
+end

data/lib/generators/fmrest/model/templates/model.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+class <%= class_name %> < FmRest::Layout
+  # Uncomment if your layout name isn't "<%= class_name %>", or delete:
+  # layout "<%= plural_name %>"
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fmrest-core
 version: !ruby/object:Gem::Version
-  version: 0.21.0
+  version: 0.23.1
 platform: ruby
 authors:
 - Pedro Carbajal
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-05-12 00:00:00.000000000 Z
+date: 2022-07-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -77,6 +77,11 @@ files:
 - lib/fmrest/v1/type_coercer.rb
 - lib/fmrest/v1/utils.rb
 - lib/fmrest/version.rb
+- lib/generators/fmrest/config/config_generator.rb
+- lib/generators/fmrest/config/templates/fmrest.yml
+- lib/generators/fmrest/config/templates/fmrest_initializer.rb
+- lib/generators/fmrest/model/model_generator.rb
+- lib/generators/fmrest/model/templates/model.rb
 homepage: https://github.com/beezwax/fmrest-ruby
 licenses:
 - MIT