rs_api 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4302d947223389c4bb1e40b4c804a2b0b42e2ef770bc3277a2892acd9a539a21
+  data.tar.gz: '0082b0d7bae37f560efc69a95e254916e1e043f4a966d858fab1e8544659dee3'
+SHA512:
+  metadata.gz: b0c78ca01a89467c0f76387fdfdba7e1dc79ea8ec2fd28db5798a514ecbe22aa8bdd3a32108c6da83a0be66a5933d0bfabab0bb867700d961c459cf66ddfa64b
+  data.tar.gz: 8d4e0c6fbf0e8d59bd8be9c7199316c57966544972671ee7181cca7be204e2a0ebf76070a1cceabd7d7428409569727cbb72f656e7b3073799addade8b05b0b0

data/config/initializers/config.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+Config.setup do |config|
+  env = ENV['RS_API_ENV'] || 'development'
+
+  # Set preferred settings
+  config.const_name = 'Settings'
+  config.evaluate_erb_in_yaml = true
+
+  # Load Settings
+  config.load_and_set_settings(Config.setting_files('config', env))
+end

data/lib/rs_api/helpers/player_name_helper.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module RsApi
+  # Functions for helping with Runescape player names
+  module PlayerNameHelper
+    class RsNameInvalid < StandardError; end
+
+    def self.check_player_name(player_name)
+      raise player_name_invalid_error unless valid_player_name(player_name)
+    end
+
+    class << self
+      private
+
+      def valid_player_name(player_name)
+        (player_name =~ /^[a-zA-Z0-9\s]{1,12}$/)&.zero?
+      end
+
+      def player_name_invalid_error
+        RsNameInvalid.new('Please enter a 1-12 character alphanumeric name')
+      end
+    end
+  end
+end

data/lib/rs_api/helpers/skill_helper.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal:true
+
+# Default Runescape-related constants
+module RsApi
+  module SkillHelper
+    MAX = 13_034_431 # Xp needed to lv 99 in any skill,
+    # useless now BUT could be useful in future.
+
+    # Mapping of received info from rs_api's uri.
+    SKILL_ID_CONST = {
+      0 => :overall,
+      1 => :attack,
+      2 => :defence,
+      3 => :strength,
+      4 => :constitution,
+      5 => :ranged,
+      6 => :prayer,
+      7 => :magic,
+      8 => :cooking,
+      9 => :woodcutting,
+      10 => :fletching,
+      11 => :fishing,
+      12 => :firemaking,
+      13 => :crafting,
+      14 => :smithing,
+      15 => :mining,
+      16 => :herblore,
+      17 => :agility,
+      18 => :thieving,
+      19 => :slayer,
+      20 => :farming,
+      21 => :runecrafting,
+      22 => :hunter,
+      23 => :construction,
+      24 => :summoning,
+      25 => :dungeoneering,
+      26 => :divination,
+      27 => :invention,
+      28 => :archaeology,
+      29 => :necromancy
+    }.freeze
+
+    MONTHLY_XP_SKILL_ID_CONST = SKILL_ID_CONST.select { |k, _v| k.positive? }
+                                              .transform_keys { |k| k - 1 }.freeze
+  end
+end

data/lib/rs_api/hiscores/hiscore.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+# Uncomment below to run Examples in file. Continue for other related files
+# require_relative '../helpers/player_name_helper'
+# require_relative '../helpers/skill_helper'
+
+module RsApi
+  # Base class for getting Runescape hiscore data for a player
+  class Hiscore
+    include PlayerNameHelper
+    include SkillHelper
+
+    private
+
+    def colour?
+      Settings.colour_output
+    end
+
+    def display?
+      Settings.display_output
+    end
+
+    def params
+      raise 'implement me!'
+    end
+
+    def table
+      @table ||= Text::Table.new(horizontal_padding: 1)
+    end
+
+    def url
+      raise 'implement me!'
+    end
+  end
+end

data/lib/rs_api/hiscores/player_compare.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal:true
+
+# Uncomment below to run Example(s) in file. May also need to for other related files.
+# require 'text-table'
+# require_relative 'hiscore'
+# require_relative '../rs_request'
+# require_relative '../helpers/integer_helper'
+# require_relative '../helpers/string_colour_helper'
+# require_relative '../helpers/skill_helper'
+# require_relative '../patches/text_table__cell_patch' # for color printing
+# require_relative '../patches/text_table__table_patch' # for color printing
+# require_relative 'rs_player_experience'
+
+module RsApi
+  # class PlayerCompare that compares two PlayerExp skill experience.
+  class PlayerCompare < Hiscore
+    attr_reader :player1, :player2
+
+    def initialize(player1, player2)
+      @player1 = PlayerExperience.new(player1)
+      @player2 = PlayerExperience.new(player2)
+    end
+
+    def compare
+      SKILL_ID_CONST.each do |key, skill_name|
+        xp_diff = @player1.all_skill_experience[key] - @player2.all_skill_experience[key]
+
+        raw_data << compare_result(key, skill_name, xp_diff)
+      end
+    end
+
+    def display
+      if raw_data.empty?
+        compare
+        table.head = %w[SKILL WINNER LEVEL XP-DIFFERENCE]
+        table.rows = formatted_data
+      end
+
+      if display?
+        # :nocov:
+        colour? ? (puts colour_table) : (puts table)
+        # :nocov:
+      end
+      table
+    end
+
+    def raw_data
+      @raw_data ||= [] # index 0 is total exp, rest is normal skills by exp
+    end
+
+    private
+
+    def capitalize(value)
+      value.capitalize
+    end
+
+    # :nocov:
+    def colour_row(row)
+      if row[1] == player1.player_name
+        row.map(&:to_s).map(&:blue)
+      else
+        row.map(&:to_s).map(&:green)
+      end
+    end
+
+    def colour_table
+      c_table = table.dup
+      c_table.head = c_table.head.map(&:white)
+      c_table.rows = c_table.rows.map { |row| colour_row(row) }
+
+      c_table
+    end
+    # :nocov:
+
+    def compare_result(key, skill_name, xp_diff)
+      case xp_diff <=> 0
+      when -1 # p2 has more skill
+        [capitalize(skill_name), @player2.player_name, @player2.raw_data[key][1], xp_diff.abs]
+      when 1 # p1 has more skill
+        [capitalize(skill_name), @player1.player_name, @player1.raw_data[key][1], xp_diff]
+      else # 0
+        [capitalize(skill_name), 'TIE', @player2.raw_data[key][1], 0]
+      end
+    end
+
+    def formatted_data
+      raw_data.map { |i, j, k, l| [i, j, k, l.delimited] }
+    end
+  end
+end
+
+# Example
+# a = RsApi::PlayerCompare.new('tibthedragon', 'bubba tut')
+# a.display

data/lib/rs_api/hiscores/player_experience.rb

@@ -0,0 +1,109 @@
+# frozen_string_literal:true
+
+# Uncomment below to run Example(s) in file. May also need to for other related files.
+# require 'text-table'
+# require_relative 'hiscore'
+# require_relative '../rs_request'
+# require_relative '../helpers/integer_helper'
+# require_relative '../helpers/string_colour_helper'
+# require_relative '../helpers/skill_helper'
+# require_relative '../patches/text_table__cell_patch' # for color printing
+# require_relative '../patches/text_table__table_patch' # for color printing
+
+module RsApi
+  # Class PlayerExp pulls, from Hiscores, player level/experience in each skill.
+  class PlayerExperience < Hiscore
+    attr_reader :player_name, :table_results
+
+    def initialize(player_name)
+      PlayerNameHelper.check_player_name(player_name)
+      @player_name = player_name
+    end
+
+    def display
+      fill_table_data if table.rows.empty?
+      if display?
+        # :nocov:
+        colour? ? (puts colour_table) : (puts table)
+        # :nocov:
+      end
+      table
+    rescue RsApi::RsRequest::PlayerNotFound
+      puts "#{@player_name} does not exist.".red if display?
+    end
+
+    def raw_data
+      @raw_data ||= parsed[0..29]
+    end
+
+    def max_skill_level
+      # Returns the highest skill level out of all sklls
+      raw_data[1..].map { |value| value[1].to_i }.max.to_s
+    end
+
+    def skills_at_max_level
+      # Returns a array containing only skills at max_skill_level
+      # SKILL_ID_CONST[i+1] | i is +1 because I don't want to load the overall skill totals
+      raw_data[1..].filter_map.with_index do |value, i|
+        SKILL_ID_CONST[i + 1].to_s.capitalize if value[1] == max_skill_level
+      end
+    end
+
+    def all_skill_experience
+      # Retuns array containing the experience for each skill
+      # Index of skills corresponds to RsConst::SKILL_ID_CONST
+      raw_data.map { |n| n.last.delete(',').to_i }
+    end
+
+    private
+
+    # :nocov:
+    def colour_table
+      c_table = table.dup
+      c_table.head = c_table.head.map(&:white)
+
+      c_table.rows = c_table.rows.map do |row|
+        [row[0].to_s.yellow, row[1].red, row[2].cyan, row[3].green]
+      end
+
+      c_table
+    end
+    # :nocov:
+
+    def fill_table_data
+      table.head = [player_name, 'Rank', 'Level', 'Experience']
+
+      # Future: move 'Overall' xp info to footer
+      raw_data.each_with_index do |value, i|
+        table.rows << [SKILL_ID_CONST[i].capitalize, format(value[0]), value[1], format(value[2])]
+      end
+    end
+
+    def format(value)
+      value.to_i.delimited
+    end
+
+    def url
+      # RsApi.load_config['runescape_urls']['hiscore_url']
+      Settings.runescape_urls.hiscore_url
+    end
+
+    def parsed
+      # Response is in CSV format
+      response = RsRequest.new(url, params).get
+
+      response.body.split("\n").map { |item| item.split(',') }
+    end
+
+    def params
+      { player: player_name }
+    end
+  end
+end
+
+# Example
+# a = RsApi::PlayerExperience.new('tibthedragon')
+# a.display
+# puts a.max_skill_level
+# puts a.skills_at_max_level
+# puts a.all_skill_experience

data/lib/rs_api/patches/integer.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal:true
+
+# Useful functions extending Integer class
+class Integer
+  def delimited
+    # Adds comma's every 3 numbers, if possible, for Integer and return as String
+    to_s.reverse.gsub(/(\d{3})(?=\d)/, '\\1,').reverse
+  end
+end

data/lib/rs_api/patches/string.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+# monkey-patching string class to add colors.
+class String
+  def negative
+    "\033[7m#{self}\033[0m"
+  end
+
+  # 1 is bold, 30 is black, 47 is white bg
+  def black
+    "\033[1;30;47m#{self}\033[0m"
+  end
+
+  def red
+    "\033[31m#{self}\033[0m"
+  end
+
+  def green
+    "\033[32m#{self}\033[0m"
+  end
+
+  def yellow
+    "\033[33m#{self}\033[0m"
+  end
+
+  def blue
+    "\033[34m#{self}\033[0m"
+  end
+
+  def purple
+    "\033[35m#{self}\033[0m"
+  end
+
+  def cyan
+    "\033[36m#{self}\033[0m"
+  end
+
+  def white
+    "\033[37m#{self}\033[0m"
+  end
+end

data/lib/rs_api/patches/text_table__cell_patch.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+# Monkey patching column widths to take into account cell length not including terminal escapes
+# Thank you to https://github.com/mikecarlton-illumio/text-table for solving this problem
+module Text
+  class Table
+    class Cell
+      # visible width: without terminal escapes
+      def width
+        value.gsub(/\033\[[^m]+m/, '').length
+      end
+
+      def to_s
+        invisible = value.length - width
+      ([' ' * table.horizontal_padding]*2).join case align
+        when :left
+          value.ljust cell_width
+          value.ljust cell_width+invisible
+        when :right
+          value.rjust cell_width
+          value.rjust cell_width+invisible
+        when :center
+          value.center cell_width
+          value.center cell_width+invisible
+        end
+      end
+    end
+  end
+end

data/lib/rs_api/patches/text_table__table_patch.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+# Monkey patching column widths to take into account cell length not including terminal escapes
+# Thank you to https://github.com/mikecarlton-illumio/text-table for solving this problem
+module Text
+  class Table
+    def column_widths
+      @column_widths ||= \
+      all_text_table_rows.reject {|row| row.cells == :separator}.map do |row|
+        row.cells.map {|cell| [(cell.width/cell.colspan.to_f).ceil] * cell.colspan}.flatten
+      end.transpose.map(&:max)
+    end
+  end
+end

data/lib/rs_api/rs_request.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal:true
+
+# Uncomment below to run Examples in file. Continue for other related files
+# require 'uri'
+# require 'net/http'
+
+module RsApi
+  # Class RsRequest that handles any Rs Api request
+  class RsRequest
+    class PlayerNotFound < StandardError; end
+    class ServiceUnavailable < StandardError; end
+
+    MAX_RETRIES = 2
+
+    attr_reader :url, :params
+
+    def initialize(url, params = {})
+      @url = url
+      @params = params
+    end
+
+    def get
+      uri.query = URI.encode_www_form(@params)
+      response = Net::HTTP.get_response(uri)
+
+      check_for_errors(response)
+      response
+    rescue ServiceUnavailable
+      retries ||= 0
+      raise ServiceUnavailable, response.code if retries >= MAX_RETRIES
+
+      retries += 1
+      retry
+    end
+
+    def put; end
+
+    private
+
+    def check_for_errors(response)
+      raise PlayerNotFound, response.code if response.code == '404' && response.message == 'Not Found'
+      raise ServiceUnavailable, response.code if response.code == '302' && response[:location] == unavailable_url
+    end
+
+    def unavailable_url
+      Settings.runescape_urls.unavailable_url
+    end
+
+    def uri
+      @uri ||= URI(@url)
+    end
+  end
+end
+
+# Example
+# a = RsApi::RsRequest.new('https://secure.runescape.com/m=hiscore/index_lite.ws?', { player: 'tibthedragon' })
+# puts a.get.response.body

data/lib/rs_api/runemetrics/monthly_xp.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal:true
+
+# Uncomment below to run Examples in file. Continue for other related files
+# require 'json'
+# require '../rs_request'
+# require '../helpers/skill_helper'
+# require_relative 'runemetrics'
+
+module RsApi
+  # For obtaining monthly xp data for a user.
+  class MonthlyXp < Runemetrics
+    class MissingPlayerData < StandardError; end
+
+    # def display; end
+
+    def previous_monthly_xp_data
+      # # Last entry is this current month
+      # # Therefore, previous month is second to last entry
+      raw_data.map { |data| data.last['monthData'][-2] }
+    end
+
+    def raw_data
+      # Data is a hash of the last 12 months of data for each key skill_name
+      @raw_data ||= request_all_data
+    end
+
+    private
+
+    def request_all_data
+      puts 'Processing request. Please wait...'.yellow if display?
+      data = {}
+      sum_total_gain_xp = 0
+
+      MONTHLY_XP_SKILL_ID_CONST.each do |skill_id, skill_name|
+        puts "Collecting #{skill_name} data...".yellow if display?
+        parsed_response = monthly_xp_request(skill_id)
+
+        data[skill_name] = parsed_response
+        sum_total_gain_xp += data[skill_name]['totalGain']
+      end
+
+      raise MissingPlayerData, 'Player data is empty.' if sum_total_gain_xp.zero?
+
+      data
+    end
+
+    def monthly_xp_request(skill_id)
+      response = RsRequest.new(url, params(skill_id)).get
+
+      JSON.parse(response.body)['monthlyXpGain'].first
+    end
+
+    def params(skill_id)
+      { searchName: player, skillid: skill_id }
+    end
+
+    def url
+      Settings.runescape_urls.monthly_xp_url
+    end
+  end
+end
+
+# Example:
+# a = RsApi::MonthlyXp.new('tibthedragon')
+# pp a.raw_data

data/lib/rs_api/runemetrics/runemetrics.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+# Uncomment below to run Examples in file. Continue for other related files
+# require_relative '../helpers/skill_helper'
+# require_relative '../helpers/player_name_helper'
+
+module RsApi
+  # Base class regarding Runescape's Runemetrics API
+  class Runemetrics
+    include SkillHelper
+    include PlayerNameHelper
+
+    attr_reader :player
+
+    def initialize(player_name)
+      PlayerNameHelper.check_player_name(player_name)
+      @player = player_name
+    end
+
+    private
+
+    def display?
+      Settings.display_output
+    end
+
+    def params
+      raise 'implement me!'
+    end
+
+    def url
+      raise 'implement me!'
+    end
+  end
+end

data/lib/rs_api/version.rb

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

data/lib/rs_api.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal:true
+
+require 'active_support/inflector'
+require 'config'
+require 'google/apis/sheets_v4'
+require 'googleauth'
+require 'googleauth/stores/file_token_store'
+require 'json'
+require 'net/http'
+require 'text-table'
+require 'uri'
+require 'yaml'
+require_relative '../config/initializers/config'
+require_relative 'rs_api/patches/integer'
+require_relative 'rs_api/patches/string'
+require_relative 'rs_api/patches/text_table__cell_patch'
+require_relative 'rs_api/patches/text_table__table_patch'
+
+# Base RsApi module for autoloading files
+module RsApi
+  FOLDERS_TO_LOAD = [:helpers, :hiscores, :runemetrics, ''].freeze
+
+  def self.autoload_files
+    FOLDERS_TO_LOAD.each do |s|
+      Dir[File.join(__dir__, 'rs_api', s.to_s, '*.rb')].each do |file|
+        class_name = File.basename(file, '.rb').camelcase
+        autoload class_name, file
+      end
+    end
+  end
+end
+
+RsApi.autoload_files

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification
+name: rs_api
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Drew Spelman
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-11-07 00:00:00.000000000 Z
+dependencies: []
+description: Code for using player data from Runescape
+email:
+- drew.spelman@gmail.com
+- thisfoxcodes@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- config/initializers/config.rb
+- lib/rs_api.rb
+- lib/rs_api/helpers/player_name_helper.rb
+- lib/rs_api/helpers/skill_helper.rb
+- lib/rs_api/hiscores/hiscore.rb
+- lib/rs_api/hiscores/player_compare.rb
+- lib/rs_api/hiscores/player_experience.rb
+- lib/rs_api/patches/integer.rb
+- lib/rs_api/patches/string.rb
+- lib/rs_api/patches/text_table__cell_patch.rb
+- lib/rs_api/patches/text_table__table_patch.rb
+- lib/rs_api/rs_request.rb
+- lib/rs_api/runemetrics/monthly_xp.rb
+- lib/rs_api/runemetrics/runemetrics.rb
+- lib/rs_api/version.rb
+homepage: https://github.com/dmspelma/rs_api
+licenses:
+- MIT
+metadata:
+  github_repo: ssh://github.com/dmspelma/rs_api
+  rubygems_mfa_required: 'false'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '='
+    - !ruby/object:Gem::Version
+      version: 3.1.1.18
+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: ''
+test_files: []