riot_lol_api 0.0.4 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1f0c729a9e5623a8a5ba0df115b092558d1db2bc
-  data.tar.gz: 6781933dc8c5b2c1d113f6d0255ceefd85cbacb0
+  metadata.gz: 97acb1526afe0a5c58b273e0001f83e5818f625a
+  data.tar.gz: ce093f7638e7986b430e389eddc1cf02bc169dfd
 SHA512:
-  metadata.gz: bb38c0b530d75258e241e3001a75cd793422f81befbfd53c22c30a8ce664b4b3cc80e049711bd4e2a09f0208decb97c029e8bafee1d9268e30f5bfd37e7aab85
-  data.tar.gz: 6a02d861420dc41f4d3e2761836151ff3d65ec977b3e8215b3743b6770fc2042815df85df905f49218301e62629abcd91542ca5ddd7779b6346dbaa50e0424c6
+  metadata.gz: 46d383514004bfa91e94ad71e37186cbc15131450d55485f5896a7232a6342cc4556cbd05c23afe8a52da979091bd1d13f77f91ea9f1e079856e8def6b1281ad
+  data.tar.gz: 5911f772bf743b5597617b2b077654e022691b3ea18426cedd913a6ae523d188bf5954c6a29562c5c0fb8340abd7bff551ca31f70b9f7e6cc24ac2ef60d37586

data/.gitignore

@@ -15,3 +15,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+.DS_Store

data/README.md

@@ -1,30 +1,185 @@
 [![Gem Version](https://badge.fury.io/rb/riot_lol_api.svg)](http://badge.fury.io/rb/riot_lol_api)
 
-# RiotLolApi
-
-RIOT LOL API
+```
+ __________.__        __                                      _____ __________.___ 
+ \______   \__| _____/  |_     _________    _____   ____     /  _  \\______   \   |
+  |       _/  |/  _ \   __\   / ___\__  \  /     \_/ __ \   /  /_\  \|     ___/   |
+  |    |   \  (  <_> )  |    / /_/  > __ \|  Y Y  \  ___/  /    |    \    |   |   |
+  |____|_  /__|\____/|__|    \___  (____  /__|_|  /\___  > \____|__  /____|   |___|
+         \/                 /_____/     \/      \/     \/          \/              
+```
 
 ## Status 
 
-In work ...
+###V 0.1.0
+
+```
+- champion-v1.2 ... NO IMPLEMENT
+- game-v1.3 ... OK
+- league-v2.4 ... 
+	/by-summoner/{summonerIds}/entry ... OK
+- lol-static-data-v1.2 ... OK
+- stats-v1.3 ... OK
+- summoner-v1.4 ... OK
+	/{summonerIds}/name ... NO IMPLEMENT
+- team-v2.3 ... NO IMPLEMENT
+```
 
 ## Installation
 
 Add this line to your application's Gemfile:
-
-    gem 'riot_lol_api'
+```ruby
+gem 'riot_lol_api'
+```
 
 And then execute:
-
-    $ bundle
+```shell
+bundle
+```
 
 Or install it yourself as:
-
-    $ gem install riot_lol_api
+```shell
+gem install riot_lol_api
+```
 
 ## Usage
+###1) Token
+Get token api on [http://developer.riotgames.com/](http://developer.riotgames.com/)
+
+###2) Scripts
+Sample scripts
+```ruby
+# Set token
+RiotLolApi::TOKEN = XXXXXXXXXXXXXXXXXXXXXXXXXXXX
+
+# Create client
+client = RiotLolApi::Client.new(:region => 'your_region')
+
+# Start get data
+summoner = client.get_summoner_by_name 'your_summoner_name'
+
+```
+
+Methods
+```ruby
+# CLIENT
+
+# Create client object
+client = RiotLolApi::Client.new(:region => 'your_region')
+
+# SUMMONER
+
+# Get summoner by name
+# params : name => string
+client.get_summoner_by_name 'pacoloco'
+
+# Get summoner by id
+# params : id => integer
+client.get_summoner_by_id 20639710
+
+# CHAMPION
+
+# Get champion by id
+# params : 
+# id => integer, 
+# data => hash (version, champData) - default => nill, 
+# locale => string ('fr_FR','en_EN', ...) - default => 'fr_FR'
+client.get_champion_by_id id_champ, data = {:version => num_version, :champData => 'all'}, locale = 'fr_FR'
+
+# Get all champions
+# params :
+# data => hash (version, champData) - default => nill, 
+# sort_id => boolean - default => false
+# locale => string ('fr_FR','en_EN', ...) - default => 'fr_FR'
+client.get_all_champions data = {:version => num_version, :champData => 'all'}, sort_id = 'false', locale = 'fr_FR'
+
+# ITEM
+
+# Get item by id
+# params :
+# id => integer, 
+# data => hash (version, itemListData) - default => nill,
+# locale => string ('fr_FR','en_EN', ...) - default => 'fr_FR'
+client.get_item_by_id id, data = {:version => num_version, :itemListData => 'all'}, locale = 'fr_FR'
+
+# Get all items
+# params :
+# data => hash (version, itemListData) - default => nill, 
+# locale => string ('fr_FR','en_EN', ...) - default => 'fr_FR'
+client.get_all_items data = {:version => num_version, :itemListData => 'all'}, locale = 'fr_FR'
+
+# MASTERY
+
+# Get masteries by id
+# params :
+# id => integer, 
+# data => hash (version, masteryListData) - default => nill, 
+# locale => string ('fr_FR','en_EN', ...) - default => 'fr_FR'
+client.get_mastery_by_id id, data = {:version => num_version, :masteryListData => 'all'}, locale = 'fr_FR'
+
+# Get all masteries
+# params :
+# data => hash (version, masteryListData) - default => nill, 
+# locale => string ('fr_FR','en_EN', ...) - default => 'fr_FR'
+client.get_all_masteries data = {:version => num_version, :masteryListData => 'all'}, locale = 'fr_FR'
+
+# RUNE
+
+# Get rune by id
+# params :
+# id => integer, 
+# data => hash (version, runeListData) - default => nill, 
+# locale => string ('fr_FR','en_EN', ...) - default => 'fr_FR'
+client.get_rune_by_id id, data = {:version => num_version, :runeListData => 'all'}, locale = 'fr_FR'
+
+# Get all rune
+# params : 
+# data => hash (version, runeListData) - default => nill, 
+# locale => string ('fr_FR','en_EN', ...) - default => 'fr_FR'
+client.get_all_runes data = {:version => num_version, :runeListData => 'all'}, locale = 'fr_FR'
+
+# SUMMONER SPELL
+
+# Get summoner spell by id
+# params :
+# id => integer, 
+# data => hash (version, spellData) - default => nill, 
+# locale => string ('fr_FR','en_EN', ...) - default => 'fr_FR'
+client.get_summoner_spell_by_id id, data = {:version => num_version, :spellData => 'all'}, locale = 'fr_FR'
+
+# Get all summoner spell
+# params : 
+# data => hash (version, spellData) - default => nill, 
+# sort_id => boolean - default => false
+# locale => string ('fr_FR','en_EN', ...) - default => 'fr_FR'
+client.get_all_summoner_spells data = {:version => num_version, :spellData => 'all'}, sort_id = 'false', locale = 'fr_FR'
+
+# INFORMATION
+
+# Get version
+client.get_versions
+
+# SUMMONER
+
+# Create summoner object
+summoner = client.get_summoner_by_name 'pacoloco'
+
+# Get sumoner masteries
+summoner.masteries
+
+# Get sumoner runes
+summoner.runes
+
+# Get sumoner games
+summoner.games
+
+# Get sumoner stat_summaries
+summoner.stat_summaries
+
+# Get sumoner get_league_stats
+summoner.get_league_stats
 
-TODO: Write usage instructions here
+```
 
 ## Contributing
 

data/lib/riot_lol_api/client.rb

@@ -3,6 +3,9 @@ require 'json'
 
 module RiotLolApi
 	class Client
+		# Constant URL
+
+		BASE_URL_API = "api.pvp.net/api/lol/"
 
 		# attr
 		# - region
@@ -11,25 +14,50 @@ module RiotLolApi
 				self.class.send(:attr_accessor, key.to_sym)
 				instance_variable_set("@#{key}", value)
 			end
+			if RiotLolApi::Client.realm.nil? && !self.region.nil?
+				self.get_realm
+			end
+		end
+
+		class << self
+			attr_accessor :realm
 		end
 
-		def self.get url, data = nil
+		def get_realm
+			response = Client.get("static-data/#{self.region}/v1.2/realm", "global")
+			unless response.nil?
+				self.class.realm = response
+			else
+				nil
+			end
+		end
+
+		# TO DO
+		# Set callback to get realm constants
+		# 
+
+		def self.get url, domaine,data = nil
 			unless RiotLolApi::TOKEN.nil?
+				# Set data params
 				if data.nil?
 					data = {:api_key => RiotLolApi::TOKEN}
 				else
 					data.merge!({:api_key => RiotLolApi::TOKEN})
 				end
-				response = HTTParty.get(url, :query => data)
+
+				# Set domaine url
+				domaine_url = "#{domaine}.#{BASE_URL_API}"
+
+				response = HTTParty.get("https://#{domaine_url}#{url}", :query => data)
 				case response.code
-				  when 200
-				    JSON.parse(response.body)
-				  when 404
-				    puts "Error server"
-				    nil
-				  when 500...600
-				    puts "ERROR #{response.code}"
-				    nil
+					when 200
+						JSON.parse(response.body)
+					when 404
+						puts "Error server"
+						nil
+					when 500...600
+						puts "ERROR #{response.code}"
+						nil
 				end
 			else
 				puts "No TOKEN, you have to define RiotLolApi::TOKEN"
@@ -42,7 +70,7 @@ module RiotLolApi
 		def get_summoner_by_name name
 			name = name.downcase
 			name.strip!
-			response = Client.get("https://prod.api.pvp.net/api/lol/#{@region}/v1.4/summoner/by-name/#{name}")
+			response = Client.get("#{@region}/v1.4/summoner/by-name/#{name}",@region)
 			unless response.nil?
 				RiotLolApi::Model::Summoner.new(response[name].to_symbol.merge({:region => @region}))
 			else
@@ -51,7 +79,7 @@ module RiotLolApi
 		end
 
 		def get_summoner_by_id id
-			response = Client.get("https://prod.api.pvp.net/api/lol/#{@region}/v1.4/summoner/#{id}")
+			response = Client.get("#{@region}/v1.4/summoner/#{id}",@region)
 			unless response.nil?
 				RiotLolApi::Model::Summoner.new(response[id.to_s].to_symbol.merge({:region => @region}))
 			else
@@ -61,20 +89,192 @@ module RiotLolApi
 
 		# CHAMPION
 
-		def get_champion_by_id id, data = nil, local = 'fr_FR'
+		def get_champion_by_id id, data = nil, locale = 'fr_FR'
 			if data.nil?
-				data = {:local => local}
+				data = {:locale => locale}
 			else
-				data.merge!({:local => local})
+				data.merge!({:locale => locale})
 			end
 			
-	        response = Client.get("https://prod.api.pvp.net/api/lol/static-data/#{@region}/v1.2/champion/#{id}",data)
-	        unless response.nil?
+			response = Client.get("static-data/#{@region}/v1.2/champion/#{id}","global",data)
+			unless response.nil?
 				RiotLolApi::Model::Champion.new(response.to_symbol)
-	        else
+			else
+				nil
+			end
+		end
+
+		def get_all_champions data = nil, sort_id = 'false', locale = 'fr_FR'
+			if data.nil?
+				data = {:locale => locale, :dataById => sort_id}
+			else
+				data.merge!({:locale => locale, :dataById => sort_id})
+			end
+
+			response = Client.get("static-data/#{@region}/v1.2/champion","global",data)
+			unless response.nil?
+				tab_champions = Array.new
+				response["data"].each do |champion|
+					tab_champions << RiotLolApi::Model::Champion.new(champion[1].to_symbol)
+				end
+				tab_champions
+			else
+				nil
+			end
+		end
+
+		# ITEM
+		
+		def get_all_items data = nil, locale = 'fr_FR'
+			if data.nil?
+				data = {:locale => locale}
+			else
+				data.merge!({:locale => locale})
+			end
+
+			response = Client.get("static-data/#{@region}/v1.2/item","global",data)
+			unless response.nil?
+				tab_items = Array.new
+				response["data"].each do |item|
+					tab_items << RiotLolApi::Model::Item.new(item[1].to_symbol)
+				end
+				tab_items
+			else
+				nil
+			end
+		end
+
+		def get_item_by_id id, data = nil, locale = 'fr_FR'
+			if data.nil?
+				data = {:locale => locale}
+			else
+				data.merge!({:locale => locale})
+			end
+
+			response = Client.get("static-data/#{@region}/v1.2/item/#{id}","global",data)
+			unless response.nil?
+				RiotLolApi::Model::Item.new(response.to_symbol)
+			else
 				nil
-	        end
-	    end
+			end
+		end
+
+		# MASTERY
+		
+		def get_all_masteries data = nil, locale = 'fr_FR'
+			if data.nil?
+				data = {:locale => locale}
+			else
+				data.merge!({:locale => locale})
+			end
+
+			response = Client.get("static-data/#{@region}/v1.2/mastery","global",data)
+			unless response.nil?
+				tab_masteries = Array.new
+				response["data"].each do |mastery|
+					tab_masteries << RiotLolApi::Model::Mastery.new(mastery[1].to_symbol)
+				end
+				tab_masteries
+			else
+				nil
+			end
+		end
+
+		def get_mastery_by_id id, data = nil, locale = 'fr_FR'
+			if data.nil?
+				data = {:locale => locale}
+			else
+				data.merge!({:locale => locale})
+			end
+
+			response = Client.get("static-data/#{@region}/v1.2/mastery/#{id}","global",data)
+			unless response.nil?
+				RiotLolApi::Model::Mastery.new(response.to_symbol)
+			else
+				nil
+			end
+		end
+
+		# RUNE
+		
+		def get_all_runes data = nil, locale = 'fr_FR'
+			if data.nil?
+				data = {:locale => locale}
+			else
+				data.merge!({:locale => locale})
+			end
+
+			response = Client.get("static-data/#{@region}/v1.2/rune","global",data)
+			unless response.nil?
+				tab_runes = Array.new
+				response["data"].each do |rune|
+					tab_runes << RiotLolApi::Model::Rune.new(rune[1].to_symbol)
+				end
+				tab_runes
+			else
+				nil
+			end
+		end
+
+		def get_rune_by_id id, data = nil, locale = 'fr_FR'
+			if data.nil?
+				data = {:locale => locale}
+			else
+				data.merge!({:locale => locale})
+			end
+
+			response = Client.get("static-data/#{@region}/v1.2/rune/#{id}","global",data)
+			unless response.nil?
+				RiotLolApi::Model::Rune.new(response.to_symbol)
+			else
+				nil
+			end
+		end
+
+		# SUMMONER SPELL
+
+		def get_all_summoner_spells data = nil, sort_id = 'false', locale = 'fr_FR'
+			if data.nil?
+				data = {:locale => locale, :dataById => sort_id}
+			else
+				data.merge!({:locale => locale, :dataById => sort_id})
+			end
+
+			response = Client.get("static-data/#{@region}/v1.2/summoner-spell","global",data)
+			unless response.nil?
+				tab_summoner_spells = Array.new
+				response["data"].each do |summoner_spell|
+					tab_summoner_spells << RiotLolApi::Model::Spell.new(summoner_spell[1].to_symbol)
+				end
+				tab_summoner_spells
+			else
+				nil
+			end
+		end
+
+		def get_summoner_spell_by_id id, data = nil, locale = 'fr_FR'
+			if data.nil?
+				data = {:locale => locale}
+			else
+				data.merge!({:locale => locale})
+			end
+
+			response = Client.get("static-data/#{@region}/v1.2/summoner-spell/#{id}","global",data)
+			unless response.nil?
+				RiotLolApi::Model::Spell.new(response.to_symbol)
+			else
+				nil
+			end
+		end
+
+		def get_versions
+			response = Client.get("static-data/#{@region}/v1.2/versions","global")
+			unless response.nil?
+				response
+			else
+				nil
+			end
+		end
 
 	end
 end