ftc_api_v3_client 0.1.0

data/docs/SeasonsApi.md

@@ -0,0 +1,148 @@
+# FtcApiV3Client::SeasonsApi
+
+All URIs are relative to *https://ftc-api.firstinspires.org*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**get_season**](SeasonsApi.md#get_season) | **GET** /api/v3/seasons/{cmpYear} | Get single FTC season |
+| [**list_seasons**](SeasonsApi.md#list_seasons) | **GET** /api/v3/seasons | List all FTC seasons |
+
+
+## get_season
+
+> <ApiV3Season> get_season(cmp_year)
+
+Get single FTC season
+
+Lists basic information about the given FTC season
+
+### Examples
+
+```ruby
+require 'time'
+require 'ftc_api_v3_client'
+# setup authorization
+FtcApiV3Client.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['api_key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['api_key'] = 'Bearer'
+end
+
+api_instance = FtcApiV3Client::SeasonsApi.new
+cmp_year = 'cmp_year_example' # String | The year of the FIRST Championship for the requested season
+
+begin
+  # Get single FTC season
+  result = api_instance.get_season(cmp_year)
+  p result
+rescue FtcApiV3Client::ApiError => e
+  puts "Error when calling SeasonsApi->get_season: #{e}"
+end
+```
+
+#### Using the get_season_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ApiV3Season>, Integer, Hash)> get_season_with_http_info(cmp_year)
+
+```ruby
+begin
+  # Get single FTC season
+  data, status_code, headers = api_instance.get_season_with_http_info(cmp_year)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ApiV3Season>
+rescue FtcApiV3Client::ApiError => e
+  puts "Error when calling SeasonsApi->get_season_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **cmp_year** | **String** | The year of the FIRST Championship for the requested season |  |
+
+### Return type
+
+[**ApiV3Season**](ApiV3Season.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list_seasons
+
+> <ApiV3Seasons> list_seasons
+
+List all FTC seasons
+
+Lists basic information about all FTC seasons with data available through this API
+
+### Examples
+
+```ruby
+require 'time'
+require 'ftc_api_v3_client'
+# setup authorization
+FtcApiV3Client.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['api_key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['api_key'] = 'Bearer'
+end
+
+api_instance = FtcApiV3Client::SeasonsApi.new
+
+begin
+  # List all FTC seasons
+  result = api_instance.list_seasons
+  p result
+rescue FtcApiV3Client::ApiError => e
+  puts "Error when calling SeasonsApi->list_seasons: #{e}"
+end
+```
+
+#### Using the list_seasons_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ApiV3Seasons>, Integer, Hash)> list_seasons_with_http_info
+
+```ruby
+begin
+  # List all FTC seasons
+  data, status_code, headers = api_instance.list_seasons_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ApiV3Seasons>
+rescue FtcApiV3Client::ApiError => e
+  puts "Error when calling SeasonsApi->list_seasons_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**ApiV3Seasons**](ApiV3Seasons.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/TeamsApi.md

@@ -0,0 +1,371 @@
+# FtcApiV3Client::TeamsApi
+
+All URIs are relative to *https://ftc-api.firstinspires.org*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**get_team**](TeamsApi.md#get_team) | **GET** /api/v3/seasons/{cmpYear}/teams/{number} | Get teams information |
+| [**get_team_details**](TeamsApi.md#get_team_details) | **GET** /api/v3/seasons/{cmpYear}/teams/{number}/details | Get detailed team information |
+| [**get_team_history**](TeamsApi.md#get_team_history) | **GET** /api/v3/teams/{number} | Get team history |
+| [**list_team_avatars**](TeamsApi.md#list_team_avatars) | **GET** /api/v3/seasons/{cmpYear}/avatars | List team avatars for a season |
+| [**list_teams**](TeamsApi.md#list_teams) | **GET** /api/v3/seasons/{cmpYear}/teams | List teams for a season |
+
+
+## get_team
+
+> <ApiV3Team> get_team(cmp_year, number)
+
+Get teams information
+
+Get information for a specific team. If a team's number changed during the season, this endpoint can be called with the old number and it will return the new one.
+
+### Examples
+
+```ruby
+require 'time'
+require 'ftc_api_v3_client'
+# setup authorization
+FtcApiV3Client.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['api_key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['api_key'] = 'Bearer'
+end
+
+api_instance = FtcApiV3Client::TeamsApi.new
+cmp_year = 'cmp_year_example' # String | The year of the FIRST Championship for the requested season
+number = 'number_example' # String | The team's number
+
+begin
+  # Get teams information
+  result = api_instance.get_team(cmp_year, number)
+  p result
+rescue FtcApiV3Client::ApiError => e
+  puts "Error when calling TeamsApi->get_team: #{e}"
+end
+```
+
+#### Using the get_team_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ApiV3Team>, Integer, Hash)> get_team_with_http_info(cmp_year, number)
+
+```ruby
+begin
+  # Get teams information
+  data, status_code, headers = api_instance.get_team_with_http_info(cmp_year, number)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ApiV3Team>
+rescue FtcApiV3Client::ApiError => e
+  puts "Error when calling TeamsApi->get_team_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **cmp_year** | **String** | The year of the FIRST Championship for the requested season |  |
+| **number** | **String** | The team&#39;s number |  |
+
+### Return type
+
+[**ApiV3Team**](ApiV3Team.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_team_details
+
+> <ApiV3TeamDetails> get_team_details(cmp_year, number)
+
+Get detailed team information
+
+Get detailed information for a specific team. Includes all awards, events, matches, and leagues. If a team's number changed during the season, this endpoint can be called with the old number and it will return the new one.
+
+### Examples
+
+```ruby
+require 'time'
+require 'ftc_api_v3_client'
+# setup authorization
+FtcApiV3Client.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['api_key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['api_key'] = 'Bearer'
+end
+
+api_instance = FtcApiV3Client::TeamsApi.new
+cmp_year = 'cmp_year_example' # String | The year of the FIRST Championship for the requested season
+number = 'number_example' # String | The team's number
+
+begin
+  # Get detailed team information
+  result = api_instance.get_team_details(cmp_year, number)
+  p result
+rescue FtcApiV3Client::ApiError => e
+  puts "Error when calling TeamsApi->get_team_details: #{e}"
+end
+```
+
+#### Using the get_team_details_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ApiV3TeamDetails>, Integer, Hash)> get_team_details_with_http_info(cmp_year, number)
+
+```ruby
+begin
+  # Get detailed team information
+  data, status_code, headers = api_instance.get_team_details_with_http_info(cmp_year, number)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ApiV3TeamDetails>
+rescue FtcApiV3Client::ApiError => e
+  puts "Error when calling TeamsApi->get_team_details_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **cmp_year** | **String** | The year of the FIRST Championship for the requested season |  |
+| **number** | **String** | The team&#39;s number |  |
+
+### Return type
+
+[**ApiV3TeamDetails**](ApiV3TeamDetails.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_team_history
+
+> <ApiV3TeamHistory> get_team_history(number)
+
+Get team history
+
+Get cross-season history for a specific team number. General information will be from the last season the team competed in.
+
+### Examples
+
+```ruby
+require 'time'
+require 'ftc_api_v3_client'
+# setup authorization
+FtcApiV3Client.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['api_key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['api_key'] = 'Bearer'
+end
+
+api_instance = FtcApiV3Client::TeamsApi.new
+number = 'number_example' # String | The team's number
+
+begin
+  # Get team history
+  result = api_instance.get_team_history(number)
+  p result
+rescue FtcApiV3Client::ApiError => e
+  puts "Error when calling TeamsApi->get_team_history: #{e}"
+end
+```
+
+#### Using the get_team_history_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ApiV3TeamHistory>, Integer, Hash)> get_team_history_with_http_info(number)
+
+```ruby
+begin
+  # Get team history
+  data, status_code, headers = api_instance.get_team_history_with_http_info(number)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ApiV3TeamHistory>
+rescue FtcApiV3Client::ApiError => e
+  puts "Error when calling TeamsApi->get_team_history_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **number** | **String** | The team&#39;s number |  |
+
+### Return type
+
+[**ApiV3TeamHistory**](ApiV3TeamHistory.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list_team_avatars
+
+> <ApiV3TeamAvatars> list_team_avatars(cmp_year)
+
+List team avatars for a season
+
+Lists all current team avatars for a season. If all you need is to display avatars with the standard FIRST fallback and scaling, directly link `/avatars/composed/{cmpYear}.css` instead of using this endpoint. Use a div with the classes `team-avatar` and `team-{number}` to display the avatar. Use the css variable `--avatar-size` to control the size of the avatar in px (defaults to 40).
+
+### Examples
+
+```ruby
+require 'time'
+require 'ftc_api_v3_client'
+# setup authorization
+FtcApiV3Client.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['api_key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['api_key'] = 'Bearer'
+end
+
+api_instance = FtcApiV3Client::TeamsApi.new
+cmp_year = 'cmp_year_example' # String | The year of the FIRST Championship for the requested season
+
+begin
+  # List team avatars for a season
+  result = api_instance.list_team_avatars(cmp_year)
+  p result
+rescue FtcApiV3Client::ApiError => e
+  puts "Error when calling TeamsApi->list_team_avatars: #{e}"
+end
+```
+
+#### Using the list_team_avatars_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ApiV3TeamAvatars>, Integer, Hash)> list_team_avatars_with_http_info(cmp_year)
+
+```ruby
+begin
+  # List team avatars for a season
+  data, status_code, headers = api_instance.list_team_avatars_with_http_info(cmp_year)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ApiV3TeamAvatars>
+rescue FtcApiV3Client::ApiError => e
+  puts "Error when calling TeamsApi->list_team_avatars_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **cmp_year** | **String** | The year of the FIRST Championship for the requested season |  |
+
+### Return type
+
+[**ApiV3TeamAvatars**](ApiV3TeamAvatars.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list_teams
+
+> <ApiV3Teams> list_teams(cmp_year)
+
+List teams for a season
+
+Lists all registered teams for the given FTC season. In some cases, teams with incomplete registrations may be included in event results but not returned in this list. Use the event's team list for that information if necessary.
+
+### Examples
+
+```ruby
+require 'time'
+require 'ftc_api_v3_client'
+# setup authorization
+FtcApiV3Client.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['api_key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['api_key'] = 'Bearer'
+end
+
+api_instance = FtcApiV3Client::TeamsApi.new
+cmp_year = 'cmp_year_example' # String | The year of the FIRST Championship for the requested season
+
+begin
+  # List teams for a season
+  result = api_instance.list_teams(cmp_year)
+  p result
+rescue FtcApiV3Client::ApiError => e
+  puts "Error when calling TeamsApi->list_teams: #{e}"
+end
+```
+
+#### Using the list_teams_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ApiV3Teams>, Integer, Hash)> list_teams_with_http_info(cmp_year)
+
+```ruby
+begin
+  # List teams for a season
+  data, status_code, headers = api_instance.list_teams_with_http_info(cmp_year)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ApiV3Teams>
+rescue FtcApiV3Client::ApiError => e
+  puts "Error when calling TeamsApi->list_teams_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **cmp_year** | **String** | The year of the FIRST Championship for the requested season |  |
+
+### Return type
+
+[**ApiV3Teams**](ApiV3Teams.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/ftc_api_v3_client.gemspec

@@ -0,0 +1,39 @@
+# -*- encoding: utf-8 -*-
+
+=begin
+#FTC Scoring Data API
+
+#THIS API IS CURRENTLY IN EARLY DEVELOPMENT AND MAY CHANGE WITHOUT WARNING. THIS PAGE WILL BE UPDATED ONCE THE API IS OFFICIALLY RELEASED.  This API provides event and scoring data for FIRST Tech Challenge. Applications that present result data directly are encouraged to directly call this API rather than maintaining their own copies of the data. All endpoints are cached by our CDN and may return data up to one hour old for data that changes infrequently. During an event, data that changes frequently (e.g. match results and rankings) should not be more than 30 seconds old.  NOTE: For developers who have integrated with the v2 API in the past, this is a policy shift, as previously developers were encouraged to maintain their own copy of relevant data. In the interest of providing the community with the most up-to-date data and reducing the burden for applications that are not performing their own analytics on event data, we are now encouraging directly integrating our API into websites and apps.  Also note that all endpoints that accept a year argument now expect the year in which the FIRST Championship for that season is held. This is a change from the previous API and FTC-events website, which used the kickoff year.  To report any issues, please report an issue here: https://github.com/FIRST-Tech-Challenge/scorekeeper/issues/new?template=api-bug-report.md To request additional data, please submit a feature request here: https://github.com/FIRST-Tech-Challenge/scorekeeper/issues/new?template=api-feature-request.md 
+
+The version of the OpenAPI document: v3
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.20.0
+
+=end
+
+$:.push File.expand_path("../lib", __FILE__)
+require "ftc_api_v3_client/version"
+
+Gem::Specification.new do |s|
+  s.name        = "ftc_api_v3_client"
+  s.version     = FtcApiV3Client::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["OpenAPI-Generator"]
+  s.email       = [""]
+  s.homepage    = "https://github.com/maths22/ftc-api-v3-client-ruby"
+  s.summary     = "FTC Scoring Data API Ruby Gem"
+  s.description = "API Client for the FTC API (v3)"
+  s.license     = "Unlicense"
+  s.required_ruby_version = ">= 3.1"
+  s.metadata    = {}
+
+  s.add_runtime_dependency 'typhoeus', '~> 1.0', '>= 1.0.1'
+
+  s.add_development_dependency 'rspec', '~> 3.6', '>= 3.6.0'
+
+  s.files         = `find *`.split("\n").uniq.sort.select { |f| !f.empty? }
+  s.test_files    = `find spec/*`.split("\n")
+  s.executables   = []
+  s.require_paths = ["lib"]
+end

data/git_push.sh

@@ -0,0 +1,57 @@
+#!/bin/sh
+# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/
+#
+# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com"
+
+git_user_id=$1
+git_repo_id=$2
+release_note=$3
+git_host=$4
+
+if [ "$git_host" = "" ]; then
+    git_host="github.com"
+    echo "[INFO] No command line input provided. Set \$git_host to $git_host"
+fi
+
+if [ "$git_user_id" = "" ]; then
+    git_user_id="GIT_USER_ID"
+    echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id"
+fi
+
+if [ "$git_repo_id" = "" ]; then
+    git_repo_id="GIT_REPO_ID"
+    echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id"
+fi
+
+if [ "$release_note" = "" ]; then
+    release_note="Minor update"
+    echo "[INFO] No command line input provided. Set \$release_note to $release_note"
+fi
+
+# Initialize the local directory as a Git repository
+git init
+
+# Adds the files in the local repository and stages them for commit.
+git add .
+
+# Commits the tracked changes and prepares them to be pushed to a remote repository.
+git commit -m "$release_note"
+
+# Sets the new remote
+git_remote=$(git remote)
+if [ "$git_remote" = "" ]; then # git remote not defined
+
+    if [ "$GIT_TOKEN" = "" ]; then
+        echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment."
+        git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git
+    else
+        git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git
+    fi
+
+fi
+
+git pull origin master
+
+# Pushes (Forces) the changes in the local repository up to the remote repository
+echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git"
+git push origin master 2>&1 | grep -v 'To https'