runescape 0.0.0 → 0.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9b2742a80bb6157c4d154cd80edc523a84ba82ae6221362277d6f184304d2d69
-  data.tar.gz: 8dd1eddae5aaca5be17f8aee996e8a94abb3da52a0629e50efb28d4cb1510bfb
+  metadata.gz: 03e73aa20edf6f3e65584526fd82f0a87639d4ab1808000c7c377f851ce120c7
+  data.tar.gz: 5078e079d337185be49b6426ec7ad9033e66fe7b07dcdb5c4fd7def4631a4a27
 SHA512:
-  metadata.gz: 2018043ed2fa4ad922b97e774f621fadd3c903e0747ac0bc32903336127625e69a74c8b14f2f8664b795316113faf8c3f738d93f7e975d490a372ca96fd3f16f
-  data.tar.gz: 9ed506243fa284da7b79d2853f8879222a1053e7b0042e338dc80235f9b6b7dd6315b822113bcbf295bf367b35462d71bea6f1c6922a13a842c76fb58e65b65d
+  metadata.gz: 4b41c109913580ab72f5bd11d7ea9eef50a92ae1fff9de58c24ff64331622020668fe5f1ee8e1ed423c8831a9558fbd4e060c433d3df004d3aa36780aa5b64e9
+  data.tar.gz: 2c12a835f048d34068fa160c4ab4984830fe5083c238fc0e91aff5506f924574f4b09766017c78dfaa3e1815a11bc86ee78563a7615dd2949cf6743ec92b3247

data/README.md

@@ -0,0 +1,17 @@
+# runescape
+[![Gem Version](https://badge.fury.io/rb/runescape.svg)](https://badge.fury.io/rb/runescape)
+[![Build Status](https://travis-ci.com/marcellosabino/runescape.svg?branch=master)](https://travis-ci.com/marcellosabino/runescape)
+[![codecov](https://codecov.io/gh/marcellosabino/runescape/branch/master/graph/badge.svg)](https://codecov.io/gh/marcellosabino/runescape)
+
+A Ruby Gem that provides useful methods for RuneScape related applications.
+
+# Installation
+```
+gem install runescape
+```
+
+# Documentation
+TODO
+
+# License
+MIT

data/lib/oldschool/hiscores/hiscores.rb

@@ -0,0 +1,83 @@
+module OldSchool
+  ##
+  # :nodoc:
+  module HiScores
+    MODES = {
+      default: 'https://secure.runescape.com/m=hiscore_oldschool/',
+      ironman: 'http://services.runescape.com/m=hiscore_oldschool_ironman/',
+      ultimate: 'http://services.runescape.com/m=hiscore_oldschool_ultimate/',
+      hardcore: 'http://services.runescape.com/m=hiscore_oldschool_hardcore_ironman/',
+      deadman: 'http://services.runescape.com/m=hiscore_oldschool_deadman/',
+      seasonal: 'http://services.runescape.com/m=hiscore_oldschool_seasonal/',
+      tournament: 'http://services.runescape.com/m=hiscore_oldschool_tournament/'
+    }.freeze
+
+    RESOURCE = {
+      stats: 'index_lite.ws?player='
+    }.freeze
+
+    SKILLS = %i[
+      overall attack defence strength
+      hitpoints ranged prayer magic
+      cooking woodcutting fletching fishing
+      firemaking crafting smithing mining
+      herblore agility thieving slayer
+      farming runecraft hunter construction
+    ].freeze
+
+    MEMBER_SKILLS = %i[
+      fletching herblore agility thieving
+      slayer farming hunter construction
+    ].freeze
+
+    COMBAT_SKILLS = %i[
+      attack defence strength hitpoints
+      ranged prayer magic
+    ].freeze
+
+    MINIGAMES = %i[
+      bh_hunter bh_rogue
+      clue_all clue_easy clue_medium clue_hard clue_elite clue_master
+    ].freeze
+
+    MINIGAMES_SAFE = %i[
+      clue_all clue_easy clue_medium
+      clue_hard clue_elite clue_master
+    ].freeze
+
+    HUMAN_NAME = {
+      overall: 'Overall',
+      attack: 'Attack',
+      defence: 'Defence',
+      strength: 'Strength',
+      hitpoints: 'Hitpoints',
+      ranged: 'Ranged',
+      prayer: 'Prayer',
+      magic: 'Magic',
+      cooking: 'Cooking',
+      woodcutting: 'Woodcutting',
+      fletching: 'Fletching',
+      fishing: 'Fishing',
+      firemaking: 'Firemaking',
+      crafting: 'Crafting',
+      smithing: 'Smithing',
+      mining: 'Mining',
+      herblore: 'Herblore',
+      agility: 'Agility',
+      thieving: 'Thieving',
+      slayer: 'Slayer',
+      farming: 'Farming',
+      runecraft: 'Runecraft',
+      hunter: 'Hunter',
+      construction: 'Construction'
+    }.freeze
+
+    ##
+    # @note The symbol must be a valid skill or minigame
+    # @return [String] the human readable name for a given symbol
+    # @return ["Undefined"] if the given symbol is invalid
+    def self.human_name_for(symbol)
+      HUMAN_NAME[symbol] || 'Undefined'
+    end
+  end
+end

data/lib/oldschool/hiscores/minigame.rb

@@ -0,0 +1,66 @@
+require_relative 'hiscores'
+
+module OldSchool
+  module HiScores # :nodoc:
+    ##
+    # Represents a Minigame in OldSchool Runescape
+    class Minigame
+      # @return [String] The name of this minigame
+      attr_reader :name
+      # @return [Symbol] The symbol of this minigame
+      attr_reader :symbol
+      # @return [Number] The rank of this minigame on the HiScores
+      attr_reader :rank
+      # @return [Number] The score of this minigame on the HiScores
+      attr_reader :score
+
+      ##
+      # Creates a new Minigame instance
+      #
+      # @see OldSchool::HiScores::MINIGAMES Complete list of OldSchool Minigames
+      #
+      # @param symbol [Symbol] the symbol of the minigame
+      # @param rank [Number] the rank of the minigame on the HiScores
+      # @param score [Number] the score of the minigame on the HiScores
+      def initialize(symbol, rank = 0, score = 0)
+        @symbol = symbol
+        @name = HiScores.human_name_for symbol
+        @rank = rank
+        @score = score
+      end
+
+      ##
+      # Determines if this minigame is safe
+      #
+      # A minigame is safe if when you die while doing
+      # the minigame, you don't lose your items.
+      #
+      # @example Bounty Hunter you lose items on death
+      #   minigame = OldSchool::HiScores::Minigame.new :bh_hunter
+      #   minigame.safe? #=> false
+      # @note You can die during Clue Scrolls, but their intents are
+      #   not PVP or even combat related, so clue scrolls are listed
+      #   as safe.
+      # @return [true] if the minigame is classified as safe
+      # @return [false] if the minigame is classified as dangerous
+      def safe?
+        HiScores::MINIGAMES_SAFE.include? @symbol
+      end
+
+      ##
+      # Determines if this minigame is dangerous
+      #
+      # A minigame is dangerous if you lose items when you die
+      #
+      # @example Bounty Hunter Rogue is a dangerous minigame
+      #   minigame = OldSchool::HiScores::Minigame.new :bh_rogue
+      #   minigame.dangerous? #=> true
+      #
+      # @note This is the inverse of #safe?
+      # @see #safe?
+      def dangerous?
+        !safe?
+      end
+    end
+  end
+end

data/lib/oldschool/hiscores/skill.rb

@@ -0,0 +1,129 @@
+require_relative 'hiscores'
+
+module OldSchool
+  module HiScores
+    ##
+    # Represents a Skill in OldSchool Runescape
+    class Skill
+      ##
+      # @example
+      #   attack = OldSchool::HiScores::Skill.new :attack
+      #   attack.name #=> "Attack"
+      # @return [String] The name of this Skill
+      attr_reader :name
+      # @return [Symbol] The of this Skill
+      attr_reader :symbol
+      # @return [Number] The rank of this Skill on the HiScores
+      attr_reader :rank
+      # @return [Number] The level of this Skill on the HiScores
+      attr_reader :level
+      # @return [Number] The experience of this Skill on the HiScores
+      attr_reader :experience
+
+      ##
+      # Creates a new instance of a Skill
+      #
+      # @param symbol [Symbol] the Symbol of this Skill
+      # @param rank [Number] the rank on the HiScores in this Skill
+      # @param level [Number] the level in this Skill
+      # @param experience [Number] the total number of experience in this Skill
+      def initialize(symbol, rank = 0, level = 1, experience = 0)
+        @symbol = symbol
+        @name = HiScores.human_name_for symbol
+        @rank = rank
+        @level = level
+        @experience = experience
+      end
+
+      ##
+      # Determines if this Skill affects a Player's combat level
+      #
+      # @example Attack affects combat level
+      #   skill = OldSchool::HiScores::Skill.new :attack
+      #   skill.combat? #=> true
+      # @example Farming doesn't affect combat level
+      #   skill = OldSchool::HiScores::Skill.new :farming
+      #   skill.combat? #=> false
+      #
+      # @see #noncombat?
+      #
+      # @return [true] if this skill affects a player's combat level
+      # @return [false] if this skill does not affect a player's combat level
+      def combat?
+        HiScores::COMBAT_SKILLS.include? @symbol
+      end
+
+      ##
+      # Determines if this Skill will not affect a Player's combat level
+      #
+      # @example Farming doesn't affect combat level
+      #   skill = OldSchool::HiScores::Skill.new :farming
+      #   skill.noncombat? #=> true
+      # @example Attack affects combat level
+      #   skill = OldSchool::HiScores::Skill.new :attack
+      #   skill.noncombat? #=> false
+      #
+      # @note This is the inverse of #combat?
+      # @see #combat?
+      # @see #skiller_friendly?
+      #
+      # @return [true] if this skill does not affect a Player's combat level
+      # @return [false] if this skill affects a Player's combat level
+      def noncombat?
+        !combat?
+      end
+
+      ##
+      # Determines if this Skill will not affect a Player's combat level
+      #
+      # @note This is an alias for #noncombat?
+      # @see #noncombat?
+      # @see #combat?
+      def skiller_friendly?
+        noncombat?
+      end
+
+      ##
+      # Determines if this is a member's only skill
+      #
+      # @example Slayer is a member's only skill
+      #   skill = OldSchool::HiScores::Skill.new :slayer
+      #   skill.member? #=> true
+      # @example Woodcutting is a free to play skill
+      #   skill = OldSchool::HiScores::Skill.new :woodcutting
+      #   skill.member? #=> false
+      #
+      # @return [true] if this is a member's only skill
+      # @return [false] if this is free to play
+      def member?
+        HiScores::MEMBER_SKILLS.include? @symbol
+      end
+
+      ##
+      # Determines if this is a free to play skill
+      #
+      # @example Woodcutting is a free to play skill
+      #   skill = OldSchool::HiScores::Skill.new :woodcutting
+      #   skill.free? #=> true
+      # @example Slayer is a member's only skill
+      #   skill = OldSchool::HiScores::Skill.new :slayer
+      #   skill.free? #=> false
+      #
+      # @return [true] if this skill is free to play
+      # @return [false] if this skill is member's only
+      def free?
+        !member?
+      end
+
+      ##
+      # Determines if this is a free to play skill
+      #
+      # @note This is an alias for #free?
+      # @see #free?
+      # @see #member?
+      def nonmember?
+        free?
+      end
+    end
+  end
+end

data/lib/oldschool/player.rb

@@ -0,0 +1,222 @@
+require 'csv'
+require 'open-uri'
+require_relative 'hiscores/hiscores'
+require_relative 'hiscores/minigame'
+require_relative 'hiscores/skill'
+
+##
+# Module representing all things OldSchool
+module OldSchool
+  ##
+  # Represents a single player on OldSchool
+  class Player
+    # @return [Symbol] the mode of the Player
+    attr_reader :mode
+    # @return [String] the Player's username
+    attr_reader :username
+    ##
+    # @example Extract Skill information from a Player
+    #   player = OldSchool::Player.new 'ruby'
+    #   player.skills[:overall].level #=> 1232
+    #   player.skills[:hunter] #=> OldSchool::HiScores::Skill
+    #   player.skills[:hunter].level #=> 72
+    #   player.skills[:hunter].experience #=> 780_000
+    #   player.skills[:hunter].rank #=> 131_232
+    #   player.skills #=> Hash of all Skills
+    #
+    # @see OldSchool::HiScores::SKILLS List of all possible Skill Symbols
+    #
+    # @return [Hash<Symbol, OldSchool::HiScores::Skill>] a Hash containing
+    #   all of the Player's skill information as it stands on the HiScores
+    attr_reader :skills
+    ##
+    # @example Extract Minigame information from a Player
+    #   player = OldSchool::Player.new 'ruby'
+    #   player.minigames[:bh_hunter].score #=> 1_344
+    #   player.minigames[:bh_rogue].score #=> 900
+    #   player.minigames[:clue_all].rank #=> 10_333
+    #   player.minigames[:clue_elite].rank #=> 90_232
+    #   player.minigames #=> Hash of all Minigames
+    #
+    # @see OldSchool::HiScores::MINIGAMES List of all possible Minigame Symbols
+    # @return [Hash<Symbol, OldSchool::HiScores::Minigame>] a Hash containing
+    #   all of the Player's minigame information as it stands on the HiScores
+    attr_reader :minigames
+
+    ##
+    # Creates a new Player object
+    #
+    # Creates a new player object with the specified
+    # username
+    #
+    # @example Create a new OldSchool Player
+    #   player = OldSchool::Player.new 'ruby'
+    #   player.mode #=> :default
+    #   player.username #=> "ruby"
+    # @example Create a new Ironman Player
+    #   player = OldSchool::Player.new 'ruby', :ironman
+    #   player.mode #=> :ironman
+    #   player.username #=> "ruby"
+    #
+    # @see OldSchool::HiScores::MODES List of all available game modes
+    #
+    # @param username [String] the username of the Player
+    # @param mode [Symbol] the mode of the Player, such as
+    #   :default, :ironman, :ultimate, :hardcore, :deadman etc.
+    def initialize(username, mode = :default)
+      @username = username
+      @mode = mode
+      @csv = nil
+
+      generate_hs_stats
+    end
+
+    ##
+    # Determines if this Player was/is a member
+    #
+    # This method determines that a Player is a member
+    # if they have any experience in any of their member's
+    # only skills.  Some members, for example, do not have
+    # experience in any of their member's only skills.
+    #
+    # @example For a Player with experience in a member's only skill
+    #   member = OldSchool::Player.new 'member'
+    #   member.member? #=> true
+    # @example For a Player with no experience in a member's only skill
+    #   f2p_player = OldSchool::Player.new 'f2p guy'
+    #   f2p_player.member? #=> false
+    #
+    # @note There is a certain level of inaccuracy using this
+    #   method, since this method determines a Player is a member
+    #   if they have experience in their member's only skills.
+    #
+    # @return [true] if this Player has experience in any member only skill
+    # @return [false] if this Player has no experience in any member only skill
+    def member?
+      @skills.each do |_, skill|
+        return true if skill.experience > 0 && skill.member?
+      end
+      false
+    end
+
+    ##
+    # Determines if this Player is a F2P Player
+    #
+    # This method dermines that a Player is F2P if they do not
+    # have any experience in their member's only skills.
+    #
+    # @example For a player with no experience in a member's only skill
+    #   f2p = OldSchool::Player.new 'f2p'
+    #   f2p.free? #=> true
+    # @example For a Player with experience in a member's only skill
+    #   member = OldSchool::Player.new 'member'
+    #   member.free? #=> false
+    #
+    # @note This method is the inverse of #member?
+    # @see #member?
+    #
+    # @return [true] if this Player has no experience in any member only skill
+    # @return [false] if this Player has experience in any member only skill
+    def free?
+      !member?
+    end
+
+    ##
+    # An alias for #free?
+    # @see #free?
+    def nonmember?
+      free?
+    end
+
+    ##
+    # Determines if this Player is a skiller
+    #
+    # This method determines that a Player is a skiller by
+    # ensuring that the player has no combat-oriented skills
+    # over the level of 1 (with the exception of 10 hitpoints).
+    #
+    # @example For a level 3 skiller
+    #   skiller = OldSchool::Player.new 'skiller'
+    #   skiller.skiller? #=> true
+    # @example For a Player who has > 1 in any combat skill
+    #   main = OldSchool::Player.new 'main'
+    #   main.skiller? #=> false
+    #
+    # @return [true] if the player is classified as a skiller
+    # @return [false] if the player is not classified as a skiller
+    def skiller?
+      skiller = true
+      @skills.each do |_, skill|
+        next if skill.symbol == :hitpoints && skill.level <= 10
+
+        skiller = false if skill.combat? && skill.level > 1
+      end
+      skiller
+    end
+
+    ##
+    # Determines if this player is not a skiller
+    #
+    # @example For a level 3 skiller
+    #   skiller = OldSchool::Player.new 'skiller'
+    #   skiller.nonskiller? #=> false
+    # @example For a Player who has > 1 in any combat skill
+    #   main = OldSchool::Player.new 'main'
+    #   main.nonskiller? #=> true
+    #
+    # @note This is the inverse of #skiller?
+    # @see #skiller?
+    #
+    # @return [true] if the player is not classified as a skiller
+    # @return [false] if the player is classified as a skiller
+    def nonskiller?
+      !skiller?
+    end
+
+    private
+
+    def open_and_read(url)
+      open(url, &:read)
+    end
+
+    def csv_data
+      mode = HiScores::MODES[@mode]
+      resource = HiScores::RESOURCE[:stats] + @username
+      url = mode + resource
+
+      @csv = CSV.parse(open_and_read(url)).map { |r| r.map(&:to_i) }
+    end
+
+    def generate_hs_stats
+      csv_data if @csv.nil?
+
+      generate_skills
+      generate_minigames
+    end
+
+    def generate_skills
+      @skills = {}
+      skills_arr = HiScores::SKILLS
+
+      @csv.each_with_index do |row, i|
+        break if i >= HiScores::SKILLS.length
+
+        @skills[HiScores::SKILLS[i]] = HiScores::Skill.new(
+          skills_arr[i], row[0], row[1], row[2]
+        )
+      end
+    end
+
+    def generate_minigames
+      @minigames = {}
+      minigames_arr = HiScores::MINIGAMES
+      range = @skills.length..@skills.length + HiScores::MINIGAMES.length - 1
+
+      range.each_with_index do |val, i|
+        @minigames[HiScores::MINIGAMES[i]] = HiScores::Minigame.new(
+          minigames_arr[i], @csv[val][0], @csv[val][1]
+        )
+      end
+    end
+  end
+end

data/lib/runescape.rb

@@ -1,6 +1,7 @@
-##
-# A Ruby Gem that provides useful methods for RuneScape related applications.
-#
-# @author Marcello Sabino <marcello.github@gmail.com>
-module Runescape
-end
+##
+# A Ruby Gem that provides useful methods for RuneScape related applications.
+#
+# @author Marcello Sabino <marcello.github@gmail.com>
+module Runescape
+  VERSION = '0.0.1'.freeze
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: runescape
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.0.1
 platform: ruby
 authors:
-- Marcello Sabino
+- Marcello A. Sabino
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-12-31 00:00:00.000000000 Z
+date: 2019-01-08 00:00:00.000000000 Z
 dependencies: []
 description: A Ruby Gem that provides useful methods for RuneScape related applications.
 email: marcello.github@gmail.com
@@ -16,6 +16,11 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- README.md
+- lib/oldschool/hiscores/hiscores.rb
+- lib/oldschool/hiscores/minigame.rb
+- lib/oldschool/hiscores/skill.rb
+- lib/oldschool/player.rb
 - lib/runescape.rb
 homepage: https://github.com/marcellosabino/runescape
 licenses:
@@ -29,16 +34,16 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.8.11
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
-summary: A Ruby Gem that provides useful methods for RuneScape
+summary: A Ruby Gem that provides useful methods for RuneScape related applications
 test_files: []