blizzard_api 0.5.4 → 0.5.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 360667c9c66306b2c7557365d3d412b92eb9d64110526f34ebcfe77f47afff9b
-  data.tar.gz: eb1d4b42631e6fa56b11727ea2a437b77a6e89400b7848c65f5f197fda206c77
+  metadata.gz: df5491aa580d19886cc9508e2ec5b448172b3ddf4921a48c10d6ec4086204cf0
+  data.tar.gz: 8842b00597c073318df660741eb8b57e9406e5659cfe60f11f31885553e1ca9f
 SHA512:
-  metadata.gz: 3a85c0a3953367f8ce5ea531c82f67f78a67799ebcf5450196a6bc32ae9e7ccb23a75dd6b77c8721b5b9048c6c1046db1fea5f510e2fc01739c32960ce4dd49a
-  data.tar.gz: 8a6f610c43bf199170cf94f4075541213ed6ef90d80966790c5a5349e1362f24a176a780f4d49cb0720592268ad113a21e8275f1b6edb0c22960bab6425746a9
+  metadata.gz: 4fe7082429eccbb69765ed1ff7253f6b65a2e6a7d0ff6ffd6d575c2eff503b206d76d53640416ac6c37eb3cc90249f228e4cb977b57344fc020ae051b5a764dd
+  data.tar.gz: 21b8f259a6cae19fabe6ce3cbf06b33dad06822a3f1842afc70984da5b11361b6e12469e7103f50ceb1e41619bdbeddae35080041a3a4d81060255a5c0137877

data/CHANGELOG.md

@@ -1,6 +1,14 @@
 Please view this file on the master branch, otherwise it may be outdated
 
-**Version 0.5.3**
+**Version 0.5.5**
+
+Removing old and deprecated function from community endpoint.
+
+Refactored all `options` arguments to use double splat syntax.
+
+Modified README.md to point to the actual documentation and include missing endpoints.
+
+**Version 0.5.4**
 
 Added missing legacy SC2 endpoints
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    blizzard_api (0.5.3)
+    blizzard_api (0.5.5)
       redis (~> 4.1, >= 4.1.0)
 
 GEM

data/README.md

@@ -63,11 +63,9 @@ race = BlizzardApi::Wow.race
 race_data = race.complete
 ```
 
-:bulb: If you use the wrapper it will always use the default region specified in the configuration file.
+Most **game data** endpoints will have always 3 methods available `index`, `get` and `complete`.
 
-Most **data** endpoints will have always 3 methods available `index`, `get` and `complete`.
-
-* `index` is used to get a list of all resources od that endpoint.
+* `index` is used to get a list of all resources of that endpoint.
 * `get` is used to get all information about a entry of the index returned data. It receives an id or slug as the first parameter, that depends on the endpoint.
 * `complete` is a complete information of all items listed in index. **This may perform various calls to the blizzard api** only use if you really need all information.
 
@@ -75,7 +73,6 @@ Most **data** endpoints will have always 3 methods available `index`, `get` and
 
 Some endpoints support search filters. To perform a search you can use the following formats:
 
-
 To use the **or** operator you may pass an array of values as argument to `where` or `where_not` methods.
 ```ruby
 realm = BlizzardApi::Wow.realm
@@ -125,227 +122,72 @@ end
 
 ### 4.1. World of Warcraft endpoints
 
-* Blizzard::Wow::Achievement
-  - get :id
-  - index
-  - categories
-  - category :id
-  - media :id
-* Blizzard::Wow::ConnectedRealm
-  - index
-  - get :id
-  - complete
-* Blizzard::Wow::Creature
-  - get :id
-  - families
-  - family :id
-  - family_media :id
-  - types
-  - type :id
-  - display_media :id
-  - search
-* Blizzard::Wow::Guild
-  - rewards
-  - perks
-  - get :realm, :guild
-  - roster :realm, :guild
-  - achievements :realm, :guild
-* Blizzard::Wow::GuildCrest
-  - index
-  - border_media :id
-  - emblem_media :id
-* Blizzard::Wow::MythicKeystonesAffix
-  - index
-  - get :id
-  - complete
-* Blizzard::Wow::MythicKeystone
-  - index
-  - dungeons
-  - dungeon :id
-  - periods
-  - period :id
-  - seasons
-  - season :id
-* Blizzard::Wow::MythicRaidLeaderboard
-  - get :raid_slug, :faction_slug
-* Blizzard::Wow::Mount
-  - index
-  - get :id
-  - complete
-* Blizzard::Wow::MythicKeystoneLeaderboard
-  - index :connected_realm_id
-  - get :connected_realm_id, :dungeon_id, :period
-* Blizzard::Wow::Pet
-  - index
-  - get
-  - ability :id
-  - species :id
-  - stats :level, :breed_id, :quality_id
-  - types
-* Blizzard::Wow::PlayableClass
-  - index
-  - get :id
-  - complete
-  - talent_slots :id
-* Blizzard::Wow::PlayableSpecialization
-  - index
-  - get :id
-  - complete
-* Blizzard::Wow::PowerType
-  - index
-  - get :id
-  - complete
-* Blizzard::Wow::PvpSeason
-  - index
-  - get :id
-  - leaderboards :season_id
-  - leaderboard :season_id, :brackets
-  - rewards :season_id
-* Blizzard::Wow::PvpTier
-  - index
-  - get :id
-  - tier_media :id
-* Blizzard::Wow::Realm
-  - index
-  - get :id
-  - complete
-  - status :realms
-  - search
-* Blizzard::Wow::Region
-  - index
-  - get :id
-  - complete
-* Blizzard::Wow::WowToken
-  - get
-* Blizzard::Wow::Race
-  - index
-  - get :id
-  - complete
-* Blizzard::Wow::Title
-  - index
-  - get :id
-* Blizzard::Wow::Item
-  - get :id
-  - item_set :id
-  - classes
-  - class :id
-  - subclass :class_id, :subclass_id
-  - media :id
-  - search
-* Blizzard::Wow::AzeriteEssence
-  - index
-  - get :id
-  - media :id
-  - search
-* Blizzard::Wow::ReputationTier
-  - index
-  - get :id
-* Blizzard::Wow::ReputationFaction
-  - index
-  - get :id
-
-* Blizzard::Wow::Auction
-  - get :realm
-* Blizzard::Wow::Boss
-  - index
-  - get :id
-* Blizzard::Wow::Challenge
-  - realm_index
-  - region_index
-* Blizzard::Wow::Guild
-  - get :relam, :name, :fields
-  - rewards
-  - perks
-* Blizzard::Wow::PvP
-  - get :bracket
-* Blizzard::Wow::Quest
-  - get :id
-* Blizzard::Wow::Recipe
-  - get :id
-* Blizzard::Wow::Spell
-  - get :id
-  - search
-* Blizzard::Wow::Zone
-  - index
-  - get :id
-
-* BlizzardApi::Wow::CharacterProfile
-  - get_user_characters :user_token
-  - get :realm, :character, :fields
-  - status :realm, :character
-  - pvp_summmary :realm, :character, :user_token
-  - pvp_bracket :realm, :character, :bracket, :user_token
-  - achievements :realm, :character
-  - appearance :realm, :character
-  - equipment :realm, :character
-  - media :realm, :character
-  - pvp_bracket :realm, :character, :bracket
-  - pvp_summary :realm, :character
-  - specializations :realm, :character
-  - statistics :realm, :character
-  - titles :realm, :character
-  - mythic_keystone_profile :realm, :character
-  - mythic_keystone_seasons :realm, :character
-  - collections :realm, :character
-  - pets :realm, :character
-  - mounts :realm, :character
-  - hunter_pets :realm, :character
-  - reputations :realm, :character
-  - raid_progression :realm, :character (Not active yet on Blizzard servers)
+* [BlizzardApi::Wow.achievement](https://rubydoc.info/gems/blizzard_api/BlizzardApi/Wow/Achievement)
+* [BlizzardApi::Wow.auction](https://rubydoc.info/gems/blizzard_api/BlizzardApi/Wow/Auction)
+* [BlizzardApi::Wow.azerite_essence](https://rubydoc.info/gems/blizzard_api/BlizzardApi/Wow/AzeriteEssence)
+* [BlizzardApi::Wow.connected_realm](https://rubydoc.info/gems/blizzard_api/BlizzardApi/Wow/ConnectedRealm)
+* [BlizzardApi::Wow.covenant](https://rubydoc.info/gems/blizzard_api/BlizzardApi/Wow/Covenant)
+* [BlizzardApi::Wow.creature](https://rubydoc.info/gems/blizzard_api/BlizzardApi/Wow/Creature)
+* [BlizzardApi::Wow.guild_crest](https://rubydoc.info/gems/blizzard_api/BlizzardApi/Wow/GuildCrest)
+* [BlizzardApi::Wow.item](https://rubydoc.info/gems/blizzard_api/BlizzardApi/Wow/Item)
+* [BlizzardApi::Wow.journal](https://rubydoc.info/gems/blizzard_api/BlizzardApi/Wow/Journal)
+* [BlizzardApi::Wow.media](https://rubydoc.info/gems/blizzard_api/BlizzardApi/Wow/Media)
+* [BlizzardApi::Wow.modified_crafting](https://rubydoc.info/gems/blizzard_api/BlizzardApi/Wow/ModifiedCrafting)
+* [BlizzardApi::Wow.mount](https://rubydoc.info/gems/blizzard_api/BlizzardApi/Wow/Mount)
+* [BlizzardApi::Wow.mythic_keystone_affix](https://rubydoc.info/gems/blizzard_api/BlizzardApi/Wow/MythicKeystoneAffix)
+* [BlizzardApi::Wow.mythic_keystone](https://rubydoc.info/gems/blizzard_api/BlizzardApi/Wow/MythicKeystone)
+* [BlizzardApi::Wow.mythic_raid_leaderboard](https://rubydoc.info/gems/blizzard_api/BlizzardApi/Wow/MythicRaidLeaderboard)
+* [BlizzardApi::Wow.mythic_keystone_leaderboard](https://rubydoc.info/gems/blizzard_api/BlizzardApi/Wow/MythicKeystoneLeaderboard)
+* [BlizzardApi::Wow.pet](https://rubydoc.info/gems/blizzard_api/BlizzardApi/Wow/Pet)
+* [BlizzardApi::Wow.playable_class](https://rubydoc.info/gems/blizzard_api/BlizzardApi/Wow/PlayableClass)
+* [BlizzardApi::Wow.playable_race](https://rubydoc.info/gems/blizzard_api/BlizzardApi/Wow/PlayableRace)
+* [BlizzardApi::Wow.playable_specialization](https://rubydoc.info/gems/blizzard_api/BlizzardApi/Wow/PlayableSpecialization)
+* [BlizzardApi::Wow.power_type](https://rubydoc.info/gems/blizzard_api/BlizzardApi/Wow/PowerType)
+* [BlizzardApi::Wow.profession](https://rubydoc.info/gems/blizzard_api/BlizzardApi/Wow/Profession)
+* [BlizzardApi::Wow.pvp_season](https://rubydoc.info/gems/blizzard_api/BlizzardApi/Wow/PvpSeason)
+* [BlizzardApi::Wow.pvp_tier](https://rubydoc.info/gems/blizzard_api/BlizzardApi/Wow/PvpTier)
+* [BlizzardApi::Wow.quest](https://rubydoc.info/gems/blizzard_api/BlizzardApi/Wow/Quest)
+* [BlizzardApi::Wow.realm](https://rubydoc.info/gems/blizzard_api/BlizzardApi/Wow/Realm)
+* [BlizzardApi::Wow.region](https://rubydoc.info/gems/blizzard_api/BlizzardApi/Wow/Region)
+* [BlizzardApi::Wow.reputation](https://rubydoc.info/gems/blizzard_api/BlizzardApi/Wow/Reputation)
+* [BlizzardApi::Wow.spell](https://rubydoc.info/gems/blizzard_api/BlizzardApi/Wow/Spell)
+* [BlizzardApi::Wow.talent](https://rubydoc.info/gems/blizzard_api/BlizzardApi/Wow/Talent)
+* [BlizzardApi::Wow.tech_talent](https://rubydoc.info/gems/blizzard_api/BlizzardApi/Wow/TechTalent)
+* [BlizzardApi::Wow.title](https://rubydoc.info/gems/blizzard_api/BlizzardApi/Wow/Title)
+* [BlizzardApi::Wow.wow_token](https://rubydoc.info/gems/blizzard_api/BlizzardApi/Wow/WowToken)
+
+* [BlizzardApi::Wow.profile](https://rubydoc.info/gems/blizzard_api/BlizzardApi/Wow/Profile)
+* [BlizzardApi::Wow.guild](https://rubydoc.info/gems/blizzard_api/BlizzardApi/Wow/Guild)
+* [BlizzardApi::Wow.character_profile](https://rubydoc.info/gems/blizzard_api/BlizzardApi/Wow/CharacterProfile)
 
 ### 4.2. Diablo III endpoints
 
-* BlizzardApi::Diablo::Act
-  - index
-  - get :id
-* BlizzardApi::Diablo::Artisan
-  - get :artisan_slug
-  - recipe :artisan_slug, :recipe_slug
-* BlizzardApi::Diablo::Follower
-  - get :slug
-* BlizzardApi::Diablo::Character
-  - get :class_slug
-  - skill :class_slug, :skill_slug
-* BlizzardApi::Diablo::ItemType
-  - index
-  - get :item_type_slug
-* BlizzardApi::Diablo::Item
-  - get :item_slug, :item_id
-* BlizzardApi::Diablo::Profile
-  - index :battletag, :oauth_token
-  - hero :battletag, :oauth_token, :hero_id
-  - hero_items :battletag, :oauth_token, :hero_id
-  - hero_follower_items :battletag, :oauth_token, :hero_id
+* [BlizzardApi::Diablo.season](https://rubydoc.info/gems/blizzard_api/BlizzardApi/Diablo/Season)
+* [BlizzardApi::Diablo.era](https://rubydoc.info/gems/blizzard_api/BlizzardApi/Diablo/Era)
+* [BlizzardApi::Diablo.act](https://rubydoc.info/gems/blizzard_api/BlizzardApi/Diablo/Act)
+* [BlizzardApi::Diablo.artisan](https://rubydoc.info/gems/blizzard_api/BlizzardApi/Diablo/Artisan)
+* [BlizzardApi::Diablo.follower](https://rubydoc.info/gems/blizzard_api/BlizzardApi/Diablo/Follower)
+* [BlizzardApi::Diablo.character](https://rubydoc.info/gems/blizzard_api/BlizzardApi/Diablo/Character)
+* [BlizzardApi::Diablo.item_type](https://rubydoc.info/gems/blizzard_api/BlizzardApi/Diablo/ItemType)
+* [BlizzardApi::Diablo.item](https://rubydoc.info/gems/blizzard_api/BlizzardApi/Diablo/Item)
+* [BlizzardApi::Diablo.profile](https://rubydoc.info/gems/blizzard_api/BlizzardApi/Diablo/Profile)
 
 ### 4.3. Hearthstone endpoints
 
-* BlizzardApi::Hearthstone::Card
-  - index
-  - get :id_or_slug
-  - search :search_options
-* BlizzardApi::Hearthstone::Deck
-  - get :deck_code
-* BlizzardApi::Hearthstone::Metadata
-  - index
-  - get :type
+* [BlizzardApi::Hearthstone.card](https://rubydoc.info/gems/blizzard_api/BlizzardApi/Hearthstone/Card)
+* [BlizzardApi::Hearthstone.back](https://rubydoc.info/gems/blizzard_api/BlizzardApi/Hearthstone/Back)
+* [BlizzardApi::Hearthstone.deck](https://rubydoc.info/gems/blizzard_api/BlizzardApi/Hearthstone/Deck)
+* [BlizzardApi::Hearthstone.metadata](https://rubydoc.info/gems/blizzard_api/BlizzardApi/Hearthstone/Metadata)
   
 ### 4.4. Starcraft II endpoints
 
 Every endpoint requiring a *region_id* parameter will accepts either the integer representation of the region described in the api docs or a symbol: `:US`, `:EU`, `:KO` or `:TW` 
 
-* BlizzardApi::Starcraft::League
-  - get :season_id, :queue_id, :team_type, :league_id
-* BlizzardApi::Starcraft::Profile
-  - static :region_id
-  - metadata :region_id, :realm_id, :profile_id
-  - profile :region_id, :realm_id, :profile_id
-  - ladder_summary :region_id, :realm_id, :profile_id
-  - ladder :region_id, :realm_id, :profile_id, :ladder_id
-* BlizzardApi::Starcraft::Ladder
-  - grandmaster :region_id, :options
-  - season :region_id
-* BlizzardApi::Starcraft::Account
-  - player :account_id
+* [BlizzardApi::Starcraft.profile](https://rubydoc.info/gems/blizzard_api/BlizzardApi/Starcraft/Profile)
+* [BlizzardApi::Starcraft.ladder](https://rubydoc.info/gems/blizzard_api/BlizzardApi/Starcraft/Ladder)
+* [BlizzardApi::Starcraft.account](https://rubydoc.info/gems/blizzard_api/BlizzardApi/Starcraft/Account)
+* [BlizzardApi::Starcraft.legacy](https://rubydoc.info/gems/blizzard_api/BlizzardApi/Starcraft/Legacy)
+* [BlizzardApi::Starcraft.league](https://rubydoc.info/gems/blizzard_api/BlizzardApi/Starcraft/League)
 
 ## Contributing
 

data/lib/blizzard_api/diablo/community/act.rb

@@ -16,7 +16,7 @@ module BlizzardApi
       # @!macro request_options
       #
       # @!macro response
-      def index(options = {})
+      def index(**options)
         api_request "#{base_url(:community)}/data/act", { ttl: CACHE_TRIMESTER }.merge(options)
       end
 
@@ -27,7 +27,7 @@ module BlizzardApi
       # @!macro request_options
       #
       # @!macro response
-      def get(id, options = {})
+      def get(id, **options)
         api_request "#{base_url(:community)}/data/act/#{id}", { ttl: CACHE_TRIMESTER }.merge(options)
       end
     end

data/lib/blizzard_api/diablo/community/artisan.rb

@@ -17,7 +17,7 @@ module BlizzardApi
       # @!macro request_options
       #
       # @!macro response
-      def get(artisan_slug, options = {})
+      def get(artisan_slug, **options)
         api_request "#{base_url(:community)}/data/artisan/#{artisan_slug}", { ttl: CACHE_TRIMESTER }.merge(options)
       end
 
@@ -29,7 +29,7 @@ module BlizzardApi
       # @!macro request_options
       #
       # @!macro response
-      def recipe(artisan_slug, recipe_slug, options = {})
+      def recipe(artisan_slug, recipe_slug, **options)
         opts = { ttl: CACHE_TRIMESTER }.merge(options)
         api_request "#{base_url(:community)}/data/artisan/#{artisan_slug}/recipe/#{recipe_slug}", opts
       end

data/lib/blizzard_api/diablo/community/character.rb

@@ -17,7 +17,7 @@ module BlizzardApi
       # @!macro request_options
       #
       # @!macro response
-      def get(class_slug, options = {})
+      def get(class_slug, **options)
         api_request "#{base_url(:community)}/data/hero/#{class_slug}", { ttl: CACHE_TRIMESTER }.merge(options)
       end
 
@@ -29,7 +29,7 @@ module BlizzardApi
       # @!macro request_options
       #
       # @!macro response
-      def skill(class_slug, skill_slug, options = {})
+      def skill(class_slug, skill_slug, **options)
         opts = { ttl: CACHE_TRIMESTER }.merge(options)
         api_request "#{base_url(:community)}/data/hero/#{class_slug}/skill/#{skill_slug}", opts
       end

data/lib/blizzard_api/diablo/community/follower.rb

@@ -17,7 +17,7 @@ module BlizzardApi
       # @!macro request_options
       #
       # @!macro response
-      def get(follower_slug, options = {})
+      def get(follower_slug, **options)
         api_request "#{base_url(:community)}/data/follower/#{follower_slug}", { ttl: CACHE_TRIMESTER }.merge(options)
       end
     end

data/lib/blizzard_api/diablo/community/item.rb

@@ -17,7 +17,7 @@ module BlizzardApi
       # @!macro request_options
       #
       # @!macro response
-      def get(item_slug_and_id, options = {})
+      def get(item_slug_and_id, **options)
         api_request "#{base_url(:community)}/data/item/#{item_slug_and_id}", { ttl: CACHE_TRIMESTER }.merge(options)
       end
     end

data/lib/blizzard_api/diablo/community/item_type.rb

@@ -16,7 +16,7 @@ module BlizzardApi
       # @!macro request_options
       #
       # @!macro response
-      def index(options = {})
+      def index(**options)
         api_request "#{base_url(:community)}/data/item-type", { ttl: CACHE_TRIMESTER }.merge(options)
       end
 
@@ -27,7 +27,7 @@ module BlizzardApi
       # @!macro request_options
       #
       # @!macro response
-      def get(item_type_slug, options = {})
+      def get(item_type_slug, **options)
         api_request "#{base_url(:community)}/data/item-type/#{item_type_slug}", { ttl: CACHE_TRIMESTER }.merge(options)
       end
     end

data/lib/blizzard_api/diablo/community/profile.rb

@@ -20,7 +20,7 @@ module BlizzardApi
       # @!macro response
       #
       # @see https://develop.battle.net/documentation/guides/using-oauth/authorization-code-flow
-      def index(battletag, oauth_token, options = {})
+      def index(battletag, oauth_token, **options)
         opts = { access_token: oauth_token, ttl: CACHE_TRIMESTER }.merge(options)
         api_request "#{base_url(:community)}/profile/#{parse_battle_tag(battletag)}/", opts
       end
@@ -36,7 +36,7 @@ module BlizzardApi
       # @!macro response
       #
       # @see https://develop.battle.net/documentation/guides/using-oauth/authorization-code-flow
-      def hero(battletag, oauth_token, hero_id, options = {})
+      def hero(battletag, oauth_token, hero_id, **options)
         opts = { access_token: oauth_token, ttl: CACHE_TRIMESTER }.merge(options)
         api_request "#{base_url(:community)}/profile/#{parse_battle_tag(battletag)}/hero/#{hero_id}", opts
       end
@@ -52,7 +52,7 @@ module BlizzardApi
       # @!macro response
       #
       # @see https://develop.battle.net/documentation/guides/using-oauth/authorization-code-flow
-      def hero_items(battletag, oauth_token, hero_id, options = {})
+      def hero_items(battletag, oauth_token, hero_id, **options)
         opts = { access_token: oauth_token, ttl: CACHE_TRIMESTER }.merge(options)
         api_request "#{base_url(:community)}/profile/#{parse_battle_tag(battletag)}/hero/#{hero_id}/items", opts
       end
@@ -68,7 +68,7 @@ module BlizzardApi
       # @!macro response
       #
       # @see https://develop.battle.net/documentation/guides/using-oauth/authorization-code-flow
-      def hero_follower_items(battletag, oauth_token, hero_id, options = {})
+      def hero_follower_items(battletag, oauth_token, hero_id, **options)
         opts = { access_token: oauth_token, ttl: CACHE_TRIMESTER }.merge(options)
         api_request "#{base_url(:community)}/profile/#{parse_battle_tag(battletag)}/hero/#{hero_id}/follower-items", opts
       end