bn 0.0.1

data/lib/bn/api/wow.rb

@@ -0,0 +1,10 @@
+require "bn/api/base"
+require "bn/api/base"
+
+module BN
+  module API
+    # The the World of Warcraft API requester.
+    class WOW < Base
+    end
+  end
+end

data/lib/bn/entity.rb

@@ -0,0 +1,19 @@
+module BN
+  # The Entity namespace.
+  module Entity
+    # The valid regions for the API.
+    # Contains name, host, and valid locales for each region.
+    REGIONS = {
+      us:  { name: "US",              uri: "https://us.api.battle.net",    locales: %w(en_US es_MX pt_BR) },
+      eu:  { name: "Europe",          uri: "https://us.api.battle.net",    locales: %w(en_GB es_ES fr_FR ru_RU de_DE pt_PT it_IT) },
+      kr:  { name: "Korea",           uri: "https://kr.api.battle.net",    locales: %w(ko_KR) },
+      tw:  { name: "Taiwan",          uri: "https://tw.api.battle.net",    locales: %w(zh_TW) },
+      cn:  { name: "China",           uri: "https://api.battlenet.com.cn", locales: %w(zh_CN) },
+      sea: { name: "South East Asia", uri: "https://sea.api.battle.net",   locales: %w(en_US) }
+    }
+  end
+end
+
+require "bn/api/d3"
+require "bn/api/sc2"
+require "bn/api/wow"

data/lib/bn/entity/base.rb

@@ -0,0 +1,16 @@
+require "bn/helpers/has_attributes"
+
+module BN
+  module Entity
+    # The base class for game entities.
+    class Base
+      include Helpers::HasAttributes
+
+      protected
+
+      def convert_time(value)
+        value.is_a?(Time) ? value : Time.at(value.to_i)
+      end
+    end
+  end
+end

data/lib/bn/entity/d3/hero.rb

@@ -0,0 +1,164 @@
+require "bn/entity/base"
+
+module BN
+  module Entity
+    module D3
+      # A hero within Diablo 3.
+      class Hero < Base
+        MAX_LEVEL = 70
+
+        def initialize(attributes={})
+          super
+
+          @level ||= 1
+          @paragon_level ||= 0
+          @hardcore ||= false
+          @seasonal ||= false
+          @dead ||= false
+        end
+
+        # @method id
+        # Get the ID.
+        #
+        # @return [Integer]
+
+        # @method id=
+        # Set the ID.
+        #
+        # @param [#to_i] value
+        # @return [Integer]
+        attribute(:id) { |value| value.to_i }
+
+        # @method name
+        # Get the name.
+        #
+        # @return [String]
+
+        # @method name=
+        # Set the name.
+        #
+        # @param [#to_s] value
+        # @return [String]
+        attribute(:name) { |value| value.to_s.strip }
+
+        # @method hero_class
+        # Get the hero class.
+        #
+        # @return [Symbol]
+
+        # @method hero_class=
+        # Set the hero class.
+        #
+        # @param [#to_sym] value
+        # @return [Symbol]
+        attribute(:hero_class) { |value| value.to_sym }
+
+        # @method gender
+        # Get the gender.
+        #
+        # @return [Symbol]
+
+        # @method gender=
+        # Set the gender.
+        #
+        # @param [#to_sym] value
+        # @return [Symbol]
+        attribute(:gender) { |value| value.to_sym }
+
+        # @method level
+        # Get the level.
+        #
+        # @return [Integer]
+
+        # @method level=
+        # Set the level.
+        #
+        # @param [#to_i] value
+        # @return [Integer]
+        attribute(:level) { |value| validate_level(value) }
+
+        # @method paragon_level
+        # Get the paragon level.
+        #
+        # @return [Integer]
+
+        # @method paragon_level=
+        # Set the paragon level.
+        #
+        # @param [#to_i] value
+        # @return [Integer]
+        attribute(:paragon_level) { |value| validate_level(value, true) }
+
+        # @method kills
+        # Get the number of kills per enemy type.
+        #
+        # @return [Hash]
+
+        # @method kills=
+        # Set the number of kills per enemy type.
+        #
+        # @param [#to_h] value
+        # @return [Hash]
+        attribute(:kills) { |value| value.to_h }
+
+        # @method hardcore
+        # Get whether this hero is hardcore.
+        #
+        # @return [Boolean]
+
+        # @method hardcore=
+        # Set whether this hero is hardcore.
+        #
+        # @param [Boolean] value
+        # @return [Boolean]
+        attribute(:hardcore) { |value| !!value }
+
+        # @method seasonal
+        # Get whether this hero is seasonal.
+        #
+        # @return [Boolean]
+
+        # @method seasonal=
+        # Set whether this hero is seasonal.
+        #
+        # @param [Boolean] value
+        # @return [Boolean]
+        attribute(:seasonal) { |value| !!value }
+
+        # @method last_updated
+        # Get the last updated time.
+        #
+        # @return [Time]
+
+        # @method last_updated=
+        # Set the last updated time.
+        #
+        # @param [Time, #to_i] value
+        # @return [Time]
+        attribute(:last_updated) { |value| convert_time(value) }
+
+        # @method dead
+        # Get whether this hero is dead.
+        #
+        # @return [Boolean]
+
+        # @method dead=
+        # Set whether this hero is dead.
+        #
+        # @param [Boolean] value
+        # @return [Boolean]
+        attribute(:dead) { |value| !!value }
+
+        protected
+
+        def validate_level(value, paragon=false)
+          value = value.to_i
+          value = 0 if value < MAX_LEVEL
+          value = MAX_LEVEL if !paragon && value > MAX_LEVEL
+
+          value
+        end
+      end
+    end
+  end
+end

data/lib/bn/entity/d3/profile.rb

@@ -0,0 +1,185 @@
+require "bn/entity/base"
+require "bn/entity/d3/hero"
+
+module BN
+  module Entity
+    module D3
+      # A profile within Diablo 3.
+      class Profile < Base
+        # @method battle_tag
+        # Get the battle tag.
+        #
+        # @return [String]
+
+        # @method battle_tag=
+        # Set the battle tag.
+        #
+        # @param [#to_s] value
+        # @return [String]
+        attribute(:battle_tag) { |value| value.to_s.strip }
+
+        # @method paragon_level
+        # Get the paragon level.
+        #
+        # @return [Integer]
+
+        # @method paragon_level=
+        # Set the paragon level.
+        #
+        # @param [#to_i] value
+        # @return [Integer]
+        attribute(:paragon_level) { |value| value.to_i }
+
+        # @method paragon_level_hardcore
+        # Get the paragon hardcore level.
+        #
+        # @return [Integer]
+
+        # @method paragon_level_hardcore=
+        # Set the paragon hardcore level.
+        #
+        # @param [#to_i] value
+        # @return [Integer]
+        attribute(:paragon_level_hardcore) { |value| value.to_i }
+
+        # @method paragon_level_season
+        # Get the paragon season level.
+        #
+        # @return [Integer]
+
+        # @method paragon_level_season=
+        # Set the paragon season level.
+        #
+        # @param [#to_i] value
+        # @return [Integer]
+        attribute(:paragon_level_season) { |value| value.to_i }
+
+        # @method paragon_level_season_hardcore
+        # Get the paragon season hardcore level.
+        #
+        # @return [Integer]
+
+        # @method paragon_level_season_hardcore=
+        # Set the paragon season hardcore level.
+        #
+        # @param [#to_i] value
+        # @return [Integer]
+        attribute(:paragon_level_season_hardcore) { |value| value.to_i }
+
+        # @method guild_name
+        # Get the guild name.
+        #
+        # @return [String]
+
+        # @method guild_name=
+        # Set the guild name.
+        #
+        # @param [#to_s] value
+        # @return [String]
+        attribute(:guild_name) { |value| value.to_s }
+
+        # @method heroes
+        # Get the heroes.
+        #
+        # @return [<Hero>]
+
+        # @method heroes=
+        # Set the heroes.
+        #
+        # @param [#to_a] value
+        # @return [<Hero>]
+        attribute(:heroes) { |value| value.to_a.collect { |hero| convert_hero(hero) } }
+
+        # @method last_hero_played
+        # Get the last hero played.
+        #
+        # @return [Hero]
+
+        # @method heroes=
+        # Set the last hero played.
+        #
+        # @param [Hero, #to_h] value
+        # @return [Hero]
+        attribute(:last_hero_played) { |value| convert_hero(value) }
+
+        # @method last_updated
+        # Get the last updated time.
+        #
+        # @return [Time]
+
+        # @method last_updated=
+        # Set the last updated time.
+        #
+        # @param [Time, #to_i] value
+        # @return [Time]
+        attribute(:last_updated) { |value| convert_time(value) }
+
+        # @method kills
+        # Get the number of kills per enemy type.
+        #
+        # @return [Hash]
+
+        # @method kills=
+        # Set the number of kills per enemy type.
+        #
+        # @param [#to_h] value
+        # @return [Hash]
+        attribute(:kills) { |value| value.to_h }
+
+        # @method highest_hardcore_level
+        # Get the highest hardcore level.
+        #
+        # @return [Integer]
+
+        # @method highest_hardcore_level=
+        # Set the highest hardcore level.
+        #
+        # @param [#to_i] value
+        # @return [Integer]
+        attribute(:highest_hardcore_level) { |value| value.to_i }
+
+        # @method time_played
+        # Get the time played.
+        #
+        # @return [Hash]
+
+        # @method time_played=
+        # Set the time played.
+        #
+        # @param [#to_h] value
+        # @return [Hash]
+        attribute(:time_played) { |value| value.to_h }
+
+        # @method progression
+        # Get the act progression.
+        #
+        # @return [Hash]
+
+        # @method time_played=
+        # Set the act progression.
+        #
+        # @param [#to_h] value
+        # @return [Hash]
+        attribute(:progression) { |value| value.to_h }
+
+        # @method fallen_heroes
+        # Get the fallen heroes.
+        #
+        # @return [<Hero>]
+
+        # @method fallen_heroes=
+        # Set the fallen heroes.
+        #
+        # @param [#to_a] value
+        # @return [<Hero>]
+        attribute(:fallen_heroes) { |value| value.to_a }
+
+        protected
+
+        def convert_hero(value)
+          value.is_a?(Hero) ? value : Hero.new(value)
+        end
+      end
+    end
+  end
+end

data/lib/bn/error/api/base.rb

@@ -0,0 +1,11 @@
+require "bn/error/base"
+
+module BN
+  module Error
+    module API
+      # The base class for API errors.
+      class Base < Error::Base
+      end
+    end
+  end
+end

data/lib/bn/error/api/invalid_key.rb

@@ -0,0 +1,14 @@
+require "bn/error/api/base"
+
+module BN
+  module Error
+    module API
+      # Raised when the key is invalid.
+      class InvalidKey < Base
+        def to_s
+          "The key is invalid."
+        end
+      end
+    end
+  end
+end

data/lib/bn/error/api/invalid_locale.rb

@@ -0,0 +1,16 @@
+require "bn/error/api/base"
+
+module BN
+  module Error
+    module API
+      # Raised when the locale is invalid.
+      class InvalidLocale < Base
+        attribute(:region)
+
+        def to_s
+          "Invalid locale for region '#{@region[:name]}'. Must be one of the following: #{@region[:locales]}"
+        end
+      end
+    end
+  end
+end

data/lib/bn/error/api/invalid_region.rb

@@ -0,0 +1,14 @@
+require "bn/error/api/base"
+
+module BN
+  module Error
+    module API
+      # Raised when the region is invalid.
+      class InvalidRegion < Base
+        def to_s
+          "Region must be one of the following: #{BN::API::REGIONS.keys}"
+        end
+      end
+    end
+  end
+end