riot-api 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: dd4a09b43f7f2dcee1d886fd5cb1b0b893a8111d
+  data.tar.gz: fb712b6fd81492d90e541b1125667403a9621273
+SHA512:
+  metadata.gz: dea2d549bcc05bedaa8438358469587b918a4cc7b22eba093b67b6123e056a278920bb54f080c5521f703da0ef17fb2a2fdbd92b861390b950946c6b4b42bfe1
+  data.tar.gz: fbf7b255adc02bb28d79804354febd50d1030121a8f230812cb817b7d3ec3a8d85d565ab2c28e6cc67a733f1c0cee13dd56ae0768bdf88f3ea6a6e9b1f44411c

data/LICENSE.md

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2013 Peter Souter
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,55 @@
+# Riot API
+
+A Ruby wrapper around connecting to the [Riot API](https://developer.riotgames.com)
+
+This is an ALPHA version. Please open up issues or send a pull request for any bugs you find =)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'riot-api'
+```
+
+Or install it yourself as:
+
+```shell
+$ gem install riot_api
+```
+
+## Usage:
+
+If you haven't already, you'll need to go to [http://developer.riotgames.com/](http://developer.riotgames.com/) and get an API key.
+
+```ruby
+require 'riot-api'
+
+# Before you can use the API, you have to give it your API Key
+RiotAPI::API_KEY = 'API_KEY_HERE'
+# Search by Summoner name
+summoner = RiotAPI::Summoner.find_by_name('MrQuackers')
+# => #<RiotAPI::Summoner:0x000000017a0840 @region="na", @id=20933307, @name="MrQuackers", @profile_icon_id=535, @summoner_level=30, @revision_date=1387030959000, @revision_date_str="12/14/2013 02:22 PM UTC"> 
+
+summoner.name # => "MrQuackers"
+summoner.summoner_level # => 30
+summoner.mastery_pages # => Returns an array of mastery pages
+MasteryPage.find("NA", 20933307) # => Equivalent to above
+
+```
+
+## [Documentation]()
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+For more information and a complete list see [the contributor page on GitHub](https://github.com/petems/riot_api/contributors).
+
+## License
+
+[MIT](./LICENSE.md)

data/lib/riot_api.rb

@@ -0,0 +1,14 @@
+require 'json'
+require 'httparty'
+require 'active_support/core_ext'
+
+require './riot_api/champion'
+require './riot_api/game'
+require './riot_api/client'
+require './riot_api/aggregated_stat'
+require './riot_api/mastery_page'
+require './riot_api/rune'
+require './riot_api/talent'
+require './riot_api/player_stat_summary'
+require './riot_api/rune_page'
+require './riot_api/summoner'

data/lib/riot_api/champion.rb

@@ -0,0 +1,28 @@
+module RiotAPI
+	# This class represents a champion in League of Legends. 
+	# It contains data about the champion.
+	class Champion
+		# Creates a new Champion described by the JSON data returned from the API
+		def initialize(data)
+			data.each do |key, value|
+				key = key.underscore
+				self.class.send(:attr_accessor, key.to_sym)
+				instance_variable_set("@#{key}", value)
+			end
+		end
+
+		# Returns all the champions in the game
+		# For only the free to play champions, set `free` to true
+		def self.all(free=false)
+			champs_json = RiotAPI::Client.get('na', 'champion', { freeToPlay: free })
+			champs_json["champions"].map do |c|
+				Champion.new(c)
+			end
+		end
+
+		# Returns all the free to play champions in the game
+		def self.free_to_play_champions
+			all(true)
+		end
+	end
+end

data/lib/riot_api/client.rb

@@ -0,0 +1,37 @@
+module RiotAPI
+	class InvalidAPIRequest < StandardError
+	end
+	# This class is what handles the requests to the API.
+	class Client
+		#API Version. Be aware that this is only a default value. It CAN be overriden within the methods.
+		VERSION = 'v1.1'
+
+		# Issues a GET request the the API. Pass in the region, and resource as well as optional query params.
+		# It will return a Hash of the JSON data
+		def self.get(region, resource, options={})
+			region.downcase!
+			options.merge!({api_key: RiotAPI::API_KEY})
+			url = "http://prod.api.pvp.net/api/lol/#{region}/#{VERSION}/#{resource}"
+			response = HTTParty.get(url, query: options)
+			if response.code == 200
+				JSON.parse(response.body)
+			else
+				nil
+			end
+		end
+
+		# Issues a POST request the the API. Pass in the region, and resource as well as optional query params.
+		# It will return a Hash of the JSON data
+		def self.post(region, resource, options={})
+			region.downcase!
+			options.merge!({api_key: RiotAPI::API_KEY})
+			url = "http://prod.api.pvp.net/api/lol/#{region}/#{version}/#{resource}"
+			response = HTTParty.post(url, query: options)
+			if response.code == 200
+				JSON.parse(response.body)
+			else
+				throw InvalidAPIRequest, response.message
+			end
+		end
+	end
+end

data/lib/riot_api/game.rb

@@ -0,0 +1,30 @@
+module RiotAPI
+	class Game
+		attr_reader :statistics
+		def initialize(data)
+			data.each do |key, value|
+				key = key.underscore
+				if key == 'statistics'
+					self.statistics = value
+				else
+					self.class.send(:attr_accessor, key.to_sym)
+					instance_variable_set("@#{key}", value)
+				end
+			end
+		end
+
+		# Returns the last 10 games for the summoner
+		def self.recent_games(region, summoner_id)
+			response = RiotAPI::Client.get(region, "game/by-summoner/#{summoner_id}/recent")
+			response["games"].map do |data|
+				RiotAPI::Game.new(data)
+			end
+		end
+
+		def statistics=(value)
+			@statistics = value.map do |stat|
+				AggregatedStat.new(stat)
+			end
+		end
+	end
+end

data/lib/riot_api/mastery_page.rb

@@ -0,0 +1,30 @@
+module RiotAPI
+	class MasteryPage
+		attr_reader :talents
+		def initialize(data)
+			data.each do |key, value|
+				key = key.underscore
+				if key == "talents"
+					self.talents = value
+				else
+					self.class.send(:attr_accessor, key.to_sym)
+					instance_variable_set("@#{key}", value)
+				end
+			end
+		end
+
+		def self.find(region, summoner_id)
+			response = RiotAPI::Client.get(region, "summoner/#{summoner_id}/masteries")
+			response["pages"].map do |data|
+				RiotAPI::MasteryPage.new(data)
+			end
+		end
+
+		def talents=(value)
+			@talents = {}
+			value.each do |talent|
+				@talents[talent["id"]] = Talent.new(talent)
+			end
+		end
+	end
+end

data/lib/riot_api/rune.rb

@@ -0,0 +1,12 @@
+module RiotAPI
+	class Rune
+		def initialize(data)
+			data.delete("runeSlotId")
+			key = key.underscore
+			data.each do |key, value|
+				self.class.send(:attr_accessor, key.to_sym)
+				instance_variable_set("@#{key}", value)
+			end
+		end
+	end
+end

data/lib/riot_api/rune_page.rb

@@ -0,0 +1,31 @@
+module RiotAPI
+	class RunePage
+		attr_reader :slots
+		
+		def initialize(data)
+			data.each do |key, value|
+				key = key.underscore
+				if key == "slots"
+					self.slots = value
+				else
+					self.class.send(:attr_accessor, key.to_sym)
+					instance_variable_set("@#{key}", value)
+				end
+			end
+		end
+
+		def self.find(region, summoner_id)
+			response = RiotAPI::Client.get(region, "summoner/#{summoner_id}/runes")
+			response["pages"].map do |data|
+				RiotAPI::MasteryPage.new(data)
+			end
+		end
+
+		def slots=(val)
+			@slots = {}
+			val.each do |slot|
+				@slots[slot["runeSlotId"]] = Rune.new(slot["rune"])
+			end
+		end
+	end
+end

data/lib/riot_api/summoner.rb

@@ -0,0 +1,60 @@
+module RiotAPI
+	class Summoner
+		attr_accessor :region
+		def initialize(data, region)
+			@region = region
+			data.each do |key, value|
+				key = key.underscore
+				self.class.send(:attr_accessor, key.to_sym)
+				instance_variable_set("@#{key}", value)
+			end
+		end
+
+		# Find a summoner by it's name
+		def self.find_by_name(region, name) 
+			response = RiotAPI::Client.get(region, "summoner/by-name/#{name}")
+			if response
+				Summoner.new(response, region)
+			else
+				nil
+			end
+		end
+
+		# Find a summoner by it's summoner ID
+		def self.find(region, summoner_id) 
+			response = RiotAPI::Client.get(region, "summoner/#{summoner_id}")
+			if response
+				Summoner.new(response)
+			else
+				nil
+			end
+		end
+
+		# Returns an array of names. summoner_ids should be an array of summoner_ids
+		def self.names_by_ids(region, summoner_ids)
+			summoner_ids = summoner_ids.join(',').first(40).compact
+			response = RiotAPI::Client.get(region, "summoner/#{summoner_ids}/name")
+			response || []
+		end
+
+		# Returns the MasteryPage array for the Summoner instance
+		def mastery_pages
+			MasteryPage.find(self.region, self.id)
+		end
+
+		# Returns the RunePage array for the Summoner instance
+		def rune_pages
+			RunePage.find(self.region, self.id)
+		end
+
+		# Returns the Player Stats for the Summoner
+		def player_stats(season='SEASON3')
+			PlayerStatSummary.find(self.region, self.id, season)
+		end
+
+		# Returns the last 10 games for the Summoner
+		def recent_games
+			Game.recent_games(self.region, self.id)
+		end
+	end
+end

data/lib/riot_api/talent.rb

@@ -0,0 +1,11 @@
+module RiotAPI
+	class Talent
+		def initialize(data)
+			data.each do |key, value|
+				key = key.underscore
+				self.class.send(:attr_accessor, key.to_sym)
+				instance_variable_set("@#{key}", value)
+			end
+		end
+	end
+end

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: riot-api
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Anujan Panchadcharam
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: An API that allows users to interact with Riot Games' League of Legends
+  API
+email: anujan714@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+- LICENSE.md
+files:
+- lib/riot_api.rb
+- lib/riot_api/champion.rb
+- lib/riot_api/client.rb
+- lib/riot_api/game.rb
+- lib/riot_api/mastery_page.rb
+- lib/riot_api/rune.rb
+- lib/riot_api/rune_page.rb
+- lib/riot_api/summoner.rb
+- lib/riot_api/talent.rb
+- README.md
+- LICENSE.md
+homepage: https://github.com/anujan/riot-api
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.1.11
+signing_key: 
+specification_version: 4
+summary: Wrapper for Riot Games' API!
+test_files: []