ruby-lol 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b867ffb05c47098f45beea30f1e091db52ac4fce
+  data.tar.gz: fa6668a7f1777938f9487bbdbc6b2cebbb57645f
+SHA512:
+  metadata.gz: 560e480835130b3e3a50f58e996d5e1aba42b908786d830671b2959dfc038185a6249d8092fb212213ec915d9bbfcdfba2fb0f4a253fe8b06701da8010055e86
+  data.tar.gz: a063f0f21d6ed47c5e9d64144b424b17cbe0ce29034c4cf399da46e8bd341bd670ba98b4080e624a158782e8846aac80aadc5b9fb2485ab50e6748ae95e9dc30

data/.autotest

@@ -0,0 +1,2 @@
+require 'autotest/fsevent'
+require 'autotest/growl'

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,4 @@
+rvm: 2.0.0
+addons:
+    code_climate:
+        repo_token: c98576197ae22bdd3bede9cd3cdfdad33fac26bfdddb1e5f2bbc4fb535812185

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Giovanni Intini
+
+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,45 @@
+# ruby-lol
+[![Coverage Status](https://coveralls.io/repos/mikamai/ruby-lol/badge.png)](https://coveralls.io/r/mikamai/ruby-lol) [![Build Status](https://travis-ci.org/mikamai/ruby-lol.png?branch=master)](https://travis-ci.org/mikamai/ruby-lol) [![Code Climate](https://codeclimate.com/repos/52a9908c56b102320a0166a4/badges/7e5d4ea4fe9e562f8e4d/gpa.png)](https://codeclimate.com/repos/52a9908c56b102320a0166a4/feed)
+
+ruby-lol is a wrapper to the [Riot Games API](https://developer.riotgames.com).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'ruby-lol'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ruby-lol
+
+## Usage
+
+    require 'lol'
+
+    # defaults to euw
+    client = Lol::Client.new "my_api_key"
+    #<Lol::Client:0x007fd09d1abb00 @api_key="my_api_key", @region="euw">
+
+    # na
+    na_client = Lol::Client.new "my_api_key", :region => "na"
+    # => <Lol::Client:0x007fd09d1abb00 @api_key="my_api_key", @region="na">
+
+    # gets all champions
+    champions = client.champion
+    # => Array of Lol::Champion
+
+    # let's play a bit, who is free to play?
+    client.champion.select {|c| c.free_to_play }.map {|c| c.name}
+    # => %w(Aatrox Cassiopeia Lux Malphite MissFortune MonkeyKing Nautilus Sivir Talon Taric)
+## 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

data/Rakefile

@@ -0,0 +1,12 @@
+require "bundler/setup"
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+desc "Open an irb session preloaded with this library"
+task :console do
+  sh "irb -rubygems -I . -r lib/lol.rb"
+end

data/lib/lol.rb

@@ -0,0 +1,6 @@
+require __dir__ + "/lol/client"
+require __dir__ + "/lol/champion"
+require __dir__ + "/lol/game"
+require __dir__ + "/lol/league"
+require __dir__ + "/lol/player"
+require __dir__ + "/lol/statistic"

data/lib/lol/champion.rb

@@ -0,0 +1,64 @@
+require 'lol/model'
+
+module Lol
+  class Champion < Lol::Model
+    # @!attribute [r] raw
+    #   @return [String] raw version of options Hash used to initialize Champion
+    attr_reader :raw
+
+    # @!attribute [r] id
+    #   @return [Fixnum] id of Champion
+    attr_reader :id
+
+    # @!attribute [r] name
+    #   @return [String] name of Champion
+    attr_reader :name
+
+    # @!attribute [r] active
+    #   @return [true] if the Champion is active
+    #   @return [false] if the Champion is disabled
+    attr_reader :active
+
+    # @!attribute [r] attack_rank
+    #   @return [Fixnum] attack rank of Champion
+    attr_reader :attack_rank
+
+    # @!attribute [r] defense_rank
+    #   @return [Fixnum] defense rank of Champion
+    attr_reader :defense_rank
+
+    # @!attribute [r] magic_rank
+    #   @return [Fixnum] magic rank of Champion
+    attr_reader :magic_rank
+
+    # @!attribute [r] difficulty_rank
+    #   @return [Fixnum] difficulty rank of Champion
+    attr_reader :difficulty_rank
+
+    # @!attribute [r] bot_enabled
+    #   @return [true] if the Champion is enabled in custom bot games
+    #   @return [false] if the Champion is disabled in custom bot games
+    attr_reader :bot_enabled
+
+    # @!attribute [r] free_to_play
+    #   @return [true] if the Champion is currently free to play
+    #   @return [false] if the Champion isn't currently free to play
+    attr_reader :free_to_play
+
+    # @!attribute [r] bot_mm_enabled
+    #   @return [true] if the Champion is enabled in match made bot games
+    #   @return [false] if the Champion is disabled in match made bot games
+    attr_reader :bot_mm_enabled
+
+    # @!attribute [r] ranked_play_enabled
+    #   @return [true] if the Champion is enabled in ranked play
+    #   @return [false] if the Champion is disabled in ranked play
+    attr_reader :ranked_play_enabled
+
+    private
+
+    attr_writer :id, :name, :active, :attack_rank, :defense_rank, :magic_rank,
+                :difficulty_rank, :bot_enabled, :free_to_play, :bot_mm_enabled,
+                :ranked_play_enabled
+  end
+end

data/lib/lol/client.rb

@@ -0,0 +1,87 @@
+require 'httparty'
+
+module Lol
+  class InvalidAPIResponse < StandardError; end
+
+  class Client
+    include HTTParty
+
+    # @!attribute [rw] region
+    #   @return [String] name of region
+    attr_accessor :region
+
+    # @!attribute [r] api_key
+    #   @return [String] the API key that has been used
+    attr_reader :api_key
+
+    # Returns a full url for an API call
+    # @param version [String] API version to call
+    # @param path [String] API path to call
+    # @return [String] full fledged url
+    def api_url version, path
+      lol = version == "v1.1" ? "lol" : ""
+      File.join "http://prod.api.pvp.net/api/", lol, "/#{region}/#{version}/", "#{path}?api_key=#{api_key}"
+    end
+
+    # Calls the API via HTTParty and handles errors
+    #
+    def get url
+      response = self.class.get(url)
+      if response["status"]
+        raise InvalidAPIResponse.new(response["status"]["message"])
+      else
+        response
+      end
+    end
+
+    # Calls the latest API version of champion
+    def champion
+      champion11
+    end
+
+    # Retrieve all champions, v1.1
+    # @return [Array] an array of champions
+    def champion11
+      get(api_url("v1.1", "champion"))["champions"].map {|c| Champion.new(c)}
+    end
+
+    # Calls the latest API version of game returning the list of
+    # recent games played by a summoner
+    def game *args
+      game11 *args
+    end
+
+    # Returns a list of the recent games played by a summoner
+    # @param summoner_id [Fixnum] Summoner id
+    # @return [Array] an array of games
+    def game11 summoner_id
+      summoner_api_path = "game/by-summoner/#{summoner_id}/recent"
+      get(api_url("v1.1", summoner_api_path))["games"].map do |game_data|
+        Game.new game_data
+      end
+    end
+
+    # Calls the latest API version of league
+    def league summoner_id
+      league21 summoner_id
+    end
+
+    # Retrieves leagues data for summoner, including leagues for all of summoner's teams, v2.1
+    # @return [Array] an array of champions
+    def league21 summoner_id
+      get(api_url("v2.1", "league/by-summoner/#{summoner_id}"))[summoner_id].map {|l| League.new}
+    end
+
+
+    # Initializes a Lol::Client
+    # @param api_key [String]
+    # @param options [Hash]
+    # @option options [String] :region ("EUW") The region on which the requests will be made
+    # @return [Lol::Client]
+    def initialize api_key, options = {}
+      @api_key = api_key
+      @region = options.delete(:region) || "euw"
+    end
+
+  end
+end

data/lib/lol/game.rb

@@ -0,0 +1,92 @@
+require 'lol/model'
+
+module Lol
+  class Game < Lol::Model
+    # @!attribute [r] raw
+    #   @return [Hash] raw version of options Hash used to initialize Game
+    attr_reader :raw
+
+    # @!attribute [r] id
+    #   @return [Fixnum] Game Id
+    attr_reader :game_id
+
+    # @!attribute [r] champion_id
+    #   @return [Fixnum] Champion Id associated with this game
+    attr_reader :champion_id
+
+    # @!attribute [r] create_date
+    #   @return [DateTime] Date game was played
+    attr_reader :create_date
+
+    # @!attribute [r] create_date_str
+    #   @return [String] Human readable string representing date game was played
+    attr_reader :create_date_str
+
+    # @!attribute [r] fellow_players
+    #   @return [Array] list of players associated with this game
+    attr_reader :fellow_players
+
+    # @!attribute [r] game_mode
+    #   @return [String] Game Mode
+    attr_reader :game_mode
+
+    # @!attribute [r] game_type
+    #   @return [String] Game Type
+    attr_reader :game_type
+
+    # @!attribute [r] invalid
+    #   @return [true] if the game is invalid
+    #   @return [false] if the game is valid
+    attr_reader :invalid
+
+    # @!attribute [r] level
+    #   @return [Fixnum] Level
+    attr_reader :level
+
+    # @!attribute [r] map_id
+    #   @return [Fixnum] Map Id
+    attr_reader :map_id
+
+    # @!attribute [r] spell1
+    # @return [Fixnum] Summoner first spell id
+    attr_reader :spell1
+
+    # @!attribute [r] spell2
+    # @return [Fixnum] Summoner second spell id
+    attr_reader :spell2
+
+    # @!attribute [r] statistics
+    #   @return [Array] Statistics associated with the game for this summoner
+    attr_reader :statistics
+
+    # @!attribute [r] sub_type
+    #   @return [String] Game sub-type
+    attr_reader :sub_type
+
+    # @!attribute [r] team_id
+    #   @return [Fixnum] Team Id associated with game
+    attr_reader :team_id
+
+    private
+
+    attr_writer :champion_id, :game_id, :game_mode, :game_type, :invalid,
+                :level, :map_id, :spell1, :spell2, :sub_type, :team_id,
+                :create_date_str
+
+    def create_date= value
+      @create_date = value.is_a?(DateTime) && value || DateTime.strptime(value.to_s, '%s')
+    end
+
+    def fellow_players= collection
+      @fellow_players = collection.map do |c|
+        c.respond_to?(:[]) && Player.new(c) || c
+      end
+    end
+
+    def statistics= collection
+      @statistics = collection.map do |c|
+        c.respond_to?(:[]) && Statistic.new(c) || c
+      end
+    end
+  end
+end

data/lib/lol/league.rb

@@ -0,0 +1,4 @@
+module Lol
+  class League
+  end
+end

data/lib/lol/model.rb

@@ -0,0 +1,15 @@
+require 'active_support/core_ext/string/inflections'
+
+module Lol
+  class Model
+    # Initializes a Lol::Model
+    # @param options [Hash]
+    # @return [Lol::Model]
+    def initialize options = {}
+      @raw = options
+      options.each do |attribute_name, value|
+        send "#{attribute_name.to_s.underscore}=", value
+      end
+    end
+  end
+end

data/lib/lol/player.rb

@@ -0,0 +1,25 @@
+require 'lol/model'
+
+module Lol
+  class Player < Lol::Model
+    # @!attribute [r] raw
+    #   @return [Hash] raw version of options Hash used to initialize Player
+    attr_reader :raw
+
+    # @!attribute [r] champion_id
+    #   @return [Fixnum] Champion Id associated with player
+    attr_reader :champion_id
+
+    # @!attribute [r] summoner_id
+    #   @return [Fixnum] Summoner Id associated with player
+    attr_reader :summoner_id
+
+    # @!attribute [r] team_id
+    #   @return [Fixnum] Team Id associated with player
+    attr_reader :team_id
+
+    private
+
+    attr_writer :champion_id, :summoner_id, :team_id
+  end
+end

data/lib/lol/statistic.rb

@@ -0,0 +1,25 @@
+require 'lol/model'
+
+module Lol
+  class Statistic < Lol::Model
+    # @!attribute [r] raw
+    #   @return [Hash] raw version of options Hash used to initialize Statistic
+    attr_reader :raw
+
+    # @!attribute [r] id
+    #   @return [Fixnum] Raw Statistic Id
+    attr_reader :id
+
+    # @!attribute [r] name
+    #   @return [String] Raw Statistic name
+    attr_reader :name
+
+    # @!attribute [r] value
+    #   @return [Fixnum] Raw Statistic value
+    attr_reader :value
+
+    private
+
+    attr_writer :id, :name, :value
+  end
+end