elvarg 0.0.0 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3a73e04f7442ae531c15f667e4e544a64a9899bc2d323300a7fd01a6db0ba263
-  data.tar.gz: 4b9da900dfa97063ee9eb608a3ac6a48f95d8ec5413567a5ecc31788aa00823b
+  metadata.gz: f996173667b01d63eb1fc686c3ab1567e39756d552de283926a1501dccd6008d
+  data.tar.gz: ed61f3c8fad382a412ba1bf9d9f65d63b90ef8dfc84ea077725de369964d464b
 SHA512:
-  metadata.gz: 3756ef35e235a83c791d225899a38cf9e856c285263a56246e091b01d406bab0215bac4491c627bc33fa23d68881adf8a390956e07acad9a4c0894482c86b355
-  data.tar.gz: e9d787772afc8d3684cf8d5387e55f9245ed246205af27548b9d14a165d082d16cc81550d7f196073b947a9df90f0cf537735ce3a65d118082dccc6edcc8d92e
+  metadata.gz: 215449333501c3ef8c79b114c08c2439a197ea17f61a835b776f872ea27719c1080a39503c358b9d989ae605a0682e9dea960ca2d9a1acad08d487e22fa55e7c
+  data.tar.gz: 2b2788d9b646573f48c27c40c07af33016c75fa81bfbb03fd01603811398130e7d2f9a2b6d1f884ecedb800d5d516cfdc7d55409512b32875007d122c996d3e1

data/lib/elvarg.rb

@@ -1,4 +1,12 @@
+require_relative "stats/stats"
+require_relative "skills/skill"
+require_relative "hiscores/player"
+require_relative "hiscores/hiscores"
+
 ##
-# Elvarg
+# A Ruby Gem that provides useful methods for OldSchool
+# RuneScape related applications.
+#
+# Author: Marcello A. Sabino
 module Elvarg
 end

data/lib/hiscores/hiscores.rb

@@ -0,0 +1,36 @@
+require 'open-uri'
+
+module Elvarg # :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/",
+    }
+    ENDPOINT = {
+      stats: "index_lite.ws?player=",
+      scores: 'overall.ws?',
+    }
+
+    ##
+    # 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
+    #
+    # player = Elvarg::Hiscores.search_for 'ruby'
+    # player = Elvarg::Hiscores.search_for('github', :ironman)
+    def self.search_for(username, mode = :default)
+      open(MODES[mode] + ENDPOINT[:stats] + username, &:read)
+    end
+  end
+end

data/lib/hiscores/player.rb

@@ -0,0 +1,120 @@
+require_relative './hiscores'
+require_relative '../stats/stats'
+require_relative '../skills/skill'
+
+module Elvarg
+  module Hiscores
+    ##
+    # Represents a single player on OldSchool Runescape
+    class Player include Hiscores, 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+
+      #
+      # ==== Examples
+      #
+      #   # 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)
+      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
+      end
+
+      private
+
+      ##
+      # Extracts the data from the OldSchool RuneScape HiScores API and
+      # creates an array so that we can work with the data.
+      #
+      # Parameters:
+      #   [String] data - The HiScores data from 
+      #                   the OldSchool Runescape HiScores API
+      def extract(data)
+        hiscores_data = []
+        data.split("\n").each { |skill|
+          hiscores_data.push(skill.split(',').map(&:to_i))
+        }
+
+        extract_skills hiscores_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
+        }
+      end
+    end
+  end
+end

data/lib/skills/skill.rb

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

data/lib/stats/stats.rb

@@ -0,0 +1,27 @@
+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 
+      farming runecraft hunter construction
+    )
+    MEMBER_SKILLS = %i(
+      fletching herblore agility thieving
+      slayer farming hunter construction
+    )
+    COMBAT_SKILLS = %i(
+      attack defence strength hitpoints
+      ranged prayer magic
+    )
+    MINIGAMES = %i(
+      bounty_hunter bounty_rogue
+    )
+    CLUES = %i(
+      all easy medium hard
+      elite master
+    )
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: elvarg
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.0.3
 platform: ruby
 authors:
 - Marcello A. Sabino
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-12-26 00:00:00.000000000 Z
+date: 2018-12-27 00:00:00.000000000 Z
 dependencies: []
 description: A Ruby Gem that provides useful methods for OldSchool RuneScape related
   applications.
@@ -18,6 +18,10 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/elvarg.rb
+- lib/hiscores/hiscores.rb
+- lib/hiscores/player.rb
+- lib/skills/skill.rb
+- lib/stats/stats.rb
 homepage: https://github.com/marchsabino/Elvarg
 licenses:
 - MIT
@@ -41,5 +45,5 @@ rubyforge_project:
 rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
-summary: Provides OldSchool Runescape tools
+summary: A Ruby Gem with useful methods for OldSchool Runescape related applications.
 test_files: []