blizzard_api 0.5.4 → 0.5.5

Sign up to get free protection for your applications and to get access to all the features.
Files changed (54) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +9 -1
  3. data/Gemfile.lock +1 -1
  4. data/README.md +57 -215
  5. data/lib/blizzard_api/diablo/community/act.rb +2 -2
  6. data/lib/blizzard_api/diablo/community/artisan.rb +2 -2
  7. data/lib/blizzard_api/diablo/community/character.rb +2 -2
  8. data/lib/blizzard_api/diablo/community/follower.rb +1 -1
  9. data/lib/blizzard_api/diablo/community/item.rb +1 -1
  10. data/lib/blizzard_api/diablo/community/item_type.rb +2 -2
  11. data/lib/blizzard_api/diablo/community/profile.rb +4 -4
  12. data/lib/blizzard_api/diablo/game_data/generic_data_endpoint.rb +3 -3
  13. data/lib/blizzard_api/hearthstone/game_data/back.rb +1 -1
  14. data/lib/blizzard_api/hearthstone/game_data/card.rb +2 -2
  15. data/lib/blizzard_api/hearthstone/game_data/generic_data_endpoint.rb +2 -2
  16. data/lib/blizzard_api/request.rb +2 -2
  17. data/lib/blizzard_api/starcraft/community/account.rb +1 -1
  18. data/lib/blizzard_api/starcraft/community/ladder.rb +2 -2
  19. data/lib/blizzard_api/starcraft/community/legacy.rb +6 -6
  20. data/lib/blizzard_api/starcraft/community/profile.rb +5 -5
  21. data/lib/blizzard_api/starcraft/game_data/league.rb +1 -1
  22. data/lib/blizzard_api/version.rb +1 -1
  23. data/lib/blizzard_api/wow.rb +0 -7
  24. data/lib/blizzard_api/wow/game_data/achievement.rb +3 -3
  25. data/lib/blizzard_api/wow/game_data/auction.rb +1 -1
  26. data/lib/blizzard_api/wow/game_data/azerite_essence.rb +1 -1
  27. data/lib/blizzard_api/wow/game_data/covenant.rb +5 -5
  28. data/lib/blizzard_api/wow/game_data/creature.rb +6 -6
  29. data/lib/blizzard_api/wow/game_data/generic_data_endpoint.rb +3 -3
  30. data/lib/blizzard_api/wow/game_data/guild_crest.rb +2 -2
  31. data/lib/blizzard_api/wow/game_data/item.rb +6 -6
  32. data/lib/blizzard_api/wow/game_data/journal.rb +8 -8
  33. data/lib/blizzard_api/wow/game_data/modified_crafting.rb +4 -4
  34. data/lib/blizzard_api/wow/game_data/mythic_keystone.rb +6 -6
  35. data/lib/blizzard_api/wow/game_data/mythic_keystone_affix.rb +1 -1
  36. data/lib/blizzard_api/wow/game_data/mythic_keystone_leaderboard.rb +2 -2
  37. data/lib/blizzard_api/wow/game_data/mythic_raid_leaderboard.rb +1 -1
  38. data/lib/blizzard_api/wow/game_data/pet.rb +4 -4
  39. data/lib/blizzard_api/wow/game_data/playable_class.rb +4 -4
  40. data/lib/blizzard_api/wow/game_data/playable_specialization.rb +2 -2
  41. data/lib/blizzard_api/wow/game_data/profession.rb +4 -4
  42. data/lib/blizzard_api/wow/game_data/pvp_season.rb +3 -3
  43. data/lib/blizzard_api/wow/game_data/pvp_tier.rb +1 -1
  44. data/lib/blizzard_api/wow/game_data/quest.rb +6 -6
  45. data/lib/blizzard_api/wow/game_data/reputation.rb +4 -4
  46. data/lib/blizzard_api/wow/game_data/spell.rb +1 -1
  47. data/lib/blizzard_api/wow/game_data/talent.rb +2 -2
  48. data/lib/blizzard_api/wow/game_data/tech_talent.rb +3 -3
  49. data/lib/blizzard_api/wow/game_data/wow_token.rb +1 -1
  50. data/lib/blizzard_api/wow/profile/character_profile.rb +51 -51
  51. data/lib/blizzard_api/wow/profile/guild.rb +8 -8
  52. data/lib/blizzard_api/wow/profile/profile.rb +5 -5
  53. data/lib/blizzard_api/wow/search/search_request.rb +1 -1
  54. metadata +2 -2
@@ -16,7 +16,7 @@ module BlizzardApi
16
16
  # @!macro request_options
17
17
  #
18
18
  # @!macro response
19
- def pvp_talents(options = {})
19
+ def pvp_talents(**options)
20
20
  api_request "#{base_url(:game_data)}/pvp-talent/index", default_options.merge(options)
21
21
  end
22
22
 
@@ -28,7 +28,7 @@ module BlizzardApi
28
28
  # @!macro request_options
29
29
  #
30
30
  # @!macro response
31
- def pvp_talent(id, options = {})
31
+ def pvp_talent(id, **options)
32
32
  api_request "#{base_url(:game_data)}/pvp-talent/#{id}", default_options.merge(options)
33
33
  end
34
34
 
@@ -16,7 +16,7 @@ module BlizzardApi
16
16
  # @!macro request_options
17
17
  #
18
18
  # @!macro response
19
- def tech_talent_trees(options = {})
19
+ def tech_talent_trees(**options)
20
20
  api_request "#{base_url(:game_data)}/tech-talent-tree/index", default_options.merge(options)
21
21
  end
22
22
 
@@ -28,7 +28,7 @@ module BlizzardApi
28
28
  # @!macro request_options
29
29
  #
30
30
  # @!macro response
31
- def tech_talent_tree(id, options = {})
31
+ def tech_talent_tree(id, **options)
32
32
  api_request "#{base_url(:game_data)}/tech-talent-tree/#{id}", default_options.merge(options)
33
33
  end
34
34
 
@@ -40,7 +40,7 @@ module BlizzardApi
40
40
  # @!macro request_options
41
41
  #
42
42
  # @!macro response
43
- def media(id, options = {})
43
+ def media(id, **options)
44
44
  api_request "#{base_url(:media)}/tech-talent/#{id}", default_options.merge(options)
45
45
  end
46
46
 
@@ -16,7 +16,7 @@ module BlizzardApi
16
16
  # @!macro request_options
17
17
  #
18
18
  # @!macro response
19
- def get(options = {})
19
+ def get(**options)
20
20
  opts = { namespace: :dynamic, ttl: CACHE_HOUR }.merge(options)
21
21
  api_request "#{base_url(:game_data)}/token/index", opts
22
22
  end
@@ -22,7 +22,7 @@ module BlizzardApi
22
22
  # @!macro request_options
23
23
  #
24
24
  # @!macro response
25
- def get(realm, character, options = {})
25
+ def get(realm, character, **options)
26
26
  character_request realm, character, options
27
27
  end
28
28
 
@@ -36,8 +36,8 @@ module BlizzardApi
36
36
  # @!macro request_options
37
37
  #
38
38
  # @!macro response
39
- def achievements(realm, character, options = {})
40
- character_request realm, character, options, 'achievements'
39
+ def achievements(realm, character, **options)
40
+ character_request realm, character, 'achievements', options
41
41
  end
42
42
 
43
43
  ##
@@ -50,8 +50,8 @@ module BlizzardApi
50
50
  # @!macro request_options
51
51
  #
52
52
  # @!macro response
53
- def achievement_statistics(realm, character, options = {})
54
- character_request realm, character, options, 'achievements/statistics'
53
+ def achievement_statistics(realm, character, **options)
54
+ character_request realm, character, 'achievements/statistics', options
55
55
  end
56
56
 
57
57
  ##
@@ -64,8 +64,8 @@ module BlizzardApi
64
64
  # @!macro request_options
65
65
  #
66
66
  # @!macro response
67
- def appearance(realm, character, options = {})
68
- character_request realm, character, options, 'appearance'
67
+ def appearance(realm, character, **options)
68
+ character_request realm, character, 'appearance', options
69
69
  end
70
70
 
71
71
  ##
@@ -78,8 +78,8 @@ module BlizzardApi
78
78
  # @!macro request_options
79
79
  #
80
80
  # @!macro response
81
- def collections(realm, character, options = {})
82
- character_request realm, character, options, 'collections'
81
+ def collections(realm, character, **options)
82
+ character_request realm, character, 'collections', options
83
83
  end
84
84
 
85
85
  ##
@@ -92,8 +92,8 @@ module BlizzardApi
92
92
  # @!macro request_options
93
93
  #
94
94
  # @!macro response
95
- def pets(realm, character, options = {})
96
- character_request realm, character, options, 'collections/pets'
95
+ def pets(realm, character, **options)
96
+ character_request realm, character, 'collections/pets', options
97
97
  end
98
98
 
99
99
  ##
@@ -106,8 +106,8 @@ module BlizzardApi
106
106
  # @!macro request_options
107
107
  #
108
108
  # @!macro response
109
- def mounts(realm, character, options = {})
110
- character_request realm, character, options, 'collections/mounts'
109
+ def mounts(realm, character, **options)
110
+ character_request realm, character, 'collections/mounts', options
111
111
  end
112
112
 
113
113
  ##
@@ -120,8 +120,8 @@ module BlizzardApi
120
120
  # @!macro request_options
121
121
  #
122
122
  # @!macro response
123
- def encounters(realm, character, options = {})
124
- character_request realm, character, options, 'encounters'
123
+ def encounters(realm, character, **options)
124
+ character_request realm, character, 'encounters', options
125
125
  end
126
126
 
127
127
  ##
@@ -134,8 +134,8 @@ module BlizzardApi
134
134
  # @!macro request_options
135
135
  #
136
136
  # @!macro response
137
- def dungeons(realm, character, options = {})
138
- character_request realm, character, options, 'encounters/dungeons'
137
+ def dungeons(realm, character, **options)
138
+ character_request realm, character, 'encounters/dungeons', options
139
139
  end
140
140
 
141
141
  ##
@@ -148,8 +148,8 @@ module BlizzardApi
148
148
  # @!macro request_options
149
149
  #
150
150
  # @!macro response
151
- def raids(realm, character, options = {})
152
- character_request realm, character, options, 'encounters/raids'
151
+ def raids(realm, character, **options)
152
+ character_request realm, character, 'encounters/raids', options
153
153
  end
154
154
 
155
155
  ##
@@ -162,8 +162,8 @@ module BlizzardApi
162
162
  # @!macro request_options
163
163
  #
164
164
  # @!macro response
165
- def equipment(realm, character, options = {})
166
- character_request realm, character, options, 'equipment'
165
+ def equipment(realm, character, **options)
166
+ character_request realm, character, 'equipment', options
167
167
  end
168
168
 
169
169
  ##
@@ -176,8 +176,8 @@ module BlizzardApi
176
176
  # @!macro request_options
177
177
  #
178
178
  # @!macro response
179
- def hunter_pets(realm, character, options = {})
180
- character_request realm, character, options, 'hunter-pets'
179
+ def hunter_pets(realm, character, **options)
180
+ character_request realm, character, 'hunter-pets', options
181
181
  end
182
182
 
183
183
  ##
@@ -190,8 +190,8 @@ module BlizzardApi
190
190
  # @!macro request_options
191
191
  #
192
192
  # @!macro response
193
- def media(realm, character, options = {})
194
- character_request realm, character, options, 'character-media'
193
+ def media(realm, character, **options)
194
+ character_request realm, character, 'character-media', options
195
195
  end
196
196
 
197
197
  ##
@@ -204,8 +204,8 @@ module BlizzardApi
204
204
  # @!macro request_options
205
205
  #
206
206
  # @!macro response
207
- def mythic_keystone_profile(realm, character, options = {})
208
- character_request realm, character, options, 'mythic-keystone-profile'
207
+ def mythic_keystone_profile(realm, character, **options)
208
+ character_request realm, character, 'mythic-keystone-profile', options
209
209
  end
210
210
 
211
211
  ##
@@ -219,8 +219,8 @@ module BlizzardApi
219
219
  # @!macro request_options
220
220
  #
221
221
  # @!macro response
222
- def mythic_keystone_seasons(realm, character, season = nil, options = {})
223
- character_request realm, character, options, "mythic-keystone-profile/season/#{season}"
222
+ def mythic_keystone_seasons(realm, character, season = nil, **options)
223
+ character_request realm, character, "mythic-keystone-profile/season/#{season}", options
224
224
  end
225
225
 
226
226
  ##
@@ -233,8 +233,8 @@ module BlizzardApi
233
233
  # @!macro request_options
234
234
  #
235
235
  # @!macro response
236
- def professions(realm, character, options = {})
237
- character_request realm, character, options, 'professions'
236
+ def professions(realm, character, **options)
237
+ character_request realm, character, 'professions', options
238
238
  end
239
239
 
240
240
  ##
@@ -248,8 +248,8 @@ module BlizzardApi
248
248
  # @!macro request_options
249
249
  #
250
250
  # @!macro response
251
- def status(realm, character, options = {})
252
- character_request realm, character, options, 'status'
251
+ def status(realm, character, **options)
252
+ character_request realm, character, 'status', options
253
253
  end
254
254
 
255
255
  ##
@@ -263,8 +263,8 @@ module BlizzardApi
263
263
  # @!macro request_options
264
264
  #
265
265
  # @!macro response
266
- def pvp_bracket(realm, character, bracket, options = {})
267
- character_request realm, character, options, "pvp-bracket/#{bracket}"
266
+ def pvp_bracket(realm, character, bracket, **options)
267
+ character_request realm, character, "pvp-bracket/#{bracket}", options
268
268
  end
269
269
 
270
270
  ##
@@ -277,8 +277,8 @@ module BlizzardApi
277
277
  # @!macro request_options
278
278
  #
279
279
  # @!macro response
280
- def pvp_summary(realm, character, options = {})
281
- character_request realm, character, options, 'pvp-summary'
280
+ def pvp_summary(realm, character, **options)
281
+ character_request realm, character, 'pvp-summary', options
282
282
  end
283
283
 
284
284
  ##
@@ -292,11 +292,11 @@ module BlizzardApi
292
292
  # @option options [Boolean] :completed Should return completed quests
293
293
  #
294
294
  # @!macro response
295
- def quests(realm, character, options = {})
295
+ def quests(realm, character, **options)
296
296
  completed = options.delete(:completed) || false
297
- return character_request realm, character, options, 'quests/completed' if completed
297
+ return character_request realm, character, 'quests/completed', options if completed
298
298
 
299
- character_request realm, character, options, 'quests'
299
+ character_request realm, character, 'quests', options
300
300
  end
301
301
 
302
302
  ##
@@ -309,8 +309,8 @@ module BlizzardApi
309
309
  # @!macro request_options
310
310
  #
311
311
  # @!macro response
312
- def reputation(realm, character, options = {})
313
- character_request realm, character, options, 'reputations'
312
+ def reputation(realm, character, **options)
313
+ character_request realm, character, 'reputations', options
314
314
  end
315
315
 
316
316
  ##
@@ -323,8 +323,8 @@ module BlizzardApi
323
323
  # @!macro request_options
324
324
  #
325
325
  # @!macro response
326
- def soulbinds(realm, character, options = {})
327
- character_request realm, character, options, 'soulbinds'
326
+ def soulbinds(realm, character, **options)
327
+ character_request realm, character, 'soulbinds', options
328
328
  end
329
329
 
330
330
  ##
@@ -337,8 +337,8 @@ module BlizzardApi
337
337
  # @!macro request_options
338
338
  #
339
339
  # @!macro response
340
- def specializations(realm, character, options = {})
341
- character_request realm, character, options, 'specializations'
340
+ def specializations(realm, character, **options)
341
+ character_request realm, character, 'specializations', options
342
342
  end
343
343
 
344
344
  ##
@@ -351,8 +351,8 @@ module BlizzardApi
351
351
  # @!macro request_options
352
352
  #
353
353
  # @!macro response
354
- def statistics(realm, character, options = {})
355
- character_request realm, character, options, 'statistics'
354
+ def statistics(realm, character, **options)
355
+ character_request realm, character, 'statistics', options
356
356
  end
357
357
 
358
358
  ##
@@ -365,8 +365,8 @@ module BlizzardApi
365
365
  # @!macro request_options
366
366
  #
367
367
  # @!macro response
368
- def titles(realm, character, options = {})
369
- character_request realm, character, options, 'titles'
368
+ def titles(realm, character, **options)
369
+ character_request realm, character, 'titles', options
370
370
  end
371
371
 
372
372
  private
@@ -377,7 +377,7 @@ module BlizzardApi
377
377
  opts
378
378
  end
379
379
 
380
- def character_request(realm, character, options = {}, variant = nil)
380
+ def character_request(realm, character, variant = nil, **options)
381
381
  uri = "#{base_url(:profile)}/character/#{string_to_slug(realm)}/#{string_to_slug(character)}"
382
382
  uri += "/#{variant}" if variant
383
383
  api_request uri, default_options.merge(options)
@@ -20,7 +20,7 @@ module BlizzardApi
20
20
  # @!macro request_options
21
21
  #
22
22
  # @!macro response
23
- def get(realm, guild, options = {})
23
+ def get(realm, guild, **options)
24
24
  guild_request(realm, guild, options)
25
25
  end
26
26
 
@@ -33,8 +33,8 @@ module BlizzardApi
33
33
  # @!macro request_options
34
34
  #
35
35
  # @!macro response
36
- def roster(realm, guild, options = {})
37
- guild_request realm, guild, options, 'roster'
36
+ def roster(realm, guild, **options)
37
+ guild_request realm, guild, 'roster', options
38
38
  end
39
39
 
40
40
  ##
@@ -45,8 +45,8 @@ module BlizzardApi
45
45
  # @!macro request_options
46
46
  #
47
47
  # @!macro response
48
- def achievements(realm, guild, options = {})
49
- guild_request realm, guild, options, 'achievements'
48
+ def achievements(realm, guild, **options)
49
+ guild_request realm, guild, 'achievements', options
50
50
  end
51
51
 
52
52
  ##
@@ -57,13 +57,13 @@ module BlizzardApi
57
57
  # @!macro request_options
58
58
  #
59
59
  # @!macro response
60
- def activity(realm, guild, options = {})
61
- guild_request realm, guild, options, 'activity'
60
+ def activity(realm, guild, **options)
61
+ guild_request realm, guild, 'activity', options
62
62
  end
63
63
 
64
64
  private
65
65
 
66
- def guild_request(realm, guild, options = {}, variant = nil)
66
+ def guild_request(realm, guild, variant = nil, **options)
67
67
  realm = string_to_slug(realm)
68
68
  guild = string_to_slug(guild)
69
69
  url = "#{base_url(:game_data)}/guild/#{realm}/#{guild}"
@@ -18,7 +18,7 @@ module BlizzardApi
18
18
  # @!macro request_options
19
19
  #
20
20
  # @!macro response
21
- def get(options = {})
21
+ def get(**options)
22
22
  api_request base_url(:user_profile).to_s, default_options.merge(options)
23
23
  end
24
24
 
@@ -28,7 +28,7 @@ module BlizzardApi
28
28
  # @!macro request_options
29
29
  #
30
30
  # @!macro response
31
- def protected_character(realm_id, character_id, options = {})
31
+ def protected_character(realm_id, character_id, **options)
32
32
  api_request "#{base_url(:user_profile)}/protected-character/#{realm_id}-#{character_id}", default_options.merge(options)
33
33
  end
34
34
 
@@ -38,7 +38,7 @@ module BlizzardApi
38
38
  # @!macro request_options
39
39
  #
40
40
  # @!macro response
41
- def collection(options = {})
41
+ def collection(**options)
42
42
  api_request "#{base_url(:user_profile)}/collections", default_options.merge(options)
43
43
  end
44
44
 
@@ -48,7 +48,7 @@ module BlizzardApi
48
48
  # @!macro request_options
49
49
  #
50
50
  # @!macro response
51
- def mounts(options = {})
51
+ def mounts(**options)
52
52
  api_request "#{base_url(:user_profile)}/collections/mounts", default_options.merge(options)
53
53
  end
54
54
 
@@ -58,7 +58,7 @@ module BlizzardApi
58
58
  # @!macro request_options
59
59
  #
60
60
  # @!macro response
61
- def pets(options = {})
61
+ def pets(**options)
62
62
  api_request "#{base_url(:user_profile)}/collections/pets", default_options.merge(options)
63
63
  end
64
64
 
@@ -13,7 +13,7 @@ module BlizzardApi
13
13
  #
14
14
  # @!macro request_options
15
15
  # @!macro response
16
- def search(page = 1, page_size = 100, options = {})
16
+ def search(page = 1, page_size = 100, **options)
17
17
  search_options = SearchComposer.new(page, page_size)
18
18
  yield search_options if block_given?
19
19
 
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: blizzard_api
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.5.4
4
+ version: 0.5.5
5
5
  platform: ruby
6
6
  authors:
7
7
  - Francis Schiavo
8
8
  autorequire:
9
9
  bindir: exe
10
10
  cert_chain: []
11
- date: 2020-12-19 00:00:00.000000000 Z
11
+ date: 2021-02-16 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: redis