lolxin 0.12.1

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+rvm:
+  - 2.3.0
+  - 2.2.0
+  - 2.1.0
+
+addons:
+  code_climate:
+    repo_token: 759ca8ab90af179e38b43faf1f62f60e14e30b47e818052654ec7e6faccad452
+
+before_install: gem install bundler -v 1.10.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Jon Ho
+
+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,62 @@
+[![Gem Version](https://badge.fury.io/rb/lolxin.svg)](https://badge.fury.io/rb/lolxin)
+[![Build Status](https://travis-ci.org/jonwho/lolxin.svg)](https://travis-ci.org/jonwho/lolxin)
+[![Code Climate](https://codeclimate.com/github/jonwho/lolxin/badges/gpa.svg)](https://codeclimate.com/github/jonwho/lolxin)
+[![Test Coverage](https://codeclimate.com/github/jonwho/lolxin/badges/coverage.svg)](https://codeclimate.com/github/jonwho/lolxin/coverage)
+[![Issue Count](https://codeclimate.com/github/jonwho/lolxin/badges/issue_count.svg)](https://codeclimate.com/github/jonwho/lolxin)
+
+# Lolxin
+
+The not-so-smooth API wrapper for League of Legends.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'lolxin'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install lolxin
+
+## Usage
+
+TODO: Document how to use
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run
+`rake spec` to run the tests. You can also run `bin/console` for an interactive
+prompt that will allow you to experiment.
+
+For testing purposes I am using the gem
+[dotenv](https://github.com/bkeepers/dotenv) to load my API key. I recommend
+you do the same and not to commit your .env file to git to keep it a secret by
+adding it to your .gitignore file. If you decide not to use dotenv for whatever
+reason make sure to comment it out in the bin/console script. Also add/remove
+any variables you see fit to speed up manual testing.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+To release a new version, update the version number in `version.rb`, and then
+run `bundle exec rake release`, which will create a git tag for the version,
+push git commits and tags, and push the `.gem` file to
+[rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/jonwho/lolxin. This project is intended to be a safe,
+welcoming space for collaboration, and contributors are expected to adhere
+to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the
+[MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

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

data/bin/bundler

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+#
+# This file was generated by Bundler.
+#
+# The application 'bundler' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("bundler", "bundler")

data/bin/cc-tddium-post-worker

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+#
+# This file was generated by Bundler.
+#
+# The application 'cc-tddium-post-worker' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("codeclimate-test-reporter", "cc-tddium-post-worker")

data/bin/codeclimate-test-reporter

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+#
+# This file was generated by Bundler.
+#
+# The application 'codeclimate-test-reporter' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("codeclimate-test-reporter", "codeclimate-test-reporter")

data/bin/coderay

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+#
+# This file was generated by Bundler.
+#
+# The application 'coderay' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("coderay", "coderay")

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "lolxin"
+include Lolxin
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+require "dotenv"
+Dotenv.load
+
+# If you use this, don't forget to add pry to your Gemfile!
+require "pry"
+Pry.start(Client.new(ENV['API_KEY'], region: :na))

data/bin/dotenv

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+#
+# This file was generated by Bundler.
+#
+# The application 'dotenv' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("dotenv", "dotenv")

data/bin/htmldiff

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+#
+# This file was generated by Bundler.
+#
+# The application 'htmldiff' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("diff-lcs", "htmldiff")

data/bin/ldiff

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+#
+# This file was generated by Bundler.
+#
+# The application 'ldiff' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("diff-lcs", "ldiff")

data/bin/pry

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+#
+# This file was generated by Bundler.
+#
+# The application 'pry' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("pry", "pry")

data/bin/rake

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rake", "rake")

data/bin/rspec

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rspec-core", "rspec")

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install --binstubs
+
+# Do any other automated setup that you need to do here

data/lib/lolxin/api_version.rb

@@ -0,0 +1,16 @@
+module Lolxin
+  module ApiVersion
+    CHAMPION         = 'v1.2'
+    CHAMPION_MASTERY = 'Riot Games has not specified a version'
+    CURRENT_GAME     = 'v1.0'
+    FEATURED_GAMES   = 'v1.0'
+    GAME             = 'v1.3'
+    LEAGUE           = 'v2.5'
+    LOL_STATIC_DATA  = 'v1.2'
+    LOL_STATUS       = 'v1.0'
+    MATCH            = 'v2.2'
+    MATCH_LIST       = 'v2.2'
+    STATS            = 'v1.3'
+    SUMMONER         = 'v1.4'
+  end
+end

data/lib/lolxin/champion.rb

@@ -0,0 +1,25 @@
+module Lolxin
+  class Champion
+    BASE_ENDPOINT = "https://%s.api.pvp.net/api/lol/%s/%s/champion"
+
+    attr_accessor :conn
+
+    def initialize(options = {})
+      region   = options[:region]
+      version  = options[:version]
+      api_key  = options[:api_key]
+      endpoint = BASE_ENDPOINT % [region, region, version]
+      @conn    = Faraday.new(endpoint, options[:conn_options]) do |faraday|
+        faraday.request(:url_encoded)
+        faraday.response(:logger)
+        faraday.adapter(Faraday.default_adapter)
+        faraday.params[:api_key] = api_key
+      end
+    end
+
+    def champion(params = {}, &block)
+      id = params.delete(:id).to_s
+      conn.get(id, params, &block)
+    end
+  end
+end

data/lib/lolxin/champion_mastery.rb

@@ -0,0 +1,69 @@
+module Lolxin
+  class ChampionMasteryError < StandardError; end
+
+  class ChampionMastery
+    BASE_ENDPOINT = "https://%s.api.pvp.net/championmastery/location"
+
+    REGIONS = %w[
+      BR1
+      EUN1
+      EUW1
+      JP1
+      KR
+      LA1
+      LA2
+      NA1
+      OC1
+      PBE1
+      RU
+      TR1
+    ]
+
+    attr_accessor :conn
+
+    def initialize(options = {})
+      region   = options[:region]
+      api_key  = options[:api_key]
+      endpoint = BASE_ENDPOINT % [region]
+      @conn    = Faraday.new(endpoint, options[:conn_options]) do |faraday|
+        faraday.request(:url_encoded)
+        faraday.response(:logger)
+        faraday.adapter(Faraday.default_adapter)
+        faraday.params[:api_key] = api_key
+      end
+    end
+
+    def player_champion(params = {}, &block)
+      player_id   = params.delete(:playerId)
+      champion_id = params.delete(:championId)
+      region      = params.delete(:region)
+      raise(ChampionMasteryError, "Region given not in acceptable regions #{REGIONS}") unless REGIONS.include? region
+      endpoint    = [region, 'player', player_id, 'champion', champion_id].join('/')
+      conn.get(endpoint, params, &block)
+    end
+
+    def player_champions(params = {}, &block)
+      player_id = params.delete(:playerId)
+      region    = params.delete(:region)
+      raise(ChampionMasteryError, "Region given not in acceptable regions #{REGIONS}") unless REGIONS.include? region
+      endpoint  = [region, 'player', player_id, 'champions'].join('/')
+      conn.get(endpoint, params, &block)
+    end
+
+    def player_score(params = {}, &block)
+      player_id = params.delete(:playerId)
+      region    = params.delete(:region)
+      raise(ChampionMasteryError, "Region given not in acceptable regions #{REGIONS}") unless REGIONS.include? region
+      endpoint  = [region, 'player', player_id, 'score'].join('/')
+      conn.get(endpoint, params, &block)
+    end
+
+    def player_top_champions(params = {}, &block)
+      player_id = params.delete(:playerId)
+      region    = params.delete(:region)
+      raise(ChampionMasteryError, "Region given not in acceptable regions #{REGIONS}") unless REGIONS.include? region
+      endpoint  = [region, 'player', player_id, 'topchampions'].join('/')
+      conn.get(endpoint, params, &block)
+    end
+  end
+end

data/lib/lolxin/client.rb

@@ -0,0 +1,92 @@
+module Lolxin
+  class ClientError < StandardError; end
+
+  # Client create connection clients for specific endpoints
+  class Client
+    attr_reader :region, :api_key
+
+    def initialize(api_key, options = {})
+      @api_key = api_key
+      @region = options[:region] if Region.valid?(options[:region])
+      raise ClientError, "Invalid region given" unless @region
+    end
+
+    def champion(options = {})
+      options[:api_key] = api_key
+      options[:region]  = region
+      options[:version] = ApiVersion::CHAMPION
+      Champion.new(options)
+    end
+
+    def lol_static_data(options = {})
+      options[:api_key] ||= api_key
+      options[:region]  ||= region
+      options[:version] ||= ApiVersion::LOL_STATIC_DATA
+      LolStaticData.new(options)
+    end
+
+    def lol_status(options = {})
+      LolStatus.new(options)
+    end
+
+    def current_game(options = {})
+      options[:api_key] ||= api_key
+      options[:region]  ||= region
+      CurrentGame.new(options)
+    end
+
+    def featured_games(options = {})
+      options[:api_key] ||= api_key
+      options[:region]  ||= region
+      FeaturedGames.new(options)
+    end
+
+    def game(options = {})
+      options[:api_key] ||= api_key
+      options[:region]  ||= region
+      options[:version] ||= ApiVersion::GAME
+      Game.new(options)
+    end
+
+    def champion_mastery(options = {})
+      options[:api_key] ||= api_key
+      options[:region]  ||= region
+      ChampionMastery.new(options)
+    end
+
+    def league(options = {})
+      options[:api_key] ||= api_key
+      options[:region]  ||= region
+      options[:version] ||= ApiVersion::LEAGUE
+      League.new(options)
+    end
+
+    def match(options = {})
+      options[:api_key] ||= api_key
+      options[:region]  ||= region
+      options[:version] ||= ApiVersion::MATCH
+      Match.new(options)
+    end
+
+    def match_list(options = {})
+      options[:api_key] ||= api_key
+      options[:region]  ||= region
+      options[:version] ||= ApiVersion::MATCH_LIST
+      MatchList.new(options)
+    end
+
+    def stats(options = {})
+      options[:api_key] ||= api_key
+      options[:region]  ||= region
+      options[:version] ||= ApiVersion::STATS
+      Stats.new(options)
+    end
+
+    def summoner(options = {})
+      options[:api_key] ||= api_key
+      options[:region]  ||= region
+      options[:version] ||= ApiVersion::SUMMONER
+      Summoner.new(options)
+    end
+  end
+end

data/lib/lolxin/current_game.rb

@@ -0,0 +1,44 @@
+module Lolxin
+  class CurrentGameError < StandardError; end
+
+  class CurrentGame
+    BASE_ENDPOINT = "https://%s.api.pvp.net/observer-mode/rest/consumer/getSpectatorGameInfo"
+
+    REGIONS = %w[
+      BR1
+      EUN1
+      EUW1
+      JP1
+      KR
+      LA1
+      LA2
+      NA1
+      OC1
+      PBE1
+      RU
+      TR1
+    ]
+
+    attr_accessor :conn
+
+    def initialize(options = {})
+      region   = options[:region]
+      api_key  = options[:api_key]
+      endpoint = BASE_ENDPOINT % [region]
+      @conn    = Faraday.new(endpoint, options[:conn_options]) do |faraday|
+        faraday.request(:url_encoded)
+        faraday.response(:logger)
+        faraday.adapter(Faraday.default_adapter)
+        faraday.params[:api_key] = api_key
+      end
+    end
+
+    def observe(params = {}, &block)
+      region   = params.delete(:region).to_s
+      raise(CurrentGameError, "Region given not in acceptable regions #{REGIONS}") unless REGIONS.include? region
+      summ_id  = params.delete(:summonerId).to_s
+      endpoint = [region, summ_id].join('/')
+      conn.get(endpoint, params, &block)
+    end
+  end
+end

data/lib/lolxin/featured_games.rb

@@ -0,0 +1,23 @@
+module Lolxin
+  class FeaturedGames
+    BASE_ENDPOINT = "https://%s.api.pvp.net/observer-mode/rest/featured"
+
+    attr_accessor :conn
+
+    def initialize(options = {})
+      region   = options[:region]
+      api_key  = options[:api_key]
+      endpoint = BASE_ENDPOINT % [region]
+      @conn    = Faraday.new(endpoint, options[:conn_options]) do |faraday|
+        faraday.request(:url_encoded)
+        faraday.response(:logger)
+        faraday.adapter(Faraday.default_adapter)
+        faraday.params[:api_key] = api_key
+      end
+    end
+
+    def observe(params = {}, &block)
+      conn.get("", params, &block)
+    end
+  end
+end

data/lib/lolxin/game.rb

@@ -0,0 +1,25 @@
+module Lolxin
+  class Game
+    BASE_ENDPOINT = "https://%s.api.pvp.net/api/lol/%s/%s/game/by-summoner"
+
+    attr_accessor :conn
+
+    def initialize(options = {})
+      region   = options[:region]
+      version  = options[:version]
+      api_key  = options[:api_key]
+      endpoint = BASE_ENDPOINT % [region, region, version]
+      @conn    = Faraday.new(endpoint, options[:conn_options]) do |faraday|
+        faraday.request(:url_encoded)
+        faraday.response(:logger)
+        faraday.adapter(Faraday.default_adapter)
+        faraday.params[:api_key] = api_key
+      end
+    end
+
+    def observe(params = {}, &block)
+      summ_id = params.delete(:summonerId).to_s
+      conn.get("#{summ_id}/recent", params, &block)
+    end
+  end
+end