riotgames_api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1481645dbd958502946a683faf77c8f67acf44912aab1cc194eeb5f8f9e323ed
+  data.tar.gz: 0fb9ffcafc6c5ed285043dfc29af016177c3663deea8bc82b3fd9fc2acbbbf39
+SHA512:
+  metadata.gz: 84f11cc918fc2ec3f917152d0356fe0501454eb13b2b59e3b3298642558e63548b32e5e6cafbfd356cabf92e652c7076ea842b8137321f1acb27950f83aaeeba
+  data.tar.gz: af045e6586c0a4440fe9c8aca3d7600e76008944b2b09371eedf9d989f9c4445c9b1d9b77dcb29d9c1b0556ec7e3698c31bfa0e63b4698fc3784e4a1772ee775

data/.editorconfig

@@ -0,0 +1,11 @@
+root = true
+
+[*]
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[**.rb]
+indent_style = space
+indent_size = 2

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.2
+before_install: gem install bundler -v 2.0.1

data/Gemfile

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

data/README.md

@@ -0,0 +1,43 @@
+# RiotAPI
+
+The RiotAPI gem allows Ruby developers to programatically access the Riot Games API with a cool DSL. P.S.: Blitzcrank approves!
+
+![Blitzcrank approves!](https://vignette.wikia.nocookie.net/p__/images/4/41/Blitzcrank_Render_old_%281%29.png/revision/latest?cb=20170128010045&path-prefix=protagonist)
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby 
+gem 'riotgames_api'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install riotgames_api
+
+## Usage
+
+```ruby
+# Do this once in your application startup
+RiotAPI.configure "your api key"
+
+# And use it =)
+RiotAPI::Summoner.find(name: "Mid or Feed", region: :na)
+# => #<RiotAPI::Summoner:0x00007fffd0a3b9c0 @id="pLIQUh9AUMSSwLMKdlNscoDEkoIYs2fYGAytTIKHkwy5YWg", @account_id=nil, @profile_icon_id=nil, @puuid="7qiWDJqhrCjc2xLDvfEsm2UiZOvo6l7UjBjUuRq7cwtWXRgSh8fGR59YC1Ls3mBZao6nDW_JiQ05gw", @summoner_level=nil, @revision_date=nil>
+```
+
+## 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.
+
+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/vnbrs/riot_api.

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

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "riot_api"
+
+# 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.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

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

data/lib/riot_api.rb

@@ -0,0 +1,21 @@
+require "riot_api/version"
+require "riot_api/client"
+require "riot_api/errors"
+require "riot_api/resources/summoner"
+
+module RiotAPI
+  class << self
+    def configure(api_key)
+      @client = Client.new(api_key)
+      return nil
+    end
+
+    def client
+      if @client
+        @client
+      else
+        raise ClientNotConfiguredError, "You must call RiotAPI.configure with your API key before calling the API"
+      end
+    end
+  end
+end

data/lib/riot_api/client.rb

@@ -0,0 +1,77 @@
+require 'net/http'
+require 'uri'
+require 'json'
+
+module RiotAPI
+  class Client
+    attr_accessor :api_key
+
+    BASE_URLS = {
+      # Regional endpoints
+      br:	  "https://br1.api.riotgames.com",
+      eune: "https://eun1.api.riotgames.com",
+      euw:  "https://euw1.api.riotgames.com",
+      jp:	  "https://jp1.api.riotgames.com",
+      kr:	  "https://kr.api.riotgames.com",
+      lan:  "https://la1.api.riotgames.com",
+      las:  "https://la2.api.riotgames.com",
+      na:   "https://na1.api.riotgames.com",
+      oce:  "https://oc1.api.riotgames.com",
+      tr:	  "https://tr1.api.riotgames.com",
+      ru:	  "https://ru.api.riotgames.com",
+      pbe:  "https://pbe1.api.riotgames.com",
+
+      # Regional proxies
+      americas: "https://americas.api.riotgames.com",
+      europe:   "https://europe.api.riotgames.com",
+      asia:     "https://asia.api.riotgames.com"
+    }
+
+    def initialize(api_key)
+      if api_key.nil? || api_key.empty?
+        raise ArgumentError, "The API key must be informed"
+      end
+
+      self.api_key = api_key
+    end
+
+    def request(method, path, region, params = {})
+      if api_key.nil? || api_key.empty?
+        raise RiotAPI::InvalidRequestError, "The API key must be informed"
+      end
+
+      base_url = BASE_URLS[region]
+      if base_url.nil?
+        raise RiotAPI::InvalidRequestError, "The informed region is not supported. Select one of the following: #{BASE_URLS.keys}"
+      end
+      url = URI.escape("#{base_url}#{path}")
+
+      uri = URI.parse(url)
+      unless uri.is_a?(URI::HTTPS)
+        raise RiotAPI::InvalidRequestError, "The request URL must be HTTPS"
+      end
+
+      params.merge!({ api_key: api_key })
+
+      case method
+      when :get
+        request_get(uri, params)
+      else
+        raise RiotAPI::InvalidRequestError, "The method #{method} is not allowed"
+      end
+    end
+
+    private
+
+    def request_get(uri, params)
+      uri.query = URI.encode_www_form(params)
+      response = Net::HTTP.get_response(uri)
+
+      if response.is_a?(Net::HTTPSuccess)
+        JSON.parse(response.body)
+      else
+        raise RiotAPI::ResponseError, response
+      end
+    end
+  end
+end

data/lib/riot_api/errors.rb

@@ -0,0 +1,13 @@
+module RiotAPI
+  class InvalidRequestError < StandardError; end
+  class ClientNotConfiguredError < StandardError; end
+
+  class ResponseError < StandardError
+    attr_accessor :response
+
+    def initialize(response)
+      self.response = response
+      super("An error has occurred during the HTTP request. Check the response for more details.")
+    end
+  end
+end

data/lib/riot_api/resources/summoner.rb

@@ -0,0 +1,41 @@
+module RiotAPI
+  class Summoner
+    attr_accessor :id, :account_id, :profile_icon_id, :puuid, :summoner_level, :revision_date
+
+    def self.find(options = {})
+      mandatory_options = [:region]
+      accepted_filters = [:name, :id, :account_id, :puuid]
+
+      unless (mandatory_options - options.keys).empty?
+        raise ArgumentError, "A required parameter was not informed. The required paramaters are #{mandatory_options}"
+      end
+
+      request_path = (
+        if options.key?(:name)
+          "/lol/summoner/v4/summoners/by-name/#{options[:name]}"
+        elsif options.key?(:id)
+          "/lol/summoner/v4/summoners/#{options[:id]}"
+        elsif options.key?(:account_id)
+          "/lol/summoner/v4/summoners/by-account/#{options[:account_id]}"
+        elsif options.key?(:puuid)
+          "/lol/summoner/v4/summoners/by-puuid/#{options[:puuid]}"
+        else
+          raise ArgumentError, "The informed filter is not accepted. The accepted filters are #{accepted_filters}"
+        end
+      )
+
+      response = RiotAPI.client.request(:get, request_path, options[:region])
+      self.from_json(response)
+    end
+
+    def self.from_json(json)
+      self.new.tap do |s|
+        s.id = json["id"]
+        s.account_id = json["account_id"]
+        s.profile_icon_id = json["profile_icon_id"]
+        s.puuid = json["puuid"]
+        s.summoner_level = json["summoner_level"]
+        s.revision_date = json["revision_date"]
+      end
+  end
+end

data/lib/riot_api/version.rb

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

data/riotgames_api.gemspec

@@ -0,0 +1,27 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "riot_api/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "riotgames_api"
+  spec.version       = RiotAPI::VERSION
+  spec.authors       = ["Vinicius Brasil"]
+  spec.email         = ["vnbrs@icloud.com"]
+
+  spec.summary       = "RiotAPI is the coolest Riot Games API gem. Blitzcrank approves!"
+  spec.description   = "The RiotAPI is a lightweight gem for accessing the Riot Games API using a cool DSL."
+  spec.homepage      = "https://github.com/vnbrs/riot_api"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: riotgames_api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Vinicius Brasil
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-03-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: The RiotAPI is a lightweight gem for accessing the Riot Games API using
+  a cool DSL.
+email:
+- vnbrs@icloud.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".editorconfig"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/riot_api.rb
+- lib/riot_api/client.rb
+- lib/riot_api/errors.rb
+- lib/riot_api/resources/summoner.rb
+- lib/riot_api/version.rb
+- riotgames_api.gemspec
+homepage: https://github.com/vnbrs/riot_api
+licenses: []
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: RiotAPI is the coolest Riot Games API gem. Blitzcrank approves!
+test_files: []