zombie_battleground-api 0.1.0 → 0.2.0

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

@@ -7,23 +7,53 @@ require 'zombie_battleground/api/requests/request_helper'
 
 module ZombieBattleground
   class Api
-    ##
-    # Request validator for GetDeck
-    class GetDeckRequest
-      include ActiveModel::Validations
-      include ZombieBattleground::Api::ValidationHelper
-      include ZombieBattleground::Api::RequestHelper
+    class Requests
+      ##
+      # Request validator for GetDeck
+      class GetDeckRequest
+        include ActiveModel::Validations
+        include ZombieBattleground::Api::ValidationHelper
+        include ZombieBattleground::Api::Requests::RequestHelper
 
-      attr_accessor :id
+        ##
+        # @!attribute [r] id
+        # Deck's id
+        #
+        # @return [Integer]
+        #
+        # @example
+        #   request.id #=> 1812
+        #
+        # @api public
+        attr_accessor :id
 
-      validate :id_is_a_non_negative_integer
+        validate :id_is_a_non_negative_integer
 
-      def uri
-        "deck/#{id}"
-      end
+        ##
+        # The URI for the endpoint
+        #
+        # @return [String]
+        #
+        # @example
+        #   request.uri # => "deck/1812"
+        #
+        # @api public
+        def uri
+          "deck/#{id}"
+        end
 
-      def params
-        {}
+        ##
+        # Deck does not take params, return an empty Hash
+        #
+        # @return [Hash]
+        #
+        # @example
+        #   request.params # => {}
+        #
+        # @api public
+        def params
+          {}
+        end
       end
     end
   end

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

@@ -7,29 +7,147 @@ require 'zombie_battleground/api/requests/request_helper'
 
 module ZombieBattleground
   class Api
-    ##
-    # Request validator for GetDecks
-    class GetDecksRequest
-      include ActiveModel::Validations
-      include ZombieBattleground::Api::ValidationHelper
-      include ZombieBattleground::Api::RequestHelper
-
-      attr_accessor :id, :user_id, :deck_id, :name, :hero_id, :primary_skill_id,
-                    :secondary_skill_id, :version, :page, :limit
-
-      validate :id_is_a_non_negative_integer
-      validate :user_id_is_a_string
-      validate :deck_id_is_a_non_negative_integer
-      validate :name_is_a_string
-      validate :hero_id_is_a_non_negative_integer
-      validate :primary_skill_id_is_a_non_negative_integer
-      validate :secondary_skill_id_is_a_non_negative_integer
-      validate :version_is_a_string
-      validate :page_is_a_non_negative_integer
-      validate :limit_is_a_non_negative_integer
-
-      def uri
-        'decks'
+    class Requests
+      ##
+      # Request validator for GetDecks
+      class GetDecksRequest
+        include ActiveModel::Validations
+        include ZombieBattleground::Api::ValidationHelper
+        include ZombieBattleground::Api::Requests::RequestHelper
+
+        # @!attribute [r] id
+        # Optionally set the Deck's id for filtered querying
+        #
+        # @return [Integer]
+        #
+        # @example
+        #   request.id #=> 1
+        #
+        # @api public
+        attr_accessor :id
+
+        # @!attribute [r] user_id
+        # Optionally set the Deck's user_id for filtered querying
+        #
+        # @return [String]
+        #
+        # @example
+        #   request.user_id #=> "ZombieSlayer_5699"
+        #
+        # @api public
+        attr_accessor :user_id
+
+        # @!attribute [r] deck_id
+        # Optionally set the Deck's deck_id for filtered querying
+        #
+        # @return [Integer]
+        #
+        # @example
+        #   request.deck_id #=> 1
+        #
+        # @api public
+        attr_accessor :deck_id
+
+        # @!attribute [r] name
+        # Optionally set the Deck's name for filtered querying
+        #
+        # @return [String]
+        #
+        # @example
+        #   request.name #=> "Buzzkill"
+        #
+        # @api public
+        attr_accessor :name
+
+        # @!attribute [r] hero_id
+        # Optionally set the Deck's hero_id for filtered querying
+        #
+        # @return [Integer]
+        #
+        # @example
+        #   request.hero_id #=> 1
+        #
+        # @api public
+        attr_accessor :hero_id
+
+        # @!attribute [r] primary_skill_id
+        # Optionally set the Deck's primary_skill_id for filtered querying
+        #
+        # @return [Integer]
+        #
+        # @example
+        #   request.primary_skill_id #=> 1
+        #
+        # @api public
+        attr_accessor :primary_skill_id
+
+        # @!attribute [r] secondary_skill_id
+        # Optionally set the Deck's secondary_skill_id for filtered querying
+        #
+        # @return [Integer]
+        #
+        # @example
+        #   request.secondary_skill_id #=> 1
+        #
+        # @api public
+        attr_accessor :secondary_skill_id
+
+        # @!attribute [r] version
+        # Optionally set the Deck's version for filtered querying
+        #
+        # @return [String]
+        #
+        # @example
+        #   request.version #=> "v3"
+        #
+        # @api public
+        attr_accessor :version
+
+        # @!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 Matches returned
+        #
+        # @return [Integer]
+        #
+        # @example
+        #   request.limit #=> 100
+        #
+        # @api public
+        attr_accessor :limit
+
+        validate :id_is_a_non_negative_integer
+        validate :user_id_is_a_string
+        validate :deck_id_is_a_non_negative_integer
+        validate :name_is_a_string
+        validate :hero_id_is_a_non_negative_integer
+        validate :primary_skill_id_is_a_non_negative_integer
+        validate :secondary_skill_id_is_a_non_negative_integer
+        validate :version_is_a_string
+        validate :page_is_a_non_negative_integer
+        validate :limit_is_a_non_negative_integer
+
+        ##
+        # The URI for the endpoint
+        #
+        # @return [String]
+        #
+        # @example
+        #   request.uri # => "decks"
+        #
+        # @api public
+        def uri
+          'decks'
+        end
       end
     end
   end

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

@@ -7,23 +7,53 @@ require 'zombie_battleground/api/requests/request_helper'
 
 module ZombieBattleground
   class Api
-    ##
-    # Request validator for GetMatch
-    class GetMatchRequest
-      include ActiveModel::Validations
-      include ZombieBattleground::Api::ValidationHelper
-      include ZombieBattleground::Api::RequestHelper
+    class Requests
+      ##
+      # Request validator for GetMatch
+      class GetMatchRequest
+        include ActiveModel::Validations
+        include ZombieBattleground::Api::ValidationHelper
+        include ZombieBattleground::Api::Requests::RequestHelper
 
-      attr_accessor :id
+        ##
+        # @!attribute [r] id
+        # Match's id
+        #
+        # @return [Integer]
+        #
+        # @example
+        #   request.id #=> 1
+        #
+        # @api public
+        attr_accessor :id
 
-      validate :id_is_a_non_negative_integer
+        validate :id_is_a_non_negative_integer
 
-      def uri
-        "match/#{id}"
-      end
+        ##
+        # The URI for the endpoint
+        #
+        # @return [String]
+        #
+        # @example
+        #   request.uri # => "match/1"
+        #
+        # @api public
+        def uri
+          "match/#{id}"
+        end
 
-      def params
-        {}
+        ##
+        # Match does not take params, return an empty Hash
+        #
+        # @return [Hash]
+        #
+        # @example
+        #   request.params # => {}
+        #
+        # @api public
+        def params
+          {}
+        end
       end
     end
   end

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

@@ -7,27 +7,131 @@ require 'zombie_battleground/api/requests/request_helper'
 
 module ZombieBattleground
   class Api
-    ##
-    # Request validator for GetMatches
-    class GetMatchesRequest
-      include ActiveModel::Validations
-      include ZombieBattleground::Api::ValidationHelper
-      include ZombieBattleground::Api::RequestHelper
-
-      attr_accessor :id, :player1_id, :player2_id, :status, :version, :winner_id,
-                    :total, :page, :limit
-
-      validate :id_is_a_non_negative_integer
-      validate :player1_id_is_a_string
-      validate :player2_id_is_a_string
-      validate :status_is_a_string
-      validate :version_is_a_string
-      validate :winner_id_is_a_string
-      validate :page_is_a_non_negative_integer
-      validate :limit_is_a_non_negative_integer
-
-      def uri
-        'matches'
+    class Requests
+      ##
+      # Request validator for GetMatches
+      class GetMatchesRequest
+        include ActiveModel::Validations
+        include ZombieBattleground::Api::ValidationHelper
+        include ZombieBattleground::Api::Requests::RequestHelper
+
+        ##
+        # @!attribute [r] id
+        # Optionally set the Match's id for filtered querying
+        #
+        # @return [Integer]
+        #
+        # @example
+        #   request.id #=> 1
+        #
+        # @api public
+        attr_accessor :id
+
+        ##
+        # @!attribute [r] player1_id
+        # Optionally set the Match's player1_id for filtered querying
+        #
+        # @return [String]
+        #
+        # @example
+        #   request.player1_id #=> "ZombieSlayer_16601021609396167139295300949176"
+        #
+        # @api public
+        attr_accessor :player1_id
+
+        ##
+        # @!attribute [r] player2_id
+        # Optionally set the Match's player2_id for filtered querying
+        #
+        # @return [String]
+        #
+        # @example
+        #   request.player2_id #=> "ZombieSlayer_16601021609396167139295300949176"
+        #
+        # @api public
+        attr_accessor :player2_id
+
+        ##
+        # @!attribute [r] status
+        # Optionally set the Match's status for filtered querying
+        #
+        # @return [String]
+        #
+        # @example
+        #   request.status #=> "Ended"
+        #
+        # @api public
+        attr_accessor :status
+
+        ##
+        # @!attribute [r] version
+        # Optionally set the Match's version for filtered querying
+        #
+        # @return [String]
+        #
+        # @example
+        #   request.version #=> "v3"
+        #
+        # @api public
+        attr_accessor :version
+
+        ##
+        # @!attribute [r] winner_id
+        # Optionally set the Match's winner_id for filtered querying
+        #
+        # @return [String]
+        #
+        # @example
+        #   request.winner_id #=> "ZombieSlayer_16601021609396167139295300949176"
+        #
+        # @api public
+        attr_accessor :winner_id
+
+        ##
+        # @!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 Matches returned
+        #
+        # @return [Integer]
+        #
+        # @example
+        #   request.limit #=> 100
+        #
+        # @api public
+        attr_accessor :limit
+
+        validate :id_is_a_non_negative_integer
+        validate :player1_id_is_a_string
+        validate :player2_id_is_a_string
+        validate :status_is_a_string
+        validate :version_is_a_string
+        validate :winner_id_is_a_string
+        validate :page_is_a_non_negative_integer
+        validate :limit_is_a_non_negative_integer
+
+        ##
+        # The URI for the endpoint
+        #
+        # @return [String]
+        #
+        # @example
+        #   request.uri # => "matches"
+        #
+        # @api public
+        def uri
+          'matches'
+        end
       end
     end
   end