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,126 @@
|
|
|
1
|
+
# Generated from lib/skyward/api/serializer/writers.rb with RBS::Inline
|
|
2
|
+
|
|
3
|
+
module Skyward::API::Serializer::Writers
|
|
4
|
+
class Writer < Data
|
|
5
|
+
attr_reader name(): String
|
|
6
|
+
|
|
7
|
+
attr_reader fits(): ^(untyped) -> bool
|
|
8
|
+
|
|
9
|
+
attr_reader write(): ^(untyped, String) -> untyped
|
|
10
|
+
|
|
11
|
+
def self.new: (String name, ^(untyped) -> bool fits, ^(untyped, String) -> untyped write) -> instance
|
|
12
|
+
| (name: String, fits: ^(untyped) -> bool, write: ^(untyped, String) -> untyped) -> instance
|
|
13
|
+
|
|
14
|
+
def self.members: () -> [ :name, :fits, :write ]
|
|
15
|
+
|
|
16
|
+
def members: () -> [ :name, :fits, :write ]
|
|
17
|
+
end
|
|
18
|
+
|
|
19
|
+
class Misfit < Data
|
|
20
|
+
attr_reader at(): String
|
|
21
|
+
|
|
22
|
+
attr_reader expected(): String
|
|
23
|
+
|
|
24
|
+
attr_reader got(): String
|
|
25
|
+
|
|
26
|
+
def self.new: (String at, String expected, String got) -> instance
|
|
27
|
+
| (at: String, expected: String, got: String) -> instance
|
|
28
|
+
|
|
29
|
+
def self.members: () -> [ :at, :expected, :got ]
|
|
30
|
+
|
|
31
|
+
def members: () -> [ :at, :expected, :got ]
|
|
32
|
+
end
|
|
33
|
+
|
|
34
|
+
# @rbs type: Skyward::Core::Types::t
|
|
35
|
+
# @rbs return: Writer
|
|
36
|
+
def writer: (Skyward::Core::Types::t type) -> Writer
|
|
37
|
+
|
|
38
|
+
# @rbs members: Array[Writer]
|
|
39
|
+
# @rbs return: Writer
|
|
40
|
+
def union: (Array[Writer] members) -> Writer
|
|
41
|
+
|
|
42
|
+
# @rbs name: String
|
|
43
|
+
# @rbs fits: ^(untyped) -> bool
|
|
44
|
+
# @rbs write: ^(untyped, String) -> untyped
|
|
45
|
+
# @rbs return: Writer
|
|
46
|
+
def checked: (String name, ^(untyped) -> bool fits, ^(untyped, String) -> untyped write) -> Writer
|
|
47
|
+
|
|
48
|
+
private
|
|
49
|
+
|
|
50
|
+
# @rbs fitting: Array[Writer]
|
|
51
|
+
# @rbs value: untyped
|
|
52
|
+
# @rbs at: String
|
|
53
|
+
# @rbs failed: Misfit?
|
|
54
|
+
# @rbs return: untyped
|
|
55
|
+
def first_written: (Array[Writer] fitting, untyped value, String at, ?Misfit? failed) -> untyped
|
|
56
|
+
|
|
57
|
+
# @rbs name: Skyward::Core::Types::scalar
|
|
58
|
+
# @rbs return: Writer
|
|
59
|
+
def scalar: (Skyward::Core::Types::scalar name) -> Writer
|
|
60
|
+
|
|
61
|
+
# @rbs value: Skyward::Core::Types::literal
|
|
62
|
+
# @rbs return: Writer
|
|
63
|
+
def literal: (Skyward::Core::Types::literal value) -> Writer
|
|
64
|
+
|
|
65
|
+
# @rbs symbols: Array[Symbol]
|
|
66
|
+
# @rbs return: Writer
|
|
67
|
+
def enum: (Array[Symbol] symbols) -> Writer
|
|
68
|
+
|
|
69
|
+
# @rbs type: Skyward::Core::Types::t
|
|
70
|
+
# @rbs return: Writer
|
|
71
|
+
def nullable: (Skyward::Core::Types::t type) -> Writer
|
|
72
|
+
|
|
73
|
+
# @rbs item: Writer
|
|
74
|
+
# @rbs return: Writer
|
|
75
|
+
def array: (Writer item) -> Writer
|
|
76
|
+
|
|
77
|
+
# @rbs value: Writer
|
|
78
|
+
# @rbs return: Writer
|
|
79
|
+
def hash_of: (Writer value) -> Writer
|
|
80
|
+
|
|
81
|
+
# @rbs fields: Array[Skyward::Core::Types::Field]
|
|
82
|
+
# @rbs return: Writer
|
|
83
|
+
def record: (Array[Skyward::Core::Types::Field] fields) -> Writer
|
|
84
|
+
|
|
85
|
+
# @rbs field: Skyward::Core::Types::Field
|
|
86
|
+
# @rbs writer: Writer
|
|
87
|
+
# @rbs hash: Hash[untyped, untyped]
|
|
88
|
+
# @rbs at: String
|
|
89
|
+
# @rbs return: [Symbol, untyped]?
|
|
90
|
+
def entry: (Skyward::Core::Types::Field field, Writer writer, Hash[untyped, untyped] hash, String at) -> [ Symbol, untyped ]?
|
|
91
|
+
|
|
92
|
+
# Only declared readers are called, never to_h, so nothing else the object holds is written.
|
|
93
|
+
# @rbs type: Skyward::Core::Types::Named
|
|
94
|
+
# @rbs return: Writer
|
|
95
|
+
def named: (Skyward::Core::Types::Named type) -> Writer
|
|
96
|
+
|
|
97
|
+
# strftime rather than iso8601, which writes a DateTime with its time.
|
|
98
|
+
# @rbs value: Date
|
|
99
|
+
# @rbs return: String
|
|
100
|
+
def date: (Date value) -> String
|
|
101
|
+
|
|
102
|
+
# Six fractional digits, so a time read back from JSON equals the one written.
|
|
103
|
+
# @rbs value: Time
|
|
104
|
+
# @rbs return: String
|
|
105
|
+
def time: (Time value) -> String
|
|
106
|
+
|
|
107
|
+
# @rbs value: untyped
|
|
108
|
+
# @rbs at: String
|
|
109
|
+
# @rbs return: untyped
|
|
110
|
+
def untyped: (untyped value, String at) -> untyped
|
|
111
|
+
|
|
112
|
+
# @rbs written: Array[untyped]
|
|
113
|
+
# @rbs return: untyped
|
|
114
|
+
def items: (Array[untyped] written) -> untyped
|
|
115
|
+
|
|
116
|
+
# @rbs pairs: Array[[untyped, untyped]]
|
|
117
|
+
# @rbs return: untyped
|
|
118
|
+
def object: (Array[[ untyped, untyped ]] pairs) -> untyped
|
|
119
|
+
|
|
120
|
+
# Names a value by its class unless it's a scalar, so a message never carries a String or an object's fields.
|
|
121
|
+
# @rbs expected: String
|
|
122
|
+
# @rbs value: untyped
|
|
123
|
+
# @rbs at: String
|
|
124
|
+
# @rbs return: Misfit
|
|
125
|
+
def misfit: (String expected, untyped value, String at) -> Misfit
|
|
126
|
+
end
|
|
@@ -0,0 +1,79 @@
|
|
|
1
|
+
# Generated from lib/skyward/api/serializer.rb with RBS::Inline
|
|
2
|
+
|
|
3
|
+
class Skyward::API::Serializer
|
|
4
|
+
JSON_TYPE: Hash[String, String]
|
|
5
|
+
|
|
6
|
+
class Problem < Data
|
|
7
|
+
attr_reader status(): Integer
|
|
8
|
+
|
|
9
|
+
attr_reader title(): String
|
|
10
|
+
|
|
11
|
+
def self.new: (Integer status, String title) -> instance
|
|
12
|
+
| (status: Integer, title: String) -> instance
|
|
13
|
+
|
|
14
|
+
def self.members: () -> [ :status, :title ]
|
|
15
|
+
|
|
16
|
+
def members: () -> [ :status, :title ]
|
|
17
|
+
end
|
|
18
|
+
|
|
19
|
+
PROBLEMS: Hash[Class, Problem]
|
|
20
|
+
|
|
21
|
+
# Every response value but Skyward::API::Responses::Created, which carries a type of its own.
|
|
22
|
+
RESPONSES: Array[Class]
|
|
23
|
+
|
|
24
|
+
UNTYPED: Skyward::Core::Types::Scalar
|
|
25
|
+
|
|
26
|
+
@writer: Writers::Writer
|
|
27
|
+
|
|
28
|
+
@label: String
|
|
29
|
+
|
|
30
|
+
# @rbs returns: Array[Skyward::API::Routing::Router::returned]
|
|
31
|
+
# @rbs label: String
|
|
32
|
+
# @rbs return: void
|
|
33
|
+
def initialize: (Array[Skyward::API::Routing::Router::returned] returns, label: String) -> void
|
|
34
|
+
|
|
35
|
+
# The whole body is written before anything is answered, so a value that doesn't fit sends none of it.
|
|
36
|
+
# @rbs value: untyped
|
|
37
|
+
# @rbs return: Skyward::API::rack
|
|
38
|
+
def call: (untyped value) -> Skyward::API::rack
|
|
39
|
+
|
|
40
|
+
private
|
|
41
|
+
|
|
42
|
+
# @rbs member: Skyward::API::Routing::Router::returned
|
|
43
|
+
# @rbs return: Writers::Writer
|
|
44
|
+
def compile: (Skyward::API::Routing::Router::returned member) -> Writers::Writer
|
|
45
|
+
|
|
46
|
+
# Untyped code can return any response value.
|
|
47
|
+
# @rbs return: Writers::Writer
|
|
48
|
+
def untyped: () -> Writers::Writer
|
|
49
|
+
|
|
50
|
+
# @rbs writer: Writers::Writer
|
|
51
|
+
# @rbs return: Writers::Writer
|
|
52
|
+
def ok: (Writers::Writer writer) -> Writers::Writer
|
|
53
|
+
|
|
54
|
+
# @rbs writer: Writers::Writer
|
|
55
|
+
# @rbs return: Writers::Writer
|
|
56
|
+
def created: (Writers::Writer writer) -> Writers::Writer
|
|
57
|
+
|
|
58
|
+
# @rbs klass: Class
|
|
59
|
+
# @rbs return: Writers::Writer
|
|
60
|
+
def response: (Class klass) -> Writers::Writer
|
|
61
|
+
|
|
62
|
+
# @rbs return: Writers::Writer
|
|
63
|
+
def rack: () -> Writers::Writer
|
|
64
|
+
|
|
65
|
+
# @rbs problem: Problem
|
|
66
|
+
# @rbs given: untyped
|
|
67
|
+
# @rbs return: Skyward::API::Assembly::Dispatcher::response
|
|
68
|
+
def problem_response: (Problem problem, untyped given) -> Skyward::API::Assembly::Dispatcher::response
|
|
69
|
+
|
|
70
|
+
# @rbs written: untyped
|
|
71
|
+
# @rbs status: Integer
|
|
72
|
+
# @rbs headers: Hash[String, String]
|
|
73
|
+
# @rbs return: untyped
|
|
74
|
+
def json: (untyped written, Integer status, Hash[String, String] headers) -> untyped
|
|
75
|
+
|
|
76
|
+
# @rbs misfit: Writers::Misfit
|
|
77
|
+
# @rbs return: String
|
|
78
|
+
def message: (Writers::Misfit misfit) -> String
|
|
79
|
+
end
|
|
@@ -0,0 +1,117 @@
|
|
|
1
|
+
# Generated from lib/skyward/api/test/client.rb with RBS::Inline
|
|
2
|
+
|
|
3
|
+
class Skyward::API::Test::Client
|
|
4
|
+
class Response < Data
|
|
5
|
+
attr_reader status(): Integer
|
|
6
|
+
|
|
7
|
+
attr_reader headers(): Hash[String, String | Array[String]]
|
|
8
|
+
|
|
9
|
+
attr_reader body(): String
|
|
10
|
+
|
|
11
|
+
attr_reader json(): untyped
|
|
12
|
+
|
|
13
|
+
def self.new: (Integer status, Hash[String, String | Array[String]] headers, String body, untyped json) -> instance
|
|
14
|
+
| (status: Integer, headers: Hash[String, String | Array[String]], body: String, json: untyped) -> instance
|
|
15
|
+
|
|
16
|
+
def self.members: () -> [ :status, :headers, :body, :json ]
|
|
17
|
+
|
|
18
|
+
def members: () -> [ :status, :headers, :body, :json ]
|
|
19
|
+
end
|
|
20
|
+
|
|
21
|
+
JSON_TYPE: Regexp
|
|
22
|
+
|
|
23
|
+
# Rack takes these two headers without the HTTP_ prefix the others get.
|
|
24
|
+
UNPREFIXED: Array[String]
|
|
25
|
+
|
|
26
|
+
@app: Skyward::API::_RackApp
|
|
27
|
+
|
|
28
|
+
# @rbs (Skyward::API::_RackApp app) -> void
|
|
29
|
+
def initialize: (Skyward::API::_RackApp app) -> void
|
|
30
|
+
|
|
31
|
+
# @rbs path: String
|
|
32
|
+
# @rbs json: untyped
|
|
33
|
+
# @rbs headers: Hash[String, String]
|
|
34
|
+
# @rbs cookies: Hash[String, String]
|
|
35
|
+
# @rbs return: Response
|
|
36
|
+
def get: (String path, ?json: untyped, ?headers: Hash[String, String], ?cookies: Hash[String, String]) -> Response
|
|
37
|
+
|
|
38
|
+
# @rbs path: String
|
|
39
|
+
# @rbs json: untyped
|
|
40
|
+
# @rbs headers: Hash[String, String]
|
|
41
|
+
# @rbs cookies: Hash[String, String]
|
|
42
|
+
# @rbs return: Response
|
|
43
|
+
def post: (String path, ?json: untyped, ?headers: Hash[String, String], ?cookies: Hash[String, String]) -> Response
|
|
44
|
+
|
|
45
|
+
# @rbs path: String
|
|
46
|
+
# @rbs json: untyped
|
|
47
|
+
# @rbs headers: Hash[String, String]
|
|
48
|
+
# @rbs cookies: Hash[String, String]
|
|
49
|
+
# @rbs return: Response
|
|
50
|
+
def put: (String path, ?json: untyped, ?headers: Hash[String, String], ?cookies: Hash[String, String]) -> Response
|
|
51
|
+
|
|
52
|
+
# @rbs path: String
|
|
53
|
+
# @rbs json: untyped
|
|
54
|
+
# @rbs headers: Hash[String, String]
|
|
55
|
+
# @rbs cookies: Hash[String, String]
|
|
56
|
+
# @rbs return: Response
|
|
57
|
+
def patch: (String path, ?json: untyped, ?headers: Hash[String, String], ?cookies: Hash[String, String]) -> Response
|
|
58
|
+
|
|
59
|
+
# @rbs path: String
|
|
60
|
+
# @rbs json: untyped
|
|
61
|
+
# @rbs headers: Hash[String, String]
|
|
62
|
+
# @rbs cookies: Hash[String, String]
|
|
63
|
+
# @rbs return: Response
|
|
64
|
+
def delete: (String path, ?json: untyped, ?headers: Hash[String, String], ?cookies: Hash[String, String]) -> Response
|
|
65
|
+
|
|
66
|
+
# @rbs path: String
|
|
67
|
+
# @rbs json: untyped
|
|
68
|
+
# @rbs headers: Hash[String, String]
|
|
69
|
+
# @rbs cookies: Hash[String, String]
|
|
70
|
+
# @rbs return: Response
|
|
71
|
+
def head: (String path, ?json: untyped, ?headers: Hash[String, String], ?cookies: Hash[String, String]) -> Response
|
|
72
|
+
|
|
73
|
+
# @rbs path: String
|
|
74
|
+
# @rbs json: untyped
|
|
75
|
+
# @rbs headers: Hash[String, String]
|
|
76
|
+
# @rbs cookies: Hash[String, String]
|
|
77
|
+
# @rbs return: Response
|
|
78
|
+
def options: (String path, ?json: untyped, ?headers: Hash[String, String], ?cookies: Hash[String, String]) -> Response
|
|
79
|
+
|
|
80
|
+
private
|
|
81
|
+
|
|
82
|
+
# @rbs method: String
|
|
83
|
+
# @rbs path: String
|
|
84
|
+
# @rbs json: untyped
|
|
85
|
+
# @rbs headers: Hash[String, String]
|
|
86
|
+
# @rbs cookies: Hash[String, String]
|
|
87
|
+
# @rbs return: Response
|
|
88
|
+
def request: (String method, String path, untyped json, Hash[String, String] headers, Hash[String, String] cookies) -> Response
|
|
89
|
+
|
|
90
|
+
# @rbs body: String
|
|
91
|
+
# @rbs return: Hash[String, String]
|
|
92
|
+
def body_headers: (String body) -> Hash[String, String]
|
|
93
|
+
|
|
94
|
+
# @rbs cookies: Hash[String, String]
|
|
95
|
+
# @rbs return: Hash[String, String]
|
|
96
|
+
def cookie_header: (Hash[String, String] cookies) -> Hash[String, String]
|
|
97
|
+
|
|
98
|
+
# @rbs method: String
|
|
99
|
+
# @rbs path: String
|
|
100
|
+
# @rbs body: String
|
|
101
|
+
# @rbs headers: Hash[String, String]
|
|
102
|
+
# @rbs return: Hash[String, untyped]
|
|
103
|
+
def env: (String method, String path, String body, Hash[String, String] headers) -> Hash[String, untyped]
|
|
104
|
+
|
|
105
|
+
# @rbs name: String
|
|
106
|
+
# @rbs return: String
|
|
107
|
+
def env_key: (String name) -> String
|
|
108
|
+
|
|
109
|
+
# @rbs body: untyped
|
|
110
|
+
# @rbs return: String
|
|
111
|
+
def read: (untyped body) -> String
|
|
112
|
+
|
|
113
|
+
# @rbs content_type: untyped
|
|
114
|
+
# @rbs body: String
|
|
115
|
+
# @rbs return: untyped
|
|
116
|
+
def parse: (untyped content_type, String body) -> untyped
|
|
117
|
+
end
|
|
@@ -1,2 +1,40 @@
|
|
|
1
1
|
# Generated from lib/skyward/api.rb with RBS::Inline
|
|
2
2
|
|
|
3
|
+
class Skyward::API
|
|
4
|
+
type rack_response = [ Integer, Hash[String, untyped], untyped ]
|
|
5
|
+
|
|
6
|
+
type rack = [ Integer, Hash[String, String], untyped ]
|
|
7
|
+
|
|
8
|
+
extend Endpoints::Declarations
|
|
9
|
+
|
|
10
|
+
include Endpoints::Helpers
|
|
11
|
+
end
|
|
12
|
+
|
|
13
|
+
module Skyward
|
|
14
|
+
# @rbs (?signatures: String, ?strict: bool, ?docs: bool, ?title: String, ?version: String, ?description: String?,
|
|
15
|
+
# ?schema_names: Hash[Class, String], ?scalar_url: String, ?logger: API::_Logger?, ?on_error: API::_OnError?,
|
|
16
|
+
# ?max_body_size: Integer) { (API::Assembly::Builder) -> void } -> API::Assembly::Application
|
|
17
|
+
def self.app: (?signatures: String, ?strict: bool, ?docs: bool, ?title: String, ?version: String, ?description: String?, ?schema_names: Hash[Class, String], ?scalar_url: String, ?logger: API::_Logger?, ?on_error: API::_OnError?, ?max_body_size: Integer) { (API::Assembly::Builder) -> void } -> API::Assembly::Application
|
|
18
|
+
|
|
19
|
+
# These response helpers are public here, for code outside an API class, such as a provider.
|
|
20
|
+
# @rbs detail: String
|
|
21
|
+
# @rbs headers: Hash[String, String]
|
|
22
|
+
# @rbs return: API::Responses::BadRequest
|
|
23
|
+
def self.bad_request: (String detail, ?headers: Hash[String, String]) -> API::Responses::BadRequest
|
|
24
|
+
|
|
25
|
+
# @rbs detail: String
|
|
26
|
+
# @rbs headers: Hash[String, String]
|
|
27
|
+
# @rbs return: API::Responses::Unauthorized
|
|
28
|
+
def self.unauthorized: (String detail, ?headers: Hash[String, String]) -> API::Responses::Unauthorized
|
|
29
|
+
|
|
30
|
+
# @rbs detail: String
|
|
31
|
+
# @rbs headers: Hash[String, String]
|
|
32
|
+
# @rbs return: API::Responses::Forbidden
|
|
33
|
+
def self.forbidden: (String detail, ?headers: Hash[String, String]) -> API::Responses::Forbidden
|
|
34
|
+
|
|
35
|
+
# @rbs to: String
|
|
36
|
+
# @rbs status: Integer
|
|
37
|
+
# @rbs headers: Hash[String, String]
|
|
38
|
+
# @rbs return: API::Responses::Redirect
|
|
39
|
+
def self.redirect: (String to, ?status: Integer, ?headers: Hash[String, String]) -> API::Responses::Redirect
|
|
40
|
+
end
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
class Skyward::API
|
|
2
|
+
interface _RackApp
|
|
3
|
+
def call: (Hash[String, untyped] env) -> rack_response
|
|
4
|
+
end
|
|
5
|
+
|
|
6
|
+
interface _Middleware
|
|
7
|
+
def new: (_RackApp app, *untyped, **untyped) ?{ (?) -> untyped } -> _RackApp
|
|
8
|
+
end
|
|
9
|
+
|
|
10
|
+
interface _Logger
|
|
11
|
+
def info: (String message) -> void
|
|
12
|
+
end
|
|
13
|
+
|
|
14
|
+
interface _Provider
|
|
15
|
+
def call: (Skyward::API::Request request) -> untyped
|
|
16
|
+
end
|
|
17
|
+
|
|
18
|
+
interface _OnError
|
|
19
|
+
def call: (StandardError exception, Hash[String, untyped] env) -> void
|
|
20
|
+
end
|
|
21
|
+
end
|
metadata
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: skyward-api
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.
|
|
4
|
+
version: 0.2.0
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Jake Bottrall
|
|
@@ -15,14 +15,14 @@ dependencies:
|
|
|
15
15
|
requirements:
|
|
16
16
|
- - '='
|
|
17
17
|
- !ruby/object:Gem::Version
|
|
18
|
-
version: 0.
|
|
18
|
+
version: 0.2.0
|
|
19
19
|
type: :runtime
|
|
20
20
|
prerelease: false
|
|
21
21
|
version_requirements: !ruby/object:Gem::Requirement
|
|
22
22
|
requirements:
|
|
23
23
|
- - '='
|
|
24
24
|
- !ruby/object:Gem::Version
|
|
25
|
-
version: 0.
|
|
25
|
+
version: 0.2.0
|
|
26
26
|
- !ruby/object:Gem::Dependency
|
|
27
27
|
name: zeitwerk
|
|
28
28
|
requirement: !ruby/object:Gem::Requirement
|
|
@@ -45,9 +45,116 @@ extra_rdoc_files: []
|
|
|
45
45
|
files:
|
|
46
46
|
- README.md
|
|
47
47
|
- lib/skyward/api.rb
|
|
48
|
+
- lib/skyward/api/assembly.rb
|
|
49
|
+
- lib/skyward/api/assembly/application.rb
|
|
50
|
+
- lib/skyward/api/assembly/boot.rb
|
|
51
|
+
- lib/skyward/api/assembly/builder.rb
|
|
52
|
+
- lib/skyward/api/assembly/dispatcher.rb
|
|
53
|
+
- lib/skyward/api/assembly/static.rb
|
|
54
|
+
- lib/skyward/api/cli.rb
|
|
55
|
+
- lib/skyward/api/cli/app_file.rb
|
|
56
|
+
- lib/skyward/api/cli/check.rb
|
|
57
|
+
- lib/skyward/api/cli/executable.rb
|
|
58
|
+
- lib/skyward/api/cli/routes.rb
|
|
59
|
+
- lib/skyward/api/cli/serve.rb
|
|
60
|
+
- lib/skyward/api/cli/serve.ru
|
|
61
|
+
- lib/skyward/api/cli/serve/reloader.rb
|
|
62
|
+
- lib/skyward/api/commands.rb
|
|
63
|
+
- lib/skyward/api/endpoints.rb
|
|
64
|
+
- lib/skyward/api/endpoints/declarations.rb
|
|
65
|
+
- lib/skyward/api/endpoints/helpers.rb
|
|
66
|
+
- lib/skyward/api/endpoints/route.rb
|
|
67
|
+
- lib/skyward/api/inputs.rb
|
|
68
|
+
- lib/skyward/api/inputs/coercer.rb
|
|
69
|
+
- lib/skyward/api/middleware.rb
|
|
70
|
+
- lib/skyward/api/middleware/line_logger.rb
|
|
71
|
+
- lib/skyward/api/middleware/request_id.rb
|
|
72
|
+
- lib/skyward/api/middleware/request_log.rb
|
|
73
|
+
- lib/skyward/api/middleware/rescue.rb
|
|
74
|
+
- lib/skyward/api/openapi.rb
|
|
75
|
+
- lib/skyward/api/openapi/docs.rb
|
|
76
|
+
- lib/skyward/api/request.rb
|
|
77
|
+
- lib/skyward/api/responses.rb
|
|
78
|
+
- lib/skyward/api/responses/bad_request.rb
|
|
79
|
+
- lib/skyward/api/responses/conflict.rb
|
|
80
|
+
- lib/skyward/api/responses/created.rb
|
|
81
|
+
- lib/skyward/api/responses/forbidden.rb
|
|
82
|
+
- lib/skyward/api/responses/no_content.rb
|
|
83
|
+
- lib/skyward/api/responses/not_found.rb
|
|
84
|
+
- lib/skyward/api/responses/redirect.rb
|
|
85
|
+
- lib/skyward/api/responses/unauthorized.rb
|
|
86
|
+
- lib/skyward/api/responses/unprocessable.rb
|
|
87
|
+
- lib/skyward/api/return_type_error.rb
|
|
88
|
+
- lib/skyward/api/routing.rb
|
|
89
|
+
- lib/skyward/api/routing/percent_encoding.rb
|
|
90
|
+
- lib/skyward/api/routing/router.rb
|
|
91
|
+
- lib/skyward/api/serializer.rb
|
|
92
|
+
- lib/skyward/api/serializer/writers.rb
|
|
93
|
+
- lib/skyward/api/test.rb
|
|
94
|
+
- lib/skyward/api/test/client.rb
|
|
48
95
|
- lib/skyward/api/version.rb
|
|
49
96
|
- sig/generated/skyward/api.rbs
|
|
97
|
+
- sig/generated/skyward/api/assembly.rbs
|
|
98
|
+
- sig/generated/skyward/api/assembly/application.rbs
|
|
99
|
+
- sig/generated/skyward/api/assembly/boot.rbs
|
|
100
|
+
- sig/generated/skyward/api/assembly/builder.rbs
|
|
101
|
+
- sig/generated/skyward/api/assembly/dispatcher.rbs
|
|
102
|
+
- sig/generated/skyward/api/assembly/static.rbs
|
|
103
|
+
- sig/generated/skyward/api/cli.rbs
|
|
104
|
+
- sig/generated/skyward/api/cli/app_file.rbs
|
|
105
|
+
- sig/generated/skyward/api/cli/check.rbs
|
|
106
|
+
- sig/generated/skyward/api/cli/executable.rbs
|
|
107
|
+
- sig/generated/skyward/api/cli/routes.rbs
|
|
108
|
+
- sig/generated/skyward/api/cli/serve.rbs
|
|
109
|
+
- sig/generated/skyward/api/cli/serve/reloader.rbs
|
|
110
|
+
- sig/generated/skyward/api/commands.rbs
|
|
111
|
+
- sig/generated/skyward/api/endpoints.rbs
|
|
112
|
+
- sig/generated/skyward/api/endpoints/declarations.rbs
|
|
113
|
+
- sig/generated/skyward/api/endpoints/helpers.rbs
|
|
114
|
+
- sig/generated/skyward/api/endpoints/route.rbs
|
|
115
|
+
- sig/generated/skyward/api/inputs.rbs
|
|
116
|
+
- sig/generated/skyward/api/inputs/coercer.rbs
|
|
117
|
+
- sig/generated/skyward/api/middleware.rbs
|
|
118
|
+
- sig/generated/skyward/api/middleware/line_logger.rbs
|
|
119
|
+
- sig/generated/skyward/api/middleware/request_id.rbs
|
|
120
|
+
- sig/generated/skyward/api/middleware/request_log.rbs
|
|
121
|
+
- sig/generated/skyward/api/middleware/rescue.rbs
|
|
122
|
+
- sig/generated/skyward/api/openapi.rbs
|
|
123
|
+
- sig/generated/skyward/api/openapi/docs.rbs
|
|
124
|
+
- sig/generated/skyward/api/request.rbs
|
|
125
|
+
- sig/generated/skyward/api/responses.rbs
|
|
126
|
+
- sig/generated/skyward/api/responses/bad_request.rbs
|
|
127
|
+
- sig/generated/skyward/api/responses/conflict.rbs
|
|
128
|
+
- sig/generated/skyward/api/responses/created.rbs
|
|
129
|
+
- sig/generated/skyward/api/responses/forbidden.rbs
|
|
130
|
+
- sig/generated/skyward/api/responses/no_content.rbs
|
|
131
|
+
- sig/generated/skyward/api/responses/not_found.rbs
|
|
132
|
+
- sig/generated/skyward/api/responses/redirect.rbs
|
|
133
|
+
- sig/generated/skyward/api/responses/unauthorized.rbs
|
|
134
|
+
- sig/generated/skyward/api/responses/unprocessable.rbs
|
|
135
|
+
- sig/generated/skyward/api/return_type_error.rbs
|
|
136
|
+
- sig/generated/skyward/api/routing.rbs
|
|
137
|
+
- sig/generated/skyward/api/routing/percent_encoding.rbs
|
|
138
|
+
- sig/generated/skyward/api/routing/router.rbs
|
|
139
|
+
- sig/generated/skyward/api/serializer.rbs
|
|
140
|
+
- sig/generated/skyward/api/serializer/writers.rbs
|
|
141
|
+
- sig/generated/skyward/api/test.rbs
|
|
142
|
+
- sig/generated/skyward/api/test/client.rbs
|
|
50
143
|
- sig/generated/skyward/api/version.rbs
|
|
144
|
+
- sig/manual/skyward/api.rbs
|
|
145
|
+
- sig/manual/skyward/api/assembly/boot.rbs
|
|
146
|
+
- sig/manual/skyward/api/cli/app_file.rbs
|
|
147
|
+
- sig/manual/skyward/api/cli/check.rbs
|
|
148
|
+
- sig/manual/skyward/api/cli/executable.rbs
|
|
149
|
+
- sig/manual/skyward/api/cli/routes.rbs
|
|
150
|
+
- sig/manual/skyward/api/cli/serve.rbs
|
|
151
|
+
- sig/manual/skyward/api/inputs/coercer.rbs
|
|
152
|
+
- sig/manual/skyward/api/openapi.rbs
|
|
153
|
+
- sig/manual/skyward/api/openapi/docs.rbs
|
|
154
|
+
- sig/manual/skyward/api/routing/percent_encoding.rbs
|
|
155
|
+
- sig/manual/skyward/api/serializer/writers.rbs
|
|
156
|
+
- sig/manual/skyward/api/test.rbs
|
|
157
|
+
- sig/manual/zeitwerk/loader.rbs
|
|
51
158
|
homepage: https://github.com/bottrall/skyward
|
|
52
159
|
licenses:
|
|
53
160
|
- MIT
|