untappd 0.0.2 → 0.0.3

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    untappd (0.0.2)
+    untappd (0.0.3)
       hashie (>= 1.0.0)
       httparty (>= 0.7.3)
 
@@ -26,5 +26,5 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  rspec
+  rspec (>= 2.5.0)
   untappd!

data/README.rdoc

@@ -1,17 +1,56 @@
 == untappd API
 
-I have just started and would love help trying to cover all the end points.
-
-This is a simple wrapper around the untappd API packaged as a ruby gem.
+Wrapper around the Untappd API. This organizes the untappd api 
+into proper RESTFUL objects. See API coverage below for mapping from
+the API documentation.
 
 * You will need to register for an API key: http://untappd.com/api/register
 * Attempting to wrap all the API documented here: http://untappd.com/api/docs/v3
+* All options can be passed into the calls
 
 == Releases
 
+* 0.0.3 Venue Info & Feed, Trending Beer, Brewery Feed, Checkin info & Feed (the pub), Renamed Beer.checkins to Beer.feed
 * 0.0.2 User feed, distinct beers, info, badges, friends, wish list
 * 0.0.1 Beer Search, Info and Checkins
 
+== API Coverage
+
+Beer Object
+* Beer Feed - Untappd::Beer.feed
+* Beer Info - Untappd::Beer.info
+* Beer Search - Untappd::Beer.search
+* Trending - Untappd::Beer.trending
+
+User Object
+* User Feed - Untappd::User.feed
+* User Info - Untappd::User.info
+* User Badges - Untappd::User.badges
+* User Friends - Untappd::User.friends
+* User Wish List - Untappd::User.wish_list
+* User Distinct Beers - Untappd::User.distinct
+
+Venue Object
+* Venue Feed - Untappd::Venue.feed
+* Venue Info - Untappd::Venue.info
+
+Brewery Object
+* Brewery Checkins - Untappd::Brewery.feed
+
+Checkin Object
+* The Pub Feed - Untappd::Checkin.feed
+* Checkin Info - Untappd::Checkin.info
+
+TODO
+
+* Friend Feed
+* Checkin (Test)
+* Checkin
+* Add Comment
+* Remove Comment
+* Toast
+* Remove Toast
+
 == Examples
 Configure your API KEY
 
@@ -48,34 +87,4 @@ All Methods can take additional options specified in the API
 You can dump any result to see what values are available with
 
   info = Untappd::Beer.info(18099)
-  puts info.inspect
-  
-== API Coverage
-
-Beer Object
-* Beer Feed - done
-* Beer Info - done
-* Beer Search - done
-
-User Object
-* User Feed - done
-* User Info - done
-* User Badges - done
-* User Friends - done
-* User Wish List - done
-* User Distinct Beers - done
-
-TODO
-* Friend Feed
-* The Pub Feed
-* Venue Feed
-* Brewery Checkins
-* Venue Info
-* Checkin Info
-* Trending
-* Checkin (Test)
-* Checkin
-* Add Comment
-* Remove Comment
-* Toast
-* Remove Toast
+  puts info.inspect

data/lib/untappd/beer.rb

@@ -1,7 +1,11 @@
 module Untappd
   
   class Beer < Base
-    def self.checkins(beer_id, options={})
+    
+    # since (optional) - The numeric ID of the last recent check-in. This provided to you in the next_query attribute.
+    # offset (optional) - The offset that you like the dataset to begin with. 
+    # Each set returns 25 max records, so you can use that paginate the feed.
+    def self.feed(beer_id, options={})
       options.merge!({
         :key => Untappd::apikey,
         :bid => beer_id
@@ -10,6 +14,7 @@ module Untappd
       response_to_mash get("/beer_checkins", :query => options)
     end
     
+    #
     def self.info(beer_id, options={})
       options.merge!({
         :key => Untappd::apikey,
@@ -19,6 +24,11 @@ module Untappd
       response_to_mash get("/beer_info", :query => options)
     end
     
+    # offset (optional) - The offset that you like the dataset to 
+    # begin with. Each set returns 25 max records, so you can use that paginate the results.
+    # sort (optional): "count" or "name" (default) - This can let you choose if you
+    # want the results to be returned in Alphabetical order (name) or by 
+    # checkin count (count). By default the search returns all values in Alphabetical order.
     def self.search(q, options={})
       options.merge!({
         :key => Untappd::apikey,
@@ -27,6 +37,20 @@ module Untappd
 
       response_to_mash get("/beer_search", :query => options)
     end
+    
+    # type (optional) - 4 options: "all", "macro", "micro", "local". "All" is set to default.
+    # limit (optional) - The number of records that you will return (max 10)
+    # age (optional) - 3 options: "daily", "weekly", "monthly".
+    # geolat (optional) - The numeric Latitude to filter the public feed. This is required for local "type".
+    # geolng (optional) - The numeric Longitude to filter the public feed. This is required for local "type".
+    def self.trending(options={})
+      options.merge!({
+        :key => Untappd::apikey
+      })
+
+      response_to_mash get("/trending", :query => options)
+    end
+    
   end
   
 end

data/lib/untappd/brewery.rb

@@ -0,0 +1,21 @@
+module Untappd
+  
+  class Brewery < Base
+    
+    # since (optional) - The numeric ID of the last recent check-in.
+    # offset (optional) - The offset that you like the dataset to begin with.
+    #   Each set returns 25 max records, so you can use that paginate the feed.
+    def self.feed(brewery_id, options={})
+      options.merge!({
+        :key => Untappd::apikey,
+        :brewery_id => brewery_id
+      })
+
+      response_to_mash get("/brewery_checkins", :query => options)
+    end
+    
+  end
+  
+end
+
+

data/lib/untappd/checkin.rb

@@ -0,0 +1,31 @@
+module Untappd
+  
+  class Checkin < Base
+    
+    def self.info(checkin_id, options={})
+      options.merge!({
+        :key => Untappd::apikey,
+        :id => checkin_id
+      })
+
+      response_to_mash get("/details", :query => options)
+    end
+    
+    # since (optional) - The numeric ID of the last recent check-in. This provided to you in the next_query attribute.
+    # geolat (optional) - The numeric Latitude to filter the public feed.
+    # geolng (optional) - The numeric Longitude to filter the public feed.
+    # offset (optional) - The offset that you like the dataset to begin with.
+    #    Each set returns 25 max records, so you can use that paginate the feed.
+    def self.feed(options={})
+      options.merge!({
+        :key => Untappd::apikey
+      })
+
+      response_to_mash get("/thepub", :query => options)
+    end
+    
+  end
+  
+end
+
+

data/lib/untappd/user.rb

@@ -47,6 +47,9 @@ module Untappd
       response_to_mash get("/distinct", :query => options)
     end
     
+    # since (optional) - The numeric ID of the last recent check-in.
+    # offset (optional) - The offset that you like the dataset to begin with.
+    #   Each set returns 25 max records, so you can use that paginate the feed.
     def self.feed(user, options={})
       options.merge!({
         :key => Untappd::apikey,

data/lib/untappd/venue.rb

@@ -0,0 +1,29 @@
+module Untappd
+  
+  class Venue < Base
+    
+    # since (optional) - The numeric ID of the last recent check-in.
+    # offset (optional) - The offset that you like the dataset to begin with.
+    #   Each set returns 25 max records, so you can use that paginate the feed.
+    def self.feed(venue_id, options={})
+      options.merge!({
+        :key => Untappd::apikey,
+        :venue_id => venue_id
+      })
+
+      response_to_mash get("/venue_checkins", :query => options)
+    end
+    
+    #
+    def self.info(venue_id, options={})
+      options.merge!({
+        :key => Untappd::apikey,
+        :venue_id => venue_id
+      })
+
+      response_to_mash get("/venue_info", :query => options)
+    end
+    
+  end
+  
+end

data/lib/untappd/version.rb

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

data/lib/untappd.rb

@@ -3,6 +3,9 @@ require 'rubygems'
 require "untappd/base"
 require "untappd/beer"
 require "untappd/user"
+require "untappd/venue"
+require "untappd/brewery"
+require "untappd/checkin"
 
 module Untappd
   @apikey = nil

data/spec/beer_spec.rb

@@ -14,13 +14,13 @@ describe "Beer" do
     Untappd::Beer.stub(:get => @response)
   end
   
-  it "should get checkins" do
+  it "should get feed" do
     @response[:results] << {:checkin_id => "610208",
                             :beer_id => "18099",
                             :beer_name => "Arrogant Bastard Ale",
                             :brewery_name => "Stone Brewing Co."}
 
-    checkins = Untappd::Beer.checkins(18099)    
+    checkins = Untappd::Beer.feed(18099)    
     checkins.first.beer_name.should == "Arrogant Bastard Ale"
   end
   
@@ -43,8 +43,20 @@ describe "Beer" do
     search.first.beer_name.should == "Arrogant Bastard Ale"
   end
   
+  it "gets the trending beers" do
+    @response[:results] << {:beer_id => "18099",
+                            :beer_name => "Arrogant Bastard Ale",
+                            :brewery_name => "Stone Brewing Co."}
+    
+    trending = Untappd::Beer.trending()    
+    trending.first.beer_name.should == "Arrogant Bastard Ale"
+  end
+  
 end
 
+#beer trending JSON
+# {"http_code":200,"results":[{"beer_name":"Samuel Adams Noble Pils","beer_id":"5743","brewery_id":"157","count":"66","brewery_name":"Boston Beer Company","img":"https:\/\/untappd.s3.amazonaws.com\/site\/beer_logos\/beer-saNobilePils.jpg"},{"beer_name":"Bud Light","beer_id":"3784","brewery_id":"44","count":"55","brewery_name":"Anheuser-Busch","img":"https:\/\/untappd.s3.amazonaws.com\/site\/beer_logos\/beer-budLight.jpg"},{"beer_name":"Miller Lite","beer_id":"3811","brewery_id":"863","count":"55","brewery_name":"Miller Brewing Company","img":"https:\/\/untappd.s3.amazonaws.com\/site\/beer_logos\/beer-millerLite.jpg"},
+  
 #beer checkin JSON
 #{"next_query":"http:\/\/api.untappd.com\/v3\/beer_checkins?bid=18099&since=610053","next_page":"http:\/\/api.untappd.com\/v3\/beer_checkins?bid=18099&offset=25","http_code":200,"results":[{"user":{"user_name":"micek","first_name":"Cory","last_name":"M.","user_avatar":"https:\/\/untappd.s3.amazonaws.com\/profile\/0d781dfce6d3acfdfbbe9f2692a0d0e4_thumb.jpg","location":"San Diego, CA","bio":"interactive designer\/developer\/creativist, obsessed with user experience, loose leaf teas and micro brews","is_friends":null,"url":""},"checkin_id":"618853","beer_id":"18099","brewery_id":"1204","beer_name":"Arrogant Bastard Ale","brewery_name":"Stone Brewing Co.","created_at":"Sat, 09 Apr 2011 05:27:09 +0000","check_in_comment":"","checkin_link":"http:\/\/untappd.com\/user\/micek\/checkin\/BETZs89","beer_stamp":"https:\/\/untappd.s3.amazonaws.com\/site\/beer_logos\/beer-arrogantBastardAle.jpg","venue_name":"El Take It Easy","venue_id":"272","venue_lat":"32.749","venue_lng":"-117.13"}
   

data/spec/brewery_spec.rb

@@ -0,0 +1,32 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe "Brewery" do
+  
+  before(:all) do
+    Untappd.configure do |config|
+        config.apikey = '6666666666666666666666'
+    end
+  end
+    
+  before(:each) do
+    @response = {:results =>[]}
+    @response.stub(:code => 200)
+    Untappd::Brewery.stub(:get => @response)
+  end
+  
+  it "gets the feed" do
+    @response[:results] << { :user => {:user_name => "cmar"},
+                             :checkin_id => "610233",
+                             :beer_id => "18099",
+                             :beer_name => "Arrogant Bastard Ale",
+                             :brewery_name => "Stone Brewing Co."}
+
+    feed = Untappd::Brewery.feed(18099)    
+    feed.first.beer_name.should == "Arrogant Bastard Ale"
+  end
+  
+end
+
+
+#Brewery feed JSON
+#{"next_query":"http:\/\/api.untappd.com\/v3\/brewery_checkins?brewery_id=1000&since=125187","next_page":"http:\/\/api.untappd.com\/v3\/brewery_checkins?brewery_id=1000&offset=25","http_code":200,"results":[{"user":{"user_name":"miamichael2","first_name":"Michael","last_name":"","user_avatar":"https:\/\/untappd.s3.amazonaws.com\/profile\/d05bf16dede98638c3521b157d12356d_thumb.JPG","location":"Miami","bio":"","is_friends":null,"url":null},"checkin_id":"617763","beer_id":"4948","brewery_id":"1000","beer_name":"Mamma Mia! Pizza Beer","brewery_name":"Pizza Beer","created_at":"Sat, 09 Apr 2011 03:34:32 +0000","check_in_comment":"A for effort and it really does smell and taste like pizza, but this is absolutely disgusting.  http:\/\/flic.kr\/p\/9x1eC2","checkin_link":"http:\/\/untappd.com\/user\/miamichael2\/checkin\/617763","beer_stamp":"https:\/\/untappd.s3.amazonaws.com\/site\/assets\/images\/temp\/badge-beer-default.png","venue_name":"Midtown 2","venue_id":"38754","venue_lat":"25.8094","venue_lng":"-80.1915"},

data/spec/checkin_spec.rb

@@ -0,0 +1,41 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe "Checkin" do
+  
+  before(:all) do
+    Untappd.configure do |config|
+        config.apikey = '6666666666666666666666'
+    end
+  end
+    
+  before(:each) do
+    @response = {:results =>[]}
+    @response.stub(:code => 200)
+    Untappd::Checkin.stub(:get => @response)
+  end
+  
+  it "gets info" do
+    @response[:results] = { :user => {:user_name => "cmar"},
+                             :checkin_id => "610233",
+                             :beer_id => "18099",
+                             :beer_name => "Arrogant Bastard Ale",
+                             :brewery_name => "Stone Brewing Co."}
+
+    checkin = Untappd::Checkin.info(18099)    
+    checkin.beer_name.should == "Arrogant Bastard Ale"
+  end
+  
+  it "gets thepub feed" do
+    @response[:results] << {:checkin_id => "610208",
+                            :beer_id => "18099",
+                            :beer_name => "Arrogant Bastard Ale",
+                            :brewery_name => "Stone Brewing Co."}
+
+    checkins = Untappd::Checkin.feed()    
+    checkins.first.beer_name.should == "Arrogant Bastard Ale"
+  end
+end
+
+
+#Checkin info JSON
+#{"http_code":200,"results":{"user":{"user_name":"miamichael2","first_name":"Michael","last_name":"","user_avatar":"https:\/\/untappd.s3.amazonaws.com\/profile\/d05bf16dede98638c3521b157d12356d_thumb.JPG","location":"Miami","bio":"","is_friends":null,"url":null},"beer_id":"4948","brewery_id":"1000","checkin_id":"617763","toast_count":"0","comments":[],"beer_name":"Mamma Mia! Pizza Beer","brewery_name":"Pizza Beer","created_at":"Sat, 09 Apr 2011 03:34:32 +0000","check_in_comment":"A for effort and it really does smell and taste like pizza, but this is absolutely disgusting.  http:\/\/flic.kr\/p\/9x1eC2","checkin_link":"http:\/\/untappd.com\/user\/miamichael2\/checkin\/617763","beer_stamp":"https:\/\/untappd.s3.amazonaws.com\/site\/assets\/images\/temp\/badge-beer-default.png","venue_name":"Midtown 2","venue_id":"38754","venue_lat":"25.8094","venue_lng":"-80.1915"}}

data/spec/venue_spec.rb

@@ -0,0 +1,43 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe "Venue" do
+  
+  before(:all) do
+    Untappd.configure do |config|
+        config.apikey = '6666666666666666666666'
+    end
+  end
+    
+  before(:each) do
+    @response = {:results =>[]}
+    @response.stub(:code => 200)
+    Untappd::Venue.stub(:get => @response)
+  end
+  
+  it "gets the feed" do
+    @response[:results] << { :user => {:user_name => "cmar"},
+                             :checkin_id => "610233",
+                             :beer_id => "18099",
+                             :beer_name => "Arrogant Bastard Ale",
+                             :brewery_name => "Stone Brewing Co."}
+
+    feed = Untappd::Venue.feed(18099)    
+    feed.first.beer_name.should == "Arrogant Bastard Ale"
+  end
+
+  it "gets info" do
+    @response[:results] = { :name => "Terminal 5",
+                             :foursquare_id => "4ad6bf91f964a520380821e3"
+                            }
+
+    info = Untappd::Venue.info(18099)    
+    info.name.should == "Terminal 5"
+  end
+  
+end
+
+#Venue info JSON
+# "http_code":200,"results":{"name":"Terminal 5","internal_venue_id":"29296","foursquare_id":"4ad6bf91f964a520380821e3","legacy_foursquare_id":"0","img":"https:\/\/foursquare.com\/img\/categories\/travel\/airport_terminal.png","total_count":"3","unique_count":"2","monthly_count":"2","weekly_count":"0","geolat":"51.4718","geolng":"-0.489278","primary_category":"Travel Spots","address":"LHR Airport","city":"Hounslow","state":"Middlesex","foursquare_link":"http:\/\/4sq.com\/8Nxc2S"}}
+
+#Venue feed JSON
+#{"next_query":"http:\/\/api.untappd.com\/v3\/venue_checkins?venue_id=29296&since=433447","next_page":"http:\/\/api.untappd.com\/v3\/venue_checkins?venue_id=29296&offset=25","http_code":200,"results":[{"user":{"user_name":"Netclectic","first_name":"Ade","last_name":"","user_avatar":"http:\/\/gravatar.com\/avatar.php?gravatar_id=bc1736a7204955210453d2dbd441a0f9&amp;rating=X&amp;size=80&amp;default=https:\/\/untappd.s3.amazonaws.com\/site\/assets\/images\/default_avatar.jpg","location":"Glasgow, Scotland","bio":"I like beer, it makes me a jolly good fellow...","is_friends":null,"url":"http:\/\/www.netclectic.com"},"checkin_id":"640369","beer_id":"6422","brewery_id":"302","beer_name":"Hoegaarden Original White Ale","brewery_name":"Brouwerij van Hoegaarden (InBev)","created_at":"Tue, 12 Apr 2011 11:25:39 +0000","check_in_comment":"So refreshing it would be rude not to have another one","checkin_link":"http:\/\/untappd.com\/user\/Netclectic\/checkin\/640369","beer_stamp":"https:\/\/untappd.s3.amazonaws.com\/site\/assets\/images\/temp\/badge-beer-default.png","venue_name":"Terminal 5","venue_id":"29296","venue_lat":"51.4718","venue_lng":"-0.489278"},{"user":{"user_name":"Netclectic","first_name":"Ade","last_name":"","user_avatar":"http:\/\/gravatar.com\/avatar.php?gravatar_id=bc1736a7204955210453d2dbd441a0f9&amp;rating=X&amp;size=80&amp;default=https:\/\/untappd.s3.amazonaws.com\/site\/assets\/images\/default_avatar.jpg","location":"Glasgow, Scotland","bio":"I like beer, it makes me a jolly good fellow...","is_friends":null,"url":"http:\/\/www.netclectic.com"},

data/untappd.gemspec

@@ -17,7 +17,7 @@ Gem::Specification.new do |s|
   s.add_dependency('httparty', '>= 0.7.3')
   s.add_dependency('hashie', '>= 1.0.0')
   
-  s.add_development_dependency('rspec', '>= 2.5.1')
+  s.add_development_dependency('rspec', '>= 2.5.0')
   
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: untappd
 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: 
 - cmar
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-11 00:00:00 -04:00
+date: 2011-04-12 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -58,12 +58,12 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 25
+        hash: 27
         segments: 
         - 2
         - 5
-        - 1
-        version: 2.5.1
+        - 0
+        version: 2.5.0
   type: :development
   version_requirements: *id003
 description: wrapper around the untappd.com API
@@ -86,12 +86,18 @@ files:
 - lib/untappd.rb
 - lib/untappd/base.rb
 - lib/untappd/beer.rb
+- lib/untappd/brewery.rb
+- lib/untappd/checkin.rb
 - lib/untappd/user.rb
+- lib/untappd/venue.rb
 - lib/untappd/version.rb
 - spec/beer_spec.rb
+- spec/brewery_spec.rb
+- spec/checkin_spec.rb
 - spec/spec_helper.rb
 - spec/untappd_spec.rb
 - spec/user_spec.rb
+- spec/venue_spec.rb
 - untappd.gemspec
 has_rdoc: true
 homepage: http://cmar.me
@@ -129,6 +135,9 @@ specification_version: 3
 summary: Wrapper around the untappd.com API
 test_files: 
 - spec/beer_spec.rb
+- spec/brewery_spec.rb
+- spec/checkin_spec.rb
 - spec/spec_helper.rb
 - spec/untappd_spec.rb
 - spec/user_spec.rb
+- spec/venue_spec.rb