frothybeer 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rvmrc

@@ -0,0 +1,55 @@
+#!/usr/bin/env bash
+
+# This is an RVM Project .rvmrc file, used to automatically load the ruby
+# development environment upon cd'ing into the directory
+
+# First we specify our desired <ruby>[@<gemset>], the @gemset name is optional.
+environment_id="ruby-1.9.2-p290@frothybeer"
+
+#
+# Uncomment following line if you want options to be set only for given project.
+#
+# PROJECT_JRUBY_OPTS=( --1.9 )
+
+#
+# First we attempt to load the desired environment directly from the environment
+# file. This is very fast and efficient compared to running through the entire
+# CLI and selector. If you want feedback on which environment was used then
+# insert the word 'use' after --create as this triggers verbose mode.
+#
+if [[ -d "${rvm_path:-$HOME/.rvm}/environments" \
+  && -s "${rvm_path:-$HOME/.rvm}/environments/$environment_id" ]]
+then
+  \. "${rvm_path:-$HOME/.rvm}/environments/$environment_id"
+
+  if [[ -s "${rvm_path:-$HOME/.rvm}/hooks/after_use" ]]
+  then
+    . "${rvm_path:-$HOME/.rvm}/hooks/after_use"
+  fi
+else
+  # If the environment file has not yet been created, use the RVM CLI to select.
+  if ! rvm --create  "$environment_id"
+  then
+    echo "Failed to create RVM environment '${environment_id}'."
+    exit 1
+  fi
+fi
+
+#
+# If you use an RVM gemset file to install a list of gems (*.gems), you can have
+# it be automatically loaded. Uncomment the following and adjust the filename if
+# necessary.
+#
+# filename=".gems"
+# if [[ -s "$filename" ]]
+# then
+#   rvm gemset import "$filename" | grep -v already | grep -v listed | grep -v complete | sed '/^$/d'
+# fi
+
+# If you use bundler, this might be useful to you:
+# if command -v bundle && [[ -s Gemfile ]]
+# then
+#   bundle
+# fi
+
+

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in frothybeer.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Vidur Murali
+
+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,64 @@
+# Frothybeer
+
+Gets ratings, styles, abv content, breweries, and other information from a beer's name
+
+Very simple and crude at the moment. Needs an exact match to the name to find the beer. However, it does return an array of other matches as a result. (The first element is the exact match, or 'nil' if an exact match was not found)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'frothybeer'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install frothybeer
+
+## Usage
+
+test.rb:
+
+	require './frothybeer/lib/frothybeer'
+
+	exit if ARGV[0].nil?
+
+	beers = FrothyBeer::beersearch(ARGV[0])
+	if beers.empty?
+		puts "No results found for that beer"
+	elsif beers.first.nil?
+	puts "Did not find #{ARGV[0]}, but we did find these similarly named beers:"
+	beers.shift
+	beers.each do |beer|
+		puts "#{beer.name} with a rating of #{beer.rating}" if !beer.rating.nil?
+	end
+	else
+		beer = beers.first
+	puts "#{beer.name} has a rating of #{beer.rating}"
+	end
+
+Sample output:
+
+	$ ruby test.rb "Sierra Nevada Pale Ale"
+	Sierra Nevada Pale Ale has a rating of 91/100
+	$ ruby test.rb "Anchor Steam"
+	Did not find Anchor Steam, but we did find these similarly named beers:
+	Anchor Steam Beer with a rating of 87/100
+	$ ruby test.rb "asdgaga"
+	No results found for that beer
+	$ ruby test.rb "Belgian Ale"
+	Did not find Belgian Ale, but we did find these similarly named beers:
+	Borman's Belgian Ale with a rating of 78/100
+	Friar's Belgian-Style White Ale with a rating of 82/100
+	W'09 Belgian Style Ale with a rating of 82/100
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require 'bundler/gem_tasks'

data/frothybeer.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/frothybeer/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Vidur Murali"]
+  gem.email         = ["vidur.murali@gmail.com"]
+  gem.description   = %q{Finds beers and their attributes from BeerAdvocate}
+  gem.summary       = %q{Gets ratings, styles, abv content, breweries, and other information from a beer's name}
+  gem.homepage      = "https://github.com/vyder/frothybeer"
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.name          = "frothybeer"
+  gem.require_paths = ["lib"]
+  gem.version       = FrothyBeer::VERSION
+  
+  gem.add_runtime_dependency "bundler"
+  gem.add_runtime_dependency "hpricot"
+end

data/lib/frothybeer.rb

@@ -0,0 +1,92 @@
+$:.unshift File.dirname(__FILE__) # For use/testing when no gem is installed
+
+# rubygems
+require 'rubygems'
+
+# 3rd party
+require 'hpricot'
+require 'open-uri'
+
+# internal requires
+require 'frothybeer/beer' # yarrr!
+require 'frothybeer/webpage'
+require 'frothybeer/version'
+
+
+
+module FrothyBeer
+
+  # Main search function used to find the beer
+  #
+  #
+  def self.beersearch(beerToFind)
+    return nil if beerToFind.nil? # TODO raise an exception
+    
+    # Clean query string
+    query = beerToFind.gsub(" ", "+")
+    url = "http://beeradvocate.com/search?q=#{query}&qt=beer"
+    
+    resultsPage = WebPage::getPage(url)
+    if WebPage::hasResults?(resultsPage)
+      results = WebPage::getResults(resultsPage)
+    else
+      # TODO raise an exception
+      return []
+    end
+
+    # find the best match beers
+    beer = nil
+    suggestions = []
+    results.each do |beer_name, beer_link|
+      beer_page = WebPage::getPage(beer_link)
+      b = Beer.new(self.makeBeerHash(beer_page))
+      
+      if beer_name == beerToFind # TODO Figure out a better matching algorithm
+        beer = b
+      else
+        suggestions << b
+      end
+    end
+    
+    return suggestions.unshift(beer)
+  end
+  
+  def self.makeBeerHash(page)
+    hash = {}
+    
+    hash[:name] = self.scrapeName(page)
+    hash[:brewery] = self.scrapeBrewery(page)
+    hash[:rating] = self.scrapeRating(page)
+    hash[:style] = self.scrapeStyle(page)
+    hash[:abv] = self.scrapeABV(page)
+    
+    hash
+  end
+  
+  # Methods to scrape the beer profile page.
+  def self.scrapeName(page)
+    page.search("h1[@class='norm']").html
+  end
+  
+  def self.scrapeBrewery(page)
+    page.search("a/b")[2].html
+  end
+  
+  # Given a beer page, returns rating for the beer
+  # (returns nil if rating N/A)
+  def self.scrapeRating(page)
+    rating = page.search("span[@class='BAscore_big']").first.html
+    (rating == "N/A") ? nil : "#{rating}/100"
+  end
+  
+  def self.scrapeStyle(page)
+    page.search("a/b")[3].html
+  end
+  
+  def self.scrapeABV(page)
+    raw = page.search("a/b")[3].parent().next().inspect
+    return nil if raw.match(/\?/) # There is no abv specified
+    abv = raw.match(/([\d\.]*)%/)[0]
+  end
+  
+end

data/lib/frothybeer/beer.rb

@@ -0,0 +1,22 @@
+module FrothyBeer
+  
+  class Beer
+    attr_reader :name, :brewery, :rating, :style, :abv
+    
+    # Beer hash params:
+    # :name
+    # :brewery
+    # :rating
+    # :style
+    # :abv (alcohol by volume)
+    def initialize(hash)
+      @name = hash[:name]
+      @brewery = hash[:brewery]
+      @rating = hash[:rating]
+      @style = hash[:style]
+      @abv = hash[:abv]
+    end
+    
+  end
+  
+end

data/lib/frothybeer/version.rb

@@ -0,0 +1,3 @@
+module FrothyBeer
+  VERSION = "0.0.1"
+end

data/lib/frothybeer/webpage.rb

@@ -0,0 +1,31 @@
+module FrothyBeer
+  
+  module WebPage
+    
+    # Creates a new webpage from a url
+    def self.getPage(url)
+      open(url) {|f| Hpricot(f)}
+    end
+    
+    def self.hasResults?(page)
+      # are there elements with 'no results' as the text
+      page.search("li[text()*='No results']").empty?
+    end
+    
+    def self.getResults(page)
+      return {} if !self.hasResults?(page)
+      
+      resultHash = {}
+      list_elements = page.search("li/a")
+      list_elements.each do |li|
+        # Beer names are in bold. Alternate links are breweries
+        if !li.at("b").nil?
+          resultHash[li.at("b").html] = "http://beeradvocate.com#{li.get_attribute("href")}"
+        end
+      end
+      
+      resultHash
+    end
+    
+  end # End of WebPage module
+end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification
+name: frothybeer
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Vidur Murali
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-04-10 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &70129987888340 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70129987888340
+- !ruby/object:Gem::Dependency
+  name: hpricot
+  requirement: &70129987887920 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70129987887920
+description: Finds beers and their attributes from BeerAdvocate
+email:
+- vidur.murali@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rvmrc
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- frothybeer.gemspec
+- lib/frothybeer.rb
+- lib/frothybeer/beer.rb
+- lib/frothybeer/version.rb
+- lib/frothybeer/webpage.rb
+homepage: https://github.com/vyder/frothybeer
+licenses: []
+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.10
+signing_key: 
+specification_version: 3
+summary: Gets ratings, styles, abv content, breweries, and other information from
+  a beer's name
+test_files: []