rumble_bundle 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 06ac207177a08474c3d5c241685bd4a3e6fcde1e
+  data.tar.gz: e14ee7a9be2aa91b10fb7b03955a7ef31289be2c
+SHA512:
+  metadata.gz: 90978f729a1b41cb2ab29a7d7abcdf8b5eb39c022a0310d79436a60523d7149da86cc7eaf8555032b5b1fb5af43763804ddcbee55667ed465f0a9b772a92a43e
+  data.tar.gz: e0c9e1e7606c8db082936a80d17adad0196683ec412e3f4c97cfb4af1dfef394246b316e8f385cad230b21645bcc0dd4ef9cb4024717a4eb58230a10e1dce0c9

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/bin/console

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,3 @@
+# Contributor Code of Conduct
+
+This project does not adhere to a code of conduct.

data/Gemfile

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

data/README.md

@@ -0,0 +1,29 @@
+# RumbleBundle
+
+This is a rudimentary info scraper and command line "browser" for the [Humble Bundle](https://www.humblebundle.com/) website, using plain Ruby and Nokogiri.
+
+Upon firing up, it will scrape the Game Bundles, Book Bundles, and Mobiles Bundles tabs (along with any sub-tabs) for ongoing bundles. Once it's finished, you can query the scraped information via the command prompt.
+
+Available information for each bundle includes: Name, Supported Charities, Donation Tiers and Included Products, Total MSRP, and URL.
+
+Available products can also be filtered by tags like `linux`, or `drm-free`, or multiple at once (`windows linux drm-free`).
+
+## Installation
+
+Install via:
+```
+$ gem install rumble_bundle
+```
+
+## Usage
+
+Run via:
+```
+$ rumble_bundle
+```
+
+Then follow the on-screen prompts. :)
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/repromancer/rumble_bundle.

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/UNLICENSE.md

@@ -0,0 +1,24 @@
+This is free and unencumbered software released into the public domain.
+
+Anyone is free to copy, modify, publish, use, compile, sell, or
+distribute this software, either in source code form or as a compiled
+binary, for any purpose, commercial or non-commercial, and by any
+means.
+
+In jurisdictions that recognize copyright laws, the author or authors
+of this software dedicate any and all copyright interest in the
+software to the public domain. We make this dedication for the benefit
+of the public at large and to the detriment of our heirs and
+successors. We intend this dedication to be an overt act of
+relinquishment in perpetuity of all present and future rights to this
+software under copyright law.
+
+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 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.
+
+For more information, please refer to <https://unlicense.org>

data/bin/rumble_bundle

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require "./config/environment"
+
+RumbleBundle::CLI.new.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/config/environment.rb

@@ -0,0 +1,10 @@
+require 'bundler/setup'
+require 'open-uri'
+require 'nokogiri'
+
+require 'rumble_bundle'
+
+require_relative '../lib/rumble_bundle/cli'
+require_relative '../lib/rumble_bundle/scraper'
+require_relative '../lib/rumble_bundle/bundle'
+require_relative '../lib/rumble_bundle/product'

data/lib/rumble_bundle.rb

@@ -0,0 +1,4 @@
+require "rumble_bundle/version"
+
+module RumbleBundle
+end

data/lib/rumble_bundle/bundle.rb

@@ -0,0 +1,29 @@
+class RumbleBundle::Bundle
+
+  attr_accessor :name, :tiers, :products, :charities, :total_msrp, :url
+
+  @@all = []
+
+  def self.all
+    @@all
+  end
+
+  def initialize(data_hash)
+    data_hash.each{|key, val| self.send("#{key}=", val)}
+    self.class.all << self
+  end
+
+
+
+  def products=(array)
+
+    #associate incoming products with Bundle
+    @products = array.tap do |products|
+      products.each do |product|
+        product.bundle = self
+      end
+    end
+
+  end
+
+end

data/lib/rumble_bundle/cli.rb

@@ -0,0 +1,161 @@
+class RumbleBundle::CLI
+
+  def start
+    puts ""
+    puts "Fetching data from HumbleBundle.com..."
+    puts ""
+
+    RumbleBundle::Scraper.new.crawl_site
+
+    query
+
+  end
+
+
+  def query
+
+    bundles = RumbleBundle::Bundle.all
+
+    puts ""
+    puts "Enter a bundle's number to learn more, or enter 'help' for more commands."
+    puts "Enter 'quit' to leave the program."
+    puts ""
+
+    bundles.each.with_index(1) do |bundle, i|
+      puts "[#{i}] #{bundle.name}"
+    end
+
+    puts ""
+    print " "
+    input = gets.strip.downcase
+    puts ""
+
+    if input.to_i.between?(1, bundles.length)
+      display_bundle(bundles[input.to_i - 1])
+    elsif input.to_i < 0 || input.to_i > bundles.length
+      puts ""
+      puts "Sorry! Please enter a valid number or command."
+      query
+
+    else
+      case input
+      when 'help'
+        help
+      when 'quit'
+        quit
+      else
+        filter(input)
+      end
+    end
+
+  end
+
+  def filter(input)
+    filters = %w[drm-free steam-key windows mac linux android]
+    valid = filters & input.split
+    if valid.any?
+      filtered = RumbleBundle::Product.all.collect{|p| p}
+      valid.each do |filter|
+        case filter
+        when 'windows','mac','linux','android'
+          filtered.delete_if{|p| ! p.platforms.include?(filter.capitalize)}
+        when 'drm-free'
+          filtered.delete_if{|p| ! p.drm_free}
+        when 'steam-key'
+          filtered.delete_if{|p| ! p.steam_key}
+        end
+      end
+
+      if filtered.any?
+        puts ""
+        puts "Results for: #{valid}"
+        puts "---------------------------------------------------------------"
+        filtered.collect{|p| p.bundle }.uniq.each do |bundle|
+          puts "#{bundle.name} (#{bundle.url})"
+          puts ""
+          filtered.each{|p| display_product(p) if p.bundle == bundle}
+          puts ""
+        end
+        puts "---------------------------------------------------------------"
+      else
+        puts ""
+        puts "Sorry! No results for: #{valid}"
+        puts "---------------------------------------------------------------"
+        puts "---------------------------------------------------------------"
+      end
+
+    else
+      puts ""
+      puts "Sorry! Please enter a valid number or command."
+      query
+
+    end
+
+    query
+
+  end
+
+  def display_bundle(bundle)
+    puts "---------------------------------------------------------------"
+    puts "#{bundle.name} (#{bundle.url})"
+    puts "#{bundle.total_msrp}!"
+    puts ""
+    puts "Supports:"
+    bundle.charities.each do |c|
+      print "  #{c}"
+      puts ","
+    end
+    puts "  or a Charity of Your Choice"
+    puts "", ""
+    bundle.tiers.each do |tier|
+      puts tier, ""
+      bundle.products.each do |product|
+        if product.tier == tier
+          display_product(product)
+        end
+      end
+      puts ""
+    end
+    puts "---------------------------------------------------------------"
+
+    query
+  end
+
+  def display_product(product)
+    print "  #{product.name}"
+    print " (#{product.platforms.join(", ")})" if product.platforms.any?
+    print " (DRM-Free!)" if product.drm_free
+    print " (w/Steam Key!)" if product.steam_key
+    puts ""
+    puts "    #{product.subtitle}" if product.subtitle
+    puts ""
+  end
+
+  def help
+    puts <<~HEREDOC
+    ---------------------------------------------------------------
+    You can enter a filter to list all products matching that filter.
+    You can combine multiple filters in a space-separated list.
+
+      e.g. 'drm-free linux'
+
+    drm-free
+    steam-key
+    windows
+    mac
+    linux
+    android
+
+    Press any key to continue.
+    ---------------------------------------------------------------
+    HEREDOC
+    STDIN.getch
+    query
+  end
+
+  def quit
+    exit
+  end
+
+end
+

data/lib/rumble_bundle/product.rb

@@ -0,0 +1,16 @@
+class RumbleBundle::Product
+
+  attr_accessor :name, :subtitle, :bundle, :tier, :platforms, :drm_free, :steam_key
+
+  @@all = []
+
+  def self.all
+    @@all
+  end
+
+  def initialize(data_hash)
+    data_hash.each{|key, val| self.send("#{key}=", val)}
+    self.class.all << self
+  end
+
+end

data/lib/rumble_bundle/scraper.rb

@@ -0,0 +1,128 @@
+class RumbleBundle::Scraper
+
+  def initialize
+    @base_url = 'https://www.humblebundle.com'
+    @main_pages = [
+      'https://www.humblebundle.com/',
+      'https://www.humblebundle.com/books/',
+      'https://www.humblebundle.com/mobile/']
+  end
+
+
+
+  def crawl_site
+
+    @main_pages.each do |page|
+      first_page = Nokogiri::HTML(open(page))
+      scrape_bundle(first_page, page)
+
+      if first_page.at_css(".js-highlight.subtab-button")
+        tab_bar = first_page.css(".js-highlight.subtab-button")
+        links = tab_bar.collect{|a| @base_url + a.attr("href") }
+
+        links.each do |link|
+          scrape_bundle(Nokogiri::HTML(open(link)), link)
+        end
+      end
+    end
+
+  end
+
+
+
+  def scrape_bundle(html, url)
+
+    bundle = {
+      'name' => '',
+      'tiers' => [],
+      'products' => [],
+      'charities' => [],
+      'total_msrp' => '',
+      'url' => url
+    }
+
+    bundle['name'] = html.css("title").text.chomp("(pay what you want and help charity)").strip
+
+    bundle['charities'] = html.css(".charity-image-wrapper img").collect{|img| img.attr("alt")}
+
+    #for each tier in bundle
+    html.css(".main-content-row").each do |tier|
+
+      #add tier to Bundle @tiers array
+      tier_name = tier.css(".dd-header-headline").text.strip
+      if tier_name.downcase.include?("charity")
+        break
+      end
+
+      bundle['tiers'] << tier_name
+
+      #and instantiate products from tier
+      tier.css(".game-boxes").each do |box|
+        scrape_product(box, tier_name).tap do |product|
+          bundle['products'] << product
+        end
+      end
+
+    end
+
+    bundle['total_msrp'] = html.css('.hr-tagline-text').detect{|e| e.text.include?("worth")}.text.strip
+
+    RumbleBundle::Bundle.new(bundle)
+
+  end
+
+
+
+  def scrape_product(box, tier)
+
+    product = {
+      'name' => '',
+      'subtitle' => '',
+      'bundle' => '',
+      'tier' => '',
+      'platforms' => [],
+      'drm_free' => nil,
+      'steam_key' => nil
+    }
+
+    product['name'] = box.css(".dd-image-box-caption").text.strip
+    product['tier'] = tier
+    product['subtitle'] = if box.at_css(".subtitle")
+      box.css(".subtitle .callout-msrp").remove
+      if box.css(".subtitle").text.strip != ""
+        box.css(".subtitle").text.strip
+      else
+        nil
+      end
+    end
+
+    product['platforms'] = Array.new.tap do |platforms|
+      if box.at_css(".dd-availability-icon > i.hb-android")
+        platforms << 'Android'
+      end
+
+      if box.at_css(".dd-availability-icon > i.hb-linux")
+        platforms << 'Linux'
+      end
+
+      if box.at_css(".dd-availability-icon > i.hb-windows")
+        platforms << 'Windows'
+      end
+
+      if box.at_css(".dd-availability-icon > i.hb-osx")
+        platforms << 'Mac'
+      end
+
+    end
+
+    product['drm_free'] = box.at_css(".dd-availability-icon > i.hb-drmfree") ?
+      true : false
+
+    product['steam_key'] = box.at_css(".dd-availability-icon > i.hb-steam") ?
+      true : false
+
+    RumbleBundle::Product.new(product)
+
+  end
+
+end

data/lib/rumble_bundle/version.rb

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

data/rumble_bundle.gemspec

@@ -0,0 +1,36 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "rumble_bundle/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "rumble_bundle"
+  spec.version       = RumbleBundle::VERSION
+  spec.authors       = ["Noah Summers"]
+  spec.email         = ["connect@repromancer.me"]
+
+  spec.summary       = %q{Simple command line reader for the Humble Bundle website.}
+
+  spec.description   = %q{This is a rudimentary info scraper and command line "browser" for the Humble Bundle website, using plain Ruby and Nokogiri.
+
+  Upon firing up, it will scrape the Game Bundles, Book Bundles, and Mobiles Bundles tabs (along with any sub-tabs) for ongoing bundles. Once it's finished, you can query the scraped information via the command prompt.
+
+  Available information for each bundle includes: Name, Supported Charities, Donation Tiers and Included Products, Total MSRP, and URL.
+
+  Available products can also be filtered by tags like linux, or drm-free, or multiple at once (windows linux drm-free).}
+
+  spec.homepage      = "https://github.com/repromancer/rumble_bundle"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "bin"
+  spec.executables  << 'rumble_bundle'
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "pry"
+
+  spec.add_dependency "nokogiri", "~> 1.7"
+end

data/spec.md

@@ -0,0 +1,12 @@
+# Specifications for the CLI Assessment
+
+Specs:
+- [x] Have a CLI for interfacing with the application
+> All user interaction occurs through `RumbleBundle::CLI`, beginning with `#start`, looping through `#query`, and ending with `#quit`.
+
+- [x] Pull data from an external source
+> Except for the `@base_url` and `@main_pages` used as a starting point by `RumbleBundle::Scraper` (unpredictable sub-urls are fetched during scraping), all data comes from [the Humble Bundle website](http://humblebundle.com/).
+
+- [x] Implement both list and detail views
+> Once the site has been scraped, a list of all bundles on sale is presented; the user can then select a bundle to see a detailed view of its content.
+> The user can also filter available products by entering a space-separated list of one or more tags such as `linux` or `drm-free`; search results are sorted by bundle.

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: rumble_bundle
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Noah Summers
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-06-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !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: pry
+  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: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+description: |-
+  This is a rudimentary info scraper and command line "browser" for the Humble Bundle website, using plain Ruby and Nokogiri.
+
+    Upon firing up, it will scrape the Game Bundles, Book Bundles, and Mobiles Bundles tabs (along with any sub-tabs) for ongoing bundles. Once it's finished, you can query the scraped information via the command prompt.
+
+    Available information for each bundle includes: Name, Supported Charities, Donation Tiers and Included Products, Total MSRP, and URL.
+
+    Available products can also be filtered by tags like linux, or drm-free, or multiple at once (windows linux drm-free).
+email:
+- connect@repromancer.me
+executables:
+- rumble_bundle
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- README.md
+- Rakefile
+- UNLICENSE.md
+- bin/console
+- bin/rumble_bundle
+- bin/setup
+- config/environment.rb
+- lib/rumble_bundle.rb
+- lib/rumble_bundle/bundle.rb
+- lib/rumble_bundle/cli.rb
+- lib/rumble_bundle/product.rb
+- lib/rumble_bundle/scraper.rb
+- lib/rumble_bundle/version.rb
+- rumble_bundle.gemspec
+- spec.md
+homepage: https://github.com/repromancer/rumble_bundle
+licenses: []
+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.6.11
+signing_key: 
+specification_version: 4
+summary: Simple command line reader for the Humble Bundle website.
+test_files: []