beer_list 0.0.2 → 0.1.2

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    beer_list (0.0.1)
+    beer_list (0.1.2)
       mechanize (= 2.6.0)
 
 GEM

data/README.md

@@ -10,6 +10,7 @@ or in your gemfile:
 
 `gem 'beer_list'`
 
+then require the gem:
 
 `require 'beer_list'`
 
@@ -41,7 +42,8 @@ BeerList.add_establishments(three_squares, muddy_waters)
 # See your registered establishments
 BeerList.establishments
 
-# Array of BeerList::List objects
+# Get the beer lists at your registered establishments.
+# as an array of BeerList::List objects
 BeerList.lists
 
 # As a hash
@@ -56,21 +58,27 @@ 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.
+BeerList ships with a limited number of establishments, but also includes an executable
+to easily create your own.
 
 For example:
 
+`beer_list establish Applebirds -u http://applebirds.com/beers -d path/to/establishments`
+
+will create the following code in path/to/establishments/applebirds.rb
+
 ```
 module BeerList
   module Establishments
-    class Applebirds
+    class Applebirds < Establishment
       URL = 'http://applebirds.com/beers'
 
+      # Handles parsing and manipulating a Mechanize::Page object
+      # in order to scrape the contents of your beer list.
+      #
+      # Uncomment and implement to your liking.
       def get_list
-        page.search('p.beer').map(&:text)
+        # page.search('.selector').map(&:text)
       end
 
       def url
@@ -79,6 +87,38 @@ module BeerList
     end
   end
 end
+
+```
+
+For all options you can pass to beer_list establish, run:
+
+`beer_list --help`
+
+### Using Your Generated Establishments
+
+So you've written some pretty bad-ass scrapers now, and you're ready to actually
+use the fruit of your labor in a real application. You'll need to tell BeerList
+about the generated files so that it can require them. If you're using Rails, add
+the following code in an initializer:
+
+`BeerList.establishments_dir = File.join(Rails.root, 'path/to/establishments')`
+
+When using Rails, you'll need to register your establishments with BeerList.
+Unfortunately, you can't call them directly (I'm working on it):
+
 ```
+BeerList.add_establishment(BeerList::Establishments::Applebirds.new)
+
+# fetch all your lists, including the one at Applebirds
+BeerList.lists
+
+# Unsupported in Rails (for now)
+BeerList.applebirds
+
+```
+
+See [Getting A List](https://github.com/DanOlson/beer_list#getting-a-list) for more details.
+
+AND...
 
 Checkout [This link](http://mechanize.rubyforge.org/) for more on Mechanize

data/beer_list.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name          = 'beer_list'
-  spec.version       = '0.0.2'
+  spec.version       = '0.1.2'
   spec.authors       = ['Dan Olson']
   spec.email         = ['olson_dan@yahoo.com']
   spec.description   = 'A utility for retrieving the beer list from various establishments'

data/bin/beer_list

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+bin_file = File.realpath(__FILE__)
+$:.unshift File.expand_path('../../lib', bin_file)
+
+require 'beer_list'
+
+BeerList::CLI.start ARGV

data/lib/beer_list/cli.rb

@@ -0,0 +1,65 @@
+require 'optparse'
+
+module BeerList
+  class CLI
+    COMMANDS = %w(establish)
+
+    class << self
+      def start(args)
+        options = parse ARGV
+
+        msg = ARGV[0]
+        abort unsupported_command unless COMMANDS.include? msg
+
+        new(options).public_send msg
+      end
+
+      def parse(args)
+        options = {}
+
+        opts = OptionParser.new do |opts|
+          opts.banner = "Usage: beer_list establish [options]"
+
+          opts.on("-u", "--url [URL]", "url of your establishment's beer list") do |url|
+            options[:url] = url
+          end
+
+          opts.on("-s", "--selector [SELECTOR]", "selector to use for scraping") do |s|
+            options[:selector] = s
+          end
+
+          opts.on("-d", "--directory DIR", "the directory in which BeerList will put your establishments") do |dir|
+            options[:dir] = dir
+          end
+        end
+
+        opts.parse! args
+        options
+      end
+
+      def unsupported_command
+        <<-WARN
+        Command: not supported. Must be one of the following:
+        #{COMMANDS.join(', ')}
+        WARN
+      end
+
+      def no_establishments_dir
+        <<-WARN
+        You must supply an establishments directory with -d or --directory
+        WARN
+      end
+    end
+
+    def initialize(args)
+      @args = args
+    end
+
+    def establish(klass=ARGV[1])
+      abort self.class.no_establishments_dir unless @args[:dir]
+      # Support underscore and camelcase
+      klass = klass.split('_').map(&:capitalize).join if klass.match(/_/)
+      BeerList::EstablishmentGenerator.new(klass, @args)
+    end
+  end
+end

data/lib/beer_list/establishments/bulldog_lowertown.rb

@@ -0,0 +1,15 @@
+module BeerList
+  module Establishments
+    class BulldogLowertown < Establishment
+      URL = 'http://www.thebulldoglowertown.com/beer/'
+
+      def get_list
+        page.search('ul.beerlist li').map(&:text)
+      end
+
+      def url
+        URL
+      end
+    end
+  end
+end

data/lib/beer_list/establishments/bulldog_northeast.rb

@@ -0,0 +1,17 @@
+module BeerList
+  module Establishments
+    class BulldogNortheast < Establishment
+      URL = 'http://www.thebulldognortheast.com/beer/'
+
+      def get_list
+        list = page.search('p.copy_menu_item_desc').map(&:text)
+        list.shift 2 # shift off Rotating Cask and Beer Flights
+        list
+      end
+
+      def url
+        URL
+      end
+    end
+  end
+end

data/lib/beer_list/establishments/bulldog_uptown.rb

@@ -0,0 +1,21 @@
+module BeerList
+  module Establishments
+    class BulldogUptown < Establishment
+      URL = 'http://www.thebulldoguptown.com/beer/'
+
+      def get_list
+        list = page.search('span.menuTitle').map(&:text)
+        list = process_list list
+      end
+
+      def process_list(list)
+        list.pop 5
+        list.map{ |e| e.split(' (').first }
+      end
+
+      def url
+        URL
+      end
+    end
+  end
+end

data/lib/beer_list/establishments.rb

@@ -3,10 +3,15 @@ $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'
+
+    Dir[File.dirname(__FILE__) + '/establishments/*.rb'].each do |f|
+      require f.split('.rb').first
+    end
+
+    if BeerList.establishments_dir
+      Dir[File.dirname(BeerList.establishments_dir) + '/*.rb'].each do |f|
+        require f.split('.rb').first
+      end
+    end
   end
 end

data/lib/beer_list/list.rb

@@ -4,7 +4,7 @@ module BeerList
 
     def initialize(ary, establishment)
       @establishment = establishment
-      super ary
+      super ary.sort
     end
 
     def to_hash

data/lib/beer_list.rb

@@ -3,12 +3,23 @@ require 'json'
 
 module BeerList
   require 'beer_list/scraper'
-  require 'beer_list/establishments'
   require 'beer_list/list'
   require 'beer_list/exceptions'
+  require 'beer_list/cli'
+  require 'generators/establishment_generator'
+  require 'ext/string'
+  autoload :Establishments, 'beer_list/establishments'
 
   class << self
 
+    def establishments_dir
+      @establishments_dir
+    end
+
+    def establishments_dir=(directory)
+      @establishments_dir = directory
+    end
+
     def establishments
       return [] if @establishments.nil?
       @establishments.dup
@@ -64,6 +75,7 @@ module BeerList
     end
 
     def method_missing(method, *args, &block)
+      super if defined? Rails
       class_name = method.to_s.split('_').map(&:capitalize).join
       begin
         klass = ['BeerList', 'Establishments', class_name].compact.inject(Object){ |o, name| o.const_get(name) }

data/lib/ext/string.rb

@@ -0,0 +1,9 @@
+class String
+  def underscore
+    self.gsub(/::/, '/').
+    gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+    gsub(/([a-z\d])([A-Z])/,'\1_\2').
+    tr("-", "_").
+    downcase
+  end
+end

data/lib/generators/establishment_generator.rb

@@ -0,0 +1,34 @@
+require 'erb'
+
+module BeerList
+  class EstablishmentGenerator
+    
+    DEFAULT_URL        = 'http://yourestablishment.com/path/to/the/beer_list'
+    TEMPLATE_FILE      = File.expand_path('../templates/establishment.erb', __FILE__)
+    ESTABLISHMENTS_DIR = File.expand_path('../../beer_list/establishments', __FILE__)
+
+    def initialize(klass, args={})
+      @klass     = klass
+      @url       = args[:url] || DEFAULT_URL
+      @selector  = args[:selector] || '.selector'
+      @directory = args[:dir] || ESTABLISHMENTS_DIR
+      write_file
+    end
+
+    private
+
+    def write_file
+      File.open(filepath, 'w+') do |f|
+        f << template.result(binding)
+      end
+    end
+
+    def template
+      ERB.new File.open(TEMPLATE_FILE).read, nil, '-'
+    end
+
+    def filepath
+      File.join @directory, "#{@klass.underscore}.rb"
+    end
+  end
+end

data/lib/generators/templates/establishment.erb

@@ -0,0 +1,19 @@
+module BeerList
+  module Establishments
+    class <%= @klass %> < Establishment
+      URL = '<%= @url %>'
+
+      # Handles parsing and manipulating a Mechanize::Page object
+      # in order to scrape the contents of your beer list.
+      #
+      # Uncomment and implement to your liking.
+      def get_list
+        # page.search('<%= @selector %>').map(&:text)
+      end
+
+      def url
+        URL
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: beer_list
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-06 00:00:00.000000000 Z
+date: 2013-04-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mechanize
@@ -62,7 +62,8 @@ dependencies:
 description: A utility for retrieving the beer list from various establishments
 email:
 - olson_dan@yahoo.com
-executables: []
+executables:
+- beer_list
 extensions: []
 extra_rdoc_files: []
 files:
@@ -73,8 +74,13 @@ files:
 - LICENSE.txt
 - README.md
 - beer_list.gemspec
+- bin/beer_list
 - lib/beer_list.rb
+- lib/beer_list/cli.rb
 - lib/beer_list/establishments.rb
+- lib/beer_list/establishments/bulldog_lowertown.rb
+- lib/beer_list/establishments/bulldog_northeast.rb
+- lib/beer_list/establishments/bulldog_uptown.rb
 - lib/beer_list/establishments/edina_grill.rb
 - lib/beer_list/establishments/establishment.rb
 - lib/beer_list/establishments/groveland_tap.rb
@@ -84,6 +90,9 @@ files:
 - lib/beer_list/exceptions.rb
 - lib/beer_list/list.rb
 - lib/beer_list/scraper.rb
+- lib/ext/string.rb
+- lib/generators/establishment_generator.rb
+- lib/generators/templates/establishment.erb
 - spec/lib/beer_list/establishments/establishment_spec.rb
 - spec/lib/beer_list/list_spec.rb
 - spec/lib/beer_list_spec.rb