lishogi 0.1.0

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'

data/lib/lishogi/api/account_api.rb

@@ -0,0 +1,314 @@
+=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 'cgi'
+
+module Lishogi
+  class AccountApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Get my preferences
+    # Read the preferences of the logged in user.  - <https://lishogi.org/account/preferences/game-display> - <https://github.com/WandererXII/lishogi/blob/master/modules/pref/src/main/Pref.scala> 
+    # @param [Hash] opts the optional parameters
+    # @return [Account200Response]
+    def account(opts = {})
+      data, _status_code, _headers = account_with_http_info(opts)
+      data
+    end
+
+    # Get my preferences
+    # Read the preferences of the logged in user.  - &lt;https://lishogi.org/account/preferences/game-display&gt; - &lt;https://github.com/WandererXII/lishogi/blob/master/modules/pref/src/main/Pref.scala&gt; 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Account200Response, Integer, Hash)>] Account200Response data, response status code and response headers
+    def account_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AccountApi.account ...'
+      end
+      # resource path
+      local_var_path = '/api/account/preferences'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Account200Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['OAuth2']
+
+      new_options = opts.merge(
+        :operation => :"AccountApi.account",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AccountApi#account\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get my email address
+    # Read the email address of the logged in user. 
+    # @param [Hash] opts the optional parameters
+    # @return [AccountEmail200Response]
+    def account_email(opts = {})
+      data, _status_code, _headers = account_email_with_http_info(opts)
+      data
+    end
+
+    # Get my email address
+    # Read the email address of the logged in user. 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(AccountEmail200Response, Integer, Hash)>] AccountEmail200Response data, response status code and response headers
+    def account_email_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AccountApi.account_email ...'
+      end
+      # resource path
+      local_var_path = '/api/account/email'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'AccountEmail200Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['OAuth2']
+
+      new_options = opts.merge(
+        :operation => :"AccountApi.account_email",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AccountApi#account_email\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get my kid mode status
+    # Read the kid mode status of the logged in user.  - <https://lishogi.org/account/kid> 
+    # @param [Hash] opts the optional parameters
+    # @return [AccountKid200Response]
+    def account_kid(opts = {})
+      data, _status_code, _headers = account_kid_with_http_info(opts)
+      data
+    end
+
+    # Get my kid mode status
+    # Read the kid mode status of the logged in user.  - &lt;https://lishogi.org/account/kid&gt; 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(AccountKid200Response, Integer, Hash)>] AccountKid200Response data, response status code and response headers
+    def account_kid_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AccountApi.account_kid ...'
+      end
+      # resource path
+      local_var_path = '/api/account/kid'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'AccountKid200Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['OAuth2']
+
+      new_options = opts.merge(
+        :operation => :"AccountApi.account_kid",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AccountApi#account_kid\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Set my kid mode status
+    # Set the kid mode status of the logged in user.  - <https://lishogi.org/account/kid> 
+    # @param v [Boolean] Kid mode status
+    # @param [Hash] opts the optional parameters
+    # @return [Ok]
+    def account_kid_post(v, opts = {})
+      data, _status_code, _headers = account_kid_post_with_http_info(v, opts)
+      data
+    end
+
+    # Set my kid mode status
+    # Set the kid mode status of the logged in user.  - &lt;https://lishogi.org/account/kid&gt; 
+    # @param v [Boolean] Kid mode status
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Ok, Integer, Hash)>] Ok data, response status code and response headers
+    def account_kid_post_with_http_info(v, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AccountApi.account_kid_post ...'
+      end
+      # verify the required parameter 'v' is set
+      if @api_client.config.client_side_validation && v.nil?
+        fail ArgumentError, "Missing the required parameter 'v' when calling AccountApi.account_kid_post"
+      end
+      # resource path
+      local_var_path = '/api/account/kid'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'v'] = v
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Ok'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['OAuth2']
+
+      new_options = opts.merge(
+        :operation => :"AccountApi.account_kid_post",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AccountApi#account_kid_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get my profile
+    # Public information about the logged in user. 
+    # @param [Hash] opts the optional parameters
+    # @return [UserExtended]
+    def account_me(opts = {})
+      data, _status_code, _headers = account_me_with_http_info(opts)
+      data
+    end
+
+    # Get my profile
+    # Public information about the logged in user. 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(UserExtended, Integer, Hash)>] UserExtended data, response status code and response headers
+    def account_me_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AccountApi.account_me ...'
+      end
+      # resource path
+      local_var_path = '/api/account'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'UserExtended'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['OAuth2']
+
+      new_options = opts.merge(
+        :operation => :"AccountApi.account_me",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AccountApi#account_me\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/lib/lishogi/api/analysis_api.rb

@@ -0,0 +1,92 @@
+=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 'cgi'
+
+module Lishogi
+  class AnalysisApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Get cloud evaluation of a position.
+    # Get the cached evaluation of a position, if available.  Opening positions have more chances of being available. There are about 500 thousand positions in the database.  Up to 5 variations may be available. Variants are supported. 
+    # @param sfen [String] SFEN of the position
+    # @param [Hash] opts the optional parameters
+    # @option opts [Float] :multi_pv Number of variations (default to 1)
+    # @option opts [VariantKey] :variant Variant (default to 'standard')
+    # @return [nil]
+    def api_cloud_eval(sfen, opts = {})
+      api_cloud_eval_with_http_info(sfen, opts)
+      nil
+    end
+
+    # Get cloud evaluation of a position.
+    # Get the cached evaluation of a position, if available.  Opening positions have more chances of being available. There are about 500 thousand positions in the database.  Up to 5 variations may be available. Variants are supported. 
+    # @param sfen [String] SFEN of the position
+    # @param [Hash] opts the optional parameters
+    # @option opts [Float] :multi_pv Number of variations (default to 1)
+    # @option opts [VariantKey] :variant Variant (default to 'standard')
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def api_cloud_eval_with_http_info(sfen, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AnalysisApi.api_cloud_eval ...'
+      end
+      # verify the required parameter 'sfen' is set
+      if @api_client.config.client_side_validation && sfen.nil?
+        fail ArgumentError, "Missing the required parameter 'sfen' when calling AnalysisApi.api_cloud_eval"
+      end
+      # resource path
+      local_var_path = '/api/cloud-eval'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'sfen'] = sfen
+      query_params[:'multiPv'] = opts[:'multi_pv'] if !opts[:'multi_pv'].nil?
+      query_params[:'variant'] = opts[:'variant'] if !opts[:'variant'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type]
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || []
+
+      new_options = opts.merge(
+        :operation => :"AnalysisApi.api_cloud_eval",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AnalysisApi#api_cloud_eval\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end