grifts 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fb6e690c4120116752089f7279b2e2d0733ed2ca
+  data.tar.gz: 59753e4f553c0744690563f01e029b6a10f7b374
+SHA512:
+  metadata.gz: 6d8edbdc80fd539c42bcc62cb4e2c70c73e3f61bf06e9491a65dec9082124e91ec88a992f3670d58ba3b220ed9fdbed3bf12f4201da1524b85f02b752a99a04f
+  data.tar.gz: 825b358c26e12453d72f70538b4f15e23b1b499c3df635f0239f3bcd95463734087e75141fa05ca73edec334568ebe7a61cb41564f12cb20bc291ca9f308f623

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+grits-0.1.1a.gem

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at gerald2557@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 gerald hernandez
+
+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,48 @@
+# Grifts
+
+Web scraper that retrieves "Diablo 3" leaderboard information. This is my first gem so expect some convention errors.
+Currently you can scrape seasonal leaderboards for all the hero classes.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'grifts'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install grifts
+
+## Usage
+```ruby
+require 'grifts'
+
+# create a new leaderboard, season 6 for demonhunters
+leaderboard = Leaderboard.new(6, :demonhunter)
+
+# scrape the season 6 demonhunter leaderboard with a 10 second timeout
+# returns true if successful
+leaderboard.scrape(10)
+
+# all 1,000 positions will be in in order in the ladder variable
+leaderboard.ladder
+```
+
+## Development
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/monoliths/grifts. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+task default:  :spec
+
+Rake::TestTask.new do |t|
+  t.libs << "tests"
+  t.test_files = FileList['tests/test*.rb']
+  t.verbose = true
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "grifts"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/grifts.gemspec

@@ -0,0 +1,34 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'grifts/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'grifts'
+  spec.version       = Grifts::VERSION
+  spec.authors       = ['gerald hernandez']
+  spec.email         = ['gerald2557@gmail.com']
+
+  spec.summary       = 'A gem for scraping diablo 3
+                        greater rift leaderboard ranks.'
+  spec.description   = 'Scrape diablo 3 leaderboard ranks.'
+  spec.homepage      = 'https://github.com/monoliths/grifts'
+  spec.license       = 'MIT'
+
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
+  # else
+  #   raise
+  #     'RubyGems 2.0 or newer is required to protect against public gem pushes.'
+  # end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject{ |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.test_files    = ['tests/test_leaderboard.rb']
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.12'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_dependency 'nokogiri', '~> 1.6.8'
+end

data/lib/grifts.rb

@@ -0,0 +1,6 @@
+require 'grifts/version'
+require 'leaderboard/leaderboard'
+
+module Grifts
+  extend self
+end

data/lib/grifts/version.rb

@@ -0,0 +1,3 @@
+module Grifts
+  VERSION = "0.1.2"
+end

data/lib/leaderboard/leaderboard.rb

@@ -0,0 +1,65 @@
+require 'open-uri'
+require 'nokogiri'
+require 'timeout'
+
+class Leaderboard
+  attr_accessor :season, :hero, :ladder
+  attr_reader :hero_classes
+  HERO_CLASSES = { barbarian: 'barbarian',
+                    witchdoctor: 'wd',
+                    demonhunter: 'dh',
+                    monk: 'monk',
+                    wizard: 'wizard',
+                    crusader: 'crusader',
+                    barb: 'barbarian',
+                    wd: 'wd',
+                    dh: 'dh',
+                    wiz: 'wizard',
+                    sader: 'crusader' }.freeze
+                    
+  def initialize(season = 6, hero = :barb)
+    @season = season.to_s
+    @hero = HERO_CLASSES[hero]
+    @ladder = []
+  end
+
+  def valid_leaderboard?
+    return true if !HERO_CLASSES.values.include?(@hero) || !@season.to_i.between?(1, 6)
+  end
+
+  def scrape(timeout = 5)
+    return false if valid_leaderboard?
+    return scrape_core timeout
+  end
+
+  def print(range = (0..9))
+    puts @ladder[range]
+  end
+
+  private
+  ###
+  # The core of the scrape, there is a timeout.
+  # If any error occurs the method returns false.
+  def scrape_core(timeout = 5)
+    begin
+      url = "http://us.battle.net/d3/en/rankings/season/#{@season}/rift-#{@hero}"
+      doc = Timeout::timeout(timeout) do
+        Nokogiri::HTML(open(url), nil, Encoding::UTF_8.to_s)
+      end
+      unless doc.nil?
+        leaders_unformated = doc.xpath('//*/table/tbody/tr//*/a/@href')
+        @ladder.clear
+        leaders_unformated.each_with_index do |player, index|
+            @ladder << player.value
+            @ladder[index].slice!('/d3/en/profile/')
+            @ladder[index].slice!('/')
+        end
+      end
+      return true
+    rescue
+      # Use this as a catch all for any exceptions.
+      # In my testing scraping can sometimes take too long.
+      return false
+    end
+  end
+end

data/tests/test_leaderboard.rb

@@ -0,0 +1,41 @@
+require "./lib/leaderboard/leaderboard.rb"
+require "test/unit"
+
+class TestLeaderboard < Test::Unit::TestCase
+
+  def test_default_leaderboard
+    t_board = Leaderboard.new
+    assert_equal('6', t_board.season)
+    assert_equal('barbarian', t_board.hero)
+    assert_equal([], t_board.ladder)
+  end
+
+  def test_default_leaderboard_scrape
+    # scrape the same leaderbaord twice
+    t_board_a = Leaderboard.new
+    t_board_b = Leaderboard.new
+    scrape_a = t_board_a.scrape
+    scrape_b = t_board_b.scrape
+    assert_equal(t_board_a.hero, t_board_b.hero)
+    assert_equal(t_board_a.season, t_board_b.season)
+    assert_equal(t_board_a.ladder, t_board_b.ladder) if scrape_a and scrape_b
+  end
+
+  def test_custom_leaderboard
+    # scrape the same leaderbaord twice
+    t_board_a = Leaderboard.new(5, :wd)
+    t_board_b = Leaderboard.new(5, :wd)
+    scrape_a = t_board_a.scrape
+    scrape_b = t_board_b.scrape
+    assert_equal(t_board_a.hero, t_board_b.hero)
+    assert_equal(t_board_a.season, t_board_b.season)
+    assert_equal(t_board_a.ladder, t_board_b.ladder) if scrape_a and scrape_b
+  end
+
+  def test_invalid_hero
+    t_board = Leaderboard.new(6, :necromancer)
+    scrape = t_board.scrape
+    assert_equal(false, scrape)
+  end
+  
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: grifts
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- gerald hernandez
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-06-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.8
+description: Scrape diablo 3 leaderboard ranks.
+email:
+- gerald2557@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- grifts.gemspec
+- lib/grifts.rb
+- lib/grifts/version.rb
+- lib/leaderboard/leaderboard.rb
+- tests/test_leaderboard.rb
+homepage: https://github.com/monoliths/grifts
+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.5.1
+signing_key: 
+specification_version: 4
+summary: A gem for scraping diablo 3 greater rift leaderboard ranks.
+test_files:
+- tests/test_leaderboard.rb