starcall 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f7a09d7f7d91682427ed719d214c309eb2ea0b26689ffca6f4975b4740b92b9d
-  data.tar.gz: abd5c5c07f1106297b7d7f5715067b50ee8dfc1ec3f64bdc3892eac7b1404480
+  metadata.gz: afe7b17e98b4f26c45a50c13d4631ddbaae2f6e8f5674ad3769e5a85cb35089e
+  data.tar.gz: 216b511b0109f37211c59777012716cf76d3ecbf803dd38ec5387bd8646fc202
 SHA512:
-  metadata.gz: 660f783e08ec030e856886580cc6d4da2161f77ce719a62a997079586410a69edd970f6bd541507cf42015a1a1046461d8b9f9061aaa1d3fc528ed2fcf042b2f
-  data.tar.gz: c66145ff56e10d8051d500a4b059315ccd65cb1e970907268c8635b123ee9fa9c2c1c2823a280288c77e197b435669c00c8592a7598cde9ba67f7ab6fdbc391a
+  metadata.gz: 9b023aaee23d61056c570301b95bc360cd68ff045afa2551b0386238b83cc0de4ba49427434f926dc1bb983ff25fb773b5a38e06420c3af3108ffd26a74e21aa
+  data.tar.gz: 4ca4dc69588b7196d1ee04e77a684fc4f2b9ab1894277fb2953445baecdeea6ff13b88275c08b34fa887cedf74eb647c6c32c7153c91341a4b7de38938c4a636

data/.rakeTasks

@@ -4,4 +4,4 @@ You are allowed to:
 1. Remove rake task
 2. Add existing rake tasks
 To add existing rake tasks automatically delete this file and reload the project.
---><RakeGroup description="" fullCmd="" taksId="rake"><RakeTask description="Build Starcall-0.1.0.gem into the pkg directory" fullCmd="build" taksId="build" /><RakeTask description="Remove any temporary products" fullCmd="clean" taksId="clean" /><RakeTask description="Remove any generated files" fullCmd="clobber" taksId="clobber" /><RakeTask description="Build and install Starcall-0.1.0.gem into system gems" fullCmd="install" taksId="install" /><RakeGroup description="" fullCmd="" taksId="install"><RakeTask description="Build and install Starcall-0.1.0.gem into system gems without network access" fullCmd="install:local" taksId="local" /></RakeGroup><RakeTask description="Create tag v0.1.0 and build and push Starcall-0.1.0.gem to TODO: Set to 'http://mygemserver.com'" fullCmd="release[remote]" taksId="release[remote]" /><RakeTask description="Run RuboCop" fullCmd="rubocop" taksId="rubocop" /><RakeGroup description="" fullCmd="" taksId="rubocop"><RakeTask description="Auto-correct RuboCop offenses" fullCmd="rubocop:auto_correct" taksId="auto_correct" /></RakeGroup><RakeTask description="Run RSpec code examples" fullCmd="spec" taksId="spec" /><RakeGroup description="" fullCmd="" taksId="travis"><RakeTask description="Run rubocop and rspec" fullCmd="travis:run" taksId="run" /></RakeGroup><RakeTask description="" fullCmd="release" taksId="release" /><RakeGroup description="" fullCmd="" taksId="release"><RakeTask description="" fullCmd="release:guard_clean" taksId="guard_clean" /><RakeTask description="" fullCmd="release:rubygem_push" taksId="rubygem_push" /><RakeTask description="" fullCmd="release:source_control_push" taksId="source_control_push" /></RakeGroup></RakeGroup></Settings>
+--><RakeGroup description="" fullCmd="" taksId="rake" /></Settings>

data/CHANGELOG.md

@@ -13,6 +13,22 @@ None
 
 ---
 
+## v0.3.0 - Alistar
+![Alistar](http://ddragon.leagueoflegends.com/cdn/10.12.1/img/champion/Alistar.png)
+
+### New features
+- Added the 3 Champion Mastery Endpoints. 
+- `ApiRequests` now checks for an API key called `RIOT_API_KEY` and adds to the headers.
+- Added a region parser as the API URLs require a region, but they are not the same as the normal regions.
+
+### Changes
+- Move `ApiRequests` under the `Starcall` namespace.
+- Move errors in to their own directory.
+
+### Bug fixes 
+
+---
+
 ## v0.2.1 - Akali
 ![Akali](http://ddragon.leagueoflegends.com/cdn/10.12.1/img/champion/Akali.png)
 

data/Gemfile.lock

@@ -1,17 +1,19 @@
 PATH
   remote: .
   specs:
-    starcall (0.2.1)
+    starcall (0.3.0)
       httparty (~> 0.17)
 
 GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.1)
+    coderay (1.1.3)
     diff-lcs (1.3)
     httparty (0.18.1)
       mime-types (~> 3.0)
       multi_xml (>= 0.5.2)
+    method_source (1.0.0)
     mime-types (3.3.1)
       mime-types-data (~> 3.2015)
     mime-types-data (3.2020.0512)
@@ -19,6 +21,9 @@ GEM
     parallel (1.19.2)
     parser (2.7.1.4)
       ast (~> 2.4.1)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
     rainbow (3.0.0)
     rake (12.3.3)
     regexp_parser (1.7.1)
@@ -58,6 +63,7 @@ PLATFORMS
 
 DEPENDENCIES
   bundler (~> 2.0)
+  pry (~> 0.13)
   rake (~> 12.3)
   rspec (~> 3.0)
   rubocop (~> 0.86)

data/README.md

@@ -119,6 +119,34 @@ Details about summoner spells.
 
 Details about profile icons and where they can be found on the sprite sheets.
 
+## Endpoints
+The below commands require a Riot API key.
+It needs to be saved as an ENV var and called `RIOT_API_KEY`
+### Champion Mastery V4
+
+#### `summoner`
+[Riot API Documentation](https://developer.riotgames.com/apis#champion-mastery-v4/GET_getAllChampionMasteries)
+
+Required fields:
+- `encrypted_summoner_id` (The encrypted summoner ID for the summoner you want to know about.)
+- `region` (The reigion that the summoner is in.)
+
+#### `summoner_on_champion`
+[Riot API Documentation](https://developer.riotgames.com/apis#champion-mastery-v4/GET_getChampionMastery)
+
+Required fields:
+- `encrypted_summoner_id` (The encrypted summoner ID for the summoner you want to know about.)
+- `champion_id` (The ID number of the champion that you want to know about.)
+- `region` (The reigion that the summoner is in.)
+
+#### `summoner_total_mastery`
+[Riot API Documentation](https://developer.riotgames.com/apis#champion-mastery-v4/GET_getChampionMasteryScore)
+
+Required fields:
+- `encrypted_summoner_id` (the encrypted summoner ID for the summoner you want to know about.)
+- `region` (The reigion that the summoner is in.)
+
+
 ## Development
 
 After checking out the repo, run `bundle install` to install dependencies. 

data/lib/starcall.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'starcall/api_requests'
-require 'starcall/error'
+require 'starcall/endpoints/endpoints'
+require 'starcall/errors/errors'
 require 'starcall/languages'
 require 'starcall/regions'
 require 'starcall/static_data'

data/lib/starcall/api_requests.rb

@@ -2,9 +2,12 @@
 
 require 'httparty'
 
-# A small class to make a HTTP get request using the passed in URL
-class ApiRequests
-  def self.make_request(url:)
-    HTTParty.get(url).parsed_response
+module Starcall
+  # A small class to make a HTTP get request using the passed in URL
+  # Intened to only be used my internal Gem classes and not be called directly.
+  class ApiRequests
+    def self.make_request(url:)
+      HTTParty.get(url, { headers: { 'X-Riot-Token' => ENV['RIOT_API_KEY'] } }).parsed_response
+    end
   end
 end

data/lib/starcall/endpoints/champion_mastery_v4.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require 'starcall/helpers/region_parser'
+require 'starcall/api_requests'
+
+module Starcall
+  module Endpoints
+    # Methods used to call the Champion Mastery endpoints.
+    class ChampionMasteryV4
+      # Get all champion mastery entries sorted by number of champion points descending.
+      def self.summoner(encrypted_summoner_id:, region:)
+        Starcall::Regions.valid?(region: region)
+        Starcall::ApiRequests.make_request(
+          url: "https://#{parse_region(region: region)}.api.riotgames.com"\
+               "/lol/champion-mastery/v4/champion-masteries/by-summoner/#{encrypted_summoner_id}"
+        )
+      end
+
+      # Get a champion mastery by player ID and champion ID.
+      def self.summoner_on_champion(encrypted_summoner_id:, champion_id:, region:)
+        Starcall::Regions.valid?(region: region)
+        Starcall::ApiRequests.make_request(
+          url: "https://#{parse_region(region: region)}.api.riotgames.com"\
+               "/lol/champion-mastery/v4/champion-masteries/by-summoner/#{encrypted_summoner_id}"\
+               "/by-champion/#{champion_id}"
+        )
+      end
+
+      # Get a player's total champion mastery score, which is the sum of individual champion mastery levels.
+      def self.summoner_total_mastery(encrypted_summoner_id:, region:)
+        Starcall::Regions.valid?(region: region)
+        Starcall::ApiRequests.make_request(
+          url: "https://#{parse_region(region: region)}.api.riotgames.com"\
+               "/lol/champion-mastery/v4/scores/by-summoner/#{encrypted_summoner_id}"
+        )
+      end
+
+      def self.parse_region(region:)
+        Starcall::Helpers::RegionParser.parse(region: region)
+      end
+
+      private_class_method :parse_region
+    end
+  end
+end

data/lib/starcall/endpoints/endpoints.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative 'champion_mastery_v4'

data/lib/starcall/errors/errors.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require_relative 'invalid_language'
+require_relative 'invalid_region'

data/lib/starcall/{error.rb → errors/invalid_language.rb}

@@ -1,23 +1,7 @@
 # frozen_string_literal: true
 
 module Starcall
-  module Error
-    # A Custom error message, used when an incorrect region is passed.
-    class InvalidRegion < StandardError
-      def initialize(region:)
-        super
-        @region = region
-      end
-
-      def message
-        "#{region} is not a valid region. Please consult Starcall::Regions.list for a list of valid regions."
-      end
-
-      private
-
-      attr_reader :region
-    end
-
+  module Errors
     # A Custom error message, used when an incorrect language is passed.
     class InvalidLanguage < StandardError
       def initialize(language:)

data/lib/starcall/errors/invalid_region.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Starcall
+  module Errors
+    # A Custom error message, used when an incorrect region is passed.
+    class InvalidRegion < StandardError
+      def initialize(region:)
+        super
+        @region = region
+      end
+
+      def message
+        "#{region} is not a valid region. Please consult Starcall::Regions.list for a list of valid regions."
+      end
+
+      private
+
+      attr_reader :region
+    end
+  end
+end

data/lib/starcall/helpers/region_parser.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require 'starcall/regions'
+
+module Starcall
+  module Helpers
+    # The API URLs don't use the actual region name, they used different ones.
+    # This converts from a region name to the URL string.
+    class RegionParser
+      def self.parse(region:)
+        Starcall::Regions.valid?(region: region)
+
+        region_matchup = {
+          br: 'br1',
+          eune: 'eun1',
+          euw: 'euw1',
+          lan: 'la1',
+          las: 'la2',
+          na: 'na1',
+          oce: 'oc1',
+          ru: 'ru',
+          tr: 'tr1',
+          jp: 'jp1',
+          kr: 'kr'
+        }
+        region_matchup[region.to_sym]
+      end
+    end
+  end
+end

data/lib/starcall/languages.rb

@@ -43,7 +43,7 @@ module Starcall
     def self.valid?(language:)
       return true if list.include? language
 
-      raise Starcall::Error::InvalidLanguage.new(language: language)
+      raise Starcall::Errors::InvalidLanguage.new(language: language)
     end
   end
 end

data/lib/starcall/regions.rb

@@ -24,7 +24,7 @@ module Starcall
     def self.valid?(region:)
       return true if list.include? region
 
-      raise Starcall::Error::InvalidRegion.new(region: region)
+      raise Starcall::Errors::InvalidRegion.new(region: region)
     end
   end
 end

data/lib/starcall/static_data.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'starcall/api_requests'
+
 module Starcall
   # This class is used for all things Static Data related.
   # Using Riots Static data and Data Dragon.
@@ -16,29 +18,29 @@ module Starcall
     # Season ids are used in match history to indicate which season a match was played.
     # A full list of season ids can be retrieved with the below method.
     def season_ids
-      ApiRequests.make_request(url: static_url(search_term: 'seasons'))
+      Starcall::ApiRequests.make_request(url: static_url(search_term: 'seasons'))
     end
 
     # Queue ids show up in several places throughout the API and are used to indicate which kind of match was played.
     # A full list of queue ids can be can be retrieved with the below method.
     def queue_ids
-      ApiRequests.make_request(url: static_url(search_term: 'queues'))
+      Starcall::ApiRequests.make_request(url: static_url(search_term: 'queues'))
     end
 
     # Map ids are used in match history to indicate which map a match was played.
     # A full list of map ids can be can be retrieved with the below method.
     def map_ids
-      ApiRequests.make_request(url: static_url(search_term: 'maps'))
+      Starcall::ApiRequests.make_request(url: static_url(search_term: 'maps'))
     end
 
     # A full list of game modes can be can be retrieved with the below method.
     def game_modes
-      ApiRequests.make_request(url: static_url(search_term: 'gameModes'))
+      Starcall::ApiRequests.make_request(url: static_url(search_term: 'gameModes'))
     end
 
     # A full list of game types can be can be retrieved with the below method.
     def game_types
-      ApiRequests.make_request(url: static_url(search_term: 'gameTypes'))
+      Starcall::ApiRequests.make_request(url: static_url(search_term: 'gameTypes'))
     end
 
     # All valid Data Dragon versions  can be can be retrieved with the below method.
@@ -47,39 +49,39 @@ module Starcall
     # This typically occurs when there's an error in the original build.
     # As such, you should always use the most recent Data Dragon version for a given patch for the best results.
     def dd_versions
-      ApiRequests.make_request(url: dd_versions_url)
+      Starcall::ApiRequests.make_request(url: dd_versions_url)
     end
 
     # Data Dragon versions aren't always equivalent to the League of Legends client version in a region.
     def dd_region_versions
-      ApiRequests.make_request(url: dd_region_version_url)
+      Starcall::ApiRequests.make_request(url: dd_region_version_url)
     end
 
     # This returns a list of all champion with a brief summary, including stats, id and blurb.
     def dd_champions
-      ApiRequests.make_request(url: dd_url(game_component: 'champion'))
+      Starcall::ApiRequests.make_request(url: dd_url(game_component: 'champion'))
     end
 
     # For me detailed and specific information about a champion, this call can be used.
     def dd_specific_champion(champion_name:)
-      ApiRequests.make_request(url: dd_specific_champion_url(champion_name: champion_name))
+      Starcall::ApiRequests.make_request(url: dd_specific_champion_url(champion_name: champion_name))
     end
 
     # Data Dragon also provides detail for every item in the game.
     # with this method you can find info such as the item's description, purchase value, sell value,
     # items it builds from, items it builds into, and stats granted from the item.
     def dd_items
-      ApiRequests.make_request(url: dd_url(game_component: 'item'))
+      Starcall::ApiRequests.make_request(url: dd_url(game_component: 'item'))
     end
 
     # Details about summoner spells.
     def dd_summoner_spells
-      ApiRequests.make_request(url: dd_url(game_component: 'summoner'))
+      Starcall::ApiRequests.make_request(url: dd_url(game_component: 'summoner'))
     end
 
     # Details about profile icons and where they can be found on the sprite sheets.
     def dd_profile_icons
-      ApiRequests.make_request(url: dd_url(game_component: 'profileicon'))
+      Starcall::ApiRequests.make_request(url: dd_url(game_component: 'profileicon'))
     end
 
     private
@@ -103,7 +105,7 @@ module Starcall
 
     # This gets the current version of specific game components, such as champions.
     def dd_current_data_version(game_component:)
-      ApiRequests.make_request(url: dd_region_version_url)['n'][game_component]
+      Starcall::ApiRequests.make_request(url: dd_region_version_url)['n'][game_component]
     end
 
     # This builds the data dragon url for specific components such as champions,

data/lib/starcall/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Starcall
-  VERSION = '0.2.1'
+  VERSION = '0.3.0'
 end

data/starcall.gemspec

@@ -30,6 +30,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'pry', '~> 0.13'
   spec.add_development_dependency 'rake', '~> 12.3'
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'rubocop', '~> 0.86'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: starcall
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Kelvin Samuel
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-06-28 00:00:00.000000000 Z
+date: 2020-06-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -114,7 +128,12 @@ files:
 - Rakefile
 - lib/starcall.rb
 - lib/starcall/api_requests.rb
-- lib/starcall/error.rb
+- lib/starcall/endpoints/champion_mastery_v4.rb
+- lib/starcall/endpoints/endpoints.rb
+- lib/starcall/errors/errors.rb
+- lib/starcall/errors/invalid_language.rb
+- lib/starcall/errors/invalid_region.rb
+- lib/starcall/helpers/region_parser.rb
 - lib/starcall/languages.rb
 - lib/starcall/regions.rb
 - lib/starcall/static_data.rb