lishogi 0.1.0

data/spec/api/bot_api_spec.rb

@@ -0,0 +1,144 @@
+=begin
+#Lishogi.org API reference
+
+## Introduction Welcome to the reference for the Lishogi API! Lishogi is free/libre, open-source shogi server forked from lichess powered by volunteers and donations.  Currently this page is a work in progress, certain information here might be wrong and incorrect! Expect it to be done during 2022. - Get help in the [Lishogi Discord channel](https://discord.gg/YFtpMGg3rR) - [Contribute to this documentation on Github](https://github.com/WandererXII/lishogi/blob/master/public/doc/lishogi-api.yaml) - Check out [Lishogi widgets to embed in your website](https://lishogi.org/developers)  ## Endpoint All requests go to `https://lishogi.org` (unless otherwise specified).  ## Rate limiting All requests are rate limited using various strategies, to ensure the API remains responsive for everyone. Only make one request at a time. If you receive an HTTP response with a [429 status](https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#429), please wait a full minute before resuming API usage.  ## Streaming with ND-JSON Some API endpoints stream their responses as [Newline Delimited JSON a.k.a. **nd-json**](http://ndjson.org/), with one JSON object per line.  Here's a [JavaScript utility function (for lichess)](https://gist.github.com/ornicar/a097406810939cf7be1df8ea30e94f3e) to help reading NDJSON streamed responses. 
+
+The version of the OpenAPI document: 2.0.0
+Contact: contact@lishogi.org
+Generated by: https://openapi-generator.tech
+Generator version: 7.10.0
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for Lishogi::BotApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'BotApi' do
+  before do
+    # run before each test
+    @api_instance = Lishogi::BotApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of BotApi' do
+    it 'should create an instance of BotApi' do
+      expect(@api_instance).to be_instance_of(Lishogi::BotApi)
+    end
+  end
+
+  # unit tests for api_bot_online
+  # Get online bots
+  # Stream the [online bot users](https://lishogi.org/player/bots), as [ndjson](#section/Introduction/Streaming-with-ND-JSON). Throttled to 50 bot users per second.
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :nb How many bot users to fetch
+  # @return [User]
+  describe 'api_bot_online test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for api_stream_event
+  # Stream incoming events
+  #    Stream the events reaching a lishogi user in real time as [ndjson](#section/Introduction/Streaming-with-ND-JSON).    Each line is a JSON object containing a `type` field. Possible values are:   - `gameStart` Start of a game   - `gameFinish` Completion of a game   - `challenge` A player sends you a challenge or you challenge someone   - `challengeDeclined` The opponent declines your challenge     When the stream opens, all current challenges and games are sent.
+  # @param [Hash] opts the optional parameters
+  # @return [ApiStreamEvent200Response]
+  describe 'api_stream_event test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for bot_account_upgrade
+  # Upgrade to Bot account
+  # Upgrade a lishogi player account into a Bot account. Only Bot accounts can use the Bot API.  The account **cannot have played any game** before becoming a Bot account. The upgrade is **irreversible**. The account will only be able to play as a Bot.  To upgrade an account to Bot, use the [official lishogi-bot client](https://github.com/ShailChoksi/lishogi-bot), or follow these steps: - Create an [API access token](https://lishogi.org/account/oauth/token/create?scopes[]=bot:play) with \"Play bot moves\" permission. - `curl -d '' https://lishogi.org/api/bot/account/upgrade -H \"Authorization: Bearer <yourTokenHere>\"`  To know if an account has already been upgraded, use the [Get my profile API](#operation/accountMe): the `title` field should be set to `BOT`. 
+  # @param [Hash] opts the optional parameters
+  # @return [Ok]
+  describe 'bot_account_upgrade test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for bot_game_abort
+  # Abort a game
+  # Abort a game being played with the Bot API. 
+  # @param game_id 
+  # @param [Hash] opts the optional parameters
+  # @return [Ok]
+  describe 'bot_game_abort test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for bot_game_chat
+  # Write in the chat
+  # Post a message to the player or spectator chat, in a game being played with the Bot API. 
+  # @param game_id 
+  # @param room 
+  # @param text 
+  # @param [Hash] opts the optional parameters
+  # @return [Ok]
+  describe 'bot_game_chat test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for bot_game_chat_get
+  # Fetch the game chat
+  # Get the messages posted in the game chat 
+  # @param game_id 
+  # @param [Hash] opts the optional parameters
+  # @return [Object]
+  describe 'bot_game_chat_get test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for bot_game_move
+  # Make a Bot move
+  # Make a move in a game being played with the Bot API. 
+  # @param game_id 
+  # @param move The move to play, in USI format
+  # @param [Hash] opts the optional parameters
+  # @return [Ok]
+  describe 'bot_game_move test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for bot_game_resign
+  # Resign a game
+  # Resign a game being played with the Bot API. 
+  # @param game_id 
+  # @param [Hash] opts the optional parameters
+  # @return [Ok]
+  describe 'bot_game_resign test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for bot_game_stream
+  # Stream Bot game state
+  #  Stream the state of a game being played with the Bot API, as [ndjson](#section/Introduction/Streaming-with-ND-JSON).  Use this endpoint to get updates about the game in real-time, with a single request.  Each line is a JSON object containing a `type` field. Possible values are:   - `gameFull` Full game data. All values are immutable, except for the `state` field.   - `gameState` Current state of the game. Immutable values not included.   - `chatLine` Chat message sent by a user (or the bot itself) in the `room` \"player\" or \"spectator\".    The first line is always of type `gameFull`.
+  # @param game_id 
+  # @param [Hash] opts the optional parameters
+  # @return [BoardGameStream200Response]
+  describe 'bot_game_stream test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+end

data/spec/api/challenges_api_spec.rb

@@ -0,0 +1,123 @@
+=begin
+#Lishogi.org API reference
+
+## Introduction Welcome to the reference for the Lishogi API! Lishogi is free/libre, open-source shogi server forked from lichess powered by volunteers and donations.  Currently this page is a work in progress, certain information here might be wrong and incorrect! Expect it to be done during 2022. - Get help in the [Lishogi Discord channel](https://discord.gg/YFtpMGg3rR) - [Contribute to this documentation on Github](https://github.com/WandererXII/lishogi/blob/master/public/doc/lishogi-api.yaml) - Check out [Lishogi widgets to embed in your website](https://lishogi.org/developers)  ## Endpoint All requests go to `https://lishogi.org` (unless otherwise specified).  ## Rate limiting All requests are rate limited using various strategies, to ensure the API remains responsive for everyone. Only make one request at a time. If you receive an HTTP response with a [429 status](https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#429), please wait a full minute before resuming API usage.  ## Streaming with ND-JSON Some API endpoints stream their responses as [Newline Delimited JSON a.k.a. **nd-json**](http://ndjson.org/), with one JSON object per line.  Here's a [JavaScript utility function (for lichess)](https://gist.github.com/ornicar/a097406810939cf7be1df8ea30e94f3e) to help reading NDJSON streamed responses. 
+
+The version of the OpenAPI document: 2.0.0
+Contact: contact@lishogi.org
+Generated by: https://openapi-generator.tech
+Generator version: 7.10.0
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for Lishogi::ChallengesApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'ChallengesApi' do
+  before do
+    # run before each test
+    @api_instance = Lishogi::ChallengesApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of ChallengesApi' do
+    it 'should create an instance of ChallengesApi' do
+      expect(@api_instance).to be_instance_of(Lishogi::ChallengesApi)
+    end
+  end
+
+  # unit tests for challenge_accept
+  # Accept a challenge
+  # Accept an incoming challenge.  You should receive a `gameStart` event on the [incoming events stream](#operation/apiStreamEvent). 
+  # @param challenge_id 
+  # @param [Hash] opts the optional parameters
+  # @return [Ok]
+  describe 'challenge_accept test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for challenge_ai
+  # Challenge the AI
+  # Start a game with Lishogi AI.  You will be notified on the [event stream](#operation/apiStreamEvent) that a new game has started. 
+  # @param [Hash] opts the optional parameters
+  # @option opts [Float] :level AI strength
+  # @option opts [Float] :clock_limit Clock initial time in seconds. If empty, a correspondence game is created.
+  # @option opts [Integer] :clock_increment Clock increment in seconds. If empty, a correspondence game is created.
+  # @option opts [Integer] :clock_byoyomi Clock byoyomi in seconds. If empty, a correspondence game is created.
+  # @option opts [Integer] :clock_periods Clock periods for byoyomi in seconds. If empty, a correspondence game is created.
+  # @option opts [Integer] :days Days per move, for correspondence games. Clock settings must be omitted.
+  # @option opts [String] :color Which color you get to play
+  # @option opts [VariantKey] :variant 
+  # @option opts [String] :sfen Custom initial position (in SFEN). Variant must be standard, and the game cannot be rated.
+  # @return [GameJson]
+  describe 'challenge_ai test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for challenge_create
+  # Create a challenge
+  # Challenge someone to play. The targeted player can choose to accept or decline.  If the challenge is accepted, you will be notified on the [event stream](#operation/apiStreamEvent) that a new game has started. The game ID will be the same as the challenge ID.  If you also have an OAuth token with `challenge:write` scope for the receiving user, you can make them accept the challenge immediately by setting the `acceptByToken` field.  Challenges for realtime games (not correspondence) expire after 20s if not accepted. To prevent that, use the `keepAliveStream` flag described below. 
+  # @param username 
+  # @param [Hash] opts the optional parameters
+  # @option opts [Boolean] :rated Game is rated and impacts players ratings
+  # @option opts [Float] :clock_limit Clock initial time in seconds. If empty, a correspondence game is created.
+  # @option opts [Integer] :clock_increment Clock increment in seconds. If empty, a correspondence game is created.
+  # @option opts [Integer] :clock_byoyomi Clock byoyomi in seconds. If empty, a correspondence game is created.
+  # @option opts [Integer] :clock_periods Clock periods for byoyomi in seconds. If empty, a correspondence game is created.
+  # @option opts [Integer] :days Days per move, for correspondence games. Clock settings must be omitted.
+  # @option opts [String] :color Which color you get to play
+  # @option opts [VariantKey] :variant 
+  # @option opts [String] :sfen Custom initial position (in SFEN). Variant must be standard, and the game cannot be rated.
+  # @option opts [Boolean] :keep_alive_stream If set, the response is streamed as [ndjson](#section/Introduction/Streaming-with-ND-JSON). The challenge is kept alive until the connection is closed by the client. When the challenge is accepted or declined, a message of the form `{\\\"done\\\":\\\"accepted\\\"}` is sent, then the connection is closed by the server. If not set, the response is not streamed, and the challenge expires after 20s if not accepted. 
+  # @option opts [String] :accept_by_token Immediately accept the challenge and create the game. Pass in an OAuth token (with the `challenge:write` scope) for the receiving user. On success, the response will contain a `game` field instead of a `challenge` field. 
+  # @option opts [String] :message **Only if `acceptByToken` is set.**  Message that is sent to each player, when the game is created. It is sent from your user account.  `{opponent}`, `{player}` and `{game}` are placeholders that will be replaced with the opponent name, player name, and the game URLs.  You can omit this field to send the default message, but if you set your own message, it must at least contain the `{game}` placeholder. 
+  # @return [ChallengeJson]
+  describe 'challenge_create test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for challenge_decline
+  # Decline a challenge
+  # Decline an incoming challenge. 
+  # @param challenge_id 
+  # @param [Hash] opts the optional parameters
+  # @return [Ok]
+  describe 'challenge_decline test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for challenge_open
+  # Open-ended challenge
+  # Create a challenge that any 2 players can join.  Share the URL of the challenge. the first 2 players to click it will be paired for a game.  The response body also contains `senteUrl` and `goteUrl`. You can control which color each player gets by giving them these URLs, instead of the main challenge URL.  Open challenges expire after 24h.  To directly pair 2 known players, use [this endpoint](#operation/challengeCreate) instead, with the `acceptByToken` parameter. 
+  # @param [Hash] opts the optional parameters
+  # @option opts [Boolean] :rated Game is rated and impacts players ratings
+  # @option opts [Float] :clock_limit Clock initial time in seconds. If empty, a correspondence game is created.
+  # @option opts [Integer] :clock_increment Clock increment in seconds. If empty, a correspondence game is created.
+  # @option opts [Integer] :clock_byoyomi Clock byoyomi in seconds. If empty, a correspondence game is created.
+  # @option opts [Integer] :clock_periods Clock periods for byoyomi in seconds. If empty, a correspondence game is created.
+  # @option opts [Integer] :days Days per turn. For correspondence challenges.
+  # @option opts [VariantKey] :variant 
+  # @option opts [String] :sfen Custom initial position (in SFEN). Variant must be standard, and the game cannot be rated.
+  # @option opts [String] :name Optional name for the challenge, that players will see on the challenge page.
+  # @return [Object]
+  describe 'challenge_open test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+end

data/spec/api/games_api_spec.rb

@@ -0,0 +1,135 @@
+=begin
+#Lishogi.org API reference
+
+## Introduction Welcome to the reference for the Lishogi API! Lishogi is free/libre, open-source shogi server forked from lichess powered by volunteers and donations.  Currently this page is a work in progress, certain information here might be wrong and incorrect! Expect it to be done during 2022. - Get help in the [Lishogi Discord channel](https://discord.gg/YFtpMGg3rR) - [Contribute to this documentation on Github](https://github.com/WandererXII/lishogi/blob/master/public/doc/lishogi-api.yaml) - Check out [Lishogi widgets to embed in your website](https://lishogi.org/developers)  ## Endpoint All requests go to `https://lishogi.org` (unless otherwise specified).  ## Rate limiting All requests are rate limited using various strategies, to ensure the API remains responsive for everyone. Only make one request at a time. If you receive an HTTP response with a [429 status](https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#429), please wait a full minute before resuming API usage.  ## Streaming with ND-JSON Some API endpoints stream their responses as [Newline Delimited JSON a.k.a. **nd-json**](http://ndjson.org/), with one JSON object per line.  Here's a [JavaScript utility function (for lichess)](https://gist.github.com/ornicar/a097406810939cf7be1df8ea30e94f3e) to help reading NDJSON streamed responses. 
+
+The version of the OpenAPI document: 2.0.0
+Contact: contact@lishogi.org
+Generated by: https://openapi-generator.tech
+Generator version: 7.10.0
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for Lishogi::GamesApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'GamesApi' do
+  before do
+    # run before each test
+    @api_instance = Lishogi::GamesApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of GamesApi' do
+    it 'should create an instance of GamesApi' do
+      expect(@api_instance).to be_instance_of(Lishogi::GamesApi)
+    end
+  end
+
+  # unit tests for api_account_playing
+  # Get my ongoing games
+  # Get the ongoing games of the current user. Real-time and correspondence games are included. The most urgent games are listed first. 
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :nb Max number of games to fetch
+  # @return [Object]
+  describe 'api_account_playing test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for api_games_user
+  # Export games of a user
+  # Download all games of any user in KIF or [ndjson](#section/Introduction/Streaming-with-ND-JSON) format.  Games are sorted by reverse chronological order (most recent first).  We recommend streaming the response, for it can be very long. <https://lishogi.org/@/YoBot_v2> for instance has more than 15,000 games.  The game stream is throttled, depending on who is making the request:   - Anonymous request: 20 games per second   - [OAuth2 authenticated](#section/Authentication) request: 30 games per second   - Authenticated, downloading your own games: 60 games per second 
+  # @param username The user name.
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :since Download games played since this timestamp. Defaults to account creation date.
+  # @option opts [Integer] :_until Download games played until this timestamp. Defaults to now.
+  # @option opts [Integer] :max How many games to download. Leave empty to download all games.
+  # @option opts [String] :vs [Filter] Only games played against this opponent
+  # @option opts [Boolean] :rated [Filter] Only rated (`true`) or casual (`false`) games
+  # @option opts [PerfType] :perf_type [Filter] Only games in these speeds or variants.   Multiple perf types can be specified, separated by a comma.   Example: blitz,rapid,classical
+  # @option opts [String] :color [Filter] Only games played as this color.
+  # @option opts [Boolean] :analysed [Filter] Only games with or without a computer analysis available
+  # @option opts [Boolean] :moves Include the KIF moves.
+  # @option opts [Boolean] :pgn_in_json Include the full KIF within the JSON response, in a `notation` field. The response type must be set to `application/x-ndjson` by the request `Accept` header.
+  # @option opts [Boolean] :tags Include the KIF tags.
+  # @option opts [Boolean] :clocks Include clock comments in the KIF moves, when available.  Example: `22   同　玉(51)   (00:02/00:00:13)` 
+  # @option opts [Boolean] :evals Include analysis evaluation comments in the KIF, when available.  Example: `9   ７八銀(79)   * [%eval -1.48]` 
+  # @option opts [Boolean] :ongoing Include ongoing games. The last 3 moves will be omitted.
+  # @option opts [Boolean] :finished Include finished games. Set to `false` to only get ongoing games.
+  # @option opts [String] :players URL of a text file containing real names and ratings, to replace Lishogi usernames and ratings in the KIF. Example: <https://gist.githubusercontent.com/ornicar/6bfa91eb61a2dcae7bcd14cce1b2a4eb/raw/768b9f6cc8a8471d2555e47ba40fb0095e5fba37/gistfile1.txt> 
+  # @option opts [String] :sort Sort order of the games.
+  # @return [Object]
+  describe 'api_games_user test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for api_user_current_game
+  # Export ongoing game of a user
+  # Download the ongoing game, or the last game played, of a user. Available in either KIF or JSON format. If the game is ongoing, the 3 last moves are omitted. 
+  # @param username 
+  # @param [Hash] opts the optional parameters
+  # @option opts [Boolean] :moves Include the KIF moves.
+  # @option opts [Boolean] :tags Include the KIF tags.
+  # @option opts [Boolean] :clocks Include clock comments in the KIF moves, when available.  Example: `22   同　玉(51)   (00:02/00:00:13)` 
+  # @option opts [Boolean] :evals Include analysis evaluation comments in the KIF, when available.  Example: `9   ７八銀(79)   * [%eval -1.48]` 
+  # @option opts [String] :players URL of a text file containing real names and ratings, to replace Lishogi usernames and ratings in the KIF. Example: <https://gist.githubusercontent.com/ornicar/6bfa91eb61a2dcae7bcd14cce1b2a4eb/raw/768b9f6cc8a8471d2555e47ba40fb0095e5fba37/gistfile1.txt> 
+  # @return [Object]
+  describe 'api_user_current_game test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for game_kif
+  # Export one game
+  # Download one game in either KIF or JSON format.  Ongoing games have their last 3 moves omitted, after move 5. 
+  # @param game_id The game ID (8 characters).
+  # @param [Hash] opts the optional parameters
+  # @option opts [Boolean] :moves Include the KIF moves.
+  # @option opts [Boolean] :tags Include the KIF tags.
+  # @option opts [Boolean] :clocks Include clock comments in the KIF moves, when available.  Example: `22   同　玉(51)   (00:02/00:00:13)` 
+  # @option opts [Boolean] :evals Include analysis evaluation comments in the KIF, when available.  Example: `9   ７八銀(79)   * [%eval -1.48]` 
+  # @option opts [String] :players URL of a text file containing real names and ratings, to replace Lishogi usernames and ratings in the KIF. Example: <https://gist.githubusercontent.com/ornicar/6bfa91eb61a2dcae7bcd14cce1b2a4eb/raw/768b9f6cc8a8471d2555e47ba40fb0095e5fba37/gistfile1.txt> 
+  # @return [Object]
+  describe 'game_kif test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for games_by_users
+  # Stream games of users
+  # Stream the games played between a list of users, in real time. Only games where **both players** are part of the list are included.  By default, games are only sent to the stream when they start. To also get all ongoing games at the beginning of the stream, use the `withCurrentGames` flag.  Maximum number of users: 300.  Games are streamed as [ndjson](#section/Introduction/Streaming-with-ND-JSON).  The method is `POST` so a longer list of IDs can be sent in the request body. 
+  # @param body Up to 300 user IDs separated by commas.
+  # @param [Hash] opts the optional parameters
+  # @option opts [Boolean] :with_current_games Include the already started games at the beginning of the stream.
+  # @return [Object]
+  describe 'games_by_users test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for stream_game
+  # Stream moves of a game
+  # Stream positions and moves of any ongoing game, in [ndjson](#section/Introduction/Streaming-with-ND-JSON).  A description of the game is sent as a first message. Then a message is sent each time a move is played. Finally a description of the game is sent when it finishes, and the stream is closed.  After move 5, the stream intentionally remains 3 moves behind the game status, as to prevent cheat bots from using this API.  No more than 8 game streams can be opened at the same time from the same IP address. 
+  # @param id 
+  # @param [Hash] opts the optional parameters
+  # @return [Object]
+  describe 'stream_game test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+end

data/spec/api/messaging_api_spec.rb

@@ -0,0 +1,48 @@
+=begin
+#Lishogi.org API reference
+
+## Introduction Welcome to the reference for the Lishogi API! Lishogi is free/libre, open-source shogi server forked from lichess powered by volunteers and donations.  Currently this page is a work in progress, certain information here might be wrong and incorrect! Expect it to be done during 2022. - Get help in the [Lishogi Discord channel](https://discord.gg/YFtpMGg3rR) - [Contribute to this documentation on Github](https://github.com/WandererXII/lishogi/blob/master/public/doc/lishogi-api.yaml) - Check out [Lishogi widgets to embed in your website](https://lishogi.org/developers)  ## Endpoint All requests go to `https://lishogi.org` (unless otherwise specified).  ## Rate limiting All requests are rate limited using various strategies, to ensure the API remains responsive for everyone. Only make one request at a time. If you receive an HTTP response with a [429 status](https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#429), please wait a full minute before resuming API usage.  ## Streaming with ND-JSON Some API endpoints stream their responses as [Newline Delimited JSON a.k.a. **nd-json**](http://ndjson.org/), with one JSON object per line.  Here's a [JavaScript utility function (for lichess)](https://gist.github.com/ornicar/a097406810939cf7be1df8ea30e94f3e) to help reading NDJSON streamed responses. 
+
+The version of the OpenAPI document: 2.0.0
+Contact: contact@lishogi.org
+Generated by: https://openapi-generator.tech
+Generator version: 7.10.0
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for Lishogi::MessagingApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'MessagingApi' do
+  before do
+    # run before each test
+    @api_instance = Lishogi::MessagingApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of MessagingApi' do
+    it 'should create an instance of MessagingApi' do
+      expect(@api_instance).to be_instance_of(Lishogi::MessagingApi)
+    end
+  end
+
+  # unit tests for inbox_username
+  # Send a private message
+  # Send a private message to another player. 
+  # @param username 
+  # @param text 
+  # @param [Hash] opts the optional parameters
+  # @return [Ok]
+  describe 'inbox_username test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+end

data/spec/api/puzzles_api_spec.rb

@@ -0,0 +1,70 @@
+=begin
+#Lishogi.org API reference
+
+## Introduction Welcome to the reference for the Lishogi API! Lishogi is free/libre, open-source shogi server forked from lichess powered by volunteers and donations.  Currently this page is a work in progress, certain information here might be wrong and incorrect! Expect it to be done during 2022. - Get help in the [Lishogi Discord channel](https://discord.gg/YFtpMGg3rR) - [Contribute to this documentation on Github](https://github.com/WandererXII/lishogi/blob/master/public/doc/lishogi-api.yaml) - Check out [Lishogi widgets to embed in your website](https://lishogi.org/developers)  ## Endpoint All requests go to `https://lishogi.org` (unless otherwise specified).  ## Rate limiting All requests are rate limited using various strategies, to ensure the API remains responsive for everyone. Only make one request at a time. If you receive an HTTP response with a [429 status](https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#429), please wait a full minute before resuming API usage.  ## Streaming with ND-JSON Some API endpoints stream their responses as [Newline Delimited JSON a.k.a. **nd-json**](http://ndjson.org/), with one JSON object per line.  Here's a [JavaScript utility function (for lichess)](https://gist.github.com/ornicar/a097406810939cf7be1df8ea30e94f3e) to help reading NDJSON streamed responses. 
+
+The version of the OpenAPI document: 2.0.0
+Contact: contact@lishogi.org
+Generated by: https://openapi-generator.tech
+Generator version: 7.10.0
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for Lishogi::PuzzlesApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'PuzzlesApi' do
+  before do
+    # run before each test
+    @api_instance = Lishogi::PuzzlesApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of PuzzlesApi' do
+    it 'should create an instance of PuzzlesApi' do
+      expect(@api_instance).to be_instance_of(Lishogi::PuzzlesApi)
+    end
+  end
+
+  # unit tests for api_puzzle_activity
+  # Get your puzzle activity
+  # Download your puzzle activity in [ndjson](#section/Introduction/Streaming-with-ND-JSON) format.  Puzzle activity is sorted by reverse chronological order (most recent first)  We recommend streaming the response, for it can be very long. 
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :max How many entries to download. Leave empty to download all activity.
+  # @return [PuzzleRoundJson]
+  describe 'api_puzzle_activity test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for api_puzzle_daily
+  # Get the daily puzzle
+  # Get the daily Lishogi puzzle in JSON format. 
+  # @param [Hash] opts the optional parameters
+  # @return [Object]
+  describe 'api_puzzle_daily test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for api_puzzle_dashboard
+  # Get your puzzle dashboard
+  # Download your [puzzle dashboard](https://lishogi.org/training/dashboard/30/dashboard) as JSON.  Also includes all puzzle themes played, with aggregated results.  Allows re-creating the [improvement/strengths](https://lishogi.org/training/dashboard/30/improvementAreas) interfaces. 
+  # @param days How many days to look back when aggregating puzzle results. 30 is sensible.
+  # @param [Hash] opts the optional parameters
+  # @return [Object]
+  describe 'api_puzzle_dashboard test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+end

data/spec/api/simuls_api_spec.rb

@@ -0,0 +1,46 @@
+=begin
+#Lishogi.org API reference
+
+## Introduction Welcome to the reference for the Lishogi API! Lishogi is free/libre, open-source shogi server forked from lichess powered by volunteers and donations.  Currently this page is a work in progress, certain information here might be wrong and incorrect! Expect it to be done during 2022. - Get help in the [Lishogi Discord channel](https://discord.gg/YFtpMGg3rR) - [Contribute to this documentation on Github](https://github.com/WandererXII/lishogi/blob/master/public/doc/lishogi-api.yaml) - Check out [Lishogi widgets to embed in your website](https://lishogi.org/developers)  ## Endpoint All requests go to `https://lishogi.org` (unless otherwise specified).  ## Rate limiting All requests are rate limited using various strategies, to ensure the API remains responsive for everyone. Only make one request at a time. If you receive an HTTP response with a [429 status](https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#429), please wait a full minute before resuming API usage.  ## Streaming with ND-JSON Some API endpoints stream their responses as [Newline Delimited JSON a.k.a. **nd-json**](http://ndjson.org/), with one JSON object per line.  Here's a [JavaScript utility function (for lichess)](https://gist.github.com/ornicar/a097406810939cf7be1df8ea30e94f3e) to help reading NDJSON streamed responses. 
+
+The version of the OpenAPI document: 2.0.0
+Contact: contact@lishogi.org
+Generated by: https://openapi-generator.tech
+Generator version: 7.10.0
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for Lishogi::SimulsApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'SimulsApi' do
+  before do
+    # run before each test
+    @api_instance = Lishogi::SimulsApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of SimulsApi' do
+    it 'should create an instance of SimulsApi' do
+      expect(@api_instance).to be_instance_of(Lishogi::SimulsApi)
+    end
+  end
+
+  # unit tests for api_simul
+  # Get current simuls
+  # Get recently finished, ongoing, and upcoming simuls. 
+  # @param [Hash] opts the optional parameters
+  # @return [Array<Object>]
+  describe 'api_simul test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+end