openapi_first 0.12.2 → 0.12.3
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.rubocop.yml +2 -0
- data/CHANGELOG.md +3 -0
- data/Gemfile.lock +10 -10
- data/README.md +17 -1
- data/benchmarks/Gemfile.lock +6 -6
- data/examples/app.rb +2 -1
- data/lib/openapi_first.rb +29 -4
- data/lib/openapi_first/app.rb +11 -4
- data/lib/openapi_first/version.rb +1 -1
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 8f5e77e342d4dba0c6ac4d535511148333efac5bc4b2cea62ee6d8b75219233e
|
4
|
+
data.tar.gz: 9b3341115e77bd4abc4b14d89464093d78483e251cf69e2b2508461c98aa1ccf
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 86f19dc76569748825731014124b689b7bddf5cce6a6fe38b5d95adb4643eeeeaa3ae6024a290aaf2aed92127147cc948a55faa062b5d97b99b7d2fe65df98cd
|
7
|
+
data.tar.gz: 27cef03d9ef7e0b49af33154e44ca68d3e0e860dcd94cbf6d2cdc4661ff90a4be590b92365aabfcdffe330f2aa2e96c12f7277ee2fa572fe02a2cc2c263e34b5
|
data/.rubocop.yml
CHANGED
data/CHANGELOG.md
CHANGED
data/Gemfile.lock
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
PATH
|
2
2
|
remote: .
|
3
3
|
specs:
|
4
|
-
openapi_first (0.12.
|
4
|
+
openapi_first (0.12.3)
|
5
5
|
deep_merge (>= 1.2.1)
|
6
6
|
hanami-router (~> 2.0.alpha3)
|
7
7
|
hanami-utils (~> 2.0.alpha1)
|
@@ -26,7 +26,7 @@ GEM
|
|
26
26
|
coderay (1.1.3)
|
27
27
|
concurrent-ruby (1.1.6)
|
28
28
|
deep_merge (1.2.1)
|
29
|
-
diff-lcs (1.4.
|
29
|
+
diff-lcs (1.4.4)
|
30
30
|
ecma-re-validator (0.2.1)
|
31
31
|
regexp_parser (~> 1.2)
|
32
32
|
hana (1.3.6)
|
@@ -49,15 +49,15 @@ GEM
|
|
49
49
|
method_source (1.0.0)
|
50
50
|
mini_portile2 (2.4.0)
|
51
51
|
minitest (5.14.1)
|
52
|
-
multi_json (1.
|
52
|
+
multi_json (1.15.0)
|
53
53
|
mustermann (1.1.1)
|
54
54
|
ruby2_keywords (~> 0.0.1)
|
55
55
|
mustermann-contrib (1.1.1)
|
56
56
|
hansi (~> 0.2.0)
|
57
57
|
mustermann (= 1.1.1)
|
58
|
-
nokogiri (1.10.
|
58
|
+
nokogiri (1.10.10)
|
59
59
|
mini_portile2 (~> 2.4.0)
|
60
|
-
oas_parser (0.25.
|
60
|
+
oas_parser (0.25.1)
|
61
61
|
activesupport (>= 4.0.0)
|
62
62
|
addressable (~> 2.3)
|
63
63
|
builder (~> 3.2.3)
|
@@ -92,16 +92,16 @@ GEM
|
|
92
92
|
diff-lcs (>= 1.2.0, < 2.0)
|
93
93
|
rspec-support (~> 3.9.0)
|
94
94
|
rspec-support (3.9.3)
|
95
|
-
rubocop (0.
|
95
|
+
rubocop (0.87.1)
|
96
96
|
parallel (~> 1.10)
|
97
|
-
parser (>= 2.7.
|
97
|
+
parser (>= 2.7.1.1)
|
98
98
|
rainbow (>= 2.2.2, < 4.0)
|
99
99
|
regexp_parser (>= 1.7)
|
100
100
|
rexml
|
101
|
-
rubocop-ast (>= 0.0
|
101
|
+
rubocop-ast (>= 0.1.0, < 1.0)
|
102
102
|
ruby-progressbar (~> 1.7)
|
103
103
|
unicode-display_width (>= 1.4.0, < 2.0)
|
104
|
-
rubocop-ast (0.0
|
104
|
+
rubocop-ast (0.1.0)
|
105
105
|
parser (>= 2.7.0.1)
|
106
106
|
ruby-progressbar (1.10.1)
|
107
107
|
ruby2_keywords (0.0.2)
|
@@ -111,7 +111,7 @@ GEM
|
|
111
111
|
thread_safe (~> 0.1)
|
112
112
|
unicode-display_width (1.7.0)
|
113
113
|
uri_template (0.7.0)
|
114
|
-
zeitwerk (2.3.
|
114
|
+
zeitwerk (2.3.1)
|
115
115
|
|
116
116
|
PLATFORMS
|
117
117
|
ruby
|
data/README.md
CHANGED
@@ -150,7 +150,12 @@ end
|
|
150
150
|
|
151
151
|
# In config.ru:
|
152
152
|
require 'openapi_first'
|
153
|
-
run OpenapiFirst.app(
|
153
|
+
run OpenapiFirst.app(
|
154
|
+
'./openapi/openapi.yaml',
|
155
|
+
namespace: Pets,
|
156
|
+
response_validation: ENV['RACK_ENV'] == 'test',
|
157
|
+
router_raise_error: ENV['RACK_ENV'] == 'test'
|
158
|
+
)
|
154
159
|
```
|
155
160
|
|
156
161
|
The above will use the mentioned Rack middlewares to:
|
@@ -159,6 +164,17 @@ The above will use the mentioned Rack middlewares to:
|
|
159
164
|
- Map the request to a method call `Pets.find_pet` based on the `operationId` in the API description
|
160
165
|
- Set the response content type according to your spec (here with the default status code `200`)
|
161
166
|
|
167
|
+
### Options and their defaults:
|
168
|
+
|
169
|
+
| Name | Possible values | Description | Default
|
170
|
+
|:---|---|---|---|
|
171
|
+
| `spec_path` || A filepath to an OpenAPI definition file. |
|
172
|
+
| `namespace:` || A class or module where to find the handler methods.|
|
173
|
+
| `response_validation:` | `true`, `false` | If set to true it raises an exception if the response is invalid. This is useful during testing. | `false`
|
174
|
+
| `router_raise_error:` | `true`, `false` | If set to true it raises an exception (subclass of `OpenapiFirst::Error` when a request path/method is not specified. This is useful during testing. | `false`
|
175
|
+
| `request_validation_raise_error:` | `true`, `false` | If set to true it raises an exception (subclass of `OpenapiFirst::Error` when a request is not valid. | `false`
|
176
|
+
|
177
|
+
|
162
178
|
Handler functions (`find_pet`) are called with two arguments:
|
163
179
|
|
164
180
|
- `params` - Holds the parsed request body, filtered query params and path parameters
|
data/benchmarks/Gemfile.lock
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
PATH
|
2
2
|
remote: ..
|
3
3
|
specs:
|
4
|
-
openapi_first (0.12.
|
4
|
+
openapi_first (0.12.3)
|
5
5
|
deep_merge (>= 1.2.1)
|
6
6
|
hanami-router (~> 2.0.alpha3)
|
7
7
|
hanami-utils (~> 2.0.alpha1)
|
@@ -25,7 +25,7 @@ GEM
|
|
25
25
|
benchmark-memory (0.1.2)
|
26
26
|
memory_profiler (~> 0.9)
|
27
27
|
builder (3.2.4)
|
28
|
-
committee (4.
|
28
|
+
committee (4.1.0)
|
29
29
|
json_schema (~> 0.14, >= 0.14.3)
|
30
30
|
openapi_parser (>= 0.11.1)
|
31
31
|
rack (>= 1.5)
|
@@ -83,7 +83,7 @@ GEM
|
|
83
83
|
memory_profiler (0.9.14)
|
84
84
|
mini_portile2 (2.4.0)
|
85
85
|
minitest (5.14.1)
|
86
|
-
multi_json (1.
|
86
|
+
multi_json (1.15.0)
|
87
87
|
mustermann (1.1.1)
|
88
88
|
ruby2_keywords (~> 0.0.1)
|
89
89
|
mustermann-contrib (1.1.1)
|
@@ -91,9 +91,9 @@ GEM
|
|
91
91
|
mustermann (= 1.1.1)
|
92
92
|
mustermann-grape (1.0.1)
|
93
93
|
mustermann (>= 1.0.0)
|
94
|
-
nokogiri (1.10.
|
94
|
+
nokogiri (1.10.10)
|
95
95
|
mini_portile2 (~> 2.4.0)
|
96
|
-
oas_parser (0.25.
|
96
|
+
oas_parser (0.25.1)
|
97
97
|
activesupport (>= 4.0.0)
|
98
98
|
addressable (~> 2.3)
|
99
99
|
builder (~> 3.2.3)
|
@@ -125,7 +125,7 @@ GEM
|
|
125
125
|
tzinfo (1.2.7)
|
126
126
|
thread_safe (~> 0.1)
|
127
127
|
uri_template (0.7.0)
|
128
|
-
zeitwerk (2.3.
|
128
|
+
zeitwerk (2.3.1)
|
129
129
|
|
130
130
|
PLATFORMS
|
131
131
|
ruby
|
data/examples/app.rb
CHANGED
@@ -17,5 +17,6 @@ oas_path = File.absolute_path('./openapi.yaml', __dir__)
|
|
17
17
|
App = OpenapiFirst.app(
|
18
18
|
oas_path,
|
19
19
|
namespace: Web,
|
20
|
-
|
20
|
+
router_raise_error: OpenapiFirst.env == 'test',
|
21
|
+
response_validation: OpenapiFirst.env == 'test'
|
21
22
|
)
|
data/lib/openapi_first.rb
CHANGED
@@ -31,14 +31,39 @@ module OpenapiFirst
|
|
31
31
|
Definition.new(parsed)
|
32
32
|
end
|
33
33
|
|
34
|
-
def self.app(
|
34
|
+
def self.app(
|
35
|
+
spec,
|
36
|
+
namespace:,
|
37
|
+
router_raise_error: false,
|
38
|
+
request_validation_raise_error: false,
|
39
|
+
response_validation: false
|
40
|
+
)
|
35
41
|
spec = OpenapiFirst.load(spec) if spec.is_a?(String)
|
36
|
-
App.new(
|
42
|
+
App.new(
|
43
|
+
nil,
|
44
|
+
spec,
|
45
|
+
namespace: namespace,
|
46
|
+
router_raise_error: router_raise_error,
|
47
|
+
request_validation_raise_error: request_validation_raise_error,
|
48
|
+
response_validation: response_validation
|
49
|
+
)
|
37
50
|
end
|
38
51
|
|
39
|
-
def self.middleware(
|
52
|
+
def self.middleware(
|
53
|
+
spec,
|
54
|
+
namespace:,
|
55
|
+
router_raise_error: false,
|
56
|
+
request_validation_raise_error: false,
|
57
|
+
response_validation: false
|
58
|
+
)
|
40
59
|
spec = OpenapiFirst.load(spec) if spec.is_a?(String)
|
41
|
-
AppWithOptions.new(
|
60
|
+
AppWithOptions.new(
|
61
|
+
spec,
|
62
|
+
namespace: namespace,
|
63
|
+
router_raise_error: router_raise_error,
|
64
|
+
request_validation_raise_error: request_validation_raise_error,
|
65
|
+
response_validation: response_validation
|
66
|
+
)
|
42
67
|
end
|
43
68
|
|
44
69
|
class AppWithOptions
|
data/lib/openapi_first/app.rb
CHANGED
@@ -5,12 +5,19 @@ require 'logger'
|
|
5
5
|
|
6
6
|
module OpenapiFirst
|
7
7
|
class App
|
8
|
-
def initialize(
|
8
|
+
def initialize( # rubocop:disable Metrics/ParameterLists
|
9
|
+
parent_app,
|
10
|
+
spec,
|
11
|
+
namespace:,
|
12
|
+
router_raise_error: false,
|
13
|
+
request_validation_raise_error: false,
|
14
|
+
response_validation: false
|
15
|
+
)
|
9
16
|
@stack = Rack::Builder.app do
|
10
17
|
freeze_app
|
11
|
-
use OpenapiFirst::Router, spec: spec, raise_error:
|
12
|
-
use OpenapiFirst::RequestValidation, raise_error:
|
13
|
-
use OpenapiFirst::ResponseValidation if
|
18
|
+
use OpenapiFirst::Router, spec: spec, raise_error: router_raise_error, parent_app: parent_app
|
19
|
+
use OpenapiFirst::RequestValidation, raise_error: request_validation_raise_error
|
20
|
+
use OpenapiFirst::ResponseValidation if response_validation
|
14
21
|
run OpenapiFirst::Responder.new(
|
15
22
|
spec: spec,
|
16
23
|
namespace: namespace
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: openapi_first
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.12.
|
4
|
+
version: 0.12.3
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Andreas Haller
|
8
8
|
autorequire:
|
9
9
|
bindir: exe
|
10
10
|
cert_chain: []
|
11
|
-
date: 2020-
|
11
|
+
date: 2020-07-10 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: deep_merge
|