zombie_battleground-api 0.1.0

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

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require 'active_record'
+
+require 'zombie_battleground/api/validation_helper'
+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'
+      end
+    end
+  end
+end

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

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require 'active_record'
+
+require 'zombie_battleground/api/validation_helper'
+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
+
+      attr_accessor :id
+
+      validate :id_is_a_non_negative_integer
+
+      def uri
+        "match/#{id}"
+      end
+
+      def params
+        {}
+      end
+    end
+  end
+end

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

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require 'active_record'
+
+require 'zombie_battleground/api/validation_helper'
+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'
+      end
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module ZombieBattleground
+  class Api
+    ##
+    # Provides generic methods for request validator classes
+    module RequestHelper
+      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)
+
+          [normalized_var, instance_variable_get(var)]
+        end.compact.to_h
+      end
+    end
+  end
+end

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

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require 'active_record'
+require 'json'
+
+require 'zombie_battleground/api/models/card'
+require 'zombie_battleground/api/validation_helper'
+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
+
+      attr_reader :card
+
+      validate :card_is_a_card
+
+      def initialize(response)
+        handle_errors(response)
+
+        @card = ZombieBattleground::Api::Card.new(JSON.parse(response.body))
+      end
+
+      def card_is_a_card
+        return if @card.is_a?(ZombieBattleground::Api::Card) &&
+                  @card.valid? &&
+                  @card.errors.size.zero?
+
+        errors.add(:card, 'card must be a Card')
+      end
+    end
+  end
+end

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

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require 'active_record'
+require 'json'
+
+require 'zombie_battleground/api/models/card'
+require 'zombie_battleground/api/validation_helper'
+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)
+          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
+
+        @cards.each do |card|
+          next if card.is_a?(ZombieBattleground::Api::Card) &&
+                  card.valid? &&
+                  card.errors.size.zero?
+
+          errors.add(:cards, 'cards must be an array of Card')
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require 'active_record'
+require 'json'
+
+require 'zombie_battleground/api/models/deck'
+require 'zombie_battleground/api/validation_helper'
+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
+
+      attr_reader :deck
+
+      validate :deck_is_a_deck
+
+      def initialize(response)
+        handle_errors(response)
+
+        @deck = ZombieBattleground::Api::Deck.new(JSON.parse(response.body))
+      end
+
+      def deck_is_a_deck
+        return if @deck.is_a?(ZombieBattleground::Api::Deck) &&
+                  @deck.valid? &&
+                  @deck.errors.size.zero?
+
+        errors.add(:deck, 'deck must be a Deck')
+      end
+    end
+  end
+end

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

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require 'active_record'
+require 'json'
+
+require 'zombie_battleground/api/models/deck'
+require 'zombie_battleground/api/validation_helper'
+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)
+          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
+
+        @decks.each do |deck|
+          next if deck.is_a?(ZombieBattleground::Api::Deck) &&
+                  deck.valid? &&
+                  deck.errors.size.zero?
+
+          errors.add(:decks, 'decks must be an array of Deck')
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require 'active_record'
+require 'json'
+
+require 'zombie_battleground/api/models/match'
+require 'zombie_battleground/api/validation_helper'
+require 'zombie_battleground/api/responses/response_helper'
+
+module ZombieBattleground
+  class Api
+    ##
+    # Response validator for GetMatch
+    class GetMatchResponse
+      include ActiveModel::Validations
+      include ZombieBattleground::Api::ValidationHelper
+      include ZombieBattleground::Api::ResponseHelper
+
+      attr_reader :match
+
+      validate :match_is_a_match
+
+      def initialize(response)
+        handle_errors(response)
+
+        @match = ZombieBattleground::Api::Match.new(JSON.parse(response.body))
+      end
+
+      def match_is_a_match
+        return if @match.is_a?(ZombieBattleground::Api::Match) &&
+                  @match.valid? &&
+                  @match.errors.size.zero?
+
+        errors.add(:match, 'match must be a Match')
+      end
+    end
+  end
+end

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

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require 'active_record'
+require 'json'
+
+require 'zombie_battleground/api/models/match'
+require 'zombie_battleground/api/validation_helper'
+require 'zombie_battleground/api/responses/response_helper'
+
+module ZombieBattleground
+  class Api
+    ##
+    # Response validator for GetMatches
+    class GetMatchesResponse
+      include ActiveModel::Validations
+      include ZombieBattleground::Api::ValidationHelper
+      include ZombieBattleground::Api::ResponseHelper
+
+      attr_reader :total, :page, :limit, :matches
+
+      validate :total_is_a_non_negative_integer
+      validate :page_is_a_non_negative_integer
+      validate :limit_is_a_non_negative_integer
+      validate :matches_is_an_array_of_match
+
+      def initialize(response)
+        handle_errors(response)
+
+        JSON.parse(response.body).each do |key, value|
+          if key == 'matches'
+            instance_variable_set("@#{key}".to_sym, value.map { |match| ZombieBattleground::Api::Match.new(match) })
+          else
+            instance_variable_set("@#{key}".to_sym, value)
+          end
+        end
+      end
+
+      def matches_is_an_array_of_match
+        unless @matches.is_a?(Array)
+          errors.add(:matches, 'Matchs must be an array')
+          return
+        end
+
+        @matches.each do |match|
+          next if match.is_a?(ZombieBattleground::Api::Match) &&
+                  match.valid? &&
+                  match.errors.size.zero?
+
+          errors.add(:matches, 'matches must be an array of Match')
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require 'zombie_battleground/api/errors'
+
+module ZombieBattleground
+  class Api
+    ##
+    # Provides generic methods for response validator classes
+    module ResponseHelper
+      def handle_errors(response)
+        return if response.status == 200
+
+        case response.status
+        when 404
+          raise ZombieBattleground::Api::Errors::NotFound, response.body
+        when 503
+          raise ZombieBattleground::Api::Errors::ServiceUnavailable, response.body
+        when 400..499
+          raise ZombieBattleground::Api::Errors::BadRequest, response.body
+        when 500..599
+          raise ZombieBattleground::Api::Errors::InternalServerError, response.body
+        end
+
+        raise ZombieBattleground::Api::Errors::UnknownResponse, response.body
+      end
+    end
+  end
+end

data/lib/zombie_battleground/api/validation_helper.rb

@@ -0,0 +1,347 @@
+# frozen_string_literal: true
+
+module ZombieBattleground
+  class Api
+    ##
+    # Validation helpers for sanitizing inputs and ouputs
+    module ValidationHelper
+      def value_is_a_class(target:, value:, nullable:, klass:)
+        return if (nullable && value.nil?) || value.is_a?(klass)
+
+        errors.add(target, "#{target} must be a #{klass}")
+      end
+
+      def value_is_a_string(target:, value:, nullable: true)
+        value_is_a_class(
+          target: target,
+          value: value,
+          nullable: nullable,
+          klass: String
+        )
+      end
+
+      def value_is_a_time(target:, value:, nullable: true)
+        value_is_a_class(
+          target: target,
+          value: value,
+          nullable: nullable,
+          klass: Time
+        )
+      end
+
+      def value_is_an_integer(target:, value:, nullable: true)
+        value_is_a_class(
+          target: target,
+          value: value,
+          nullable: nullable,
+          klass: Integer
+        )
+      end
+
+      def value_is_a_non_negative_integer(target:, value:, nullable: true)
+        value_is_an_integer(target: target, value: value, nullable: nullable)
+        return unless errors.messages.empty?
+        return if nullable && value.nil?
+        return if value.zero? || value.positive?
+
+        errors.add(target, "#{target} must be not negative")
+      end
+
+      def id_is_a_non_negative_integer
+        value_is_a_non_negative_integer(target: :id, value: id)
+      end
+
+      def id_is_a_non_negative_integer_and_not_null
+        value_is_a_non_negative_integer(target: :id, value: id, nullable: false)
+      end
+
+      def user_id_is_a_string
+        value_is_a_string(target: :user_id, value: user_id)
+      end
+
+      def user_id_is_a_string_and_not_null
+        value_is_a_string(target: :user_id, value: user_id, nullable: false)
+      end
+
+      def deck_id_is_a_non_negative_integer
+        value_is_a_non_negative_integer(target: :deck_id, value: deck_id)
+      end
+
+      def deck_id_is_a_non_negative_integer_and_not_null
+        value_is_a_non_negative_integer(target: :deck_id, value: deck_id, nullable: false)
+      end
+
+      def name_is_a_string
+        value_is_a_string(target: :name, value: name)
+      end
+
+      def name_is_a_string_and_not_null
+        value_is_a_string(target: :name, value: name, nullable: false)
+      end
+
+      def hero_id_is_a_non_negative_integer
+        value_is_a_non_negative_integer(target: :hero_id, value: hero_id)
+      end
+
+      def hero_id_is_a_non_negative_integer_and_not_null
+        value_is_a_non_negative_integer(target: :hero_id, value: hero_id, nullable: false)
+      end
+
+      def primary_skill_id_is_a_non_negative_integer
+        value_is_a_non_negative_integer(target: :primary_skill_id, value: primary_skill_id)
+      end
+
+      def primary_skill_id_is_a_non_negative_integer_and_not_null
+        value_is_a_non_negative_integer(target: :primary_skill_id, value: primary_skill_id, nullable: false)
+      end
+
+      def secondary_skill_id_is_a_non_negative_integer
+        value_is_a_non_negative_integer(target: :secondary_skill_id, value: secondary_skill_id)
+      end
+
+      def secondary_skill_id_is_a_non_negative_integer_and_not_null
+        value_is_a_non_negative_integer(target: :secondary_skill_id, value: secondary_skill_id, nullable: false)
+      end
+
+      def version_is_a_string
+        value_is_a_string(target: :version, value: version)
+      end
+
+      def version_is_a_string_and_not_null
+        value_is_a_string(target: :version, value: version, nullable: false)
+      end
+
+      def total_is_a_non_negative_integer
+        value_is_a_non_negative_integer(target: :total, value: total)
+      end
+
+      def total_is_a_non_negative_integer_and_not_null
+        value_is_a_non_negative_integer(target: :total, value: total, nullable: false)
+      end
+
+      def page_is_a_non_negative_integer
+        value_is_a_non_negative_integer(target: :page, value: page)
+      end
+
+      def page_is_a_non_negative_integer_and_not_null
+        value_is_a_non_negative_integer(target: :page, value: page, nullable: false)
+      end
+
+      def limit_is_a_non_negative_integer
+        value_is_a_non_negative_integer(target: :limit, value: limit)
+      end
+
+      def limit_is_a_non_negative_integer_and_not_null
+        value_is_a_non_negative_integer(target: :limit, value: limit, nullable: false)
+      end
+
+      def card_name_is_a_string
+        value_is_a_string(target: :card_name, value: card_name)
+      end
+
+      def card_name_is_a_string_and_not_null
+        value_is_a_string(target: :card_name, value: card_name, nullable: false)
+      end
+
+      def amount_is_a_non_negative_integer
+        value_is_a_non_negative_integer(target: :amount, value: amount)
+      end
+
+      def amount_is_a_non_negative_integer_and_not_null
+        value_is_a_non_negative_integer(target: :amount, value: amount, nullable: false)
+      end
+
+      def sender_address_is_a_string
+        value_is_a_string(target: :sender_address, value: sender_address)
+      end
+
+      def sender_address_is_a_string_and_not_null
+        value_is_a_string(target: :sender_address, value: sender_address, nullable: false)
+      end
+
+      def created_at_is_a_time
+        value_is_a_time(target: :created_at, value: created_at)
+      end
+
+      def created_at_is_a_time_and_not_null
+        value_is_a_time(target: :created_at, value: created_at, nullable: false)
+      end
+
+      def updated_at_is_a_time
+        value_is_a_time(target: :updated_at, value: updated_at)
+      end
+
+      def updated_at_is_a_time_and_not_null
+        value_is_a_time(target: :updated_at, value: updated_at, nullable: false)
+      end
+
+      def block_height_is_a_non_negative_integer
+        value_is_a_non_negative_integer(target: :block_height, value: block_height)
+      end
+
+      def block_height_is_a_non_negative_integer_and_not_null
+        value_is_a_non_negative_integer(target: :block_height, value: block_height, nullable: false)
+      end
+
+      def player1_id_is_a_string
+        value_is_a_string(target: :player1_id, value: player1_id)
+      end
+
+      def player1_id_is_a_string_and_not_null
+        value_is_a_string(target: :player1_id, value: player1_id, nullable: false)
+      end
+
+      def player2_id_is_a_string
+        value_is_a_string(target: :player2_id, value: player2_id)
+      end
+
+      def player2_id_is_a_string_and_not_null
+        value_is_a_string(target: :player2_id, value: player2_id, nullable: false)
+      end
+
+      def player1_deck_id_is_a_non_negative_integer
+        value_is_a_non_negative_integer(target: :player1_deck_id, value: player1_deck_id)
+      end
+
+      def player1_deck_id_is_a_non_negative_integer_and_not_null
+        value_is_a_non_negative_integer(target: :player1_deck_id, value: player1_deck_id, nullable: false)
+      end
+
+      def player2_deck_id_is_a_non_negative_integer
+        value_is_a_non_negative_integer(target: :player2_deck_id, value: player2_deck_id)
+      end
+
+      def player2_deck_id_is_a_non_negative_integer_and_not_null
+        value_is_a_non_negative_integer(target: :player2_deck_id, value: player2_deck_id, nullable: false)
+      end
+
+      def random_seed_is_a_non_negative_integer
+        value_is_a_non_negative_integer(target: :random_seed, value: random_seed)
+      end
+
+      def random_seed_is_a_non_negative_integer_and_not_null
+        value_is_a_non_negative_integer(target: :random_seed, value: random_seed, nullable: false)
+      end
+
+      def status_is_a_string
+        value_is_a_string(target: :status, value: status)
+      end
+
+      def status_is_a_string_and_not_null
+        value_is_a_string(target: :status, value: status, nullable: false)
+      end
+
+      def winner_id_is_a_string
+        value_is_a_string(target: :winner_id, value: winner_id)
+      end
+
+      def winner_id_is_a_string_and_not_null
+        value_is_a_string(target: :winner_id, value: winner_id, nullable: false)
+      end
+
+      def mould_id_is_a_string
+        value_is_a_string(target: :mould_id, value: mould_id)
+      end
+
+      def mould_id_is_a_string_and_not_null
+        value_is_a_string(target: :mould_id, value: mould_id, nullable: false)
+      end
+
+      def kind_is_a_string
+        value_is_a_string(target: :kind, value: kind)
+      end
+
+      def kind_is_a_string_and_not_null
+        value_is_a_string(target: :kind, value: kind, nullable: false)
+      end
+
+      def set_is_a_string
+        value_is_a_string(target: :set, value: set)
+      end
+
+      def set_is_a_string_and_not_null
+        value_is_a_string(target: :set, value: set, nullable: false)
+      end
+
+      def description_is_a_string
+        value_is_a_string(target: :description, value: description)
+      end
+
+      def description_is_a_string_and_not_null
+        value_is_a_string(target: :description, value: description, nullable: false)
+      end
+
+      def rank_is_a_string
+        value_is_a_string(target: :rank, value: rank)
+      end
+
+      def rank_is_a_string_and_not_null
+        value_is_a_string(target: :rank, value: rank, nullable: false)
+      end
+
+      def type_is_a_string
+        value_is_a_string(target: :type, value: type)
+      end
+
+      def type_is_a_string_and_not_null
+        value_is_a_string(target: :type, value: type, nullable: false)
+      end
+
+      def rarity_is_a_string
+        value_is_a_string(target: :rarity, value: rarity)
+      end
+
+      def rarity_is_a_string_and_not_null
+        value_is_a_string(target: :rarity, value: rarity, nullable: false)
+      end
+
+      def frame_is_a_string
+        value_is_a_string(target: :frame, value: frame)
+      end
+
+      def frame_is_a_string_and_not_null
+        value_is_a_string(target: :frame, value: frame, nullable: false)
+      end
+
+      def damage_is_a_non_negative_integer
+        value_is_a_non_negative_integer(target: :damage, value: damage)
+      end
+
+      def damage_is_a_non_negative_integer_and_not_null
+        value_is_a_non_negative_integer(target: :damage, value: damage, nullable: false)
+      end
+
+      def health_is_a_non_negative_integer
+        value_is_a_non_negative_integer(target: :health, value: health)
+      end
+
+      def health_is_a_non_negative_integer_and_not_null
+        value_is_a_non_negative_integer(target: :health, value: health, nullable: false)
+      end
+
+      def cost_is_a_non_negative_integer
+        value_is_a_non_negative_integer(target: :cost, value: cost)
+      end
+
+      def cost_is_a_non_negative_integer_and_not_null
+        value_is_a_non_negative_integer(target: :cost, value: cost, nullable: false)
+      end
+
+      def ability_is_a_string
+        value_is_a_string(target: :ability, value: ability)
+      end
+
+      def ability_is_a_string_and_not_null
+        value_is_a_string(target: :ability, value: ability, nullable: false)
+      end
+
+      def image_url_is_a_string
+        value_is_a_string(target: :image_url, value: image_url)
+      end
+
+      def image_url_is_a_string_and_not_null
+        value_is_a_string(target: :image_url, value: image_url, nullable: false)
+      end
+    end
+  end
+end