ftc_events_client 0.1.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/Gemfile +9 -0
- data/README.md +236 -0
- data/Rakefile +10 -0
- data/config.json +8 -0
- data/docs/AllianceModelVersion2.md +32 -0
- data/docs/AllianceScore2020.md +86 -0
- data/docs/AllianceSelectionApi.md +62 -0
- data/docs/AllianceSelectionModelVersion2.md +20 -0
- data/docs/ApiIndexModel.md +34 -0
- data/docs/AwardAssignmentModel.md +38 -0
- data/docs/AwardsApi.md +235 -0
- data/docs/AwardsModel.md +18 -0
- data/docs/EventMatchResultsModelVersion2.md +18 -0
- data/docs/EventRankingsModel.md +18 -0
- data/docs/EventScheduleHybridModelVersion2.md +18 -0
- data/docs/EventScheduleModelVersion2.md +18 -0
- data/docs/GeneralApi.md +51 -0
- data/docs/MatchResultModelVersion2.md +44 -0
- data/docs/MatchResultTeamModelVersion2.md +22 -0
- data/docs/MatchResultsApi.md +141 -0
- data/docs/MatchScoresModel.md +18 -0
- data/docs/MatchScoresModelMatchScoresOneOf.md +51 -0
- data/docs/RankingsApi.md +68 -0
- data/docs/ScheduleApi.md +135 -0
- data/docs/ScheduleHybridModelTeamVersion2.md +26 -0
- data/docs/ScheduleHybridModelVersion2.md +44 -0
- data/docs/ScheduledMatchModelVersion2.md +32 -0
- data/docs/ScheduledMatchTeamModelVersion2.md +24 -0
- data/docs/ScoreDetailAllianceModel2020.md +90 -0
- data/docs/ScoreDetailModel2019.md +22 -0
- data/docs/ScoreDetailModel2020.md +22 -0
- data/docs/ScoreDetailModelAlliance2019.md +84 -0
- data/docs/ScoreDetailModelSinglePlayer2020.md +24 -0
- data/docs/SeasonAwardListingsModel.md +18 -0
- data/docs/SeasonAwardsModel.md +24 -0
- data/docs/SeasonDataApi.md +182 -0
- data/docs/SeasonEventListingsModelVersion2.md +20 -0
- data/docs/SeasonEventModelVersion2.md +50 -0
- data/docs/SeasonSummaryModelChampionship.md +22 -0
- data/docs/SeasonSummaryModelVersion2.md +28 -0
- data/docs/SeasonTeamListingsModelVersion2.md +26 -0
- data/docs/SeasonTeamModelVersion2.md +40 -0
- data/docs/Stone.md +15 -0
- data/docs/TeamRankingModel.md +46 -0
- data/docs/TournamentLevel.md +15 -0
- data/ftc_events_client.gemspec +38 -0
- data/git_push.sh +58 -0
- data/lib/ftc_events_client.rb +80 -0
- data/lib/ftc_events_client/api/alliance_selection_api.rb +87 -0
- data/lib/ftc_events_client/api/awards_api.rb +296 -0
- data/lib/ftc_events_client/api/general_api.rb +79 -0
- data/lib/ftc_events_client/api/match_results_api.rb +185 -0
- data/lib/ftc_events_client/api/rankings_api.rb +93 -0
- data/lib/ftc_events_client/api/schedule_api.rb +176 -0
- data/lib/ftc_events_client/api/season_data_api.rb +229 -0
- data/lib/ftc_events_client/api_client.rb +390 -0
- data/lib/ftc_events_client/api_error.rb +57 -0
- data/lib/ftc_events_client/configuration.rb +275 -0
- data/lib/ftc_events_client/models/alliance_model_version2.rb +288 -0
- data/lib/ftc_events_client/models/alliance_score2020.rb +524 -0
- data/lib/ftc_events_client/models/alliance_selection_model_version2.rb +230 -0
- data/lib/ftc_events_client/models/api_index_model.rb +301 -0
- data/lib/ftc_events_client/models/award_assignment_model.rb +317 -0
- data/lib/ftc_events_client/models/awards_model.rb +221 -0
- data/lib/ftc_events_client/models/event_match_results_model_version2.rb +221 -0
- data/lib/ftc_events_client/models/event_rankings_model.rb +221 -0
- data/lib/ftc_events_client/models/event_schedule_hybrid_model_version2.rb +221 -0
- data/lib/ftc_events_client/models/event_schedule_model_version2.rb +221 -0
- data/lib/ftc_events_client/models/match_result_model_version2.rb +343 -0
- data/lib/ftc_events_client/models/match_result_team_model_version2.rb +237 -0
- data/lib/ftc_events_client/models/match_scores_model.rb +221 -0
- data/lib/ftc_events_client/models/match_scores_model_match_scores_one_of.rb +106 -0
- data/lib/ftc_events_client/models/schedule_hybrid_model_team_version2.rb +257 -0
- data/lib/ftc_events_client/models/schedule_hybrid_model_version2.rb +349 -0
- data/lib/ftc_events_client/models/scheduled_match_model_version2.rb +289 -0
- data/lib/ftc_events_client/models/scheduled_match_team_model_version2.rb +247 -0
- data/lib/ftc_events_client/models/score_detail_alliance_model2020.rb +543 -0
- data/lib/ftc_events_client/models/score_detail_model2019.rb +239 -0
- data/lib/ftc_events_client/models/score_detail_model2020.rb +239 -0
- data/lib/ftc_events_client/models/score_detail_model_alliance2019.rb +519 -0
- data/lib/ftc_events_client/models/score_detail_model_single_player2020.rb +245 -0
- data/lib/ftc_events_client/models/season_award_listings_model.rb +221 -0
- data/lib/ftc_events_client/models/season_awards_model.rb +247 -0
- data/lib/ftc_events_client/models/season_event_listings_model_version2.rb +230 -0
- data/lib/ftc_events_client/models/season_event_model_version2.rb +377 -0
- data/lib/ftc_events_client/models/season_summary_model_championship.rb +239 -0
- data/lib/ftc_events_client/models/season_summary_model_version2.rb +268 -0
- data/lib/ftc_events_client/models/season_team_listings_model_version2.rb +257 -0
- data/lib/ftc_events_client/models/season_team_model_version2.rb +328 -0
- data/lib/ftc_events_client/models/stone.rb +38 -0
- data/lib/ftc_events_client/models/team_ranking_model.rb +344 -0
- data/lib/ftc_events_client/models/tournament_level.rb +41 -0
- data/lib/ftc_events_client/version.rb +15 -0
- data/spec/api/alliance_selection_api_spec.rb +48 -0
- data/spec/api/awards_api_spec.rb +89 -0
- data/spec/api/general_api_spec.rb +46 -0
- data/spec/api/match_results_api_spec.rb +71 -0
- data/spec/api/rankings_api_spec.rb +50 -0
- data/spec/api/schedule_api_spec.rb +68 -0
- data/spec/api/season_data_api_spec.rb +77 -0
- data/spec/api_client_spec.rb +226 -0
- data/spec/configuration_spec.rb +42 -0
- data/spec/models/alliance_model_version2_spec.rb +76 -0
- data/spec/models/alliance_score2020_spec.rb +238 -0
- data/spec/models/alliance_selection_model_version2_spec.rb +40 -0
- data/spec/models/api_index_model_spec.rb +82 -0
- data/spec/models/award_assignment_model_spec.rb +94 -0
- data/spec/models/awards_model_spec.rb +34 -0
- data/spec/models/event_match_results_model_version2_spec.rb +34 -0
- data/spec/models/event_rankings_model_spec.rb +34 -0
- data/spec/models/event_schedule_hybrid_model_version2_spec.rb +34 -0
- data/spec/models/event_schedule_model_version2_spec.rb +34 -0
- data/spec/models/match_result_model_version2_spec.rb +112 -0
- data/spec/models/match_result_team_model_version2_spec.rb +46 -0
- data/spec/models/match_scores_model_match_scores_one_of_spec.rb +31 -0
- data/spec/models/match_scores_model_spec.rb +34 -0
- data/spec/models/schedule_hybrid_model_team_version2_spec.rb +58 -0
- data/spec/models/schedule_hybrid_model_version2_spec.rb +112 -0
- data/spec/models/scheduled_match_model_version2_spec.rb +76 -0
- data/spec/models/scheduled_match_team_model_version2_spec.rb +52 -0
- data/spec/models/score_detail_alliance_model2020_spec.rb +250 -0
- data/spec/models/score_detail_model2019_spec.rb +46 -0
- data/spec/models/score_detail_model2020_spec.rb +46 -0
- data/spec/models/score_detail_model_alliance2019_spec.rb +232 -0
- data/spec/models/score_detail_model_single_player2020_spec.rb +52 -0
- data/spec/models/season_award_listings_model_spec.rb +34 -0
- data/spec/models/season_awards_model_spec.rb +52 -0
- data/spec/models/season_event_listings_model_version2_spec.rb +40 -0
- data/spec/models/season_event_model_version2_spec.rb +130 -0
- data/spec/models/season_summary_model_championship_spec.rb +46 -0
- data/spec/models/season_summary_model_version2_spec.rb +64 -0
- data/spec/models/season_team_listings_model_version2_spec.rb +58 -0
- data/spec/models/season_team_model_version2_spec.rb +100 -0
- data/spec/models/stone_spec.rb +28 -0
- data/spec/models/team_ranking_model_spec.rb +118 -0
- data/spec/models/tournament_level_spec.rb +28 -0
- data/spec/spec_helper.rb +111 -0
- data/update.sh +8 -0
- metadata +265 -0
@@ -0,0 +1,229 @@
|
|
1
|
+
=begin
|
2
|
+
#FTC Events API
|
3
|
+
|
4
|
+
#FTC Events API is a service to return relevant information about the _FIRST_ Tech Challenge (FTC). Information is made available from events operating around the world Information is currently made available after the conclusion of the tournament. The API will provide data as soon as it has synced, and we do not add any artificial delays. ## Documentation Notes ### Timezones All times are listed in the local time to the event venue. HTTP-date values will show their timezone. ### Query Parameters If you specify a parameter, but no value for that parameter, it will be ignored. For example, if you request `URL?teamNumber=` the `teamNumber` parameter would be ignored. For all APIs that accept a query string in addition to the base URI, the order of parameters do not matter, but the name shown in the documentation must match exactly, as does the associated value format as described in details. For response codes that are not HTTP 200 (OK), the documentation will show a body message that represents a possible response value. While the \"title\" of the HTTP Status Code will match those shown in the response codes documentation section exactly, the body of the response will be a more detailed explanation of why that status code is being returned and may not always be exactly as shown in the examples. ### Experimenting with the API This documentation is rendered at both [api-docs](https://ftc-events.firstinspires.org/api-docs) and [try-it-out](https://ftc-events.firstinspires.org/try-it-out). [api-docs](https://ftc-events.firstinspires.org/api-docs) has a three panel, easy to read layout, while [try-it-out](https://ftc-events.firstinspires.org/try-it-out) has a feature that allows you try out endpoints from within the page. Additionally, the Open API Json is availabe at [Open API](https://ftc-events.firstinspires.org/swagger/v2.0/swagger.json). This can be imported into a tool such as [Postman](https://www.postman.com) for experimentation as well. ### Last-Modified, FMS-OnlyModifiedSince, and If-Modified-Since Headers The FTC Events API utilizes the `Last-Modified` and `If-Modified-Since` Headers to communicate with consumers regarding the age of the data they are requesting. With a couple of exceptions, all calls will return a `Last-Modified` Header set with the time at which the data at that endpoint was last modified. The Header will always be set in the HTTP-date format, as described in the HTTP Protocol. There are two exceptions: the `Last-Modified` Header is not set if the endpoint returns no results (such as a request for a schedule with no matches). Consumers should keep track of the `Last-Modified` Header, and return it on subsequent calls to the same endpoint as the If-Modified-Since. The server will recognize this request, and will only return a result if the data has been modified since the last request. If no changes have been made, an HTTP 304 will be returned. If data has been modified, ALL data on that call will be returned (for \"only modified\" data, see below). The FTC Events API also allows a custom header used to filter the return data to a specific subset. This is done by specifying a `FMS-OnlyModifiedSince` header with each call. As with the `If-Modified-Since` header, consumers should keep track of the Last-Modified Header, and return it on subsequent calls to the same endpoint as the `FMS-OnlyModifiedSince` Header. The server will recognize this request, and will only return a result if the data has been modified since the last request, and, if returned, the data will only be those portions modified since the included date. If no changes, have been made, an HTTP 304 will be returned. Using this method, the server and consumer save processing time by only receiving modified data that is in need of update on the consumer side. If the Headers are improperly passed (such as the wrong Day of Week for the matching date, or a date in the future), the endpoint will simply ignore the Header and return all results. If both headers are specified, the request will be denied. ## Response Codes The FTC Events API HTTP Status Codes correspond with the [common codes](http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html), but occasionally with different \"titles\". The \"title\" used by the API is shown next to each of the below possible response HTTP Status Codes. Throughout the documentation, Apiary may automatically show the common \"title\" in example returns (like \"Not Found\" for 404) but on the production server, the \"title\" will instead match those listed below. ### HTTP 200 - \"OK\" The request has succeeded. An entity corresponding to the requested resource is sent in the response. This will be returned as the HTTP Status Code for all request that succeed, even if the body is empty (such as an event that has no rankings, but with a valid season and event code were used) ### HTTP 304 - \"Not Modified\" When utilizing a Header that allows filtered data returns, such as `If-Modified-Since`, this response indicates that no data meets the request. ### HTTP 400 - \"Invalid Season Requested\"/\"Malformed Parameter Format In Request\"/\"Missing Parameter In Request\"/\"Invalid API Version Requested\": The request could not be understood by the server due to malformed syntax. The client SHOULD NOT repeat the request without modifications. Specifically for this API, a 400 response indicates that the requested URI matches with a valid API, but one or more required parameter was malformed or invalid. Examples include an event code that is too short or team number that contains a letter. ### HTTP 401 - \"Unauthorized\" All requests against the API require authentication via a valid user token. Failing to provide one, or providing an invalid one, will warrant a 401 response. The client MAY repeat the request with a suitable Authorization header field. ### HTTP 404 - \"Invalid Event Requested\" Even though the 404 code usually indicates any not found status, a 404 will only be issued in this API when an event cannot be found for the requested season and event code. If the request didn't match a valid API or there were malformed parameters, the response would not receive a 404 but rather a 400 or 501. If this HTTP code is received, the season was a valid season and the event code matched the acceptable style of an event code, but there were no records of an event matching the combination of that season and event code. For example, HTTP 404 would be issued when the event had a different code in the requested season (the codes can change year to year based on event location). ### HTTP 500 - \"Internal Server Error\" The server encountered an unexpected condition which prevented it from fulfilling the request. This is a code sent directly by the server, and has no special alternate definition specific to this API. ### HTTP 501 - \"Request Did Not Match Any Current API Pattern\" The server does not support the functionality required to fulfill the request. Specifically, the request pattern did not match any of the possible APIs, and thus processing was discontinued. This code is also issued when too many optional parameters were included in a single request and fulfilling it would make the result confusing or misleading. Each API will specify which parameters or combination of parameters can be used at the same time. ### HTTP 503 - \"Service Unavailable\" The server is currently unable to handle the request due to a temporary overloading or maintenance of the server. The implication is that this is a temporary condition which will be alleviated after some delay. If known, the length of the delay MAY be indicated in a `Retry-After` header. This code will not always appear, sometimes the server may outright refuse the connection instead. This is a code sent directly by the server, and has no special alternate definition specific to this API. ## Authorization In order to make calls against the FTC Events API, you must include an HTTP Header called `Authorization` with the value set as specified below. If a request is made without this header, processing stops and an HTTP 401 is issued. All `Authorization` headers follow the same format: ``` Authorization: Basic 000000000000000000000000000000000000000000000000000000000000 ``` Where the Zeros are replaced by your Token. The Token can be formed by taking your username and your AuthorizationKey and adding a colon. For example, if your username is `sampleuser` and your AuthorizationKey is `7eaa6338-a097-4221-ac04-b6120fcc4d49` you would have this string: ``` sampleuser:7eaa6338-a097-4221-ac04-b6120fcc4d49 ``` This string must then be encoded using Base64 Encoded to form the Token, which will be the same length as the example above, but include letters and numbers. For our example, we would have: ``` c2FtcGxldXNlcjo3ZWFhNjMzOC1hMDk3LTQyMjEtYWMwNC1iNjEyMGZjYzRkNDk= ``` Most API client libraries can handle computing the authorization header using a username and password for you NOTICE: Publicly distributing an application, code snippet, etc, that has your username and token in it, encoded or not, WILL result in your token being blocked from the API. Each user should apply for their own token. If you wish to acquire a token for your development, you may do so by requesting a token through our automated system on this website.
|
5
|
+
|
6
|
+
The version of the OpenAPI document: v2.0
|
7
|
+
|
8
|
+
Generated by: https://openapi-generator.tech
|
9
|
+
OpenAPI Generator version: 5.0.0-SNAPSHOT
|
10
|
+
|
11
|
+
=end
|
12
|
+
|
13
|
+
require 'cgi'
|
14
|
+
|
15
|
+
module FtcEventsClient
|
16
|
+
class SeasonDataApi
|
17
|
+
attr_accessor :api_client
|
18
|
+
|
19
|
+
def initialize(api_client = ApiClient.default)
|
20
|
+
@api_client = api_client
|
21
|
+
end
|
22
|
+
# Event Listings
|
23
|
+
# The event listings API returns all FTC official regional events in a particular season. You can specify an `eventCode` if you would only like data about one specific event. If you specify an `eventCode` you cannot specify any other optional parameters. Alternately, you can specify a `teamNumber` to retrieve only the listings of events being attended by the particular team. If you specify a `teamNumber` you cannot specify an `eventCode`. The response for event listings contains a special field called divisionCode. For example, the FIRST Championship contains two Divisions. As an example of a response, the event listings for a Division will have a divisionCode that matches the FIRST Championship event code (as they are divisions of that event). This allows you to see the full structure of events, and how they relate to each other.
|
24
|
+
# @param season [Integer] Numeric year from which the event listings are requested. Must be 4 digits
|
25
|
+
# @param [Hash] opts the optional parameters
|
26
|
+
# @option opts [String] :event_code Case insensitive alphanumeric `eventCode` of the event about which details are requested. (default to '0')
|
27
|
+
# @option opts [Integer] :team_number Numeric `teamNumber` of the team from which the attending event listings are requested. (default to 0)
|
28
|
+
# @return [SeasonEventListingsModelVersion2]
|
29
|
+
def v20_season_events_get(season, opts = {})
|
30
|
+
data, _status_code, _headers = v20_season_events_get_with_http_info(season, opts)
|
31
|
+
data
|
32
|
+
end
|
33
|
+
|
34
|
+
# Event Listings
|
35
|
+
# The event listings API returns all FTC official regional events in a particular season. You can specify an `eventCode` if you would only like data about one specific event. If you specify an `eventCode` you cannot specify any other optional parameters. Alternately, you can specify a `teamNumber` to retrieve only the listings of events being attended by the particular team. If you specify a `teamNumber` you cannot specify an `eventCode`. The response for event listings contains a special field called divisionCode. For example, the FIRST Championship contains two Divisions. As an example of a response, the event listings for a Division will have a divisionCode that matches the FIRST Championship event code (as they are divisions of that event). This allows you to see the full structure of events, and how they relate to each other.
|
36
|
+
# @param season [Integer] Numeric year from which the event listings are requested. Must be 4 digits
|
37
|
+
# @param [Hash] opts the optional parameters
|
38
|
+
# @option opts [String] :event_code Case insensitive alphanumeric `eventCode` of the event about which details are requested.
|
39
|
+
# @option opts [Integer] :team_number Numeric `teamNumber` of the team from which the attending event listings are requested.
|
40
|
+
# @return [Array<(SeasonEventListingsModelVersion2, Integer, Hash)>] SeasonEventListingsModelVersion2 data, response status code and response headers
|
41
|
+
def v20_season_events_get_with_http_info(season, opts = {})
|
42
|
+
if @api_client.config.debugging
|
43
|
+
@api_client.config.logger.debug 'Calling API: SeasonDataApi.v20_season_events_get ...'
|
44
|
+
end
|
45
|
+
# verify the required parameter 'season' is set
|
46
|
+
if @api_client.config.client_side_validation && season.nil?
|
47
|
+
fail ArgumentError, "Missing the required parameter 'season' when calling SeasonDataApi.v20_season_events_get"
|
48
|
+
end
|
49
|
+
# resource path
|
50
|
+
local_var_path = '/v2.0/{season}/events'.sub('{' + 'season' + '}', CGI.escape(season.to_s))
|
51
|
+
|
52
|
+
# query parameters
|
53
|
+
query_params = opts[:query_params] || {}
|
54
|
+
query_params[:'eventCode'] = opts[:'event_code'] if !opts[:'event_code'].nil?
|
55
|
+
query_params[:'teamNumber'] = opts[:'team_number'] if !opts[:'team_number'].nil?
|
56
|
+
|
57
|
+
# header parameters
|
58
|
+
header_params = opts[:header_params] || {}
|
59
|
+
# HTTP header 'Accept' (if needed)
|
60
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
61
|
+
|
62
|
+
# form parameters
|
63
|
+
form_params = opts[:form_params] || {}
|
64
|
+
|
65
|
+
# http body (model)
|
66
|
+
post_body = opts[:debug_body]
|
67
|
+
|
68
|
+
# return_type
|
69
|
+
return_type = opts[:debug_return_type] || 'SeasonEventListingsModelVersion2'
|
70
|
+
|
71
|
+
# auth_names
|
72
|
+
auth_names = opts[:debug_auth_names] || ['basic']
|
73
|
+
|
74
|
+
new_options = opts.merge(
|
75
|
+
:operation => :"SeasonDataApi.v20_season_events_get",
|
76
|
+
:header_params => header_params,
|
77
|
+
:query_params => query_params,
|
78
|
+
:form_params => form_params,
|
79
|
+
:body => post_body,
|
80
|
+
:auth_names => auth_names,
|
81
|
+
:return_type => return_type
|
82
|
+
)
|
83
|
+
|
84
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
85
|
+
if @api_client.config.debugging
|
86
|
+
@api_client.config.logger.debug "API called: SeasonDataApi#v20_season_events_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
87
|
+
end
|
88
|
+
return data, status_code, headers
|
89
|
+
end
|
90
|
+
|
91
|
+
# Season Summary
|
92
|
+
# The season summary API returns a high level glance of a particular FTC season.
|
93
|
+
# @param season [Integer] Numeric year of the event from which the season summary is requested. Must be 4 digits.
|
94
|
+
# @param [Hash] opts the optional parameters
|
95
|
+
# @return [SeasonSummaryModelVersion2]
|
96
|
+
def v20_season_get(season, opts = {})
|
97
|
+
data, _status_code, _headers = v20_season_get_with_http_info(season, opts)
|
98
|
+
data
|
99
|
+
end
|
100
|
+
|
101
|
+
# Season Summary
|
102
|
+
# The season summary API returns a high level glance of a particular FTC season.
|
103
|
+
# @param season [Integer] Numeric year of the event from which the season summary is requested. Must be 4 digits.
|
104
|
+
# @param [Hash] opts the optional parameters
|
105
|
+
# @return [Array<(SeasonSummaryModelVersion2, Integer, Hash)>] SeasonSummaryModelVersion2 data, response status code and response headers
|
106
|
+
def v20_season_get_with_http_info(season, opts = {})
|
107
|
+
if @api_client.config.debugging
|
108
|
+
@api_client.config.logger.debug 'Calling API: SeasonDataApi.v20_season_get ...'
|
109
|
+
end
|
110
|
+
# verify the required parameter 'season' is set
|
111
|
+
if @api_client.config.client_side_validation && season.nil?
|
112
|
+
fail ArgumentError, "Missing the required parameter 'season' when calling SeasonDataApi.v20_season_get"
|
113
|
+
end
|
114
|
+
# resource path
|
115
|
+
local_var_path = '/v2.0/{season}'.sub('{' + 'season' + '}', CGI.escape(season.to_s))
|
116
|
+
|
117
|
+
# query parameters
|
118
|
+
query_params = opts[:query_params] || {}
|
119
|
+
|
120
|
+
# header parameters
|
121
|
+
header_params = opts[:header_params] || {}
|
122
|
+
# HTTP header 'Accept' (if needed)
|
123
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
124
|
+
|
125
|
+
# form parameters
|
126
|
+
form_params = opts[:form_params] || {}
|
127
|
+
|
128
|
+
# http body (model)
|
129
|
+
post_body = opts[:debug_body]
|
130
|
+
|
131
|
+
# return_type
|
132
|
+
return_type = opts[:debug_return_type] || 'SeasonSummaryModelVersion2'
|
133
|
+
|
134
|
+
# auth_names
|
135
|
+
auth_names = opts[:debug_auth_names] || ['basic']
|
136
|
+
|
137
|
+
new_options = opts.merge(
|
138
|
+
:operation => :"SeasonDataApi.v20_season_get",
|
139
|
+
:header_params => header_params,
|
140
|
+
:query_params => query_params,
|
141
|
+
:form_params => form_params,
|
142
|
+
:body => post_body,
|
143
|
+
:auth_names => auth_names,
|
144
|
+
:return_type => return_type
|
145
|
+
)
|
146
|
+
|
147
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
148
|
+
if @api_client.config.debugging
|
149
|
+
@api_client.config.logger.debug "API called: SeasonDataApi#v20_season_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
150
|
+
end
|
151
|
+
return data, status_code, headers
|
152
|
+
end
|
153
|
+
|
154
|
+
# Team Listings
|
155
|
+
# The team listings API returns all FTC official teams in a particular season. If specified, the `teamNumber` parameter will return only one result with the details of the requested `teamNumber`. Alternately, the `eventCode` parameter allows sorting of the team list to only those teams attending a particular event in the particular season. If you specify a teamNumber parameter, you cannot additionally specify an `eventCode` and/or `state` in the same request, or you will receive an HTTP 501. If you specify the `state` parameter, it should be the full legal name of the US state or international state/prov, such as New Hampshire or Ontario. Values on this endpoint are \"pass through\" values from the TIMS registration system. As such, if the team does not specify a value for a field, it may be presented in the API as null.
|
156
|
+
# @param season [Integer] Numeric year from which the team listings are requested. Must be 4 digits.
|
157
|
+
# @param [Hash] opts the optional parameters
|
158
|
+
# @option opts [Integer] :team_number Numeric `teamNumber` of the team about which information is requested. Must be 1 to 5 digits. (default to 0)
|
159
|
+
# @option opts [String] :event_code Case insensitive alphanumeric `eventCode` of the event from which details are requested. (default to '0')
|
160
|
+
# @option opts [String] :state Full legal name of the US state or international state/prov (default to '')
|
161
|
+
# @option opts [Integer] :page Numeric page of results to return. (default to 1)
|
162
|
+
# @return [SeasonTeamListingsModelVersion2]
|
163
|
+
def v20_season_teams_get(season, opts = {})
|
164
|
+
data, _status_code, _headers = v20_season_teams_get_with_http_info(season, opts)
|
165
|
+
data
|
166
|
+
end
|
167
|
+
|
168
|
+
# Team Listings
|
169
|
+
# The team listings API returns all FTC official teams in a particular season. If specified, the `teamNumber` parameter will return only one result with the details of the requested `teamNumber`. Alternately, the `eventCode` parameter allows sorting of the team list to only those teams attending a particular event in the particular season. If you specify a teamNumber parameter, you cannot additionally specify an `eventCode` and/or `state` in the same request, or you will receive an HTTP 501. If you specify the `state` parameter, it should be the full legal name of the US state or international state/prov, such as New Hampshire or Ontario. Values on this endpoint are \"pass through\" values from the TIMS registration system. As such, if the team does not specify a value for a field, it may be presented in the API as null.
|
170
|
+
# @param season [Integer] Numeric year from which the team listings are requested. Must be 4 digits.
|
171
|
+
# @param [Hash] opts the optional parameters
|
172
|
+
# @option opts [Integer] :team_number Numeric `teamNumber` of the team about which information is requested. Must be 1 to 5 digits.
|
173
|
+
# @option opts [String] :event_code Case insensitive alphanumeric `eventCode` of the event from which details are requested.
|
174
|
+
# @option opts [String] :state Full legal name of the US state or international state/prov
|
175
|
+
# @option opts [Integer] :page Numeric page of results to return.
|
176
|
+
# @return [Array<(SeasonTeamListingsModelVersion2, Integer, Hash)>] SeasonTeamListingsModelVersion2 data, response status code and response headers
|
177
|
+
def v20_season_teams_get_with_http_info(season, opts = {})
|
178
|
+
if @api_client.config.debugging
|
179
|
+
@api_client.config.logger.debug 'Calling API: SeasonDataApi.v20_season_teams_get ...'
|
180
|
+
end
|
181
|
+
# verify the required parameter 'season' is set
|
182
|
+
if @api_client.config.client_side_validation && season.nil?
|
183
|
+
fail ArgumentError, "Missing the required parameter 'season' when calling SeasonDataApi.v20_season_teams_get"
|
184
|
+
end
|
185
|
+
# resource path
|
186
|
+
local_var_path = '/v2.0/{season}/teams'.sub('{' + 'season' + '}', CGI.escape(season.to_s))
|
187
|
+
|
188
|
+
# query parameters
|
189
|
+
query_params = opts[:query_params] || {}
|
190
|
+
query_params[:'teamNumber'] = opts[:'team_number'] if !opts[:'team_number'].nil?
|
191
|
+
query_params[:'eventCode'] = opts[:'event_code'] if !opts[:'event_code'].nil?
|
192
|
+
query_params[:'state'] = opts[:'state'] if !opts[:'state'].nil?
|
193
|
+
query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
|
194
|
+
|
195
|
+
# header parameters
|
196
|
+
header_params = opts[:header_params] || {}
|
197
|
+
# HTTP header 'Accept' (if needed)
|
198
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
199
|
+
|
200
|
+
# form parameters
|
201
|
+
form_params = opts[:form_params] || {}
|
202
|
+
|
203
|
+
# http body (model)
|
204
|
+
post_body = opts[:debug_body]
|
205
|
+
|
206
|
+
# return_type
|
207
|
+
return_type = opts[:debug_return_type] || 'SeasonTeamListingsModelVersion2'
|
208
|
+
|
209
|
+
# auth_names
|
210
|
+
auth_names = opts[:debug_auth_names] || ['basic']
|
211
|
+
|
212
|
+
new_options = opts.merge(
|
213
|
+
:operation => :"SeasonDataApi.v20_season_teams_get",
|
214
|
+
:header_params => header_params,
|
215
|
+
:query_params => query_params,
|
216
|
+
:form_params => form_params,
|
217
|
+
:body => post_body,
|
218
|
+
:auth_names => auth_names,
|
219
|
+
:return_type => return_type
|
220
|
+
)
|
221
|
+
|
222
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
223
|
+
if @api_client.config.debugging
|
224
|
+
@api_client.config.logger.debug "API called: SeasonDataApi#v20_season_teams_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
225
|
+
end
|
226
|
+
return data, status_code, headers
|
227
|
+
end
|
228
|
+
end
|
229
|
+
end
|
@@ -0,0 +1,390 @@
|
|
1
|
+
=begin
|
2
|
+
#FTC Events API
|
3
|
+
|
4
|
+
#FTC Events API is a service to return relevant information about the _FIRST_ Tech Challenge (FTC). Information is made available from events operating around the world Information is currently made available after the conclusion of the tournament. The API will provide data as soon as it has synced, and we do not add any artificial delays. ## Documentation Notes ### Timezones All times are listed in the local time to the event venue. HTTP-date values will show their timezone. ### Query Parameters If you specify a parameter, but no value for that parameter, it will be ignored. For example, if you request `URL?teamNumber=` the `teamNumber` parameter would be ignored. For all APIs that accept a query string in addition to the base URI, the order of parameters do not matter, but the name shown in the documentation must match exactly, as does the associated value format as described in details. For response codes that are not HTTP 200 (OK), the documentation will show a body message that represents a possible response value. While the \"title\" of the HTTP Status Code will match those shown in the response codes documentation section exactly, the body of the response will be a more detailed explanation of why that status code is being returned and may not always be exactly as shown in the examples. ### Experimenting with the API This documentation is rendered at both [api-docs](https://ftc-events.firstinspires.org/api-docs) and [try-it-out](https://ftc-events.firstinspires.org/try-it-out). [api-docs](https://ftc-events.firstinspires.org/api-docs) has a three panel, easy to read layout, while [try-it-out](https://ftc-events.firstinspires.org/try-it-out) has a feature that allows you try out endpoints from within the page. Additionally, the Open API Json is availabe at [Open API](https://ftc-events.firstinspires.org/swagger/v2.0/swagger.json). This can be imported into a tool such as [Postman](https://www.postman.com) for experimentation as well. ### Last-Modified, FMS-OnlyModifiedSince, and If-Modified-Since Headers The FTC Events API utilizes the `Last-Modified` and `If-Modified-Since` Headers to communicate with consumers regarding the age of the data they are requesting. With a couple of exceptions, all calls will return a `Last-Modified` Header set with the time at which the data at that endpoint was last modified. The Header will always be set in the HTTP-date format, as described in the HTTP Protocol. There are two exceptions: the `Last-Modified` Header is not set if the endpoint returns no results (such as a request for a schedule with no matches). Consumers should keep track of the `Last-Modified` Header, and return it on subsequent calls to the same endpoint as the If-Modified-Since. The server will recognize this request, and will only return a result if the data has been modified since the last request. If no changes have been made, an HTTP 304 will be returned. If data has been modified, ALL data on that call will be returned (for \"only modified\" data, see below). The FTC Events API also allows a custom header used to filter the return data to a specific subset. This is done by specifying a `FMS-OnlyModifiedSince` header with each call. As with the `If-Modified-Since` header, consumers should keep track of the Last-Modified Header, and return it on subsequent calls to the same endpoint as the `FMS-OnlyModifiedSince` Header. The server will recognize this request, and will only return a result if the data has been modified since the last request, and, if returned, the data will only be those portions modified since the included date. If no changes, have been made, an HTTP 304 will be returned. Using this method, the server and consumer save processing time by only receiving modified data that is in need of update on the consumer side. If the Headers are improperly passed (such as the wrong Day of Week for the matching date, or a date in the future), the endpoint will simply ignore the Header and return all results. If both headers are specified, the request will be denied. ## Response Codes The FTC Events API HTTP Status Codes correspond with the [common codes](http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html), but occasionally with different \"titles\". The \"title\" used by the API is shown next to each of the below possible response HTTP Status Codes. Throughout the documentation, Apiary may automatically show the common \"title\" in example returns (like \"Not Found\" for 404) but on the production server, the \"title\" will instead match those listed below. ### HTTP 200 - \"OK\" The request has succeeded. An entity corresponding to the requested resource is sent in the response. This will be returned as the HTTP Status Code for all request that succeed, even if the body is empty (such as an event that has no rankings, but with a valid season and event code were used) ### HTTP 304 - \"Not Modified\" When utilizing a Header that allows filtered data returns, such as `If-Modified-Since`, this response indicates that no data meets the request. ### HTTP 400 - \"Invalid Season Requested\"/\"Malformed Parameter Format In Request\"/\"Missing Parameter In Request\"/\"Invalid API Version Requested\": The request could not be understood by the server due to malformed syntax. The client SHOULD NOT repeat the request without modifications. Specifically for this API, a 400 response indicates that the requested URI matches with a valid API, but one or more required parameter was malformed or invalid. Examples include an event code that is too short or team number that contains a letter. ### HTTP 401 - \"Unauthorized\" All requests against the API require authentication via a valid user token. Failing to provide one, or providing an invalid one, will warrant a 401 response. The client MAY repeat the request with a suitable Authorization header field. ### HTTP 404 - \"Invalid Event Requested\" Even though the 404 code usually indicates any not found status, a 404 will only be issued in this API when an event cannot be found for the requested season and event code. If the request didn't match a valid API or there were malformed parameters, the response would not receive a 404 but rather a 400 or 501. If this HTTP code is received, the season was a valid season and the event code matched the acceptable style of an event code, but there were no records of an event matching the combination of that season and event code. For example, HTTP 404 would be issued when the event had a different code in the requested season (the codes can change year to year based on event location). ### HTTP 500 - \"Internal Server Error\" The server encountered an unexpected condition which prevented it from fulfilling the request. This is a code sent directly by the server, and has no special alternate definition specific to this API. ### HTTP 501 - \"Request Did Not Match Any Current API Pattern\" The server does not support the functionality required to fulfill the request. Specifically, the request pattern did not match any of the possible APIs, and thus processing was discontinued. This code is also issued when too many optional parameters were included in a single request and fulfilling it would make the result confusing or misleading. Each API will specify which parameters or combination of parameters can be used at the same time. ### HTTP 503 - \"Service Unavailable\" The server is currently unable to handle the request due to a temporary overloading or maintenance of the server. The implication is that this is a temporary condition which will be alleviated after some delay. If known, the length of the delay MAY be indicated in a `Retry-After` header. This code will not always appear, sometimes the server may outright refuse the connection instead. This is a code sent directly by the server, and has no special alternate definition specific to this API. ## Authorization In order to make calls against the FTC Events API, you must include an HTTP Header called `Authorization` with the value set as specified below. If a request is made without this header, processing stops and an HTTP 401 is issued. All `Authorization` headers follow the same format: ``` Authorization: Basic 000000000000000000000000000000000000000000000000000000000000 ``` Where the Zeros are replaced by your Token. The Token can be formed by taking your username and your AuthorizationKey and adding a colon. For example, if your username is `sampleuser` and your AuthorizationKey is `7eaa6338-a097-4221-ac04-b6120fcc4d49` you would have this string: ``` sampleuser:7eaa6338-a097-4221-ac04-b6120fcc4d49 ``` This string must then be encoded using Base64 Encoded to form the Token, which will be the same length as the example above, but include letters and numbers. For our example, we would have: ``` c2FtcGxldXNlcjo3ZWFhNjMzOC1hMDk3LTQyMjEtYWMwNC1iNjEyMGZjYzRkNDk= ``` Most API client libraries can handle computing the authorization header using a username and password for you NOTICE: Publicly distributing an application, code snippet, etc, that has your username and token in it, encoded or not, WILL result in your token being blocked from the API. Each user should apply for their own token. If you wish to acquire a token for your development, you may do so by requesting a token through our automated system on this website.
|
5
|
+
|
6
|
+
The version of the OpenAPI document: v2.0
|
7
|
+
|
8
|
+
Generated by: https://openapi-generator.tech
|
9
|
+
OpenAPI Generator version: 5.0.0-SNAPSHOT
|
10
|
+
|
11
|
+
=end
|
12
|
+
|
13
|
+
require 'date'
|
14
|
+
require 'json'
|
15
|
+
require 'logger'
|
16
|
+
require 'tempfile'
|
17
|
+
require 'time'
|
18
|
+
require 'typhoeus'
|
19
|
+
|
20
|
+
module FtcEventsClient
|
21
|
+
class ApiClient
|
22
|
+
# The Configuration object holding settings to be used in the API client.
|
23
|
+
attr_accessor :config
|
24
|
+
|
25
|
+
# Defines the headers to be used in HTTP requests of all API calls by default.
|
26
|
+
#
|
27
|
+
# @return [Hash]
|
28
|
+
attr_accessor :default_headers
|
29
|
+
|
30
|
+
# Initializes the ApiClient
|
31
|
+
# @option config [Configuration] Configuration for initializing the object, default to Configuration.default
|
32
|
+
def initialize(config = Configuration.default)
|
33
|
+
@config = config
|
34
|
+
@user_agent = "OpenAPI-Generator/#{VERSION}/ruby"
|
35
|
+
@default_headers = {
|
36
|
+
'Content-Type' => 'application/json',
|
37
|
+
'User-Agent' => @user_agent
|
38
|
+
}
|
39
|
+
end
|
40
|
+
|
41
|
+
def self.default
|
42
|
+
@@default ||= ApiClient.new
|
43
|
+
end
|
44
|
+
|
45
|
+
# Call an API with given options.
|
46
|
+
#
|
47
|
+
# @return [Array<(Object, Integer, Hash)>] an array of 3 elements:
|
48
|
+
# the data deserialized from response body (could be nil), response status code and response headers.
|
49
|
+
def call_api(http_method, path, opts = {})
|
50
|
+
request = build_request(http_method, path, opts)
|
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]
|
73
|
+
data = deserialize(response, opts[:return_type])
|
74
|
+
else
|
75
|
+
data = nil
|
76
|
+
end
|
77
|
+
return data, response.code, response.headers
|
78
|
+
end
|
79
|
+
|
80
|
+
# Builds the HTTP request
|
81
|
+
#
|
82
|
+
# @param [String] http_method HTTP method/verb (e.g. POST)
|
83
|
+
# @param [String] path URL path (e.g. /account/new)
|
84
|
+
# @option opts [Hash] :header_params Header parameters
|
85
|
+
# @option opts [Hash] :query_params Query parameters
|
86
|
+
# @option opts [Hash] :form_params Query parameters
|
87
|
+
# @option opts [Object] :body HTTP body (JSON/XML)
|
88
|
+
# @return [Typhoeus::Request] A Typhoeus Request
|
89
|
+
def build_request(http_method, path, opts = {})
|
90
|
+
url = build_request_url(path, opts)
|
91
|
+
http_method = http_method.to_sym.downcase
|
92
|
+
|
93
|
+
header_params = @default_headers.merge(opts[:header_params] || {})
|
94
|
+
query_params = opts[:query_params] || {}
|
95
|
+
form_params = opts[:form_params] || {}
|
96
|
+
|
97
|
+
update_params_for_auth! header_params, query_params, opts[:auth_names]
|
98
|
+
|
99
|
+
# set ssl_verifyhosts option based on @config.verify_ssl_host (true/false)
|
100
|
+
_verify_ssl_host = @config.verify_ssl_host ? 2 : 0
|
101
|
+
|
102
|
+
req_opts = {
|
103
|
+
:method => http_method,
|
104
|
+
:headers => header_params,
|
105
|
+
:params => query_params,
|
106
|
+
:params_encoding => @config.params_encoding,
|
107
|
+
:timeout => @config.timeout,
|
108
|
+
:ssl_verifypeer => @config.verify_ssl,
|
109
|
+
:ssl_verifyhost => _verify_ssl_host,
|
110
|
+
:sslcert => @config.cert_file,
|
111
|
+
:sslkey => @config.key_file,
|
112
|
+
:verbose => @config.debugging
|
113
|
+
}
|
114
|
+
|
115
|
+
# set custom cert, if provided
|
116
|
+
req_opts[:cainfo] = @config.ssl_ca_cert if @config.ssl_ca_cert
|
117
|
+
|
118
|
+
if [:post, :patch, :put, :delete].include?(http_method)
|
119
|
+
req_body = build_request_body(header_params, form_params, opts[:body])
|
120
|
+
req_opts.update :body => req_body
|
121
|
+
if @config.debugging
|
122
|
+
@config.logger.debug "HTTP request body param ~BEGIN~\n#{req_body}\n~END~\n"
|
123
|
+
end
|
124
|
+
end
|
125
|
+
|
126
|
+
request = Typhoeus::Request.new(url, req_opts)
|
127
|
+
download_file(request) if opts[:return_type] == 'File'
|
128
|
+
request
|
129
|
+
end
|
130
|
+
|
131
|
+
# Builds the HTTP request body
|
132
|
+
#
|
133
|
+
# @param [Hash] header_params Header parameters
|
134
|
+
# @param [Hash] form_params Query parameters
|
135
|
+
# @param [Object] body HTTP body (JSON/XML)
|
136
|
+
# @return [String] HTTP body data in the form of string
|
137
|
+
def build_request_body(header_params, form_params, body)
|
138
|
+
# http form
|
139
|
+
if header_params['Content-Type'] == 'application/x-www-form-urlencoded' ||
|
140
|
+
header_params['Content-Type'] == 'multipart/form-data'
|
141
|
+
data = {}
|
142
|
+
form_params.each do |key, value|
|
143
|
+
case value
|
144
|
+
when ::File, ::Array, nil
|
145
|
+
# let typhoeus handle File, Array and nil parameters
|
146
|
+
data[key] = value
|
147
|
+
else
|
148
|
+
data[key] = value.to_s
|
149
|
+
end
|
150
|
+
end
|
151
|
+
elsif body
|
152
|
+
data = body.is_a?(String) ? body : body.to_json
|
153
|
+
else
|
154
|
+
data = nil
|
155
|
+
end
|
156
|
+
data
|
157
|
+
end
|
158
|
+
|
159
|
+
# Save response body into a file in (the defined) temporary folder, using the filename
|
160
|
+
# from the "Content-Disposition" header if provided, otherwise a random filename.
|
161
|
+
# The response body is written to the file in chunks in order to handle files which
|
162
|
+
# size is larger than maximum Ruby String or even larger than the maximum memory a Ruby
|
163
|
+
# process can use.
|
164
|
+
#
|
165
|
+
# @see Configuration#temp_folder_path
|
166
|
+
def download_file(request)
|
167
|
+
tempfile = nil
|
168
|
+
encoding = nil
|
169
|
+
request.on_headers do |response|
|
170
|
+
content_disposition = response.headers['Content-Disposition']
|
171
|
+
if content_disposition && content_disposition =~ /filename=/i
|
172
|
+
filename = content_disposition[/filename=['"]?([^'"\s]+)['"]?/, 1]
|
173
|
+
prefix = sanitize_filename(filename)
|
174
|
+
else
|
175
|
+
prefix = 'download-'
|
176
|
+
end
|
177
|
+
prefix = prefix + '-' unless prefix.end_with?('-')
|
178
|
+
encoding = response.body.encoding
|
179
|
+
tempfile = Tempfile.open(prefix, @config.temp_folder_path, encoding: encoding)
|
180
|
+
@tempfile = tempfile
|
181
|
+
end
|
182
|
+
request.on_body do |chunk|
|
183
|
+
chunk.force_encoding(encoding)
|
184
|
+
tempfile.write(chunk)
|
185
|
+
end
|
186
|
+
request.on_complete do |response|
|
187
|
+
if tempfile
|
188
|
+
tempfile.close
|
189
|
+
@config.logger.info "Temp file written to #{tempfile.path}, please copy the file to a proper folder "\
|
190
|
+
"with e.g. `FileUtils.cp(tempfile.path, '/new/file/path')` otherwise the temp file "\
|
191
|
+
"will be deleted automatically with GC. It's also recommended to delete the temp file "\
|
192
|
+
"explicitly with `tempfile.delete`"
|
193
|
+
end
|
194
|
+
end
|
195
|
+
end
|
196
|
+
|
197
|
+
# Check if the given MIME is a JSON MIME.
|
198
|
+
# JSON MIME examples:
|
199
|
+
# application/json
|
200
|
+
# application/json; charset=UTF8
|
201
|
+
# APPLICATION/JSON
|
202
|
+
# */*
|
203
|
+
# @param [String] mime MIME
|
204
|
+
# @return [Boolean] True if the MIME is application/json
|
205
|
+
def json_mime?(mime)
|
206
|
+
(mime == '*/*') || !(mime =~ /Application\/.*json(?!p)(;.*)?/i).nil?
|
207
|
+
end
|
208
|
+
|
209
|
+
# Deserialize the response to the given return type.
|
210
|
+
#
|
211
|
+
# @param [Response] response HTTP response
|
212
|
+
# @param [String] return_type some examples: "User", "Array<User>", "Hash<String, Integer>"
|
213
|
+
def deserialize(response, return_type)
|
214
|
+
body = response.body
|
215
|
+
|
216
|
+
# handle file downloading - return the File instance processed in request callbacks
|
217
|
+
# note that response body is empty when the file is written in chunks in request on_body callback
|
218
|
+
return @tempfile if return_type == 'File'
|
219
|
+
|
220
|
+
return nil if body.nil? || body.empty?
|
221
|
+
|
222
|
+
# return response body directly for String return type
|
223
|
+
return body if return_type == 'String'
|
224
|
+
|
225
|
+
# ensuring a default content type
|
226
|
+
content_type = response.headers['Content-Type'] || 'application/json'
|
227
|
+
|
228
|
+
fail "Content-Type is not supported: #{content_type}" unless json_mime?(content_type)
|
229
|
+
|
230
|
+
begin
|
231
|
+
data = JSON.parse("[#{body}]", :symbolize_names => true)[0]
|
232
|
+
rescue JSON::ParserError => e
|
233
|
+
if %w(String Date Time).include?(return_type)
|
234
|
+
data = body
|
235
|
+
else
|
236
|
+
raise e
|
237
|
+
end
|
238
|
+
end
|
239
|
+
|
240
|
+
convert_to_type data, return_type
|
241
|
+
end
|
242
|
+
|
243
|
+
# Convert data to the given return type.
|
244
|
+
# @param [Object] data Data to be converted
|
245
|
+
# @param [String] return_type Return type
|
246
|
+
# @return [Mixed] Data in a particular type
|
247
|
+
def convert_to_type(data, return_type)
|
248
|
+
return nil if data.nil?
|
249
|
+
case return_type
|
250
|
+
when 'String'
|
251
|
+
data.to_s
|
252
|
+
when 'Integer'
|
253
|
+
data.to_i
|
254
|
+
when 'Float'
|
255
|
+
data.to_f
|
256
|
+
when 'Boolean'
|
257
|
+
data == true
|
258
|
+
when 'Time'
|
259
|
+
# parse date time (expecting ISO 8601 format)
|
260
|
+
Time.parse data
|
261
|
+
when 'Date'
|
262
|
+
# parse date time (expecting ISO 8601 format)
|
263
|
+
Date.parse data
|
264
|
+
when 'Object'
|
265
|
+
# generic object (usually a Hash), return directly
|
266
|
+
data
|
267
|
+
when /\AArray<(.+)>\z/
|
268
|
+
# e.g. Array<Pet>
|
269
|
+
sub_type = $1
|
270
|
+
data.map { |item| convert_to_type(item, sub_type) }
|
271
|
+
when /\AHash\<String, (.+)\>\z/
|
272
|
+
# e.g. Hash<String, Integer>
|
273
|
+
sub_type = $1
|
274
|
+
{}.tap do |hash|
|
275
|
+
data.each { |k, v| hash[k] = convert_to_type(v, sub_type) }
|
276
|
+
end
|
277
|
+
else
|
278
|
+
# models (e.g. Pet) or oneOf
|
279
|
+
klass = FtcEventsClient.const_get(return_type)
|
280
|
+
klass.respond_to?(:openapi_one_of) ? klass.build(data) : klass.build_from_hash(data)
|
281
|
+
end
|
282
|
+
end
|
283
|
+
|
284
|
+
# Sanitize filename by removing path.
|
285
|
+
# e.g. ../../sun.gif becomes sun.gif
|
286
|
+
#
|
287
|
+
# @param [String] filename the filename to be sanitized
|
288
|
+
# @return [String] the sanitized filename
|
289
|
+
def sanitize_filename(filename)
|
290
|
+
filename.gsub(/.*[\/\\]/, '')
|
291
|
+
end
|
292
|
+
|
293
|
+
def build_request_url(path, opts = {})
|
294
|
+
# Add leading and trailing slashes to path
|
295
|
+
path = "/#{path}".gsub(/\/+/, '/')
|
296
|
+
@config.base_url(opts[:operation]) + path
|
297
|
+
end
|
298
|
+
|
299
|
+
# Update hearder and query params based on authentication settings.
|
300
|
+
#
|
301
|
+
# @param [Hash] header_params Header parameters
|
302
|
+
# @param [Hash] query_params Query parameters
|
303
|
+
# @param [String] auth_names Authentication scheme name
|
304
|
+
def update_params_for_auth!(header_params, query_params, auth_names)
|
305
|
+
Array(auth_names).each do |auth_name|
|
306
|
+
auth_setting = @config.auth_settings[auth_name]
|
307
|
+
next unless auth_setting
|
308
|
+
case auth_setting[:in]
|
309
|
+
when 'header' then header_params[auth_setting[:key]] = auth_setting[:value]
|
310
|
+
when 'query' then query_params[auth_setting[:key]] = auth_setting[:value]
|
311
|
+
else fail ArgumentError, 'Authentication token must be in `query` of `header`'
|
312
|
+
end
|
313
|
+
end
|
314
|
+
end
|
315
|
+
|
316
|
+
# Sets user agent in HTTP header
|
317
|
+
#
|
318
|
+
# @param [String] user_agent User agent (e.g. openapi-generator/ruby/1.0.0)
|
319
|
+
def user_agent=(user_agent)
|
320
|
+
@user_agent = user_agent
|
321
|
+
@default_headers['User-Agent'] = @user_agent
|
322
|
+
end
|
323
|
+
|
324
|
+
# Return Accept header based on an array of accepts provided.
|
325
|
+
# @param [Array] accepts array for Accept
|
326
|
+
# @return [String] the Accept header (e.g. application/json)
|
327
|
+
def select_header_accept(accepts)
|
328
|
+
return nil if accepts.nil? || accepts.empty?
|
329
|
+
# use JSON when present, otherwise use all of the provided
|
330
|
+
json_accept = accepts.find { |s| json_mime?(s) }
|
331
|
+
json_accept || accepts.join(',')
|
332
|
+
end
|
333
|
+
|
334
|
+
# Return Content-Type header based on an array of content types provided.
|
335
|
+
# @param [Array] content_types array for Content-Type
|
336
|
+
# @return [String] the Content-Type header (e.g. application/json)
|
337
|
+
def select_header_content_type(content_types)
|
338
|
+
# use application/json by default
|
339
|
+
return 'application/json' if content_types.nil? || content_types.empty?
|
340
|
+
# use JSON when present, otherwise use the first one
|
341
|
+
json_content_type = content_types.find { |s| json_mime?(s) }
|
342
|
+
json_content_type || content_types.first
|
343
|
+
end
|
344
|
+
|
345
|
+
# Convert object (array, hash, object, etc) to JSON string.
|
346
|
+
# @param [Object] model object to be converted into JSON string
|
347
|
+
# @return [String] JSON string representation of the object
|
348
|
+
def object_to_http_body(model)
|
349
|
+
return model if model.nil? || model.is_a?(String)
|
350
|
+
local_body = nil
|
351
|
+
if model.is_a?(Array)
|
352
|
+
local_body = model.map { |m| object_to_hash(m) }
|
353
|
+
else
|
354
|
+
local_body = object_to_hash(model)
|
355
|
+
end
|
356
|
+
local_body.to_json
|
357
|
+
end
|
358
|
+
|
359
|
+
# Convert object(non-array) to hash.
|
360
|
+
# @param [Object] obj object to be converted into JSON string
|
361
|
+
# @return [String] JSON string representation of the object
|
362
|
+
def object_to_hash(obj)
|
363
|
+
if obj.respond_to?(:to_hash)
|
364
|
+
obj.to_hash
|
365
|
+
else
|
366
|
+
obj
|
367
|
+
end
|
368
|
+
end
|
369
|
+
|
370
|
+
# Build parameter value according to the given collection format.
|
371
|
+
# @param [String] collection_format one of :csv, :ssv, :tsv, :pipes and :multi
|
372
|
+
def build_collection_param(param, collection_format)
|
373
|
+
case collection_format
|
374
|
+
when :csv
|
375
|
+
param.join(',')
|
376
|
+
when :ssv
|
377
|
+
param.join(' ')
|
378
|
+
when :tsv
|
379
|
+
param.join("\t")
|
380
|
+
when :pipes
|
381
|
+
param.join('|')
|
382
|
+
when :multi
|
383
|
+
# return the array directly as typhoeus will handle it as expected
|
384
|
+
param
|
385
|
+
else
|
386
|
+
fail "unknown collection format: #{collection_format.inspect}"
|
387
|
+
end
|
388
|
+
end
|
389
|
+
end
|
390
|
+
end
|