README.md in fmrest-spyke-0.20.0 vs README.md in fmrest-spyke-0.21.0.rc1
- old
+ new
@@ -1,10 +1,11 @@
# fmrest-ruby
[](https://rubygems.org/gems/fmrest)
[](https://rubydoc.info/github/beezwax/fmrest-ruby)
+[](https://beezwax.net/)
A Ruby client for
[FileMaker's Data API](https://help.claris.com/en/data-api-guide)
with ActiveRecord-ish ORM features.
@@ -14,24 +15,10 @@
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:
* `fmrest-spyke`, providing an ActiveRecord-like ORM library built on top
@@ -122,28 +109,29 @@
```ruby
{
host: "…",
…
- ssl: { verify: false }
+ ssl: { verify: false },
+ proxy: "http://user:password@proxy.host:4321"
}
```
You can also pass a `:log` option for basic request logging, see the section on
[Logging](#Logging) below.
### Full list of available options
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`
`:date_format` | Date parsing format | String (FM date format) | `"MM/dd/yyyy"`
`:timestamp_format` | Timestmap parsing format | String (FM date format) | `"MM/dd/yyyy HH:mm:ss"`
@@ -559,16 +547,11 @@
\* You can manually supply the URL and JSON to a `FmRest` connection.
## 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
After checking out the repo, run `bin/setup` to install dependencies. Then, run
`bundle exec rspec` to run the specs. You can also run `bin/console` for an