rshiscores 3.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: deb75a4dc9c4856ae3a1a6e58ee6b0a6724a8965
+  data.tar.gz: 918508c00eee15946a721c5d0fe586789817bc4e
+SHA512:
+  metadata.gz: 7509bc568e09299913649725ca853312cd54526882da1d13df52cc7d3ff8384e59ac90271a8865116425272d9300ef6d562702eb77d9012aca601a83380ad9ff
+  data.tar.gz: 20bbb5213696e4aa22a25929af9edc38739f2e6e1837eb2d69bf7b18e76bd05d1b8484206b8f225f3a826636e9ba06dc30013fb3f5e28ef4dd34db54ae1b9fdd

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+.DS_Store
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in osrshighscores.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Sam Broughton
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,49 @@
+# RsHighscores
+
+[![Code Climate](https://codeclimate.com/github/sambooo/RsHighscores.png)](https://codeclimate.com/github/sambooo/RsHighscores)
+
+Easy to use gem for downloading and parsing Runescape highscores. Inspired to some extent by [Partyhat](https://github.com/clooth/Partyhat)
+
+## 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. 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?
+
+I was asked to port the gem to Runescape 3 by a friend. I figured it would be better to immediately roll-out a working version and then work on merging branches later.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rshighscores'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rshighscores
+
+## Usage
+
+```ruby
+require 'rshighscores'
+
+foot = RsHighscores::Player.new "Foot", force: true
+highscores = foot.stats
+puts highscores.hunter.level # => 99
+
+jebrim = OSRS::Player.new "Jebrim", force: true # RsHighscores::OldSchool::Player would work too
+highscores = jebrim.stats
+puts highscores.agility.level # => 99
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new :test
+
+task :default => [:test]

data/lib/rshiscores.rb

@@ -0,0 +1,10 @@
+%w(stats player oldschool).each do |dep|
+  require "rshiscores/#{dep}"
+end
+
+module RsHiscores
+  VERSION = "3.0.0"
+end
+
+module OSRS
+end

data/lib/rshiscores/oldschool.rb

@@ -0,0 +1,18 @@
+module RsHiscores
+  module OldSchool
+    class Stats < RsHiscores::Stats
+      StatCount = 24
+      Skills = RsHiscores::Stats::Skills.take(StatCount)
+    end
+
+    class Player < RsHiscores::Player
+      LookupUrl = "http://services.runescape.com/m=hiscore_oldschool/index_lite.ws?player="
+      StatClass = RsHiscores::OldSchool::Stats
+    end
+  end
+end
+
+module OSRS
+  Player = RsHiscores::OldSchool::Player
+  Stats = RsHiscores::OldSchool::Stats
+end

data/lib/rshiscores/player.rb

@@ -0,0 +1,34 @@
+require 'open-uri'
+
+module RsHiscores
+  class Player
+    LookupUrl = "http://hiscore.runescape.com/index_lite.ws?player="
+    StatClass = RsHiscores::Stats
+
+    attr_reader :name, :raw_stats, :stats
+
+    def initialize name, params = {}
+      @name = name
+      validate_name
+
+      fetch_highscores if params[:force]
+    end
+
+    def validate_name
+      raise "invalid characters in name" if @name =~ /[^A-Za-z0-9_\- ]/
+
+      raise "name too long" if @name.length > 12
+      raise "name too short" if @name.length < 1
+
+      raise "name starts/ends with a space character" if (name[0] + name[-1]) =~ /[_\- ]/
+    end
+
+    def fetch_highscores
+      safe_name = @name.gsub " ", "%20"
+      f = open(self.class::LookupUrl + safe_name, "User-Agent" => "Ruby/RsHiscoresGrabber")
+
+      @raw_stats = f.readlines.map &:chomp # readlines preserves newlines??
+      @stats = self.class::StatClass.new @raw_stats
+    end
+  end
+end

data/lib/rshiscores/stats.rb

@@ -0,0 +1,87 @@
+module RsHiscores
+  class 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
+                Summoning Dungeoneering Divination)
+
+    StatCount = Skills.count
+
+    attr_accessor :stats, :raw_stats
+
+    def initialize raw_stats
+      @raw_stats = raw_stats
+
+      parse_stats
+    end
+
+    def stat_count
+      self.class::StatCount
+    end
+
+    def skills
+      self.class::Skills
+    end
+
+    def validate_raw_stats
+      if @raw_stats.length < stat_count
+        raise "incorrect input length: expected #{stat_count}, got #{@raw_stats.length}"
+      end
+    end
+
+    def parse_stats
+      validate_raw_stats
+
+      @stats = []
+      @raw_stats.take(stat_count).each do |line|
+        raise "malformed raw stats" unless line =~ /\d+,\d+,\d+/
+        stat = Stat.new line.split(",").map(&:to_i)
+
+        @stats << stat
+      end
+    end
+
+    def [] skill
+      skill = skill.to_s.capitalize
+      raise "non-existant skill lookup" unless skills.index(skill)
+
+      stats[skills.index(skill)]
+    end
+
+    def method_missing name, *args
+      return self[name] if Skills.include? name.to_s.capitalize
+      super
+    end
+  end
+
+  class Stat
+    attr_reader :backing_array
+
+    def initialize backing_array
+      @backing_array = backing_array
+    end
+
+    def length
+      backing_array.length
+    end
+
+    def each &block
+      backing_array.each &block
+    end
+
+    def rank
+      backing_array[0]
+    end
+
+    def level
+      backing_array[1]
+    end
+
+    def xp
+      backing_array[2]
+    end
+  end
+end

data/rshiscores.gemspec

@@ -0,0 +1,24 @@
+# encoding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rshiscores'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rshiscores"
+  spec.version       = RsHiscores::VERSION
+  spec.authors       = ["Sam Broughton", "Joshua Bell"]
+  spec.email         = ["sam@26th-zerk.co.uk"]
+  spec.description   = %q{Easy to use gem for downloading and parsing Runescape hiscores}
+  spec.summary       = %q{RS Hiscore Parser}
+  spec.homepage      = "https://github.com/sambooo/RsHighscores"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/spec/lookup_spec.rb

@@ -0,0 +1,102 @@
+require 'spec_helper'
+
+describe RsHiscores::Stats do
+  before :all do
+    @player = RsHiscores::Player.new "jake", force: true
+    @stats = RsHiscores::Stats.new @player.raw_stats
+  end
+
+  describe "raw highscore validation" do
+    context "valid input" do
+      it "correct input length" do
+        lambda {
+         @stats = RsHiscores::Stats.new @player.raw_stats
+        }.should_not raise_error
+      end
+    end
+
+    context "invalid input" do
+      it "incorrect input length" do
+        lambda {
+          RsHiscores::Stats.new []
+        }.should raise_error(/incorrect input length/)
+      end
+
+      it "malformed input line" do
+        lambda {
+          RsHiscores::Stats.new Array.new(49) { "" }
+        }.should raise_error("malformed raw stats")
+      end
+    end
+  end
+
+  describe "stat parsing" do
+    it "parsed output length" do
+     @stats.stats.length.should eq(RsHiscores::Stats::Skills.count)
+    end
+
+    it "stats in groups of three" do
+     @stats.stats.each do |skill|
+        skill.length.should eq(3)
+      end
+    end
+
+    it "stats converted to ints" do
+     @stats.stats.each do |skill|
+        skill.each do |elem|
+          elem.should be_a(Numeric)
+        end
+      end
+    end
+  end
+
+  describe "usability" do
+    it "stats 'hash' call" do
+      lambda {
+       @stats[:overall]
+      }.should_not raise_error
+    end
+
+    it "stat arrays with convenience methods" do
+     @stats.stats.each do |skill|
+        skill.rank.should be_a(Numeric)
+        skill.level.should be_a(Numeric)
+        skill.xp.should be_a(Numeric)
+      end
+    end
+
+    it "error on non-existant skill lookup" do
+      lambda {
+       @stats[:foot]
+      }.should raise_error("non-existant skill lookup")
+    end
+
+    it "success on valid skill lookup" do
+      RsHiscores::Stats::Skills.each do |name|
+        @stats[name].should be_a(RsHiscores::Stat)
+      end
+    end
+
+    it "skill_names output" do
+      RsHiscores::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
+                                      Summoning Dungeoneering Divination))
+    end
+
+    it "attempting to call a skill name that doesn't exist" do
+      lambda {
+        @stats.not_a_skill
+      }.should raise_error
+    end
+
+    it "missing method call" do
+      RsHiscores::Stats::Skills.each do |name|
+        @stats.send(name.downcase).should eq(@stats[name])
+      end
+    end
+  end
+end

data/spec/oldschool_spec.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+
+describe RsHiscores::OldSchool::Player do
+  context "backwards compatibility" do
+    it "namespace alias" do
+      OSRS::Player.should eq(RsHiscores::OldSchool::Player)
+    end
+  end
+
+  context "usability" do
+    before :all do
+      @player = OSRS::Player.new "jebrim", force: true
+      @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
+
+    it "individual skill lookup" do
+      @stats.stats.each do |stat|
+        stat.should be_a(RsHiscores::Stat)
+        stat.each do |elem|
+          elem.should be_a(Numeric)
+        end
+      end
+    end
+
+    it "named stat lookup" do
+      OSRS::Stats::Skills.each do |skill|
+        @stats.send(skill.to_sym).should be_a(RsHiscores::Stat)
+      end
+    end
+  end
+end

data/spec/player_spec.rb

@@ -0,0 +1,74 @@
+# -*- coding: utf-8 -*-
+require 'spec_helper'
+
+describe RsHiscores::Player do
+	describe "name validation" do
+    context "valid names" do
+      it "ordinary name" do
+        lambda {
+          RsHiscores::Player.new "foot"
+        }.should_not raise_error
+      end
+
+      it "multiple spaces" do
+        lambda {
+          RsHiscores::Player.new "s u  o  m i"
+        }.should_not raise_error
+      end
+
+      it "spaces being replaced" do
+        lambda {
+          RsHiscores::Player.new "s u o m i", force: true
+        }.should_not raise_error
+      end
+    end
+
+    context "errors" do
+      it "invalid characters in name" do
+        lambda {
+          RsHiscores::Player.new "@£$%^&"
+        }.should raise_error(Exception, "invalid characters in name")
+      end
+
+      it "name too long" do
+        lambda {
+          RsHiscores::Player.new "abcdef123456x"
+        }.should raise_error(Exception, "name too long")
+      end
+
+      it "name too short" do
+        lambda {
+          RsHiscores::Player.new ""
+        }.should raise_error(Exception, "name too short")
+      end
+
+      it "name starts/ends with space character" do
+        lambda {
+          RsHiscores::Player.new "_heh_"
+        }.should raise_error(Exception, "name starts/ends with a space character")
+      end
+    end
+	end
+
+  describe "highscore lookup" do
+    it "member lookup" do
+      player = RsHiscores::Player.new "jake", force: true # Not Foot in case he cancels membership
+
+      lambda {
+        player.fetch_highscores
+      }.should_not raise_error
+
+      player.raw_stats.should_not be_nil
+      player.raw_stats.length.should_not eq(0)
+      player.raw_stats.each { |e| e.end_with?("\n").should be_false }
+
+      player.stats.should be_a(RsHiscores::Stats)
+    end
+
+    it "non-member/banned lookup" do
+      lambda {
+        RsHiscores::Player.new "smithking087", force: true # Known banned player
+      }.should raise_error(OpenURI::HTTPError)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'rshiscores'
+
+RSpec.configure do |config|
+  config.mock_with :rspec
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: rshiscores
+version: !ruby/object:Gem::Version
+  version: 3.0.0
+platform: ruby
+authors:
+- Sam Broughton
+- Joshua Bell
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Easy to use gem for downloading and parsing Runescape hiscores
+email:
+- sam@26th-zerk.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rshiscores.rb
+- lib/rshiscores/oldschool.rb
+- lib/rshiscores/player.rb
+- lib/rshiscores/stats.rb
+- rshiscores.gemspec
+- spec/lookup_spec.rb
+- spec/oldschool_spec.rb
+- spec/player_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/sambooo/RsHighscores
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: RS Hiscore Parser
+test_files:
+- spec/lookup_spec.rb
+- spec/oldschool_spec.rb
+- spec/player_spec.rb
+- spec/spec_helper.rb