fmrest-core 0.20.0 → 0.22.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 45fc41042ceaacc56c0d27b9d705a635ddad09f34d7e9dbdd33b0965a61a59b3
-  data.tar.gz: 37d8f75cb978808a08745efa558aa58c4369a43b023336c1b67f3921c6031cba
+  metadata.gz: b7ac58128c88341bca022d6470847a1bf0ee489daf71323697e17ba103f0325f
+  data.tar.gz: 7061ed4af4f344646aa4dd4935242f00751473885302cb257283183aadbed763
 SHA512:
-  metadata.gz: 7cf50096d31b71e98238a2a4cde059ff771c32929298c277aa9972fb2ec6ddb4a5ebaeef227e6bb63dba2ccc8e8240afb500db4b88669b67b66a5e9887cbd8cf
-  data.tar.gz: 2b706a20520719bb1311a7b72c5be838168cb88701904da2ffcd5fcdb973015f825447d5367104819387e1d391af26f289105ac1ae7ccf03ea74f6801f097d68
+  metadata.gz: db124b9095a6a8636e5edea83ba9b2c1517aff515336daa37cb882db1818f02f5fb6ceb2eaac7d980d433bbef2892fa708bbb1087fc9bbde1829cd22f738dd67
+  data.tar.gz: 587890573a26cc811da0a7327d4b8b3799f9f7717fb6885b4f2d8414922d48eb53cb54c3cad52050e56bc998e9ade720fe7cd835a9bd36184afbb4271f12729f

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 ## Changelog
 
+### 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

@@ -3,6 +3,7 @@
 [![Gem Version](https://badge.fury.io/rb/fmrest.svg?style=flat)](https://rubygems.org/gems/fmrest)
 ![CI](https://github.com/beezwax/fmrest-ruby/workflows/CI/badge.svg)
 [![Yard Docs](http://img.shields.io/badge/yard-docs-blue.svg)](https://rubydoc.info/github/beezwax/fmrest-ruby)
+[![Powered by Beezwax](https://img.shields.io/badge/Powered%20By-Beezwax-gold?logo=data:image/svg+xml;charset=utf-8;base64,PHN2ZyB3aWR0aD0iMTA5IiBoZWlnaHQ9IjEwOSIgdmlld0JveD0iMCAwIDEwOSAxMDkiIGZpbGw9Im5vbmUiIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyI+DQogICA8Zz4NCiAgICAgIDxwYXRoIGQ9Ik01MC44IDEwNi42MjVDNTkuMSA5OS4zMjUgNjEuOSA5MS42MjUgNjEuOSA5MS42MjVDNjMuMiA4Ny43MjUgNjQuNyA4NC41MjUgNjQuNyA2OS4zMjVDNjQuNyA0Ni40MjUgNTYuMiAzOC45MjUgNDcgMzIuMDI1QzQwLjggMjcuMzI1IDI0LjkgMjEuMTI1IDE1LjUgMTcuNjI1TDIuMjk5OTggMjUuMTI1QzEuNDk5OTggMjUuNzI1IDAuOTk5OTc2IDI2LjIyNSAwLjU5OTk3NiAyNi44MjVDMjQuNCAzMi4xMjUgNDEuNSA0OC4wMjUgNDEuNSA2Ni44MjVDNDEuNSA3OC4yMjUgMzUuMSA4OC42MjUgMjQuOSA5Ni4xMjVMNDQuNyAxMDcuNTI1QzQ1LjEgMTA3LjcyNSA0NiAxMDguMTI1IDQ3LjMgMTA4LjEyNUM0Ny45IDEwOC4xMjUgNDkgMTA3LjkyNSA1MC4zIDEwNi44MjVMNTAuOCAxMDYuNjI1WiIgZmlsbD0iI0ZGRDkzOSI+PC9wYXRoPg0KICAgICAgPHBhdGggZD0iTTIyLjkgMTMuMzI0OEw0NCAyMC40MjQ4QzY0LjYgMjcuNzI0OCA3My4yIDM3LjgyNDggNzMuMiAzNy44MjQ4Qzg0LjUgNDkuMTI0OCA4My4yIDYxLjYyNDggODMuMiA3Ni44MjQ4QzgzLjIgODAuNjI0OCA4Mi42IDg0LjkyNDggODEuNyA4OS4wMjQ4TDkzIDgyLjYyNDhDOTUuNiA4MS4xMjQ4IDk1LjYgNzcuOTI0OCA5NS42IDc3LjkyNDhWMjkuMzI0OEM5NS42IDI2LjEyNDggOTMgMjQuNjI0OCA5MyAyNC42MjQ4TDcyLjUgMTMuMjI0OEw1MC42IDAuNjI0ODQ1QzQ4LjEgLTAuNjc1MTU1IDQ1LjUgMC40MjQ4NDUgNDUuMyAwLjYyNDg0NUwyMy4xIDEzLjMyNDhIMjIuOVoiIGZpbGw9IiNGRkQ5MzkiPjwvcGF0aD4NCiAgICAgIDxwYXRoIGQ9Ik0wLjEgMzEuNTI0NFY3OC4yMjQ0QzAuMSA4MC44MjQ0IDIuMiA4Mi4zMjQ0IDIuNyA4Mi43MjQ0TDE0LjggODkuNjI0NEwxNy44IDkxLjMyNDRDMjQuNCA4NC43MjQ0IDI4LjQgNzYuMzI0NCAyOC41IDY3LjEyNDRDMjguNSA1MS41MjQ0IDE2LjggMzguMDI0NCAwIDMxLjUyNDRIMC4xWiIgZmlsbD0iI0ZGRDkzOSI+PC9wYXRoPg0KICAgPC9nPg0KPC9zdmc+)](https://beezwax.net/)
 
 A Ruby client for
 [FileMaker's Data API](https://help.claris.com/en/data-api-guide)
@@ -16,29 +17,16 @@ is natively supported by the gem.
 Need Ruby or FileMaker consulting? Contact us at
 [Beezwax.net](https://beezwax.net/)
 
-## Contents
-
-* [Gems](#gems)
-* [Installation](#installation)
-* [Simple example](#simple-example)
-* [Connection settings](#connection-settings)
-* [Session token store](#session-token-store)
-* [Date fields and timezones](#date-fields-and-timezones)
-* [ActiveRecord-like ORM (fmrest-spyke)](#activerecord-like-orm-fmrest-spyke)
-* [Logging](#logging)
-* [Gotchas](#gotchas)
-* [API implementation completeness table](#api-implementation-completeness-table)
-* [Supported Ruby versions](#supported-ruby-versions)
-
 ## 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
@@ -55,6 +43,12 @@ gem 'fmrest'
 gem 'fmrest-cloud'
 ```
 
+If you're using Rails you can now run:
+
+```
+rails generate fmrest:config
+```
+
 ## Simple example
 
 ```ruby
@@ -124,7 +118,8 @@ to, for instance, disable SSL verification:
 {
   host: "…",
   …
-  ssl:  { verify: false }
+  ssl:  { verify: false },
+  proxy: "http://user:password@proxy.host:4321"
 }
 ```
 
@@ -135,13 +130,13 @@ 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
+`:host`             | Hostname with optional port, e.g. `example.com:9000` | 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 URI e.g. `http://username:password@proxy.host:5000` | String / URI | None
+`:ssl`              | SSL options to be forwarded to Faraday     | [Faraday SSL options](https://www.rubydoc.info/gems/faraday/Faraday/SSLOptions) hash | None
+`:proxy`            | Proxy URI, e.g. `http://user:password@proxy.host:4321` | String          | None
 `:log`              | Log JSON responses to STDOUT               | Boolean                     | `false`
 `:log_level`        | Which log level to log into                | Values accepted by `Logger#level=` | `:debug`
 `:coerce_dates`     | See section on [date fields](#date-fields-and-timezones) | Boolean \| `:hybrid` \| `:full` | `false`
@@ -561,13 +556,8 @@ FM Data API reference: https://help.claris.com/en/data-api-guide/
 
 ## Supported Ruby versions
 
-fmrest-ruby aims to support and is [tested against](https://github.com/beezwax/fmrest-ruby/actions?query=workflow%3ACI)
-the following Ruby implementations:
-
-* Ruby 2.5
-* Ruby 2.6
-* Ruby 2.7
-* Ruby 3.0
+fmrest-ruby is [tested against](https://github.com/beezwax/fmrest-ruby/actions?query=workflow%3ACI)
+Ruby 2.6 through 3.1.
 
 ## Gem development
 

data/lib/fmrest/v1/connection.rb

@@ -72,7 +72,7 @@ module FmRest
           elsif is_cloud_host
             conn.request :authorization, CLARIS_ID_HTTP_AUTH_TYPE, -> { Cloud::ClarisIdTokenManager.new(settings).fetch_token }
           else
-            conn.request :basic_auth, settings.username!, settings.password!
+            conn.request :authorization, :basic, settings.username!, settings.password!
           end
 
           if settings.log

data/lib/fmrest/v1/container_fields.rb

@@ -80,11 +80,11 @@ module FmRest
 
         connection.post do |request|
           request.url container_path
-          request.headers['Content-Type'] = ::Faraday::Request::Multipart.mime_type
+          request.headers['Content-Type'] = ::Faraday::Multipart::Middleware.mime_type
 
           filename = options[:filename] || filename_or_io.try(:original_filename)
 
-          request.body = { upload: Faraday::UploadIO.new(filename_or_io, content_type, filename) }
+          request.body = { upload: Faraday::Multipart::FilePart.new(filename_or_io, content_type, filename) }
         end
       end
 

data/lib/fmrest/v1/raise_errors.rb

@@ -5,7 +5,7 @@ module FmRest
     # FM Data API response middleware for raising exceptions on API response
     # errors
     #
-    class RaiseErrors < Faraday::Response::Middleware
+    class RaiseErrors < Faraday::Middleware
       # Error codes reference:
       # https://help.claris.com/en/pro-help/content/error-codes.html
       ERROR_RANGES = {

data/lib/fmrest/v1/type_coercer.rb

@@ -4,7 +4,7 @@ require "fmrest/string_date"
 
 module FmRest
   module V1
-    class TypeCoercer < Faraday::Response::Middleware
+    class TypeCoercer < Faraday::Middleware
       # We use this date to represent a FileMaker time for consistency with
       # ginjo-rfm
       JULIAN_ZERO_DAY = "-4712/1/1"

data/lib/fmrest/version.rb

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

data/lib/fmrest.rb

@@ -1,17 +1,18 @@
 # frozen_string_literal: true
 
 require "faraday"
-require "faraday_middleware"
+require "faraday/multipart"
 
 require "fmrest/version"
 require "fmrest/connection_settings"
 require "fmrest/errors"
 
 module FmRest
-  autoload :V1,         "fmrest/v1"
-  autoload :TokenStore, "fmrest/token_store"
-  autoload :Spyke,      "fmrest/spyke"
-  autoload :Layout,     "fmrest/spyke"
+  autoload :V1,                  "fmrest/v1"
+  autoload :TokenStore,          "fmrest/token_store"
+  autoload :Spyke,               "fmrest/spyke"
+  autoload :Layout,              "fmrest/spyke"
+  autoload :StringDateAwareness, "fmrest/string_date"
 
   class << self
     attr_accessor :token_store
@@ -68,3 +69,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,23 +1,20 @@
 --- !ruby/object:Gem::Specification
 name: fmrest-core
 version: !ruby/object:Gem::Version
-  version: 0.20.0
+  version: 0.22.0
 platform: ruby
 authors:
 - Pedro Carbajal
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-10-26 00:00:00.000000000 Z
+date: 2022-06-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.8.0
-    - - "<"
       - !ruby/object:Gem::Version
         version: '2.0'
   type: :runtime
@@ -25,31 +22,22 @@ dependencies:
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.8.0
-    - - "<"
       - !ruby/object:Gem::Version
         version: '2.0'
 - !ruby/object:Gem::Dependency
-  name: faraday_middleware
+  name: faraday-multipart
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.1
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.1
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '0'
 description: fmrest-core is a FileMaker Data API client built with Faraday. It handles
   authentication as well as providing many utilities for working with the Data API.
   An ORM library built on top of fmrest-core is also available.
@@ -89,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
@@ -108,7 +101,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.3.3
 signing_key:
 specification_version: 4
 summary: FileMaker Data API client using Faraday, core library