beer_in_the_evening 0.0.3 → 0.0.4

data/README.md

@@ -9,6 +9,7 @@ Wrong.
 
     require 'beer_in_the_evening'
     search = BeerInTheEvening::Search.new
+    search.maximum_results = 10
     search.tube_station = BeerInTheEvening::Location::Tube::HOLBORN
     search.minimum_rating = 6
     search.real_ale = true
@@ -18,6 +19,7 @@ Wrong.
     random_pub.to_s
     # => "Lord Clyde, 2.2 miles, 6.7 / 10, http://beerintheevening.com/pubs/s/65/6501/Lord_Clyde/Canonbury"
 
+There are a few more examples in the `examples/` directory.
 
 ## Authors
 

data/beer_in_the_evening.gemspec

@@ -19,4 +19,5 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   s.add_runtime_dependency "nokogiri"
+  s.add_runtime_dependency "null_logger"
 end

data/examples/near_holborn.rb

@@ -0,0 +1,15 @@
+require 'beer_in_the_evening'
+require 'logger'
+
+STDOUT.sync = true
+logger = Logger.new STDOUT
+search = BeerInTheEvening::Search.new :logger => logger
+search.tube_station = BeerInTheEvening::Location::Tube::HOLBORN
+search.maximum_results = 5
+search.minimum_rating = 6
+search.real_ale = true
+search.wifi = true
+search.food = true
+search.each do |pub|
+  puts pub.to_s
+end

data/examples/near_postcode.rb

@@ -0,0 +1,13 @@
+require 'beer_in_the_evening'
+require 'logger'
+
+STDOUT.sync = true
+logger = Logger.new STDOUT
+search = BeerInTheEvening::Search.new :logger => logger
+search.postcode = 'SE1 1EY'
+search.maximum_results = 5
+search.minimum_rating = 6
+search.wifi = true
+search.each do |pub|
+  puts pub.to_s
+end

data/lib/beer_in_the_evening/pub.rb

@@ -1,33 +1,45 @@
 module BeerInTheEvening
   class Pub
+    attr_accessor :data
+    private :data=
+
     def initialize data
-      @data = data
+      self.data = data
+    end
+
+    def distance_known?
+      !distance.nil?
     end
 
     def name
-      @data.css("td b a:first-child")[0].inner_text.to_s
+      data.css("td b a:first-child")[0].inner_text.to_s.strip
     end
 
     def url
-      "http://beerintheevening.com" + @data.css("td b a:first-child")[0]['href'].to_s
+      "http://beerintheevening.com" + self.data.css("td b a:first-child")[0]['href'].to_s
     end
 
-    def rating
-      results = @data.css("td:nth-child(3)")[0].inner_text.scan /Rating:(.*)\/10/
-      results[0][0].to_f if results[0]
+    def rating_column
+      distance_known? ? 3 : 2
     end
 
-    def visited?
-      Meetup.exists? self
+    def rating
+      results = data.css("td:nth-child(#{rating_column})")[0].inner_text.scan /Rating:(.*)\/10/
+      results[0][0].to_f if results[0]
     end
 
     def distance
-      results = @data.css("td:nth-child(2)")[0].inner_text.scan /Distance:(.*)miles/
+      results = data.css("td:nth-child(2)")[0].inner_text.scan /Distance:(.*)miles/
       results[0][0].to_f if results[0]
+    rescue
     end
 
     def to_s
-      [ name, "#{distance} miles", "#{rating} / 10", url ].join ', '
+      if distance_known?
+        [ name, "#{distance} miles", "#{rating} / 10", url ]
+      else
+        [ name, "#{rating} / 10", url ]
+      end.join ', '
     end
   end
 end

data/lib/beer_in_the_evening/search.rb

@@ -1,11 +1,26 @@
 module BeerInTheEvening
   class Search
+    class << self
+      attr_accessor :maximum_cache_ttl
+    end
+    # Invalidate the cache at least every 28 days
+    self.maximum_cache_ttl = 86400 * 28
+
+    attr_accessor :postcode
     attr_accessor :tube_station
     attr_accessor :real_ale
     attr_accessor :food
     attr_accessor :wifi
     attr_accessor :minimum_rating
 
+    attr_accessor :maximum_results
+
+    attr_accessor :logger
+
+    def initialize options = {}
+      self.logger = options[:logger] || NullLogger.instance
+    end
+
     def number_of_results
       matches = page(0).to_s.scan /showing \d+ to \d+ of (\d+)/
       matches[0][0].to_i
@@ -13,18 +28,36 @@ module BeerInTheEvening
 
     def each &block
       current_page = 0
+      results_total = 0
       loop do
+        logger.debug "Finding next set of results"
         results = results_on_page current_page
         break if results.empty?
+        if maximum_results
+          while results_total + results.size > maximum_results do
+            logger.debug "Trimming results. Max = #{maximum_results}, Current = #{results_total + results.size}"
+            results.pop
+          end
+        end
+        logger.debug "Yielding #{results.size} pubs to client"
         results.each &block
+        logger.debug "Client code finished"
         current_page += 1
+        results_total += results.size
+        break if maximum_results && results_total >= maximum_results
       end
     end
     include Enumerable
 
+    def escaped_postcode
+      CGI.escape postcode
+    end
+    private :escaped_postcode
+
     def query_string
       params = []
       params << "tu=#{tube_station}" if tube_station
+      params << "postcode=#{escaped_postcode}" if postcode
       params << "ra=on" if real_ale
       params << "f=on" if food
       params << "wireless=on" if wifi
@@ -35,30 +68,54 @@ module BeerInTheEvening
 
     def page n
       uri = "http://www.beerintheevening.com/pubs/results.shtml?#{query_string}&page=#{n}"
+      logger.debug "Page #{n} of results will be at #{uri}"
       content = read_cache uri do
+        logger.debug "Fetching #{uri}"
         open(uri).read
       end
+      logger.debug "Building document from HTML data"
       doc = Nokogiri::HTML content
     end
     private :page
 
+    def cache_generation
+      Time.now.to_i / self.class.maximum_cache_ttl.to_i
+    end
+    private :cache_generation
+
+    def cache_prefix
+      "beer_in_the_evening-#{BeerInTheEvening::VERSION}-#{self.class.maximum_cache_ttl.to_i}-#{cache_generation}"
+    end
+    private :cache_prefix
+
     def read_cache uri
-      cache_dir = Dir.tmpdir + "/beer_in_the_evening-#{BeerInTheEvening::VERSION}"
+      cache_dir = Dir.tmpdir + "/#{cache_prefix}"
       Dir.mkdir cache_dir unless File.exists? cache_dir
       cache_file_name = "#{cache_dir}/#{Digest::SHA1.hexdigest(uri)}.html"
-      return File.read(cache_file_name) if File.exists? cache_file_name
+      if File.exists? cache_file_name
+        logger.debug "Found #{uri} in cache at #{cache_file_name}"
+        return File.read cache_file_name
+      end
+      logger.debug "Did not find #{uri} in cache"
       data = yield
+      logger.debug "Data is #{data.bytesize}b"
+      logger.debug "Adding #{uri} to cache as #{cache_file_name}"
       File.open cache_file_name, 'w+' do |f|
         f.puts data
       end
+      logger.debug "Returning data"
       data
     end
     private :read_cache
 
     def results_on_page n
-      page(n).css('table.pubtable tr.pubtable').to_a.map { |row|
+      rows = page(n).css('table.pubtable tr.pubtable').to_a
+      logger.debug "Found #{rows.size} results on page #{n}"
+      rows.map! { |row|
         Pub.new row
       }
+      logger.debug "Returning results as pubs"
+      rows
     end
     private :results_on_page
   end

data/lib/beer_in_the_evening/version.rb

@@ -1,3 +1,3 @@
 module BeerInTheEvening
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/lib/beer_in_the_evening.rb

@@ -2,6 +2,8 @@ require "nokogiri"
 require "open-uri"
 require "digest/sha1"
 require "tmpdir"
+require "null_logger"
+require "cgi"
 
 require "beer_in_the_evening/version"
 require "beer_in_the_evening/pub"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: beer_in_the_evening
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-11-01 00:00:00.000000000Z
+date: 2012-09-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
-  requirement: &70318119693620 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,7 +21,28 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70318119693620
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: null_logger
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Search over the Beer In The Evening site looking for suitable pubs
 email:
 - craig@barkingiguana.com
@@ -34,6 +55,8 @@ files:
 - README.md
 - Rakefile
 - beer_in_the_evening.gemspec
+- examples/near_holborn.rb
+- examples/near_postcode.rb
 - lib/beer_in_the_evening.rb
 - lib/beer_in_the_evening/location/dlr.rb
 - lib/beer_in_the_evening/location/tube.rb
@@ -60,7 +83,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: beer_in_the_evening
-rubygems_version: 1.8.10
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Is it pub time?