rshighscores 2.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 344d5fdf838f325840ce3656527d712edd3fb9c6
+  data.tar.gz: b9fd1fe8d2f9a7b4cfc4eb6f8fd3025c672faf77
+SHA512:
+  metadata.gz: c7464194e33cf7d901c109431d5d512f75dd20d989000a0b2939132d53647ffd5745416d3f47bd4980fdc492ff53efa0776be92ddf300a06c873370fb8e7d409
+  data.tar.gz: ef9171b1468052ea74465737d1246f22f472d9fd35053bc4ccdbcec10de6b1c6c24a92621cd617dff9e793960884a53c9b8d89e5580790cb87d3843214cf7040

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 documentation

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+        - 2.0.0

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/OSRSGrabber.png)](https://codeclimate.com/github/sambooo/OSRSGrabber)
+
+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. 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.
+
+### 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 highscores
+
+## Usage
+
+```ruby
+require 'rshighscores'
+
+player = RsHighscores::Player.new "Foot"
+highscores = player.stats
+puts highscores.hunter.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/rshighscores/player.rb

@@ -0,0 +1,32 @@
+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
+      @name = name
+      validate_name
+
+      fetch_highscores if force == :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
+      f = open(@@lookup_url + @name, "User-Agent" => "Ruby/RsHighscoresGrabber")
+      
+      @raw_stats = f.readlines.map &:chomp # readlines preserves newlines??
+      @stats = RsHighscores::Stats.new @raw_stats
+    end
+  end
+end

data/lib/rshighscores/stats.rb

@@ -0,0 +1,64 @@
+module RsHighscores
+  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)
+
+    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
+    end
+
+    def parse_stats
+      validate_raw_stats
+
+      @stats = []
+      @raw_stats.take(@@skills.count).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
+
+    def skill_names
+      @@skills
+    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
+    end
+  end
+end

data/lib/rshighscores.rb

@@ -0,0 +1,7 @@
+%w(player stats).each do |dep|
+  require "rshighscores/#{dep}"
+end
+
+module RsHighscores
+  VERSION = "2.0.0"
+end

data/rshighscores.gemspec

@@ -0,0 +1,25 @@
+# encoding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rshighscores'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rshighscores"
+  spec.version       = RsHighscores::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 highscores} 
+  spec.summary       = %q{RS Highscore Parser}
+  spec.homepage      = "https://github.com/sambooo/OSRSGrabber"
+  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"
+  spec.add_development_dependency "shoulda"
+end

data/spec/lookup_spec.rb

@@ -0,0 +1,86 @@
+require 'spec_helper'
+
+describe RsHighscores::Stats do
+  before :all do
+    @player = RsHighscores::Player.new "jake", :force
+    @stats = RsHighscores::Stats.new @player.raw_stats
+  end
+
+  describe "raw highscore validation" do
+    context "valid input" do
+      it "correct input length" do
+        lambda {
+         @stats = RsHighscores::Stats.new @player.raw_stats
+        }.should_not raise_error
+      end
+    end
+
+    context "invalid input" do
+      it "incorrect input length" do
+        lambda {
+          RsHighscores::Stats.new []
+        }.should raise_error("incorrect input length")
+      end
+
+      it "malformed input line" do
+        lambda {
+          RsHighscores::Stats.new Array.new(44) { "" }
+        }.should raise_error("malformed raw stats")
+      end
+    end
+  end
+
+  describe "stat parsing" do
+    it "parsed output length" do
+     @stats.stats.length.should eq(@stats.skill_names.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
+      @stats.skill_names.each do |name|
+        @stats[name].should be_a(Array)
+      end
+    end
+
+    it "missing method call" do
+      @stats.skill_names.each do |name|
+        @stats.send(name.to_sym).should eq(@stats[name])
+      end
+    end
+  end
+end

data/spec/player_spec.rb

@@ -0,0 +1,67 @@
+require 'spec_helper'
+
+describe RsHighscores::Player do
+	describe "name validation" do
+    context "valid names" do
+      it "ordinary name" do
+        lambda {
+          RsHighscores::Player.new "foot"
+        }.should_not raise_error
+      end
+
+      it "multiple spaces" do
+        lambda {
+          RsHighscores::Player.new "s u  o  m i"
+        }.should_not raise_error
+      end
+    end
+    
+    context "errors" do
+      it "invalid characters in name" do
+        lambda {
+          RsHighscores::Player.new "@£$%^&"
+        }.should raise_error(Exception, "invalid characters in name")
+      end
+
+      it "name too long" do
+        lambda {
+          RsHighscores::Player.new "abcdef123456x"
+        }.should raise_error(Exception, "name too long")
+      end
+
+      it "name too short" do
+        lambda {
+          RsHighscores::Player.new ""
+        }.should raise_error(Exception, "name too short")
+      end
+
+      it "name starts/ends with space character" do
+        lambda {
+          RsHighscores::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 = RsHighscores::Player.new "jake", :force # 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(RsHighscores::Stats)
+    end
+
+    it "non-member/banned lookup" do
+      lambda {
+        RsHighscores::Player.new "smithking087", :force # Known banned player
+      }.should raise_error(OpenURI::HTTPError)
+    end
+  end
+end

data/spec/spec_helper.rb

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

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: rshighscores
+version: !ruby/object:Gem::Version
+  version: 2.0.0
+platform: ruby
+authors:
+- Sam Broughton
+- Joshua Bell
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-29 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'
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  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 highscores
+email:
+- sam@26th-zerk.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rshighscores.rb
+- lib/rshighscores/player.rb
+- lib/rshighscores/stats.rb
+- rshighscores.gemspec
+- spec/lookup_spec.rb
+- spec/player_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/sambooo/OSRSGrabber
+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.0.7
+signing_key: 
+specification_version: 4
+summary: RS Highscore Parser
+test_files:
+- spec/lookup_spec.rb
+- spec/player_spec.rb
+- spec/spec_helper.rb