minecraft_versions 0.10.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.
Files changed (53) hide show
  1. checksums.yaml +7 -0
  2. data/Gemfile +9 -0
  3. data/Gemfile.lock +72 -0
  4. data/README.md +98 -0
  5. data/Rakefile +10 -0
  6. data/bin/bundle +109 -0
  7. data/bin/byebug +27 -0
  8. data/bin/coderay +27 -0
  9. data/bin/htmldiff +27 -0
  10. data/bin/ldiff +27 -0
  11. data/bin/pry +27 -0
  12. data/bin/racc +27 -0
  13. data/bin/rake +27 -0
  14. data/bin/rspec +27 -0
  15. data/bin/rubocop +27 -0
  16. data/bin/ruby-parse +27 -0
  17. data/bin/ruby-rewrite +27 -0
  18. data/docs/DefaultApi.md +132 -0
  19. data/docs/Download.md +22 -0
  20. data/docs/Version.md +26 -0
  21. data/docs/VersionManifest.md +20 -0
  22. data/docs/VersionManifestLatest.md +20 -0
  23. data/docs/VersionPackageInfo.md +40 -0
  24. data/docs/VersionPackageInfoAssetIndex.md +26 -0
  25. data/docs/VersionPackageInfoDownloads.md +24 -0
  26. data/docs/VersionPackageInfoJavaVersion.md +20 -0
  27. data/git_push.sh +57 -0
  28. data/lib/minecraft_versions/api/default_api.rb +142 -0
  29. data/lib/minecraft_versions/api_client.rb +391 -0
  30. data/lib/minecraft_versions/api_error.rb +56 -0
  31. data/lib/minecraft_versions/configuration.rb +293 -0
  32. data/lib/minecraft_versions/models/download.rb +230 -0
  33. data/lib/minecraft_versions/models/version.rb +248 -0
  34. data/lib/minecraft_versions/models/version_manifest.rb +223 -0
  35. data/lib/minecraft_versions/models/version_manifest_latest.rb +221 -0
  36. data/lib/minecraft_versions/models/version_package_info.rb +311 -0
  37. data/lib/minecraft_versions/models/version_package_info_asset_index.rb +248 -0
  38. data/lib/minecraft_versions/models/version_package_info_downloads.rb +239 -0
  39. data/lib/minecraft_versions/models/version_package_info_java_version.rb +221 -0
  40. data/lib/minecraft_versions/version.rb +13 -0
  41. data/lib/minecraft_versions.rb +46 -0
  42. data/minecraft_versions.gemspec +37 -0
  43. data/spec/api/default_api_spec.rb +55 -0
  44. data/spec/models/download_spec.rb +46 -0
  45. data/spec/models/version_manifest_latest_spec.rb +40 -0
  46. data/spec/models/version_manifest_spec.rb +40 -0
  47. data/spec/models/version_package_info_asset_index_spec.rb +58 -0
  48. data/spec/models/version_package_info_downloads_spec.rb +52 -0
  49. data/spec/models/version_package_info_java_version_spec.rb +40 -0
  50. data/spec/models/version_package_info_spec.rb +100 -0
  51. data/spec/models/version_spec.rb +58 -0
  52. data/spec/spec_helper.rb +109 -0
  53. metadata +144 -0
@@ -0,0 +1,391 @@
1
+ =begin
2
+ #SDK for Minecraft versions info
3
+
4
+ The version of the OpenAPI document: 0.10.0
5
+ Contact: blah+oapicf@cliffano.com
6
+ Generated by: https://openapi-generator.tech
7
+ Generator version: 7.6.0
8
+
9
+ =end
10
+
11
+ require 'date'
12
+ require 'json'
13
+ require 'logger'
14
+ require 'tempfile'
15
+ require 'time'
16
+ require 'typhoeus'
17
+
18
+
19
+ module MinecraftVersionsClient
20
+ class ApiClient
21
+ # The Configuration object holding settings to be used in the API client.
22
+ attr_accessor :config
23
+
24
+ # Defines the headers to be used in HTTP requests of all API calls by default.
25
+ #
26
+ # @return [Hash]
27
+ attr_accessor :default_headers
28
+
29
+ # Initializes the ApiClient
30
+ # @option config [Configuration] Configuration for initializing the object, default to Configuration.default
31
+ def initialize(config = Configuration.default)
32
+ @config = config
33
+ @user_agent = "OpenAPI-Generator/#{VERSION}/ruby"
34
+ @default_headers = {
35
+ 'Content-Type' => 'application/json',
36
+ 'User-Agent' => @user_agent
37
+ }
38
+ end
39
+
40
+ def self.default
41
+ @@default ||= ApiClient.new
42
+ end
43
+
44
+ # Call an API with given options.
45
+ #
46
+ # @return [Array<(Object, Integer, Hash)>] an array of 3 elements:
47
+ # the data deserialized from response body (may be a Tempfile or nil), response status code and response headers.
48
+ def call_api(http_method, path, opts = {})
49
+ request = build_request(http_method, path, opts)
50
+ tempfile = download_file(request) if opts[:return_type] == 'File'
51
+ response = request.run
52
+
53
+ if @config.debugging
54
+ @config.logger.debug "HTTP response body ~BEGIN~\n#{response.body}\n~END~\n"
55
+ end
56
+
57
+ unless response.success?
58
+ if response.timed_out?
59
+ fail ApiError.new('Connection timed out')
60
+ elsif response.code == 0
61
+ # Errors from libcurl will be made visible here
62
+ fail ApiError.new(:code => 0,
63
+ :message => response.return_message)
64
+ else
65
+ fail ApiError.new(:code => response.code,
66
+ :response_headers => response.headers,
67
+ :response_body => response.body),
68
+ response.status_message
69
+ end
70
+ end
71
+
72
+ if opts[:return_type] == 'File'
73
+ data = tempfile
74
+ elsif opts[:return_type]
75
+ data = deserialize(response, opts[:return_type])
76
+ else
77
+ data = nil
78
+ end
79
+ return data, response.code, response.headers
80
+ end
81
+
82
+ # Builds the HTTP request
83
+ #
84
+ # @param [String] http_method HTTP method/verb (e.g. POST)
85
+ # @param [String] path URL path (e.g. /account/new)
86
+ # @option opts [Hash] :header_params Header parameters
87
+ # @option opts [Hash] :query_params Query parameters
88
+ # @option opts [Hash] :form_params Query parameters
89
+ # @option opts [Object] :body HTTP body (JSON/XML)
90
+ # @return [Typhoeus::Request] A Typhoeus Request
91
+ def build_request(http_method, path, opts = {})
92
+ url = build_request_url(path, opts)
93
+ http_method = http_method.to_sym.downcase
94
+
95
+ header_params = @default_headers.merge(opts[:header_params] || {})
96
+ query_params = opts[:query_params] || {}
97
+ form_params = opts[:form_params] || {}
98
+ follow_location = opts[:follow_location] || true
99
+
100
+
101
+ # set ssl_verifyhosts option based on @config.verify_ssl_host (true/false)
102
+ _verify_ssl_host = @config.verify_ssl_host ? 2 : 0
103
+
104
+ req_opts = {
105
+ :method => http_method,
106
+ :headers => header_params,
107
+ :params => query_params,
108
+ :params_encoding => @config.params_encoding,
109
+ :timeout => @config.timeout,
110
+ :ssl_verifypeer => @config.verify_ssl,
111
+ :ssl_verifyhost => _verify_ssl_host,
112
+ :sslcert => @config.cert_file,
113
+ :sslkey => @config.key_file,
114
+ :verbose => @config.debugging,
115
+ :followlocation => follow_location
116
+ }
117
+
118
+ # set custom cert, if provided
119
+ req_opts[:cainfo] = @config.ssl_ca_cert if @config.ssl_ca_cert
120
+
121
+ if [:post, :patch, :put, :delete].include?(http_method)
122
+ req_body = build_request_body(header_params, form_params, opts[:body])
123
+ req_opts.update :body => req_body
124
+ if @config.debugging
125
+ @config.logger.debug "HTTP request body param ~BEGIN~\n#{req_body}\n~END~\n"
126
+ end
127
+ end
128
+
129
+ Typhoeus::Request.new(url, req_opts)
130
+ end
131
+
132
+ # Builds the HTTP request body
133
+ #
134
+ # @param [Hash] header_params Header parameters
135
+ # @param [Hash] form_params Query parameters
136
+ # @param [Object] body HTTP body (JSON/XML)
137
+ # @return [String] HTTP body data in the form of string
138
+ def build_request_body(header_params, form_params, body)
139
+ # http form
140
+ if header_params['Content-Type'] == 'application/x-www-form-urlencoded' ||
141
+ header_params['Content-Type'] == 'multipart/form-data'
142
+ data = {}
143
+ form_params.each do |key, value|
144
+ case value
145
+ when ::File, ::Array, nil
146
+ # let typhoeus handle File, Array and nil parameters
147
+ data[key] = value
148
+ else
149
+ data[key] = value.to_s
150
+ end
151
+ end
152
+ elsif body
153
+ data = body.is_a?(String) ? body : body.to_json
154
+ else
155
+ data = nil
156
+ end
157
+ data
158
+ end
159
+
160
+ # Save response body into a file in (the defined) temporary folder, using the filename
161
+ # from the "Content-Disposition" header if provided, otherwise a random filename.
162
+ # The response body is written to the file in chunks in order to handle files which
163
+ # size is larger than maximum Ruby String or even larger than the maximum memory a Ruby
164
+ # process can use.
165
+ #
166
+ # @see Configuration#temp_folder_path
167
+ #
168
+ # @return [Tempfile] the tempfile generated
169
+ def download_file(request)
170
+ tempfile = nil
171
+ encoding = nil
172
+ request.on_headers do |response|
173
+ content_disposition = response.headers['Content-Disposition']
174
+ if content_disposition && content_disposition =~ /filename=/i
175
+ filename = content_disposition[/filename=['"]?([^'"\s]+)['"]?/, 1]
176
+ prefix = sanitize_filename(filename)
177
+ else
178
+ prefix = 'download-'
179
+ end
180
+ prefix = prefix + '-' unless prefix.end_with?('-')
181
+ encoding = response.body.encoding
182
+ tempfile = Tempfile.open(prefix, @config.temp_folder_path, encoding: encoding)
183
+ end
184
+ request.on_body do |chunk|
185
+ chunk.force_encoding(encoding)
186
+ tempfile.write(chunk)
187
+ end
188
+ # run the request to ensure the tempfile is created successfully before returning it
189
+ request.run
190
+ if tempfile
191
+ tempfile.close
192
+ @config.logger.info "Temp file written to #{tempfile.path}, please copy the file to a proper folder "\
193
+ "with e.g. `FileUtils.cp(tempfile.path, '/new/file/path')` otherwise the temp file "\
194
+ "will be deleted automatically with GC. It's also recommended to delete the temp file "\
195
+ "explicitly with `tempfile.delete`"
196
+ else
197
+ fail ApiError.new("Failed to create the tempfile based on the HTTP response from the server: #{request.inspect}")
198
+ end
199
+
200
+ tempfile
201
+ end
202
+
203
+ # Check if the given MIME is a JSON MIME.
204
+ # JSON MIME examples:
205
+ # application/json
206
+ # application/json; charset=UTF8
207
+ # APPLICATION/JSON
208
+ # */*
209
+ # @param [String] mime MIME
210
+ # @return [Boolean] True if the MIME is application/json
211
+ def json_mime?(mime)
212
+ (mime == '*/*') || !(mime =~ /^Application\/.*json(?!p)(;.*)?/i).nil?
213
+ end
214
+
215
+ # Deserialize the response to the given return type.
216
+ #
217
+ # @param [Response] response HTTP response
218
+ # @param [String] return_type some examples: "User", "Array<User>", "Hash<String, Integer>"
219
+ def deserialize(response, return_type)
220
+ body = response.body
221
+ return nil if body.nil? || body.empty?
222
+
223
+ # return response body directly for String return type
224
+ return body.to_s if return_type == 'String'
225
+
226
+ # ensuring a default content type
227
+ content_type = response.headers['Content-Type'] || 'application/json'
228
+
229
+ fail "Content-Type is not supported: #{content_type}" unless json_mime?(content_type)
230
+
231
+ begin
232
+ data = JSON.parse("[#{body}]", :symbolize_names => true)[0]
233
+ rescue JSON::ParserError => e
234
+ if %w(String Date Time).include?(return_type)
235
+ data = body
236
+ else
237
+ raise e
238
+ end
239
+ end
240
+
241
+ convert_to_type data, return_type
242
+ end
243
+
244
+ # Convert data to the given return type.
245
+ # @param [Object] data Data to be converted
246
+ # @param [String] return_type Return type
247
+ # @return [Mixed] Data in a particular type
248
+ def convert_to_type(data, return_type)
249
+ return nil if data.nil?
250
+ case return_type
251
+ when 'String'
252
+ data.to_s
253
+ when 'Integer'
254
+ data.to_i
255
+ when 'Float'
256
+ data.to_f
257
+ when 'Boolean'
258
+ data == true
259
+ when 'Time'
260
+ # parse date time (expecting ISO 8601 format)
261
+ Time.parse data
262
+ when 'Date'
263
+ # parse date time (expecting ISO 8601 format)
264
+ Date.parse data
265
+ when 'Object'
266
+ # generic object (usually a Hash), return directly
267
+ data
268
+ when /\AArray<(.+)>\z/
269
+ # e.g. Array<Pet>
270
+ sub_type = $1
271
+ data.map { |item| convert_to_type(item, sub_type) }
272
+ when /\AHash\<String, (.+)\>\z/
273
+ # e.g. Hash<String, Integer>
274
+ sub_type = $1
275
+ {}.tap do |hash|
276
+ data.each { |k, v| hash[k] = convert_to_type(v, sub_type) }
277
+ end
278
+ else
279
+ # models (e.g. Pet) or oneOf
280
+ klass = MinecraftVersionsClient.const_get(return_type)
281
+ klass.respond_to?(:openapi_one_of) ? klass.build(data) : klass.build_from_hash(data)
282
+ end
283
+ end
284
+
285
+ # Sanitize filename by removing path.
286
+ # e.g. ../../sun.gif becomes sun.gif
287
+ #
288
+ # @param [String] filename the filename to be sanitized
289
+ # @return [String] the sanitized filename
290
+ def sanitize_filename(filename)
291
+ filename.split(/[\/\\]/).last
292
+ end
293
+
294
+ def build_request_url(path, opts = {})
295
+ # Add leading and trailing slashes to path
296
+ path = "/#{path}".gsub(/\/+/, '/')
297
+ @config.base_url(opts[:operation]) + path
298
+ end
299
+
300
+ # Update header and query params based on authentication settings.
301
+ #
302
+ # @param [Hash] header_params Header parameters
303
+ # @param [Hash] query_params Query parameters
304
+ # @param [String] auth_names Authentication scheme name
305
+ def update_params_for_auth!(header_params, query_params, auth_names)
306
+ Array(auth_names).each do |auth_name|
307
+ auth_setting = @config.auth_settings[auth_name]
308
+ next unless auth_setting
309
+ case auth_setting[:in]
310
+ when 'header' then header_params[auth_setting[:key]] = auth_setting[:value]
311
+ when 'query' then query_params[auth_setting[:key]] = auth_setting[:value]
312
+ else fail ArgumentError, 'Authentication token must be in `query` or `header`'
313
+ end
314
+ end
315
+ end
316
+
317
+ # Sets user agent in HTTP header
318
+ #
319
+ # @param [String] user_agent User agent (e.g. openapi-generator/ruby/1.0.0)
320
+ def user_agent=(user_agent)
321
+ @user_agent = user_agent
322
+ @default_headers['User-Agent'] = @user_agent
323
+ end
324
+
325
+ # Return Accept header based on an array of accepts provided.
326
+ # @param [Array] accepts array for Accept
327
+ # @return [String] the Accept header (e.g. application/json)
328
+ def select_header_accept(accepts)
329
+ return nil if accepts.nil? || accepts.empty?
330
+ # use JSON when present, otherwise use all of the provided
331
+ json_accept = accepts.find { |s| json_mime?(s) }
332
+ json_accept || accepts.join(',')
333
+ end
334
+
335
+ # Return Content-Type header based on an array of content types provided.
336
+ # @param [Array] content_types array for Content-Type
337
+ # @return [String] the Content-Type header (e.g. application/json)
338
+ def select_header_content_type(content_types)
339
+ # return nil by default
340
+ return if content_types.nil? || content_types.empty?
341
+ # use JSON when present, otherwise use the first one
342
+ json_content_type = content_types.find { |s| json_mime?(s) }
343
+ json_content_type || content_types.first
344
+ end
345
+
346
+ # Convert object (array, hash, object, etc) to JSON string.
347
+ # @param [Object] model object to be converted into JSON string
348
+ # @return [String] JSON string representation of the object
349
+ def object_to_http_body(model)
350
+ return model if model.nil? || model.is_a?(String)
351
+ local_body = nil
352
+ if model.is_a?(Array)
353
+ local_body = model.map { |m| object_to_hash(m) }
354
+ else
355
+ local_body = object_to_hash(model)
356
+ end
357
+ local_body.to_json
358
+ end
359
+
360
+ # Convert object(non-array) to hash.
361
+ # @param [Object] obj object to be converted into JSON string
362
+ # @return [String] JSON string representation of the object
363
+ def object_to_hash(obj)
364
+ if obj.respond_to?(:to_hash)
365
+ obj.to_hash
366
+ else
367
+ obj
368
+ end
369
+ end
370
+
371
+ # Build parameter value according to the given collection format.
372
+ # @param [String] collection_format one of :csv, :ssv, :tsv, :pipes and :multi
373
+ def build_collection_param(param, collection_format)
374
+ case collection_format
375
+ when :csv
376
+ param.join(',')
377
+ when :ssv
378
+ param.join(' ')
379
+ when :tsv
380
+ param.join("\t")
381
+ when :pipes
382
+ param.join('|')
383
+ when :multi
384
+ # return the array directly as typhoeus will handle it as expected
385
+ param
386
+ else
387
+ fail "unknown collection format: #{collection_format.inspect}"
388
+ end
389
+ end
390
+ end
391
+ end
@@ -0,0 +1,56 @@
1
+ =begin
2
+ #SDK for Minecraft versions info
3
+
4
+ The version of the OpenAPI document: 0.10.0
5
+ Contact: blah+oapicf@cliffano.com
6
+ Generated by: https://openapi-generator.tech
7
+ Generator version: 7.6.0
8
+
9
+ =end
10
+
11
+ module MinecraftVersionsClient
12
+ class ApiError < StandardError
13
+ attr_reader :code, :response_headers, :response_body
14
+
15
+ # Usage examples:
16
+ # ApiError.new
17
+ # ApiError.new("message")
18
+ # ApiError.new(:code => 500, :response_headers => {}, :response_body => "")
19
+ # ApiError.new(:code => 404, :message => "Not Found")
20
+ def initialize(arg = nil)
21
+ if arg.is_a? Hash
22
+ if arg.key?(:message) || arg.key?('message')
23
+ super(arg[:message] || arg['message'])
24
+ else
25
+ super arg
26
+ end
27
+
28
+ arg.each do |k, v|
29
+ instance_variable_set "@#{k}", v
30
+ end
31
+ else
32
+ super arg
33
+ @message = arg
34
+ end
35
+ end
36
+
37
+ # Override to_s to display a friendly error message
38
+ def to_s
39
+ message
40
+ end
41
+
42
+ def message
43
+ if @message.nil?
44
+ msg = "Error message: the server returns an error"
45
+ else
46
+ msg = @message
47
+ end
48
+
49
+ msg += "\nHTTP status code: #{code}" if code
50
+ msg += "\nResponse headers: #{response_headers}" if response_headers
51
+ msg += "\nResponse body: #{response_body}" if response_body
52
+
53
+ msg
54
+ end
55
+ end
56
+ end