lolbase 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c8749694dc4664005095b8ec196c017c35797d53
+  data.tar.gz: 23756e8276524d3827086e87b2225afb757c3442
+SHA512:
+  metadata.gz: 8a85f88ec28b3dbc6b1bad3f216fd0f83433a4ad02bd87b3e9e877c9ad1a676209160b0e84e2cd2e9101246417a9a2fb79fb62c068e0c14076ef2209579483ca
+  data.tar.gz: fdf05afe3b1a90aedbe785ab7589c7806756afb76f8b988607ebfe39fc31bc539005ab05387b6d18bf663c9b1f21f813ec14a8498bea640da76eb6ef8ff99c9c

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/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Regan Chan
+
+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,73 @@
+# LoLBase
+
+A basic Ruby wrapper for the League of Legends API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+	gem 'lolbase', :github => 'illianthe/lolbase'
+
+And in the console, execute:
+
+	$ bundle
+
+## Usage
+
+### 1. Configuration
+
+LoLBase can be globally configured through the *LoLBase::configure* method. The values shown are the defaults set by the gem.
+
+	LoLBase.configure do |config|
+	  config.default_region = "na"
+	  config.default_key = nil
+	  config.version_champion = "1.1"
+      config.version_game = "1.1"
+      config.version_league = "2.1"
+      config.version_stats = "1.1"
+      config.version_summoner = "1.1"
+      config.version_team = "2.1"
+	end
+
+### 2. Connection
+
+	connection = LoLBase.new "your-api-key-here"
+
+All connections begin by calling *LoLBase::new* which takes an API key as an argument (this can be left blank if it was provided in the config). Multiple connections can be used if you have more than one key available to you.
+
+### 3. Data Retrieval
+
+#### 3.1 Summoner
+
+	# Fetch a summoner by their name...
+	summoner = connection.summoner("A Summoner Name", "na")
+
+	# ...or by their ID
+	summoner = connection.summoner(12345, "euw")
+
+	# Retrieve data associated to the summoner
+	summoner.id
+	summoner.name
+	summoner.region
+	summoner.profileIconId
+	summoner.revisionDate
+	summoner.revisionDateStr
+	summoner.summonerLevel
+
+## To Do
+
+This gem is still missing a lot of functionality, but most of it will be added over time.
+
+* Champion list
+* Recent games
+* League data
+* Stats
+  * Summary
+  * Ranked
+* Summoner
+  * Masteries
+  * Runes
+  * ~~Find by name~~
+  * ~~Find by ID~~
+  * List of names by ID
+* Teams

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/lolbase/configuration.rb

@@ -0,0 +1,32 @@
+module LoLBase
+  class << self
+    attr_reader :config
+
+    def configure(&block)
+      yield @config ||= Configuration.new
+    end
+  end
+
+  class Configuration
+    attr_accessor :default_region,
+                  :default_key,
+                  :version_champion,
+                  :version_game,
+                  :version_league,
+                  :version_stats,
+                  :version_summoner,
+                  :version_team
+  end
+
+  # Default config values
+  configure do |config|
+    config.default_region = "na"
+
+    config.version_champion = "1.1"
+    config.version_game = "1.1"
+    config.version_league = "2.1"
+    config.version_stats = "1.1"
+    config.version_summoner = "1.1"
+    config.version_team = "2.1"
+  end
+end

data/lib/lolbase/connection.rb

@@ -0,0 +1,47 @@
+require 'httparty'
+
+module LoLBase
+  def self.new(key = nil)
+    return Connection.new(key)
+  end
+
+  class Connection
+    include HTTParty
+    base_uri "https://prod.api.pvp.net"
+
+    # Override HTTParty's get method to append the API key and to process errors returned from request
+    def get(path, options = {})
+      if options[:query].nil?
+        options.merge!({ query: { api_key: @key } })
+      else
+        options[:query].merge!({ api_key: @key })
+      end
+
+      response = self.class.get path, options
+      raise LoLBaseError, response.message if response.code != 200
+      response.body
+    end
+
+    def initialize(key = nil)
+      @key = key || LoLBase.config.default_key
+      self
+    end
+
+    # Syntactic sugar: lookup summoner by name or by ID
+    def summoner(identifier, region = LoLBase.config.default_region)
+      if identifier.is_a? String
+        return summoner_by_name(identifier, region)
+      else
+        return summoner_by_id(identifier, region)
+      end
+    end
+
+    def summoner_by_name(name, region = LoLBase.config.default_region)
+      return Summoner.new({ name: name, region: region }, self)
+    end
+
+    def summoner_by_id(id, region = LoLBase.config.default_region)
+      return Summoner.new({ id: id, region: region }, self)
+    end
+  end
+end

data/lib/lolbase/data/summoner.rb

@@ -0,0 +1,42 @@
+require "json"
+
+module LoLBase
+  class Summoner
+    attr_reader :id, :name, :profileIconId, :revisionDate, :revisionDateStr, :summonerLevel, :region
+
+    # Input
+    # - params - A hash containing either a summoner name or ID and the region that they belong to
+    #   (e.g. { id: 123, region: "na" })
+    # - connection - Current connection to the Riot API
+    #
+    # Effects: Calls the Riot API to retrieve data for the given summoner
+    #
+    # Output: Returns the Summoner class for further chaining
+    def initialize(params, connection)
+      @id = params[:id]
+      @name = params[:name]
+      @region = params[:region]
+      @connection = connection
+
+      response =
+        if !@id.nil?
+          # Find summoner by ID
+          connection.get "/api/lol/#{@region}/v#{LoLBase.config.version_summoner}/summoner/#{@id}"
+        else
+          # Find summoner by name
+          connection.get "/api/lol/#{@region}/v#{LoLBase.config.version_summoner}/summoner/by-name/#{@name}"
+        end
+
+      # Populate object with response data
+      data = JSON.parse(response)
+      @id = data["id"]
+      @name = data["name"]
+      @profileIconId = data["profileIconId"]
+      @revisionDate = data["revisionDate"]
+      @revisionDateStr = data["revisionDateStr"]
+      @summonerLevel = data["summonerLevel"]
+
+      self
+    end
+  end
+end

data/lib/lolbase/error.rb

@@ -0,0 +1,4 @@
+module LoLBase
+  class LoLBaseError < StandardError
+  end
+end

data/lib/lolbase/version.rb

@@ -0,0 +1,3 @@
+module LoLBase
+  VERSION = "0.1.0"
+end

data/lib/lolbase.rb

@@ -0,0 +1,5 @@
+require "lolbase/configuration"
+require "lolbase/connection"
+require "lolbase/error"
+
+require "lolbase/data/summoner"

data/lolbase.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "lolbase/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "lolbase"
+  spec.version       = LoLBase::VERSION
+  spec.authors       = ["Regan Chan"]
+  spec.email         = [""]
+  spec.description   = %q{A basic Ruby wrapper for the League of Legends API.}
+  spec.summary       = %q{A basic Ruby wrapper for the League of Legends API.}
+  spec.homepage      = "https://github.com/Illianthe/lolbase"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "webmock"
+
+  spec.add_runtime_dependency "httparty"
+end

data/spec/connection_spec.rb

@@ -0,0 +1,47 @@
+require "spec_helper"
+
+describe LoLBase::Connection do
+  before do
+    @connection = LoLBase.new "random-key"
+  end
+
+  it "rejects requests with an invalid API key" do
+    stub_request(:get, "http://www.irythia.com/invalid_api_key").with(query: { api_key: "random-key" }).to_return(status: 400)
+    expect { @connection.get "http://www.irythia.com/invalid_api_key" }.to raise_error(LoLBase::LoLBaseError)
+  end
+
+  it "returns an error if rate limits were reached" do
+    stub_request(:get, "http://www.irythia.com/rate_limited").with(query: { api_key: "random-key" }).to_return(status: 429)
+    expect { @connection.get "http://www.irythia.com/rate_limited" }.to raise_error(LoLBase::LoLBaseError)
+  end
+
+  it "returns an error if request can not be processed (data not found, etc.)" do
+    stub_request(:get, "http://www.irythia.com/not_found").with(query: { api_key: "random-key" }).to_return(status: 404)
+    expect { @connection.get "http://www.irythia.com/not_found" }.to raise_error(LoLBase::LoLBaseError)
+  end
+
+  it "returns an error if the API server is experiencing issues" do
+    stub_request(:get, "http://www.irythia.com/server_error").with(query: { api_key: "random-key" }).to_return(status: 500)
+    expect { @connection.get "http://www.irythia.com/server_error" }.to raise_error(LoLBase::LoLBaseError)
+  end
+
+  it "should allow for multiple connections using differing API keys" do
+    stub_request(:get, "http://www.irythia.com/ok").with(query: { api_key: "random-key" }).to_return(status: 200, body: "random-key")
+    stub_request(:get, "http://www.irythia.com/ok").with(query: { api_key: "random-key-2" }).to_return(status: 200, body: "random-key-2")
+
+    @connection2 = LoLBase.new "random-key-2"
+
+    expect(@connection.get "http://www.irythia.com/ok").to eq("random-key")
+    expect(@connection2.get "http://www.irythia.com/ok").to eq("random-key-2")
+  end
+
+  it "should create a connection using the default key if none specified" do
+    LoLBase.configure do |config|
+      config.default_key = "blah"
+    end
+
+    stub_request(:get, "http://www.irythia.com/ok").with(query: { api_key: "blah" }).to_return(status: 200, body: "blah")
+    connection = LoLBase.new
+    expect(connection.get "http://www.irythia.com/ok").to eq("blah")
+  end
+end

data/spec/data_spec.rb

@@ -0,0 +1,23 @@
+require "spec_helper"
+
+describe "LoLBase Data" do
+  before do
+    @connection = LoLBase.new "random-key"
+  end
+  
+  context "Summoner" do
+    it "should return summoner data when requested" do
+      file = File.read(File.expand_path("../json/summoner.json", __FILE__))
+      stub_request(:get, "https://prod.api.pvp.net/api/lol/na/v1.1/summoner/by-name/illianthe?api_key=random-key").to_return(status: 200, body: file)
+      
+      illianthe = @connection.summoner("illianthe")
+      expect(illianthe.id).to eq(19578577)
+      expect(illianthe.name).to eq("Illianthe")
+      expect(illianthe.profileIconId).to eq(539)
+      expect(illianthe.revisionDate).to eq(1386988105000)
+      expect(illianthe.revisionDateStr).to eq("12/14/2013 02:28 AM UTC")
+      expect(illianthe.summonerLevel).to eq(30)
+      expect(illianthe.region).to eq("na")
+    end
+  end
+end

data/spec/json/summoner.json

@@ -0,0 +1,8 @@
+{
+   "revisionDateStr": "12/14/2013 02:28 AM UTC",
+   "id": 19578577,
+   "name": "Illianthe",
+   "profileIconId": 539,
+   "revisionDate": 1386988105000,
+   "summonerLevel": 30
+}

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require "webmock/rspec"
+require "lolbase"

metadata

@@ -0,0 +1,135 @@
+--- !ruby/object:Gem::Specification
+name: lolbase
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Regan Chan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  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: A basic Ruby wrapper for the League of Legends API.
+email:
+- ''
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/lolbase.rb
+- lib/lolbase/configuration.rb
+- lib/lolbase/connection.rb
+- lib/lolbase/data/summoner.rb
+- lib/lolbase/error.rb
+- lib/lolbase/version.rb
+- lolbase.gemspec
+- spec/connection_spec.rb
+- spec/data_spec.rb
+- spec/json/summoner.json
+- spec/spec_helper.rb
+homepage: https://github.com/Illianthe/lolbase
+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.0.3
+signing_key: 
+specification_version: 4
+summary: A basic Ruby wrapper for the League of Legends API.
+test_files:
+- spec/connection_spec.rb
+- spec/data_spec.rb
+- spec/json/summoner.json
+- spec/spec_helper.rb
+has_rdoc: