zombie_battleground-api 0.1.0 → 0.2.0

data/lib/zombie_battleground/api/models/match.rb

@@ -6,39 +6,217 @@ require 'zombie_battleground/api/validation_helper'
 
 module ZombieBattleground
   class Api
-    ##
-    # Validator for Match
-    class Match
-      include ActiveModel::Validations
-      include ZombieBattleground::Api::ValidationHelper
-
-      attr_reader :id, :created_at, :updated_at, :player1_id, :player2_id, :player1_accepted,
-                  :player2_accepted, :player1_deck_id, :player2_deck_id, :status, :version,
-                  :random_seed, :winner_id, :block_height
-
-      validate :id_is_a_non_negative_integer
-      validate :created_at_is_a_time_and_not_null
-      validate :updated_at_is_a_time_and_not_null
-      validate :player1_id_is_a_string_and_not_null
-      validate :player2_id_is_a_string_and_not_null
-      validates :player1_accepted, inclusion: { in: [true, false] }
-      validates :player2_accepted, inclusion: { in: [true, false] }
-      validate :player1_deck_id_is_a_non_negative_integer
-      validate :player2_deck_id_is_a_non_negative_integer
-      validate :status_is_a_string_and_not_null
-      validate :version_is_a_string_and_not_null
-      validate :random_seed_is_a_non_negative_integer
-      validate :winner_id_is_a_string_and_not_null
-      validate :block_height_is_a_non_negative_integer_and_not_null
-
-      def initialize(match)
-        match.each do |key, value|
-          next if value.nil? # this is an illegal response, match id 1 is bogus
-
-          if %w[created_at updated_at].include?(key)
-            instance_variable_set("@#{key}".to_sym, Time.parse(value))
-          else
-            instance_variable_set("@#{key}".to_sym, value)
+    class Models
+      ##
+      # Validator for Match
+      class Match
+        include ActiveModel::Validations
+        include ZombieBattleground::Api::ValidationHelper
+
+        ##
+        # @!attribute [r] id
+        # the Match's id
+        #
+        # @return [Integer]
+        #
+        # @example
+        #   match.id #=> 1
+        #
+        # @api public
+        attr_reader :id
+
+        ##
+        # @!attribute [r] created_at
+        # the Match's created_at time
+        #
+        # @return [Time]
+        #
+        # @example
+        #   match.created_at #=> Time
+        #
+        # @api public
+        attr_reader :created_at
+
+        ##
+        # @!attribute [r] updated_at
+        # the Match's updated_at time
+        #
+        # @return [Time]
+        #
+        # @example
+        #   match.updated_at #=> Time
+        #
+        # @api public
+        attr_reader :updated_at
+
+        ##
+        # @!attribute [r] player1_id
+        # the Match's player1_id
+        #
+        # @return [String]
+        #
+        # @example
+        #   match.player1_id #=> "ZombieSlayer_16601"
+        #
+        # @api public
+        attr_reader :player1_id
+
+        ##
+        # @!attribute [r] player2_id
+        # the Match's player2_id
+        #
+        # @return [String]
+        #
+        # @example
+        #   match.player2_id #=> "ZombieSlayer_50758"
+        #
+        # @api public
+        attr_reader :player2_id
+
+        ##
+        # @!attribute [r] player1_accepted
+        # the Match's player1_accepted
+        #
+        # @return [Boolean]
+        #
+        # @example
+        #   match.player1_accepted #=> true
+        #
+        # @api public
+        attr_reader :player1_accepted
+
+        ##
+        # @!attribute [r] player2_accepted
+        # the Match's player2_accepted
+        #
+        # @return [Boolean]
+        #
+        # @example
+        #   match.player2_accepted #=> true
+        #
+        # @api public
+        attr_reader :player2_accepted
+
+        ##
+        # @!attribute [r] player1_deck_id
+        # the Match's player1_deck_id
+        #
+        # @return [Integer]
+        #
+        # @example
+        #   match.player1_deck_id #=> 1
+        #
+        # @api public
+        attr_reader :player1_deck_id
+
+        ##
+        # @!attribute [r] player2_deck_id
+        # the Match's player2_deck_id
+        #
+        # @return [Integer]
+        #
+        # @example
+        #   match.player2_deck_id #=> 4
+        #
+        # @api public
+        attr_reader :player2_deck_id
+
+        ##
+        # @!attribute [r] status
+        # the Match's status
+        #
+        # @return [String]
+        #
+        # @example
+        #   match.status #=> "Ended"
+        #
+        # @api public
+        attr_reader :status
+
+        ##
+        # @!attribute [r] version
+        # the Match's version
+        #
+        # @return [String]
+        #
+        # @example
+        #   match.version #=> "v3"
+        #
+        # @api public
+        attr_reader :version
+
+        ##
+        # @!attribute [r] random_seed
+        # the Match's random_seed
+        #
+        # @return [Integer]
+        #
+        # @example
+        #   match.random_seed #=> 1548242486
+        #
+        # @api public
+        attr_reader :random_seed
+
+        ##
+        # @!attribute [r] winner_id
+        # the Match's winner_id
+        #
+        # @return [String]
+        #
+        # @example
+        #   match.winner_id #=> "ZombieSlayer_507586"
+        #
+        # @api public
+        attr_reader :winner_id
+
+        ##
+        # @!attribute [r] block_height
+        # the Match's block_height
+        #
+        # @return [Integer]
+        #
+        # @example
+        #   match.block_height #=> 497513
+        #
+        # @api public
+        attr_reader :block_height
+
+        validate :id_is_a_non_negative_integer
+        validate :created_at_is_a_time_and_not_null
+        validate :updated_at_is_a_time_and_not_null
+        validate :player1_id_is_a_string_and_not_null
+        validate :player2_id_is_a_string_and_not_null
+        validates :player1_accepted, inclusion: { in: [true, false] }
+        validates :player2_accepted, inclusion: { in: [true, false] }
+        validate :player1_deck_id_is_a_non_negative_integer
+        validate :player2_deck_id_is_a_non_negative_integer
+        validate :status_is_a_string_and_not_null
+        validate :version_is_a_string_and_not_null
+        validate :random_seed_is_a_non_negative_integer
+        validate :winner_id_is_a_string_and_not_null
+        validate :block_height_is_a_non_negative_integer_and_not_null
+
+        ##
+        # Creates a new Match
+        #
+        # @param match [Hash] Parsed JSON response
+        #
+        # @return [ZombieBattleground::Api::Match]
+        #
+        # @example
+        #   match = ZombieBattleground::Api::Match.new(parsed_json)
+        #   # => ZombieBattleground::Api::Match
+        #
+        # @api public
+        def initialize(match)
+          match.each do |key, value|
+            next if value.nil? # this is an illegal response, match id 1 is bogus
+
+            if %w[created_at updated_at].include?(key)
+              instance_variable_set("@#{key}".to_sym, Time.parse(value))
+            else
+              instance_variable_set("@#{key}".to_sym, value)
+            end
           end
         end
       end

data/lib/zombie_battleground/api/models/simple_card.rb

@@ -6,20 +6,56 @@ require 'zombie_battleground/api/validation_helper'
 
 module ZombieBattleground
   class Api
-    ##
-    # Validator for SimpleCard (only returned from GetDeck(s))
-    class SimpleCard
-      include ActiveModel::Validations
-      include ZombieBattleground::Api::ValidationHelper
+    class Models
+      ##
+      # Validator for SimpleCard (only returned from GetDeck(s))
+      class SimpleCard
+        include ActiveModel::Validations
+        include ZombieBattleground::Api::ValidationHelper
 
-      attr_reader :card_name, :amount
+        ##
+        # @!attribute [r] card_name
+        # the Card's name
+        #
+        # @return [String]
+        #
+        # @example
+        #   simple_card.card_name #=> "Hazmaz"
+        #
+        # @api public
+        attr_reader :card_name
 
-      validate :card_name_is_a_string_and_not_null
-      validate :amount_is_a_non_negative_integer_and_not_null
+        ##
+        # @!attribute [r] amount
+        # the amount of the Card in the deck
+        #
+        # @return [Integer]
+        #
+        # @example
+        #   simple_card.amount #=> 2
+        #
+        # @api public
+        attr_reader :amount
 
-      def initialize(card)
-        card.each do |key, value|
-          instance_variable_set("@#{key}".to_sym, value)
+        validate :card_name_is_a_string_and_not_null
+        validate :amount_is_a_non_negative_integer_and_not_null
+
+        ##
+        # Creates a new SimpleCard (returned by GetDeck(s))
+        #
+        # @param card [Hash] Parsed JSON response
+        #
+        # @return [ZombieBattleground::Api::SimpleCard]
+        #
+        # @example
+        #   simple_card = ZombieBattleground::Api::SimpleCard.new(parsed_json)
+        #   # => ZombieBattleground::Api::SimpleCard
+        #
+        # @api public
+        def initialize(card)
+          card.each do |key, value|
+            instance_variable_set("@#{key}".to_sym, value)
+          end
         end
       end
     end

data/lib/zombie_battleground/api/requests/get_card_request.rb

@@ -8,19 +8,54 @@ require 'zombie_battleground/api/requests/request_helper'
 module ZombieBattleground
   class Api
     ##
-    # Request validator for GetCard
-    class GetCardRequest
-      include ActiveModel::Validations
-      include ZombieBattleground::Api::ValidationHelper
-      include ZombieBattleground::Api::RequestHelper
+    # Namespace for Requests
+    class Requests
+      ##
+      # Request validator for GetCard
+      class GetCardRequest
+        include ActiveModel::Validations
+        include ZombieBattleground::Api::ValidationHelper
+        include ZombieBattleground::Api::Requests::RequestHelper
 
-      attr_accessor :mould_id, :version
+        ##
+        # @!attribute [r] mould_id
+        # Card's mould_id
+        #
+        # @return [String]
+        #
+        # @example
+        #   request.id #=> "1"
+        #
+        # @api public
+        attr_accessor :mould_id
 
-      validate :mould_id_is_a_string_and_not_null
-      validate :version_is_a_string_and_not_null
+        ##
+        # @!attribute [r] version
+        # Deck's version
+        #
+        # @return [String]
+        #
+        # @example
+        #   request.id #=> "v3"
+        #
+        # @api public
+        attr_accessor :version
 
-      def uri
-        'card'
+        validate :mould_id_is_a_string_and_not_null
+        validate :version_is_a_string_and_not_null
+
+        ##
+        # The URI for the endpoint
+        #
+        # @return [String]
+        #
+        # @example
+        #   request.uri # => "card"
+        #
+        # @api public
+        def uri
+          'card'
+        end
       end
     end
   end

data/lib/zombie_battleground/api/requests/get_cards_request.rb

@@ -7,33 +7,209 @@ require 'zombie_battleground/api/requests/request_helper'
 
 module ZombieBattleground
   class Api
-    ##
-    # Request validator for GetCards
-    class GetCardsRequest
-      include ActiveModel::Validations
-      include ZombieBattleground::Api::ValidationHelper
-      include ZombieBattleground::Api::RequestHelper
-
-      attr_accessor :id, :mould_id, :version, :kind, :set, :name, :rank, :type, :rarity,
-                    :damage, :health, :cost, :page, :limit
-
-      validate :id_is_a_non_negative_integer
-      validate :mould_id_is_a_string
-      validate :version_is_a_string
-      validate :kind_is_a_string
-      validate :set_is_a_string
-      validate :name_is_a_string
-      validate :rank_is_a_string
-      validate :type_is_a_string
-      validate :rarity_is_a_string
-      validate :damage_is_a_non_negative_integer
-      validate :health_is_a_non_negative_integer
-      validate :cost_is_a_non_negative_integer
-      validate :page_is_a_non_negative_integer
-      validate :limit_is_a_non_negative_integer
-
-      def uri
-        'cards'
+    class Requests
+      ##
+      # Request validator for GetCards
+      class GetCardsRequest
+        include ActiveModel::Validations
+        include ZombieBattleground::Api::ValidationHelper
+        include ZombieBattleground::Api::Requests::RequestHelper
+
+        ##
+        # @!attribute [r] id
+        # Optionally set the Card's id for filtered querying
+        #
+        # @return [Integer]
+        #
+        # @example
+        #   request.id #=> 1
+        #
+        # @api public
+        attr_accessor :id
+
+        ##
+        # @!attribute [r] mould_id
+        # Optionally mould_id the Card's mould_id for filtered querying
+        #
+        # @return [String]
+        #
+        # @example
+        #   request.mould_id #=> "1"
+        #
+        # @api public
+        attr_accessor :mould_id
+
+        ##
+        # @!attribute [r] version
+        # Optionally version the Card's version for filtered querying
+        #
+        # @return [String]
+        #
+        # @example
+        #   request.version #=> "v3"
+        #
+        # @api public
+        attr_accessor :version
+
+        ##
+        # @!attribute [r] set
+        # Optionally set the Card's set for filtered querying
+        #
+        # @return [String]
+        #
+        # @example
+        #   request.set #=> "AIR"
+        #
+        # @api public
+        attr_accessor :kind
+
+        ##
+        # @!attribute [r] set
+        # Optionally set the Card's set for filtered querying
+        #
+        # @return [String]
+        #
+        # @example
+        #   request.set #=> "AIR"
+        #
+        # @api public
+        attr_accessor :set
+
+        ##
+        # @!attribute [r] name
+        # Optionally set the Card's name for filtered querying
+        #
+        # @return [String]
+        #
+        # @example
+        #   request.name #=> "Whizpar"
+        #
+        # @api public
+        attr_accessor :name
+
+        ##
+        # @!attribute [r] rank
+        # Optionally set the Card's rank for filtered querying
+        #
+        # @return [String]
+        #
+        # @example
+        #   request.rank #=> "MINION"
+        #
+        # @api public
+        attr_accessor :rank
+
+        ##
+        # @!attribute [r] type
+        # Optionally set the Card's type for filtered querying
+        #
+        # @return [String]
+        #
+        # @example
+        #   request.type #=> "WALKER"
+        #
+        # @api public
+        attr_accessor :type
+
+        ##
+        # @!attribute [r] rarity
+        # Optionally set the Card's rarity for filtered querying
+        #
+        # @return [String]
+        #
+        # @example
+        #   request.rarity #=> ""
+        #
+        # @api public
+        attr_accessor :rarity
+
+        ##
+        # @!attribute [r] damage
+        # Optionally set the Card's damage for filtered querying
+        #
+        # @return [Integer]
+        #
+        # @example
+        #   request.damage #=> 1
+        #
+        # @api public
+        attr_accessor :damage
+
+        ##
+        # @!attribute [r] health
+        # Optionally set the Card's health for filtered querying
+        #
+        # @return [Integer]
+        #
+        # @example
+        #   request.health #=> 1
+        #
+        # @api public
+        attr_accessor :health
+
+        ##
+        # @!attribute [r] cost
+        # Optionally set the Card's cost for filtered querying
+        #
+        # @return [Integer]
+        #
+        # @example
+        #   request.cost #=> 1
+        #
+        # @api public
+        attr_accessor :cost
+
+        ##
+        # @!attribute [r] page
+        # Optionally set the page number for filtered querying
+        #
+        # @return [Integer]
+        #
+        # @example
+        #   request.page #=> 1
+        #
+        # @api public
+        attr_accessor :page
+
+        ##
+        # @!attribute [r] limit
+        # Optionally set the limit for max Cards returned
+        #
+        # @return [Integer]
+        #
+        # @example
+        #   request.limit #=> 100
+        #
+        # @api public
+        attr_accessor :limit
+
+        validate :id_is_a_non_negative_integer
+        validate :mould_id_is_a_string
+        validate :version_is_a_string
+        validate :kind_is_a_string
+        validate :set_is_a_string
+        validate :name_is_a_string
+        validate :rank_is_a_string
+        validate :type_is_a_string
+        validate :rarity_is_a_string
+        validate :damage_is_a_non_negative_integer
+        validate :health_is_a_non_negative_integer
+        validate :cost_is_a_non_negative_integer
+        validate :page_is_a_non_negative_integer
+        validate :limit_is_a_non_negative_integer
+
+        ##
+        # The URI for the endpoint
+        #
+        # @return [String]
+        #
+        # @example
+        #   request.uri # => "cards"
+        #
+        # @api public
+        def uri
+          'cards'
+        end
       end
     end
   end