rshighscores 2.0.1 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 16a49fc6f1b6ed8498727f9049c63d84a6d880e6
-  data.tar.gz: 34abff3b83241879be64832f11cecde8ff197fb9
+  metadata.gz: 2c3fb91c10bab6b714839776d3c8c425d59ad2fa
+  data.tar.gz: f2d47f6a1cc8b731ec416bfdeab69111b3bcb7fc
 SHA512:
-  metadata.gz: b54eb879b6c9b8e95e676fb1fe398878fe174c2ca1c99821573ed8ab523232ff285d18bc3c238db6443d73bf668f87bda420af6689861b1687a9579d1f23fbb5
-  data.tar.gz: affa06907703a651865bd63b3bc2b931f1eb2de36612bd9049738af06819a41bf5d83a48fdd482b86f02f4b18183073e7543af7b33d19e3ddb30d25d8ad75f97
+  metadata.gz: 6610d92a3acf36c1b0bf51f190d1ccfe423bcabaab11d80a8d6b13b265ed0006cfc5da28dde6d460d7834435431d388353adb3144991a827982cf4a8b942bac8
+  data.tar.gz: 39b637cb3057ab22a2ed0de7fb68be13d009dd48ffce723565100989535279649b51fcd9fe05aac12a90b84ff3da8bf0ad47abf4c288488eccce4da5f9ee496c

data/README.md

@@ -6,11 +6,7 @@ Easy to use gem for downloading and parsing Runescape highscores. Inspired to so
 
 ## Rename and compatibility changes
 
-This gem was previously called `osrshighscores` and only worked with Oldschool Runescape. The current version has been renamed to reflect the future version-agnostic highscore parsing that the gem will do. Currently, there is no support for Oldschool Runescape at all.
-
-### But what if I want the Oldschool Runescape version?
-
-Don't worry, it's still around. It currently resides in its own branch, `version-1` and will still function as before. I intend to merge the two versions later on for ease of development and use so keep an eye out for version 3.x.
+This gem was previously called `osrshighscores` and only worked with Oldschool Runescape. The current version has been renamed to reflect the future version-agnostic highscore parsing that the gem will do. As of version 2.1.0, Oldschool Runescape is supported alongside Runescape 3. There are aliases in place to make code from 1.x work without issue in 2.1.x onwards, so if you were using 1.x you need not change anything.
 
 ### Why the change at all?
 
@@ -28,16 +24,20 @@ And then execute:
 
 Or install it yourself as:
 
-    $ gem install highscores
+    $ gem install rshighscores
 
 ## Usage
 
 ```ruby
 require 'rshighscores'
 
-player = RsHighscores::Player.new "Foot"
-highscores = player.stats
+foot = RsHighscores::Player.new "Foot"
+highscores = foot.stats
 puts highscores.hunter.level # => 99
+
+jebrim = OSRS::Player.new "Jebrim" # RsHighscores::OldSchool::Player would work too
+highscores = jebrim.stats
+puts highscores.agility.level # => 99
 ```
 
 ## Contributing

data/lib/rshighscores/oldschool.rb

@@ -0,0 +1,58 @@
+module RsHighscores
+  module OldSchool
+    class Player < RsHighscores::Player
+      def fetch_highscores
+        f = open("http://services.runescape.com/m=hiscore_oldschool/index_lite.ws?player=" + @name, "User-Agent" => "Ruby/RsHighscoresGrabber")
+        
+        @raw_stats = f.readlines.map &:chomp # readlines preserves newlines??
+        @stats = RsHighscores::OldSchool::Stats.new @raw_stats
+      end
+    end
+
+    class Stats < RsHighscores::Stats
+      Skills = %w(Overall Attack Defence Strength
+                  Hitpoints Ranged Prayer Magic
+                  Cooking Woodcutting Fletching Fishing
+                  Firemaking Crafting Smithing Mining
+                  Herblore Agility Thieving Slayer
+                  Farming Runecrafting Hunter Construction)
+
+      ExpectedStatCount = 39
+      ActualStatCount = 23
+
+      def validate_raw_stats
+        raise "incorrect input length" unless @raw_stats.length == ExpectedStatCount
+      end
+
+      def parse_stats
+      validate_raw_stats
+
+      @stats = []
+      @raw_stats.take(ActualStatCount).each do |line|
+        raise "malformed raw stats" unless line =~ /\d+,\d+,\d+/
+        stat = line.split(",").map(&:to_i)
+
+        class << stat
+          def method_missing name, *args
+            case name
+            when :rank
+              return self[0]
+            when :level
+              return self[1]
+            when :xp
+              return self[2]
+            end
+          end
+        end
+
+        @stats << stat
+      end
+    end
+    end
+  end
+end
+
+module OSRS
+  Player = RsHighscores::OldSchool::Player
+  Stats = RsHighscores::OldSchool::Stats
+end

data/lib/rshighscores/player.rb

@@ -2,8 +2,6 @@ require 'open-uri'
 
 module RsHighscores
   class Player
-    @@lookup_url = "http://hiscore.runescape.com/index_lite.ws?player="
-
     attr_reader :name, :raw_stats, :stats
 
     def initialize name, force = :no_force
@@ -23,7 +21,7 @@ module RsHighscores
     end
 
     def fetch_highscores
-      f = open(@@lookup_url + @name, "User-Agent" => "Ruby/RsHighscoresGrabber")
+      f = open("http://hiscore.runescape.com/index_lite.ws?player=" + @name, "User-Agent" => "Ruby/RsHighscoresGrabber")
       
       @raw_stats = f.readlines.map &:chomp # readlines preserves newlines??
       @stats = RsHighscores::Stats.new @raw_stats

data/lib/rshighscores/stats.rb

@@ -1,6 +1,6 @@
 module RsHighscores
   class Stats
-    @@skills = %w(Overall Attack Defence Strength
+    Skills = %w(Overall Attack Defence Strength
                   Hitpoints Ranged Prayer Magic
                   Cooking Woodcutting Fletching Fishing
                   Firemaking Crafting Smithing Mining
@@ -8,24 +8,26 @@ module RsHighscores
                   Farming Runecrafting Hunter Construction
                   Summoning Dungeoneering Divination)
 
+    ExpectedStatCount = 44
+    ActualStatCount = 27
+
     attr_accessor :stats, :raw_stats
 
     def initialize raw_stats
-      @expected_stat_count = 44
       @raw_stats = raw_stats
 
       parse_stats
     end
 
     def validate_raw_stats
-      raise "incorrect input length" unless @raw_stats.length == @expected_stat_count
+      raise "incorrect input length" unless @raw_stats.length == ExpectedStatCount
     end
 
     def parse_stats
       validate_raw_stats
 
       @stats = []
-      @raw_stats.take(@@skills.count).each do |line|
+      @raw_stats.take(ActualStatCount).each do |line|
         raise "malformed raw stats" unless line =~ /\d+,\d+,\d+/
         stat = line.split(",").map(&:to_i)
 
@@ -46,19 +48,15 @@ module RsHighscores
       end
     end
 
-    def skill_names
-      @@skills
-    end
-
     def [] skill
       skill = skill.to_s.capitalize
-      raise "non-existant skill lookup" unless @@skills.index(skill)
+      raise "non-existant skill lookup" unless Skills.index(skill)
 
-      stats[@@skills.index(skill)]
+      stats[Skills.index(skill)]
     end
 
     def method_missing name, *args
-      return self[name] if skill_names.include? name.to_s.capitalize
+      return self[name] if Skills.include? name.to_s.capitalize
       raise NoMethodError
     end
   end

data/lib/rshighscores.rb

@@ -1,7 +1,11 @@
-%w(player stats).each do |dep|
+%w(player stats oldschool).each do |dep|
   require "rshighscores/#{dep}"
 end
 
 module RsHighscores
-  VERSION = "2.0.1"
+  VERSION = "2.1.0"
+end
+
+module OSRS
+  # This exists for compatibility reasons
 end

data/spec/lookup_spec.rb

@@ -32,7 +32,7 @@ describe RsHighscores::Stats do
 
   describe "stat parsing" do
     it "parsed output length" do
-     @stats.stats.length.should eq(@stats.skill_names.count)
+     @stats.stats.length.should eq(RsHighscores::Stats::Skills.count)
     end
 
     it "stats in groups of three" do
@@ -72,13 +72,13 @@ describe RsHighscores::Stats do
     end
 
     it "success on valid skill lookup" do
-      @stats.skill_names.each do |name|
+      RsHighscores::Stats::Skills.each do |name|
         @stats[name].should be_a(Array)
       end
     end
 
     it "skill_names output" do
-      @stats.skill_names.should eq(%w(Overall Attack Defence Strength
+      RsHighscores::Stats::Skills.should eq(%w(Overall Attack Defence Strength
                                       Hitpoints Ranged Prayer Magic
                                       Cooking Woodcutting Fletching Fishing
                                       Firemaking Crafting Smithing Mining
@@ -94,7 +94,7 @@ describe RsHighscores::Stats do
     end
 
     it "missing method call" do
-      @stats.skill_names.each do |name|
+      RsHighscores::Stats::Skills.each do |name|
         @stats.send(name.downcase).should eq(@stats[name])
       end
     end

data/spec/oldschool_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+describe RsHighscores::OldSchool::Player do
+  context "backwards compatibility" do
+    it "namespace alias" do
+      OSRS::Player.should eq(RsHighscores::OldSchool::Player)
+    end
+  end
+
+  context "usability" do
+    before :all do
+      @player = OSRS::Player.new "jebrim", :force
+      @stats = OSRS::Stats.new @player.raw_stats
+    end
+
+    it "skill_names output" do
+      OSRS::Stats::Skills.should eq(%w(Overall Attack Defence Strength
+                                      Hitpoints Ranged Prayer Magic
+                                      Cooking Woodcutting Fletching Fishing
+                                      Firemaking Crafting Smithing Mining
+                                      Herblore Agility Thieving Slayer
+                                      Farming Runecrafting Hunter Construction))
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rshighscores
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.1.0
 platform: ruby
 authors:
 - Sam Broughton
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-29 00:00:00.000000000 Z
+date: 2013-09-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -82,10 +82,12 @@ files:
 - README.md
 - Rakefile
 - lib/rshighscores.rb
+- lib/rshighscores/oldschool.rb
 - lib/rshighscores/player.rb
 - lib/rshighscores/stats.rb
 - rshighscores.gemspec
 - spec/lookup_spec.rb
+- spec/oldschool_spec.rb
 - spec/player_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/sambooo/OSRSGrabber
@@ -114,5 +116,6 @@ specification_version: 4
 summary: RS Highscore Parser
 test_files:
 - spec/lookup_spec.rb
+- spec/oldschool_spec.rb
 - spec/player_spec.rb
 - spec/spec_helper.rb