restaurant_week_boston 1.0.1

data/ChangeLog

@@ -0,0 +1,2 @@
+1.0.0 / 2010-08-14
+* Birthday!

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Gabe Berke-Williams
+
+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.rdoc

@@ -0,0 +1,65 @@
+= Restaurant Week Boston
+This is just a silly little gem I made that parses the Restaurant Week
+Boston (http://www.restaurantweekboston.com/) website and lets you mark which
+ones you want to go to for lunch, dinner, or lunch and dinner.
+
+= Installation
+<tt>gem install restaurant_week_boston</tt>
+
+= Usage
+Use the +restaurant_week_boston+ command line script.
+Use -a/--all, -l/--lunch, and -d/--dinner options to mark restaurants that
+you want to go to for lunch *and* dinner, lunch, or dinner, respectively.
+
+So if you want to go to Bond and Aquitaine Bis for lunch and dinner, you'd
+do
+
+<tt>$ restaurant_week_boston -a 'aquitaine bis',bond</tt>
+
+=== More involved demo
+
+<tt>$ restaurant_week_boston -a 'aquitaine bis' -l bond,asana -d bergamot,clink</tt>
+ Getting doc...done.
+ Parsing doc...done.
+
+ === LUNCH ===
+ Name: Asana (short-name: asana)
+ Meals: Lunch, Dinner
+ Neighborhood: Back Bay
+ Phone: 617-535-8800
+ Lunch Menu: http://www.restaurantweekboston.com/fetch/asana/lunch/
+ Dinner Menu: http://www.restaurantweekboston.com/fetch/asana/dinner/
+ Map: http://www.restaurantweekboston.com/map/back-bay/asana/#topOfMap
+ --------------------------------------------------------------------------------
+ Name: Bond (short-name: bond)
+ Meals: Lunch, Dinner
+ Neighborhood: Downtown
+ Phone: 617-451-1900
+ Lunch Menu: http://www.restaurantweekboston.com/fetch/bond/lunch/
+ Dinner Menu: http://www.restaurantweekboston.com/fetch/bond/dinner/
+ Map: http://www.restaurantweekboston.com/map/downtown/bond/#topOfMap
+
+ === DINNER ===
+ Name: Bergamot (short-name: bergamot)
+ Meals: Dinner
+ Neighborhood: Somerville
+ Phone: <no phone given>
+ Dinner Menu: http://www.restaurantweekboston.com/fetch/bergamot/dinner/
+ Map: http://www.restaurantweekboston.com/map/somerville/bergamot/#topOfMap
+ --------------------------------------------------------------------------------
+ Name: Clink. at the Liberty Hotel (short-name: clink)
+ Meals: Lunch, Dinner
+ Neighborhood: Beacon Hill
+ Phone: 617-224-4004
+ Lunch Menu: http://www.restaurantweekboston.com/fetch/clink/lunch/
+ Dinner Menu: http://www.restaurantweekboston.com/fetch/clink/dinner/
+ Map: http://www.restaurantweekboston.com/map/beacon-hill/clink/#topOfMap
+
+ === LUNCH OR DINNER ===
+ Name: Aquitaine Bis (short-name: aquitaine-bis)
+ Meals: Lunch, Dinner
+ Neighborhood: Chestnut Hill
+ Phone: 617-734-8400
+ Lunch Menu: http://www.restaurantweekboston.com/fetch/aquitaine-bis/lunch/
+ Dinner Menu: http://www.restaurantweekboston.com/fetch/aquitaine-bis/dinner/
+ Map: http://www.restaurantweekboston.com/map/chestnut-hill/aquitaine-bis/#topOfMap

data/bin/restaurant_week_boston

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'restaurant_week_boston'
+runner = RestaurantWeekBoston::Runner.new(ARGV)
+runner.run()

data/lib/restaurant_week_boston/marker.rb

@@ -0,0 +1,63 @@
+require 'restaurant_week_boston/scraper'
+
+module RestaurantWeekBoston
+  # Uses a given Scraper and marks restaurants as good for lunch, dinner, any,
+  # etc.
+  class Marker
+    # +opts+ is a hash with keys for +:lunch+, +:dinner+, and +:any+.
+    # The values of each of these keys should be an array suitable for passing
+    # to Scraper#special_find().
+    def initialize(scraper, opts)
+      @scraper = scraper
+      @opts = opts
+    end
+
+    # Print out restaurants that are good for lunch.
+    def lunch
+      unless @lunch
+        if @opts.key?(:lunch)
+          @lunch = @scraper.special_find(@opts[:lunch])
+        else
+          @lunch = '[no lunch options specified]'
+        end
+      end
+      puts "=== LUNCH ==="
+      puts @lunch
+    end
+
+    # Print out restaurants that are good for dinner.
+    def dinner
+      unless @dinner
+        if @opts.key?(:dinner)
+          @dinner = @scraper.special_find(@opts[:dinner])
+        else
+          @dinner = '[no dinner options specified]'
+        end
+      end
+      puts "=== DINNER ==="
+      puts @dinner
+    end
+
+    # Print out restaurants that are good for lunch or dinner.
+    def any
+      unless @any
+        if @opts.key?(:any)
+          @any = @scraper.special_find(@opts[:any])
+        else
+          @any = '[no "lunch or dinner" options specified]'
+        end
+      end
+      puts "=== LUNCH OR DINNER ==="
+      puts @any
+    end
+
+    # Print lunch(), dinner(), and any(), with newlines between them.
+    def all
+      lunch()
+      puts
+      dinner()
+      puts
+      any()
+    end
+  end
+end

data/lib/restaurant_week_boston/restaurant.rb

@@ -0,0 +1,134 @@
+module RestaurantWeekBoston
+  # A Restaurant has the following properties:
+  # * name ("224 Boston Street")
+  # * short-name ("224-boston-street", used internally by RWB site)
+  # * meals: %w{lunch dinner}, %w{lunch}, %w{dinner}
+  # * neighborhood: "back-bay", etc
+  # * phone: "617-555-1234"
+  # * menu: use menu_link_for("lunch" || "dinner")
+  # * map_link: a link to the RWB map page for that Restaurant
+  class Restaurant
+    include Comparable
+
+    # +entry+ is a Nokogiri::XML::Node from the RWB web site.
+    def initialize(entry)
+      @entry = entry
+    end
+
+
+    # Compares this Restaurant's name to +other+'s name, and returns -1, 0, 1
+    # as appropriate.
+    def <=>(other)
+      return name <=> other.name
+    end
+
+
+    # Generate a pretty representation of the Restaurant.
+    def to_s
+      # back-bay -> "Back Bay"
+      pretty_neighborhood = neighborhood.split('-').map{|x| x.capitalize }.join(' ')
+
+      s = "Name: #{name} (short-name: #{short_name})"
+      s += "\n"
+      s += "Meals: #{meals.map(&:capitalize).join(', ')}"
+      s += "\n"
+      s += "Neighborhood: #{pretty_neighborhood}"
+      s += "\n"
+      s += "Phone: #{phone}"
+      @meals.each do |meal|
+        s += "\n"
+        s += "%s Menu: #{menu_link_for(meal)}" % [meal.capitalize]
+      end
+      s += "\n"
+      s += "Map: #{map_link}"
+      s
+    end
+
+
+    # Returns "<Restaurant: #{restaurant-name}>"
+    def inspect
+      "<Restaurant: #{name}>"
+    end
+
+    # Returns true if this Restaurant offers lunch.
+    def offers_lunch?
+      meals.include?('lunch')
+    end
+
+    # Returns true if this Restaurant offers dinner.
+    def offers_dinner?
+      meals.include?('dinner')
+    end
+
+    # Return the short name (e.g. '224-boston-street' for "224 Boston Street").
+    def short_name
+      @short_name ||= @entry[:id].sub('restaurantID-', '')
+    end
+
+    # Return the full name of this Restaurant, e.g. "224 Boston Street".
+    def name
+      unless @name
+        # UGLY, but it's not wrapped in a tag so there it is.
+        # split: ["224", "Boston", "Street", "[", "map", "]"]
+        split = @entry.css('h4')[0].text.strip.split(/\s+/)
+        # Remove [[", "map", "]"]
+        split.slice!(-3, 3)
+        @name = split.join(' ')
+      end
+      @name
+    end
+
+    # Return a 0-2 element array containing the meals offered by this
+    # Restaurant: "lunch" and/or "dinner".
+    def meals
+      unless @meals
+        @meals = []
+        lunch = ! @entry.css('a.lunchMenuButton').empty?
+        dinner = ! @entry.css('a.dinnerMenuButton').empty?
+        @meals << 'lunch' if lunch
+        @meals << 'dinner' if dinner
+      end
+      @meals
+    end
+
+    # Return the neighborhood this Restaurant is in (e.g. "back-bay").
+    def neighborhood
+      unless @neighborhood
+        link = @entry.css('a[@href*="neighborhood"]').first
+        @neighborhood = link.attributes['href'].value.sub('/?neighborhood=', '')
+      end
+      @neighborhood
+    end
+
+
+    # Return this Restaurant's phone number, or "<no phone given>" is none is
+    # provided.
+    def phone
+      unless @phone
+        # UGLY, but it's not wrapped in a tag so there it is.
+        phone = @entry.css('.restaurantInfoBasic > p').children[6].to_s
+        if phone == '<br>'
+          @phone = '<no phone given>'
+        else
+          @phone = phone
+        end
+      end
+      @phone
+    end
+
+    # +meal+ should be either "lunch" or "dinner"
+    def menu_link_for(meal)
+      if meal == 'lunch'
+        @lunch_menu_link ||= "http://www.restaurantweekboston.com/fetch/#{short_name}/lunch/"
+      elsif meal == 'dinner'
+        @dinner_menu_link ||= "http://www.restaurantweekboston.com/fetch/#{short_name}/dinner/"
+      end
+    end
+
+
+    # Return the URL to the map of this Restaurant at the RWB web site.
+    def map_link
+      @map_link ||= "http://www.restaurantweekboston.com/map/#{neighborhood}/#{short_name}/#topOfMap"
+    end
+  end
+end

data/lib/restaurant_week_boston/runner.rb

@@ -0,0 +1,55 @@
+require 'optparse'
+require 'restaurant_week_boston/scraper'
+require 'restaurant_week_boston/marker'
+
+module RestaurantWeekBoston
+  # Used in the executable script, +restaurant_week_boston+.
+  class Runner
+    # Pass in ARGV.
+    def initialize(argv)
+      options = {}
+      optparse = OptionParser.new do |opts|
+        opts.banner = "Usage: #{$0} [options] restaurant1, restaurant2, ..."
+
+        options[:meal] = :any
+        opts.on('-m', '--meal MEAL', 'Only get restaurants that offer this meal (lunch/dinner/both/any)') do |m|
+          options[:meal] = m
+        end
+
+        opts.on('-l', '--lunch RESTO1,RESTO2', 'Mark RESTAURANTS as good for lunch') do |lunches|
+          options[:lunch] = lunches.split(',')
+        end
+
+        opts.on('-d', '--dinner RESTO1,RESTO2', 'Mark RESTAURANTS as good for dinner') do |dinners|
+          options[:dinner] = dinners.split(',')
+        end
+
+        opts.on('-a', '--any RESTO1,RESTO2', 'Mark RESTAURANTS as good for any meal') do |any|
+          options[:any] = any.split(',')
+        end
+
+        options[:neighborhood] = :all # NOT any!
+        opts.on('-n', '--neighborhood HOOD',
+                'Only get restaurants in this neighborhood (dorchester, back-bay, etc)') do |n|
+          n = :all if n == 'any' # :any makes it choke
+          options[:neighborhood] = n
+        end
+
+        opts.on('-h', '--help', 'Display this help') do
+          puts opts
+          return
+        end
+      end
+      optparse.parse!(argv)
+      @options = options
+    end
+
+    def run
+      scraper = Scraper.new(:meal => @options[:meal],
+                            :neighborhood => @options[:neighborhood])
+      marker = Marker.new(scraper, @options)
+
+      puts marker.all
+    end
+  end
+end

data/lib/restaurant_week_boston/scraper.rb

@@ -0,0 +1,85 @@
+require 'nokogiri'
+require 'open-uri'
+
+require 'restaurant_week_boston/restaurant'
+
+module RestaurantWeekBoston
+  # Scrapes Restaurant Week site.
+  class Scraper
+    include Enumerable
+    # +opts+ is a hash of options, with the following keys:
+    # :neighborhood:: dorchester, back-bay, etc. (default: "all")
+    # :meal:: lunch, dinner, both, or any (default: "any").  Will create a
+    # file in your home directory called ".restaurant_week_boston.cache"
+    # which contains the HTML from the RWB site, just so it doesn't have to
+    # keep getting it. You can delete that file, it'll just take longer next
+    # time since it will have to re-get the HTML.
+    def initialize(opts = {})
+      @url = create_url(opts)
+      @dump = File.expand_path('~/.restaurant_week_boston.cache')
+      entries = doc().css('.restaurantEntry')
+      @restaurants = entries.map{ |entry| Restaurant.new(entry) }
+    end
+
+    # +opts+ is a hash of options, with the following keys:
+    # :neighborhood:: dorchester, back-bay, etc. (default: :all)
+    # :meal:: lunch, dinner, both, or any (default: :any)
+    def create_url(opts = {})
+      # meal: any/lunch/dinner/both
+      # &view=all
+      default_opts = {:neighborhood => :all,
+                      :meal => :any }
+      opts = default_opts.merge!(opts)
+      sprintf('http://www.restaurantweekboston.com/?neighborhood=%s&meal=%s&view=all',
+              opts[:neighborhood].to_s, opts[:meal].to_s)
+    end
+
+
+    # Iterates over @restaurants. All methods in Enumerable work.
+    def each(&blk)
+      @restaurants.each(&blk)
+    end
+
+    # Returns the result of open()ing the url from create_url(), as a String.
+    def get_html
+      print "Getting doc..."
+      if File.size? @dump
+        html = File.read(@dump)
+      else
+        html = open(@url).read()
+        f = File.new(@dump, 'w')
+        f.write(html)
+        f.close()
+      end
+      puts "done."
+      html
+    end
+
+    # Return a Nokogiri::HTML::Document parsed from get_html. Prints status
+    # messages along the way.
+    def doc
+      # get_html beforehand for good output messages
+      html = get_html
+      print "Parsing doc..."
+      doc = Nokogiri::HTML(html)
+      puts "done."
+      puts
+      doc
+    end
+
+    # Pass in an array of names that =~ (case-insensitive) the ones you're
+    # thinking of, and this will get those. So, if you're thinking of Bond,
+    # 224 Boston Street, and Artu, you can pass in ['bond', 'boston street',
+    # 'artu'].
+    def special_find(array)
+      array.map! do |name|
+        /#{Regexp.escape(name)}/i
+      end
+      results = @restaurants.find_all do |restaurant|
+        array.detect{ |regexp| regexp =~ restaurant.name }
+      end
+      # Add separators
+      results.join("\n" + '-' * 80 + "\n")
+    end
+  end
+end

data/lib/restaurant_week_boston.rb

@@ -0,0 +1,5 @@
+require 'rubygems'
+require 'restaurant_week_boston/scraper'
+require 'restaurant_week_boston/marker'
+require 'restaurant_week_boston/restaurant'
+require 'restaurant_week_boston/runner'

data/restaurant_week_boston.gemspec

@@ -0,0 +1,39 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{restaurant_week_boston}
+  s.version = "1.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Gabe Berke-Williams"]
+  s.date = %q{2010-08-14}
+  s.summary= %q{A fast, easy way to search the Boston Restaurant Week site and mark your favorites.}
+  s.description = %q{A fast, easy way to search the Boston Restaurant Week site and mark your favorites.}
+  s.email = %q{gbw@brandeis.edu}
+  s.extra_rdoc_files = ["README.rdoc"]
+  s.executables = ["restaurant_week_boston"]
+  s.default_executable = %q{restaurant_week_boston}
+  s.files = [
+     "ChangeLog",
+     "LICENSE",
+     "README.rdoc",
+     "bin/restaurant_week_boston",
+     "lib/restaurant_week_boston.rb",
+     "lib/restaurant_week_boston/scraper.rb",
+     "lib/restaurant_week_boston/marker.rb",
+     "lib/restaurant_week_boston/restaurant.rb",
+     "lib/restaurant_week_boston/runner.rb",
+     "restaurant_week_boston.gemspec"
+  ]
+  s.homepage = %q{http://github.com/gabebw/restaurant_week_boston}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.test_files = []
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+  end
+end
+

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification 
+name: restaurant_week_boston
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 1
+  version: 1.0.1
+platform: ruby
+authors: 
+- Gabe Berke-Williams
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-08-14 00:00:00 -07:00
+default_executable: restaurant_week_boston
+dependencies: []
+
+description: A fast, easy way to search the Boston Restaurant Week site and mark your favorites.
+email: gbw@brandeis.edu
+executables: 
+- restaurant_week_boston
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- ChangeLog
+- LICENSE
+- README.rdoc
+- bin/restaurant_week_boston
+- lib/restaurant_week_boston.rb
+- lib/restaurant_week_boston/scraper.rb
+- lib/restaurant_week_boston/marker.rb
+- lib/restaurant_week_boston/restaurant.rb
+- lib/restaurant_week_boston/runner.rb
+- restaurant_week_boston.gemspec
+has_rdoc: true
+homepage: http://github.com/gabebw/restaurant_week_boston
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: A fast, easy way to search the Boston Restaurant Week site and mark your favorites.
+test_files: []
+