valorant 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9a36f9f5ee4cd08482186eb82e1b4832f942c482d65ef3b3acb059d1377d1c96
+  data.tar.gz: 4ed8029b401abbfae509c107de62784083f4194b9c4da01808ae55f1c2b834dd
+SHA512:
+  metadata.gz: b199bceb9378e2a15ab30e5400aa884a0fe709f44720a62367ea1f699d6344a6dfa87168bd5b7224d6d1f59c379459af3308d029f1b94674eb7ffc9e1923de29
+  data.tar.gz: e8da10bb9ec1cdfffd79ab75e4e91d3c0dc6a1dcaeccc820ef5681b08a3dc11ca5932e5f75cc1b50b10b17f965d5f3ff418441554814d6c7e93a37b76209fe69

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2022-11-16
+
+- Initial release

data/Gemfile

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in valorant-api.gemspec
+gemspec
+
+gem 'rake', '~> 13.0'
+
+gem 'rspec', '~> 3.0'
+
+gem 'rubocop', '~> 1.21'
+
+gem 'fast_jsonparser'
+
+gem 'rest-client'
+
+gem 'date'

data/README.md

@@ -0,0 +1,29 @@
+# Valorant
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/valorant`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add valorant
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install valorant
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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 the created tag, 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/[USERNAME]/valorant.

data/Rakefile

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+require 'rubocop/rake_task'
+
+desc 'Look for style guide offenses in your code'
+task :rubocop do
+  sh 'rubocop lib/ --format simple || true'
+end
+
+desc 'Look for style guide offenses in your code and fix them.'
+task :rubofix do
+  sh 'rubocop lib/ --fix --format simple || true'
+end
+
+desc 'Install required gems'
+task :install do
+  sh 'bundle install'
+end
+
+task :console do
+  sh 'bin/console'
+end
+
+task default: %i[spec rubocop]

data/bin/console

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

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require_relative 'utils/user'
+require_relative 'utils/utilities'
+
+module Valorant
+  # This class is used to fetch data from the Valorant API -> ENDPOINT: /account
+  class AccountStats
+    def self.account_data(name, tag)
+      User.new(fetch_resposne("v1/account/#{name}/#{tag}"))
+    end
+  end
+end

data/lib/valorant/match.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require_relative 'utils/match'
+require_relative 'utils/matches_history'
+require_relative 'utils/utilities'
+
+module Valorant
+  # This class is used to fetch data from the Valorant API -> ENDPOINTS: /match, /matches
+  class MatchStats
+    def self.match_data(match_id)
+      Match.new(fetch_resposne("v2/match/#{match_id}"))
+    end
+
+    def self.matches_history(name, tag, region = 'eu', filter: '')
+      MatcheshHistory.new(fetch_resposne("v3/matches/#{region}/#{name}/#{tag}?filter=#{validate_filter(filter)}"))
+    end
+
+    def self.matches_history_by_puuid(puuid, region = 'eu', filter: '')
+      MatcheshHistory.new(fetch_resposne("v3/by-puuid/matches/#{region}/#{puuid}?filter=#{validate_filter(filter)}"))
+    end
+  end
+end

data/lib/valorant/misc.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require_relative 'utils/articles'
+require_relative 'utils/leader_board'
+require_relative 'utils/utilities'
+
+module Valorant
+  # This class is used to fetch data from the Valorant API -> ENDPOINTS: /v1/website/, /v1/leaderboard/,
+  # v1/content/, v1/status/
+  class Misc
+    def self.articles(filter = '', locale = 'en-us')
+      Articles.new(fetch_resposne("v1/website/#{validate_locale(locale)}?filter=#{validate_filter(filter)}"))
+    end
+
+    def self.leader_board(region = 'eu', name = '', tag = '')
+      LeaderBoard.new(fetch_resposne("v1/leaderboard/#{region}?name=#{name}&tag=#{tag}", validate: false))
+    end
+
+    def self.content
+      fetch_resposne('v1/content')
+    end
+
+    def self.server_status(region)
+      fetch_resposne("v1/status/#{region}")['data'].transform_keys(&:to_sym)
+    end
+  end
+end

data/lib/valorant/mmr.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require_relative 'utils/mmr_v1'
+require_relative 'utils/mmr_history'
+require_relative 'utils/utilities'
+
+module Valorant
+  # This class is used to fetch data from the Valorant API -> ENDPOINTS: /mmr, /by-puuid/mmr/,
+  # v1/mmr-history/, v1/by-puuid/mmr-history/
+  class MMRStats
+    def self.mmr_data(name, tag, region = 'eu', version: 'v1')
+      MMRV1.new(fetch_resposne("#{version}/mmr/#{region}/#{name}/#{tag}"))
+    end
+
+    def self.mmr_data_by_puuid(puuid, region = 'eu', version: 'v1')
+      MMRV1.new(fetch_resposne("#{version}/by-puuid/mmr/#{region}/#{puuid}"))
+    end
+
+    def self.mmr_history(name, tag, region = 'eu')
+      MMRHistory.new(fetch_resposne("v1/mmr-history/#{region}/#{name}/#{tag}"))
+    end
+
+    def self.mmr_history_by_puuid(puuid, region = 'eu')
+      MMRHistory.new(fetch_resposne("v1/by-puuid/mmr-history/#{region}/#{puuid}"))
+    end
+  end
+end

data/lib/valorant/utils/article.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'date'
+# This class is used to get the data for web articles.
+class Article
+  attr_reader :banner_url, :category, :date, :external_link, :title, :url
+
+  def initialize(data)
+    @banner_url = data['banner_url']
+    @category = data['category']
+    @date = Date.parse(data['date'])
+    @external_link = data['external_link']
+    @title = data['title']
+    @url = data['url']
+  end
+end

data/lib/valorant/utils/articles.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require_relative 'article'
+# This class is used to store the data for web articles.
+class Articles
+  attr_reader :articles
+
+  def initialize(hash)
+    data = hash['data']
+    @articles = data.each_with_object([]) do |article, arr|
+      arr << Article.new(article)
+    end
+  end
+end

data/lib/valorant/utils/leader.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+# Leader class
+class Leader
+  attr_accessor :leader_board_rank, :ranked_rating, :number_of_wins, :comptetitive_tier, :puuid, :game_name,
+                :tag_line, :player_card_id, :title_id, :is_banned, :is_anonymized
+
+  def initialize(data)
+    @leader_board_rank = data['leaderboardRank']
+    @ranked_rating = data['rankedRating']
+    @number_of_wins = data['numberOfWins']
+    @comptetitive_tier = data['competitiveTier']
+    fetch_player_data(data)
+  end
+
+  def fetch_player_data(data)
+    @puuid = data['puuid']
+    @game_name = data['gameName']
+    @tag_line = data['tagLine']
+    @player_card_id = data['PlayerCardID']
+    @title_id = data['TitleID']
+    @is_banned = data['IsBanned']
+    @is_anonymized = data['IsAnonymized']
+  end
+end
+
+# DOCUMENTATION
+
+# @PlayerCardID
+# @TitleID
+# @IsBanned
+# @IsAnonymized
+# @puuid
+# @gameName
+# @tagLine
+# @leaderboardRank
+# @rankedRating
+# @numberOfWins
+# @competitiveTier

data/lib/valorant/utils/leader_board.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require_relative 'leader'
+# Leaderboard class
+class LeaderBoard
+  def initialize(data)
+    @board = data
+    leaders
+  end
+
+  def leaders
+    @board.map { |leader| Leader.new(leader) }
+  end
+end

data/lib/valorant/utils/match.rb

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+require_relative 'player'
+
+# This class is used to get the data from a match
+class Match
+  attr_reader :game_version, :game_start_patched, :season_id, :platform, :region,
+              :cluster, :map, :mode, :queue, :rounds_played, :matchid, :game_length,
+              :game_start, :winning_team, :red_rounds_won, :red_rounds_lost,
+              :blue_rounds_won, :blue_rounds_lost, :red_team, :blue_team, :all_players
+
+  def initialize(data)
+    @meta_data = data['data']['metadata']
+    @player_data = data['data']['players']
+    @team_data = data['data']['teams']
+
+    fetch_game_info
+    fetch_game_type
+    fetch_game_statistics
+
+    fetch_players
+  end
+
+  def mvp
+    @all_players.max_by(&:score)
+  end
+
+  def mvp_red
+    @red_team.max_by(&:score)
+  end
+
+  def mvp_blue
+    @blue_team.max_by(&:score)
+  end
+
+  def fetch_game_info
+    @game_version = @meta_data['game_version']
+    @game_start_patched = @meta_data['game_start_patched']
+    @season_id = @meta_data['season_id']
+    @platform = @meta_data['platform']
+    @region = @meta_data['region']
+    @cluster = @meta_data['cluster']
+  end
+
+  def fetch_game_type
+    @map = @meta_data['map']
+    @mode = @meta_data['mode']
+    @queue = @meta_data['queue']
+  end
+
+  def fetch_game_statistics
+    @rounds_played = @meta_data['rounds_played']
+    @matchid = @meta_data['matchid']
+    @game_length = @meta_data['game_length']
+    @game_start = @meta_data['game_start']
+  end
+
+  def fetch_players
+    fetch_all_players
+
+    return if @queue == 'Deathmatch'
+
+    fetch_red_team
+    fetch_blue_team
+    fetch_team_stats
+  end
+
+  def fetch_team_stats
+    @winning_team = @team_data['red']['has_won'] ? 'red' : 'blue'
+    @red_rounds_won = @team_data['red']['rounds_won']
+    @red_rounds_lost = @team_data['red']['rounds_lost']
+    @blue_rounds_won = @team_data['blue']['rounds_won']
+    @blue_rounds_lost = @team_data['blue']['rounds_lost']
+  end
+
+  def fetch_red_team
+    red_team = @player_data['red']
+    @red_team = []
+    red_team.each do |player|
+      @red_team << Player.new(player)
+    end
+  end
+
+  def fetch_blue_team
+    blue_team = @player_data['blue']
+    @blue_team = []
+    blue_team.each do |player|
+      @blue_team << Player.new(player)
+    end
+  end
+
+  def fetch_all_players
+    @all_players = @player_data['all_players'].each_with_object([]) do |player, array|
+      array << Player.new(player)
+    end
+  end
+end

data/lib/valorant/utils/matches_history.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require_relative 'match'
+
+# This class is used to get the data from the match history
+class MatcheshHistory
+  attr_reader :matches
+
+  def initialize(hash)
+    @matches = fetch_matches(hash['data'])
+  end
+
+  private
+
+  def fetch_matches(matches_json)
+    matches_json.each_with_object([]) do |match, arr|
+      reformated_data = { 'data' => match }
+      arr << Match.new(reformated_data)
+    end
+  end
+end

data/lib/valorant/utils/mmr_history.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require_relative 'mmr_v1'
+
+# This class is used to get the data from the mmr history
+class MMRHistory
+  attr_reader :data
+
+  def initialize(hash)
+    @data = fetch_mmr_v1(hash['data'])
+  end
+
+  private
+
+  def fetch_mmr_v1(mmr_v1_json)
+    mmr_v1_json.each_with_object([]) do |mmr_v1, arr|
+      reformated_data = { 'data' => mmr_v1 }
+      arr << MMRV1.new(reformated_data)
+    end
+  end
+end

data/lib/valorant/utils/mmr_v1.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require 'date'
+
+# This class is used to get the @data from MMR
+class MMRV1
+  attr_reader :currenttier, :currenttierpatched, :images, :ranking_in_tier, :mmr_change_to_last_game, :elo, :name,
+              :tag, :old, :date
+
+  def initialize(hash)
+    @data = hash['data']
+    @currenttier = @data['currenttier']
+    @currenttierpatched = @data['currenttierpatched']
+    @images = @data['images']
+    @ranking_in_tier = @data['ranking_in_tier']
+    @mmr_change_to_last_game = @data['mmr_change_to_last_game']
+    @elo = @data['elo']
+    @old = @data['old']
+    fetch_date
+    fetch_nametag
+  end
+
+  private
+
+  def fetch_date
+    @date = if @data['date'].nil?
+              Time.now
+            else
+              Date.parse(@data['date'])
+            end
+  end
+
+  def fetch_nametag
+    @name = @data['name']
+    @tag = @data['tag']
+  end
+end

data/lib/valorant/utils/player.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+# This class is used to get the data from the player
+class Player
+  attr_reader :puuid, :name, :tag, :team, :level, :character, :currenttier, :currenttier_patched, :party_id,
+              :player_card, :player_title, :assets_card, :assets_agent, :session_playtime, :behavior, :ability_casts,
+              :score, :kills, :deaths, :assists, :bodyshots, :headshots, :legshots, :spent_overall, :spent_average,
+              :damage_made, :damage_received
+
+  def initialize(data)
+    @data = data
+
+    fetch_general_data
+    fetch_aesthetics_data
+    fetch_session_data
+    fetch_performance_data
+    fetch_economy_data
+    fetch_damage_data
+  end
+
+  def name_tag
+    "#{@name} ##{@tag}"
+  end
+
+  def kd
+    (@kills.to_f / @deaths).round(2)
+  end
+
+  private
+
+  def fetch_general_data
+    @puuid = @data['puuid']
+    @name = @data['name']
+    @tag = @data['tag']
+    @team = @data['team']
+    @level = @data['level']
+    @character = @data['character']
+    @currenttier = @data['currenttier']
+    @currenttier_patched = @data['currenttier_patched']
+    @party_id = @data['party_id']
+  end
+
+  def fetch_aesthetics_data
+    @player_card = @data['player_card']
+    @player_title = @data['player_title']
+    @assets_card = keys_to_sim(@data['assets']['card']) # This is a hash
+    @assets_agent = keys_to_sim(@data['assets']['agent']) # This is a hash
+  end
+
+  def fetch_session_data
+    @session_playtime = @data['session_playtime']['seconds'].to_i
+    @behavior = keys_to_sim(@data['behavior']) # This is a hash
+    @ability_casts = keys_to_sim(@data['ability_casts']) # This is a hash
+  end
+
+  def fetch_performance_data
+    @score = @data['stats']['score']
+    @kills = @data['stats']['kills']
+    @deaths = @data['stats']['deaths']
+    @assists = @data['stats']['assists']
+    @bodyshots = @data['stats']['bodyshots']
+    @headshots = @data['stats']['headshots']
+    @legshots = @data['stats']['legshots']
+  end
+
+  def fetch_economy_data
+    @spent_overall = @data['economy']['spent']['overall'].to_i
+    @spent_average = @data['economy']['spent']['average'].to_i
+  end
+
+  def fetch_damage_data
+    @damage_made = @data['damage_made'].to_i
+    @damage_received = @data['damage_received'].to_i
+    return unless @damage_made.zero? || @damage_received.zero?
+
+    @damage_made = nil
+    @damage_received = nil
+  end
+
+  def session_platform_formatter(platform)
+    "#{platform['tpye']} #{platform['os'].values.join(' ')}"
+  end
+
+  def keys_to_sim(hash)
+    hash.transform_keys(&:to_sym)
+  end
+end

data/lib/valorant/utils/user.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+# This class is used to get the data from the User
+class User
+  attr_reader :puuid, :region, :name, :tag, :account_level, :card, :last_update, :last_update_raw
+
+  def initialize(hash)
+    data = hash['data']
+    @puuid = data['puuid']
+    @region = data['region']
+    @name = data['name']
+    @tag = data['tag']
+    @account_level = data['account_level']
+    @card = data['card']
+    @last_update = data['last_update']
+    @last_update_raw = data['last_update_raw']
+  end
+end

data/lib/valorant/utils/utilities.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require 'json'
+require 'rest-client'
+require 'fast_jsonparser'
+
+BASE_URL = 'https://api.henrikdev.xyz/valorant/'
+
+def fetch_resposne(endpoint, validate: true)
+  response = RestClient.get(BASE_URL + endpoint)
+  return FastJsonparser.parse(validate_response(response), symbolize_keys: false) unless validate == false
+
+  FastJsonparser.parse(response, symbolize_keys: false)
+end
+
+def validate_response(response)
+  return response.body if response.code == 200
+
+  raise "Error: #{response.code} - #{response['message']}"
+end
+
+def validate_filter(filter)
+  return if filter.empty?
+
+  filters = %w[escalation spikerush deathmatch competitive unrated replication game_updates dev esports
+               announcments]
+  raise "Error: Invalid filter. Valid filters are: #{filters.join(', ')}" unless filters.include?(filter)
+
+  filter
+end
+
+def validate_locale(locale)
+  return if locale.empty?
+
+  locales = %w[en-us en-gb de-de es-es fr-fr it-it ru-ru tr-tr es-mx ja-jp ko-kr pt-br]
+  raise "Error: Invalid locale. Valid locales are: #{locales.join(', ')}" unless locales.include?(locale)
+
+  locale
+end

data/lib/valorant/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Valorant
+  class Api
+    VERSION = '0.1.0'
+  end
+end

data/lib/valorant.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Valorant
+  require_relative 'valorant/version'
+  require_relative 'valorant/account'
+  require_relative 'valorant/match'
+  require_relative 'valorant/mmr'
+  require_relative 'valorant/misc'
+end

data/valorant.gemspec

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require_relative "lib/valorant/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "valorant"
+  spec.version = Valorant::Api::VERSION
+  spec.authors = ["Gerard Hernandez"]
+  spec.email = ["ger.almenara@gmail.com"]
+
+  spec.summary = "An API wrapper for the Hendriks Valorant API 🍬"
+  spec.homepage = "https://github.com/jaredthejellyfish/ruby-hendriks-val"
+  spec.required_ruby_version = ">= 3.1.2"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/jaredthejellyfish/ruby-hendriks-val"
+  spec.metadata["changelog_uri"] = "https://github.com/jaredthejellyfish/ruby-hendriks-val"
+
+  # 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.
+  require 'rake'
+spec.files = FileList['lib/**/*.rb',
+                      'bin/*',
+                      '[A-Z]*'].to_a
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification
+name: valorant
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Gerard Hernandez
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-11-16 00:00:00.000000000 Z
+dependencies: []
+description:
+email:
+- ger.almenara@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/valorant.rb
+- lib/valorant/account.rb
+- lib/valorant/match.rb
+- lib/valorant/misc.rb
+- lib/valorant/mmr.rb
+- lib/valorant/utils/article.rb
+- lib/valorant/utils/articles.rb
+- lib/valorant/utils/leader.rb
+- lib/valorant/utils/leader_board.rb
+- lib/valorant/utils/match.rb
+- lib/valorant/utils/matches_history.rb
+- lib/valorant/utils/mmr_history.rb
+- lib/valorant/utils/mmr_v1.rb
+- lib/valorant/utils/player.rb
+- lib/valorant/utils/user.rb
+- lib/valorant/utils/utilities.rb
+- lib/valorant/version.rb
+- valorant.gemspec
+homepage: https://github.com/jaredthejellyfish/ruby-hendriks-val
+licenses: []
+metadata:
+  homepage_uri: https://github.com/jaredthejellyfish/ruby-hendriks-val
+  source_code_uri: https://github.com/jaredthejellyfish/ruby-hendriks-val
+  changelog_uri: https://github.com/jaredthejellyfish/ruby-hendriks-val
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: "An API wrapper for the Hendriks Valorant API \U0001F36C"
+test_files: []