elvarg 0.0.3 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f996173667b01d63eb1fc686c3ab1567e39756d552de283926a1501dccd6008d
-  data.tar.gz: ed61f3c8fad382a412ba1bf9d9f65d63b90ef8dfc84ea077725de369964d464b
+  metadata.gz: 67e2cce699cff36e9c3449c7c89db0da859d702a3d464e75f78b491636aa1014
+  data.tar.gz: b5da4d18227f1233ba51e7605aa5d51dc245e2a7209528aeaa6aaa675efc4911
 SHA512:
-  metadata.gz: 215449333501c3ef8c79b114c08c2439a197ea17f61a835b776f872ea27719c1080a39503c358b9d989ae605a0682e9dea960ca2d9a1acad08d487e22fa55e7c
-  data.tar.gz: 2b2788d9b646573f48c27c40c07af33016c75fa81bfbb03fd01603811398130e7d2f9a2b6d1f884ecedb800d5d516cfdc7d55409512b32875007d122c996d3e1
+  metadata.gz: 59a1de2cd781d6b452c4db7d0497fcd2abc30d6cfa23dd8e1eb0bc3013a15e5cba415d0693c9050652945f910fca00ddb593a8102ba25b8a4e2ea28b48990fda
+  data.tar.gz: 264f3d2466a0780ddff14fcc53f01449d03ce8a1eba2f7fa4d8b94b992ef957f1c982cab3f79ff1565ec19dcdc89f9e7356e1c60064c7edebb5b0493eadc9fb8

data/lib/elvarg.rb

@@ -1,12 +1,13 @@
-require_relative "stats/stats"
-require_relative "skills/skill"
-require_relative "hiscores/player"
-require_relative "hiscores/hiscores"
+require_relative 'hiscores/hiscores'
+require_relative 'hiscores/player'
+require_relative 'hiscores/skill'
+require_relative 'stats/skill'
+require_relative 'stats/stats'
 
 ##
-# A Ruby Gem that provides useful methods for OldSchool
-# RuneScape related applications.
+# A Ruby Gem that provides useful methods
+# for OldSchool Runescape related applications.
 #
-# Author: Marcello A. Sabino
+# @author Marcello Sabino <marchsabino@gmail.com>
 module Elvarg
 end

data/lib/hiscores/hiscores.rb

@@ -1,36 +1,36 @@
 require 'open-uri'
 
-module Elvarg # :nodoc:
-  module Hiscores
+module Elvarg #:nodoc:
+  module Hiscores #:nodoc:
+    ##
+    # Represents different modes base URL's on the OldSchool RuneScape 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/",
-    }
-    ENDPOINT = {
-      stats: "index_lite.ws?player=",
-      scores: 'overall.ws?',
-    }
+      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
 
     ##
-    # Searches for a specific user on a specified mode on the OldSchool
-    # RuneScape HiScores website.
-    #
-    # ==== Parameters
-    #
-    # * [String] +username+ - The user's username
-    # * [Symbol] +mode+ - the mode to look in, see Hiscores::MODES for available modes. Default is `:default`.
-    #
-    # ==== Examples
+    # Represents different endpoints on the Hiscores.
+    ENDPOINTS = {
+      stats: 'index_lite.ws?player=',
+      scores: 'overall.ws?'
+    }.freeze
+
+    ##
+    # Searches for a particular player on the Hiscores and grabs data
+    # about the player.
     #
-    # player = Elvarg::Hiscores.search_for 'ruby'
-    # player = Elvarg::Hiscores.search_for('github', :ironman)
+    # @param username [String] the player's username
+    # @param mode [Symbol] the mode to grab data in.
+    #   This can be any of the Elvarg::Hiscores::MODES.
+    # @return [String] data about the Player on the Hiscores
     def self.search_for(username, mode = :default)
-      open(MODES[mode] + ENDPOINT[:stats] + username, &:read)
+      open(MODES[mode] + ENDPOINTS[:stats] + username, &:read)
     end
   end
 end

data/lib/hiscores/player.rb

@@ -1,119 +1,67 @@
-require_relative './hiscores'
 require_relative '../stats/stats'
-require_relative '../skills/skill'
+require_relative './hiscores'
+require_relative './skill'
 
-module Elvarg
-  module Hiscores
+module Elvarg #:nodoc:
+  module Hiscores #:nodoc:
     ##
-    # Represents a single player on OldSchool Runescape
-    class Player include Hiscores, Stats
+    # Represents a Player on the Hiscores
+    class Player
+      include Elvarg::Stats
       attr_reader :username
       attr_reader :mode
       attr_reader :skills
 
       ##
-      # Creates a new Player object
-      #
-      # ==== Parameters
-      #
-      # * [String] +username+ - The user's username
-      # * [Symbol] +mode+ - The mode to search in. see +Hiscores::MODES+, defaults to +:default+
+      # Creates a Player object
       #
-      # ==== Examples
+      # @example a Player on the default Hiscores
+      #   player = Elvarg::Hiscores::Player.new('ruby')
+      #   player.username #=> "ruby"
+      #   player.mode #=> :default
+      # @example a Player on the ironman Hiscores
+      #   ironman = Elvarg::Hiscores::Player.new('dids', :ironman)
+      #   ironman.username #=> "dids"
+      #   ironman.mode #=> :ironman
       #
-      #   # Search through the default overall hiscores
-      #   player = Elvarg::Hiscores::Player.new 'ruby'
-      #   # Search through the ultimate ironman hiscores
-      #   player = Elvarg::Hiscores::Player.new('ruby', :ultimate)
+      # @param username [String] the Player's username
+      # @param mode [Symbol] The mode to search in (default) `:default`
       def initialize(username, mode = :default)
         @username = username
         @mode = mode
         @skills = {}
 
-        extract(Hiscores.search_for(username, mode))
-      end
-
-      ##
-      # Determines if this player is a member
-      #
-      # ==== Details
-      #
-      # This detects membership if the user has greater than 0 experience in
-      # any member's only skill.
-      #
-      # ==== Returns
-      #
-      # [true] if the player has experience in a member's only skill, false otherwise
-      #
-      # ==== Examples
-      #
-      #   player = Elvarg::Hiscores::Player.new 'ruby'
-      #   player.is_member?
-      #   #=> true
-      def is_member?
-        @skills.each { |key, skill| return true if skill.xp > 0 && skill.is_member? }
-        false
-      end
-
-      ##
-      # The inverse of +is_member?+
-      def is_free?
-        !is_member?
-      end
-
-      ##
-      # Determines if this player is a skiller
-      # A user is a skiller when they do not have any combat skill
-      # (other than 10 hitpoints) greater than 1.
-      #
-      # ==== Returns
-      #
-      # [true] if the player has 1 in all combat skills (and 10 hitpoints) false otherwise
-      #
-      # ==== Examples
-      #
-      #   player = Elvarg::Hiscores::Player.new 'ruby'
-      #   player.is_skiller?
-      #   #=> false
-      def is_skiller?
-        @skills.each { |key, skill|
-          next if key == :hitpoints && skill.level <= 10
-          return false if skill.level > 1 && skill.is_combat?
-        }
-        true
+        parse_data(Hiscores.search_for(username, mode))
       end
 
       private
 
       ##
-      # Extracts the data from the OldSchool RuneScape HiScores API and
-      # creates an array so that we can work with the data.
+      # Parses the data that's grabbed from RuneScape.
       #
-      # Parameters:
-      #   [String] data - The HiScores data from 
-      #                   the OldSchool Runescape HiScores API
-      def extract(data)
-        hiscores_data = []
+      # @param data [String] the data grabbed from RuneScape.
+      def parse_data(data)
+        hiscore_data = []
         data.split("\n").each { |skill|
-          hiscores_data.push(skill.split(',').map(&:to_i))
+          hiscore_data.push(skill.split(',').map(&:to_i))
         }
 
-        extract_skills hiscores_data
+        extract_skills(hiscore_data)
       end
 
       ##
-      # Extracts only the skills' data from the hiscores array
-      def extract_skills(hiscores_data)
-        i = 0
-        SKILLS.each { |skill| 
-          @skills[skill] = Elvarg::Skill.new(
-            skill, 
-            hiscores_data[i][0], 
-            hiscores_data[i][1], 
-            hiscores_data[i][2], 
-            i)
-          i += 1
-        }
+      # Extracts only the skill data from the hiscore data.
+      #
+      # @param hiscore_data [Array] Skill data from the Hiscores in an array
+      def extract_skills(hiscore_data)
+        SKILLS.each_with_index do |skill, i|
+          @skills[skill] = Skill.new(
+            skill, i,
+            hiscore_data[i][0],
+            hiscore_data[i][1],
+            hiscore_data[i][2]
+          )
+        end
       end
     end
   end

data/lib/hiscores/skill.rb

@@ -0,0 +1,25 @@
+require_relative '../stats/skill'
+
+module Elvarg #:nodoc:
+  module Hiscores #:nodoc:
+    ##
+    # Represents a Skill on the Hiscores
+    class Skill < Stats::Skill
+      # TODO
+      attr_reader :rank
+      # TODO
+      attr_reader :level
+      # TODO
+      attr_reader :exp
+
+      ##
+      # TODO
+      def initialize(symbol, id = 0, rank = -1, level = 1, exp = 0)
+        super(symbol, id)
+        @rank = rank
+        @level = level
+        @exp = exp
+      end
+    end
+  end
+end

data/lib/stats/skill.rb

@@ -0,0 +1,90 @@
+require_relative './stats'
+
+module Elvarg #:nodoc:
+  module Stats
+    ##
+    # Represents a Skill in OldSchool RuneScape
+    class Skill
+      # The link to the `.gif` of the related Skill
+      attr_reader :icon
+      # The unique id of this Skill
+      attr_reader :id
+      # The human readable name of this Skill
+      attr_reader :name
+      ##
+      # The symbol of this Skill
+      # @see Elvarg::Stats::SKILLS for list of symbols
+      attr_reader :symbol
+
+      ##
+      # Creates a new Skill object.
+      #
+      # @example Create a Hunter Skill object
+      #   hunter = Elvarg::Stats::Skill.new(:hunter, 22)
+      #   hunter.level #=> 1
+      # @example Create a Hitpoints Skill object
+      #   hitpoints = Elvarg::Stats::Skill.new(:hitpoints, 4)
+      #   hitpoints.level #=> 10
+      # @example Create a Runecraft Skill, with no id will default to 0
+      #   runecraft = Elvarg::Stats::Skill.new(:runecraft)
+      #   runecraft.level #=> 1
+      #   runecraft.id #=> 0
+      #
+      # @param symbol [Symbol] the symbol of this skill.
+      # @param id [Integer] the unique identifier of this skill, 1 is attack.
+      #           (0).
+      def initialize(symbol, id = 0)
+        @id = id
+        @symbol = symbol
+        @name = symbol.to_s.capitalize
+        @icon = 'https://www.runescape.com/img/rsp777/' \
+                "hiscores/skill_icon_#{@name.downcase}1.gif"
+      end
+
+      ##
+      # Determines if this Skill is a member's only skill.
+      #
+      # @example Slayer is a member's only skill.
+      #   Elvarg::Stats::Skill.new(:hunter).members? #=> true
+      # @example Runecraft is a free-to-play skill.
+      #   Elvarg::Stats::Skill.new(:runecraft).members? #=> false
+      # @return [true] if this Skill is a member's only skill.
+      # @return [false] if this Skill is free-to-play.
+      def members?
+        MEMBER_SKILLS.include? @symbol
+      end
+
+      ##
+      # Determines if this Skill is a free-to-play skill.
+      #
+      # @note This is the inverse of `members?`
+      # @see members?
+      def free?
+        !members?
+      end
+
+      ##
+      # Determines if this Skill will affect a player's combat
+      #
+      # @example Attack will affect one's combat level
+      #   Elvarg::Stats::Skill.new(:attack).combat? #=> true
+      # @example Woodcutting will not affect one's combat level
+      #   Elvarg::Stats::Skill.new(:woodcutting).combat? #=> false
+      #
+      # @return [true] if this Skill affects a player's combat
+      # @return [false] if this Skill does not affect a player's combat
+      def combat?
+        COMBAT_SKILLS.include? @symbol
+      end
+
+      ##
+      # Determines if this Skill does not affect a player's combat
+      #
+      # @note This is the inverse of `combat?`
+      # @see combat?
+      def skiller_friendly?
+        !combat?
+      end
+    end
+  end
+end

data/lib/stats/stats.rb

@@ -1,27 +1,31 @@
 module Elvarg
-  module Stats
-    SKILLS = %i(
-      overall attack defence strength 
-      hitpoints ranged prayer magic 
-      cooking woodcutting fletching fishing 
-      firemaking crafting smithing mining 
-      herblore agility thieving slayer 
+  module Stats #:nodoc:
+    ##
+    # An array of symbols that represent all
+    # available skills on OldSchool RuneScape.
+    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
-    )
-    MEMBER_SKILLS = %i(
+    ].freeze
+
+    ##
+    # An array of symbols that represent all skills
+    # that are member's only.
+    MEMBER_SKILLS = %i[
       fletching herblore agility thieving
       slayer farming hunter construction
-    )
-    COMBAT_SKILLS = %i(
+    ].freeze
+
+    ##
+    # An array of symbols that represent all skills
+    # that affect a player's combat level.
+    COMBAT_SKILLS = %i[
       attack defence strength hitpoints
       ranged prayer magic
-    )
-    MINIGAMES = %i(
-      bounty_hunter bounty_rogue
-    )
-    CLUES = %i(
-      all easy medium hard
-      elite master
-    )
+    ].freeze
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: elvarg
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.5
 platform: ruby
 authors:
 - Marcello A. Sabino
@@ -20,7 +20,8 @@ files:
 - lib/elvarg.rb
 - lib/hiscores/hiscores.rb
 - lib/hiscores/player.rb
-- lib/skills/skill.rb
+- lib/hiscores/skill.rb
+- lib/stats/skill.rb
 - lib/stats/stats.rb
 homepage: https://github.com/marchsabino/Elvarg
 licenses:

data/lib/skills/skill.rb

@@ -1,66 +0,0 @@
-require_relative '../stats/stats'
-
-module Elvarg
-  class Skill include Stats
-    attr_reader :id
-    attr_reader :symbol
-    attr_reader :name
-    attr_reader :rank
-    attr_reader :level
-    attr_reader :xp
-    attr_reader :icon
-
-    ##
-    # Creates a new Skill object
-    #
-    # Paramters:
-    #   [Symbol] symbol - The symbol of the skill, like :attack, :magic, :ranged
-    #   [Integer] rank - The user's rank. Default is -1
-    #   [Integer] level - The user's level in this skill. Default is 1
-    #   [Integer] xp - The user's experience in this skill. Default is 0
-    #   [Integer] id - The id of this skill, default is -1
-    def initialize(symbol, rank = -1, level = 1, xp = 0, id = -1)
-      @id = id
-      @symbol = symbol
-      @name = symbol.to_s.capitalize
-      @rank = rank
-      @level = level
-      @level = 10 if level == 1 && symbol == :hitpoints
-      @xp = xp
-      @xp = 1154 if xp == 0 && symbol == :hitpoints
-      @icon = "https://www.runescape.com/img/rsp777/hiscores/skill_icon_#{@name.downcase}1.gif"
-    end
-
-    ##
-    # Determines if this Skill is a member's only skill
-    #
-    # Returns:
-    #   true - if this skill is member's only, false otherwise
-    def is_member?
-      Stats::MEMBER_SKILLS.include? @symbol
-    end
-
-    ##
-    # Determines if this Skill is a free to play skill
-    # The inverse of `is_member?`
-    def is_free?
-      !is_member?
-    end
-
-    ##
-    # Determines if this Skill will affect a user's combat level
-    #
-    # Returns:
-    #   true - if this skill will affect combat level, false otherwise
-    def is_combat?
-      Stats::COMBAT_SKILLS.include? @symbol
-    end
-
-    ##
-    # Determines if this Skill is skiller friendly
-    # The inverse of `is_combat?`
-    def is_skiller_friendly?
-      !combat?
-    end
-  end
-end