skyward-api 0.1.0 → 0.2.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.
- checksums.yaml +4 -4
- data/README.md +185 -47
- data/lib/skyward/api/assembly/application.rb +26 -0
- data/lib/skyward/api/assembly/boot.rb +533 -0
- data/lib/skyward/api/assembly/builder.rb +83 -0
- data/lib/skyward/api/assembly/dispatcher.rb +121 -0
- data/lib/skyward/api/assembly/static.rb +115 -0
- data/lib/skyward/api/assembly.rb +4 -0
- data/lib/skyward/api/cli/app_file.rb +38 -0
- data/lib/skyward/api/cli/check.rb +145 -0
- data/lib/skyward/api/cli/executable.rb +15 -0
- data/lib/skyward/api/cli/routes.rb +30 -0
- data/lib/skyward/api/cli/serve/reloader.rb +77 -0
- data/lib/skyward/api/cli/serve.rb +137 -0
- data/lib/skyward/api/cli/serve.ru +16 -0
- data/lib/skyward/api/cli.rb +4 -0
- data/lib/skyward/api/commands.rb +38 -0
- data/lib/skyward/api/endpoints/declarations.rb +124 -0
- data/lib/skyward/api/endpoints/helpers.rb +49 -0
- data/lib/skyward/api/endpoints/route.rb +13 -0
- data/lib/skyward/api/endpoints.rb +4 -0
- data/lib/skyward/api/inputs/coercer.rb +425 -0
- data/lib/skyward/api/inputs.rb +164 -0
- data/lib/skyward/api/middleware/line_logger.rb +20 -0
- data/lib/skyward/api/middleware/request_id.rb +26 -0
- data/lib/skyward/api/middleware/request_log.rb +46 -0
- data/lib/skyward/api/middleware/rescue.rb +81 -0
- data/lib/skyward/api/middleware.rb +4 -0
- data/lib/skyward/api/openapi/docs.rb +39 -0
- data/lib/skyward/api/openapi.rb +393 -0
- data/lib/skyward/api/request.rb +127 -0
- data/lib/skyward/api/responses/bad_request.rb +18 -0
- data/lib/skyward/api/responses/conflict.rb +18 -0
- data/lib/skyward/api/responses/created.rb +19 -0
- data/lib/skyward/api/responses/forbidden.rb +18 -0
- data/lib/skyward/api/responses/no_content.rb +13 -0
- data/lib/skyward/api/responses/not_found.rb +18 -0
- data/lib/skyward/api/responses/redirect.rb +25 -0
- data/lib/skyward/api/responses/unauthorized.rb +18 -0
- data/lib/skyward/api/responses/unprocessable.rb +18 -0
- data/lib/skyward/api/responses.rb +4 -0
- data/lib/skyward/api/return_type_error.rb +4 -0
- data/lib/skyward/api/routing/percent_encoding.rb +15 -0
- data/lib/skyward/api/routing/router.rb +115 -0
- data/lib/skyward/api/routing.rb +4 -0
- data/lib/skyward/api/serializer/writers.rb +230 -0
- data/lib/skyward/api/serializer.rb +139 -0
- data/lib/skyward/api/test/client.rb +160 -0
- data/lib/skyward/api/test.rb +8 -0
- data/lib/skyward/api/version.rb +5 -1
- data/lib/skyward/api.rb +118 -1
- data/sig/generated/skyward/api/assembly/application.rbs +22 -0
- data/sig/generated/skyward/api/assembly/boot.rbs +217 -0
- data/sig/generated/skyward/api/assembly/builder.rbs +77 -0
- data/sig/generated/skyward/api/assembly/dispatcher.rbs +84 -0
- data/sig/generated/skyward/api/assembly/static.rbs +47 -0
- data/sig/generated/skyward/api/assembly.rbs +4 -0
- data/sig/generated/skyward/api/cli/app_file.rbs +15 -0
- data/sig/generated/skyward/api/cli/check.rbs +76 -0
- data/sig/generated/skyward/api/cli/executable.rbs +11 -0
- data/sig/generated/skyward/api/cli/routes.rbs +19 -0
- data/sig/generated/skyward/api/cli/serve/reloader.rbs +46 -0
- data/sig/generated/skyward/api/cli/serve.rbs +56 -0
- data/sig/generated/skyward/api/cli.rbs +4 -0
- data/sig/generated/skyward/api/commands.rbs +2 -0
- data/sig/generated/skyward/api/endpoints/declarations.rbs +81 -0
- data/sig/generated/skyward/api/endpoints/helpers.rbs +49 -0
- data/sig/generated/skyward/api/endpoints/route.rbs +24 -0
- data/sig/generated/skyward/api/endpoints.rbs +4 -0
- data/sig/generated/skyward/api/inputs/coercer.rbs +231 -0
- data/sig/generated/skyward/api/inputs.rbs +75 -0
- data/sig/generated/skyward/api/middleware/line_logger.rbs +13 -0
- data/sig/generated/skyward/api/middleware/request_id.rbs +17 -0
- data/sig/generated/skyward/api/middleware/request_log.rbs +18 -0
- data/sig/generated/skyward/api/middleware/rescue.rbs +41 -0
- data/sig/generated/skyward/api/middleware.rbs +4 -0
- data/sig/generated/skyward/api/openapi/docs.rbs +17 -0
- data/sig/generated/skyward/api/openapi.rbs +198 -0
- data/sig/generated/skyward/api/request.rbs +65 -0
- data/sig/generated/skyward/api/responses/bad_request.rbs +14 -0
- data/sig/generated/skyward/api/responses/conflict.rbs +14 -0
- data/sig/generated/skyward/api/responses/created.rbs +15 -0
- data/sig/generated/skyward/api/responses/forbidden.rbs +14 -0
- data/sig/generated/skyward/api/responses/no_content.rbs +10 -0
- data/sig/generated/skyward/api/responses/not_found.rbs +14 -0
- data/sig/generated/skyward/api/responses/redirect.rbs +20 -0
- data/sig/generated/skyward/api/responses/unauthorized.rbs +14 -0
- data/sig/generated/skyward/api/responses/unprocessable.rbs +14 -0
- data/sig/generated/skyward/api/responses.rbs +4 -0
- data/sig/generated/skyward/api/return_type_error.rbs +4 -0
- data/sig/generated/skyward/api/routing/percent_encoding.rbs +11 -0
- data/sig/generated/skyward/api/routing/router.rbs +158 -0
- data/sig/generated/skyward/api/routing.rbs +4 -0
- data/sig/generated/skyward/api/serializer/writers.rbs +126 -0
- data/sig/generated/skyward/api/serializer.rbs +79 -0
- data/sig/generated/skyward/api/test/client.rbs +117 -0
- data/sig/generated/skyward/api/test.rbs +6 -0
- data/sig/generated/skyward/api.rbs +38 -0
- data/sig/manual/skyward/api/assembly/boot.rbs +3 -0
- data/sig/manual/skyward/api/cli/app_file.rbs +3 -0
- data/sig/manual/skyward/api/cli/check.rbs +3 -0
- data/sig/manual/skyward/api/cli/executable.rbs +3 -0
- data/sig/manual/skyward/api/cli/routes.rbs +3 -0
- data/sig/manual/skyward/api/cli/serve.rbs +3 -0
- data/sig/manual/skyward/api/inputs/coercer.rbs +3 -0
- data/sig/manual/skyward/api/openapi/docs.rbs +3 -0
- data/sig/manual/skyward/api/openapi.rbs +3 -0
- data/sig/manual/skyward/api/routing/percent_encoding.rbs +3 -0
- data/sig/manual/skyward/api/serializer/writers.rbs +3 -0
- data/sig/manual/skyward/api/test.rbs +3 -0
- data/sig/manual/skyward/api.rbs +21 -0
- data/sig/manual/zeitwerk/loader.rbs +6 -0
- metadata +110 -3
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
# Generated from lib/skyward/api/middleware/rescue.rb with RBS::Inline
|
|
2
|
+
|
|
3
|
+
class Skyward::API::Middleware::Rescue
|
|
4
|
+
@app: Skyward::API::_RackApp
|
|
5
|
+
|
|
6
|
+
@logger: Skyward::API::_Logger?
|
|
7
|
+
|
|
8
|
+
@on_error: Skyward::API::_OnError?
|
|
9
|
+
|
|
10
|
+
@development: bool
|
|
11
|
+
|
|
12
|
+
# @rbs (Skyward::API::_RackApp app, logger: Skyward::API::_Logger?, on_error: Skyward::API::_OnError?,
|
|
13
|
+
# development: bool) -> void
|
|
14
|
+
def initialize: (Skyward::API::_RackApp app, logger: Skyward::API::_Logger?, on_error: Skyward::API::_OnError?, development: bool) -> void
|
|
15
|
+
|
|
16
|
+
# @rbs env: Hash[String, untyped]
|
|
17
|
+
# @rbs return: Skyward::API::rack_response
|
|
18
|
+
def call: (Hash[String, untyped] env) -> Skyward::API::rack_response
|
|
19
|
+
|
|
20
|
+
private
|
|
21
|
+
|
|
22
|
+
# @rbs exception: StandardError
|
|
23
|
+
# @rbs request_id: String?
|
|
24
|
+
# @rbs return: void
|
|
25
|
+
def log: (StandardError exception, String? request_id) -> void
|
|
26
|
+
|
|
27
|
+
# @rbs exception: StandardError
|
|
28
|
+
# @rbs env: Hash[String, untyped]
|
|
29
|
+
# @rbs request_id: String?
|
|
30
|
+
# @rbs return: void
|
|
31
|
+
def report: (StandardError exception, Hash[String, untyped] env, String? request_id) -> void
|
|
32
|
+
|
|
33
|
+
# @rbs exception: StandardError
|
|
34
|
+
# @rbs request_id: String?
|
|
35
|
+
# @rbs return: Hash[Symbol, untyped]
|
|
36
|
+
def problem: (StandardError exception, String? request_id) -> Hash[Symbol, untyped]
|
|
37
|
+
|
|
38
|
+
# @rbs exception: StandardError
|
|
39
|
+
# @rbs return: String
|
|
40
|
+
def message: (StandardError exception) -> String
|
|
41
|
+
end
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# Generated from lib/skyward/api/openapi/docs.rb with RBS::Inline
|
|
2
|
+
|
|
3
|
+
module Skyward::API::OpenAPI::Docs
|
|
4
|
+
PATH: String
|
|
5
|
+
|
|
6
|
+
HTML_TYPE: String
|
|
7
|
+
|
|
8
|
+
SCALAR_URL: String
|
|
9
|
+
|
|
10
|
+
# Recompute from the file whenever SCALAR_URL's version changes.
|
|
11
|
+
SCALAR_INTEGRITY: String
|
|
12
|
+
|
|
13
|
+
# @rbs title: String
|
|
14
|
+
# @rbs scalar_url: String
|
|
15
|
+
# @rbs return: String
|
|
16
|
+
def page: (title: String, scalar_url: String) -> String
|
|
17
|
+
end
|
|
@@ -0,0 +1,198 @@
|
|
|
1
|
+
# Generated from lib/skyward/api/openapi.rb with RBS::Inline
|
|
2
|
+
|
|
3
|
+
module Skyward::API::OpenAPI
|
|
4
|
+
type schema = Hash[Symbol, untyped]
|
|
5
|
+
|
|
6
|
+
type form = :request | :response
|
|
7
|
+
|
|
8
|
+
class Answer < Data
|
|
9
|
+
attr_reader status(): String
|
|
10
|
+
|
|
11
|
+
attr_reader media_type(): String?
|
|
12
|
+
|
|
13
|
+
attr_reader schema(): schema?
|
|
14
|
+
|
|
15
|
+
def self.new: (String status, String? media_type, schema? schema) -> instance
|
|
16
|
+
| (status: String, media_type: String?, schema: schema?) -> instance
|
|
17
|
+
|
|
18
|
+
def self.members: () -> [ :status, :media_type, :schema ]
|
|
19
|
+
|
|
20
|
+
def members: () -> [ :status, :media_type, :schema ]
|
|
21
|
+
end
|
|
22
|
+
|
|
23
|
+
PATH: String
|
|
24
|
+
|
|
25
|
+
SERVED: Hash[String, String]
|
|
26
|
+
|
|
27
|
+
# OpenAPI's pattern for the name of a component.
|
|
28
|
+
NAME: Regexp
|
|
29
|
+
|
|
30
|
+
JSON_TYPE: String
|
|
31
|
+
|
|
32
|
+
PROBLEM_TYPE: String
|
|
33
|
+
|
|
34
|
+
SCALARS: Hash[Skyward::Core::Types::scalar, schema]
|
|
35
|
+
|
|
36
|
+
NULL: schema
|
|
37
|
+
|
|
38
|
+
PROBLEM: schema
|
|
39
|
+
|
|
40
|
+
PROBLEM_SCHEMA: schema
|
|
41
|
+
|
|
42
|
+
NO_CONTENT: Answer
|
|
43
|
+
|
|
44
|
+
# A redirect's status is chosen when it's made, so it's documented as the range.
|
|
45
|
+
REDIRECT: Answer
|
|
46
|
+
|
|
47
|
+
RACK: Answer
|
|
48
|
+
|
|
49
|
+
INVALID: Answer
|
|
50
|
+
|
|
51
|
+
REFUSED: Array[Answer]
|
|
52
|
+
|
|
53
|
+
LOCATION: Hash[Symbol, untyped]
|
|
54
|
+
|
|
55
|
+
DESCRIPTIONS: Hash[String, String]
|
|
56
|
+
|
|
57
|
+
# Takes the document unbuilt, so a route or static file at /openapi.json or /docs is refused first.
|
|
58
|
+
# @rbs endpoints: Array[Skyward::API::Routing::Router::Endpoint]
|
|
59
|
+
# @rbs static: Skyward::API::Assembly::Static
|
|
60
|
+
# @rbs document: ^() -> schema
|
|
61
|
+
# @rbs return: String
|
|
62
|
+
def json: (Array[Skyward::API::Routing::Router::Endpoint] endpoints, static: Skyward::API::Assembly::Static, document: ^() -> schema) -> String
|
|
63
|
+
|
|
64
|
+
# Only serving the documents needs /openapi.json and /docs free, so this doesn't check them.
|
|
65
|
+
# @rbs endpoints: Array[Skyward::API::Routing::Router::Endpoint]
|
|
66
|
+
# @rbs title: String
|
|
67
|
+
# @rbs version: String
|
|
68
|
+
# @rbs description: String?
|
|
69
|
+
# @rbs schema_names: Hash[Class, String]
|
|
70
|
+
# @rbs return: schema
|
|
71
|
+
def document: (Array[Skyward::API::Routing::Router::Endpoint] endpoints, title: String, version: String, description: String?, schema_names: Hash[Class, String]) -> schema
|
|
72
|
+
|
|
73
|
+
private
|
|
74
|
+
|
|
75
|
+
# The request: keyword is Skyward's, not part of the HTTP contract.
|
|
76
|
+
# @rbs endpoint: Skyward::API::Routing::Router::Endpoint
|
|
77
|
+
# @rbs return: Array[Skyward::API::Routing::Router::Keyword]
|
|
78
|
+
def described: (Skyward::API::Routing::Router::Endpoint endpoint) -> Array[Skyward::API::Routing::Router::Keyword]
|
|
79
|
+
|
|
80
|
+
# @rbs endpoint: Skyward::API::Routing::Router::Endpoint
|
|
81
|
+
# @rbs return: Array[Skyward::Core::Types::t]
|
|
82
|
+
def types: (Skyward::API::Routing::Router::Endpoint endpoint) -> Array[Skyward::Core::Types::t]
|
|
83
|
+
|
|
84
|
+
# @rbs type: Skyward::Core::Types::t
|
|
85
|
+
# @rbs return: Array[Skyward::Core::Types::Named]
|
|
86
|
+
def named: (Skyward::Core::Types::t type) -> Array[Skyward::Core::Types::Named]
|
|
87
|
+
|
|
88
|
+
# @rbs endpoints: Array[Skyward::API::Routing::Router::Endpoint]
|
|
89
|
+
# @rbs static: Skyward::API::Assembly::Static
|
|
90
|
+
# @rbs return: String?
|
|
91
|
+
def served: (Array[Skyward::API::Routing::Router::Endpoint] endpoints, Skyward::API::Assembly::Static static) -> String?
|
|
92
|
+
|
|
93
|
+
# @rbs at: String
|
|
94
|
+
# @rbs serves: String
|
|
95
|
+
# @rbs endpoints: Array[Skyward::API::Routing::Router::Endpoint]
|
|
96
|
+
# @rbs static: Skyward::API::Assembly::Static
|
|
97
|
+
# @rbs return: String?
|
|
98
|
+
def taken: (String at, String serves, Array[Skyward::API::Routing::Router::Endpoint] endpoints, Skyward::API::Assembly::Static static) -> String?
|
|
99
|
+
|
|
100
|
+
# @rbs endpoints: Array[Skyward::API::Routing::Router::Endpoint]
|
|
101
|
+
# @rbs return: String?
|
|
102
|
+
def operation_ids: (Array[Skyward::API::Routing::Router::Endpoint] endpoints) -> String?
|
|
103
|
+
|
|
104
|
+
# @rbs types: Array[Skyward::Core::Types::Named]
|
|
105
|
+
# @rbs schema_names: Hash[Class, String]
|
|
106
|
+
# @rbs return: Hash[Class, String] | String
|
|
107
|
+
def names: (Array[Skyward::Core::Types::Named] types, Hash[Class, String] schema_names) -> (Hash[Class, String] | String)
|
|
108
|
+
|
|
109
|
+
# @rbs endpoints: Array[Skyward::API::Routing::Router::Endpoint]
|
|
110
|
+
# @rbs types: Array[Skyward::Core::Types::Named]
|
|
111
|
+
# @rbs info: Hash[Symbol, String]
|
|
112
|
+
# @rbs names: Hash[Class, String]
|
|
113
|
+
# @rbs return: schema
|
|
114
|
+
def assembled: (Array[Skyward::API::Routing::Router::Endpoint] endpoints, Array[Skyward::Core::Types::Named] types, Hash[Symbol, String] info, Hash[Class, String] names) -> schema
|
|
115
|
+
|
|
116
|
+
# @rbs endpoint: Skyward::API::Routing::Router::Endpoint
|
|
117
|
+
# @rbs names: Hash[Class, String]
|
|
118
|
+
# @rbs return: schema
|
|
119
|
+
def operation: (Skyward::API::Routing::Router::Endpoint endpoint, Hash[Class, String] names) -> schema
|
|
120
|
+
|
|
121
|
+
# A path or query value can't be null, so its schema leaves null out, and it's
|
|
122
|
+
# always a String, so an untyped one is a string.
|
|
123
|
+
# @rbs keyword: Skyward::API::Routing::Router::Keyword
|
|
124
|
+
# @rbs names: Hash[Class, String]
|
|
125
|
+
# @rbs return: schema
|
|
126
|
+
def parameter: (Skyward::API::Routing::Router::Keyword keyword, Hash[Class, String] names) -> schema
|
|
127
|
+
|
|
128
|
+
# @rbs keyword: Skyward::API::Routing::Router::Keyword
|
|
129
|
+
# @rbs names: Hash[Class, String]
|
|
130
|
+
# @rbs return: schema
|
|
131
|
+
def request_body: (Skyward::API::Routing::Router::Keyword keyword, Hash[Class, String] names) -> schema
|
|
132
|
+
|
|
133
|
+
# @rbs endpoint: Skyward::API::Routing::Router::Endpoint
|
|
134
|
+
# @rbs body: Skyward::API::Routing::Router::Keyword?
|
|
135
|
+
# @rbs names: Hash[Class, String]
|
|
136
|
+
# @rbs return: Hash[String, schema]
|
|
137
|
+
def responses: (Skyward::API::Routing::Router::Endpoint endpoint, Skyward::API::Routing::Router::Keyword? body, Hash[Class, String] names) -> Hash[String, schema]
|
|
138
|
+
|
|
139
|
+
# @rbs member: Skyward::API::Routing::Router::returned
|
|
140
|
+
# @rbs names: Hash[Class, String]
|
|
141
|
+
# @rbs return: Answer
|
|
142
|
+
def answer: (Skyward::API::Routing::Router::returned member, Hash[Class, String] names) -> Answer
|
|
143
|
+
|
|
144
|
+
# @rbs klass: Class
|
|
145
|
+
# @rbs return: Answer
|
|
146
|
+
def response_value: (Class klass) -> Answer
|
|
147
|
+
|
|
148
|
+
# Every answer with one status has the same media type, because the status says what's sent.
|
|
149
|
+
# @rbs status: String
|
|
150
|
+
# @rbs answers: Array[Answer]
|
|
151
|
+
# @rbs return: schema
|
|
152
|
+
def response: (String status, Array[Answer] answers) -> schema
|
|
153
|
+
|
|
154
|
+
# @rbs endpoints: Array[Skyward::API::Routing::Router::Endpoint]
|
|
155
|
+
# @rbs types: Array[Skyward::Core::Types::Named]
|
|
156
|
+
# @rbs names: Hash[Class, String]
|
|
157
|
+
# @rbs return: Hash[String, schema]
|
|
158
|
+
def components: (Array[Skyward::API::Routing::Router::Endpoint] endpoints, Array[Skyward::Core::Types::Named] types, Hash[Class, String] names) -> Hash[String, schema]
|
|
159
|
+
|
|
160
|
+
# @rbs type: Skyward::Core::Types::t
|
|
161
|
+
# @rbs form: form
|
|
162
|
+
# @rbs names: Hash[Class, String]
|
|
163
|
+
# @rbs return: schema
|
|
164
|
+
def schema: (Skyward::Core::Types::t type, form form, Hash[Class, String] names) -> schema
|
|
165
|
+
|
|
166
|
+
# @rbs schema: schema
|
|
167
|
+
# @rbs return: schema
|
|
168
|
+
def nullable: (schema schema) -> schema
|
|
169
|
+
|
|
170
|
+
# @rbs fields: Array[Skyward::Core::Types::Field]
|
|
171
|
+
# @rbs form: form
|
|
172
|
+
# @rbs names: Hash[Class, String]
|
|
173
|
+
# @rbs return: schema
|
|
174
|
+
def object: (Array[Skyward::Core::Types::Field] fields, form form, Hash[Class, String] names) -> schema
|
|
175
|
+
|
|
176
|
+
# A request may leave out a nullable value, which arrives as nil, but a response always writes it.
|
|
177
|
+
# @rbs required: bool
|
|
178
|
+
# @rbs type: Skyward::Core::Types::t
|
|
179
|
+
# @rbs form: form
|
|
180
|
+
# @rbs return: bool
|
|
181
|
+
def required?: (bool required, Skyward::Core::Types::t type, form form) -> bool
|
|
182
|
+
|
|
183
|
+
# @rbs pattern: Array[String | Symbol]
|
|
184
|
+
# @rbs return: String
|
|
185
|
+
def path: (Array[String | Symbol] pattern) -> String
|
|
186
|
+
|
|
187
|
+
# @rbs endpoint: Skyward::API::Routing::Router::Endpoint
|
|
188
|
+
# @rbs return: String
|
|
189
|
+
def tag: (Skyward::API::Routing::Router::Endpoint endpoint) -> String
|
|
190
|
+
|
|
191
|
+
# @rbs endpoint: Skyward::API::Routing::Router::Endpoint
|
|
192
|
+
# @rbs return: String
|
|
193
|
+
def operation_id: (Skyward::API::Routing::Router::Endpoint endpoint) -> String
|
|
194
|
+
|
|
195
|
+
# @rbs name: String
|
|
196
|
+
# @rbs return: String
|
|
197
|
+
def dotted: (String name) -> String
|
|
198
|
+
end
|
|
@@ -0,0 +1,65 @@
|
|
|
1
|
+
# Generated from lib/skyward/api/request.rb with RBS::Inline
|
|
2
|
+
|
|
3
|
+
class Skyward::API::Request
|
|
4
|
+
# Rack passes these two headers without the HTTP_ prefix the others get.
|
|
5
|
+
UNPREFIXED: Hash[String, String]
|
|
6
|
+
|
|
7
|
+
OCTET: String
|
|
8
|
+
|
|
9
|
+
# Rack's trusted proxies: loopback, the private ranges and Unix sockets.
|
|
10
|
+
TRUSTED_PROXY: Regexp
|
|
11
|
+
|
|
12
|
+
IPV6: Regexp
|
|
13
|
+
|
|
14
|
+
# Rack's authority grammar: a bracketed IPv6 address or an RFC 3986 host, then an optional port.
|
|
15
|
+
AUTHORITY: Regexp
|
|
16
|
+
|
|
17
|
+
# @dynamic env
|
|
18
|
+
attr_reader env: Hash[String, untyped]
|
|
19
|
+
|
|
20
|
+
# @dynamic headers
|
|
21
|
+
attr_reader headers: Hash[String, String]
|
|
22
|
+
|
|
23
|
+
# @dynamic cookies
|
|
24
|
+
attr_reader cookies: Hash[String, String]
|
|
25
|
+
|
|
26
|
+
# @dynamic ip
|
|
27
|
+
attr_reader ip: String?
|
|
28
|
+
|
|
29
|
+
# @dynamic request_id
|
|
30
|
+
attr_reader request_id: String
|
|
31
|
+
|
|
32
|
+
# @rbs env: Hash[String, untyped]
|
|
33
|
+
# @rbs return: void
|
|
34
|
+
def initialize: (Hash[String, untyped] env) -> void
|
|
35
|
+
|
|
36
|
+
private
|
|
37
|
+
|
|
38
|
+
# @rbs env: Hash[String, untyped]
|
|
39
|
+
# @rbs return: Hash[String, String]
|
|
40
|
+
def read_headers: (Hash[String, untyped] env) -> Hash[String, String]
|
|
41
|
+
|
|
42
|
+
# @rbs header: String?
|
|
43
|
+
# @rbs return: Hash[String, String]
|
|
44
|
+
def read_cookies: (String? header) -> Hash[String, String]
|
|
45
|
+
|
|
46
|
+
# @rbs header: String?
|
|
47
|
+
# @rbs return: Array[String]
|
|
48
|
+
def addresses: (String? header) -> Array[String]
|
|
49
|
+
|
|
50
|
+
# Rack wraps a bare IPv6 address, which clients send without brackets.
|
|
51
|
+
# @rbs entry: String
|
|
52
|
+
# @rbs return: String?
|
|
53
|
+
def bare: (String entry) -> String?
|
|
54
|
+
|
|
55
|
+
# As Rack does, a forwarded address is trusted only from a trusted proxy,
|
|
56
|
+
# and the client is the last address that isn't one.
|
|
57
|
+
# @rbs remote: Array[String?]
|
|
58
|
+
# @rbs forwarded: Array[String?]
|
|
59
|
+
# @rbs return: String?
|
|
60
|
+
def client_ip: (Array[String?] remote, Array[String?] forwarded) -> String?
|
|
61
|
+
|
|
62
|
+
# @rbs addresses: Array[String?]
|
|
63
|
+
# @rbs return: Array[String?]?
|
|
64
|
+
def untrusted: (Array[String?] addresses) -> Array[String?]?
|
|
65
|
+
end
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
# Generated from lib/skyward/api/responses/bad_request.rb with RBS::Inline
|
|
2
|
+
|
|
3
|
+
class Skyward::API::Responses::BadRequest
|
|
4
|
+
# @dynamic detail
|
|
5
|
+
attr_reader detail: String
|
|
6
|
+
|
|
7
|
+
# @dynamic headers
|
|
8
|
+
attr_reader headers: Hash[String, String]
|
|
9
|
+
|
|
10
|
+
# @rbs detail: String
|
|
11
|
+
# @rbs headers: Hash[String, String]
|
|
12
|
+
# @rbs return: void
|
|
13
|
+
def initialize: (detail: String, headers: Hash[String, String]) -> void
|
|
14
|
+
end
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
# Generated from lib/skyward/api/responses/conflict.rb with RBS::Inline
|
|
2
|
+
|
|
3
|
+
class Skyward::API::Responses::Conflict
|
|
4
|
+
# @dynamic detail
|
|
5
|
+
attr_reader detail: String
|
|
6
|
+
|
|
7
|
+
# @dynamic headers
|
|
8
|
+
attr_reader headers: Hash[String, String]
|
|
9
|
+
|
|
10
|
+
# @rbs detail: String
|
|
11
|
+
# @rbs headers: Hash[String, String]
|
|
12
|
+
# @rbs return: void
|
|
13
|
+
def initialize: (detail: String, headers: Hash[String, String]) -> void
|
|
14
|
+
end
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# Generated from lib/skyward/api/responses/created.rb with RBS::Inline
|
|
2
|
+
|
|
3
|
+
# @rbs generic out T
|
|
4
|
+
class Skyward::API::Responses::Created[out T]
|
|
5
|
+
# @dynamic value
|
|
6
|
+
attr_reader value: T
|
|
7
|
+
|
|
8
|
+
# @dynamic headers
|
|
9
|
+
attr_reader headers: Hash[String, String]
|
|
10
|
+
|
|
11
|
+
# @rbs value: T
|
|
12
|
+
# @rbs headers: Hash[String, String]
|
|
13
|
+
# @rbs return: void
|
|
14
|
+
def initialize: (value: T, headers: Hash[String, String]) -> void
|
|
15
|
+
end
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
# Generated from lib/skyward/api/responses/forbidden.rb with RBS::Inline
|
|
2
|
+
|
|
3
|
+
class Skyward::API::Responses::Forbidden
|
|
4
|
+
# @dynamic detail
|
|
5
|
+
attr_reader detail: String
|
|
6
|
+
|
|
7
|
+
# @dynamic headers
|
|
8
|
+
attr_reader headers: Hash[String, String]
|
|
9
|
+
|
|
10
|
+
# @rbs detail: String
|
|
11
|
+
# @rbs headers: Hash[String, String]
|
|
12
|
+
# @rbs return: void
|
|
13
|
+
def initialize: (detail: String, headers: Hash[String, String]) -> void
|
|
14
|
+
end
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# Generated from lib/skyward/api/responses/no_content.rb with RBS::Inline
|
|
2
|
+
|
|
3
|
+
class Skyward::API::Responses::NoContent
|
|
4
|
+
# @dynamic headers
|
|
5
|
+
attr_reader headers: Hash[String, String]
|
|
6
|
+
|
|
7
|
+
# @rbs headers: Hash[String, String]
|
|
8
|
+
# @rbs return: void
|
|
9
|
+
def initialize: (headers: Hash[String, String]) -> void
|
|
10
|
+
end
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
# Generated from lib/skyward/api/responses/not_found.rb with RBS::Inline
|
|
2
|
+
|
|
3
|
+
class Skyward::API::Responses::NotFound
|
|
4
|
+
# @dynamic detail
|
|
5
|
+
attr_reader detail: String?
|
|
6
|
+
|
|
7
|
+
# @dynamic headers
|
|
8
|
+
attr_reader headers: Hash[String, String]
|
|
9
|
+
|
|
10
|
+
# @rbs detail: String?
|
|
11
|
+
# @rbs headers: Hash[String, String]
|
|
12
|
+
# @rbs return: void
|
|
13
|
+
def initialize: (detail: String?, headers: Hash[String, String]) -> void
|
|
14
|
+
end
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# Generated from lib/skyward/api/responses/redirect.rb with RBS::Inline
|
|
2
|
+
|
|
3
|
+
class Skyward::API::Responses::Redirect
|
|
4
|
+
STATUSES: Array[Integer]
|
|
5
|
+
|
|
6
|
+
# @dynamic to
|
|
7
|
+
attr_reader to: String
|
|
8
|
+
|
|
9
|
+
# @dynamic status
|
|
10
|
+
attr_reader status: Integer
|
|
11
|
+
|
|
12
|
+
# @dynamic headers
|
|
13
|
+
attr_reader headers: Hash[String, String]
|
|
14
|
+
|
|
15
|
+
# @rbs to: String
|
|
16
|
+
# @rbs status: Integer
|
|
17
|
+
# @rbs headers: Hash[String, String]
|
|
18
|
+
# @rbs return: void
|
|
19
|
+
def initialize: (to: String, status: Integer, headers: Hash[String, String]) -> void
|
|
20
|
+
end
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
# Generated from lib/skyward/api/responses/unauthorized.rb with RBS::Inline
|
|
2
|
+
|
|
3
|
+
class Skyward::API::Responses::Unauthorized
|
|
4
|
+
# @dynamic detail
|
|
5
|
+
attr_reader detail: String
|
|
6
|
+
|
|
7
|
+
# @dynamic headers
|
|
8
|
+
attr_reader headers: Hash[String, String]
|
|
9
|
+
|
|
10
|
+
# @rbs detail: String
|
|
11
|
+
# @rbs headers: Hash[String, String]
|
|
12
|
+
# @rbs return: void
|
|
13
|
+
def initialize: (detail: String, headers: Hash[String, String]) -> void
|
|
14
|
+
end
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
# Generated from lib/skyward/api/responses/unprocessable.rb with RBS::Inline
|
|
2
|
+
|
|
3
|
+
class Skyward::API::Responses::Unprocessable
|
|
4
|
+
# @dynamic detail
|
|
5
|
+
attr_reader detail: String
|
|
6
|
+
|
|
7
|
+
# @dynamic headers
|
|
8
|
+
attr_reader headers: Hash[String, String]
|
|
9
|
+
|
|
10
|
+
# @rbs detail: String
|
|
11
|
+
# @rbs headers: Hash[String, String]
|
|
12
|
+
# @rbs return: void
|
|
13
|
+
def initialize: (detail: String, headers: Hash[String, String]) -> void
|
|
14
|
+
end
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
# Generated from lib/skyward/api/routing/percent_encoding.rb with RBS::Inline
|
|
2
|
+
|
|
3
|
+
module Skyward::API::Routing::PercentEncoding
|
|
4
|
+
ESCAPE: Regexp
|
|
5
|
+
|
|
6
|
+
# Lenient, unlike URI.decode_uri_component, because servers pass the path
|
|
7
|
+
# through undecoded and a malformed escape is the client's to send.
|
|
8
|
+
# @rbs text: String
|
|
9
|
+
# @rbs return: String
|
|
10
|
+
def decode: (String text) -> String
|
|
11
|
+
end
|
|
@@ -0,0 +1,158 @@
|
|
|
1
|
+
# Generated from lib/skyward/api/routing/router.rb with RBS::Inline
|
|
2
|
+
|
|
3
|
+
class Skyward::API::Routing::Router
|
|
4
|
+
type returned = Skyward::Core::Types::t | Created | Response | Rack
|
|
5
|
+
|
|
6
|
+
class Keyword < Data
|
|
7
|
+
attr_reader name(): Symbol
|
|
8
|
+
|
|
9
|
+
attr_reader source(): :path | :query | :body | :request
|
|
10
|
+
|
|
11
|
+
attr_reader required(): bool
|
|
12
|
+
|
|
13
|
+
attr_reader type(): Skyward::Core::Types::t
|
|
14
|
+
|
|
15
|
+
def self.new: (Symbol name, :path | :query | :body | :request source, bool required, Skyward::Core::Types::t type) -> instance
|
|
16
|
+
| (name: Symbol, source: :path | :query | :body | :request, required: bool, type: Skyward::Core::Types::t) -> instance
|
|
17
|
+
|
|
18
|
+
def self.members: () -> [ :name, :source, :required, :type ]
|
|
19
|
+
|
|
20
|
+
def members: () -> [ :name, :source, :required, :type ]
|
|
21
|
+
end
|
|
22
|
+
|
|
23
|
+
# Skyward::API::Responses::Created[T], which the reader can't read, so its value's type is read on its own.
|
|
24
|
+
class Created < Data
|
|
25
|
+
attr_reader type(): Skyward::Core::Types::t
|
|
26
|
+
|
|
27
|
+
def self.new: (Skyward::Core::Types::t type) -> instance
|
|
28
|
+
| (type: Skyward::Core::Types::t) -> instance
|
|
29
|
+
|
|
30
|
+
def self.members: () -> [ :type ]
|
|
31
|
+
|
|
32
|
+
def members: () -> [ :type ]
|
|
33
|
+
end
|
|
34
|
+
|
|
35
|
+
class Response < Data
|
|
36
|
+
attr_reader klass(): Class
|
|
37
|
+
|
|
38
|
+
def self.new: (Class klass) -> instance
|
|
39
|
+
| (klass: Class) -> instance
|
|
40
|
+
|
|
41
|
+
def self.members: () -> [ :klass ]
|
|
42
|
+
|
|
43
|
+
def members: () -> [ :klass ]
|
|
44
|
+
end
|
|
45
|
+
|
|
46
|
+
class Rack < Data
|
|
47
|
+
def self.new: () -> instance
|
|
48
|
+
| () -> instance
|
|
49
|
+
|
|
50
|
+
def self.members: () -> [ ]
|
|
51
|
+
|
|
52
|
+
def members: () -> [ ]
|
|
53
|
+
end
|
|
54
|
+
|
|
55
|
+
# A provider without a signature has no value to check, so its value is nil.
|
|
56
|
+
class Provider < Data
|
|
57
|
+
attr_reader name(): Symbol
|
|
58
|
+
|
|
59
|
+
attr_reader callable(): Skyward::API::_Provider
|
|
60
|
+
|
|
61
|
+
attr_reader value(): Array[RBS::Types::t]?
|
|
62
|
+
|
|
63
|
+
attr_reader responses(): Array[Response]
|
|
64
|
+
|
|
65
|
+
attr_reader serializer(): Skyward::API::Serializer
|
|
66
|
+
|
|
67
|
+
def self.new: (Symbol name, Skyward::API::_Provider callable, Array[RBS::Types::t]? value, Array[Response] responses, Skyward::API::Serializer serializer) -> instance
|
|
68
|
+
| (name: Symbol, callable: Skyward::API::_Provider, value: Array[RBS::Types::t]?, responses: Array[Response], serializer: Skyward::API::Serializer) -> instance
|
|
69
|
+
|
|
70
|
+
def self.members: () -> [ :name, :callable, :value, :responses, :serializer ]
|
|
71
|
+
|
|
72
|
+
def members: () -> [ :name, :callable, :value, :responses, :serializer ]
|
|
73
|
+
end
|
|
74
|
+
|
|
75
|
+
class Endpoint < Data
|
|
76
|
+
attr_reader verb(): String
|
|
77
|
+
|
|
78
|
+
attr_reader pattern(): Array[String | Symbol]
|
|
79
|
+
|
|
80
|
+
attr_reader api(): Skyward::API
|
|
81
|
+
|
|
82
|
+
attr_reader to(): Symbol
|
|
83
|
+
|
|
84
|
+
attr_reader label(): String
|
|
85
|
+
|
|
86
|
+
attr_reader summary(): String?
|
|
87
|
+
|
|
88
|
+
attr_reader description(): String?
|
|
89
|
+
|
|
90
|
+
attr_reader keywords(): Array[Keyword]
|
|
91
|
+
|
|
92
|
+
attr_reader providers(): Array[Provider]
|
|
93
|
+
|
|
94
|
+
attr_reader returns(): Array[returned]
|
|
95
|
+
|
|
96
|
+
attr_reader signature(): String
|
|
97
|
+
|
|
98
|
+
attr_reader inputs(): Skyward::API::Inputs
|
|
99
|
+
|
|
100
|
+
attr_reader serializer(): Skyward::API::Serializer
|
|
101
|
+
|
|
102
|
+
def self.new: (String verb, Array[String | Symbol] pattern, Skyward::API api, Symbol to, String label, String? summary, String? description, Array[Keyword] keywords, Array[Provider] providers, Array[returned] returns, String signature, Skyward::API::Inputs inputs, Skyward::API::Serializer serializer) -> instance
|
|
103
|
+
| (verb: String, pattern: Array[String | Symbol], api: Skyward::API, to: Symbol, label: String, summary: String?, description: String?, keywords: Array[Keyword], providers: Array[Provider], returns: Array[returned], signature: String, inputs: Skyward::API::Inputs, serializer: Skyward::API::Serializer) -> instance
|
|
104
|
+
|
|
105
|
+
def self.members: () -> [ :verb, :pattern, :api, :to, :label, :summary, :description, :keywords, :providers, :returns, :signature, :inputs, :serializer ]
|
|
106
|
+
|
|
107
|
+
def members: () -> [ :verb, :pattern, :api, :to, :label, :summary, :description, :keywords, :providers, :returns, :signature, :inputs, :serializer ]
|
|
108
|
+
end
|
|
109
|
+
|
|
110
|
+
class Match < Data
|
|
111
|
+
attr_reader api(): Skyward::API
|
|
112
|
+
|
|
113
|
+
attr_reader to(): Symbol
|
|
114
|
+
|
|
115
|
+
attr_reader inputs(): Skyward::API::Inputs
|
|
116
|
+
|
|
117
|
+
attr_reader params(): Hash[Symbol, String]
|
|
118
|
+
|
|
119
|
+
attr_reader serializer(): Skyward::API::Serializer
|
|
120
|
+
|
|
121
|
+
def self.new: (Skyward::API api, Symbol to, Skyward::API::Inputs inputs, Hash[Symbol, String] params, Skyward::API::Serializer serializer) -> instance
|
|
122
|
+
| (api: Skyward::API, to: Symbol, inputs: Skyward::API::Inputs, params: Hash[Symbol, String], serializer: Skyward::API::Serializer) -> instance
|
|
123
|
+
|
|
124
|
+
def self.members: () -> [ :api, :to, :inputs, :params, :serializer ]
|
|
125
|
+
|
|
126
|
+
def members: () -> [ :api, :to, :inputs, :params, :serializer ]
|
|
127
|
+
end
|
|
128
|
+
|
|
129
|
+
METHODS: Array[String]
|
|
130
|
+
|
|
131
|
+
@endpoints: Array[Endpoint]
|
|
132
|
+
|
|
133
|
+
# @rbs endpoints: Array[Endpoint]
|
|
134
|
+
# @rbs return: void
|
|
135
|
+
def initialize: (Array[Endpoint] endpoints) -> void
|
|
136
|
+
|
|
137
|
+
# @rbs verb: String
|
|
138
|
+
# @rbs path: String
|
|
139
|
+
# @rbs return: Match?
|
|
140
|
+
def match: (String verb, String path) -> Match?
|
|
141
|
+
|
|
142
|
+
# @rbs path: String
|
|
143
|
+
# @rbs return: Array[String]
|
|
144
|
+
def allowed: (String path) -> Array[String]
|
|
145
|
+
|
|
146
|
+
private
|
|
147
|
+
|
|
148
|
+
# @rbs endpoint: Endpoint
|
|
149
|
+
# @rbs verb: String
|
|
150
|
+
# @rbs segments: Array[String]
|
|
151
|
+
# @rbs return: Match?
|
|
152
|
+
def match_endpoint: (Endpoint endpoint, String verb, Array[String] segments) -> Match?
|
|
153
|
+
|
|
154
|
+
# @rbs pattern: Array[String | Symbol]
|
|
155
|
+
# @rbs segments: Array[String]
|
|
156
|
+
# @rbs return: Hash[Symbol, String]?
|
|
157
|
+
def params_for: (Array[String | Symbol] pattern, Array[String] segments) -> Hash[Symbol, String]?
|
|
158
|
+
end
|