beer_list 1.0.0 → 1.1.0

data/Gemfile.lock

@@ -1,14 +1,14 @@
 PATH
   remote: .
   specs:
-    beer_list (0.1.3)
+    beer_list (1.1.0)
       mechanize (~> 2.6.0)
       thor (~> 0.18.1)
 
 GEM
   specs:
     diff-lcs (1.1.3)
-    domain_name (0.5.9)
+    domain_name (0.5.11)
       unf (>= 0.0.5, < 1.0.0)
     mechanize (2.6.0)
       domain_name (~> 0.5, >= 0.5.1)
@@ -18,7 +18,7 @@ GEM
       nokogiri (~> 1.4)
       ntlm-http (~> 0.1, >= 0.1.1)
       webrobots (>= 0.0.9, < 0.2)
-    mime-types (1.22)
+    mime-types (1.23)
     net-http-digest_auth (1.3)
     net-http-persistent (2.8)
     nokogiri (1.5.9)

data/README.md

@@ -4,6 +4,8 @@ A utility for retrieving the beer list from various establishments
 
 ## Usage
 
+### Installation
+
 `gem install beer_list`
 
 or in your gemfile:
@@ -18,7 +20,7 @@ then require the gem:
 
 See what's on tap:
 
-```
+```ruby
 # An array-like object
 list = BeerList.groveland_tap
 
@@ -38,7 +40,7 @@ but its easy to [extend BeerList](#extending-beerlist-with-more-establishments)
 
 First, let's try one out of the box:
 
-```
+```ruby
 bulldog_northeast = BeerList::Establishments::BulldogNortheast.new
 
 # Now get the list
@@ -48,7 +50,7 @@ bulldog_northeast.list
 You may want to get lists for more than one establishment at a time. To do so, register
 the desired establishments in BeerList.establishments:
 
-```
+```ruby
 three_squares = BeerList::Establishments::ThreeSquares.new
 muddy_waters  = BeerList::Establishments::MuddyWaters.new
 
@@ -82,7 +84,7 @@ For example:
 
 will create the following code in path/to/establishments/applebirds.rb
 
-```
+```ruby
 module BeerList
   module Establishments
     class Applebirds < Establishment
@@ -107,7 +109,7 @@ end
 
 For all options you can pass to beer_list establish, run:
 
-`$ beer_list help`
+`$ beer_list help establish`
 
 ### Using Your Generated Establishments
 
@@ -116,10 +118,15 @@ 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')`
+```ruby
+BeerList.configure do |c|
+  c.establishments_dir = File.join(Rails.root, 'path/to/establishments')
+end
+```
 
+Then in your app:
 
-```
+```ruby
 # Fetch just the list at Applebirds
 BeerList.applebirds
 
@@ -137,12 +144,45 @@ AND...
 
 Checkout [This link](http://mechanize.rubyforge.org/) for more on Mechanize
 
+### Sending Lists
+
+Once you have lists, you can use them locally (obviously), or you can send them elsewhere.
+Configure BeerList with a default URL like this:
+
+```ruby
+BeerList.configure do |c|
+  c.default_url = 'https://yourapp.com/some_sweet_beer_route'
+end
+```
+
+Then in your code, send a list!
+
+```ruby
+applebirds = BeerList.applebirds
+
+# POSTs your list to your default_url as JSON under the "beer_list" name
+BeerList.send_list(applebirds)
+
+# You can also give it an explicit URL
+other_route = 'http://myotherapp.com/another_beer_route'
+BeerList.send_list(applebirds, other_route)
+
+# Register some lists and send 'em all at once:
+thursdays = BeerList::Establishments::Thursdays.new
+
+BeerList.add_establishments(applebirds, thursdays)
+BeerList.send_lists
+```
+
+Both .send_list and .send_lists accept an optional URL as the last argument. If you don't pass one,
+it will use the default in your configuration. If neither doesn't exist, it will raise an error.
+
 ### Leads
 
 If you're out of ideas on what establishments you may want lists for, fear not: BeerList can
 give you some ideas.
 
-```
+```ruby
 # You might be interested in good beer bars located in California:
 cali = BeerList::Leads::CA.new
 
@@ -163,12 +203,14 @@ it in the not-too-distant future.
 ### CLI
 
 In addition to the [establish](#extending-beerlist-with-more-establishments) command, which
-generates Establishment files for you, BeerList also offers the `list` command. For example,
+generates Establishment files for you, BeerList also offers a few other commands:
+
+There's the `list` command. For example,
 say you have the following two establishments a directory called ~/my_beer_lists:
 
 ```
-BeerList::Establishments::Applebirds
-BeerList::Establishments::Thursdays
+applebirds.rb
+thursdays.rb
 ```
 
 You can get the beer lists for these places from the command line:
@@ -182,3 +224,9 @@ $ beer_list list applebirds thursdays -d ~/my_beer_lists
 # pass -j for JSON
 $ beer_list list applebirds thursdays -j -d ~/my_beer_lists
 ```
+
+There's also the `send` command for [sending your lists](#sending-lists) to a given URL:
+
+`$ beer_list send applebirds thursdays -u 'http://mybeerapiendpoint.com/beer_list'`
+
+See `$ beer_list help` for all commands

data/beer_list.gemspec

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

data/lib/beer_list.rb

@@ -2,6 +2,7 @@ require 'mechanize'
 require 'json'
 
 module BeerList
+  require 'beer_list/settings'
   require 'beer_list/scraper'
   require 'beer_list/list'
   require 'beer_list/exceptions'
@@ -14,12 +15,30 @@ module BeerList
 
   class << self
 
+    def configure
+      yield settings
+      true
+    end
+
+    def settings
+      @settings ||= Settings.new
+    end
+
+    def default_url
+      settings.default_url
+    end
+
     def establishments_dir
-      @establishments_dir
+      settings.establishments_dir
     end
 
+    ### DEPRECATED ###
     def establishments_dir=(directory)
-      @establishments_dir = directory
+      puts <<-dep
+        BeerList.establishments_dir= is deprecated and will be removed.
+        Please use BeerList.configure instead
+      dep
+      settings.establishments_dir = directory
     end
 
     def establishments
@@ -57,6 +76,19 @@ module BeerList
       lists_as_hash.to_json
     end
 
+    def send_list(list, url=nil)
+      url ||= default_url
+      raise NoUrlError unless url
+      raise NotAListError unless list.is_a? BeerList::List
+      scraper.send_json url, list.to_json
+    end
+
+    def send_lists(url=nil)
+      url ||= default_url
+      raise NoUrlError unless url
+      scraper.send_json url, lists_as_json
+    end
+
     def scraper
       @scraper ||= Scraper.instance
     end
@@ -78,11 +110,19 @@ module BeerList
 
     def method_missing(method, *args, &block)
       class_name = method.to_s.split('_').map(&:capitalize).join
-      klass = get_class_with_namespace class_name
-      scraper.beer_list klass.new
+      if klass = get_class_with_namespace(class_name)
+        scraper.beer_list klass.new
+      else
+        super
+      end
+    end
+
+    def is_establishment?(class_name)
+      BeerList::Establishments.constants.include? class_name.to_sym
     end
 
     def get_class_with_namespace(class_name)
+      return nil unless is_establishment? class_name
       ['BeerList', 'Establishments', class_name].inject(Object){ |o, name| o.const_get(name) }
     end
   end

data/lib/beer_list/cli.rb

@@ -11,7 +11,7 @@ module BeerList
            banner:   'The directory in which BeerList will put your establishments'
     option :selector,
            aliases: '-s',
-           banner: 'Optional selector to use for scraping'
+           banner:  'Optional selector to use for scraping'
 
     desc 'establish ESTABLISHMENT', 'Generate a subclass of BeerList::Establishments::Establishment in the given directory'
     def establish(klass)
@@ -30,8 +30,8 @@ module BeerList
 
     desc 'list ESTABLISHMENTS', 'Retrieve the beer list at the given establishments'
     def list(*establishments)
-      BeerList.establishments_dir = options[:directory]
-      BeerList.add_establishments *classify(establishments)
+      configure
+      add_establishments establishments
       if options[:json]
         puts BeerList.lists_as_json
       else
@@ -46,13 +46,42 @@ module BeerList
       end
     end
 
+    option :url,
+           aliases:  '-u',
+           required: true,
+           banner:   'the URL to which to post your lists'
+    desc 'send ESTABLISHMENTS', 'Send (POST) the lists (as JSON) for the given establishments to the given URL'
+    def send(*establishments)
+      configure
+      add_establishments establishments
+      puts "Sent!" if BeerList.send_lists
+    end
+
     private
 
+    def add_establishments(establishments)
+      BeerList.add_establishments *classify(establishments)
+    end
+
+    def configure
+      BeerList.configure do |c|
+        c.establishments_dir = options[:directory]
+        c.default_url        = options[:url]
+      end
+    end
+
     def classify(establishments)
       establishments.map do |est|
         class_name = est.to_s.split('_').map(&:capitalize).join
-        klass = BeerList.send(:get_class_with_namespace, class_name)
+        instantiate_or_die class_name
+      end
+    end
+
+    def instantiate_or_die(class_name)
+      if klass = BeerList.send(:get_class_with_namespace, class_name)
         klass.new
+      else
+        abort "#{class_name} is not recognized. Is it in your BeerList.establishments_dir?"
       end
     end
   end

data/lib/beer_list/establishments/blue_door_pub.rb

@@ -0,0 +1,15 @@
+module BeerList
+  module Establishments
+    class BlueDoorPub < Establishment
+      URL = 'http://thebdp.com/?page_id=159'
+
+      def get_list
+        page.search('div.two-columns li a').map(&:text)
+      end
+
+      def url
+        URL
+      end
+    end
+  end
+end

data/lib/beer_list/establishments/ginger_hop.rb

@@ -0,0 +1,15 @@
+module BeerList
+  module Establishments
+    class GingerHop < Establishment
+      URL = 'http://www.gingerhop.com/beer'
+
+      def get_list
+        page.search('div.left-col h5').map(&:text)
+      end
+
+      def url
+        URL
+      end
+    end
+  end
+end

data/lib/beer_list/establishments/mc_coys_mn.rb

@@ -0,0 +1,36 @@
+module BeerList
+  module Establishments
+    class McCoysMN < Establishment
+      attr_accessor :url
+
+      DRAFTS  = 'http://mccoysmn.com/beer/'
+      BOTTLES = 'http://mccoysmn.com/beer/bottles'
+
+      def initialize
+        @url = DRAFTS
+      end
+
+      def get_list
+        @beers = []
+        get_draft_list
+        get_bottle_list
+      end
+
+      private
+
+      def get_draft_list
+        @beers += base_list
+      end
+
+      def get_bottle_list
+        self.url  = BOTTLES
+        self.page = BeerList.scraper.visit self
+        @beers   += base_list
+      end
+
+      def base_list
+        page.search('td.title a').map(&:text)
+      end
+    end
+  end
+end

data/lib/beer_list/exceptions.rb

@@ -6,4 +6,18 @@ module BeerList
       super msg
     end
   end
+
+  class NoUrlError < StandardError
+    def initialize(msg=nil)
+      msg ||= "No url was specified and no default_url exists"
+      super msg
+    end
+  end
+
+  class NotAListError < StandardError
+    def initialize(msg=nil)
+      msg ||= "That object was not a BeerList::List"
+      super msg
+    end
+  end
 end

data/lib/beer_list/scraper.rb

@@ -17,13 +17,23 @@ module BeerList
     end
 
     def visit(visitable)
-      visitable.page = @agent.get(visitable.url)
+      visitable.page = agent.get(visitable.url)
+    end
+
+    def send_json(url, json)
+      url = "http://#{url}" unless url.start_with? 'http://'
+      agent.post url, "{\"beer_list\": #{json}}", 'Content-Type' => 'application/json'
+      true
     end
 
     private
 
     def set_user_agent
-      @agent.user_agent_alias = USER_AGENT
+      agent.user_agent_alias = USER_AGENT
+    end
+
+    def agent
+      @agent
     end
   end
 end

data/lib/beer_list/settings.rb

@@ -0,0 +1,5 @@
+module BeerList
+  class Settings
+    attr_accessor :establishments_dir, :default_url
+  end
+end

data/spec/lib/beer_list/scraper_spec.rb

@@ -0,0 +1,62 @@
+require 'spec_helper'
+
+module BeerList
+  describe Scraper do
+    let(:establishment){ BeerList::Establishments::Establishment.new }
+    let(:scraper){ Scraper.instance }
+    let(:agent){ stub }
+    let(:url){ "http://omg.io" }
+
+    before do
+      scraper.stub(:agent){ agent }
+      agent.stub(:user_agent_alias=)
+    end
+
+    describe '#send_json' do
+      let(:json){ "{\"foo\":\"bar\"}" }
+      let(:headers){ { 'Content-Type' => 'application/json' } }
+
+      it 'posts to the given url with namespaced parameters' do
+        expected_json = "{\"beer_list\": #{json}}"
+        agent.should_receive(:post).with url, expected_json, headers
+        scraper.send_json url, json
+      end
+
+      it 'prepends a scheme if one is not given' do
+        expected_json = "{\"beer_list\": #{json}}"
+        no_scheme_url = 'www.foobar.com'
+        agent.should_receive(:post).with "http://#{no_scheme_url}", expected_json, headers
+        scraper.send_json no_scheme_url, json
+      end
+    end
+
+    describe '#beer_list' do
+      before do
+        scraper.should_receive(:visit).with establishment
+      end
+
+      it "calls the establishment's #list method" do
+        establishment.should_receive :list
+        scraper.beer_list establishment
+      end
+    end
+
+    describe '#visit' do
+      before do
+        establishment.stub(:url){ url }
+        establishment.stub(:list)
+      end
+
+      it "visits the establishment's url" do
+        agent.should_receive(:get).with(url){ 'the page' }
+        scraper.beer_list establishment
+      end
+
+      it "assigns to establishment.page" do
+        agent.stub(:get){ 'the page' }
+        establishment.should_receive(:page=).with 'the page'
+        scraper.beer_list establishment
+      end
+    end
+  end
+end

data/spec/lib/beer_list_spec.rb

@@ -3,6 +3,23 @@ require 'spec_helper'
 describe BeerList do
   let(:establishment){ BeerList::Establishments::ThreeSquares.new }
 
+  describe '.configure' do
+    before do
+      BeerList.configure do |c|
+        c.establishments_dir = '/home/foo'
+        c.default_url        = 'http://omg.io'
+      end
+    end
+
+    it 'stores the establishments_dir' do
+      BeerList.establishments_dir.should == '/home/foo'
+    end
+
+    it 'stores the default_url' do
+      BeerList.default_url.should == 'http://omg.io'
+    end
+  end
+
   describe '.establishments' do
 
     after(:each) do
@@ -109,4 +126,34 @@ describe BeerList do
     end
   end
 
+  describe 'sending lists' do
+    let(:scraper){ stub }
+    let(:url){ 'http://omg.io' }
+    let(:json){ "{\"foo\":\"bar\"}" }
+    let(:list){ BeerList::List.new }
+
+    before do
+      BeerList.stub(:scraper).and_return scraper
+      list.stub(:to_json).and_return json
+    end
+
+    describe '.send_list' do
+      it 'delegates to the scraper' do
+        scraper.should_receive(:send_json).with(url, json)
+        BeerList.send_list list, url
+      end
+    end
+
+    describe '.send_lists' do
+      before do
+        BeerList.stub(:lists).and_return [list]
+        list.stub(:to_hash).and_return({ foo: 'bar' })
+      end
+
+      it 'delegates to the scraper' do
+        scraper.should_receive(:send_json).with(url, json)
+        BeerList.send_lists url
+      end
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: beer_list
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-16 00:00:00.000000000 Z
+date: 2013-05-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mechanize
@@ -95,6 +95,7 @@ files:
 - lib/beer_list/cli.rb
 - lib/beer_list/establishments.rb
 - lib/beer_list/establishments/acadia_cafe.rb
+- lib/beer_list/establishments/blue_door_pub.rb
 - lib/beer_list/establishments/blue_nile.rb
 - lib/beer_list/establishments/bulldog_lowertown.rb
 - lib/beer_list/establishments/bulldog_northeast.rb
@@ -102,12 +103,14 @@ files:
 - lib/beer_list/establishments/busters_on28th.rb
 - lib/beer_list/establishments/edina_grill.rb
 - lib/beer_list/establishments/establishment.rb
+- lib/beer_list/establishments/ginger_hop.rb
 - lib/beer_list/establishments/groveland_tap.rb
 - lib/beer_list/establishments/happy_gnome.rb
 - lib/beer_list/establishments/longfellow_grill.rb
 - lib/beer_list/establishments/lowry_uptown.rb
 - lib/beer_list/establishments/mackenzie_pub.rb
 - lib/beer_list/establishments/macs_industrial.rb
+- lib/beer_list/establishments/mc_coys_mn.rb
 - lib/beer_list/establishments/muddy_pig.rb
 - lib/beer_list/establishments/muddy_waters.rb
 - lib/beer_list/establishments/new_bohemia.rb
@@ -119,11 +122,13 @@ files:
 - lib/beer_list/list.rb
 - lib/beer_list/listable.rb
 - lib/beer_list/scraper.rb
+- lib/beer_list/settings.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/scraper_spec.rb
 - spec/lib/beer_list_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/DanOlson/beer_list
@@ -154,5 +159,6 @@ 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/scraper_spec.rb
 - spec/lib/beer_list_spec.rb
 - spec/spec_helper.rb