fmrest 0.20.0 → 0.22.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (4) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +6 -0
  3. data/README.md +16 -26
  4. metadata +25 -11
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 6c4b366640593f14ee48c1e4443f92aeb68edfe089cad7c7108c27526c1771cc
4
- data.tar.gz: 4e772c3d19b64e030e8e572a30ef251715db66f94082ed95becd2d97eed790ae
3
+ metadata.gz: 0131d260381901aea8ffb137cbb3480fba2c64318735ccf5d2fe2271c9e36bb3
4
+ data.tar.gz: 4e04e36c1584e9c0576afc6ee67b5ca7b710d05ce2eed6801590e029a36e1d58
5
5
  SHA512:
6
- metadata.gz: 413b4820538640c3c68f2c03cd14e624f4883da55b36810e58d71928d2712b51b6c1a85a93136a53fab695bd02d96ef2cc6d6ad2cf4b7ca63af08cb6957b5dab
7
- data.tar.gz: 74b50c3faf532012b775e1dbe21df8a0455d044fcd46cb26213eef21f608d82eed995be9fb941dbebdaf388497ad549ed596fbced218832da0c5f21081b9e1d2
6
+ metadata.gz: 77511996dca18b566f675bfea15967e35d82b7decb5e74f3b20a8c67dc92c681226047d1aeb6f1308dfb47eb6ebf4c1d792eb14c815d5a1f31678bb5926abd7e
7
+ data.tar.gz: 9a405d0ea9aef89d4d1d98b89b1dcb02818cf2bf1f090caf81ae61d1cc013327208aa96ba62ea1214507a8b57e0d40e49cea568e656930066405845a6189a241
data/CHANGELOG.md CHANGED
@@ -1,5 +1,11 @@
1
1
  ## Changelog
2
2
 
3
+ ### 0.21.0
4
+
5
+ * Support for Spyke 7 and Faraday 2
6
+ * Drop support for Faraday 1
7
+ * Drop support for Ruby 2.5
8
+
3
9
  ### 0.20.0
4
10
 
5
11
  * Forward proxy options to AWS Client when using `fmrest-cloud` gem
data/README.md CHANGED
@@ -3,6 +3,7 @@
3
3
  [![Gem Version](https://badge.fury.io/rb/fmrest.svg?style=flat)](https://rubygems.org/gems/fmrest)
4
4
  ![CI](https://github.com/beezwax/fmrest-ruby/workflows/CI/badge.svg)
5
5
  [![Yard Docs](http://img.shields.io/badge/yard-docs-blue.svg)](https://rubydoc.info/github/beezwax/fmrest-ruby)
6
+ [![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/)
6
7
 
7
8
  A Ruby client for
8
9
  [FileMaker's Data API](https://help.claris.com/en/data-api-guide)
@@ -16,29 +17,16 @@ is natively supported by the gem.
16
17
  Need Ruby or FileMaker consulting? Contact us at
17
18
  [Beezwax.net](https://beezwax.net/)
18
19
 
19
- ## Contents
20
-
21
- * [Gems](#gems)
22
- * [Installation](#installation)
23
- * [Simple example](#simple-example)
24
- * [Connection settings](#connection-settings)
25
- * [Session token store](#session-token-store)
26
- * [Date fields and timezones](#date-fields-and-timezones)
27
- * [ActiveRecord-like ORM (fmrest-spyke)](#activerecord-like-orm-fmrest-spyke)
28
- * [Logging](#logging)
29
- * [Gotchas](#gotchas)
30
- * [API implementation completeness table](#api-implementation-completeness-table)
31
- * [Supported Ruby versions](#supported-ruby-versions)
32
-
33
20
  ## Gems
34
21
 
35
- The `fmrest` gem is a wrapper for two other gems:
22
+ The `fmrest` gem is a wrapper for these gems:
36
23
 
37
24
  * `fmrest-spyke`, providing an ActiveRecord-like ORM library built on top
38
25
  of `fmrest-core` and [Spyke](https://github.com/balvig/spyke).
39
26
  * `fmrest-core`, providing the core
40
27
  [Faraday](https://github.com/lostisland/faraday) connection builder, session
41
28
  management, and other core utilities.
29
+ * `fmrest-rails`, providing Rails integration.
42
30
 
43
31
  In addition, the optional `fmrest-cloud` gem adds support for FileMaker Cloud.
44
32
  See the [main document on connecting to FileMaker
@@ -55,6 +43,12 @@ gem 'fmrest'
55
43
  gem 'fmrest-cloud'
56
44
  ```
57
45
 
46
+ If you're using Rails you can now run:
47
+
48
+ ```
49
+ rails generate fmrest:config
50
+ ```
51
+
58
52
  ## Simple example
59
53
 
60
54
  ```ruby
@@ -124,7 +118,8 @@ to, for instance, disable SSL verification:
124
118
  {
125
119
  host: "…",
126
120
  …
127
- ssl: { verify: false }
121
+ ssl: { verify: false },
122
+ proxy: "http://user:password@proxy.host:4321"
128
123
  }
129
124
  ```
130
125
 
@@ -135,13 +130,13 @@ You can also pass a `:log` option for basic request logging, see the section on
135
130
 
136
131
  Option | Description | Format | Default
137
132
  --------------------|--------------------------------------------|-----------------------------|--------
138
- `:host` | Hostname with optional port, e.g. `"example.com:9000"` | String | None
133
+ `:host` | Hostname with optional port, e.g. `example.com:9000` | String | None
139
134
  `:database` | The name of the database to connect to | String | None
140
135
  `:username` | A Data API-ready account | String | None
141
136
  `:password` | Your password | String | None
142
137
  `:account_name` | Alias of `:username` | String | None
143
- `:ssl` | SSL options to be forwarded to Faraday | Faraday SSL options | None
144
- `:proxy` | Proxy URI e.g. `http://username:password@proxy.host:5000` | String / URI | None
138
+ `:ssl` | SSL options to be forwarded to Faraday | [Faraday SSL options](https://www.rubydoc.info/gems/faraday/Faraday/SSLOptions) hash | None
139
+ `:proxy` | Proxy URI, e.g. `http://user:password@proxy.host:4321` | String | None
145
140
  `:log` | Log JSON responses to STDOUT | Boolean | `false`
146
141
  `:log_level` | Which log level to log into | Values accepted by `Logger#level=` | `:debug`
147
142
  `: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/
561
556
 
562
557
  ## Supported Ruby versions
563
558
 
564
- fmrest-ruby aims to support and is [tested against](https://github.com/beezwax/fmrest-ruby/actions?query=workflow%3ACI)
565
- the following Ruby implementations:
566
-
567
- * Ruby 2.5
568
- * Ruby 2.6
569
- * Ruby 2.7
570
- * Ruby 3.0
559
+ fmrest-ruby is [tested against](https://github.com/beezwax/fmrest-ruby/actions?query=workflow%3ACI)
560
+ Ruby 2.6 through 3.1.
571
561
 
572
562
  ## Gem development
573
563
 
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: fmrest
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.20.0
4
+ version: 0.22.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Pedro Carbajal
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2021-10-26 00:00:00.000000000 Z
11
+ date: 2022-06-24 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: fmrest-core
@@ -16,42 +16,56 @@ dependencies:
16
16
  requirements:
17
17
  - - '='
18
18
  - !ruby/object:Gem::Version
19
- version: 0.20.0
19
+ version: 0.22.0
20
20
  type: :runtime
21
21
  prerelease: false
22
22
  version_requirements: !ruby/object:Gem::Requirement
23
23
  requirements:
24
24
  - - '='
25
25
  - !ruby/object:Gem::Version
26
- version: 0.20.0
26
+ version: 0.22.0
27
27
  - !ruby/object:Gem::Dependency
28
28
  name: fmrest-spyke
29
29
  requirement: !ruby/object:Gem::Requirement
30
30
  requirements:
31
31
  - - '='
32
32
  - !ruby/object:Gem::Version
33
- version: 0.20.0
33
+ version: 0.22.0
34
34
  type: :runtime
35
35
  prerelease: false
36
36
  version_requirements: !ruby/object:Gem::Requirement
37
37
  requirements:
38
38
  - - '='
39
39
  - !ruby/object:Gem::Version
40
- version: 0.20.0
40
+ version: 0.22.0
41
+ - !ruby/object:Gem::Dependency
42
+ name: fmrest-rails
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - '='
46
+ - !ruby/object:Gem::Version
47
+ version: 0.22.0
48
+ type: :runtime
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - '='
53
+ - !ruby/object:Gem::Version
54
+ version: 0.22.0
41
55
  - !ruby/object:Gem::Dependency
42
56
  name: bundler
43
57
  requirement: !ruby/object:Gem::Requirement
44
58
  requirements:
45
59
  - - "~>"
46
60
  - !ruby/object:Gem::Version
47
- version: 2.2.0
61
+ version: '2.2'
48
62
  type: :development
49
63
  prerelease: false
50
64
  version_requirements: !ruby/object:Gem::Requirement
51
65
  requirements:
52
66
  - - "~>"
53
67
  - !ruby/object:Gem::Version
54
- version: 2.2.0
68
+ version: '2.2'
55
69
  - !ruby/object:Gem::Dependency
56
70
  name: rake
57
71
  requirement: !ruby/object:Gem::Requirement
@@ -156,14 +170,14 @@ dependencies:
156
170
  requirements:
157
171
  - - "~>"
158
172
  - !ruby/object:Gem::Version
159
- version: '6.0'
173
+ version: '7.0'
160
174
  type: :development
161
175
  prerelease: false
162
176
  version_requirements: !ruby/object:Gem::Requirement
163
177
  requirements:
164
178
  - - "~>"
165
179
  - !ruby/object:Gem::Version
166
- version: '6.0'
180
+ version: '7.0'
167
181
  - !ruby/object:Gem::Dependency
168
182
  name: sqlite3
169
183
  requirement: !ruby/object:Gem::Requirement
@@ -278,7 +292,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
278
292
  - !ruby/object:Gem::Version
279
293
  version: '0'
280
294
  requirements: []
281
- rubygems_version: 3.2.3
295
+ rubygems_version: 3.3.3
282
296
  signing_key:
283
297
  specification_version: 4
284
298
  summary: FileMaker Data API client