ratebeer 0.0.8 → 0.1.0

data/lib/ratebeer/location.rb

@@ -1,6 +1,6 @@
-require_relative "brewery"
-require_relative "style"
-require_relative "urls"
+require_relative 'brewery'
+require_relative 'style'
+require_relative 'urls'
 
 module RateBeer
   class Location
@@ -25,41 +25,52 @@ module RateBeer
     #
     def initialize(id, location_type: nil, name: nil, **options)
       super
-      if location_type.nil? || !([:country, :region].include?(location_type))
-        raise ArgumentError.new("location_type must be supplied and must be "\
-                                "either country or region")
+      if location_type.nil? || ![:country, :region].include?(location_type)
+        raise ArgumentError.new('location_type must be supplied and must be '\
+                                'either country or region')
       end
       @location_type = location_type
     end
 
+    def doc
+      unless instance_variable_defined?('@doc')
+        @doc = noko_doc(url)
+        validate_location
+      end
+      @doc
+    end
+
+    def heading
+      @heading ||= doc.at_css('.col-lg-9')
+    end
+
     private
 
-    # Retrive details about this location from the website.
-    #
-    # This method stores the retrived details in instance variables
-    # of the location instance.
-    #
-    def retrieve_details
-      doc          = noko_doc(url)
-      heading      = doc.css('.col-lg-9').first
-      brewery_info = doc.css('#tabs table')
+    def validate_location
+      if @doc.at_css('h1').text.include? 'n/a'
+        raise PageNotFoundError.new("#{self.class.name} not found - #{id}")
+      end
+    end
 
+    def scrape_name
       @name = heading.at_css('h1')
                      .text
                      .split('Breweries')
                      .first
                      .strip
-      if @name == "n/a" || @name == "RateBeer Robot Oops!"
-        raise PageNotFoundError.new("#{self.class.name} not found - #{id}")
-      end
+    end
 
+    def scrape_num_breweries
       @num_breweries = heading.at_css('li.active')
                               .text
                               .scan(/Active \((\d*)\)/)
                               .first
                               .first
                               .to_i
+    end
 
+    def scrape_breweries
+      brewery_info = doc.css('#tabs table')
       @breweries = brewery_info.flat_map.with_index do |tbl, i|
         status = i == 0 ? 'Active' : 'Out of Business'
 
@@ -83,7 +94,6 @@ module RateBeer
                       status:      status)
         end
       end
-      nil
     end
 
     # Return URL for page containing information on this location.
@@ -97,7 +107,7 @@ module RateBeer
                when :region
                  URI.join(BASE_URL, region_url(id))
                else
-                 raise "invalid location type: #{@location_type.to_s}"
+                 raise "invalid location type: #{@location_type}"
                end
     end
   end

data/lib/ratebeer/scraping.rb

@@ -16,9 +16,7 @@ module RateBeer
     def self.included(base)
       base.data_keys.each do |attr|
         define_method(attr) do
-          unless instance_variable_defined?("@#{attr}")
-            retrieve_details
-          end
+          send("scrape_#{attr}") unless instance_variable_defined?("@#{attr}")
           instance_variable_get("@#{attr}")
         end
       end
@@ -60,6 +58,11 @@ module RateBeer
                end
     end
 
+    # Extracts an ID# from an a element containing a link to an entity.
+    def id_from_link(node)
+      node.attribute('href').value.split('/').last.to_i
+    end
+
     # Return full details of the scraped entity in a Hash.
     #
     def full_details

data/lib/ratebeer/search.rb

@@ -6,7 +6,6 @@ require_relative 'scraping'
 require_relative 'urls'
 
 module RateBeer
-  
   # Stop I18N from enforcing locale, to avoid error message
   I18n.enforce_available_locales = false
 
@@ -29,7 +28,7 @@ module RateBeer
       # a search.
       #
       def search(query)
-        s = self.new(query)
+        s = new(query)
         { beers:      s.beers,
           breweries:  s.breweries }
       end
@@ -41,8 +40,9 @@ module RateBeer
     #
     # @param [String] query Term to use to search RateBeer
     #
-    def initialize(query)
+    def initialize(query, scrape_beer_brewers = false)
       self.query = query
+      @scrape_breweries = scrape_beer_brewers
     end
 
     # Setter for query instance variable.
@@ -52,6 +52,10 @@ module RateBeer
       @query = fix_query_param(qry)
     end
 
+    def ==(other)
+      query == other.query
+    end
+
     def inspect
       num_beers = @beers && @beers.count || 0
       num_breweries = @breweries && @breweries.count || 0
@@ -71,7 +75,6 @@ module RateBeer
     #
     def run_search
       @beers, @breweries = nil
-      doc                = post_request(URI.join(BASE_URL, SEARCH_URL), post_params)
       tables             = doc.css('h2').map(&:text).zip(doc.css('table'))
       beers, breweries   = nil
       tables.each do |(heading, table)|
@@ -84,24 +87,44 @@ module RateBeer
       end
 
       # RateBeer is inconsistent with searching for IPAs. If IPA is in the name
-      # of the beer, replace IPA with India Pale Ale, and add the additional 
+      # of the beer, replace IPA with India Pale Ale, and add the additional
       # results to these results.
-      if query.downcase.include?(" ipa")
-        alt_query = query.downcase.gsub(" ipa", " india pale ale")
+      if query.downcase.include?(' ipa')
+        alt_query = query.downcase.gsub(' ipa', ' india pale ale')
         extra_beers = self.class.new(alt_query).run_search.beers
         @beers = ((@beers || []) + (extra_beers || [])).uniq
       end
-      return self
+      self
     end
 
     alias retrieve_details run_search
 
     private
+    
+    def doc
+      @doc ||= post_request(URI.join(BASE_URL, SEARCH_URL), post_params)
+    end
+
+    def scrape_beers
+      unless instance_variable_defined?('@beers')
+        run_search
+        @beers = @beers.sort_by(&:id)
+      end
+      @beers
+    end
+
+    def scrape_breweries
+      unless instance_variable_defined?('@breweries')
+        run_search
+        @breweries = @breweries.sort_by(&:id)
+      end
+      @breweries
+    end
 
     # Generate parameters to use in POST request.
     #
     def post_params
-      { "BeerName" => @query }
+      { 'BeerName' => @query }
     end
 
     # Process breweries table returned in search.
@@ -118,9 +141,9 @@ module RateBeer
     def process_breweries_table(table)
       table.css('tr').map do |row|
         result = [:id, :name, :location, :url].zip([nil]).to_h
-        result[:name], result[:location] = row.element_children.map { |x| 
-          fix_characters(x.text) 
-        }
+        result[:name], result[:location] = row.element_children.map do |x|
+          fix_characters(x.text)
+        end
         result[:url] = row.at_css('a')['href']
         result[:id]  = result[:url].split('/').last.to_i
         Brewery.new(result[:id], name: result[:name])
@@ -168,7 +191,7 @@ module RateBeer
       result[:url] = row.at_css('a')['href']
       result[:id]  = result[:url].split('/').last.to_i
       b = Beer.new(result[:id], name: result[:name])
-      b.brewery.name
+      b.brewery.name if @scrape_beer_brewers
       b
     end
 

data/lib/ratebeer/style.rb

@@ -24,16 +24,16 @@ module RateBeer
 
       # Scrape all styles.
       #
-      # RateBeer provides a styles landing page, with links through to info on 
-      # each style listed thereon. This method scrapes style info with links 
+      # RateBeer provides a styles landing page, with links through to info on
+      # each style listed thereon. This method scrapes style info with links
       # to the more detailed pages.
       #
-      # @param [Boolean] hidden_styles Flag for whether to include hidden 
+      # @param [Boolean] hidden_styles Flag for whether to include hidden
       #   styles.
-      # @return [Array<RateBeer::Style>] List of styles with links etc. to 
+      # @return [Array<RateBeer::Style>] List of styles with links etc. to
       #   detailed pages
       #
-      def all_styles(include_hidden=false)
+      def all_styles(include_hidden = false)
         doc  = Scraping.noko_doc(URI.join(BASE_URL, '/beerstyles/'))
         root = doc.at_css('div.container-fluid table')
 
@@ -41,15 +41,15 @@ module RateBeer
         style_node = root.css('.styleGroup')
 
         styles = style_node.flat_map.with_index do |list, i|
-          list.css('a').map do |x| 
+          list.css('a').map do |x|
             category = categories[i]
-            Style.new(x['href'].split('/').last.to_i, name: x.text).tap { |s| 
-              s.category = category 
-            }
+            Style.new(x['href'].split('/').last.to_i, name: x.text).tap do |s|
+              s.category = category
+            end
           end
         end
         if include_hidden
-          styles += hidden_styles
+          styles + hidden_styles
         else
           styles
         end
@@ -57,13 +57,13 @@ module RateBeer
       
       # Scrape hidden style information
       #
-      # RateBeer has a number of styles not accessible from the "beerstyles" 
+      # RateBeer has a number of styles not accessible from the "beerstyles"
       # landing page. This method scrapes these.
       #
       # @return [Array<Hash>] List of hidden styles
       #
       def hidden_styles
-        hidden_ids = [40, 41, 57, 59, 66, 67, 68, 69, 70, 
+        hidden_ids = [40, 41, 57, 59, 66, 67, 68, 69, 70,
                       75, 83, 99, 104, 106, 116, 119, 120]
         hidden_ids.map do |id|
           Style.new(id)
@@ -73,32 +73,45 @@ module RateBeer
 
     private
 
-    # Retrieve details about this style from the website.
-    #
-    # This method stores the retrieved details in instance variables of
-    # this style instance.
-    #
-    def retrieve_details
-      doc       = noko_doc(URI.join(BASE_URL, style_url(id)))
-      root      = doc.at_css('.container-fluid')
-      beer_list = noko_doc(URI.join(BASE_URL, style_beers_url(id)))
-
-      if !root.nil?
-        @name = root.at_css('h1').text.strip
-      else
-        raise PageNotFoundError.new("style not found - ##{id}")
+    def doc
+      unless instance_variable_defined?('@doc')
+        @doc = noko_doc(URI.join(BASE_URL, style_url(id)))
+        validate_style
       end
+      @doc
+    end
+
+    def validate_style
+      raise PageNotFoundError.new("style not found - ##{id}") if root.nil?
+    end
+
+    def root
+      @root ||= doc.at_css('.container-fluid')
+    end
 
+    def beer_list
+      @beer_list = noko_doc(URI.join(BASE_URL, style_beers_url(id)))
+    end
+
+    def scrape_name
+      @name = root.at_css('h1').text.strip
+    end
+
+    def scrape_description
       @description = root.at_css('#styleDescription').text
+    end
+
+    def scrape_glassware
       @glassware   = root.css('.glassblurb').map { |x| x.text.strip }
+    end
 
+    def scrape_beers
       @beers = beer_list.css('tr').drop(1).map do |row|
         cells = row.css('td')
         url   = cells[1].at_css('a')['href']
-        [cells[0].text.to_i, Beer.new(url.split('/').last, 
+        [cells[0].text.to_i, Beer.new(url.split('/').last,
                                       name: fix_characters(cells[1].text))]
       end.to_h
-      nil
     end
   end
 end

data/lib/ratebeer/urls.rb

@@ -19,11 +19,15 @@ module RateBeer
     end
 
     # Return URL to info page for brewery with id
-    #
     def brewery_url(id)
       "/brewers/a/#{id}/"
     end
 
+    # Return URL to beer listing page for brewery with id.
+    def brewery_beers_url(id)
+      "/Ratings/Beer/ShowBrewerBeers.asp?BrewerID=#{id}"
+    end
+
     # Return URL to info page for country with id
     def country_url(id)
       "/breweries/a/0/#{id}/"

data/spec/lib/ratebeer/beer_spec.rb

@@ -3,43 +3,43 @@ require 'spec_helper'
 describe RateBeer::Beer do
   before :all do
     @valid     = RateBeer::Beer.new(1411) # ID for Tennents Lager (sorry...)
-    @retired   = RateBeer::Beer.new(213225) # ID for BrewDog Vice Bier
-    @with_name = RateBeer::Beer.new(422, name: "Stone IPA")
+    @retired   = RateBeer::Beer.new(213_225) # ID for BrewDog Vice Bier
+    @with_name = RateBeer::Beer.new(422, name: 'Stone IPA')
   end
 
-  describe "#new" do
-    it "creates a beer instance" do
+  describe '#new' do
+    it 'creates a beer instance' do
       expect(@valid).to be_a RateBeer::Beer
     end
 
-    it "requires an ID# as parameter" do
+    it 'requires an ID# as parameter' do
       expect { RateBeer::Beer.new }.to raise_error(ArgumentError)
     end
 
-    it "accepts a name parameter" do
+    it 'accepts a name parameter' do
       expect(@with_name).to be_a RateBeer::Beer
     end
   end
 
-  describe "#name" do
-    it "retrieves name details from RateBeer if not present" do
-      expect(@valid.name).to eq "Tennents Lager"
+  describe '#name' do
+    it 'retrieves name details from RateBeer if not present' do
+      expect(@valid.name).to eq 'Tennents Lager'
     end
 
-    it "uses name details if passed as parameter" do
-      expect(@with_name.name).to eq "Stone IPA"
+    it 'uses name details if passed as parameter' do
+      expect(@with_name.name).to eq 'Stone IPA'
     end
   end
 
-  describe "#retired" do
-    it "states that beer is retired when this is the case" do
+  describe '#retired' do
+    it 'states that beer is retired when this is the case' do
       expect(@valid.retired).to be false
       expect(@retired.retired).to be true
     end
   end
 
-  describe "#full_details" do
-    it "returns full information about the beer" do
+  describe '#full_details' do
+    it 'returns full information about the beer' do
       expect(@valid.full_details).to include(:id,
                                              :name,
                                              :brewery,

data/spec/lib/ratebeer/brewery_spec.rb

@@ -3,51 +3,58 @@ require 'spec_helper'
 describe RateBeer::Brewery do
   before :all do
     @valid     = RateBeer::Brewery.new(8534) # ID for BrewDog
-    @with_name = RateBeer::Brewery.new(1069, name: "Cantillon Brewery")
+    @with_name = RateBeer::Brewery.new(1069, name: 'Cantillon Brewery')
   end
 
-  describe "#new" do
-    it "creates a brewery instance" do
+  describe '#new' do
+    it 'creates a brewery instance' do
       expect(@valid).to be_a RateBeer::Brewery
     end
 
-    it "requires an ID# as parameter" do
+    it 'requires an ID# as parameter' do
       expect { RateBeer::Brewery.new }.to raise_error(ArgumentError)
     end
 
-    it "accepts a name parameter" do
+    it 'accepts a name parameter' do
       expect(@with_name).to be_a RateBeer::Brewery
     end
   end
 
-  describe "#name" do
-    it "retrieves name from RateBeer if not passed as parameter" do
-      expect(@valid.name).to eq "BrewDog"
+  describe '#name' do
+    it 'retrieves name from RateBeer if not passed as parameter' do
+      expect(@valid.name).to eq 'BrewDog'
     end
 
-    it "uses name details if passed as parameter" do
-      expect(@with_name.name).to eq "Cantillon Brewery"
+    it 'uses name details if passed as parameter' do
+      expect(@with_name.name).to eq 'Cantillon Brewery'
     end
   end
 
-  describe "#beers" do
-    it "returns a non-empty array of beers produced by the brewery" do
+  describe '#beers' do
+    it 'returns a non-empty array of beers produced by the brewery' do
       expect(@valid.beers).to_not be_empty
     end
 
-    it "returns an array of beer instances" do
+    it 'returns an array of beer instances' do
       @valid.beers.each { |b| expect(b).to be_a RateBeer::Beer }
     end
 
-    it "returns a list of beers produced by brewery" do
-      beers = [215065, 98242, 172237, 76701, 178585, 162521, 87321, 118987, 
-               119594].map { |id| RateBeer::Beer.new(id) }
+    it 'returns a list of beers produced by brewery' do
+      beers = [215_065,
+               98_242,
+               172_237,
+               76_701,
+               178_585,
+               162_521,
+               87_321,
+               118_987,
+               119_594].map { |id| RateBeer::Beer.new(id) }
       expect(@valid.beers).to include(*beers)
     end
   end
 
-  describe "#full_details" do
-    it "returns full information about the brewery" do
+  describe '#full_details' do
+    it 'returns full information about the brewery' do
       expect(@valid.full_details).to include(:id,
                                              :name,
                                              :url,