riot_api 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 17bde58de266bd8784b609710bb69ab284a1c57a
+  data.tar.gz: 83ce4b198561719b170da799fe167264eb4fb162
+SHA512:
+  metadata.gz: d181ca19d237dc0deb4d490296ccc8128953874fc15f7036bdcad6ef4263a58557d63263777e7f0a7229177fc2584e0c7f785c73910c1cfb6cb4c9076e692cc0
+  data.tar.gz: 6dba356f080ef32437bedac026fd91f5049ad5a101af5c9db3739416786e8d9d3a0945c2281154db9de04d564fed11886977e57433f733fd89eea04a12470e44

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,12 @@
+language: ruby
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+  - 2.0.0
+  - ruby-head
+script: bundle exec rake
+matrix:
+  allow_failures:
+    - rvm: 1.8.7
+    - rvm: ruby-head

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## 0.0.1
+
+* First Release!
+* Initial Setup
+* Summoner Name method added

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,11 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'rspec' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)/(.+)\.rb$}) { |m| "spec/lib/#{m[1]}/#{m[2]}_spec.rb" }
+  watch(%r{^lib/(.+)\.rb$})      { |m| "spec/lib/#{m[1]}_spec.rb" }
+
+  watch('spec/spec_helper.rb')  { "spec" }
+end
+

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2013 Peter Souter
+
+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,68 @@
+# Riot API
+
+A Ruby wrapper around connecting to the Riot API
+
+Early days yet, but trying to make it as modular as possible :cat:
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'riot_api'
+```
+
+And then execute:
+
+```shell
+$ bundle
+```
+
+Or install it yourself as:
+
+```shell
+$ gem install riot_api
+```
+
+## Usage:
+
+
+```ruby
+require 'riot_api'
+
+# Create Instace of the API
+ra = RiotApi::API.new :api_key => 'API_KEY_HERE', :region => 'euw', :debug => true
+
+# Search by Summoner name
+summoner_details = ra.summoner.name('Best Lux EUW')
+#<Hashie::Rash id=44600324 name="Best Lux EUW" profile_icon_id=7 revision_date=1375116256000 revision_date_str="07/29/2013 04:44 PM UTC" summoner_level=6>
+
+summoner.name # => "Best Lux EUW"
+```
+
+## ChangeLog / History / Releases
+
+see the [CHANGELOG.md](./CHANGELOG.md) file.
+
+## 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
+
+### Contributors
+
+* None Yet :)
+
+For more information and a complete list see [the contributor page on GitHub](https://github.com/petems/riot_api/contributors).
+
+## License
+
+[MIT](./LICENSE)
+
+## Thanks
+
+* @rmoriz - For the excellent [digital_ocean](https://github.com/rmoriz/digital_ocean) gem, which I used as a framework to setup this gem! :+1:
+

data/Rakefile

@@ -0,0 +1,14 @@
+#encoding: utf-8
+require 'rubygems'
+require 'bundler'
+Bundler.setup
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+desc 'Run RSpec'
+RSpec::Core::RakeTask.new do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rspec_opts = ['--color', '--format nested']
+end
+
+task :default => :spec

data/lib/riot_api/api.rb

@@ -0,0 +1,33 @@
+module RiotApi
+  class API
+    def initialize(params)
+      @api_key             = params[:api_key]
+      @region              = params[:region]
+      @debug               = params[:debug]
+      @ssl                 = params[:ssl] || { :verify => true }
+      @base_url            = params[:base_url]            || "http://prod.api.pvp.net/api/lol/#{@region}/v1.1/"
+      @faraday_adapter     = params[:faraday_adapter]     || Faraday.default_adapter
+      @raise_status_errors = params[:raise_status_errors] || false
+      @faraday             = params[:faraday]             || default_faraday
+      raise ArgumentError, ':api_key missing' unless @api_key
+      raise ArgumentError, ':region missing' unless @region
+    end
+
+    def summoner
+      RiotApi::Resource::Summoner.new(@faraday)
+    end
+
+    def default_faraday
+      Faraday.new(:url => @base_url, :ssl => @ssl) do |faraday|
+        faraday.use Faraday::Response::RaiseError if @raise_status_errors
+        faraday.request  :url_encoded
+        faraday.response :rashify
+        faraday.response :json
+        faraday.response(:logger) if @debug
+        faraday.adapter @faraday_adapter
+        faraday.params['api_key'] = @api_key
+        faraday.headers['User-Agent'] = "riot_api rubygem v#{RiotApi::VERSION}"
+      end
+    end
+  end
+end

data/lib/riot_api/resource/base.rb

@@ -0,0 +1,9 @@
+module RiotApi
+  module Resource
+    class Base
+      def initialize(connection, options = {})
+        @connection = connection
+      end
+    end
+  end
+end

data/lib/riot_api/resource/summoner.rb

@@ -0,0 +1,11 @@
+module RiotApi
+  module Resource
+    class Summoner < Base
+
+      def name(name, opts = {})
+        @connection.get("summoner/by-name/#{name}/").body
+      end
+
+    end
+  end
+end

data/lib/riot_api/resource.rb

@@ -0,0 +1,8 @@
+require 'riot_api/resource/base'
+require 'riot_api/resource/summoner'
+
+module RiotApi
+  module Resource
+
+  end
+end

data/lib/riot_api/version.rb

@@ -0,0 +1,3 @@
+module RiotApi
+  VERSION = '0.0.1'
+end

data/lib/riot_api.rb

@@ -0,0 +1,9 @@
+require 'faraday'
+require 'faraday_middleware'
+
+require 'riot_api/version'
+require 'riot_api/api'
+require 'riot_api/resource'
+
+module RiotApi
+end

data/riot_api.gemspec

@@ -0,0 +1,42 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'riot_api/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = 'riot_api'
+  gem.version       = RiotApi::VERSION
+  gem.authors       = ['Peter Souter']
+  gem.email         = ['p.morsou@gmail.com']
+  gem.description   = %q{A Ruby gem for the Riot Games API}
+  gem.summary       = %q{This gem wraps the Riot Games API documented at https://developer.riotgames.com/api/}
+  gem.homepage      = 'https://github.com/petems/riot_api'
+  gem.license       = 'MIT'
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ['lib']
+
+  if RUBY_PLATFORM == 'java'
+    gem.add_runtime_dependency 'jruby-openssl'
+  end
+
+  gem.add_dependency 'faraday', '~> 0.8.7'
+  gem.add_dependency 'faraday_middleware', '~> 0.9.0'
+  gem.add_dependency 'json', '~> 1.8.1'
+  gem.add_dependency 'rash', '~> 0.4.0'
+
+  gem.add_development_dependency 'rspec', '~> 2.0'
+  gem.add_development_dependency 'guard', '~> 2.1.0'
+  gem.add_development_dependency 'guard-rspec', '~> 4.0.1'
+
+  if RUBY_PLATFORM =~ /darwin/i
+    gem.add_development_dependency 'rb-fsevent', '~> 0.9.3'
+  end
+
+  gem.add_development_dependency 'vcr',     '~> 2.4'
+  gem.add_development_dependency 'fakeweb', '~> 1.3.0'
+  gem.add_development_dependency 'rake',  '~> 10.1.0'
+  gem.add_development_dependency 'coveralls', '~> 0.7.0'
+end

data/spec/api_spec.rb

@@ -0,0 +1,39 @@
+require 'spec_helper'
+
+describe RiotApi::API, :vcr do
+  subject { ra = RiotApi::API.new :api_key => api_key, :region => 'euw' }
+  let(:api_key)   { API_KEY }
+
+  describe '.new' do
+    it 'should return an instance when called with the essential parameters' do
+      client = RiotApi::API.new :api_key => api_key, :region => 'euw'
+      client.should be_instance_of(RiotApi::API)
+    end
+  end
+
+  describe 'ssl settings' do
+    it 'should by default enforce ssl' do
+      subject.default_faraday.ssl.should == { :verify => true }
+    end
+  end
+
+  describe '#summoner' do
+    let(:summoner_name) { 'BestLuxEUW' }
+
+    describe '#name' do
+      let(:response) {
+        subject.summoner.name summoner_name
+      }
+
+      it 'should return information from the summoner name' do
+        response.id.should eql(44600324)
+        response.name.should eql("Best Lux EUW")
+        response.profile_icon_id.should eql(7)
+        response.revision_date.should eql(1375116256000)
+        response.revision_date_str.should eql('07/29/2013 04:44 PM UTC')
+        response.summoner_level.should eql(6)
+      end
+    end
+
+  end
+end

data/spec/riot_api_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe RiotApi do
+  it 'should have a version number' do
+    RiotApi::VERSION.should_not be_nil
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,22 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'coveralls'
+Coveralls.wear!
+
+require 'rspec/autorun'
+require 'riot_api'
+
+if ENV['RECORDING']
+  API_KEY   = ENV['RIOT_API_KEY']
+else
+  API_KEY   = 'api_key_YYYYYYYYYYYYYYYYYYYYY'
+end
+
+RSpec.configure do |c|
+  # VCR:
+  # so we can use :vcr rather than :vcr => true;
+  # in RSpec 3 this will no longer be necessary.
+  c.treat_symbols_as_metadata_keys_with_true_values = true
+end
+
+Dir["./spec/support/**/*.rb"].sort.each {|f| require f}
+

data/spec/support/vcr.rb

@@ -0,0 +1,18 @@
+require 'vcr'
+require 'pp'
+
+VCR.configure do |c|
+  c.cassette_library_dir = 'spec/vcr/cassettes'
+  c.hook_into :faraday
+  c.configure_rspec_metadata!
+
+  if ENV['RECORDING']
+    c.filter_sensitive_data('api_key_YYYYYYYYYYYYYYYYYYYYY') { ENV['RIOT_API_KEY'] }
+  end
+
+  c.filter_sensitive_data('XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX') do |http_interaction|
+    #Not sure if this needs removing, but better safe than sorry...
+    http_interaction.response.headers['x-newrelic-app-data'].first
+  end
+
+end

data/spec/vcr/cassettes/RiotApi_API/_summoner/_name/should_return_information_from_the_summoner_name.yml

@@ -0,0 +1,47 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://prod.api.pvp.net/api/lol/euw/v1.1/summoner/by-name/BestLuxEUW/?api_key=api_key_YYYYYYYYYYYYYYYYYYYYY
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - riot_api rubygem 0.0.1
+  response:
+    status:
+      code: 200
+      message: 
+    headers:
+      access-control-allow-headers:
+      - Content-Type
+      access-control-allow-methods:
+      - GET, POST, DELETE, PUT
+      access-control-allow-origin:
+      - '*'
+      content-type:
+      - application/json;charset=UTF-8
+      date:
+      - Tue, 10 Dec 2013 23:03:59 GMT
+      server:
+      - Jetty(9.1.0.v20131115)
+      x-newrelic-app-data:
+      - XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
+      content-length:
+      - '146'
+      x-cache:
+      - MISS from localhost
+      x-cache-lookup:
+      - MISS from localhost:3128
+      via:
+      - 1.1 localhost:3128 (squid/2.7.STABLE9)
+      connection:
+      - close
+    body:
+      encoding: UTF-8
+      string: '{"id":44600324,"name":"Best Lux EUW","profileIconId":7,"summonerLevel":6,"revisionDate":1375116256000,"revisionDateStr":"07/29/2013
+        04:44 PM UTC"}'
+    http_version: 
+  recorded_at: Tue, 10 Dec 2013 23:04:00 GMT
+recorded_with: VCR 2.6.0

metadata

@@ -0,0 +1,238 @@
+--- !ruby/object:Gem::Specification
+name: riot_api
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Peter Souter
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.7
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.1
+- !ruby/object:Gem::Dependency
+  name: rash
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.0.1
+- !ruby/object:Gem::Dependency
+  name: rb-fsevent
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.3
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.4'
+- !ruby/object:Gem::Dependency
+  name: fakeweb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 10.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 10.1.0
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+description: A Ruby gem for the Riot Games API
+email:
+- p.morsou@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- CHANGELOG.md
+- Gemfile
+- Guardfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/riot_api.rb
+- lib/riot_api/api.rb
+- lib/riot_api/resource.rb
+- lib/riot_api/resource/base.rb
+- lib/riot_api/resource/summoner.rb
+- lib/riot_api/version.rb
+- riot_api.gemspec
+- spec/api_spec.rb
+- spec/riot_api_spec.rb
+- spec/spec_helper.rb
+- spec/support/vcr.rb
+- spec/vcr/cassettes/RiotApi_API/_summoner/_name/should_return_information_from_the_summoner_name.yml
+homepage: https://github.com/petems/riot_api
+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.1.10
+signing_key: 
+specification_version: 4
+summary: This gem wraps the Riot Games API documented at https://developer.riotgames.com/api/
+test_files:
+- spec/api_spec.rb
+- spec/riot_api_spec.rb
+- spec/spec_helper.rb
+- spec/support/vcr.rb
+- spec/vcr/cassettes/RiotApi_API/_summoner/_name/should_return_information_from_the_summoner_name.yml