zombie_battleground-api 0.1.0 → 0.2.0

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

@@ -2,18 +2,32 @@
 
 module ZombieBattleground
   class Api
-    ##
-    # Provides generic methods for request validator classes
-    module RequestHelper
-      BLACKLISTED_INSTANCE_VARIABLES = %w[errors validation_context].freeze
+    class Requests
+      ##
+      # Provides generic methods for request validator classes
+      module RequestHelper
+        ##
+        # Instance variables to skip when computing the model's query paramaters
+        BLACKLISTED_INSTANCE_VARIABLES = %w[errors validation_context].freeze
 
-      def params
-        instance_variables.map do |var|
-          normalized_var = var.to_s.gsub(/^@/, '')
-          next if BLACKLISTED_INSTANCE_VARIABLES.include?(normalized_var)
+        ##
+        # Computes the model's query paramaters
+        #
+        # @return [Hash]
+        #
+        # @example
+        #   query_params = model.params
+        #   query_params # => Hash
+        #
+        # @api public
+        def params
+          instance_variables.map do |var|
+            normalized_var = var.to_s.gsub(/^@/, '')
+            next if BLACKLISTED_INSTANCE_VARIABLES.include?(normalized_var)
 
-          [normalized_var, instance_variable_get(var)]
-        end.compact.to_h
+            [normalized_var, instance_variable_get(var)]
+          end.compact.to_h
+        end
       end
     end
   end

data/lib/zombie_battleground/api/responses/get_card_response.rb

@@ -10,28 +10,62 @@ require 'zombie_battleground/api/responses/response_helper'
 module ZombieBattleground
   class Api
     ##
-    # Response validator for GetCard
-    class GetCardResponse
-      include ActiveModel::Validations
-      include ZombieBattleground::Api::ValidationHelper
-      include ZombieBattleground::Api::ResponseHelper
+    # Namespace for Responses
+    class Responses
+      ##
+      # Response validator for GetCard
+      class GetCardResponse
+        include ActiveModel::Validations
+        include ZombieBattleground::Api::ValidationHelper
+        include ZombieBattleground::Api::Responses::ResponseHelper
 
-      attr_reader :card
+        ##
+        # @!attribute [r] card
+        # the card
+        #
+        # @return [ZombieBattleground::Api::Deck]
+        #
+        # @example
+        #   response.card #=> ZombieBattleground::Api::Deck
+        #
+        # @api public
+        attr_reader :card
 
-      validate :card_is_a_card
+        validate :card_is_a_card
 
-      def initialize(response)
-        handle_errors(response)
+        ##
+        # Creates a new GetCardResponse
+        #
+        # @param response [Faraday::Response] Faraday response from endpoint
+        #
+        # @return [ZombieBattleground::Api::GetCardResponse]
+        #
+        # @example
+        #   response = ZombieBattleground::Api::GetCardResponse.new(faraday_response)
+        #   # => ZombieBattleground::Api::GetCardResponse
+        #
+        # @api public
+        def initialize(response)
+          handle_errors(response)
 
-        @card = ZombieBattleground::Api::Card.new(JSON.parse(response.body))
-      end
+          @card = ZombieBattleground::Api::Models::Card.new(JSON.parse(response.body))
+        end
+
+        private
 
-      def card_is_a_card
-        return if @card.is_a?(ZombieBattleground::Api::Card) &&
-                  @card.valid? &&
-                  @card.errors.size.zero?
+        ##
+        # Validator for card attribute
+        #
+        # @return [void]
+        #
+        # @api private
+        def card_is_a_card
+          return if @card.is_a?(ZombieBattleground::Api::Models::Card) &&
+                    @card.valid? &&
+                    @card.errors.size.zero?
 
-        errors.add(:card, 'card must be a Card')
+          errors.add(:card, 'card must be a Card')
+        end
       end
     end
   end

data/lib/zombie_battleground/api/responses/get_cards_response.rb

@@ -9,44 +9,114 @@ require 'zombie_battleground/api/responses/response_helper'
 
 module ZombieBattleground
   class Api
-    ##
-    # Response validator for GetCards
-    class GetCardsResponse
-      include ActiveModel::Validations
-      include ZombieBattleground::Api::ValidationHelper
-      include ZombieBattleground::Api::ResponseHelper
-
-      attr_reader :total, :page, :limit, :cards
-
-      validate :total_is_a_non_negative_integer
-      validate :page_is_a_non_negative_integer
-      validate :limit_is_a_non_negative_integer
-      validate :cards_is_an_array_of_card
-
-      def initialize(response)
-        handle_errors(response)
-
-        JSON.parse(response.body).each do |key, value|
-          if key == 'cards'
-            instance_variable_set("@#{key}".to_sym, value.map { |card| ZombieBattleground::Api::Card.new(card) })
-          else
-            instance_variable_set("@#{key}".to_sym, value)
+    class Responses
+      ##
+      # Response validator for GetCards
+      class GetCardsResponse
+        include ActiveModel::Validations
+        include ZombieBattleground::Api::ValidationHelper
+        include ZombieBattleground::Api::Responses::ResponseHelper
+
+        ##
+        # @!attribute [r] total
+        # the total number of results available
+        #
+        # @return [Integer]
+        #
+        # @example
+        #   response.total #=> 1505
+        #
+        # @api public
+        attr_reader :total
+
+        ##
+        # @!attribute [r] page
+        # the page number of the results
+        #
+        # @return [Integer]
+        #
+        # @example
+        #   response.page #=> 1
+        #
+        # @api public
+        attr_reader :page
+
+        ##
+        # @!attribute [r] limit
+        # the limit of results for the page
+        #
+        # @return [Integer]
+        #
+        # @example
+        #   response.limit #=> 100
+        #
+        # @api public
+        attr_reader :limit
+
+        ##
+        # @!attribute [r] cards
+        # the deck found for the page and limit
+        #
+        # @return [Array<ZombieBattleground::Api::Models::Card>]
+        #
+        # @example
+        #   response.deck #=> [ZombieBattleground::Api::Models::Card]
+        #
+        # @api public
+        attr_reader :cards
+
+        validate :total_is_a_non_negative_integer
+        validate :page_is_a_non_negative_integer
+        validate :limit_is_a_non_negative_integer
+        validate :cards_is_an_array_of_card
+
+        ##
+        # Creates a new GetCardsResponse
+        #
+        # @param response [Faraday::Response] Faraday response from endpoint
+        #
+        # @return [ZombieBattleground::Api::GetCardsResponse]
+        #
+        # @example
+        #   response = ZombieBattleground::Api::GetCardsResponse.new(faraday_response)
+        #   # => ZombieBattleground::Api::GetCardsResponse
+        #
+        # @api public
+        def initialize(response)
+          handle_errors(response)
+
+          JSON.parse(response.body).each do |key, value|
+            if key == 'cards'
+              instance_variable_set(
+                "@#{key}".to_sym, value.map { |card| ZombieBattleground::Api::Models::Card.new(card) }
+              )
+            else
+              instance_variable_set("@#{key}".to_sym, value)
+            end
           end
         end
-      end
 
-      def cards_is_an_array_of_card
-        unless @cards.is_a?(Array)
-          errors.add(:cards, 'Cards must be an array')
-          return
-        end
+        private
 
-        @cards.each do |card|
-          next if card.is_a?(ZombieBattleground::Api::Card) &&
-                  card.valid? &&
-                  card.errors.size.zero?
+        ##
+        # Validator for cards attribute
+        #
+        # @return [void]
+        #
+        # @api private
+        def cards_is_an_array_of_card
+          unless @cards.is_a?(Array)
+            errors.add(:cards, 'Cards must be an array')
+            return
+          end
+
+          @cards.each do |card|
+            next if card.is_a?(ZombieBattleground::Api::Models::Card) &&
+                    card.valid? &&
+                    card.errors.size.zero?
 
-          errors.add(:cards, 'cards must be an array of Card')
+            errors.add(:cards, 'cards must be an array of Card')
+          end
         end
       end
     end

data/lib/zombie_battleground/api/responses/get_deck_response.rb

@@ -9,29 +9,61 @@ require 'zombie_battleground/api/responses/response_helper'
 
 module ZombieBattleground
   class Api
-    ##
-    # Response validator for GetDeck
-    class GetDeckResponse
-      include ActiveModel::Validations
-      include ZombieBattleground::Api::ValidationHelper
-      include ZombieBattleground::Api::ResponseHelper
+    class Responses
+      ##
+      # Response validator for GetDeck
+      class GetDeckResponse
+        include ActiveModel::Validations
+        include ZombieBattleground::Api::ValidationHelper
+        include ZombieBattleground::Api::Responses::ResponseHelper
 
-      attr_reader :deck
+        ##
+        # @!attribute [r] deck
+        # the deck
+        #
+        # @return [ZombieBattleground::Api::Models::Deck]
+        #
+        # @example
+        #   response.deck #=> ZombieBattleground::Api::Models::Deck
+        #
+        # @api public
+        attr_reader :deck
 
-      validate :deck_is_a_deck
+        validate :deck_is_a_deck
 
-      def initialize(response)
-        handle_errors(response)
+        ##
+        # Creates a new GetDeckResponse
+        #
+        # @param response [Faraday::Response] Faraday response from endpoint
+        #
+        # @return [ZombieBattleground::Api::GetDeckResponse]
+        #
+        # @example
+        #   response = ZombieBattleground::Api::GetDeckResponse.new(faraday_response)
+        #   # => ZombieBattleground::Api::GetDeckResponse
+        #
+        # @api public
+        def initialize(response)
+          handle_errors(response)
 
-        @deck = ZombieBattleground::Api::Deck.new(JSON.parse(response.body))
-      end
+          @deck = ZombieBattleground::Api::Models::Deck.new(JSON.parse(response.body))
+        end
+
+        private
 
-      def deck_is_a_deck
-        return if @deck.is_a?(ZombieBattleground::Api::Deck) &&
-                  @deck.valid? &&
-                  @deck.errors.size.zero?
+        ##
+        # Validator for deck attribute
+        #
+        # @return [void]
+        #
+        # @api private
+        def deck_is_a_deck
+          return if @deck.is_a?(ZombieBattleground::Api::Models::Deck) &&
+                    @deck.valid? &&
+                    @deck.errors.size.zero?
 
-        errors.add(:deck, 'deck must be a Deck')
+          errors.add(:deck, 'deck must be a Deck')
+        end
       end
     end
   end

data/lib/zombie_battleground/api/responses/get_decks_response.rb

@@ -9,44 +9,114 @@ require 'zombie_battleground/api/responses/response_helper'
 
 module ZombieBattleground
   class Api
-    ##
-    # Response validator for GetDecks
-    class GetDecksResponse
-      include ActiveModel::Validations
-      include ZombieBattleground::Api::ValidationHelper
-      include ZombieBattleground::Api::ResponseHelper
-
-      attr_reader :total, :page, :limit, :decks
-
-      validate :total_is_a_non_negative_integer
-      validate :page_is_a_non_negative_integer
-      validate :limit_is_a_non_negative_integer
-      validate :decks_is_an_array_of_deck
-
-      def initialize(response)
-        handle_errors(response)
-
-        JSON.parse(response.body).each do |key, value|
-          if key == 'decks'
-            instance_variable_set("@#{key}".to_sym, value.map { |deck| ZombieBattleground::Api::Deck.new(deck) })
-          else
-            instance_variable_set("@#{key}".to_sym, value)
+    class Responses
+      ##
+      # Response validator for GetDecks
+      class GetDecksResponse
+        include ActiveModel::Validations
+        include ZombieBattleground::Api::ValidationHelper
+        include ZombieBattleground::Api::Responses::ResponseHelper
+
+        ##
+        # @!attribute [r] total
+        # the total number of results available
+        #
+        # @return [Integer]
+        #
+        # @example
+        #   response.total #=> 1505
+        #
+        # @api public
+        attr_reader :total
+
+        ##
+        # @!attribute [r] page
+        # the page number of the results
+        #
+        # @return [Integer]
+        #
+        # @example
+        #   response.page #=> 1
+        #
+        # @api public
+        attr_reader :page
+
+        ##
+        # @!attribute [r] limit
+        # the limit of results for the page
+        #
+        # @return [Integer]
+        #
+        # @example
+        #   response.limit #=> 100
+        #
+        # @api public
+        attr_reader :limit
+
+        ##
+        # @!attribute [r] decks
+        # the deck found for the page and limit
+        #
+        # @return [Array<ZombieBattleground::Api::Models::Deck>]
+        #
+        # @example
+        #   response.deck #=> [ZombieBattleground::Api::Models::Deck]
+        #
+        # @api public
+        attr_reader :decks
+
+        validate :total_is_a_non_negative_integer
+        validate :page_is_a_non_negative_integer
+        validate :limit_is_a_non_negative_integer
+        validate :decks_is_an_array_of_deck
+
+        ##
+        # Creates a new GetDecksResponse
+        #
+        # @param response [Faraday::Response] Faraday response from endpoint
+        #
+        # @return [ZombieBattleground::Api::GetDecksResponse]
+        #
+        # @example
+        #   response = ZombieBattleground::Api::GetDecksResponse.new(faraday_response)
+        #   # => ZombieBattleground::Api::GetDecksResponse
+        #
+        # @api public
+        def initialize(response)
+          handle_errors(response)
+
+          JSON.parse(response.body).each do |key, value|
+            if key == 'decks'
+              instance_variable_set(
+                "@#{key}".to_sym, value.map { |deck| ZombieBattleground::Api::Models::Deck.new(deck) }
+              )
+            else
+              instance_variable_set("@#{key}".to_sym, value)
+            end
           end
         end
-      end
 
-      def decks_is_an_array_of_deck
-        unless @decks.is_a?(Array)
-          errors.add(:decks, 'Decks must be an array')
-          return
-        end
+        private
 
-        @decks.each do |deck|
-          next if deck.is_a?(ZombieBattleground::Api::Deck) &&
-                  deck.valid? &&
-                  deck.errors.size.zero?
+        ##
+        # Validator for decks attribute
+        #
+        # @return [void]
+        #
+        # @api private
+        def decks_is_an_array_of_deck
+          unless @decks.is_a?(Array)
+            errors.add(:decks, 'Decks must be an array')
+            return
+          end
+
+          @decks.each do |deck|
+            next if deck.is_a?(ZombieBattleground::Api::Models::Deck) &&
+                    deck.valid? &&
+                    deck.errors.size.zero?
 
-          errors.add(:decks, 'decks must be an array of Deck')
+            errors.add(:decks, 'decks must be an array of Deck')
+          end
         end
       end
     end