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,19 @@
|
|
|
1
|
+
# Generated from lib/skyward/api/cli/routes.rb with RBS::Inline
|
|
2
|
+
|
|
3
|
+
module Skyward::API::CLI::Routes
|
|
4
|
+
GAP: Integer
|
|
5
|
+
|
|
6
|
+
# @rbs endpoints: Array[Skyward::API::Routing::Router::Endpoint]
|
|
7
|
+
# @rbs return: String
|
|
8
|
+
def table: (Array[Skyward::API::Routing::Router::Endpoint] endpoints) -> String
|
|
9
|
+
|
|
10
|
+
private
|
|
11
|
+
|
|
12
|
+
# @rbs pattern: Array[String | Symbol]
|
|
13
|
+
# @rbs return: String
|
|
14
|
+
def path: (Array[String | Symbol] pattern) -> String
|
|
15
|
+
|
|
16
|
+
# @rbs endpoint: Skyward::API::Routing::Router::Endpoint
|
|
17
|
+
# @rbs return: String
|
|
18
|
+
def handler: (Skyward::API::Routing::Router::Endpoint endpoint) -> String
|
|
19
|
+
end
|
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
# Generated from lib/skyward/api/cli/serve/reloader.rb with RBS::Inline
|
|
2
|
+
|
|
3
|
+
class Skyward::API::CLI::Serve::Reloader
|
|
4
|
+
INTERVAL: Float
|
|
5
|
+
|
|
6
|
+
@watch: ^() -> Hash[String, Time]
|
|
7
|
+
|
|
8
|
+
@load: ^() -> Skyward::API::_RackApp
|
|
9
|
+
|
|
10
|
+
@clock: ^() -> Float
|
|
11
|
+
|
|
12
|
+
@mutex: Thread::Mutex
|
|
13
|
+
|
|
14
|
+
@checked_at: Float
|
|
15
|
+
|
|
16
|
+
@files: Hash[String, Time]
|
|
17
|
+
|
|
18
|
+
@app: Skyward::API::_RackApp
|
|
19
|
+
|
|
20
|
+
# @rbs watch: ^() -> Hash[String, Time]
|
|
21
|
+
# @rbs load: ^() -> Skyward::API::_RackApp
|
|
22
|
+
# @rbs clock: ^() -> Float
|
|
23
|
+
# @rbs return: void
|
|
24
|
+
def initialize: (watch: ^() -> Hash[String, Time], load: ^() -> Skyward::API::_RackApp, clock: ^() -> Float) -> void
|
|
25
|
+
|
|
26
|
+
# The app is taken under the lock but called outside it, so a request in
|
|
27
|
+
# flight finishes on the app it started with.
|
|
28
|
+
# @rbs env: Hash[String, untyped]
|
|
29
|
+
# @rbs return: Skyward::API::rack_response
|
|
30
|
+
def call: (Hash[String, untyped] env) -> Skyward::API::rack_response
|
|
31
|
+
|
|
32
|
+
private
|
|
33
|
+
|
|
34
|
+
# @rbs return: Skyward::API::_RackApp
|
|
35
|
+
def current: () -> Skyward::API::_RackApp
|
|
36
|
+
|
|
37
|
+
# @rbs return: Skyward::API::_RackApp
|
|
38
|
+
def attempt: () -> Skyward::API::_RackApp
|
|
39
|
+
|
|
40
|
+
# The development 500 that Skyward::API::Middleware::Rescue answers, without a request
|
|
41
|
+
# ID: the app that assigns them is the one that failed to load.
|
|
42
|
+
# @rbs error: Exception
|
|
43
|
+
# @rbs env: Hash[String, untyped]
|
|
44
|
+
# @rbs return: Skyward::API::rack_response
|
|
45
|
+
def failure: (Exception error, Hash[String, untyped] env) -> Skyward::API::rack_response
|
|
46
|
+
end
|
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
# Generated from lib/skyward/api/cli/serve.rb with RBS::Inline
|
|
2
|
+
|
|
3
|
+
module Skyward::API::CLI::Serve
|
|
4
|
+
RACKUP: String
|
|
5
|
+
|
|
6
|
+
CONFIG: String
|
|
7
|
+
|
|
8
|
+
# Neither watched nor reloaded, and nor is any hidden directory: the app's
|
|
9
|
+
# gems can be installed under vendor/ or .bundle/.
|
|
10
|
+
IGNORED: Array[String]
|
|
11
|
+
|
|
12
|
+
WATCHED: String
|
|
13
|
+
|
|
14
|
+
# @rbs directory: String
|
|
15
|
+
# @rbs env: Hash[String, String]
|
|
16
|
+
# @rbs falcon: String?
|
|
17
|
+
# @rbs kernel: singleton(Kernel)
|
|
18
|
+
# @rbs return: void
|
|
19
|
+
def run: (String directory, env: Hash[String, String], falcon: String?, kernel: singleton(Kernel)) -> void
|
|
20
|
+
|
|
21
|
+
# @rbs directory: String
|
|
22
|
+
# @rbs build: ^(String config) -> Skyward::API::_RackApp
|
|
23
|
+
# @rbs clock: ^() -> Float
|
|
24
|
+
# @rbs apis: ^() -> Array[singleton(Skyward::API)]
|
|
25
|
+
# @rbs features: Array[String]
|
|
26
|
+
# @rbs loaders: ^() -> Array[Zeitwerk::Loader]
|
|
27
|
+
# @rbs return: Reloader
|
|
28
|
+
def reloader: (String directory, build: ^(String config) -> Skyward::API::_RackApp, clock: ^() -> Float, apis: ^() -> Array[singleton(Skyward::API)], features: Array[String], loaders: ^() -> Array[Zeitwerk::Loader]) -> Reloader
|
|
29
|
+
|
|
30
|
+
# @rbs directory: String
|
|
31
|
+
# @rbs return: Hash[String, Time]
|
|
32
|
+
def watch: (String directory) -> Hash[String, Time]
|
|
33
|
+
|
|
34
|
+
# @rbs directory: String
|
|
35
|
+
# @rbs apis: Array[singleton(Skyward::API)]
|
|
36
|
+
# @rbs features: Array[String]
|
|
37
|
+
# @rbs loaders: Array[Zeitwerk::Loader]
|
|
38
|
+
# @rbs return: void
|
|
39
|
+
def unload: (String directory, apis: Array[singleton(Skyward::API)], features: Array[String], loaders: Array[Zeitwerk::Loader]) -> void
|
|
40
|
+
|
|
41
|
+
private
|
|
42
|
+
|
|
43
|
+
# @rbs directory: String
|
|
44
|
+
# @rbs api: singleton(Skyward::API)
|
|
45
|
+
# @rbs return: bool
|
|
46
|
+
def reloaded_api?: (String directory, singleton(Skyward::API) api) -> bool
|
|
47
|
+
|
|
48
|
+
# @rbs directory: String
|
|
49
|
+
# @rbs path: String
|
|
50
|
+
# @rbs return: bool
|
|
51
|
+
def reloaded?: (String directory, String path) -> bool
|
|
52
|
+
|
|
53
|
+
# @rbs root: String
|
|
54
|
+
# @rbs return: bool
|
|
55
|
+
def ignored?: (String root) -> bool
|
|
56
|
+
end
|
|
@@ -0,0 +1,81 @@
|
|
|
1
|
+
# Generated from lib/skyward/api/endpoints/declarations.rb with RBS::Inline
|
|
2
|
+
|
|
3
|
+
# @rbs module-self Class
|
|
4
|
+
module Skyward::API::Endpoints::Declarations : Class
|
|
5
|
+
PARAMETER_NAME: Regexp
|
|
6
|
+
|
|
7
|
+
@routes: Array[Skyward::API::Endpoints::Route]?
|
|
8
|
+
|
|
9
|
+
@class_description: String?
|
|
10
|
+
|
|
11
|
+
# A class that hasn't declared a route, or whose routes were cleared, has its
|
|
12
|
+
# parent's, so a reopened subclass declares its own after them again.
|
|
13
|
+
# @rbs return: Array[Skyward::API::Endpoints::Route]
|
|
14
|
+
def routes: () -> Array[Skyward::API::Endpoints::Route]
|
|
15
|
+
|
|
16
|
+
# @rbs return: String?
|
|
17
|
+
def class_description: () -> String?
|
|
18
|
+
|
|
19
|
+
# @rbs text: String
|
|
20
|
+
# @rbs return: void
|
|
21
|
+
def description: (String text) -> void
|
|
22
|
+
|
|
23
|
+
# skyward serve's reloading runs a reopened class's declarations again, on
|
|
24
|
+
# the same class, so it clears them first.
|
|
25
|
+
# @rbs return: void
|
|
26
|
+
def clear_declarations: () -> void
|
|
27
|
+
|
|
28
|
+
# @rbs path: String
|
|
29
|
+
# @rbs to: Symbol
|
|
30
|
+
# @rbs summary: String?
|
|
31
|
+
# @rbs description: String?
|
|
32
|
+
# @rbs return: void
|
|
33
|
+
def get: (String path, to: Symbol, ?summary: String?, ?description: String?) -> void
|
|
34
|
+
|
|
35
|
+
# @rbs path: String
|
|
36
|
+
# @rbs to: Symbol
|
|
37
|
+
# @rbs summary: String?
|
|
38
|
+
# @rbs description: String?
|
|
39
|
+
# @rbs return: void
|
|
40
|
+
def post: (String path, to: Symbol, ?summary: String?, ?description: String?) -> void
|
|
41
|
+
|
|
42
|
+
# @rbs path: String
|
|
43
|
+
# @rbs to: Symbol
|
|
44
|
+
# @rbs summary: String?
|
|
45
|
+
# @rbs description: String?
|
|
46
|
+
# @rbs return: void
|
|
47
|
+
def put: (String path, to: Symbol, ?summary: String?, ?description: String?) -> void
|
|
48
|
+
|
|
49
|
+
# @rbs path: String
|
|
50
|
+
# @rbs to: Symbol
|
|
51
|
+
# @rbs summary: String?
|
|
52
|
+
# @rbs description: String?
|
|
53
|
+
# @rbs return: void
|
|
54
|
+
def patch: (String path, to: Symbol, ?summary: String?, ?description: String?) -> void
|
|
55
|
+
|
|
56
|
+
# @rbs path: String
|
|
57
|
+
# @rbs to: Symbol
|
|
58
|
+
# @rbs summary: String?
|
|
59
|
+
# @rbs description: String?
|
|
60
|
+
# @rbs return: void
|
|
61
|
+
def delete: (String path, to: Symbol, ?summary: String?, ?description: String?) -> void
|
|
62
|
+
|
|
63
|
+
private
|
|
64
|
+
|
|
65
|
+
# @rbs return: Array[Skyward::API::Endpoints::Route]
|
|
66
|
+
def inherited_routes: () -> Array[Skyward::API::Endpoints::Route]
|
|
67
|
+
|
|
68
|
+
# @rbs verb: Symbol
|
|
69
|
+
# @rbs path: String
|
|
70
|
+
# @rbs to: Symbol
|
|
71
|
+
# @rbs summary: String?
|
|
72
|
+
# @rbs description: String?
|
|
73
|
+
# @rbs return: void
|
|
74
|
+
def declare: (Symbol verb, String path, Symbol to, String? summary, String? description) -> void
|
|
75
|
+
|
|
76
|
+
# Untyped: a caller that Steep doesn't check can pass anything.
|
|
77
|
+
# @rbs path: untyped
|
|
78
|
+
# @rbs to: untyped
|
|
79
|
+
# @rbs return: String?
|
|
80
|
+
def problem_with: (untyped path, untyped to) -> String?
|
|
81
|
+
end
|
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
# Generated from lib/skyward/api/endpoints/helpers.rb with RBS::Inline
|
|
2
|
+
|
|
3
|
+
# Private, so a route can't name a helper as its method.
|
|
4
|
+
module Skyward::API::Endpoints::Helpers
|
|
5
|
+
private
|
|
6
|
+
|
|
7
|
+
# @rbs [T] (T value, ?headers: Hash[String, String]) -> Skyward::API::Responses::Created[T]
|
|
8
|
+
def created: [T] (T value, ?headers: Hash[String, String]) -> Skyward::API::Responses::Created[T]
|
|
9
|
+
|
|
10
|
+
# @rbs headers: Hash[String, String]
|
|
11
|
+
# @rbs return: Skyward::API::Responses::NoContent
|
|
12
|
+
def no_content: (?headers: Hash[String, String]) -> Skyward::API::Responses::NoContent
|
|
13
|
+
|
|
14
|
+
# @rbs detail: String
|
|
15
|
+
# @rbs headers: Hash[String, String]
|
|
16
|
+
# @rbs return: Skyward::API::Responses::BadRequest
|
|
17
|
+
def bad_request: (String detail, ?headers: Hash[String, String]) -> Skyward::API::Responses::BadRequest
|
|
18
|
+
|
|
19
|
+
# @rbs detail: String
|
|
20
|
+
# @rbs headers: Hash[String, String]
|
|
21
|
+
# @rbs return: Skyward::API::Responses::Unauthorized
|
|
22
|
+
def unauthorized: (String detail, ?headers: Hash[String, String]) -> Skyward::API::Responses::Unauthorized
|
|
23
|
+
|
|
24
|
+
# @rbs detail: String
|
|
25
|
+
# @rbs headers: Hash[String, String]
|
|
26
|
+
# @rbs return: Skyward::API::Responses::Forbidden
|
|
27
|
+
def forbidden: (String detail, ?headers: Hash[String, String]) -> Skyward::API::Responses::Forbidden
|
|
28
|
+
|
|
29
|
+
# @rbs detail: String?
|
|
30
|
+
# @rbs headers: Hash[String, String]
|
|
31
|
+
# @rbs return: Skyward::API::Responses::NotFound
|
|
32
|
+
def not_found: (?String? detail, ?headers: Hash[String, String]) -> Skyward::API::Responses::NotFound
|
|
33
|
+
|
|
34
|
+
# @rbs detail: String
|
|
35
|
+
# @rbs headers: Hash[String, String]
|
|
36
|
+
# @rbs return: Skyward::API::Responses::Conflict
|
|
37
|
+
def conflict: (String detail, ?headers: Hash[String, String]) -> Skyward::API::Responses::Conflict
|
|
38
|
+
|
|
39
|
+
# @rbs detail: String
|
|
40
|
+
# @rbs headers: Hash[String, String]
|
|
41
|
+
# @rbs return: Skyward::API::Responses::Unprocessable
|
|
42
|
+
def unprocessable: (String detail, ?headers: Hash[String, String]) -> Skyward::API::Responses::Unprocessable
|
|
43
|
+
|
|
44
|
+
# @rbs to: String
|
|
45
|
+
# @rbs status: Integer
|
|
46
|
+
# @rbs headers: Hash[String, String]
|
|
47
|
+
# @rbs return: Skyward::API::Responses::Redirect
|
|
48
|
+
def redirect: (String to, ?status: Integer, ?headers: Hash[String, String]) -> Skyward::API::Responses::Redirect
|
|
49
|
+
end
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# Generated from lib/skyward/api/endpoints/route.rb with RBS::Inline
|
|
2
|
+
|
|
3
|
+
# rbs-inline only types a Data.define assigned to a bare constant name, so
|
|
4
|
+
# Route is assigned inside the module rather than as Skyward::API::Endpoints::Route.
|
|
5
|
+
module Skyward::API::Endpoints
|
|
6
|
+
class Route < Data
|
|
7
|
+
attr_reader verb(): Symbol
|
|
8
|
+
|
|
9
|
+
attr_reader path(): String
|
|
10
|
+
|
|
11
|
+
attr_reader to(): Symbol
|
|
12
|
+
|
|
13
|
+
attr_reader summary(): String?
|
|
14
|
+
|
|
15
|
+
attr_reader description(): String?
|
|
16
|
+
|
|
17
|
+
def self.new: (Symbol verb, String path, Symbol to, String? summary, String? description) -> instance
|
|
18
|
+
| (verb: Symbol, path: String, to: Symbol, summary: String?, description: String?) -> instance
|
|
19
|
+
|
|
20
|
+
def self.members: () -> [ :verb, :path, :to, :summary, :description ]
|
|
21
|
+
|
|
22
|
+
def members: () -> [ :verb, :path, :to, :summary, :description ]
|
|
23
|
+
end
|
|
24
|
+
end
|
|
@@ -0,0 +1,231 @@
|
|
|
1
|
+
# Generated from lib/skyward/api/inputs/coercer.rb with RBS::Inline
|
|
2
|
+
|
|
3
|
+
module Skyward::API::Inputs::Coercer
|
|
4
|
+
type result = Ok | Invalid
|
|
5
|
+
|
|
6
|
+
type t = ^(untyped raw, String at) -> result
|
|
7
|
+
|
|
8
|
+
type seen = Hash[[ Integer, Integer ], result]
|
|
9
|
+
|
|
10
|
+
type coercer = ^(untyped raw, String at, seen seen) -> result
|
|
11
|
+
|
|
12
|
+
class Error < Data
|
|
13
|
+
attr_reader at(): String
|
|
14
|
+
|
|
15
|
+
attr_reader message(): String
|
|
16
|
+
|
|
17
|
+
def self.new: (String at, String message) -> instance
|
|
18
|
+
| (at: String, message: String) -> instance
|
|
19
|
+
|
|
20
|
+
def self.members: () -> [ :at, :message ]
|
|
21
|
+
|
|
22
|
+
def members: () -> [ :at, :message ]
|
|
23
|
+
end
|
|
24
|
+
|
|
25
|
+
class Ok < Data
|
|
26
|
+
attr_reader value(): untyped
|
|
27
|
+
|
|
28
|
+
def self.new: (untyped value) -> instance
|
|
29
|
+
| (value: untyped) -> instance
|
|
30
|
+
|
|
31
|
+
def self.members: () -> [ :value ]
|
|
32
|
+
|
|
33
|
+
def members: () -> [ :value ]
|
|
34
|
+
end
|
|
35
|
+
|
|
36
|
+
class Invalid < Data
|
|
37
|
+
attr_reader errors(): Array[Error]
|
|
38
|
+
|
|
39
|
+
def self.new: (Array[Error] errors) -> instance
|
|
40
|
+
| (errors: Array[Error]) -> instance
|
|
41
|
+
|
|
42
|
+
def self.members: () -> [ :errors ]
|
|
43
|
+
|
|
44
|
+
def members: () -> [ :errors ]
|
|
45
|
+
end
|
|
46
|
+
|
|
47
|
+
# Coercion stops once it has found this many problems, so a small body can't
|
|
48
|
+
# produce a large response.
|
|
49
|
+
MAX_ERRORS: Integer
|
|
50
|
+
|
|
51
|
+
# A message's expected type and a hash's key in a path are cut to this many
|
|
52
|
+
# characters, so a large written type or key can't make a 422 many times
|
|
53
|
+
# larger than the body that caused it.
|
|
54
|
+
MAX_SHOWN: Integer
|
|
55
|
+
|
|
56
|
+
# Stands for every problem a union's member finds, since the union reports
|
|
57
|
+
# none of them.
|
|
58
|
+
MISFIT: Invalid
|
|
59
|
+
|
|
60
|
+
# INTEGER, DATE and TIME match a String's bytes, because a path parameter
|
|
61
|
+
# can be any bytes, and Regexp#match raises on a String that isn't UTF-8.
|
|
62
|
+
INTEGER: Regexp
|
|
63
|
+
|
|
64
|
+
BOOLEANS: Hash[String, bool]
|
|
65
|
+
|
|
66
|
+
DATE: Regexp
|
|
67
|
+
|
|
68
|
+
# The fraction is cut to nanoseconds, which bounds what converting it costs.
|
|
69
|
+
TIME: Regexp
|
|
70
|
+
|
|
71
|
+
NAMES: Hash[Skyward::Core::Types::scalar, String]
|
|
72
|
+
|
|
73
|
+
FORMATS: Hash[Skyward::Core::Types::scalar, String]
|
|
74
|
+
|
|
75
|
+
# Path and query values are Strings, so with strings: true a coercer parses them.
|
|
76
|
+
# @rbs type: Skyward::Core::Types::t
|
|
77
|
+
# @rbs strings: bool
|
|
78
|
+
# @rbs return: t
|
|
79
|
+
def compile: (Skyward::Core::Types::t type, strings: bool) -> t
|
|
80
|
+
|
|
81
|
+
# @rbs type: Skyward::Core::Types::t
|
|
82
|
+
# @rbs required: bool
|
|
83
|
+
# @rbs at: String
|
|
84
|
+
# @rbs return: result?
|
|
85
|
+
def absent: (Skyward::Core::Types::t type, bool required, String at) -> result?
|
|
86
|
+
|
|
87
|
+
# @rbs results: Hash[Symbol, result]
|
|
88
|
+
# @rbs return: result
|
|
89
|
+
def combine: (Hash[Symbol, result] results) -> result
|
|
90
|
+
|
|
91
|
+
private
|
|
92
|
+
|
|
93
|
+
# A union reports its own mismatch, so with member: true a coercer stops at
|
|
94
|
+
# its first problem and never writes a message.
|
|
95
|
+
# @rbs type: Skyward::Core::Types::t
|
|
96
|
+
# @rbs strings: bool
|
|
97
|
+
# @rbs member: bool
|
|
98
|
+
# @rbs unions: Hash[[Skyward::Core::Types::Union, bool], coercer]
|
|
99
|
+
# @rbs return: coercer
|
|
100
|
+
def build: (Skyward::Core::Types::t type, bool strings, bool member, Hash[[ Skyward::Core::Types::Union, bool ], coercer] unions) -> coercer
|
|
101
|
+
|
|
102
|
+
# @rbs type: Skyward::Core::Types::Record | Skyward::Core::Types::Named
|
|
103
|
+
# @rbs strings: bool
|
|
104
|
+
# @rbs member: bool
|
|
105
|
+
# @rbs unions: Hash[[Skyward::Core::Types::Union, bool], coercer]
|
|
106
|
+
# @rbs return: Array[[Skyward::Core::Types::Field, coercer]]
|
|
107
|
+
def fields: (Skyward::Core::Types::Record | Skyward::Core::Types::Named type, bool strings, bool member, Hash[[ Skyward::Core::Types::Union, bool ], coercer] unions) -> Array[[ Skyward::Core::Types::Field, coercer ]]
|
|
108
|
+
|
|
109
|
+
# @rbs parse: ^(untyped) -> Ok?
|
|
110
|
+
# @rbs expected: String?
|
|
111
|
+
# @rbs return: coercer
|
|
112
|
+
def scalar: (^(untyped) -> Ok? parse, String? expected) -> coercer
|
|
113
|
+
|
|
114
|
+
# @rbs name: Skyward::Core::Types::scalar
|
|
115
|
+
# @rbs strings: bool
|
|
116
|
+
# @rbs return: ^(untyped) -> Ok?
|
|
117
|
+
def parser: (Skyward::Core::Types::scalar name, bool strings) -> ^(untyped) -> Ok?
|
|
118
|
+
|
|
119
|
+
# A query key given more than once arrives as an Array of its values, of
|
|
120
|
+
# which untyped takes the last, as Rack's params do.
|
|
121
|
+
# @rbs raw: String | Array[String]
|
|
122
|
+
# @rbs return: String?
|
|
123
|
+
def last: (String | Array[String] raw) -> String?
|
|
124
|
+
|
|
125
|
+
# @rbs raw: untyped
|
|
126
|
+
# @rbs return: untyped
|
|
127
|
+
def symbolized: (untyped raw) -> untyped
|
|
128
|
+
|
|
129
|
+
# @rbs raw: untyped
|
|
130
|
+
# @rbs strings: bool
|
|
131
|
+
# @rbs return: Ok?
|
|
132
|
+
def integer: (untyped raw, bool strings) -> Ok?
|
|
133
|
+
|
|
134
|
+
# @rbs raw: untyped
|
|
135
|
+
# @rbs strings: bool
|
|
136
|
+
# @rbs return: Ok?
|
|
137
|
+
def float: (untyped raw, bool strings) -> Ok?
|
|
138
|
+
|
|
139
|
+
# @rbs raw: untyped
|
|
140
|
+
# @rbs strings: bool
|
|
141
|
+
# @rbs return: Ok?
|
|
142
|
+
def bool: (untyped raw, bool strings) -> Ok?
|
|
143
|
+
|
|
144
|
+
# @rbs raw: untyped
|
|
145
|
+
# @rbs return: Ok?
|
|
146
|
+
def date: (untyped raw) -> Ok?
|
|
147
|
+
|
|
148
|
+
# @rbs raw: untyped
|
|
149
|
+
# @rbs return: Ok?
|
|
150
|
+
def time: (untyped raw) -> Ok?
|
|
151
|
+
|
|
152
|
+
# @rbs value: Skyward::Core::Types::literal
|
|
153
|
+
# @rbs strings: bool
|
|
154
|
+
# @rbs expected: String?
|
|
155
|
+
# @rbs return: coercer
|
|
156
|
+
def literal: (Skyward::Core::Types::literal value, bool strings, String? expected) -> coercer
|
|
157
|
+
|
|
158
|
+
# @rbs symbols: Array[Symbol]
|
|
159
|
+
# @rbs expected: String?
|
|
160
|
+
# @rbs return: coercer
|
|
161
|
+
def enum: (Array[Symbol] symbols, String? expected) -> coercer
|
|
162
|
+
|
|
163
|
+
# @rbs coercer: coercer
|
|
164
|
+
# @rbs return: coercer
|
|
165
|
+
def nullable: (coercer coercer) -> coercer
|
|
166
|
+
|
|
167
|
+
# @rbs item: coercer
|
|
168
|
+
# @rbs strings: bool
|
|
169
|
+
# @rbs limit: Integer
|
|
170
|
+
# @rbs expected: String?
|
|
171
|
+
# @rbs return: coercer
|
|
172
|
+
def array: (coercer item, bool strings, Integer limit, String? expected) -> coercer
|
|
173
|
+
|
|
174
|
+
# @rbs value: coercer
|
|
175
|
+
# @rbs limit: Integer
|
|
176
|
+
# @rbs expected: String?
|
|
177
|
+
# @rbs return: coercer
|
|
178
|
+
def hash_of: (coercer value, Integer limit, String? expected) -> coercer
|
|
179
|
+
|
|
180
|
+
# @rbs values: Array[untyped]
|
|
181
|
+
# @rbs item: coercer
|
|
182
|
+
# @rbs limit: Integer
|
|
183
|
+
# @rbs seen: seen
|
|
184
|
+
# @rbs &: (Integer) -> String
|
|
185
|
+
# @rbs return: Array[result]
|
|
186
|
+
def items: (Array[untyped] values, coercer item, Integer limit, seen seen) { (Integer) -> String } -> Array[result]
|
|
187
|
+
|
|
188
|
+
# @rbs results: Array[result]
|
|
189
|
+
# @rbs &: (Array[untyped]) -> untyped
|
|
190
|
+
# @rbs return: result
|
|
191
|
+
def collected: (Array[result] results) { (Array[untyped]) -> untyped } -> result
|
|
192
|
+
|
|
193
|
+
# @rbs fields: Array[[Skyward::Core::Types::Field, coercer]]
|
|
194
|
+
# @rbs limit: Integer
|
|
195
|
+
# @rbs expected: String?
|
|
196
|
+
# @rbs &: (Hash[Symbol, untyped]) -> untyped
|
|
197
|
+
# @rbs return: coercer
|
|
198
|
+
def object: (Array[[ Skyward::Core::Types::Field, coercer ]] fields, Integer limit, String? expected) { (Hash[Symbol, untyped]) -> untyped } -> coercer
|
|
199
|
+
|
|
200
|
+
# @rbs coercers: Array[coercer]
|
|
201
|
+
# @rbs member: bool
|
|
202
|
+
# @rbs expected: String?
|
|
203
|
+
# @rbs return: coercer
|
|
204
|
+
def union: (Array[coercer] coercers, bool member, String? expected) -> coercer
|
|
205
|
+
|
|
206
|
+
# @rbs results: Array[result]
|
|
207
|
+
# @rbs return: Array[Error]
|
|
208
|
+
def errors: (Array[result] results) -> Array[Error]
|
|
209
|
+
|
|
210
|
+
# @rbs type: Skyward::Core::Types::t
|
|
211
|
+
# @rbs return: String
|
|
212
|
+
def expectation: (Skyward::Core::Types::t type) -> String
|
|
213
|
+
|
|
214
|
+
# @rbs text: String
|
|
215
|
+
# @rbs return: String
|
|
216
|
+
def cut: (String text) -> String
|
|
217
|
+
|
|
218
|
+
# @rbs expected: String?
|
|
219
|
+
# @rbs raw: untyped
|
|
220
|
+
# @rbs at: String
|
|
221
|
+
# @rbs return: Invalid
|
|
222
|
+
def mismatch: (String? expected, untyped raw, String at) -> Invalid
|
|
223
|
+
|
|
224
|
+
# @rbs type: Skyward::Core::Types::t
|
|
225
|
+
# @rbs return: String
|
|
226
|
+
def written: (Skyward::Core::Types::t type) -> String
|
|
227
|
+
|
|
228
|
+
# @rbs type: Skyward::Core::Types::t
|
|
229
|
+
# @rbs return: String
|
|
230
|
+
def nullable_written: (Skyward::Core::Types::t type) -> String
|
|
231
|
+
end
|
|
@@ -0,0 +1,75 @@
|
|
|
1
|
+
# Generated from lib/skyward/api/inputs.rb with RBS::Inline
|
|
2
|
+
|
|
3
|
+
class Skyward::API::Inputs
|
|
4
|
+
type refusal = :content_too_large | :unsupported_media_type
|
|
5
|
+
|
|
6
|
+
type body = Coercer::result | refusal | nil
|
|
7
|
+
|
|
8
|
+
JSON_TYPE: Regexp
|
|
9
|
+
|
|
10
|
+
MALFORMED_QUERY: Coercer::Invalid
|
|
11
|
+
|
|
12
|
+
INVALID_JSON: Coercer::Invalid
|
|
13
|
+
|
|
14
|
+
@max_body_size: Integer
|
|
15
|
+
|
|
16
|
+
@request: bool
|
|
17
|
+
|
|
18
|
+
@body: bool
|
|
19
|
+
|
|
20
|
+
@providers: Array[Skyward::API::Routing::Router::Provider]
|
|
21
|
+
|
|
22
|
+
@keywords: Array[[ Skyward::API::Routing::Router::Keyword, Coercer::t ]]
|
|
23
|
+
|
|
24
|
+
# @rbs keywords: Array[Skyward::API::Routing::Router::Keyword]
|
|
25
|
+
# @rbs providers: Array[Skyward::API::Routing::Router::Provider]
|
|
26
|
+
# @rbs max_body_size: Integer
|
|
27
|
+
# @rbs return: void
|
|
28
|
+
def initialize: (Array[Skyward::API::Routing::Router::Keyword] keywords, providers: Array[Skyward::API::Routing::Router::Provider], max_body_size: Integer) -> void
|
|
29
|
+
|
|
30
|
+
# Providers run first, so a caller they turn away learns nothing from the inputs' problems.
|
|
31
|
+
# @rbs env: Hash[String, untyped]
|
|
32
|
+
# @rbs params: Hash[Symbol, String]
|
|
33
|
+
# @rbs return: Coercer::result | refusal | Skyward::API::rack
|
|
34
|
+
def call: (Hash[String, untyped] env, Hash[Symbol, String] params) -> (Coercer::result | refusal | Skyward::API::rack)
|
|
35
|
+
|
|
36
|
+
private
|
|
37
|
+
|
|
38
|
+
# @rbs providers: Array[Skyward::API::Routing::Router::Provider]
|
|
39
|
+
# @rbs request: Skyward::API::Request
|
|
40
|
+
# @rbs values: Hash[Symbol, untyped]
|
|
41
|
+
# @rbs return: Hash[Symbol, untyped] | Skyward::API::rack
|
|
42
|
+
def provide: (Array[Skyward::API::Routing::Router::Provider] providers, Skyward::API::Request request, Hash[Symbol, untyped] values) -> (Hash[Symbol, untyped] | Skyward::API::rack)
|
|
43
|
+
|
|
44
|
+
# @rbs params: Hash[Symbol, String]
|
|
45
|
+
# @rbs query: Hash[String, String | Array[String]] | Coercer::Invalid
|
|
46
|
+
# @rbs body: Coercer::result?
|
|
47
|
+
# @rbs given: Hash[Symbol, untyped]
|
|
48
|
+
# @rbs return: Coercer::result
|
|
49
|
+
def arguments: (Hash[Symbol, String] params, Hash[String, String | Array[String]] | Coercer::Invalid query, Coercer::result? body, Hash[Symbol, untyped] given) -> Coercer::result
|
|
50
|
+
|
|
51
|
+
# @rbs keyword: Skyward::API::Routing::Router::Keyword
|
|
52
|
+
# @rbs coercer: Coercer::t
|
|
53
|
+
# @rbs params: Hash[Symbol, String]
|
|
54
|
+
# @rbs query: Hash[String, String | Array[String]] | Coercer::Invalid
|
|
55
|
+
# @rbs body: Coercer::result?
|
|
56
|
+
# @rbs return: [Symbol, Coercer::result]?
|
|
57
|
+
def argument: (Skyward::API::Routing::Router::Keyword keyword, Coercer::t coercer, Hash[Symbol, String] params, Hash[String, String | Array[String]] | Coercer::Invalid query, Coercer::result? body) -> [ Symbol, Coercer::result ]?
|
|
58
|
+
|
|
59
|
+
# @rbs query: Hash[String, String | Array[String]] | Coercer::Invalid
|
|
60
|
+
# @rbs key: String
|
|
61
|
+
# @rbs return: Coercer::result?
|
|
62
|
+
def from_query: (Hash[String, String | Array[String]] | Coercer::Invalid query, String key) -> Coercer::result?
|
|
63
|
+
|
|
64
|
+
# @rbs string: String
|
|
65
|
+
# @rbs return: Hash[String, String | Array[String]] | Coercer::Invalid
|
|
66
|
+
def query: (String string) -> (Hash[String, String | Array[String]] | Coercer::Invalid)
|
|
67
|
+
|
|
68
|
+
# @rbs env: Hash[String, untyped]
|
|
69
|
+
# @rbs return: body
|
|
70
|
+
def body: (Hash[String, untyped] env) -> body
|
|
71
|
+
|
|
72
|
+
# @rbs text: String
|
|
73
|
+
# @rbs return: Coercer::result
|
|
74
|
+
def parse: (String text) -> Coercer::result
|
|
75
|
+
end
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
# Generated from lib/skyward/api/middleware/line_logger.rb with RBS::Inline
|
|
2
|
+
|
|
3
|
+
class Skyward::API::Middleware::LineLogger
|
|
4
|
+
@io: IO
|
|
5
|
+
|
|
6
|
+
# @rbs io: IO
|
|
7
|
+
# @rbs return: void
|
|
8
|
+
def initialize: (IO io) -> void
|
|
9
|
+
|
|
10
|
+
# @rbs message: String
|
|
11
|
+
# @rbs return: void
|
|
12
|
+
def info: (String message) -> void
|
|
13
|
+
end
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# Generated from lib/skyward/api/middleware/request_id.rb with RBS::Inline
|
|
2
|
+
|
|
3
|
+
class Skyward::API::Middleware::RequestId
|
|
4
|
+
# Visible ASCII only, so a client can't put a space or a line break in the logs.
|
|
5
|
+
VALID: Regexp
|
|
6
|
+
|
|
7
|
+
@app: Skyward::API::_RackApp
|
|
8
|
+
|
|
9
|
+
@generate: ^() -> String
|
|
10
|
+
|
|
11
|
+
# @rbs (Skyward::API::_RackApp app, generate: ^() -> String) -> void
|
|
12
|
+
def initialize: (Skyward::API::_RackApp app, generate: ^() -> String) -> void
|
|
13
|
+
|
|
14
|
+
# @rbs env: Hash[String, untyped]
|
|
15
|
+
# @rbs return: Skyward::API::rack_response
|
|
16
|
+
def call: (Hash[String, untyped] env) -> Skyward::API::rack_response
|
|
17
|
+
end
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# Generated from lib/skyward/api/middleware/request_log.rb with RBS::Inline
|
|
2
|
+
|
|
3
|
+
class Skyward::API::Middleware::RequestLog
|
|
4
|
+
@app: Skyward::API::_RackApp
|
|
5
|
+
|
|
6
|
+
@logger: Skyward::API::_Logger
|
|
7
|
+
|
|
8
|
+
@now: ^() -> Time
|
|
9
|
+
|
|
10
|
+
@clock_ms: ^() -> Float
|
|
11
|
+
|
|
12
|
+
# @rbs (Skyward::API::_RackApp app, logger: Skyward::API::_Logger, now: ^() -> Time, clock_ms: ^() -> Float) -> void
|
|
13
|
+
def initialize: (Skyward::API::_RackApp app, logger: Skyward::API::_Logger, now: ^() -> Time, clock_ms: ^() -> Float) -> void
|
|
14
|
+
|
|
15
|
+
# @rbs env: Hash[String, untyped]
|
|
16
|
+
# @rbs return: Skyward::API::rack_response
|
|
17
|
+
def call: (Hash[String, untyped] env) -> Skyward::API::rack_response
|
|
18
|
+
end
|