lishogi 0.1.0

data/lib/lishogi/models/game_state_event.rb

@@ -0,0 +1,396 @@
+=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 'date'
+require 'time'
+
+module Lishogi
+  class GameStateEvent
+    attr_accessor :type
+
+    # Current moves in USI format
+    attr_accessor :moves
+
+    # Integer of milliseconds sente has left on the clock
+    attr_accessor :btime
+
+    # Integer of milliseconds Gote has left on the clock
+    attr_accessor :qtime
+
+    # Integer of Sente Fisher increment.
+    attr_accessor :binc
+
+    # Integer of Gote Fisher increment.
+    attr_accessor :winc
+
+    # Integer of Byoyomi
+    attr_accessor :byo
+
+    attr_accessor :status
+
+    # Color of the winner, if any
+    attr_accessor :winner
+
+    # true if sente is proposing takeback, else omitted
+    attr_accessor :btakeback
+
+    # true if gote is proposing takeback, else omitted
+    attr_accessor :qtakeback
+
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'type' => :'type',
+        :'moves' => :'moves',
+        :'btime' => :'btime',
+        :'qtime' => :'qtime',
+        :'binc' => :'binc',
+        :'winc' => :'winc',
+        :'byo' => :'byo',
+        :'status' => :'status',
+        :'winner' => :'winner',
+        :'btakeback' => :'btakeback',
+        :'qtakeback' => :'qtakeback'
+      }
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'type' => :'String',
+        :'moves' => :'String',
+        :'btime' => :'Integer',
+        :'qtime' => :'Integer',
+        :'binc' => :'Integer',
+        :'winc' => :'Integer',
+        :'byo' => :'Integer',
+        :'status' => :'GameStatus',
+        :'winner' => :'String',
+        :'btakeback' => :'Boolean',
+        :'qtakeback' => :'Boolean'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `Lishogi::GameStateEvent` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Lishogi::GameStateEvent`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'type')
+        self.type = attributes[:'type']
+      else
+        self.type = nil
+      end
+
+      if attributes.key?(:'moves')
+        self.moves = attributes[:'moves']
+      else
+        self.moves = nil
+      end
+
+      if attributes.key?(:'btime')
+        self.btime = attributes[:'btime']
+      else
+        self.btime = nil
+      end
+
+      if attributes.key?(:'qtime')
+        self.qtime = attributes[:'qtime']
+      end
+
+      if attributes.key?(:'binc')
+        self.binc = attributes[:'binc']
+      else
+        self.binc = nil
+      end
+
+      if attributes.key?(:'winc')
+        self.winc = attributes[:'winc']
+      else
+        self.winc = nil
+      end
+
+      if attributes.key?(:'byo')
+        self.byo = attributes[:'byo']
+      else
+        self.byo = nil
+      end
+
+      if attributes.key?(:'status')
+        self.status = attributes[:'status']
+      else
+        self.status = nil
+      end
+
+      if attributes.key?(:'winner')
+        self.winner = attributes[:'winner']
+      end
+
+      if attributes.key?(:'btakeback')
+        self.btakeback = attributes[:'btakeback']
+      end
+
+      if attributes.key?(:'qtakeback')
+        self.qtakeback = attributes[:'qtakeback']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      invalid_properties = Array.new
+      if @type.nil?
+        invalid_properties.push('invalid value for "type", type cannot be nil.')
+      end
+
+      if @moves.nil?
+        invalid_properties.push('invalid value for "moves", moves cannot be nil.')
+      end
+
+      if @btime.nil?
+        invalid_properties.push('invalid value for "btime", btime cannot be nil.')
+      end
+
+      if @binc.nil?
+        invalid_properties.push('invalid value for "binc", binc cannot be nil.')
+      end
+
+      if @winc.nil?
+        invalid_properties.push('invalid value for "winc", winc cannot be nil.')
+      end
+
+      if @byo.nil?
+        invalid_properties.push('invalid value for "byo", byo cannot be nil.')
+      end
+
+      if @status.nil?
+        invalid_properties.push('invalid value for "status", status cannot be nil.')
+      end
+
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      return false if @type.nil?
+      type_validator = EnumAttributeValidator.new('String', ["gameState"])
+      return false unless type_validator.valid?(@type)
+      return false if @moves.nil?
+      return false if @btime.nil?
+      return false if @binc.nil?
+      return false if @winc.nil?
+      return false if @byo.nil?
+      return false if @status.nil?
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] type Object to be assigned
+    def type=(type)
+      validator = EnumAttributeValidator.new('String', ["gameState"])
+      unless validator.valid?(type)
+        fail ArgumentError, "invalid value for \"type\", must be one of #{validator.allowable_values}."
+      end
+      @type = type
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          type == o.type &&
+          moves == o.moves &&
+          btime == o.btime &&
+          qtime == o.qtime &&
+          binc == o.binc &&
+          winc == o.winc &&
+          byo == o.byo &&
+          status == o.status &&
+          winner == o.winner &&
+          btakeback == o.btakeback &&
+          qtakeback == o.qtakeback
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [type, moves, btime, qtime, binc, winc, byo, status, winner, btakeback, qtakeback].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = nil
+        elsif type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
+          end
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
+        end
+      end
+      new(transformed_hash)
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def self._deserialize(type, value)
+      case type.to_sym
+      when :Time
+        Time.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :Boolean
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        # models (e.g. Pet) or oneOf
+        klass = Lishogi.const_get(type)
+        klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+
+end

data/lib/lishogi/models/game_status.rb

@@ -0,0 +1,52 @@
+=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 'date'
+require 'time'
+
+module Lishogi
+  class GameStatus
+    CREATED = "created".freeze
+    STARTED = "started".freeze
+    ABORTED = "aborted".freeze
+    MATE = "mate".freeze
+    RESIGN = "resign".freeze
+    STALEMATE = "stalemate".freeze
+    TIMEOUT = "timeout".freeze
+    DRAW = "draw".freeze
+    OUTOFTIME = "outoftime".freeze
+    CHEAT = "cheat".freeze
+    NO_START = "noStart".freeze
+    UNKNOWN_FINISH = "unknownFinish".freeze
+    ROYALS_LOST = "royalsLost".freeze
+    BARE_KING = "bareKing".freeze
+
+    def self.all_vars
+      @all_vars ||= [CREATED, STARTED, ABORTED, MATE, RESIGN, STALEMATE, TIMEOUT, DRAW, OUTOFTIME, CHEAT, NO_START, UNKNOWN_FINISH, ROYALS_LOST, BARE_KING].freeze
+    end
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def self.build_from_hash(value)
+      new.build_from_hash(value)
+    end
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def build_from_hash(value)
+      return value if GameStatus.all_vars.include?(value)
+      raise "Invalid ENUM value #{value} for class #GameStatus"
+    end
+  end
+end