riot_games_api 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a0582a84f782a7eed7d62f680ddad53403349cb9
+  data.tar.gz: 6954173fa2a5208e9f34105bb0e401436558c7bb
+SHA512:
+  metadata.gz: e2e2540150fda6f49efb18c30a482ed1fc7ea2392c5352efc29ae5137c4532c82bb3f770f8c2a98bd0125abf2ba9576ca9db24faf1a84723946ad69afad74ef1
+  data.tar.gz: 96653cf8820ea6df8b514c39fa77088130a89b59df405ca1752f3790a31c1b32e0ded6671a7041e39463e2f0c85896c0fe92171fadf65088f527a04befb35d85

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+.pryrc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rubocop.yml

@@ -0,0 +1,28 @@
+AllCops:
+  Include:
+    - Rakefile
+    - Gemfile
+    - config.ru
+  Exclude:
+    - bin/*
+    - db/schema.rb
+    - db/migrate/*
+  RunRailsCops: true
+
+Documentation:
+  Enabled: false
+
+LineLength:
+  Max: 160
+
+MethodLength:
+  Max: 15
+
+ClassAndModuleChildren:
+  Enabled: false
+
+CollectionMethods:
+  Enabled: false
+
+SingleLineBlockParams:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+script: 'bundle exec rake spec'
+rvm:
+  - 2.1.0
+  - 1.9.3
+  - jruby-19mode
+env:
+  - RIOT_GAMES_API_KEY="test_key" SPEC_OPTS="--color --format documentation" CODECLIMATE_REPO_TOKEN="81eb5c871ceafdf53bb05f2311220c146d7ffdb7d0e1854583902ed979fc8620"

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in riot_games_api.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Shigenobu Nishikawa
+
+MIT License
+
+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,192 @@
+[![Build Status](https://drone.io/github.com/shishi/riot_games_api/status.png)](https://drone.io/github.com/shishi/riot_games_api/latest)
+[![Build Status](https://travis-ci.org/shishi/riot_games_api.svg?branch=master)](https://travis-ci.org/shishi/riot_games_api)
+[![Code Climate](https://codeclimate.com/github/shishi/riot_games_api.png)](https://codeclimate.com/github/shishi/riot_games_api) [![Code Climate](https://codeclimate.com/github/shishi/riot_games_api/coverage.png
+)](https://codeclimate.com/github/shishi/riot_games_api)
+[![Dependency Status](https://gemnasium.com/shishi/riot_games_api.svg)](https://gemnasium.com/shishi/riot_games_api)
+
+# RiotGamesApi
+
+Make access easy to access Riot Games API to get their game data like League of Legends.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'riot_games_api'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install riot_games_api
+
+## Usage
+
+**First, You should love to play, watch, or do something with League of Legends.**
+
+Very thanks to Riot for greatest game.
+
+* English
+  * You need to get your RIOT Games API key. You may need to register your app. Defaul key for development is too restricted to use.
+
+* Japanese
+  * RIOT Games API キーを取得してきて下さい。アプリケーションを登録してキーをもらったほうが良いかもしれません。デフォルトの開発用キーは普通に使うには制限が強すぎます。
+
+https://developer.riotgames.com/
+
+``` ruby
+  
+client = RiotGamesApi::LOL::Client.new api_key: 'your_api_key'
+# from summoner resource
+summoner = client.summoner.by_name 'shishisn'
+# from team resource
+teams = client.team.by_summoner_id summoner.id
+
+# English
+# You can use champions and items id list (created 4/20/2014)
+# You can see and edit lists in lib/riot_games_api/lol/constant/
+
+# Japnese
+# チャンピオンとアイテムのIDのリストを作ってあります (2014/4/20 時点)
+# lib/riot_games_api/lol/constant/ にファイルがあるので編集もできます
+
+# from static_data resource
+jinx = client.static_data.champion_by_id RiotGamesApi::LOL::CHAMPIONS[:jinx]
+jinx_lore = jinx.lore
+b_f_sword = client.static_data.item_by_id RiotGamesApi::LOL::ITEMS[:b_f_sword]
+b_f_sword_stats = b_f_sword.stats
+
+# English
+# Now, Riot Games API do not support image file directly, but you can get url for images their official data. Almost same for items, etc.
+
+# Japanese
+# 現在 Riot Games API は画像を直接サポートしていませんが、こうするとCDNの公式データを取得するURLを組み立てることが出来ます。アイテムとかでも大体同じようにできます。
+
+xin = client.static_data.champion_by_id RiotGamesApi::LOL::CHAMPIONS[:xin_zhao]
+xin_image_filename = xin.image.full
+image_group = xin.image.group
+
+realm = client.static_data.realm
+url = realm.cdn
+dd_version = realm.dd
+
+image_url = url + dd_version + '/img/' + image_group + xin_image_filename
+  
+```
+
+### Public method list
+
+You may need to inspect return object to know what they have. 
+
+返されるオブジェクトをインスペクトすると、どんなデータを持ってるのか分かりやすいです。
+
+```
+There are some more options, you found in lib/riot_games_api/lol/resource 
+
+RiotGamesApi::LOL::Resource::Champion
+  This resource for champion's status like active, free, enable or not in ranked
+
+  #all
+    return all champions
+  #free
+    return free champions
+  #by_champion_id
+    return a specified champion by champion id
+
+RiotGamesApi::LOL::Resource::Game
+This resource for recent game records
+
+  #recent
+    return recent 10 game records by summoner id
+
+RiotGamesApi::LOL::Resource::League
+  This resource for league of legends league system records
+
+  #by_summoner_id
+    return league data include entries by summoner id
+  #by_summoner_id_only_own_entry
+    return entry league data by summoner id
+  #by_team_id
+    return league data include entries by team id
+  #by_team_id_only_own_entry
+    return entry league data by team id
+  #challenger_solo_5v5
+    return league data include entries in challenger solo 5v5
+  #challenger_team_5v5
+    return league data include entries in challenger team 5v5
+  #challenger_team_3v3
+    return league data include entries in challenger team 3v3
+
+RiotGamesApi::LOL::Resource::StaticData
+  This resource for static data like champion' status, skill data
+
+  champion
+    #champion_all
+      return all champion static data (very heavy)
+    #champion_by_id
+      return a specified champion static data by champion id
+  item
+    #item_all
+      return all item static data
+    #item_by_id
+      return a specified item static data by item id
+  mastery
+    #mastery_all
+      return all mastery static data
+    #mastery_by_id
+      return a specified mastery static data by mastery id
+  #realm
+    return realm data
+  rune
+    #rune_all
+      return all rune static data
+    #rune_by_id
+      return a specified rune static data by rune id
+  summoner_spell
+    #summoner_spell_all
+      return all summoner spell static data
+    #summoner_spell_by_id
+      return a specified summoner spell static data by summoner spell id
+
+RiotGamesApi::LOL::Resource::Stats
+  This resource for statistics of league of legends matches
+
+  #ranked
+    return statistics of ranekd match by summoner id
+  #summary
+    return statistics of matches by summoner id
+
+RiotGamesApi::LOL::Resource::Summoner
+  This resource for summoner data
+
+  #by_name
+    return a summoner data by summoner name
+  #by_id
+    return a summoner data by summoner id
+  #masteries
+    return summoner masteries data by summoner id
+  #name
+    retuen summoner name by summoner id
+  #runes
+    return summoner runes data by summoner id
+
+RiotGamesApi::LOL::Resource::Team
+  This resource for ranked team data
+
+  #by_summoner_id
+    return team data by summoner id
+  #by_team_id
+    retuen team data by team id
+
+```
+
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/riot_games_api/fork )
+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

data/Rakefile

@@ -0,0 +1,5 @@
+require "bundler/gem_tasks"
+
+require 'rspec/core/rake_task'
+task :default => :spec
+RSpec::Core::RakeTask.new

data/lib/riot_games_api/lol/client.rb

@@ -0,0 +1,57 @@
+module RiotGamesApi
+  module LOL
+    class Client
+      def initialize(params = {})
+        @api_key = params[:api_key] || ENV['RIOT_GAMES_API_KEY']
+        @base_url = params[:use_ssl] ? 'https://prod.api.pvp.net/' : 'http://prod.api.pvp.net/'
+        @region = params[:region] || 'na'
+        @adapter = params[:adapter] || Faraday.default_adapter
+        @logger = params[:debug] ? :logger : :raise_error
+        @locale = params[:locale] || 'en_US'
+
+        fail ArgumentError, 'You should need "Riot Games API Key" at leaet.' unless @api_key
+      end
+
+      def connection
+        Faraday.new(url: @base_url) do |faraday|
+          faraday.request :url_encoded
+          faraday.response :rashify
+          faraday.response :json
+          faraday.response @logger
+          faraday.adapter @adapter
+          faraday.params[:api_key] = @api_key
+          faraday.params[:locale] = @locale
+          faraday.headers['User-Agent'] = "RiotGamesApi gem v#{RiotGamesApi::VERSION}"
+        end
+      end
+
+      def champions
+        RiotGamesApi::LOL::Resource::Champion.new(connection, @region)
+      end
+
+      def games
+        RiotGamesApi::LOL::Resource::Game.new(connection, @region)
+      end
+
+      def leagues
+        RiotGamesApi::LOL::Resource::League.new(connection, @region)
+      end
+
+      def static_data
+        RiotGamesApi::LOL::Resource::StaticData.new(connection, @region)
+      end
+
+      def stats
+        RiotGamesApi::LOL::Resource::Stats.new(connection, @region)
+      end
+
+      def summoner
+        RiotGamesApi::LOL::Resource::Summoner.new(connection, @region)
+      end
+
+      def team
+        RiotGamesApi::LOL::Resource::Team.new(connection, @region)
+      end
+    end
+  end
+end

data/lib/riot_games_api/lol/constant/champions.rb

@@ -0,0 +1,125 @@
+module RiotGamesApi
+  module LOL
+    CHAMPIONS = {
+                 aatrox: 266,
+                 ahri: 103,
+                 akali: 84,
+                 alistar: 12,
+                 amumu: 32,
+                 anivia: 34,
+                 annie: 1,
+                 ashe: 22,
+                 blitzcrank: 53,
+                 brand: 63,
+                 caitlyn: 51,
+                 cassiopeia: 69,
+                 chogath: 31,
+                 corki: 42,
+                 darius: 122,
+                 diana: 131,
+                 dr_mundo: 36,
+                 draven: 119,
+                 elise: 60,
+                 evelynn: 28,
+                 ezreal: 81,
+                 fiddle_sticks: 9,
+                 fiora: 114,
+                 fizz: 105,
+                 galio: 3,
+                 gangplank: 41,
+                 garen: 86,
+                 gragas: 79,
+                 graves: 104,
+                 hecarim: 120,
+                 heimerdinger: 74,
+                 irelia: 39,
+                 janna: 40,
+                 jarvan_iv: 59,
+                 jax: 24,
+                 jayce: 126,
+                 jinx: 222,
+                 karma: 43,
+                 karthus: 30,
+                 kassadin: 38,
+                 katarina: 55,
+                 kayle: 10,
+                 kennen: 85,
+                 khazix: 121,
+                 kog_maw: 96,
+                 leblanc: 7,
+                 lee_sin: 64,
+                 leona: 89,
+                 lissandra: 127,
+                 lucian: 236,
+                 lulu: 117,
+                 lux: 99,
+                 malphite: 54,
+                 malzahar: 90,
+                 maokai: 57,
+                 master_yi: 11,
+                 miss_fortune: 21,
+                 monkey_king: 62, # wukong, riot use this name for wukong
+                 mordekaiser: 82,
+                 morgana: 25,
+                 nami: 267,
+                 nasus: 75,
+                 nautilus: 111,
+                 nidalee: 76,
+                 nocturne: 56,
+                 nunu: 20,
+                 olaf: 2,
+                 orianna: 61,
+                 pantheon: 80,
+                 poppy: 78,
+                 quinn: 133,
+                 rammus: 33,
+                 renekton: 58,
+                 rengar: 107,
+                 riven: 92,
+                 rumble: 68,
+                 ryze: 13,
+                 sejuani: 113,
+                 shaco: 35,
+                 shen: 98,
+                 shyvana: 102,
+                 singed: 27,
+                 sion: 14,
+                 sivir: 15,
+                 skarner: 72,
+                 sona: 37,
+                 soraka: 16,
+                 swain: 50,
+                 syndra: 134,
+                 talon: 91,
+                 taric: 44,
+                 teemo: 17,
+                 thresh: 412,
+                 tristana: 18,
+                 trundle: 48,
+                 tryndamere: 23,
+                 twisted_fate: 4,
+                 twitch: 29,
+                 udyr: 77,
+                 urgot: 6,
+                 varus: 110,
+                 vayne: 67,
+                 veigar: 45,
+                 velkoz: 161,
+                 vi: 254,
+                 viktor: 112,
+                 vladimir: 8,
+                 volibear: 106,
+                 warwick: 19,
+                 wukong: 62, # alias for monkey_king
+                 xerath: 101,
+                 xin_zhao: 5,
+                 yasuo: 157,
+                 yorick: 83,
+                 zac: 154,
+                 zed: 238,
+                 ziggs: 115,
+                 zilean: 26,
+                 zyra: 143,
+                }
+  end
+end

data/lib/riot_games_api/lol/constant/items.rb

@@ -0,0 +1,186 @@
+module RiotGamesApi
+  module LOL
+    ITEMS = {
+             abyssal_scepter: 3001,
+             aegis_of_the_legion: 3105,
+             aether_wisp: 3113,
+             amplifying_tome: 1052,
+             ancient_coin: 3301,
+             archangels_staff: 3003,
+             archangels_staff_crystal_scar: 3007,
+             athenes_unholy_grail: 3174,
+             atmas_impaler: 3005,
+             augment_death: 3198,
+             augment_gravity: 3197,
+             augment_power: 3196,
+             avarice_blade: 3093,
+             b_f_sword: 1038,
+             banner_of_command: 3060,
+             banshees_veil: 3102,
+             berserkers_greaves: 3006,
+             bilgewater_cutlass: 3144,
+             blackfire_torch: 3188,
+             blade_of_the_ruined_king: 3153,
+             blasting_wand: 1026,
+             bonetooth_necklace: 3167,
+             boots_of_mobility: 3117,
+             boots_of_speed: 1001,
+             boots_of_swiftness: 3009,
+             brawlers_gloves: 1051,
+             catalyst_the_protector: 3010,
+             chain_vest: 1031,
+             chalice_of_harmony: 3028,
+             cloak_of_agility: 1018,
+             cloth_armor: 1029,
+             crystalline_flask: 2041,
+             dagger: 1042,
+             deathfire_grasp: 3128,
+             dervish_blade: 3137,
+             dorans_blade: 1055,
+             dorans_ring: 1056,
+             dorans_shield: 1054,
+             elixir_of_brilliance: 2039,
+             elixir_of_fortitude: 2037,
+             enchantment_alacrity: 3269,
+             enchantment_captain: 3271,
+             enchantment_distortion: 3268,
+             enchantment_furor: 3267,
+             enchantment_homeguard: 3270,
+             entropy: 3184,
+             executioners_calling: 3123,
+             explorers_ward: 2050,
+             face_of_the_mountain: 3401,
+             faerie_charm: 1004,
+             farsight_orb: 3363,
+             feral_flare: 3160,
+             fiendish_codex: 3108,
+             forbidden_idol: 3114,
+             frost_queens_claim: 3092,
+             frostfang: 3098,
+             frozen_heart: 3110,
+             frozen_mallet: 3022,
+             giants_belt: 1011,
+             glacial_shroud: 3024,
+             greater_stealth_totem: 3361,
+             greater_vision_totem: 3362,
+             grezs_spectral_lantern: 3159,
+             guardians_horn: 2051,
+             guardian_angel: 3026,
+             guinsoos_rageblade: 3124,
+             haunting_guise: 3136,
+             health_potion: 2003,
+             hexdrinker: 3155,
+             hextech_gunblade: 3146,
+             hextech_revolver: 3145,
+             hextech_sweeper: 3187,
+             hunters_machete: 1039,
+             iceborn_gauntlet: 3025,
+             ichor_of_illumination: 2048,
+             ichor_of_rage: 2040,
+             infinity_edge: 3031,
+             ionian_boots_of_lucidity: 3158,
+             kindlegem: 3067,
+             last_whisper: 3035,
+             liandrys_torment: 3151,
+             lich_bane: 3100,
+             locket_of_the_iron_solari: 3190,
+             long_sword: 1036,
+             lord_van_damms_pillager: 3104,
+             madreds_razors: 3106,
+             mana_potion: 2004,
+             manamune: 3004,
+             manamune_crystal_scar: 3008,
+             maw_of_malmortius: 3156,
+             mejais_soulstealer: 3041,
+             mercurial_scimitar: 3139,
+             mercurys_treads: 3111,
+             mikaels_crucible: 3222,
+             moonflair_spellblade: 3170,
+             morellonomicon: 3165,
+             muramana: 3043,
+             nashors_tooth: 3115,
+             needlessly_large_rod: 1058,
+             negatron_cloak: 1057,
+             ninja_tabi: 3047,
+             nomads_medallion: 3096,
+             null_magic_mantle: 1033,
+             odyns_veil: 3180,
+             ohmwrecker: 3056,
+             oracles_extract: 2047,
+             oracles_lens: 3364,
+             orb_of_winter: 3112,
+             overlords_bloodmail: 3084,
+             phage: 3044,
+             phantom_dancer: 3046,
+             pickaxe: 1037,
+             poro_snax: 2052,
+             prospectors_blade: 1062,
+             prospectors_ring: 1063,
+             quicksilver_sash: 3140,
+             rabadons_deathcap: 3089,
+             randuins_omen: 3143,
+             ravenous_hydra: 3074,
+             recurve_bow: 1043,
+             rejuvenation_bead: 1006,
+             relic_shield: 3302,
+             rod_of_ages: 3027,
+             rod_of_ages_crystal_scar: 3029,
+             ruby_crystal: 1028,
+             ruby_sightstone: 2045,
+             runaans_hurricane: 3085,
+             rylais_crystal_scepter: 3116,
+             sanguine_blade: 3181,
+             sapphire_crystal: 1027,
+             scrying_orb: 3342,
+             seekers_armguard: 3191,
+             seraphs_embrace: 3040,
+             sheen: 3057,
+             sightstone: 2049,
+             sorcerers_shoes: 3020,
+             spectres_cowl: 3211,
+             spellthiefs_edge: 3303,
+             spirit_of_the_ancient_golem: 3207,
+             spirit_of_the_elder_lizard: 3209,
+             spirit_of_the_spectral_wraith: 3206,
+             spirit_stone: 1080,
+             spirit_visage: 3065,
+             statikk_shiv: 3087,
+             stealth_ward: 2044,
+             stinger: 3101,
+             sunfire_cape: 3068,
+             sweeping_lens: 3341,
+             sword_of_the_divine: 3131,
+             sword_of_the_occult: 3141,
+             talisman_of_ascension: 3069,
+             targons_brace: 3097,
+             tear_of_the_goddess: 3070,
+             tear_of_the_goddess_crystal_scar: 3073,
+             the_black_cleaver: 3071,
+             the_bloodthirster: 3072,
+             the_brutalizer: 3134,
+             the_hex_core: 3200,
+             the_lightbringer: 3185,
+             thornmail: 3075,
+             tiamat: 3077,
+             total_biscuit_of_rejuvenation: 2010,
+             trinity_force: 3078,
+             twin_shadows: 3023,
+             vampiric_scepter: 1053,
+             vision_ward: 2043,
+             void_staff: 3135,
+             wardens_mail: 3082,
+             warding_totem: 3340,
+             warmogs_armor: 3083,
+             wicked_hatchet: 3122,
+             will_of_the_ancients: 3152,
+             wits_end: 3091,
+             wooglets_witchcap: 3090,
+             wriggles_lantern: 3154,
+             youmuus_ghostblade: 3142,
+             zeal: 3086,
+             zekes_herald: 3050,
+             zephyr: 3172,
+             zhonyas_hourglass: 3157
+            }
+  end
+end

data/lib/riot_games_api/lol/model/champion/champion.rb

@@ -0,0 +1,18 @@
+module RiotGamesApi
+  module LOL
+    module Model
+      module Champion
+        class Champion
+          include Virtus.model
+
+          attribute :id, Integer
+          attribute :active, Boolean
+          attribute :bot_enabled, Boolean
+          attribute :free_to_play, Boolean
+          attribute :bot_mm_enabled, Boolean
+          attribute :ranked_play_enabled, Boolean
+        end
+      end
+    end
+  end
+end

data/lib/riot_games_api/lol/model/champion.rb

@@ -0,0 +1,10 @@
+require 'riot_games_api/lol/model/champion/champion'
+
+module RiotGamesApi
+  module LOL
+    module Model
+      module Champion
+      end
+    end
+  end
+end