Class: Sightstone::SummonerModule

Inherits:
SightstoneBaseModule show all
Defined in:
lib/sightstone/modules/summoner_module.rb

Overview

Module to provide calls to the summoner api

Instance Method Summary collapse

Constructor Details

#initialize(sightstone) ⇒ SummonerModule

Returns a new instance of SummonerModule.



11
12
13
 
# File 'lib/sightstone/modules/summoner_module.rb', line 11

def initialize(sightstone)
  @sightstone = sightstone
end

Instance Method Details

#masterybook(summoner, optional = {}) ⇒ Masterybook

returns the masterybook of a summoner

Parameters:

  • summoner (Summoner, id) —

    summoner object or id of a summoner

  • optional (Hash<Symbol, String>) (defaults to: {}) —

    optional arguments: :region => replaces default region

Returns:

  • (Masterybook) —

    masterybook of the summoner



154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
 
# File 'lib/sightstone/modules/summoner_module.rb', line 154

def masterybook(summoner, optional={})
  region = optional[:region] || @sightstone.region
   id = if summoner.is_a? Summoner
    summoner.id
  else
    summoner
  end
  uri = "http://prod.api.pvp.net/api/lol/#{region}/v1.3/summoner/#{id}/masteries"
  response = _get_api_response(uri)
  _parse_response(response) { |resp|
    data = JSON.parse(resp)
    book =  MasteryBook.new(data.values[0])
    if block_given?
      yield book
    else
      return book
    end
  }
end

#masterybooks(summoners, optional = {}) ⇒ Hash<Integer, Masterybook>

returns the masterybooks for multiple summoners

Parameters:

  • summoners (Array<(Summoner, Integer)>) —

    list of summoner objects or ids of summoners

  • optional (Hash<Symbol, String>) (defaults to: {}) —

    optional arguments: :region => replaces default region

Returns:

  • (Hash<Integer, Masterybook>) —

    A hash mapping masterybooks to the ids of summoners



178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
 
# File 'lib/sightstone/modules/summoner_module.rb', line 178

def masterybooks(summoners, optional={})
  return {} if summoners.empty?
  region = optional[:region] || @sightstone.region
  ids = summoners.collect { |summoner|
    if summoner.is_a? Summoner
      summoner.id
    else
      summoner
    end
  }

  uri = "http://prod.api.pvp.net/api/lol/#{region}/v1.3/summoner/#{ids.join(',')}/masteries"
  response = _get_api_response(uri)
  _parse_response(response) { |resp|
    data = JSON.parse(resp)
    books = {}
    data.each do |key, raw_book|
      books[key] = MasteryBook.new(raw_book)
    end
    if block_given?
      yield books
    else
      return books
    end
  }
end

#names(ids, optional = {}) ⇒ Hash<Numeric, String>

returns the names for the ids

Parameters:

  • ids (Array<Numeric>) —

    ids

  • optional (Hash<Symbol, String>) (defaults to: {}) —

    optional arguments: :region => replaces default region

Returns:

  • (Hash<Numeric, String>) —

    a hash matching each id to the summoners name



75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/sightstone/modules/summoner_module.rb', line 75

def names(ids, optional={})
  region = optional[:region] || @sightstone.region
  ids = ids.join(',')
  uri = "http://prod.api.pvp.net/api/lol/#{region}/v1.3/summoner/#{ids}/name"
  response = _get_api_response(uri)
  _parse_response(response) { |resp|
    data = JSON.parse(resp)

    names_hash = Hash.new
    data.each do |id, name|
      names_hash[id.to_i] = name
    end
    if block_given?
      yield names_hash
    else
      return names_hash
    end
  }
end

#runebook(summoner, optional = {}) ⇒ Runebook

returns the runebook of a summoner

Parameters:

  • summoner (Summoner, id) —

    summoner object or id of a summoner

  • optional (Hash<Symbol, String>) (defaults to: {}) —

    optional arguments: :region => replaces default region

Returns:

  • (Runebook) —

    runebook of the summoner



99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
 
# File 'lib/sightstone/modules/summoner_module.rb', line 99

def runebook(summoner, optional={})
  region = optional[:region] || @sightstone.region
  id = if summoner.is_a? Summoner
    summoner.id
  else
    summoner
  end
  uri = "http://prod.api.pvp.net/api/lol/#{region}/v1.3/summoner/#{id}/runes"
  response = _get_api_response(uri)
  _parse_response(response) { |resp|
    data = JSON.parse(resp)
    book = RuneBook.new(data.values[0])
    if block_given?
      yield book
    else
      return book
    end
  }
end

#runebooks(summoners, optional = {}) ⇒ Hash<Integer, Runebook>

returns the runebook for multiple summoners

Parameters:

  • summoners (Array<(Summoner, Integer)>) —

    list of summoner objects or ids of summoners

  • optional (Hash<Symbol, String>) (defaults to: {}) —

    optional arguments: :region => replaces default region

Returns:

  • (Hash<Integer, Runebook>) —

    A hash mapping runebooks to the ids of summoners



123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
 
# File 'lib/sightstone/modules/summoner_module.rb', line 123

def runebooks(summoners, optional={})
  return {} if summoners.empty?

  region = optional[:region] || @sightstone.region
  ids = summoners.collect { |summoner|
    if summoner.is_a? Summoner
      summoner.id
    else
      summoner
    end
  }
  uri = "http://prod.api.pvp.net/api/lol/#{region}/v1.3/summoner/#{ids.join(',')}/runes"
  response = _get_api_response(uri)
  _parse_response(response) { |resp|
    data = JSON.parse(resp)
    books = {}
    data.each do |key, raw_book|
      books[key] = RuneBook.new(raw_book)
    end
    if block_given?
      yield books
    else
      return books
    end
  }
end

#summoner(name_or_id, optional = {}) ⇒ Object

returns a summoner object @ return [Summoner] summoner

Parameters:

  • name_or_id (Integer, String) —

    name or id of the summoner

  • optional (Hash) (defaults to: {}) —

    optional arguments: :region => replaces default region



19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
 
# File 'lib/sightstone/modules/summoner_module.rb', line 19

def summoner(name_or_id, optional={})
  region = optional[:region] || @sightstone.region
  uri = if name_or_id.is_a? Integer
    "https://prod.api.pvp.net/api/lol/#{region}/v1.3/summoner/#{name_or_id}"
  else
    "https://prod.api.pvp.net/api/lol/#{region}/v1.3/summoner/by-name/#{URI::encode(name_or_id)}"
  end
  
  response = _get_api_response(uri)
  _parse_response(response) { |resp|
    data = JSON.parse(resp)
    s = Summoner.new(data.values[0])
    if block_given?
      yield s
    else
      return s
    end
  }
end

#summoners(names_or_ids, optional = {}) ⇒ Hash<(String or Integer), Summoner>

returns an array of summoner objects

Parameters:

  • names_or_ids (Array<Integer, String>) —

    names or ids of summoners

  • optional (Hash) (defaults to: {}) —

    optional arguments: :region => replaces default region

Returns:

  • (Hash<(String or Integer), Summoner>) —

    A Hash mapping summoner ids or names to summoner objects



43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/sightstone/modules/summoner_module.rb', line 43

def summoners(names_or_ids, optional={})
  return {} if names_or_ids.empty?

  region = optional[:region] || @sightstone.region
  
  uri = if !names_or_ids[0].is_a? String
    "https://prod.api.pvp.net/api/lol/#{region}/v1.3/summoner/#{names_or_ids.join(',')}"
  else
    "https://prod.api.pvp.net/api/lol/#{region}/v1.3/summoner/by-name/#{URI::encode(names_or_ids.join(','))}"
  end
  
  response = _get_api_response(uri)
  _parse_response(response) { |resp|
    data = JSON.parse(resp)
    summoners = {}
    data.each do |id_or_name, raw_summoner|
      summoners[id_or_name] = Summoner.new(raw_summoner)
    end

    if block_given?
      yield summoners
    else
      return summoners
    end
  }
end