starcall 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f5c6be068d4b17fb2fcabccb3cb99a186691e8e302936a88fedf1e8b33a86fb1
+  data.tar.gz: 59b75900fd12620bfc17afb5411869748a3739302d394634b21afa1441588071
+SHA512:
+  metadata.gz: db1d88e8c618b4572d65af78ce5ae0374267ef58da292abdc7a5ede1d7bb6c6317ee81a14b2d67aa890c08b16ddc60c2ffb9b82a48ce152384d09e9d0ef21e5c
+  data.tar.gz: ba5b2610e5cf5ce269023df02293e62c9ebfa715618e6746e97256e60a459bb4e830f83daf8e0a2fa6d97ad0e3c5664c290e848b75b68414006da32bb19634b2

data/.gitignore

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

data/.rakeTasks

@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<Settings><!--This file was automatically generated by Ruby plugin.
+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>

data/.rubocop.yml

@@ -0,0 +1,52 @@
+AllCops:
+  Exclude:
+    - 'bin/*'
+    - 'vendor/**/*'
+
+Layout/LineLength:
+  Max: 120
+
+Metrics/BlockLength:
+  Max: 150
+
+Layout/SpaceAroundMethodCallOperator:
+  Enabled: true
+
+Lint/RaiseException:
+  Enabled: true
+
+Lint/StructNewOverride:
+  Enabled: true
+
+Style/ExponentialNotation:
+  Enabled: true
+
+Style/HashEachMethods:
+  Enabled: true
+
+Style/HashTransformKeys:
+  Enabled: true
+
+Style/HashTransformValues:
+  Enabled: true
+
+Layout/EmptyLinesAroundAttributeAccessor:
+  Enabled: true
+
+Lint/DeprecatedOpenSSLConstant:
+  Enabled: true
+
+Lint/MixedRegexpCaptureTypes:
+  Enabled: true
+
+Style/RedundantFetchBlock:
+  Enabled: true
+
+Style/RedundantRegexpCharacterClass:
+  Enabled: true
+
+Style/RedundantRegexpEscape:
+  Enabled: true
+
+Style/SlicingWithRange:
+  Enabled: true

data/.travis.yml

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

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in starcall.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Kelvin Samuel
+
+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,101 @@
+![starcall](starcall.png)
+
+----
+[![Build Status](https://travis-ci.com/kks110/starcall.svg?branch=master)](https://travis-ci.com/kks110/starcall)
+
+---
+A Gem to help with calls to Riot API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'starcall'
+
+
+And then execute:
+
+    bundle
+
+Or install it yourself as:
+
+    gem install starcall
+
+## Usage
+
+### Static Queries
+
+You can call any of the below methods like:
+```ruby
+Starcall::StaticData.season_ids
+```
+
+#### `season_ids`
+
+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.
+
+#### `queue_ids`
+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.
+
+#### `map_ids`
+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.
+
+#### `game_modes`
+A full list of game modes can be can be retrieved with the below method.
+
+#### `game_types`
+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.
+
+#### `dd_versions`
+All valid Data Dragon versions  can be can be retrieved with the below method.
+Typically there's only a single build of Data Dragon for a given patch,
+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`
+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.
+
+#### `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.
+
+
+## Development
+
+After checking out the repo, run `bundle install` to install dependencies. 
+
+To run the test suite, you can run `bundle exec rake spec`.
+
+To run rubocop, you can run `bundle exec rake rubocop`.
+
+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).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require 'English'
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+RuboCop::RakeTask.new
+
+namespace :travis do
+  desc 'Run rspec and rubocop'
+  travis_tasks = %w[spec rubocop]
+  task :run do
+    travis_tasks.each do |task|
+      puts "Starting to run #{task}..."
+      system("bundle exec rake #{task}")
+      raise "#{task} failed!" unless $CHILD_STATUS.exitstatus.zero?
+    end
+  end
+end

data/lib/starcall.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require 'starcall/version'
+
+module Starcall
+  class Error < StandardError; end
+end

data/lib/starcall/api_requests.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+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
+  end
+end

data/lib/starcall/static_data.rb

@@ -0,0 +1,121 @@
+# 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.
+  class StaticData
+    # 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
+      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
+      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
+      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
+      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
+      ApiRequests.make_request(url: static_url(search_term: 'gameTypes'))
+    end
+
+    # All valid Data Dragon versions  can be can be retrieved with the below method.
+    # Typically there's only a single build of Data Dragon for a given patch,
+    # 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
+      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)
+    end
+
+    # This returns a list of all champion with a brief summary, including stats, id and blurb.
+    def self.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:)
+      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
+      ApiRequests.make_request(url: dd_url(game_component: 'item'))
+    end
+
+    # Details about summoner spells.
+    def self.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
+      ApiRequests.make_request(url: dd_url(game_component: 'profileicon'))
+    end
+
+    # This help build the static data url for thins such as map ids.
+    def self.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
+      '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'
+    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]
+    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:)
+      'http://ddragon.leagueoflegends.com/cdn/'\
+      "#{dd_current_data_version(game_component: game_component)}/data/en_GB/"\
+      "#{game_component}.json"
+    end
+
+    # This builds the data dragon url for a specific champion.
+    def self.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"
+    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

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

data/starcall.gemspec

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'starcall/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'starcall'
+  spec.version       = Starcall::VERSION
+  spec.authors       = ['Kelvin Samuel']
+  spec.email         = ['kelvin@kks110.com']
+
+  spec.summary       = 'A Helper Gem for calling Riots API'
+  spec.description   = 'You can use this gem to call Riot Games API without having to write the requests yourself.'
+  spec.homepage      = 'https://github.com/kks110/starcall'
+  spec.license       = 'MIT'
+
+  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'
+
+  # 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(__dir__)) 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', '~> 12.3'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 0.86'
+  spec.add_development_dependency 'rubocop-rspec', '~> 1.40'
+
+  spec.add_runtime_dependency 'httparty', '~> 0.17'
+end

metadata

@@ -0,0 +1,146 @@
+--- !ruby/object:Gem::Specification
+name: starcall
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Kelvin Samuel
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-06-25 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: '12.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.86'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.86'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.40'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.40'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.17'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.17'
+description: You can use this gem to call Riot Games API without having to write the
+  requests yourself.
+email:
+- kelvin@kks110.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rakeTasks"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/starcall.rb
+- lib/starcall/api_requests.rb
+- lib/starcall/static_data.rb
+- lib/starcall/version.rb
+- starcall.gemspec
+- starcall.png
+homepage: https://github.com/kks110/starcall
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/kks110/starcall
+  source_code_uri: https://github.com/kks110/starcall
+  changelog_uri: https://github.com/kks110/starcall
+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: A Helper Gem for calling Riots API
+test_files: []