beer_list 0.0.1

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

@@ -0,0 +1 @@
+gemspec

data/Gemfile.lock

@@ -0,0 +1,44 @@
+PATH
+  remote: .
+  specs:
+    beer_list (0.0.1)
+      mechanize (= 2.6.0)
+
+GEM
+  specs:
+    diff-lcs (1.1.3)
+    domain_name (0.5.9)
+      unf (>= 0.0.5, < 1.0.0)
+    mechanize (2.6.0)
+      domain_name (~> 0.5, >= 0.5.1)
+      mime-types (~> 1.17, >= 1.17.2)
+      net-http-digest_auth (~> 1.1, >= 1.1.1)
+      net-http-persistent (~> 2.5, >= 2.5.2)
+      nokogiri (~> 1.4)
+      ntlm-http (~> 0.1, >= 0.1.1)
+      webrobots (>= 0.0.9, < 0.2)
+    mime-types (1.22)
+    net-http-digest_auth (1.3)
+    net-http-persistent (2.8)
+    nokogiri (1.5.9)
+    ntlm-http (0.1.1)
+    rspec (2.12.0)
+      rspec-core (~> 2.12.0)
+      rspec-expectations (~> 2.12.0)
+      rspec-mocks (~> 2.12.0)
+    rspec-core (2.12.2)
+    rspec-expectations (2.12.1)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.12.2)
+    unf (0.1.1)
+      unf_ext
+    unf_ext (0.0.6)
+    webrobots (0.1.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  beer_list!
+  bundler (~> 1.3)
+  rspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Dan Olson
+
+MIT License
+
+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,74 @@
+# Beer List
+
+A utility for retrieving the beer list from various establishments
+
+## Usage
+
+`require 'beer_list'`
+
+### Getting a List
+
+See what's on tap:
+
+```
+# An array-like object
+list = BeerList.groveland_tap
+
+# As a hash
+list.to_hash
+
+# As JSON
+list.to_json
+```
+
+You may want to get lists for more than one establishment at a time. To do so, register
+the desired establishments in BeerList.establishments:
+
+```
+three_squares = BeerList::Establishments::ThreeSquares.new
+muddy_waters  = BeerList::Establishments::MuddyWaters.new
+
+BeerList.establishments << three_squares
+BeerList.establishments << muddy_waters
+
+# Array of BeerList::List objects
+BeerList.lists
+
+# As a hash
+BeerList.list_as_hash
+
+# As JSON
+BeerList.list_as_json
+```
+
+The Lists will be memoized until the content of BeerList.establishments changes so that
+The establishments don't have to be re-scraped each time the list is requested.
+
+### Extending BeerList with More Establishments
+
+BeerList ships with a limited number of establishments, but it's easy to write your own.
+Your establishment class must inherit from BeerList::Establishments::Establishment,
+and provide two instance methods: `get_list` and `url`. `url` should be the url of the beer list on your establishment's website. `get_list` should handle parsing and 
+manipulating a Mechanize::Page object in order to scrape the contents of your beer list.
+
+For example:
+
+```
+module BeerList
+  module Establishments
+    class Applebirds
+      URL = 'http://applebirds.com/beers'
+
+      def get_list
+        page.search('p.beer').map(&:text)
+      end
+
+      def url
+        URL
+      end
+    end
+  end
+end
+```
+
+Checkout [This link](http://mechanize.rubyforge.org/) for more on Mechanize

data/beer_list.gemspec

@@ -0,0 +1,19 @@
+Gem::Specification.new do |spec|
+  spec.name          = 'beer_list'
+  spec.version       = '0.0.1'
+  spec.authors       = ['Dan Olson']
+  spec.email         = ['olson_dan@yahoo.com']
+  spec.description   = 'A utility for retrieving the beer list from various establishments'
+  spec.summary       = 'A beer list scraper'
+  spec.homepage      = 'https://github.com/DanOlson/beer_list'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(spec)/})
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'mechanize', '2.6.0'
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rspec'
+end

data/lib/beer_list/establishments/edina_grill.rb

@@ -0,0 +1,15 @@
+module BeerList
+  module Establishments
+    class EdinaGrill < Establishment
+      URL = 'http://www.edinagrill.com/beer_taps.php'
+
+      def get_list
+        page.search('li span').map(&:text)
+      end
+
+      def url
+        URL
+      end
+    end
+  end
+end

data/lib/beer_list/establishments/establishment.rb

@@ -0,0 +1,24 @@
+module BeerList
+  module Establishments
+    class Establishment
+      attr_accessor :scraper, :page
+
+      def list
+        raise BeerList::NoScraperError unless @scraper
+        @list ||= BeerList::List.new get_list, short_class_name
+      end
+
+      def get_list
+        raise "#{__method__} is not implemented in #{self.class.name}"
+      end
+
+      def url
+        raise "#{__method__} is not implemented in #{self.class.name}"
+      end
+
+      def short_class_name
+        self.class.name.split('::').last
+      end
+    end
+  end
+end

data/lib/beer_list/establishments/groveland_tap.rb

@@ -0,0 +1,15 @@
+module BeerList
+  module Establishments
+    class GrovelandTap < Establishment
+      URL = 'http://www.grovelandtap.com/beer_taps.php'
+
+      def get_list
+        page.search('p.MsoNormal').map(&:text)
+      end
+
+      def url
+        URL
+      end
+    end
+  end
+end

data/lib/beer_list/establishments/longfellow_grill.rb

@@ -0,0 +1,42 @@
+module BeerList
+  module Establishments
+    class LongfellowGrill < Establishment
+      URL = 'http://www.longfellowgrill.com/beer_taps.php'
+      STATE_AND_PRICE_REGEX = /\s*(?:\([A-Z]*\))*\s*\**\s*\d+\.\d{2}$/
+
+      def get_list
+        get_base_list
+        process_base_list
+        @my_list
+      end
+
+      def url
+        URL
+      end
+
+      private
+
+      def get_base_list
+        @my_list = page.search('li span').map(&:text)
+      end
+
+      def process_base_list
+        remove_not_applicable
+        remove_special_chars
+        trim_list_items
+      end
+
+      def remove_not_applicable
+        @my_list = @my_list.reject{ |e| e.match(/\A\s+\Z|\A\((.*)\)/) }
+      end
+
+      def remove_special_chars
+        @my_list = @my_list.map(&:strip).map{ |e| e.gsub(/\u00a0/, '') }
+      end
+
+      def trim_list_items
+        @my_list = @my_list.map{ |e| e.gsub(STATE_AND_PRICE_REGEX, '') }.uniq
+      end
+    end
+  end
+end

data/lib/beer_list/establishments/muddy_waters.rb

@@ -0,0 +1,30 @@
+module BeerList
+  module Establishments
+    class MuddyWaters < Establishment
+      URL = 'http://muddywatersmpls.com/booze.html'
+
+      def get_list
+        get_processed_list
+      end
+
+      def url
+        URL
+      end
+
+      def get_processed_list
+        all = page.search('div.graphic_textbox_layout_style_default p').map(&:text)
+
+        all.pop get_wine_count(all.reverse)
+        all
+      end
+
+      def get_wine_count(ary=[])
+        count = 0
+        ary.each do |e|
+          count += 1
+          break count if e.empty?
+        end
+      end
+    end
+  end
+end

data/lib/beer_list/establishments/three_squares.rb

@@ -0,0 +1,15 @@
+module BeerList
+  module Establishments
+    class ThreeSquares < Establishment
+      URL = 'http://www.3squaresrestaurant.com/beer_taps.php'
+
+      def get_list
+        page.at('ul').text.split("\r\n")
+      end
+
+      def url
+        URL
+      end
+    end
+  end
+end

data/lib/beer_list/establishments.rb

@@ -0,0 +1,12 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+module BeerList
+  module Establishments
+    require 'establishments/establishment'
+    require 'establishments/three_squares'
+    require 'establishments/groveland_tap'
+    require 'establishments/edina_grill'
+    require 'establishments/longfellow_grill'
+    require 'establishments/muddy_waters'
+  end
+end

data/lib/beer_list/exceptions.rb

@@ -0,0 +1,16 @@
+module BeerList
+  
+  class NoEstablishmentsError < StandardError
+    def initialize(msg=nil)
+      msg ||= "No establishments are registered"
+      super msg
+    end
+  end
+
+  class NoScraperError < StandardError
+    def initialize(msg=nil)
+      msg ||= "No scraper is registered"
+      super msg
+    end
+  end
+end

data/lib/beer_list/list.rb

@@ -0,0 +1,20 @@
+module BeerList
+  class List < Array
+    attr_reader :establishment
+
+    def initialize(ary, establishment)
+      @establishment = establishment
+      super ary
+    end
+
+    def to_hash
+      Hash[establishment, self.to_a]
+    end
+
+    alias :old_to_json :to_json
+    
+    def to_json
+      to_hash.to_json
+    end
+  end
+end

data/lib/beer_list/scraper.rb

@@ -0,0 +1,28 @@
+module BeerList
+  class Scraper
+    attr_reader :agent, :url, :page
+
+    USER_AGENT = 'Mac Safari'
+
+    def initialize
+      @agent = Mechanize.new
+      set_user_agent
+    end
+
+    def beer_list(establishment)
+      establishment.scraper = self
+      visit_site establishment
+      establishment.list
+    end
+
+    private
+
+    def visit_site(establishment)
+      establishment.page = agent.get(establishment.url)
+    end
+
+    def set_user_agent
+      agent.user_agent_alias = USER_AGENT
+    end
+  end
+end

data/lib/beer_list.rb

@@ -0,0 +1,76 @@
+require 'mechanize'
+require 'json'
+
+module BeerList
+  require 'beer_list/scraper'
+  require 'beer_list/establishments'
+  require 'beer_list/list'
+  require 'beer_list/exceptions'
+
+  class << self
+
+    def establishments
+      return [] if @establishments.nil?
+      @establishments.dup
+    end
+
+    def clear_establishments!
+      @establishments.clear if @establishments
+    end
+
+    def add_establishment(*args)
+      args.each do |e|
+        _establishments << e if e.respond_to?(:get_list)
+      end
+    end
+    alias :add_establishments :add_establishment
+
+    def lists
+      raise NoEstablishmentsError if establishments.empty?
+
+      return @lists unless update_necessary?
+      @lists = establishments.map do |e|
+        scraper.beer_list e
+      end
+    end
+
+    def lists_as_hash
+      lists.inject({}) do |hsh, list|
+        hsh.merge! list.to_hash
+      end
+    end
+
+    def lists_as_json
+      lists_as_hash.to_json
+    end
+
+    private
+
+    def scraper
+      @scraper ||= Scraper.new
+    end
+
+    def update_necessary?
+      !@lists || !establishments_eq_lists?
+    end
+
+    def _establishments
+      @establishments ||= []
+    end
+
+    def establishments_eq_lists?
+      list_names = @lists.map(&:establishment)
+      establishments.map(&:short_class_name).all? { |name| list_names.include? name }
+    end
+
+    def method_missing(method, *args, &block)
+      class_name = method.to_s.split('_').map(&:capitalize).join
+      begin
+        klass = ['BeerList', 'Establishments', class_name].compact.inject(Object){ |o, name| o.const_get(name) }
+        scraper.beer_list klass.new
+      rescue NameError
+        super method, *args, &block
+      end
+    end
+  end
+end

data/spec/lib/beer_list/establishments/establishment_spec.rb

@@ -0,0 +1,52 @@
+require 'spec_helper'
+
+module BeerList
+  module Establishments
+
+    describe Establishment do
+      let(:establishment){ BeerList::Establishments::Establishment.new }
+
+      describe '#list' do
+        context "when it doesn't have a scraper" do
+          it "raises an exception" do
+            expect { establishment.list }.to raise_error(NoScraperError)
+          end
+        end
+
+        context 'when it has a scraper' do
+
+          before do
+            establishment.scraper = stub
+          end
+
+          it 'returns a BeerList::List' do
+            establishment.stub(:get_list){ [] }
+            establishment.list.should be_an_instance_of BeerList::List
+          end
+        end
+      end
+
+      describe '#get_list' do
+        context 'when it is not implemented in a subclass' do
+          it 'raises an exception' do
+            expect { establishment.get_list }.to raise_error
+          end
+        end
+      end
+
+      describe '#url' do
+        it 'raises an exception unless it is implemented in a subclass' do
+          expect { establishment.get_list }.to raise_error
+        end
+      end
+
+      describe '#short_class_name' do
+        let(:establishment){ BeerList::Establishments::MuddyWaters.new }
+
+        it 'returns a usable name' do
+          establishment.short_class_name.should == 'MuddyWaters'
+        end
+      end
+    end
+  end
+end

data/spec/lib/beer_list/list_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+module BeerList
+  describe List do
+    let(:est_name){ 'MuddyWaters' }
+    let(:list){ List.new [], est_name}
+
+    it 'knows its establishent' do
+      list.establishment.should == est_name
+    end
+
+    describe '#to_hash' do
+      it 'hashes its establishment name with its content' do
+        expected = { est_name => [] }
+        list.to_hash.should == expected
+      end
+    end
+
+    describe '#to_json' do
+      it 'returns the list as json' do
+        expected = "{\"MuddyWaters\":[]}"
+        list.to_json.should == expected
+      end
+    end
+  end
+end

data/spec/lib/beer_list_spec.rb

@@ -0,0 +1,111 @@
+require 'spec_helper'
+
+describe BeerList do
+  let(:establishment){ BeerList::Establishments::ThreeSquares.new }
+
+  describe '.establishments' do
+
+    after(:each) do
+      BeerList.clear_establishments!
+    end
+
+    it 'returns an array' do
+      BeerList.establishments.should be_an_instance_of Array
+    end
+  end
+
+  describe '.add_establishment' do
+    let(:muddy_waters){ BeerList::Establishments::MuddyWaters.new }
+
+    after(:each) do
+      BeerList.clear_establishments!
+    end
+
+    it 'appends to establishments' do
+      BeerList.add_establishment establishment
+      BeerList.establishments.should include establishment
+    end
+
+    it 'accepts multiple establishments' do
+      BeerList.add_establishment establishment, muddy_waters
+      BeerList.establishments.size.should == 2
+    end
+
+    it 'rejects invalid input' do
+      BeerList.add_establishment muddy_waters, Object.new
+      BeerList.establishments.size.should == 1
+    end
+
+    it 'can be called multiple times' do
+      BeerList.add_establishment muddy_waters
+      BeerList.add_establishment establishment
+      BeerList.establishments.size.should == 2
+    end
+  end
+
+  describe '.clear_establishments!' do
+
+    shared_examples_for 'clear_establishments!' do
+      it 'should empty the collection' do
+        BeerList.clear_establishments!
+        BeerList.establishments.should be_empty
+      end
+    end
+
+    context 'when establishments are registered' do
+      before do
+        BeerList.add_establishment establishment
+      end
+
+      it_behaves_like 'clear_establishments!'
+    end
+
+    context 'when no establishments are registered' do
+      it_behaves_like 'clear_establishments!'
+    end
+  end
+
+  describe '.lists' do
+    context 'when no establishments are registered' do
+      it 'should raise an error' do
+        BeerList.clear_establishments!
+        expect { BeerList.lists }.to raise_error(BeerList::NoEstablishmentsError)
+      end
+    end
+
+    context 'when establishments are registered' do
+      before(:all) do
+        BeerList.add_establishments establishment
+      end
+
+      after(:all) do
+        BeerList.clear_establishments!
+      end
+
+      before do
+        establishment.stub(:get_list){ ['Darkness', 'Pliney the Elder'] }
+      end
+
+      it 'returns an array of lists' do
+        BeerList.lists.all?{ |l| l.is_a? BeerList::List }.should be_true
+      end
+
+      it 'contains lists for the registered establishments' do
+        BeerList.lists.first.establishment.should == 'ThreeSquares'
+      end
+
+      describe '.lists_as_hash' do
+        it 'returns a hash' do
+          BeerList.lists_as_hash.should be_an_instance_of Hash
+        end
+      end
+
+      describe '.lists_as_json' do
+        it 'returns JSON' do
+          expect { JSON.parse(BeerList.lists_as_json) }.to_not raise_error
+        end
+      end
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+require 'beer_list'
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: beer_list
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Dan Olson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mechanize
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.6.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A utility for retrieving the beer list from various establishments
+email:
+- olson_dan@yahoo.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .rspec
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- beer_list.gemspec
+- lib/beer_list.rb
+- lib/beer_list/establishments.rb
+- lib/beer_list/establishments/edina_grill.rb
+- lib/beer_list/establishments/establishment.rb
+- lib/beer_list/establishments/groveland_tap.rb
+- lib/beer_list/establishments/longfellow_grill.rb
+- lib/beer_list/establishments/muddy_waters.rb
+- lib/beer_list/establishments/three_squares.rb
+- lib/beer_list/exceptions.rb
+- lib/beer_list/list.rb
+- lib/beer_list/scraper.rb
+- spec/lib/beer_list/establishments/establishment_spec.rb
+- spec/lib/beer_list/list_spec.rb
+- spec/lib/beer_list_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/DanOlson/beer_list
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: A beer list scraper
+test_files:
+- spec/lib/beer_list/establishments/establishment_spec.rb
+- spec/lib/beer_list/list_spec.rb
+- spec/lib/beer_list_spec.rb
+- spec/spec_helper.rb