rumble_bundle 0.1.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1e0cbcb6413466b3ddec4ca3814ceb129224bee6
-  data.tar.gz: 14e09388a179ac90ff1d7df78f261875e5ad618c
+  metadata.gz: ab912ac3d3ab1fa15544e0d5dde4421d1a9fb30c
+  data.tar.gz: '0479427cfff6e9e85a85d04917aaa9718f93c863'
 SHA512:
-  metadata.gz: d89e2671e1b6577fbe99bec9951534b548852e381c97e29ccfed36e39067f1dcd4107b1775b0d15fdc9b609a7c1eecdb69b2e46df6b72379d11dfa5baabcc119
-  data.tar.gz: 88ee8a990f923acf5826737c2eea0d44520ee42a01d96b0fb08d1fb636e396132ce4f104377910801712341dfe1566bc1edc608d3fa7f620e592228d2b5a488e
+  metadata.gz: 9675a0ac23f75668bbf7ec75f61d13635b7d224d4cd240f93240c129f9c3ddb7033bf8eb7d1b6218c75d513a72f8f12bf157b95002d32718262b99918aaa1941
+  data.tar.gz: 54f374f52c02574af06e8e06ea3649d5dc82173f68e9b8e3213168d8677d6ca6a789c0210e24003a782607a2141c28bbd53cbfee66a7533efa37681a7fec2820

data/Gemfile

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

data/README.md

@@ -27,3 +27,9 @@ Then follow the on-screen prompts. :)
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/repromancer/rumble_bundle.
+
+## License
+
+This is free and unencumbered software released into the public domain.
+
+For more information, please refer to the included UNLICENSE.md or <https://unlicense.org>

data/bin/setup

@@ -3,6 +3,4 @@ set -euo pipefail
 IFS=$'\n\t'
 set -vx
 
-bundle install
-
-# Do any other automated setup that you need to do here
+bundle install

data/config/environment.rb

@@ -4,7 +4,8 @@ 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'
+require_relative '../lib/rumble_bundle/tier'
+require_relative '../lib/rumble_bundle/product'
+require_relative '../lib/rumble_bundle/scraper'
+require_relative '../lib/rumble_bundle/cli'

data/lib/rumble_bundle/bundle.rb

@@ -1,6 +1,6 @@
 class RumbleBundle::Bundle
 
-  attr_accessor :name, :tiers, :products, :charities, :total_msrp, :url
+  attr_accessor :name, :url, :tiers, :charities, :total_msrp
 
   @@all = []
 
@@ -8,22 +8,13 @@ class RumbleBundle::Bundle
     @@all
   end
 
-  def initialize(data_hash)
-    data_hash.each{|key, val| self.send("#{key}=", val)}
+  def initialize
     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
-
+  def products
+    # Leverage Bundle#tiers to expose a flat array of a Bundle's Products.
+    self.tiers.collect{|t| t.products}.flatten
   end
 
 end

data/lib/rumble_bundle/cli.rb

@@ -1,5 +1,6 @@
 class RumbleBundle::CLI
 
+  # Scrape site and allow user to begin browsing.
   def start
     puts ""
     puts "Fetching data from HumbleBundle.com..."
@@ -12,6 +13,7 @@ class RumbleBundle::CLI
   end
 
 
+
   def query
 
     bundles = RumbleBundle::Bundle.all
@@ -21,22 +23,28 @@ class RumbleBundle::CLI
     puts "Enter 'quit' to leave the program."
     puts ""
 
+    # List Bundles in numbered order
     bundles.each.with_index(1) do |bundle, i|
       puts "[#{i}] #{bundle.name}"
     end
 
+    # Get user input
     puts ""
     print " "
     input = gets.strip.downcase
     puts ""
 
+    # If input is a valid number, display the corresponding Bundle
     if input.to_i.between?(1, bundles.length)
       display_bundle(bundles[input.to_i - 1])
+
+    # If input is an invalid number, restart #query
     elsif input.to_i < 0 || input.to_i > bundles.length
       puts ""
       puts "Sorry! Please enter a valid number or command."
       query
 
+    # Check for 'help' or 'quit' commands, else pass input to #filter
     else
       case input
       when 'help'
@@ -50,9 +58,14 @@ class RumbleBundle::CLI
 
   end
 
+
+
   def filter(input)
+    # Compare input to recognized tags
     filters = %w[drm-free steam-key windows mac linux android]
     valid = filters & input.split
+
+    # If input is valid, collect an array of all Products, remove any that do not match search tags, then display results in a formatted list
     if valid.any?
       filtered = RumbleBundle::Product.all.collect{|p| p}
       valid.each do |filter|
@@ -73,8 +86,13 @@ class RumbleBundle::CLI
         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 ""
+          bundle.tiers.each do |tier|
+            if filtered.detect{|p| p.tier == tier}
+              puts "  #{tier.description}", ""
+              filtered.each{|p| display_product(p) if p.tier == tier}
+              puts ""
+            end
+          end
         end
         puts "---------------------------------------------------------------"
       else
@@ -95,25 +113,24 @@ class RumbleBundle::CLI
 
   end
 
+
+
+  # Display formatted information for given Bundle
   def display_bundle(bundle)
     puts "---------------------------------------------------------------"
     puts "#{bundle.name} (#{bundle.url})"
     puts "#{bundle.total_msrp}!"
     puts ""
-    puts "Supports:"
+    puts "  Supports:"
     bundle.charities.each do |c|
-      print "  #{c}"
+      print "    #{c}"
       puts ","
     end
-    puts "  or a Charity of Your Choice"
+    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 "  #{tier.description}", ""
+      tier.products.each{|p| display_product(p)}
       puts ""
     end
     puts "---------------------------------------------------------------"
@@ -122,15 +139,16 @@ class RumbleBundle::CLI
   end
 
   def display_product(product)
-    print "  #{product.name}"
+    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 "      #{product.subtitle}" if product.subtitle
     puts ""
   end
 
+  # Display help
   def help
     puts <<~HEREDOC
     ---------------------------------------------------------------
@@ -153,6 +171,7 @@ class RumbleBundle::CLI
     query
   end
 
+  # Quit
   def quit
     exit
   end

data/lib/rumble_bundle/product.rb

@@ -8,8 +8,7 @@ class RumbleBundle::Product
     @@all
   end
 
-  def initialize(data_hash)
-    data_hash.each{|key, val| self.send("#{key}=", val)}
+  def initialize
     self.class.all << self
   end
 

data/lib/rumble_bundle/scraper.rb

@@ -1,6 +1,7 @@
 class RumbleBundle::Scraper
 
   def initialize
+    # Set URLs used as starting points for scraping
     @base_url = 'https://www.humblebundle.com'
     @main_pages = [
       'https://www.humblebundle.com/',
@@ -11,15 +12,18 @@ class RumbleBundle::Scraper
 
 
   def crawl_site
-
+    # For each main page
     @main_pages.each do |page|
+      # scrape the bundle from that page
       first_page = Nokogiri::HTML(open(page))
       scrape_bundle(first_page, page)
 
+      # and if there are any sub-pages
       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") }
 
+        # scrape them for bundles too
         links.each do |link|
           scrape_bundle(Nokogiri::HTML(open(link)), link)
         end
@@ -32,96 +36,96 @@ class RumbleBundle::Scraper
 
   def scrape_bundle(html, url)
 
-    bundle = {
-      'name' => '',
-      'tiers' => [],
-      'products' => [],
-      'charities' => [],
-      'total_msrp' => '',
-      'url' => url
-    }
+    RumbleBundle::Bundle.new.tap do |bundle|
 
-    bundle['name'] = html.css("title").text.chomp("(pay what you want and help charity)").strip
+      bundle.url = url
 
-    bundle['charities'] = html.css(".charity-image-wrapper img").collect{|img| img.attr("alt")}
+      # Scrape Bundle metadata
 
-    #for each tier in bundle
-    html.css(".main-content-row").each do |tier|
+      bundle.name = html.css("title").text.chomp("(pay what you want and help charity)").strip
 
-      #add tier to Bundle @tiers array
-      tier_name = tier.css(".dd-header-headline").text.strip
-      if tier_name.downcase.include?("charity")
-        break
-      end
+      bundle.charities = html.css(".charity-image-wrapper img").collect{|img| img.attr("alt")}
 
-      bundle['tiers'] << tier_name
+      bundle.total_msrp = html.css('.hr-tagline-text').detect{|e| e.text.include?("worth")}.text.strip
 
-      #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.tiers = Array.new.tap do |bundle_tiers|
+
+        # For each 'main content row' on the page, instantiate a Tier with its Products and add that Tier to the Bundle's @tiers array
+        html.css(".main-content-row").each do |row|
+
+          row_title = row.css(".dd-header-headline").text.strip
 
-    bundle['total_msrp'] = html.css('.hr-tagline-text').detect{|e| e.text.include?("worth")}.text.strip
+          # Stop iterating if scraper has reached a row which is not a Tier
+          if row_title.downcase.include?("charity")
+            break
+          end
 
-    RumbleBundle::Bundle.new(bundle)
+          bundle_tiers << RumbleBundle::Tier.new.tap do |tier|
+            tier.description = row_title
+            tier.bundle = bundle
+            tier.products = Array.new.tap do |tier_products|
+              row.css(".game-boxes").each do |box|
+                scrape_product(box, bundle, tier).tap do |product|
+                  tier_products << product
+                end
+              end
+            end
+          end
 
+        end
+
+      end
+
+    end
   end
 
 
+  # Self-explanatory
+  def scrape_product(box, bundle, tier)
 
-  def scrape_product(box, tier)
+    RumbleBundle::Product.new.tap do |product|
 
-    product = {
-      'name' => '',
-      'subtitle' => '',
-      'bundle' => '',
-      'tier' => '',
-      'platforms' => [],
-      'drm_free' => nil,
-      'steam_key' => nil
-    }
+      product.bundle = bundle
+      product.tier = tier
 
-    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.name = box.css(".dd-image-box-caption").text.strip
 
-    product['platforms'] = Array.new.tap do |platforms|
-      if box.at_css(".dd-availability-icon > i.hb-android")
-        platforms << 'Android'
+      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
 
-      if box.at_css(".dd-availability-icon > i.hb-linux")
-        platforms << 'Linux'
-      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-windows")
-        platforms << 'Windows'
-      end
+        if box.at_css(".dd-availability-icon > i.hb-linux")
+          platforms << 'Linux'
+        end
 
-      if box.at_css(".dd-availability-icon > i.hb-osx")
-        platforms << 'Mac'
-      end
+        if box.at_css(".dd-availability-icon > i.hb-windows")
+          platforms << 'Windows'
+        end
 
-    end
+        if box.at_css(".dd-availability-icon > i.hb-osx")
+          platforms << 'Mac'
+        end
 
-    product['drm_free'] = box.at_css(".dd-availability-icon > i.hb-drmfree") ?
-      true : false
+      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
+      product.steam_key = box.at_css(".dd-availability-icon > i.hb-steam") ?
+        true : false
 
-    RumbleBundle::Product.new(product)
+    end
 
   end
 

data/lib/rumble_bundle/tier.rb

@@ -0,0 +1,3 @@
+class RumbleBundle::Tier
+  attr_accessor :bundle, :products, :description
+end

data/lib/rumble_bundle/version.rb

@@ -1,3 +1,3 @@
 module RumbleBundle
-  VERSION = "0.1.1"
+  VERSION = "1.0.0"
 end

data/rumble_bundle.gemspec

@@ -24,7 +24,7 @@ Gem::Specification.new do |spec|
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end
-  spec.bindir        = "bin"
+  spec.bindir        = "exe"
   spec.executables  << 'rumble_bundle'
   spec.require_paths = ["lib"]
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rumble_bundle
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Noah Summers
 autorequire: 
-bindir: bin
+bindir: exe
 cert_chain: []
-date: 2017-06-30 00:00:00.000000000 Z
+date: 2017-07-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -88,14 +88,15 @@ files:
 - Rakefile
 - UNLICENSE.md
 - bin/console
-- bin/rumble_bundle
 - bin/setup
 - config/environment.rb
+- exe/rumble_bundle
 - 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/tier.rb
 - lib/rumble_bundle/version.rb
 - rumble_bundle.gemspec
 - spec.md