brewerydb 0.0.2 → 0.0.3

data/README.rdoc

@@ -10,37 +10,50 @@ In Rails, you can configure it with initializer by creating a file
 named config/initializers/brewerydb.rb
 
   BreweryDb.configure do |config|
-    config.apikey = 'c01822f029486661bb3669a845b5ec14'
+    config.apikey = 'YOUR_API_KEY'
   end
 
 Remember: Good People Drink Good Beer!
 
+== Releases
+
+0.0.3
+* we return Hashie::Mash objects, so you can access the properties using .notation
+* search endpoint enabled
+
+0.0.2
+* fully functional for all end points
+
+0.0.1
+* initial release
+
 == Examples
 
 You can fetch beers:
 
   response = BreweryDb.beers
-    response['beer'].each do |beer|
-     puts "#{beer['id']}: #{beer['name']}"
-    end
-  end
-  puts response['pages']['page']
-  puts response['pages']['total']
+  
+  response.beer.each do |beer|
+    puts "#{beer.id}: #{beer.name}"
+  end if response.beer
+  
+  puts response.pages.page
+  puts response.pages.total
 
 Get a list of beers on a specific page:
 
   response = BreweryDb.beers(:page => 10, :metadata => true) 
-  response['beer'].each do |beer|
-    puts "#{beer['id']}: #{beer['name']}"
-  end
+  response.beer.each do |beer|
+    puts "#{beer.id}: #{beer.name}"
+  end if response.beer
 
 Get a specific beer or brewery by id:
 
   response = BreweryDb.beer(1196)
-  puts response['name']
+  puts response.name
 
   response = BreweryDb.brewery(1000)
-  puts response['name']
+  puts response.name
 
 Get all the breweries around Washington DC:
 
@@ -49,11 +62,13 @@ Get all the breweries around Washington DC:
                                  :lng => -77.007294,
                                  :radius => 30,
                                  :units => 'm')
-  response['brewery'].each do |brewery|
-    puts brewery['name']
-  end
+  response.brewery.each do |brewery|
+    puts brewery.name
+  end if response.brewery
 
-  puts response['pages']['page']
-  puts response['pages']['total']
+  puts response.pages.page
+  puts response.pages.total
 
 Categories, Styles and Glassware work as well.
+
+Additional working examples are in the examples directory

data/examples/dogfish_beers.rb

@@ -5,14 +5,15 @@ require 'brewerydb'
 # set your API KEY
 
 BreweryDb.configure do |config|
-	  config.apikey = 'XX'
+	  config.apikey = 'YOUR_API_KEY'
 end
 
 # Get all the DogFish Head Beers
-beers = BreweryDb.beers(:brewery_id => 459)
-beers['beer'].each do |beer|
-  puts beer['name']
+results = BreweryDb.beers(:brewery_id => 459)
+
+results.beer.each do |beer|
+  puts beer.name
 end
 
-puts "Page: #{beers['pages']['page']}"
-puts "Total: #{beers['pages']['total']}" 
+puts "Page: #{results.pages.page}"
+puts "Total: #{results.pages.total}"

data/examples/search.rb

@@ -0,0 +1,41 @@
+require 'rubygems'
+require 'brewerydb'
+
+BreweryDb.configure do |config|
+   config.apikey = 'YOUR_API_KEY'
+end
+
+# q => (string) Your query to search on [required] 
+# type => (string) Can be set to beer to return just beers, brewery to 
+# return just breweries or left empty to return both beers and 
+# breweries. 
+# metadata => (true or 1) if set will return more data about the beer or 
+# brewery 
+# page => (int) if there are more pages to page through.
+
+results = BreweryDb.search(:q => 'stone')
+
+puts "Page: #{results.pages.page}"
+puts "Total: #{results.pages.total}"
+
+results.result.each do |result|
+  puts "#{result.id}: #{result.name} (#{result['type']})"
+end if results.result #check if there is a result before looping
+
+#Expected Output
+# 1
+# 2
+# 1204: Stone Brewing Company (Brewery)
+# 821: Stone IPA (Beer)
+# 1258: Stone Pale Ale (Beer)
+# 1205: Stone Cellar Brewpub & Restaurant (Brewery)
+# 6869: Old Stone Wall (Beer)
+# 1193: Standing Stone Brewing Company (Brewery)
+# 2638: Stone Teepee Pale Ale (Beer)
+# 4801: Stone 10th Anniversery IPA (Beer)
+# 4423: Stone 11th Anniversery Ale (Beer)
+# 4800: Stone 12 Anniversery Bitter Chocolate Oatmeal Stout (Beer)
+# 3066: Stone Beer (Beer)
+# 1206: Stone City Brewing (Brewery)
+# 341: Blarney Stone Stout (Beer)
+# ...

data/lib/brewerydb.rb

@@ -1,5 +1,6 @@
 require 'rubygems'
 require 'httparty'
+require 'hashie'
 
 #
 # BreweryDb.configure do |config|
@@ -13,13 +14,22 @@ class BreweryDb
   default_params :format => 'JSON'
   @@apikey = nil
   
+  def self.search(options={})
+    options.merge!({
+      :apikey => apikey
+    })
+        
+    response = get("/search", :query => options)
+    Hashie::Mash.new(response['results']) if response.code == 200
+  end
+  
   def self.breweries(options={})
     options.merge!({
       :apikey => apikey
     })
         
     response = get("/breweries", :query => options)
-    response['breweries'] if response.code == 200
+    Hashie::Mash.new(response['breweries']) if response.code == 200
   end
   
   def self.brewery(id, options={})
@@ -28,7 +38,7 @@ class BreweryDb
     })
     
     response = get("/breweries/#{id}", :query => options)
-    response['breweries']['brewery'] if response.code == 200
+    Hashie::Mash.new(response['breweries']['brewery']) if response.code == 200
   end
   
   def self.beers(options={})
@@ -37,7 +47,7 @@ class BreweryDb
     })
         
     response = get("/beers", :query => options)
-    response['beers'] if response.code == 200
+    Hashie::Mash.new(response['beers']) if response.code == 200
   end
   
   def self.beer(id, options={})
@@ -46,7 +56,7 @@ class BreweryDb
     })
     
     response = get("/beers/#{id}", :query => options)
-    response['beers']['beer'] if response.code == 200
+    Hashie::Mash.new(response['beers']['beer']) if response.code == 200
   end
   
   def self.styles(options={})
@@ -55,7 +65,7 @@ class BreweryDb
     })
         
     response = get("/styles", :query => options)
-    response['styles'] if response.code == 200
+    Hashie::Mash.new(response['styles']) if response.code == 200
   end
   
   def self.style(id, options={})
@@ -64,7 +74,7 @@ class BreweryDb
     })
         
     response = get("/styles/#{id}", :query => options)
-    response['styles']['style'] if response.code == 200
+    Hashie::Mash.new(response['styles']['style']) if response.code == 200
   end
   
   def self.categories(options={})
@@ -73,7 +83,7 @@ class BreweryDb
     })
         
     response = get("/categories", :query => options)
-    response['categories'] if response.code == 200
+    Hashie::Mash.new(response['categories']) if response.code == 200
   end
 
   def self.category(id, options={})
@@ -82,7 +92,7 @@ class BreweryDb
     })
         
     response = get("/categories/#{id}", :query => options)
-    response['categories']['category'] if response.code == 200
+    Hashie::Mash.new(response['categories']['category']) if response.code == 200
   end
   
   def self.glassware(options={})
@@ -91,7 +101,7 @@ class BreweryDb
     })
         
     response = get("/glassware", :query => options)
-    response['glassware'] if response.code == 200
+    Hashie::Mash.new(response['glassware']) if response.code == 200
   end
 
   def self.glass(id, options={})
@@ -100,7 +110,7 @@ class BreweryDb
     })
         
     response = get("/glassware/#{id}", :query => options)
-    response['glassware']['glass'] if response.code == 200
+    Hashie::Mash.new(response['glassware']['glass']) if response.code == 200
   end
   
   def self.apikey

data/lib/brewerydb/version.rb

@@ -1,3 +1,3 @@
 module Brewerydb
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/spec/brewerydb_spec.rb

@@ -10,38 +10,90 @@ describe "brewerydb" do
     BreweryDb.apikey.should eq 'c01822f029486661bb3669a845b5ec14'
   end
   
+  describe "Search" do
+    let (:response) {
+      mock_httparty_response({
+            "results" => {'result' => [{'name' => 'Stone Brewing', 'type' => 'Brewery'},
+                                       {'name' => 'Stone IPA', 'type' => 'Beer'}   
+                                      ],
+                          'pages' => {'page' => 1, 'total' => 2}           
+                          }
+            })
+    }
+    
+    let (:no_results_response) {
+        mock_httparty_response({
+              "results" => {'pages' => {'page' => 1, 'total' => 2}           
+                            }
+              })
+    }
+      
+    it "retrieves results by search" do
+      BreweryDb.should_receive(:get).and_return(response)
+      BreweryDb.search.result.first.name.should == 'Stone Brewing'      
+    end
+    
+    it "handles no results" do
+      BreweryDb.should_receive(:get).and_return(no_results_response)
+      BreweryDb.search.result.should be_nil 
+    end
+    
+  end
+  
   describe "Breweries" do
     before(:each) do
       @response = mock_httparty_response({
-            "breweries" => {'brewery' => {'name' => 'dogfish head'}}
+            "breweries" => {'brewery' => [{'name' => 'dogfish head'}, {'name' => 'stone brewery'}],
+                            'pages' => {'page' => 1, 'total' => 20 }}
       })
       BreweryDb.should_receive(:get).and_return(@response)
     end
     
     it "should retrieve a list of breweries" do
-      BreweryDb.breweries['brewery']['name'].should == 'dogfish head'
+      BreweryDb.breweries.brewery.first.name.should == 'dogfish head'
+    end
+    
+  end
+  
+  describe "Brewery" do
+    before(:each) do
+      @response = mock_httparty_response({
+            "breweries" => {'brewery' => {'name' => 'dogfish head'}}
+      })
+      BreweryDb.should_receive(:get).and_return(@response)
     end
     
     it "should retrieve a specific brewery" do
-        BreweryDb.brewery(1000)['name'].should == 'dogfish head'
+        BreweryDb.brewery(1000).name.should == 'dogfish head'
     end
   end
   
-  describe "Beers" do
+  context "Beers" do
     before(:each) do
       @response = mock_httparty_response({
-            "beers" => {'beer' => {'name' => 'midas touch'},
+            "beers" => {'beer' => [{'name' => 'midas touch'}, {'name' => 'chica stout'}],
                         'pages' => {'page' => 1, 'total' => 20 }
                        }
       })
       BreweryDb.should_receive(:get).and_return(@response)
     end
     
-    it "should retrieve a list of breweries" do
-      BreweryDb.beers['beer']['name'].should == 'midas touch'
+    it "retrieves a list of beers" do
+      BreweryDb.beers.beer.first.name.should == 'midas touch'
     end
     
-    it "should retrieve a specific brewery" do
+  end
+  
+  context "Beer" do
+    before(:each) do
+      @response = mock_httparty_response({
+            "beers" => {'beer' => {'name' => 'midas touch'}
+                       }
+      })
+      BreweryDb.should_receive(:get).and_return(@response)
+    end
+    
+    it "should retrieve a specific beer" do
       BreweryDb.beer(1000)['name'].should == 'midas touch'
     end
   end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: brewerydb
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 25
   prerelease: 
   segments: 
   - 0
   - 0
-  - 2
-  version: 0.0.2
+  - 3
+  version: 0.0.3
 platform: ruby
 authors: 
 - Chris Mar
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-07 00:00:00 -05:00
+date: 2011-03-22 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -64,6 +64,7 @@ files:
 - Rakefile
 - brewerydb.gemspec
 - examples/dogfish_beers.rb
+- examples/search.rb
 - lib/brewerydb.rb
 - lib/brewerydb/version.rb
 - spec/brewerydb_spec.rb