hextech 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 34bec97e74db0a93f11d679b5f381dab953483940358944db61c8d283e4a4ef9
+  data.tar.gz: e91bbb519ecc5df86e4e64d98ca3b070f26c4dfddf11774223cec8b37202795e
+SHA512:
+  metadata.gz: 7a1abf2f60038adbaa89424aecbe4e4552b4dd5f6116802fe6e7956b4074f09396c67949fbb075b202333caf8179e8a2539e04329ad791a6ec20eecdf324edf4
+  data.tar.gz: 9bd07444a7d38d5a9caf32933f522fbadc3fa140a93d086536bc4750a451cba41b6f898af3c3dba34a7dca40d95f2a78c6b474435d0eb4e3987588cd2e2058aa

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/.DS_Store

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,17 @@
+AllCops:
+  TargetRubyVersion: 2.7.2
+  DisplayCopNames: true
+  StyleGuideCopsOnly: false
+Style/Documentation:
+  Enabled: false
+Layout/EmptyLinesAroundClassBody:
+  Enabled: true
+  EnforcedStyle: empty_lines
+  Supportedstyles:
+    - empty_lines
+    - no_empty_lines
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*'
+    - 'hextech.gemspec'
+    - 'lib/hextech/**/response/*'

data/CHANGELOG.md

@@ -0,0 +1,54 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+## [1.0.0] - 2021-08-24
+
+### Added
+
+- Global endpoints
+  - API
+    - ACCOUNT-V1
+      - `ByPuuid`
+      - `ByRiotId`
+      - `ActiveShard`
+
+- League endpoints
+  - API
+    - CHAMPION-MASTERY-V4
+      - `AllChampions`
+      - `ByChampion`
+      - `TotalScore`
+    - CHAMPION-V3
+      - `ChampionRotation`
+    - CLASH-V1
+      - `AllTournaments`
+      - `BySummonerId`
+      - `ByTournamentId`
+      - `TeamByTeamId`
+      - `TournamentByTeamId`
+    - LOL-STATUS-V4
+      - `Status`
+    - MATCH-V5
+      - `ByPuuid`
+      - `ByMatchId`
+      - `MatchTimeline`
+    - SPECTATOR-V4
+      - `ActiveGames`
+      - `FeaturedGames`
+    - SUMMONER-V4
+      - `ByAccountId`
+      - `ByPUUID`
+      - `BySummonerId`
+      - `BySummonerName`
+    - THIRD-PARTY-CODE-V4
+  - CDN
+    - Champion Information
+    - Patch Information
+
+- Valorant endpoints
+  - API
+    - VAL-STATUS-V1
+      - `Status`
+
+[1.0.0]: https://github.com/lilystoney/hextech/releases/tag/v1.0.0

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in hextech.gemspec
+gemspec
+
+gem 'rake', '~> 13.0'

data/Gemfile.lock

@@ -0,0 +1,134 @@
+PATH
+  remote: .
+  specs:
+    hextech (1.0.0)
+      dry-struct (~> 1.4.0)
+      faraday (~> 1.8.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.8.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    ast (2.4.2)
+    climate_control (1.0.1)
+    coderay (1.1.3)
+    concurrent-ruby (1.1.9)
+    crack (0.4.5)
+      rexml
+    diff-lcs (1.4.4)
+    docile (1.4.0)
+    dry-configurable (0.13.0)
+      concurrent-ruby (~> 1.0)
+      dry-core (~> 0.6)
+    dry-container (0.9.0)
+      concurrent-ruby (~> 1.0)
+      dry-configurable (~> 0.13, >= 0.13.0)
+    dry-core (0.7.1)
+      concurrent-ruby (~> 1.0)
+    dry-inflector (0.2.1)
+    dry-logic (1.2.0)
+      concurrent-ruby (~> 1.0)
+      dry-core (~> 0.5, >= 0.5)
+    dry-struct (1.4.0)
+      dry-core (~> 0.5, >= 0.5)
+      dry-types (~> 1.5)
+      ice_nine (~> 0.11)
+    dry-types (1.5.1)
+      concurrent-ruby (~> 1.0)
+      dry-container (~> 0.3)
+      dry-core (~> 0.5, >= 0.5)
+      dry-inflector (~> 0.1, >= 0.1.2)
+      dry-logic (~> 1.0, >= 1.0.2)
+    faraday (1.8.0)
+      faraday-em_http (~> 1.0)
+      faraday-em_synchrony (~> 1.0)
+      faraday-excon (~> 1.1)
+      faraday-httpclient (~> 1.0.1)
+      faraday-net_http (~> 1.0)
+      faraday-net_http_persistent (~> 1.1)
+      faraday-patron (~> 1.0)
+      faraday-rack (~> 1.0)
+      multipart-post (>= 1.2, < 3)
+      ruby2_keywords (>= 0.0.4)
+    faraday-em_http (1.0.0)
+    faraday-em_synchrony (1.0.0)
+    faraday-excon (1.1.0)
+    faraday-httpclient (1.0.1)
+    faraday-net_http (1.0.1)
+    faraday-net_http_persistent (1.2.0)
+    faraday-patron (1.0.0)
+    faraday-rack (1.0.0)
+    hashdiff (1.0.1)
+    ice_nine (0.11.2)
+    method_source (1.0.0)
+    multipart-post (2.1.1)
+    parallel (1.20.1)
+    parser (3.0.2.0)
+      ast (~> 2.4.1)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    public_suffix (4.0.6)
+    rainbow (3.0.0)
+    rake (13.0.6)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.3)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.4)
+    rubocop (0.93.1)
+      parallel (~> 1.10)
+      parser (>= 2.7.1.5)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8)
+      rexml
+      rubocop-ast (>= 0.6.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (1.10.0)
+      parser (>= 3.0.1.1)
+    rubocop-rspec (1.43.2)
+      rubocop (~> 0.87)
+    ruby-progressbar (1.11.0)
+    ruby2_keywords (0.0.5)
+    simplecov (0.21.2)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.3)
+    unicode-display_width (1.7.0)
+    vcr (6.0.0)
+    webmock (3.14.0)
+      addressable (>= 2.8.0)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+
+PLATFORMS
+  x86_64-darwin-20
+
+DEPENDENCIES
+  climate_control (~> 1.0.1)
+  hextech!
+  pry (~> 0.13.1)
+  rake (~> 13.0)
+  rspec (~> 3.9.0)
+  rubocop (~> 0.93.1)
+  rubocop-rspec (~> 1.43.2)
+  simplecov (~> 0.21.2)
+  vcr (~> 6.0.0)
+  webmock (~> 3.14.0)
+
+BUNDLED WITH
+   2.2.15

data/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Lily Stoney
+
+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,50 @@
+![Hextech Logo](./docs/logo.png)
+
+Simply a Ruby wrapper for Riot Api endpoints.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'hextech'
+```
+
+And then execute:
+
+    $ bundle install
+
+
+## Usage
+
+You'll need the following environment variable:
+
+```
+RIOT_API_KEY='code-goes-here'
+```
+
+Each Riot API endpoint integrated into the gem has been namespaced by game, endpoint grouping, and (if present) specific endpoint. The responses to these endpoints will be wrapped in a `Dry::Struct` with keys that have been converted to snake case.
+
+```ruby
+# Example:
+
+summoner = Hextech::League::Summoner.by_name(name: 'Example Summoner', region: 'euw1')
+# => #<Hextech::League::Response::Summoner account_id="1234" id="4321" name="Example Summoner" profile_icon_id=1234 puuid="2468" revision_date=2021-11-01 08:00:00 +0100 summoner_level=100>
+
+summoner.name
+# => "Example Summoner"
+```
+
+## API Logging
+
+Whenever the API Key is logged to the console, it will be replaced with `[REPLACED]`.
+
+Logging is suppressed by default. In order to increase the logging level to `DEBUG`, use the following environment variable:
+
+```
+DEBUG_LOGGER=true
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/lilystoney/hextech.

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'hextech'
+
+# 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/hextech.gemspec

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require_relative 'lib/hextech/version'
+
+Gem::Specification.new do |spec|
+  spec.name                        = 'hextech'
+  spec.version                     = Hextech::VERSION
+  spec.required_ruby_version       = Gem::Requirement.new('>= 2.7.0')
+  spec.summary                     = 'Ruby Wrapper for the Riot API endpoints.'
+  spec.description                 = 'An easy to use ruby wrapper for Riot API endpoints for League, Valorant,' \
+                                     'Legends of Runeterra, etc.'
+  spec.authors                     = ['Lily Stoney']
+  spec.email                       = ['lily@lilypad.info']
+  spec.homepage                    = 'https://github.com/LilyStoney/hextech'
+  spec.license                     = 'MIT'
+
+  spec.metadata['bug_tracker_uri'] = 'https://github.com/lilystoney/hextech/issues'
+  spec.metadata['changelog_uri']   = 'https://github.com/lilystoney/hextech/blob/master/CHANGELOG.md'
+  spec.metadata['github_repo']     = 'ssh://github.com/lilystoney/hextech'
+  spec.metadata['source_code_uri'] = 'https://github.com/lilystoney/hextech'
+
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+
+  spec.bindir                      = 'exe'
+  spec.executables                 = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths               = ['lib']
+
+  spec.add_dependency 'dry-struct', '~> 1.4.0'
+  spec.add_dependency 'faraday', '~> 1.8.0'
+
+  spec.add_development_dependency 'climate_control', '~> 1.0.1'
+  spec.add_development_dependency 'pry', '~> 0.13.1'
+  spec.add_development_dependency 'rspec', '~> 3.9.0'
+  spec.add_development_dependency 'rubocop', '~> 0.93.1'
+  spec.add_development_dependency 'rubocop-rspec', '~> 1.43.2'
+  spec.add_development_dependency 'simplecov', '~> 0.21.2'
+  spec.add_development_dependency 'vcr', '~> 6.0.0'
+  spec.add_development_dependency 'webmock', '~> 3.14.0'
+end

data/lib/hextech/adapter.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Hextech
+  class Adapter
+
+    include Hextech::Mixins::ArgumentChecks
+    include Hextech::Mixins::Callable
+
+    def initialize
+      @connection = Hextech::SendRequest.new(host: host, api_key: api_key)
+    end
+
+    def call
+      connection
+        .call(path)
+        .then { |response| wrap_response(response, response_class) }
+    end
+
+    private
+
+    attr_reader :connection
+
+    def wrap_response(response, response_class)
+      Hextech::Response.new(response.body, response_class).call
+    end
+
+    def response_class
+      return unless defined?(@response_class)
+
+      @response_class
+    end
+
+    def host
+      raise NotImplementedError, 'Missing host attribute'
+    end
+
+    def path
+      raise NotImplementedError, 'Missing path attribute'
+    end
+
+    def api_key
+      @api_key ||= ENV.fetch('RIOT_API_KEY')
+    end
+
+  end
+end

data/lib/hextech/base_struct.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Hextech
+  class BaseStruct < Dry::Struct
+
+    module Types
+      include Dry.Types()
+    end
+
+    CallableTime = Types::Time.constructor { |value| Time.at(value / 1000) }
+
+  end
+end

data/lib/hextech/errors.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Hextech
+  class Errors < Faraday::Response::Middleware
+
+    def on_complete(env)
+      case env[:status]
+      when 403
+        raise Hextech::Forbidden, 'You may not have the rights to perform this action or your API key may have expired.'
+      when 404
+        raise Hextech::NotFound, 'Resource not found.'
+      when 429
+        raise Hextech::RateLimitExceeded, 'Too many requests have exceeded your designated rate limit.'
+      end
+    end
+
+  end
+
+  class RateLimitExceeded < StandardError; end
+
+  class NotFound < StandardError; end
+
+  class Forbidden < StandardError; end
+
+  class InvalidArgument < StandardError; end
+end

data/lib/hextech/global/account/base.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Hextech
+  module Global
+    module Account
+      class Base < Hextech::Adapter
+
+        REGIONS = %w[europe americas asia esports].freeze
+
+        def call
+          validate_collection_for(collection: REGIONS, option: region)
+
+          super
+        end
+
+        private
+
+        def host
+          "https://#{region}.api.riotgames.com"
+        end
+
+      end
+    end
+  end
+end

data/lib/hextech/global/account/by_puuid.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Hextech
+  module Global
+    module Account
+      class ByPuuid < Hextech::Global::Account::Base
+
+        def initialize(puuid:, region:)
+          @puuid = puuid
+          @region = region
+
+          super()
+        end
+
+        private
+
+        attr_reader :puuid, :region
+
+        def path
+          "/riot/account/v1/accounts/by-puuid/#{puuid}"
+        end
+
+        def response_class
+          Hextech::Global::Response::Account::ByPuuid
+        end
+
+      end
+    end
+  end
+end

data/lib/hextech/global/account/by_riot_id.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Hextech
+  module Global
+    module Account
+      class ByRiotId < Hextech::Global::Account::Base
+
+        def initialize(game_name:, tag_line:, region:)
+          @game_name = game_name
+          @tag_line = tag_line
+          @region = region
+
+          super()
+        end
+
+        private
+
+        attr_reader :game_name, :tag_line, :region
+
+        def path
+          "/riot/account/v1/accounts/by-riot-id/#{clean_name}/#{tag_line}"
+        end
+
+        def clean_name
+          ERB::Util.url_encode(game_name)
+        end
+
+        def response_class
+          Hextech::Global::Response::Account::ByRiotId
+        end
+
+      end
+    end
+  end
+end

data/lib/hextech/global/account.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require_relative 'account/base'
+require_relative 'account/by_puuid'
+require_relative 'account/by_riot_id'
+
+module Hextech
+  module Global
+    module Account
+      class << self
+
+        def by_puuid(puuid:, region: 'europe')
+          Account::ByPuuid.call(puuid: puuid, region: region)
+        end
+
+        def by_riot_id(game_name:, tag_line:, region: 'europe')
+          Account::ByRiotId.call(game_name: game_name, tag_line: tag_line, region: region)
+        end
+
+      end
+    end
+  end
+end

data/lib/hextech/global/active_shard.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Hextech
+  module Global
+    class ActiveShard < Hextech::Adapter
+
+      GAMES = %w[lor val].freeze
+      REGIONS = %w[europe americas asia esports].freeze
+
+      def initialize(game:, puuid:, region: 'europe')
+        @game = game
+        @puuid = puuid
+        @region = region
+
+        super()
+      end
+
+      def call
+        validate_collection_for(collection: REGIONS, option: region)
+        validate_collection_for(collection: GAMES, option: game)
+
+        super
+      end
+
+      private
+
+      attr_reader :game, :puuid, :region
+
+      def path
+        "/riot/account/v1/active-shards/by-game/#{game}/by-puuid/#{puuid}"
+      end
+
+      def host
+        "https://#{region}.api.riotgames.com"
+      end
+
+      def response_class
+        Hextech::Global::Response::ActiveShard
+      end
+
+    end
+  end
+end

data/lib/hextech/global/response/account/by_puuid.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Hextech
+  module Global
+    module Response
+      module Account
+        class ByPuuid < Hextech::BaseStruct
+
+          attribute :puuid, Types::String
+          attribute :game_name, Types::String
+          attribute :tag_line, Types::String
+
+        end
+      end
+    end
+  end
+end

data/lib/hextech/global/response/account/by_riot_id.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Hextech
+  module Global
+    module Response
+      module Account
+        class ByRiotId < Hextech::BaseStruct
+
+          attribute :puuid, Types::String
+          attribute :game_name, Types::String
+          attribute :tag_line, Types::String
+
+        end
+      end
+    end
+  end
+end

data/lib/hextech/global/response/active_shard.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Hextech
+  module Global
+    module Response
+      class ActiveShard < Hextech::BaseStruct
+
+        attribute :puuid, Types::String
+        attribute :game, Types::String
+        attribute :active_shard, Types::String
+
+      end
+    end
+  end
+end