playoverwatch-scraper 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4ba4b5008c58bd07896e5443795e32044734d99233e7d2ffa76747f3d098de95
+  data.tar.gz: 1f8a0fa7d81a5527ff146153269e34903a2733d528dd9aee1bd8c5b050ee1b38
+SHA512:
+  metadata.gz: 6d887e89c72c7a94d3eea83617e71e7e79614402d043019cdef86f5ababe8d99195f11cd4494f57d2bd9d1b72ac7211b64776a2ddfcba28dcdb1e24c25fdb9e0
+  data.tar.gz: 4972ea7ff6bf8e7a162e5ee1d59cf193762f07c52ee08726bf507d6de644dc38ba246e115ded1acbcfa9a82cd37ea00ced70705655447c6b54d93c473db7f3ee

data/.gitignore

@@ -0,0 +1,85 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+
+# Created by https://www.gitignore.io/api/macos,linux,windows
+
+### Linux ###
+*~
+
+# temporary files which can be created if a process still has a handle open of a deleted file
+.fuse_hidden*
+
+# KDE directory preferences
+.directory
+
+# Linux trash folder which might appear on any partition or disk
+.Trash-*
+
+# .nfs files are created when an open file is removed but is still being accessed
+.nfs*
+
+### macOS ###
+# General
+.DS_Store
+.AppleDouble
+.LSOverride
+
+# Icon must end with two \r
+Icon
+
+# Thumbnails
+._*
+
+# Files that might appear in the root of a volume
+.DocumentRevisions-V100
+.fseventsd
+.Spotlight-V100
+.TemporaryItems
+.Trashes
+.VolumeIcon.icns
+.com.apple.timemachine.donotpresent
+
+# Directories potentially created on remote AFP share
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk
+
+### Windows ###
+# Windows thumbnail cache files
+Thumbs.db
+ehthumbs.db
+ehthumbs_vista.db
+
+# Dump file
+*.stackdump
+
+# Folder config file
+[Dd]esktop.ini
+
+# Recycle Bin used on file shares
+$RECYCLE.BIN/
+
+# Windows Installer files
+*.cab
+*.msi
+*.msix
+*.msm
+*.msp
+
+# Windows shortcuts
+*.lnk
+
+
+# End of https://www.gitignore.io/api/macos,linux,windows

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,10 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5.1
+before_install: gem install bundler -v 1.16.2
+deploy:
+  provider: rubygems
+  api_key: $RUBYGEMS_API_KEY
+  on:
+    tags: true

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+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.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at duncanleo97@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,10 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in playoverwatch-scraper.gemspec
+gemspec
+
+gem "nokogiri", "~> 1.8"
+
+gem "pry", "~> 0.11.3", :group => [:development]

data/Gemfile.lock

@@ -0,0 +1,45 @@
+PATH
+  remote: .
+  specs:
+    playoverwatch-scraper (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.2)
+    diff-lcs (1.3)
+    method_source (0.9.0)
+    mini_portile2 (2.3.0)
+    nokogiri (1.8.4)
+      mini_portile2 (~> 2.3.0)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  nokogiri (~> 1.8)
+  playoverwatch-scraper!
+  pry (~> 0.11.3)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.16.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Duncan Leo
+
+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,51 @@
+# playoverwatch-scraper
+[RubyDocs](https://www.rubydoc.info/github/bottleneckco/playoverwatch-scraper/master)
+[![Build Status](https://travis-ci.org/bottleneckco/playoverwatch-scraper.svg?branch=master)](https://travis-ci.org/bottleneckco/playoverwatch-scraper)
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/playoverwatch/scraper`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'playoverwatch-scraper'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install playoverwatch-scraper
+
+## Usage
+
+```ruby
+scraper = PlayOverwatch::Scraper.new('Someone-1234')
+
+# SR
+puts scraper.sr
+
+# Level
+puts scraper.player_level
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+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/[USERNAME]/playoverwatch-scraper. 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](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Playoverwatch project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/playoverwatch-scraper/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "playoverwatch/scraper"
+
+# 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 "pry"
+Pry.start(__FILE__)

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/lib/playoverwatch.rb

@@ -0,0 +1,7 @@
+require "playoverwatch/scraper/version"
+
+##
+# This module wraps the Scraper code
+module PlayOverwatch
+  require 'playoverwatch/scraper'
+end

data/lib/playoverwatch/ranks.json

@@ -0,0 +1,182 @@
+{
+	"918": 0,
+	"919": 0,
+	"91A": 0,
+	"91B": 0,
+	"91C": 0,
+	"91D": 0,
+	"91E": 0,
+	"91F": 0,
+	"920": 0,
+	"921": 0,
+	"922": 1,
+	"924": 1,
+	"925": 1,
+	"926": 1,
+	"94C": 1,
+	"927": 1,
+	"928": 1,
+	"929": 1,
+	"92B": 1,
+	"950": 1,
+	"92A": 2,
+	"92C": 2,
+	"937": 2,
+	"93B": 2,
+	"933": 2,
+	"923": 2,
+	"944": 2,
+	"948": 2,
+	"93F": 2,
+	"951": 2,
+	"92D": 3,
+	"930": 3,
+	"934": 3,
+	"938": 3,
+	"940": 3,
+	"949": 3,
+	"952": 3,
+	"94D": 3,
+	"945": 3,
+	"93C": 3,
+	"92E": 4,
+	"931": 4,
+	"935": 4,
+	"93D": 4,
+	"946": 4,
+	"94A": 4,
+	"953": 4,
+	"94E": 4,
+	"939": 4,
+	"941": 4,
+	"92F": 5,
+	"932": 5,
+	"93E": 5,
+	"936": 5,
+	"93A": 5,
+	"942": 5,
+	"947": 5,
+	"94F": 5,
+	"94B": 5,
+	"954": 5,
+	"956": 6,
+	"95C": 6,
+	"95D": 6,
+	"95E": 6,
+	"95F": 6,
+	"960": 6,
+	"961": 6,
+	"962": 6,
+	"963": 6,
+	"964": 6,
+	"957": 7,
+	"965": 7,
+	"966": 7,
+	"967": 7,
+	"968": 7,
+	"969": 7,
+	"96A": 7,
+	"96B": 7,
+	"96C": 7,
+	"96D": 7,
+	"958": 8,
+	"96E": 8,
+	"96F": 8,
+	"970": 8,
+	"971": 8,
+	"972": 8,
+	"973": 8,
+	"974": 8,
+	"975": 8,
+	"976": 8,
+	"959": 9,
+	"977": 9,
+	"978": 9,
+	"979": 9,
+	"97A": 9,
+	"97B": 9,
+	"97C": 9,
+	"97D": 9,
+	"97E": 9,
+	"97F": 9,
+	"95A": 10,
+	"980": 10,
+	"981": 10,
+	"982": 10,
+	"983": 10,
+	"984": 10,
+	"985": 10,
+	"986": 10,
+	"987": 10,
+	"988": 10,
+	"95B": 11,
+	"989": 11,
+	"98A": 11,
+	"98B": 11,
+	"98C": 11,
+	"98D": 11,
+	"98E": 11,
+	"98F": 11,
+	"991": 11,
+	"990": 11,
+	"992": 12,
+	"993": 12,
+	"994": 12,
+	"995": 12,
+	"996": 12,
+	"997": 12,
+	"998": 12,
+	"999": 12,
+	"99A": 12,
+	"99B": 12,
+	"99C": 13,
+	"99D": 13,
+	"99E": 13,
+	"99F": 13,
+	"9A0": 13,
+	"9A1": 13,
+	"9A2": 13,
+	"9A3": 13,
+	"9A4": 13,
+	"9A5": 13,
+	"9A6": 14,
+	"9A7": 14,
+	"9A8": 14,
+	"9A9": 14,
+	"9AA": 14,
+	"9AB": 14,
+	"9AC": 14,
+	"9AD": 14,
+	"9AE": 14,
+	"9AF": 14,
+	"9B0": 15,
+	"9B1": 15,
+	"9B2": 15,
+	"9B3": 15,
+	"9B4": 15,
+	"9B5": 15,
+	"9B6": 15,
+	"9B7": 15,
+	"9B8": 15,
+	"9B9": 15,
+	"9BA": 16,
+	"9BB": 16,
+	"9BC": 16,
+	"9BD": 16,
+	"9BE": 16,
+	"9BF": 16,
+	"9C0": 16,
+	"9C1": 16,
+	"9C2": 16,
+	"9C3": 16,
+	"9C4": 17,
+	"9C5": 17,
+	"9C6": 17,
+	"9C7": 17,
+	"9C8": 17,
+	"9C9": 17,
+	"9CA": 17,
+	"9CB": 17,
+	"9CC": 17,
+	"9CD": 17
+}

data/lib/playoverwatch/scraper.rb

@@ -0,0 +1,79 @@
+require 'json'
+require 'nokogiri'
+require 'open-uri'
+
+CHROME_USER_AGENT = 'Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/60.0.3112.113 Safari/537.36'
+
+module PlayOverwatch
+  ##
+  # This class represents a scraper that can be used to retrieve certain statistics.
+  class Scraper
+    ##
+    # Creates a scraper with a specified battle tag.
+    # The +battle_tag+ can be in the hex (#) or hyphenated (-) format. It IS case sensitive.
+    def initialize(battle_tag)
+      @player_page = Nokogiri::HTML(open("https://playoverwatch.com/en-us/career/pc/#{battle_tag.gsub(/#/, '-')}", "User-Agent" => CHROME_USER_AGENT))
+    end
+
+    ##
+    # Retrieve the player's player icon. Returns an image URL.
+    def player_icon
+      @player_page.css('img.player-portrait').first["src"]
+    end
+
+    ##
+    # Retrieve a player's level
+    def player_level
+      quotient = 0
+      remainder = @player_page.css('.player-level .u-vertical-center').first.content.to_i
+      player_rank_div = @player_page.css('.player-rank')
+      if player_rank_div.any?
+        level_stars_image_url_code = player_rank_div.first['style'].scan(/0x0250000000000(.+?)_Rank.png/i).flatten
+        if level_stars_image_url_code.any?
+          quotient = 100 * rank_map[level_stars_image_url_code.first]
+        end
+      end
+      return quotient + remainder
+    end
+
+    ##
+    # Retrieve a player's endorsement level
+    def endorsement_level
+      @player_page.css('.endorsement-level .u-center').first.content.to_i
+    end
+
+    ##
+    # Retrieve a player's current competitive season ranking.
+    # Returns -1 if player did not complete placements.
+    def sr
+      comp_div = @player_page.css('.competitive-rank > .h5')
+      return -1 if comp_div.empty?
+      content = comp_div.first.content
+      content.to_i if Integer(content) rescue -1
+    end
+
+    ##
+    # Retrieve player's main Quick Play hero, in lowercase form.
+    def main_qp
+      hero_img = hidden_mains_style.content.scan(/\.quickplay {.+?url\((.+?)\);/mis).flatten.first
+      hero_img.scan(/\/hero\/(.+?)\/career/i).flatten.first
+    end
+
+    ##
+    # Retrieve player's main Competitive hero, in lowercase form.
+    # You should check if the sr is -1 before attempting to call this.
+    def main_comp
+      hero_img = hidden_mains_style.content.scan(/\.competitive {.+?url\((.+?)\);/mis).flatten.first
+      hero_img.scan(/\/hero\/(.+?)\/career/i).flatten.first
+    end
+
+    private
+    def rank_map
+      JSON.parse File.read(File.expand_path('./ranks.json', __dir__))
+    end
+
+    def hidden_mains_style
+      @player_page.css('style').first
+    end
+  end
+end

data/lib/playoverwatch/version.rb

@@ -0,0 +1,3 @@
+module PlayOverwatch
+  VERSION = "0.1.0"
+end

data/playoverwatch-scraper.gemspec

@@ -0,0 +1,38 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "playoverwatch/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "playoverwatch-scraper"
+  spec.version       = PlayOverwatch::VERSION
+  spec.authors       = ["Duncan Leo"]
+  spec.email         = ["duncanleo97@gmail.com"]
+
+  spec.summary       = "Library to get player details"
+  spec.description   = "Scraper library for playoverwatch.com"
+  spec.homepage      = "https://github.com/bottleneckco/playoverwatch-scraper"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  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
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: playoverwatch-scraper
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Duncan Leo
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-08-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Scraper library for playoverwatch.com
+email:
+- duncanleo97@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/playoverwatch.rb
+- lib/playoverwatch/ranks.json
+- lib/playoverwatch/scraper.rb
+- lib/playoverwatch/version.rb
+- playoverwatch-scraper.gemspec
+homepage: https://github.com/bottleneckco/playoverwatch-scraper
+licenses:
+- MIT
+metadata:
+  allowed_push_host: 'TODO: Set to ''http://mygemserver.com'''
+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.7.7
+signing_key: 
+specification_version: 4
+summary: Library to get player details
+test_files: []