starcall 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f5c6be068d4b17fb2fcabccb3cb99a186691e8e302936a88fedf1e8b33a86fb1
-  data.tar.gz: 59b75900fd12620bfc17afb5411869748a3739302d394634b21afa1441588071
+  metadata.gz: 747f4858cbdbfc589afaea575efb50a1ab13cb6b17ea4c8a00e7d8531372ff45
+  data.tar.gz: 7343bf8040d4a954f7f9c28724053bfad8d97ea4c145d1a028607b900d539bb3
 SHA512:
-  metadata.gz: db1d88e8c618b4572d65af78ce5ae0374267ef58da292abdc7a5ede1d7bb6c6317ee81a14b2d67aa890c08b16ddc60c2ffb9b82a48ce152384d09e9d0ef21e5c
-  data.tar.gz: ba5b2610e5cf5ce269023df02293e62c9ebfa715618e6746e97256e60a459bb4e830f83daf8e0a2fa6d97ad0e3c5664c290e848b75b68414006da32bb19634b2
+  metadata.gz: 7d648c379749197d1c35f5a18ffffa6661741a12b704cb1ca10ab27df84c81640c2f56650ee7feb32363276beb222a0bedec5806702a5dc0b19d6c66dad64e7f
+  data.tar.gz: cd19a5a3963fc1a6240877ebba5f2020c76165b56f12d9d887ee2d3a961c75ec70134252227626527b6b5be0844c951e037facf95a2ab92d5b44d22752db7d29

data/.github/workflows/tests.yaml

@@ -0,0 +1,20 @@
+env:
+  RUBY_VERSION: 2.6
+
+name: tests
+on: [push]
+jobs:
+  rubocop-and-rspec:
+    name: Rubocop and Rspec
+    runs-on: ubuntu-18.04
+    steps:
+      - uses: actions/checkout@v1
+      - uses: actions/setup-ruby@v1
+        with:
+          ruby-version: ${{ env.RUBY_VERSION }}
+      - name: Install dependencies
+        run: |
+          gem install bundler
+          bundle install
+      - name: Check code
+        run: bundle exec rake github:run

data/.rubocop.yml

@@ -7,7 +7,10 @@ Layout/LineLength:
   Max: 120
 
 Metrics/BlockLength:
-  Max: 150
+  ExcludedMethods: ['let', 'describe', 'context']
+
+Metrics/MethodLength:
+  Max: 15
 
 Layout/SpaceAroundMethodCallOperator:
   Enabled: true

data/CHANGELOG.md

@@ -0,0 +1,52 @@
+# Change log
+
+## master (unreleased)
+
+### New features
+None
+
+### Changes
+None
+
+### Bug fixes 
+None
+
+---
+
+## v0.2.0 - Ahri
+![Aatrox](http://ddragon.leagueoflegends.com/cdn/10.12.1/img/champion/Ahri.png)
+
+### New features
+- Regions
+    - `Starcall::Regions.list` for a full list of supported regions.
+    - Static data that can change per region and now supports different regions.
+    
+- Languages
+    - `Starcall::Languages.list` for a full list of supported languages.
+    - Static data comes in different languages and now supports different languages.
+
+### Changes
+- `Starcall::StaticData` now needs to be initialised. Can be initialised with a region and a language.
+If none is supplied, `euw` and `en_GB` is assumed.
+- `dd_euw_versions` has now become `dd_region_versions` defaulting to `euw` if no region has been supplied.
+- Errors
+    - An error module has now been created where custom errors will be stored.
+
+### Bug fixes 
+None
+
+---
+
+## v0.1.1 - Aatrox
+![Aatrox](http://ddragon.leagueoflegends.com/cdn/10.12.1/img/champion/Aatrox.png)
+
+### New features
+- Riot API static endpoints
+
+### Changes
+None
+
+### Bug fixes 
+None
+
+-----

data/Gemfile.lock

@@ -1,68 +1,68 @@
-PATH
-  remote: .
-  specs:
-    starcall (0.1.1)
-      httparty (~> 0.17)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    ast (2.4.1)
-    diff-lcs (1.3)
-    httparty (0.18.1)
-      mime-types (~> 3.0)
-      multi_xml (>= 0.5.2)
-    mime-types (3.3.1)
-      mime-types-data (~> 3.2015)
-    mime-types-data (3.2020.0512)
-    multi_xml (0.6.0)
-    parallel (1.19.2)
-    parser (2.7.1.4)
-      ast (~> 2.4.1)
-    rainbow (3.0.0)
-    rake (12.3.3)
-    regexp_parser (1.7.1)
-    rexml (3.2.4)
-    rspec (3.9.0)
-      rspec-core (~> 3.9.0)
-      rspec-expectations (~> 3.9.0)
-      rspec-mocks (~> 3.9.0)
-    rspec-core (3.9.2)
-      rspec-support (~> 3.9.3)
-    rspec-expectations (3.9.2)
-      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.3)
-    rubocop (0.86.0)
-      parallel (~> 1.10)
-      parser (>= 2.7.0.1)
-      rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.7)
-      rexml
-      rubocop-ast (>= 0.0.3, < 1.0)
-      ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 2.0)
-    rubocop-ast (0.0.3)
-      parser (>= 2.7.0.1)
-    rubocop-rspec (1.40.0)
-      rubocop (>= 0.68.1)
-    ruby-progressbar (1.10.1)
-    unicode-display_width (1.7.0)
-
-PLATFORMS
-  ruby
-  x64-mingw32
-
-DEPENDENCIES
-  bundler (~> 2.0)
-  rake (~> 12.3)
-  rspec (~> 3.0)
-  rubocop (~> 0.86)
-  rubocop-rspec (~> 1.40)
-  starcall!
-
-BUNDLED WITH
-   2.0.2
+PATH
+  remote: .
+  specs:
+    starcall (0.2.0)
+      httparty (~> 0.17)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.1)
+    diff-lcs (1.3)
+    httparty (0.18.1)
+      mime-types (~> 3.0)
+      multi_xml (>= 0.5.2)
+    mime-types (3.3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2020.0512)
+    multi_xml (0.6.0)
+    parallel (1.19.2)
+    parser (2.7.1.4)
+      ast (~> 2.4.1)
+    rainbow (3.0.0)
+    rake (12.3.3)
+    regexp_parser (1.7.1)
+    rexml (3.2.4)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      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.3)
+    rubocop (0.86.0)
+      parallel (~> 1.10)
+      parser (>= 2.7.0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.7)
+      rexml
+      rubocop-ast (>= 0.0.3, < 1.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (0.0.3)
+      parser (>= 2.7.0.1)
+    rubocop-rspec (1.40.0)
+      rubocop (>= 0.68.1)
+    ruby-progressbar (1.10.1)
+    unicode-display_width (1.7.0)
+
+PLATFORMS
+  ruby
+  x64-mingw32
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  rake (~> 12.3)
+  rspec (~> 3.0)
+  rubocop (~> 0.86)
+  rubocop-rspec (~> 1.40)
+  starcall!
+
+BUNDLED WITH
+   2.0.2

data/README.md

@@ -1,8 +1,9 @@
 ![starcall](starcall.png)
 
 ----
-[![Build Status](https://travis-ci.com/kks110/starcall.svg?branch=master)](https://travis-ci.com/kks110/starcall)
-
+![Build Status](https://img.shields.io/github/workflow/status/kks110/starcall/tests/master)
+![Gem Version](https://img.shields.io/gem/v/starcall)
+![Downloads](https://img.shields.io/gem/dt/starcall)
 ---
 A Gem to help with calls to Riot API.
 
@@ -23,11 +24,41 @@ Or install it yourself as:
 
 ## Usage
 
+### Regions
+Sometimes, due to manual upload speeds, versions in different regions might be different or due to things like version specific bugs.
+Due to this, if you are looking for details of a specific region, it worth checking there rather than generically.
+
+A full list of supported regions can be obtained by running:
+```ruby
+Starcall::Regions.list
+```
+
+### Languages
+Things such as champion data is avalible in different languages.
+
+A full list of supported languages can be obtained by running:
+```ruby
+Starcall::Languages.list
+```
+
+
 ### Static Queries
 
-You can call any of the below methods like:
+First you need to initialise and instance of Starcall::StaticData
+```ruby
+static_data = Starcall::StaticData.new
+```
+
+Some of the queries below can return different data based on the region. When you initialize the class, you can pass in a valid region.
+Regions that Riot support can be queried as per the Regions section above.
+If no region is supplied, 'euw' will be assumed.
+
+Some of the queries below can be returned in different languages.
+Languages that Riot support can be queried as per the Languages section above.
+If no language is supplied, 'en_GB' (English Great Britain) will be assumed.
+
 ```ruby
-Starcall::StaticData.season_ids
+Starcall::StaticData.new(region: 'kr', language: 'ko_KR')
 ```
 
 #### `season_ids`
@@ -52,7 +83,7 @@ A full list of game types can be can be retrieved with the below method.
 #### Data Dragon
 Data Dragon is Riots way of centralizing League of Legends game data and assets, including champions, items, runes, summoner spells, and profile icons. 
 All of which can be used by third-party developers. 
-Please be aware that Riot update Data Dragon after each League of Legends manualy, so it is not always updated immediately after a patch.
+Please be aware that Riot update Data Dragon after each League of Legends manually, so it is not always updated immediately after a patch.
 
 #### `dd_versions`
 All valid Data Dragon versions  can be can be retrieved with the below method.
@@ -61,28 +92,32 @@ however occasionally there will be additional builds.
 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.
 
-#### `dd_euw_versions`
+#### `dd_region_versions`
+
 Data Dragon versions aren't always equivalent to the League of Legends client version in a region.
 You can find the version each region is using via the realms files.
-This function returns the EWU versions
 
 #### `dd_champions`
+
 This returns a list of all champion with a brief summary, including stats, id and blurb.
 
 #### `dd_specific_champion(champion_name:)`
-For me detailed and specific information about a champion, this call can be used.
+
+For more detailed and specific information about a champion, this call can be used.
 
 #### `dd_items`
+
 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.
 
 #### `dd_summoner_spells`
+
 Details about summoner spells.
 
 #### `dd_profile_icons`
-Details about profile icons and where they can be found on the sprite sheets.
 
+Details about profile icons and where they can be found on the sprite sheets.
 
 ## Development
 

data/Rakefile

@@ -9,7 +9,7 @@ RSpec::Core::RakeTask.new(:spec)
 
 RuboCop::RakeTask.new
 
-namespace :travis do
+namespace :github do
   desc 'Run rspec and rubocop'
   travis_tasks = %w[spec rubocop]
   task :run do

data/lib/starcall/error.rb

@@ -0,0 +1,37 @@
+# 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
+
+    # A Custom error message, used when an incorrect language is passed.
+    class InvalidLanguage < StandardError
+      def initialize(language:)
+        super
+        @language = language
+      end
+
+      def message
+        "#{language} is not a valid language. Please consult Starcall::Languages.list for a list of valid languages."
+      end
+
+      private
+
+      attr_reader :language
+    end
+  end
+end

data/lib/starcall/languages.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require 'starcall/error'
+
+module Starcall
+  # This class is used to list and validate languages.
+  class Languages
+    # A list of valid Riot Languages.
+    # rubocop:disable Metrics/MethodLength
+    def self.list
+      [
+        'cs_CZ',	# Czech (Czech Republic)
+        'el_GR',	# Greek (Greece)
+        'pl_PL',	# Polish (Poland)
+        'ro_RO',	# Romanian (Romania)
+        'hu_HU',	# Hungarian (Hungary)
+        'en_GB',	# English (United Kingdom)
+        'de_DE',	# German (Germany)
+        'es_ES',	# Spanish (Spain)
+        'it_IT',	# Italian (Italy)
+        'fr_FR',	# French (France)
+        'ja_JP',	# Japanese (Japan)
+        'ko_KR',	# Korean (Korea)
+        'es_MX',	# Spanish (Mexico)
+        'es_AR',	# Spanish (Argentina)
+        'pt_BR',	# Portuguese (Brazil)
+        'en_US',	# English (United States)
+        'en_AU',	# English (Australia)
+        'ru_RU',	# Russian (Russia)
+        'tr_TR',	# Turkish (Turkey)
+        'ms_MY',	# Malay (Malaysia)
+        'en_PH',	# English (Republic of the Philippines)
+        'en_SG',	# English (Singapore)
+        'th_TH',	# Thai (Thailand)
+        'vn_VN',	# Vietnamese (Viet Nam)
+        'id_ID',	# Indonesian (Indonesia)
+        'zh_MY',	# Chinese (Malaysia)
+        'zh_CN',	# Chinese (China)
+        'zh_TW'	# Chinese (Taiwan)
+      ]
+    end
+    # rubocop:enable Metrics/MethodLength
+
+    # A method to check is the language is valid, if not, raise an error.
+    def self.valid?(language:)
+      return true if list.include? language
+
+      raise Starcall::Error::InvalidLanguage.new(language: language)
+    end
+  end
+end

data/lib/starcall/regions.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require 'starcall/error'
+
+module Starcall
+  # This class is used to list and validate regions.
+  class Regions
+    # A list of valid Riot Regions.
+    def self.list
+      [
+        'br',   # Brazil
+        'eune', # EU North East
+        'euw',  # EU West
+        'lan',  # Latin America North
+        'las',  # Latin America South
+        'na',   # North America
+        'oce',  # Oceania
+        'ru',   # Russia
+        'tr',   # Turkey
+        'jp',   # Japan
+        'kr'    # Korea
+      ]
+    end
+
+    # A method to check is the region is valid, if not, raise an error.
+    def self.valid?(region:)
+      return true if list.include? region
+
+      raise Starcall::Error::InvalidRegion.new(region: region)
+    end
+  end
+end

data/lib/starcall/static_data.rb

@@ -1,36 +1,47 @@
 # frozen_string_literal: true
 
 require 'starcall/api_requests'
+require 'starcall/regions'
+require 'starcall/languages'
 
 module Starcall
   # This class is used for all things Static Data related.
   # Using Riots Static data and Data Dragon.
   class StaticData
+    # Initialize the class with a region, if none is supplied, EUW will be assumed.
+    def initialize(region: 'euw', language: 'en_GB')
+      Starcall::Regions.valid?(region: region)
+      Starcall::Languages.valid?(language: language)
+
+      @region = region
+      @language = language
+    end
+
     # 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 self.season_ids
+    def season_ids
       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 self.queue_ids
+    def queue_ids
       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 self.map_ids
+    def map_ids
       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 self.game_modes
+    def game_modes
       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 self.game_types
+    def game_types
       ApiRequests.make_request(url: static_url(search_term: 'gameTypes'))
     end
 
@@ -39,83 +50,79 @@ module Starcall
     # however occasionally there will be additional builds.
     # 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 self.dd_versions
+    def dd_versions
       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.
-    # You can find the version each region is using via the realms files.
-    def self.dd_euw_versions
-      ApiRequests.make_request(url: dd_euw_specific_version_url)
+    def dd_region_versions
+      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 self.dd_champions
+    def dd_champions
       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 self.dd_specific_champion(champion_name:)
+    def dd_specific_champion(champion_name:)
       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 self.dd_items
+    def dd_items
       ApiRequests.make_request(url: dd_url(game_component: 'item'))
     end
 
     # Details about summoner spells.
-    def self.dd_summoner_spells
+    def dd_summoner_spells
       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 self.dd_profile_icons
+    def dd_profile_icons
       ApiRequests.make_request(url: dd_url(game_component: 'profileicon'))
     end
 
+    private
+
+    attr_reader :region, :language
+
     # This help build the static data url for thins such as map ids.
-    def self.static_url(search_term:)
+    def static_url(search_term:)
       "http://static.developer.riotgames.com/docs/lol/#{search_term}.json"
     end
 
     # This is the data dragon version URL
-    def self.dd_versions_url
+    def dd_versions_url
       'https://ddragon.leagueoflegends.com/api/versions.json'
     end
 
     # This is the specific EUW data dragon version URL.
-    def self.dd_euw_specific_version_url
-      'https://ddragon.leagueoflegends.com/realms/euw.json'
+    def dd_region_version_url
+      "https://ddragon.leagueoflegends.com/realms/#{region}.json"
     end
 
     # This gets the current version of specific game components, such as champions.
-    def self.dd_current_data_version(game_component:)
-      ApiRequests.make_request(url: dd_euw_specific_version_url)['n'][game_component]
+    def dd_current_data_version(game_component:)
+      ApiRequests.make_request(url: dd_region_version_url)['n'][game_component]
     end
 
     # This builds the data dragon url for specific components such as champions,
     # using the above method to get the version.
-    def self.dd_url(game_component:)
+    def dd_url(game_component:)
       'http://ddragon.leagueoflegends.com/cdn/'\
-      "#{dd_current_data_version(game_component: game_component)}/data/en_GB/"\
+      "#{dd_current_data_version(game_component: game_component)}/data/#{language}/"\
       "#{game_component}.json"
     end
 
     # This builds the data dragon url for a specific champion.
-    def self.dd_specific_champion_url(champion_name:)
+    def dd_specific_champion_url(champion_name:)
       'http://ddragon.leagueoflegends.com/cdn/'\
       "#{dd_current_data_version(game_component: 'champion')}"\
-      "/data/en_GB/champion/#{champion_name}.json"
+      "/data/#{language}/champion/#{champion_name}.json"
     end
-
-    private_class_method :static_url,
-                         :dd_versions_url,
-                         :dd_euw_specific_version_url,
-                         :dd_current_data_version,
-                         :dd_url,
-                         :dd_specific_champion_url
   end
 end

data/lib/starcall/version.rb

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

data/starcall.gemspec

@@ -17,7 +17,7 @@ Gem::Specification.new do |spec|
 
   spec.metadata['homepage_uri'] = spec.homepage
   spec.metadata['source_code_uri'] = 'https://github.com/kks110/starcall'
-  spec.metadata['changelog_uri'] = 'https://github.com/kks110/starcall'
+  spec.metadata['changelog_uri'] = 'https://github.com/kks110/starcall/blob/master/CHANGELOG.md'
 
   # 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.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: starcall
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Kelvin Samuel
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-06-25 00:00:00.000000000 Z
+date: 2020-06-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -102,10 +102,11 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/tests.yaml"
 - ".gitignore"
 - ".rakeTasks"
 - ".rubocop.yml"
-- ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -113,6 +114,9 @@ files:
 - Rakefile
 - lib/starcall.rb
 - lib/starcall/api_requests.rb
+- lib/starcall/error.rb
+- lib/starcall/languages.rb
+- lib/starcall/regions.rb
 - lib/starcall/static_data.rb
 - lib/starcall/version.rb
 - starcall.gemspec
@@ -123,7 +127,7 @@ licenses:
 metadata:
   homepage_uri: https://github.com/kks110/starcall
   source_code_uri: https://github.com/kks110/starcall
-  changelog_uri: https://github.com/kks110/starcall
+  changelog_uri: https://github.com/kks110/starcall/blob/master/CHANGELOG.md
 post_install_message: 
 rdoc_options: []
 require_paths:

data/.travis.yml

@@ -1,6 +0,0 @@
-language: ruby
-cache: bundler
-rvm:
-  - 2.6.5
-script:
-  - bundle exec rake travis:run