zombie_battleground-api 0.1.0 → 0.2.0

data/lib/zombie_battleground/api/errors.rb

@@ -2,17 +2,45 @@
 
 module ZombieBattleground
   class Api
+    ##
+    # Error classes for the API
     class Errors
+      ##
+      # Raised if the endpoint responds with a 400
       class BadRequest < StandardError; end
+
+      ##
+      # Raised if the endpoint responds with a 500
       class InternalServerError < StandardError; end
+
+      ##
+      # Raised if a request validation fails
       class InvalidInput < StandardError; end
+
+      ##
+      # Raised if the endpoint responds with a 404
       class NotFound < StandardError; end
+
+      ##
+      # Raised if the endpoint responds with a 503
       class ServiceUnavailable < StandardError; end
+
+      ##
+      # Raised if the response fails validation
       class UnknownResponse < StandardError; end
 
       ##
       # Creates an error with the Faraday response and the context for the error
       class InvalidResponse < StandardError
+        ##
+        # Creates an exception class with the Faraday response and error context
+        #
+        # @param response [Faraday::Response] response from the endpoint
+        # @param context [Class] parsed response object
+        #
+        # @return [ZombieBattleground::Api::Errors::InvalidResponse]
+        #
+        # @api private
         def initialize(response, context)
           @response = response
           @context = context

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

@@ -7,38 +7,278 @@ require 'zombie_battleground/api/validation_helper'
 module ZombieBattleground
   class Api
     ##
-    # Validator for Card
-    class Card
-      include ActiveModel::Validations
-      include ZombieBattleground::Api::ValidationHelper
-
-      attr_reader :id, :mould_id, :version, :kind, :set, :name, :description, :flavor_text,
-                  :picture, :rank, :type, :rarity, :frame, :damage, :health, :cost,
-                  :ability, :block_height, :image_url
-
-      validate :id_is_a_non_negative_integer
-      validate :mould_id_is_a_string_and_not_null
-      validate :version_is_a_string_and_not_null
-      validate :kind_is_a_string_and_not_null
-      validate :set_is_a_string_and_not_null
-      validate :name_is_a_string_and_not_null
-      validate :description_is_a_string_and_not_null
-      validate :rank_is_a_string_and_not_null
-      validate :type_is_a_string_and_not_null
-      validate :rarity_is_a_string_and_not_null
-      validate :frame_is_a_string_and_not_null
-      validate :damage_is_a_non_negative_integer_and_not_null
-      validate :health_is_a_non_negative_integer_and_not_null
-      validate :cost_is_a_non_negative_integer_and_not_null
-      validate :ability_is_a_string_and_not_null
-      validate :block_height_is_a_non_negative_integer_and_not_null
-      validate :image_url_is_a_string_and_not_null
-
-      def initialize(card)
-        card.each do |key, value|
-          next if value.nil? # this is an illegal response, card id 1 is bogus
-
-          instance_variable_set("@#{key}".to_sym, value)
+    # Namespace for Models
+    class Models
+      ##
+      # Validator for Card
+      class Card
+        include ActiveModel::Validations
+        include ZombieBattleground::Api::ValidationHelper
+
+        ##
+        # @!attribute [r] id
+        # the Cards's id
+        #
+        # @return [Integer]
+        #
+        # @example
+        #   card.id #=> 1
+        #
+        # @api public
+        attr_reader :id
+
+        ##
+        # @!attribute [r] mould_id
+        # the Cards's mould_id
+        #
+        # @return [String]
+        #
+        # @example
+        #   card.mould_id #=> "1"
+        #
+        # @api public
+        attr_reader :mould_id
+
+        ##
+        # @!attribute [r] version
+        # the Cards's version
+        #
+        # @return [String]
+        #
+        # @example
+        #   card.version #=> "v3"
+        #
+        # @api public
+        attr_reader :version
+
+        ##
+        # @!attribute [r] kind
+        # the Cards's kind
+        #
+        # @return [String]
+        #
+        # @example
+        #   card.kind #=> "CREATURE"
+        #
+        # @api public
+        attr_reader :kind
+
+        ##
+        # @!attribute [r] set
+        # the Cards's set
+        #
+        # @return [String]
+        #
+        # @example
+        #   card.set #=> "AIR"
+        #
+        # @api public
+        attr_reader :set
+
+        ##
+        # @!attribute [r] name
+        # the Cards's name
+        #
+        # @return [String]
+        #
+        # @example
+        #   card.name #=> "Whizpar"
+        #
+        # @api public
+        attr_reader :name
+
+        ##
+        # @!attribute [r] description
+        # the Cards's description
+        #
+        # @return [String]
+        #
+        # @example
+        #   card.description #=> "<b>Attack:</b> +1 damage to Water zombies"
+        #
+        # @api public
+        attr_reader :description
+
+        ##
+        # @!attribute [r] flavor_text
+        # the Cards's flavor_text
+        #
+        # @return [String]
+        #
+        # @example
+        #   card.flavor_text #=> "The unfriendly ghost..."
+        #
+        # @api public
+        attr_reader :flavor_text
+
+        ##
+        # @!attribute [r] picture
+        # the Cards's picture
+        #
+        # @return [String]
+        #
+        # @example
+        #   card.picture #=> "Whizpar"
+        #
+        # @api public
+        attr_reader :picture
+
+        ##
+        # @!attribute [r] rank
+        # the Cards's rank
+        #
+        # @return [String]
+        #
+        # @example
+        #   card.rank #=> "MINION"
+        #
+        # @api public
+        attr_reader :rank
+
+        ##
+        # @!attribute [r] type
+        # the Cards's type
+        #
+        # @return [String]
+        #
+        # @example
+        #   card.type #=> "WALKER"
+        #
+        # @api public
+        attr_reader :type
+
+        ##
+        # @!attribute [r] rarity
+        # the Cards's rarity
+        #
+        # @return [String]
+        #
+        # @example
+        #   card.rarity #=> ""
+        #
+        # @api public
+        attr_reader :rarity
+
+        ##
+        # @!attribute [r] frame
+        # the Cards's frame
+        #
+        # @return [String]
+        #
+        # @example
+        #   card.frame #=> ""
+        #
+        # @api public
+        attr_reader :frame
+
+        ##
+        # @!attribute [r] damage
+        # the Cards's damage
+        #
+        # @return [Integer]
+        #
+        # @example
+        #   card.damage #=> 1
+        #
+        # @api public
+        attr_reader :damage
+
+        ##
+        # @!attribute [r] health
+        # the Cards's health
+        #
+        # @return [Integer]
+        #
+        # @example
+        #   card.health #=> 1
+        #
+        # @api public
+        attr_reader :health
+
+        ##
+        # @!attribute [r] cost
+        # the Cards's cost
+        #
+        # @return [Integer]
+        #
+        # @example
+        #   card.cost #=> 1
+        #
+        # @api public
+        attr_reader :cost
+
+        ##
+        # @!attribute [r] ability
+        # the Cards's ability
+        #
+        # @return [String]
+        #
+        # @example
+        #   card.ability #=> ""
+        #
+        # @api public
+        attr_reader :ability
+
+        ##
+        # @!attribute [r] block_height
+        # the Cards's block_height
+        #
+        # @return [Integer]
+        #
+        # @example
+        #   card.block_height #=> 0
+        #
+        # @api public
+        attr_reader :block_height
+
+        ##
+        # @!attribute [r] image_url
+        # the Cards's image_url
+        #
+        # @return [String]
+        #
+        # @example
+        #   card.image_url #=> "https://loom.games/img/cards/001.png"
+        #
+        # @api public
+        attr_reader :image_url
+
+        validate :id_is_a_non_negative_integer
+        validate :mould_id_is_a_string_and_not_null
+        validate :version_is_a_string_and_not_null
+        validate :kind_is_a_string_and_not_null
+        validate :set_is_a_string_and_not_null
+        validate :name_is_a_string_and_not_null
+        validate :description_is_a_string_and_not_null
+        validate :rank_is_a_string_and_not_null
+        validate :type_is_a_string_and_not_null
+        validate :rarity_is_a_string_and_not_null
+        validate :frame_is_a_string_and_not_null
+        validate :damage_is_a_non_negative_integer_and_not_null
+        validate :health_is_a_non_negative_integer_and_not_null
+        validate :cost_is_a_non_negative_integer_and_not_null
+        validate :ability_is_a_string_and_not_null
+        validate :block_height_is_a_non_negative_integer_and_not_null
+        validate :image_url_is_a_string_and_not_null
+
+        ##
+        # Creates a new Card
+        #
+        # @param card [Hash] Parsed JSON response
+        #
+        # @return [ZombieBattleground::Api::Card]
+        #
+        # @example
+        #   card = ZombieBattleground::Api::Card.new(parsed_json)
+        #   # => ZombieBattleground::Api::Card
+        #
+        # @api public
+        def initialize(card)
+          card.each do |key, value|
+            next if value.nil? # this is an illegal response, card id 1 is bogus
+
+            instance_variable_set("@#{key}".to_sym, value)
+          end
         end
       end
     end

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

@@ -7,57 +7,245 @@ require 'zombie_battleground/api/models/simple_card'
 
 module ZombieBattleground
   class Api
-    ##
-    # Validator for Deck
-    class Deck
-      include ActiveModel::Validations
-      include ZombieBattleground::Api::ValidationHelper
-
-      attr_reader :id, :created_at, :updated_at, :user_id, :deck_id, :name, :hero_id,
-                  :cards, :primary_skill_id, :secondary_skill_id, :version, :sender_address,
-                  :block_height, :is_deleted
-
-      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 :user_id_is_a_string_and_not_null
-      validate :deck_id_is_a_non_negative_integer_and_not_null
-      validate :name_is_a_string_and_not_null
-      validate :hero_id_is_a_non_negative_integer_and_not_null
-      validate :cards_is_an_array_of_simple_card
-      validate :primary_skill_id_is_a_non_negative_integer_and_not_null
-      validate :secondary_skill_id_is_a_non_negative_integer_and_not_null
-      validate :version_is_a_string_and_not_null
-      validate :sender_address_is_a_string_and_not_null
-      validate :block_height_is_a_non_negative_integer_and_not_null
-      validates :is_deleted, inclusion: { in: [true, false] }
-
-      def initialize(deck)
-        deck.each do |key, value|
-          next if value.nil? # this is an illegal response, deck id 1 is bogus
-
-          if key == 'cards'
-            instance_variable_set("@#{key}".to_sym, value.map { |card| ZombieBattleground::Api::SimpleCard.new(card) })
-          elsif %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 Deck
+      class Deck
+        include ActiveModel::Validations
+        include ZombieBattleground::Api::ValidationHelper
+
+        ##
+        # @!attribute [r] id
+        # Deck's id
+        #
+        # @return [Integer]
+        #
+        # @example
+        #   deck.id #=> 1812
+        #
+        # @api public
+        attr_reader :id
+
+        ##
+        # @!attribute [r] created_at
+        # the Deck's created_at time
+        #
+        # @return [Time]
+        #
+        # @example
+        #   deck.created_at #=> Time
+        #
+        # @api public
+        attr_reader :created_at
+
+        ##
+        # @!attribute [r] updated_at
+        # the Deck's updated_at time
+        #
+        # @return [Time]
+        #
+        # @example
+        #   deck.updated_at #=> Time
+        #
+        # @api public
+        attr_reader :updated_at
+
+        ##
+        # @!attribute [r] user_id
+        # the Deck's user_id
+        #
+        # @return [String]
+        #
+        # @example
+        #   deck.user_id #=> "ZombieSlayer_5773"
+        #
+        # @api public
+        attr_reader :user_id
+
+        ##
+        # @!attribute [r] deck_id
+        # the Deck's deck_id
+        #
+        # @return [Integer]
+        #
+        # @example
+        #   deck.deck_id #=> 4
+        #
+        # @api public
+        attr_reader :deck_id
+
+        ##
+        # @!attribute [r] name
+        # the Deck's name
+        #
+        # @return [String]
+        #
+        # @example
+        #   deck.name #=> "Leaf Midrange"
+        #
+        # @api public
+        attr_reader :name
+
+        ##
+        # @!attribute [r] hero_id
+        # the Deck's hero_id
+        #
+        # @return [Integer]
+        #
+        # @example
+        #   deck.hero_id #=> 5
+        #
+        # @api public
+        attr_reader :hero_id
+
+        ##
+        # @!attribute [r] cards
+        # the Deck's cards
+        #
+        # @return [Array<ZombieBattleground::Api::Models::SimpleCard>]
+        #
+        # @example
+        #   deck.cards #=> [ZombieBattleground::Api::Models::SimpleCard]
+        #
+        # @api public
+        attr_reader :cards
+
+        ##
+        # @!attribute [r] primary_skill_id
+        # the Deck's primary_skill_id
+        #
+        # @return [Integer]
+        #
+        # @example
+        #   deck.primary_skill_id #=> 19
+        #
+        # @api public
+        attr_reader :primary_skill_id
+
+        ##
+        # @!attribute [r] secondary_skill_id
+        # the Deck's secondary_skill_id
+        #
+        # @return [Integer]
+        #
+        # @example
+        #   deck.secondary_skill_id #=> 18
+        #
+        # @api public
+        attr_reader :secondary_skill_id
+
+        ##
+        # @!attribute [r] version
+        # the Deck's version
+        #
+        # @return [String]
+        #
+        # @example
+        #   deck.version #=> "v5"
+        #
+        # @api public
+        attr_reader :version
+
+        ##
+        # @!attribute [r] sender_address
+        # the Deck's sender_address
+        #
+        # @return [String]
+        #
+        # @example
+        #   deck.sender_address #=> "0x62bb8C4452c3Fa7E9eEd6D9Ceaa4d3fe8E18E249"
+        #
+        # @api public
+        attr_reader :sender_address
+
+        ##
+        # @!attribute [r] block_height
+        # the Deck's block_height
+        #
+        # @return [Integer]
+        #
+        # @example
+        #   deck.block_height #=> 939237
+        #
+        # @api public
+        attr_reader :block_height
+
+        ##
+        # @!attribute [r] is_deleted
+        # the Deck's is_deleted
+        #
+        # @return [Boolean]
+        #
+        # @example
+        #   deck.is_deleted #=> false
+        #
+        # @api public
+        attr_reader :is_deleted
+
+        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 :user_id_is_a_string_and_not_null
+        validate :deck_id_is_a_non_negative_integer_and_not_null
+        validate :name_is_a_string_and_not_null
+        validate :hero_id_is_a_non_negative_integer_and_not_null
+        validate :cards_is_an_array_of_simple_card
+        validate :primary_skill_id_is_a_non_negative_integer_and_not_null
+        validate :secondary_skill_id_is_a_non_negative_integer_and_not_null
+        validate :version_is_a_string_and_not_null
+        validate :sender_address_is_a_string_and_not_null
+        validate :block_height_is_a_non_negative_integer_and_not_null
+        validates :is_deleted, inclusion: { in: [true, false] }
+
+        ##
+        # Creates a new Deck
+        #
+        # @param card [Hash] Parsed JSON response
+        #
+        # @return [ZombieBattleground::Api::Deck]
+        #
+        # @example
+        #   deck = ZombieBattleground::Api::Deck.new(parsed_json)
+        #   # => ZombieBattleground::Api::Deck
+        #
+        # @api public
+        def initialize(deck)
+          deck.each do |key, value|
+            next if value.nil? # this is an illegal response, deck id 1 is bogus
+
+            if key == 'cards'
+              instance_variable_set(
+                "@#{key}".to_sym, value.map { |card| ZombieBattleground::Api::Models::SimpleCard.new(card) }
+              )
+            elsif %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
 
-      def cards_is_an_array_of_simple_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::SimpleCard) &&
-                  card.valid? &&
-                  card.errors.size.zero?
+        ##
+        # Validator for cards attribute
+        #
+        # @return [void]
+        #
+        # @api private
+        def cards_is_an_array_of_simple_card
+          unless @cards.is_a?(Array)
+            errors.add(:cards, 'cards must be an Array')
+            return
+          end
 
-          errors.add(:cards, 'cards must be an array of SimpleCard')
+          @cards.each do |card|
+            next if card.is_a?(ZombieBattleground::Api::Models::SimpleCard) &&
+                    card.valid? &&
+                    card.errors.size.zero?
+
+            errors.add(:cards, 'cards must be an array of SimpleCard')
+          end
         end
       end
     end