speakeasy_rubygems_tp_sample 0.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (33) hide show
  1. checksums.yaml +7 -0
  2. data/lib/crystalline/enum.rbi +17 -0
  3. data/lib/crystalline/metadata_fields.rb +265 -0
  4. data/lib/crystalline/module.rb +188 -0
  5. data/lib/crystalline/types.rb +170 -0
  6. data/lib/crystalline/utils.rb +69 -0
  7. data/lib/crystalline.rb +13 -0
  8. data/lib/open_api_sdk/models/callbacks.rb +12 -0
  9. data/lib/open_api_sdk/models/components/pet.rb +34 -0
  10. data/lib/open_api_sdk/models/components/pet.rbi +20 -0
  11. data/lib/open_api_sdk/models/components.rb +12 -0
  12. data/lib/open_api_sdk/models/errors/apierror.rb +39 -0
  13. data/lib/open_api_sdk/models/errors/apierror.rbi +27 -0
  14. data/lib/open_api_sdk/models/errors.rb +12 -0
  15. data/lib/open_api_sdk/models/operations/listpets_response.rb +51 -0
  16. data/lib/open_api_sdk/models/operations/listpets_response.rbi +32 -0
  17. data/lib/open_api_sdk/models/operations.rb +12 -0
  18. data/lib/open_api_sdk/petstore.rb +223 -0
  19. data/lib/open_api_sdk/sdk_hooks/hooks.rb +99 -0
  20. data/lib/open_api_sdk/sdk_hooks/registration.rb +34 -0
  21. data/lib/open_api_sdk/sdk_hooks/types.rb +180 -0
  22. data/lib/open_api_sdk/sdkconfiguration.rb +97 -0
  23. data/lib/open_api_sdk/sdkconfiguration.rbi +77 -0
  24. data/lib/open_api_sdk/utils/forms.rb +232 -0
  25. data/lib/open_api_sdk/utils/headers.rb +84 -0
  26. data/lib/open_api_sdk/utils/query_params.rb +167 -0
  27. data/lib/open_api_sdk/utils/request_bodies.rb +79 -0
  28. data/lib/open_api_sdk/utils/retries.rb +139 -0
  29. data/lib/open_api_sdk/utils/security.rb +158 -0
  30. data/lib/open_api_sdk/utils/url.rb +124 -0
  31. data/lib/open_api_sdk/utils/utils.rb +245 -0
  32. data/lib/speakeasy_rubygems_tp_sample.rb +25 -0
  33. metadata +290 -0
@@ -0,0 +1,180 @@
1
+ # Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
2
+
3
+ # typed: true
4
+ # frozen_string_literal: true
5
+
6
+ require_relative "../sdkconfiguration"
7
+
8
+ module OpenApiSDK
9
+ module SDKHooks
10
+ class HookContext
11
+ extend T::Sig
12
+
13
+ sig { returns(SDKConfiguration) }
14
+ attr_accessor :config
15
+
16
+ sig { returns(::String) }
17
+ attr_accessor :base_url
18
+
19
+ sig { returns(T.nilable(T::Array[::String])) }
20
+ attr_accessor :oauth2_scopes
21
+
22
+ sig { returns(::String) }
23
+ attr_accessor :operation_id
24
+
25
+ sig { returns(T.nilable(T.proc.returns(T.untyped))) }
26
+ attr_accessor :security_source
27
+
28
+ sig do
29
+ params(
30
+ config: SDKConfiguration,
31
+ base_url: ::String,
32
+ oauth2_scopes: T.nilable(T::Array[::String]),
33
+ operation_id: ::String,
34
+ security_source: T.nilable(T.proc.returns(T.untyped))
35
+ )
36
+ .void
37
+ end
38
+ def initialize(config:, base_url:, oauth2_scopes:, operation_id:, security_source:)
39
+ @config = T.let(config, SDKConfiguration)
40
+ @base_url = T.let(base_url, ::String)
41
+ @oauth2_scopes = T.let(oauth2_scopes, T.nilable(T::Array[::String]))
42
+ @operation_id = T.let(operation_id, ::String)
43
+ @security_source = T.let(security_source, T.nilable(T.proc.returns(T.untyped)))
44
+ end
45
+ end
46
+
47
+ class BeforeRequestHookContext < HookContext
48
+ extend T::Sig
49
+
50
+ sig do
51
+ params(
52
+ hook_ctx: HookContext
53
+ )
54
+ .void
55
+ end
56
+ def initialize(hook_ctx:)
57
+ super(
58
+ config: hook_ctx.config,
59
+ base_url: hook_ctx.base_url,
60
+ operation_id: hook_ctx.operation_id,
61
+ oauth2_scopes: hook_ctx.oauth2_scopes,
62
+ security_source: hook_ctx.security_source
63
+ )
64
+ end
65
+ end
66
+
67
+ class AfterSuccessHookContext < HookContext
68
+ extend T::Sig
69
+
70
+ sig do
71
+ params(
72
+ hook_ctx: HookContext
73
+ )
74
+ .void
75
+ end
76
+ def initialize(hook_ctx:)
77
+ super(
78
+ config: hook_ctx.config,
79
+ base_url: hook_ctx.base_url,
80
+ operation_id: hook_ctx.operation_id,
81
+ oauth2_scopes: hook_ctx.oauth2_scopes,
82
+ security_source: hook_ctx.security_source
83
+ )
84
+ end
85
+ end
86
+
87
+ class AfterErrorHookContext < HookContext
88
+ extend T::Sig
89
+
90
+ sig do
91
+ params(
92
+ hook_ctx: HookContext
93
+ )
94
+ .void
95
+ end
96
+ def initialize(hook_ctx:)
97
+ super(
98
+ config: hook_ctx.config,
99
+ base_url: hook_ctx.base_url,
100
+ operation_id: hook_ctx.operation_id,
101
+ oauth2_scopes: hook_ctx.oauth2_scopes,
102
+ security_source: hook_ctx.security_source
103
+ )
104
+ end
105
+ end
106
+
107
+ module AbstractSDKInitHook
108
+ extend T::Sig
109
+ extend T::Helpers
110
+ abstract!
111
+
112
+ sig { overridable.params(config: SDKConfiguration).returns(SDKConfiguration) }
113
+ def sdk_init(config:)
114
+ ::Kernel.raise ::NotImplementedError.new
115
+ end
116
+ end
117
+
118
+ module AbstractBeforeRequestHook
119
+ extend T::Sig
120
+ extend T::Helpers
121
+ abstract!
122
+
123
+ sig do
124
+ overridable
125
+ .params(
126
+ hook_ctx: BeforeRequestHookContext,
127
+ request: Faraday::Request
128
+ )
129
+ .returns(Faraday::Request)
130
+ end
131
+ def before_request(hook_ctx:, request:)
132
+ ::Kernel.raise ::NotImplementedError.new
133
+ end
134
+ end
135
+
136
+ module AbstractAfterSuccessHook
137
+ extend T::Sig
138
+ extend T::Helpers
139
+ abstract!
140
+
141
+ sig do
142
+ overridable
143
+ .params(
144
+ hook_ctx: AfterSuccessHookContext,
145
+ response: Faraday::Response
146
+ )
147
+ .returns(Faraday::Response)
148
+ end
149
+ def after_success(hook_ctx:, response:)
150
+ ::Kernel.raise ::NotImplementedError.new
151
+ end
152
+ end
153
+
154
+ module AbstractAfterErrorHook
155
+ extend T::Sig
156
+ extend T::Helpers
157
+ abstract!
158
+
159
+ sig do
160
+ overridable
161
+ .params(
162
+ error: T.nilable(::StandardError),
163
+ hook_ctx: AfterErrorHookContext,
164
+ response: T.nilable(Faraday::Response)
165
+ )
166
+ .returns(T.nilable(Faraday::Response))
167
+ end
168
+ def after_error(error:, hook_ctx:, response:)
169
+ ::Kernel.raise ::NotImplementedError.new
170
+ end
171
+ end
172
+
173
+ class AbstractSDKHook
174
+ include AbstractSDKInitHook
175
+ include AbstractBeforeRequestHook
176
+ include AbstractAfterSuccessHook
177
+ include AbstractAfterErrorHook
178
+ end
179
+ end
180
+ end
@@ -0,0 +1,97 @@
1
+ # Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
2
+
3
+ # typed: true
4
+ # frozen_string_literal: true
5
+
6
+ require "faraday"
7
+ require "faraday/multipart"
8
+ require "faraday/retry"
9
+ require "sorbet-runtime"
10
+
11
+ require_relative "sdk_hooks/hooks"
12
+ require_relative "utils/retries"
13
+
14
+ module OpenApiSDK
15
+ extend T::Sig
16
+
17
+ SERVERS = T.let(
18
+ [
19
+ "https://api.example.com"
20
+ ].freeze,
21
+ T::Array[::String]
22
+ )
23
+ # Contains the list of servers available to the SDK
24
+
25
+ class SDKConfiguration
26
+ extend T::Sig
27
+
28
+ sig { returns(T.nilable(Faraday::Connection)) }
29
+ attr_accessor :client
30
+
31
+ sig { returns(::OpenApiSDK::SDKHooks::Hooks) }
32
+ attr_accessor :hooks
33
+
34
+ sig { returns(T.nilable(::OpenApiSDK::Utils::RetryConfig)) }
35
+ attr_accessor :retry_config
36
+
37
+ sig { returns(T.nilable(::Float)) }
38
+ attr_accessor :timeout
39
+
40
+ sig { returns(T.nilable(::String)) }
41
+ attr_accessor :server_url
42
+
43
+ sig { returns(T.nilable(::Integer)) }
44
+ attr_accessor :server_idx
45
+
46
+ sig { returns(::String) }
47
+ attr_accessor :language
48
+
49
+ sig { returns(::String) }
50
+ attr_accessor :openapi_doc_version
51
+
52
+ sig { returns(::String) }
53
+ attr_accessor :sdk_version
54
+
55
+ sig { returns(::String) }
56
+ attr_accessor :gen_version
57
+
58
+ sig { returns(::String) }
59
+ attr_accessor :user_agent
60
+
61
+ sig do
62
+ params(
63
+ client: T.nilable(Faraday::Connection),
64
+ hooks: ::OpenApiSDK::SDKHooks::Hooks,
65
+ retry_config: T.nilable(::OpenApiSDK::Utils::RetryConfig),
66
+ timeout_ms: T.nilable(::Integer),
67
+ server_url: T.nilable(::String),
68
+ server_idx: T.nilable(::Integer)
69
+ )
70
+ .void
71
+ end
72
+ def initialize(client, hooks, retry_config, timeout_ms, server_url, server_idx)
73
+ @client = client
74
+ @hooks = hooks
75
+ @retry_config = retry_config
76
+ @server_url = server_url
77
+ @timeout = (timeout_ms.to_f / 1000) unless timeout_ms.nil?
78
+ @server_idx = server_idx.nil? ? 0 : server_idx
79
+ if @server_idx.negative? || @server_idx >= SERVERS.length
80
+ raise ::StandardError, "Invalid server index #{server_idx}"
81
+ end
82
+
83
+ @language = "ruby"
84
+ @openapi_doc_version = "0.1.0"
85
+ @sdk_version = "0.0.1"
86
+ @gen_version = "2.961.1"
87
+ @user_agent = "speakeasy-sdk/ruby 0.0.1 2.961.1 0.1.0 speakeasy_rubygems_tp_sample"
88
+ end
89
+
90
+ sig { returns([::String, T::Hash[::Symbol, ::String]]) }
91
+ def get_server_details
92
+ return [@server_url.delete_suffix("/"), {}] if !@server_url.nil?
93
+ @server_idx = T.must(@server_idx)
94
+ [T.must(SERVERS[@server_idx]), {}]
95
+ end
96
+ end
97
+ end
@@ -0,0 +1,77 @@
1
+ # typed: true
2
+
3
+ class OpenApiSDK::SDKConfiguration
4
+ extend ::Crystalline::MetadataFields::ClassMethods
5
+
6
+ def client
7
+ end
8
+
9
+ def client=(client)
10
+ end
11
+
12
+ def gen_version
13
+ end
14
+
15
+ def gen_version=(gen_version)
16
+ end
17
+
18
+ def hooks
19
+ end
20
+
21
+ def hooks=(hooks)
22
+ end
23
+
24
+ def language
25
+ end
26
+
27
+ def language=(language)
28
+ end
29
+
30
+ def openapi_doc_version
31
+ end
32
+
33
+ def openapi_doc_version=(openapi_doc_version)
34
+ end
35
+
36
+ def retry_config
37
+ end
38
+
39
+ def retry_config=(retry_config)
40
+ end
41
+
42
+ def sdk_version
43
+ end
44
+
45
+ def sdk_version=(sdk_version)
46
+ end
47
+
48
+ def server_idx
49
+ end
50
+
51
+ def server_idx=(server_idx)
52
+ end
53
+
54
+ def server_params
55
+ end
56
+
57
+ def server_params=(server_params)
58
+ end
59
+
60
+ def server_url
61
+ end
62
+
63
+ def server_url=(server_url)
64
+ end
65
+
66
+ def timeout
67
+ end
68
+
69
+ def timeout=(timeout)
70
+ end
71
+
72
+ def user_agent
73
+ end
74
+
75
+ def user_agent=(user_agent)
76
+ end
77
+ end
@@ -0,0 +1,232 @@
1
+ # Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
2
+
3
+ # typed: true
4
+ # frozen_string_literal: true
5
+
6
+ require "cgi"
7
+ require "date"
8
+ require "base64"
9
+ require "sorbet-runtime"
10
+
11
+ module OpenApiSDK
12
+ module Utils
13
+ extend T::Sig
14
+
15
+ sig do
16
+ params(
17
+ field_name: ::String,
18
+ explode: T::Boolean,
19
+ obj: ::Object,
20
+ delimiter: ::String,
21
+ get_field_name_lambda: T.proc.params(obj_field: ::Crystalline::MetadataFields::Field).returns(::String)
22
+ )
23
+ .returns(T::Hash[::String, T::Array[::String]])
24
+ end
25
+ def self._populate_form(field_name, explode, obj, delimiter, &get_field_name_lambda)
26
+ params = {}
27
+
28
+ return params if obj.nil?
29
+
30
+ if obj.respond_to?(:fields)
31
+ items = []
32
+ T.unsafe(obj).fields.each do |obj_field|
33
+ obj_field_name = get_field_name_lambda.call(obj_field)
34
+ next if obj_field_name == ""
35
+
36
+ val = obj.send(obj_field.name.to_sym)
37
+ next if val.nil?
38
+
39
+ if explode
40
+ params[obj_field_name] = [val_to_string(val)]
41
+ else
42
+ items.append("#{obj_field_name}#{delimiter}#{val_to_string(val)}")
43
+ end
44
+ end
45
+
46
+ params[field_name] = [items.join(delimiter)] if !items.empty?
47
+ elsif obj.is_a?(::Hash)
48
+ items = []
49
+ obj.each do |key, value|
50
+ next if value.nil?
51
+
52
+ if explode
53
+ params[key] = val_to_string(value)
54
+ else
55
+ items.append("#{key}#{delimiter}#{val_to_string(value)}")
56
+ end
57
+ end
58
+
59
+ params[field_name] = [items.join(delimiter)] if !items.empty?
60
+
61
+ elsif obj.is_a?(::Array)
62
+ items = []
63
+ obj.each do |value|
64
+ next if value.nil?
65
+
66
+ if explode
67
+ params[field_name] = [] if !params.key?(field_name)
68
+
69
+ params[field_name].append(val_to_string(value))
70
+ else
71
+ items.append(val_to_string(value))
72
+ end
73
+ end
74
+
75
+ params[field_name] = items.map(&:to_s).join(delimiter) if !items.empty?
76
+
77
+ else
78
+ params[field_name] = val_to_string(obj)
79
+ end
80
+
81
+ params
82
+ end
83
+
84
+ sig {
85
+ params(media_type: ::String, request: ::Object).returns(
86
+ [::String, ::Object, T::Array[T::Array[T.any(T::Array[T.nilable(::String)], ::String)]]]
87
+ )
88
+ }
89
+ def self.serialize_multipart_form(media_type, request)
90
+ form = []
91
+ T.unsafe(request).fields.each do |field|
92
+ val = request.send(field.name)
93
+ next if val.nil?
94
+
95
+ field_metadata = field.metadata[:multipart_form]
96
+ next if field_metadata.nil?
97
+
98
+ if field_metadata[:file] == true
99
+ field_name = field_metadata[:field_name]
100
+
101
+ # Handle arrays of files
102
+ if val.is_a?(::Array)
103
+ val.each do |file_obj|
104
+ file_name = T.let("", ::String)
105
+ content = nil
106
+
107
+ T.must(file_obj).fields.each do |file_field|
108
+ file_metadata = file_field.metadata[:multipart_form]
109
+ next if file_metadata.nil?
110
+
111
+ if file_metadata[:content] == true
112
+ content = T.let(file_obj.send(file_field.name), ::String)
113
+ else
114
+ file_name = T.let(file_obj.send(file_field.name), ::String)
115
+ end
116
+ end
117
+
118
+ if T.unsafe(file_name) == "" || T.unsafe(content).nil?
119
+ raise ::StandardError, "invalid multipart/form-data file"
120
+ end
121
+
122
+ form.append([field_name, [file_name, content]])
123
+ end
124
+ else
125
+ # Handle single file
126
+ file_name = T.let("", ::String)
127
+ content = nil
128
+
129
+ T.must(val).fields.each do |file_field|
130
+ file_metadata = file_field.metadata[:multipart_form]
131
+ next if file_metadata.nil?
132
+
133
+ if file_metadata[:content] == true
134
+ content = T.let(val.send(file_field.name), ::String)
135
+ else
136
+ file_name = T.let(val.send(file_field.name), ::String)
137
+ end
138
+ end
139
+
140
+ if T.unsafe(file_name) == "" || T.unsafe(content).nil?
141
+ raise ::StandardError, "invalid multipart/form-data file"
142
+ end
143
+
144
+ form.append([field_name, [file_name, content]])
145
+ end
146
+ elsif field_metadata[:json] == true
147
+ to_append = [
148
+ field_metadata.fetch(:field_name, field.name),
149
+ [
150
+ nil,
151
+ ::Crystalline.to_json(val),
152
+ "application/json"
153
+ ]
154
+ ]
155
+ form.append(to_append)
156
+ else
157
+ field_name = field_metadata.fetch(
158
+ :field_name,
159
+ field.name
160
+ )
161
+ if val.is_a?(::Array)
162
+ val.each do |value|
163
+ next if value.nil?
164
+
165
+ form.append(
166
+ [field_name, [nil, val_to_string(value)]]
167
+ )
168
+ end
169
+ else
170
+ form.append([field_name, [nil, val_to_string(val)]])
171
+ end
172
+ end
173
+ end
174
+
175
+ [media_type, nil, form]
176
+ end
177
+
178
+ sig do
179
+ params(data: T.any(::Object, T::Hash[::String, ::String]))
180
+ .returns(T::Hash[T.any(::String, ::Symbol), ::Object])
181
+ end
182
+ def self.serialize_form_data(data)
183
+ get_form_field_name = lambda do |obj_field|
184
+ obj_param_metadata = obj_field.metadata[:form]
185
+
186
+ return T.let({}, T::Hash[T.any(::String, ::Symbol), ::Object]) if obj_param_metadata.nil?
187
+
188
+ return obj_param_metadata.fetch(:field_name, obj_field.name)
189
+ end
190
+
191
+ form = T.let({}, T::Hash[T.any(::String, ::Symbol), ::Object])
192
+ if data.respond_to?(:fields)
193
+ T.unsafe(data).fields.each do |field|
194
+ val = data.send(field.name)
195
+ next if val.nil?
196
+
197
+ metadata = field.metadata[:form]
198
+
199
+ next if metadata.nil?
200
+
201
+ field_name = metadata.fetch(:field_name, field.name)
202
+
203
+ if metadata[:json]
204
+ form[field_name] = ::Crystalline.to_json(val)
205
+ else
206
+ if metadata.fetch(:style, "form") == "form"
207
+ form = form.merge(
208
+ _populate_form(
209
+ field_name,
210
+ metadata.fetch(:explode, true),
211
+ val,
212
+ ",",
213
+ &get_form_field_name
214
+ )
215
+ )
216
+ else
217
+ raise ::StandardError, "Invalid form style for field #{field.name}"
218
+ end
219
+ end
220
+ end
221
+ elsif data.is_a?(::Hash)
222
+ data.each do |key, value|
223
+ form[key] = [val_to_string(value)]
224
+ end
225
+ else
226
+ raise ::StandardError, "Invalid request body type #{data.class}"
227
+ end
228
+
229
+ form
230
+ end
231
+ end
232
+ end
@@ -0,0 +1,84 @@
1
+ # Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
2
+
3
+ # typed: true
4
+ # frozen_string_literal: true
5
+
6
+ require "cgi"
7
+ require "date"
8
+ require "base64"
9
+ require "sorbet-runtime"
10
+
11
+ module OpenApiSDK
12
+ module Utils
13
+ extend T::Sig
14
+
15
+ sig {
16
+ params(
17
+ headers_params: ::Object,
18
+ gbls: T.nilable(T::Hash[::Symbol, T::Hash[::Symbol, T::Hash[::Symbol, ::Object]]])
19
+ )
20
+ .returns(T::Hash[::Symbol, ::String])
21
+ }
22
+ def self.get_headers(headers_params, gbls = nil)
23
+ return {} if headers_params.nil?
24
+
25
+ headers = {}
26
+ T.unsafe(headers_params).fields.each do |f|
27
+ metadata = f.metadata[:header]
28
+ next if metadata.nil?
29
+
30
+ value = _populate_from_globals(f.name, headers_params&.send(f.name), "header", gbls)
31
+ value = _serialize_header(metadata.fetch(:explode, false), value)
32
+ headers[metadata.fetch(:field_name, f.name)] = value if !T.must(value).empty?
33
+ end
34
+
35
+ headers
36
+ end
37
+
38
+ sig { params(explode: T::Boolean, obj: ::Object).returns(T.nilable(::String)) }
39
+ def self._serialize_header(explode, obj)
40
+ return "" if obj.nil?
41
+
42
+ if obj.respond_to?(:fields)
43
+ items = []
44
+ T.unsafe(obj).fields.each do |obj_field|
45
+ obj_param_metadata = obj_field.metadata[:header]
46
+ next if obj_param_metadata.nil?
47
+
48
+ obj_field_name = obj_param_metadata.fetch(:field_name, obj_field.name)
49
+ next if obj_field_name == ""
50
+
51
+ val = obj.send(obj_field.name)
52
+ next if val.nil?
53
+
54
+ if explode
55
+ items.append("#{obj_field_name}=#{val_to_string(val)}")
56
+ else
57
+ items.append(obj_field_name)
58
+ items.append(val_to_string(val))
59
+ end
60
+ end
61
+
62
+ items.join(",") if !items.empty?
63
+ elsif obj.is_a?(::Hash)
64
+ items = []
65
+ obj.each do |key, value|
66
+ next if value.nil?
67
+
68
+ if explode
69
+ items.append("#{key}=#{val_to_string(value)}")
70
+ else
71
+ items.append(key)
72
+ items.append(val_to_string(value))
73
+ end
74
+ end
75
+
76
+ items.join(",") if !items.empty?
77
+ elsif obj.is_a?(::Array)
78
+ items = obj.filter { |v| !v.nil? }.map { |v| val_to_string(v) }.join(",")
79
+ else
80
+ val_to_string(obj)
81
+ end
82
+ end
83
+ end
84
+ end