untappd 0.0.1 → 0.0.2

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    untappd (0.0.1)
+    untappd (0.0.2)
       hashie (>= 1.0.0)
       httparty (>= 0.7.3)
 

data/README.rdoc

@@ -9,6 +9,7 @@ This is a simple wrapper around the untappd API packaged as a ruby gem.
 
 == Releases
 
+* 0.0.2 User feed, distinct beers, info, badges, friends, wish list
 * 0.0.1 Beer Search, Info and Checkins
 
 == Examples
@@ -20,7 +21,7 @@ Configure your API KEY
 
 Get all the checkins for Arrogant Bastard Ale
 
-  checkins = Untappd.beer_checkins(18099)
+  checkins = Untappd::Beer.checkins(18099)
   checkins.each do |checkin|
     puts "#{checkin.user.first_name} at #{checkin.created_at}" 
   end
@@ -37,8 +38,44 @@ Get extended info for Arrogant Bastard Ale
   info = Untappd::Beer.info(18099)
   puts "#{info.name} by #{info.brewery}"
   
+All Methods can take additional options specified in the API
+
+  checkins = Untappd::Beer.checkins(18099, :offset => 100)
+  
+  beers = Untappd::Beer.search('stone', :sort => "count")
+
 == Debugging
 You can dump any result to see what values are available with
 
   info = Untappd::Beer.info(18099)
-  puts info.inspect
+  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

data/examples/user_feed.rb

@@ -0,0 +1,12 @@
+#list the recent checkins for Arrogant Bastard Ale
+require 'rubygems'
+require 'untappd'
+
+Untappd.configure do |config|
+  config.apikey = 'YOUR_API_KEY'
+end
+
+feed = Untappd::User.feed("cmar")
+feed.each do |f|
+  puts "#{f.user.first_name} at #{f.created_at}" 
+end

data/lib/untappd.rb

@@ -2,6 +2,7 @@ require 'rubygems'
 
 require "untappd/base"
 require "untappd/beer"
+require "untappd/user"
 
 module Untappd
   @apikey = nil

data/lib/untappd/beer.rb

@@ -29,4 +29,4 @@ module Untappd
     end
   end
   
-end
+end

data/lib/untappd/user.rb

@@ -0,0 +1,60 @@
+module Untappd
+  
+  class User < Base
+    
+    def self.info(user, options={})
+      options.merge!({
+        :key => Untappd::apikey,
+        :user => user
+      })
+
+      response_to_mash get("/user", :query => options)
+    end
+    
+    def self.badges(user, options={})
+      options.merge!({
+        :key => Untappd::apikey,
+        :user => user
+      })
+
+      response_to_mash get("/user_badge", :query => options)
+    end
+    
+    def self.friends(user, options={})
+      options.merge!({
+        :key => Untappd::apikey,
+        :user => user
+      })
+
+      response_to_mash get("/friends", :query => options)
+    end
+    
+    def self.wish_list(user, options={})
+      options.merge!({
+        :key => Untappd::apikey,
+        :user => user
+      })
+
+      response_to_mash get("/wish_list", :query => options)
+    end
+    
+    def self.distinct(user, options={})
+      options.merge!({
+        :key => Untappd::apikey,
+        :user => user
+      })
+
+      response_to_mash get("/distinct", :query => options)
+    end
+    
+    def self.feed(user, options={})
+      options.merge!({
+        :key => Untappd::apikey,
+        :user => user
+      })
+
+      response_to_mash get("/user_feed", :query => options)
+    end
+  end
+  
+end

data/lib/untappd/version.rb

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

data/spec/beer_spec.rb

@@ -0,0 +1,55 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe "Beer" do
+  
+  before(:all) do
+    Untappd.configure do |config|
+        config.apikey = '6666666666666666666666'
+    end
+  end
+    
+  before(:each) do
+    @response = {:results =>[]}
+    @response.stub(:code => 200)
+    Untappd::Beer.stub(:get => @response)
+  end
+  
+  it "should get checkins" 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.first.beer_name.should == "Arrogant Bastard Ale"
+  end
+  
+  it "should get info" do
+    @response[:results] = {:brewery_id => "1204",
+                            :beer_id => "18099",
+                            :name => "Arrogant Bastard Ale",
+                            :brewery => "Stone Brewing Co."}
+
+    info = Untappd::Beer.info(18099)    
+    info.name.should == "Arrogant Bastard Ale"
+  end
+  
+  it "should search" do
+    @response[:results] << {:beer_id => "18099",
+                            :beer_name => "Arrogant Bastard Ale",
+                            :brewery_name => "Stone Brewing Co."}
+    
+    search = Untappd::Beer.info('stone')    
+    search.first.beer_name.should == "Arrogant Bastard Ale"
+  end
+  
+end
+
+#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"}
+  
+#beer info JSON
+# {"http_code":200,"results":{"name":"Arrogant Bastard Ale","beer_id":"18099","brewery":"Stone Brewing Co.","brewery_id":"1204","img":"https:\/\/untappd.s3.amazonaws.com\/site\/beer_logos\/beer-arrogantBastardAle.jpg","total_count":"1553","unique_count":"1041","monthly_count":"193","weekly_count":"161","beer_abv":"7.2","beer_created":"Mon, 27 Dec 2010 20:34:38 +0000","type":"American Strong Ale","beer_creator":"Firmansyah","beer_creator_id":"9041"}}
+
+#beer search JSON
+#{"search_term":"stone","http_code":200,"returned_results":25,"next_page":"http:\/\/api.untappd.com\/v3\/beer_search?q=stone&offset=25","results":[{"beer_id":"29100","beer_name":" Arrogant Bastard Ale Aged In Bourbon Barrels","beer_stamp":"https:\/\/untappd.s3.amazonaws.com\/site\/assets\/images\/temp\/badge-beer-default.png","brewery_id":"1204","brewery_name":"Stone Brewing Co.","brewery_stamp":"https:\/\/untappd.s3.amazonaws.com\/site\/assets\/images\/temp\/badge-brewery-default.png","country_name":"United States","total_count":"11"}

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+$TESTING=true
+$:.push File.join(File.dirname(__FILE__), '..', 'lib')
+
+require 'untappd'

data/spec/untappd_spec.rb

@@ -0,0 +1,13 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe "Untappd" do
+  
+  it "should configure Rails initializer style" do
+    Untappd.configure do |config|
+       config.apikey = 'c01822f029486661bb3669a845b5ec14'
+    end
+    
+    Untappd.apikey.should eq 'c01822f029486661bb3669a845b5ec14'
+  end
+  
+end

data/spec/user_spec.rb

@@ -0,0 +1,100 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe "User" do
+  
+  before(:all) do
+    Untappd.configure do |config|
+        config.apikey = '6666666666666666666666'
+    end
+  end
+    
+  before(:each) do
+    @response = {:results =>[]}
+    @response.stub(:code => 200)
+    Untappd::User.stub(:get => @response)
+  end
+  
+  it "should get info" do
+    @response[:results] = {:user => {
+                              :user_name => "cmar",
+                              :first_name => "cmar"
+                              }
+                           }
+
+    info = Untappd::User.info("cmar")    
+    info.user.user_name.should == "cmar"
+  end
+  
+  it "should get badges" do
+    @response[:results] << {
+                              :badge_name => "Newbie",
+                              :checkin_id => "413105"
+                            }
+
+    badges = Untappd::User.badges("cmar")    
+    badges.first.badge_name.should == "Newbie"
+  end
+  
+  it "should get friends" do
+    @response[:results] << {
+                              :user_name => "pks1850",
+                              :user_id => "10819"
+                            }
+
+    friends = Untappd::User.friends("cmar")    
+    friends.first.user_name.should == "pks1850"
+  end
+  
+  it "should get the wish list" do
+     @response[:results] << {
+                                :user => {:user_name => "cmar"},
+                                :beer_name => "Aprihop",
+                                :beer_id => "4665"
+                            }
+
+    wish_list = Untappd::User.wish_list("cmar")    
+    wish_list.first.beer_name.should == "Aprihop"
+  end
+  
+  it "should get distinct beers" do
+     @response[:results] << {
+                                :user => {:user_name => "cmar"},
+                                :beer_name => "Aprihop",
+                                :beer_id => "4665"
+                            }
+
+    distinct_beers = Untappd::User.distinct("cmar")    
+    distinct_beers.first.beer_name.should == "Aprihop"
+  end
+  
+  it "should get feed" do
+     @response[:results] << {
+                                :user => {:user_name => "cmar"},
+                                :beer_name => "Aprihop",
+                                :checkin_id => "551239"
+                            }
+
+    feed = Untappd::User.feed("cmar")    
+    feed.first.beer_name.should == "Aprihop"
+  end
+  
+end
+
+#User feed JSON
+#{"http_code":200,"returned_results":2,"next_query":"http:\/\/api.untappd.com\/v3\/user_feed?user=cmar&since=551239","next_page":"http:\/\/api.untappd.com\/v3\/user_feed?user=cmar&offset=25","results":[{"user":{"user_name":"cmar","first_name":"cmar","last_name":"","user_avatar":"http:\/\/gravatar.com\/avatar.php?gravatar_id=cf989ae1f7ddd979f38b00ec033a0e7d&amp;rating=X&amp;size=80&amp;default=https:\/\/untappd.s3.amazonaws.com\/site\/assets\/images\/default_avatar.jpg","location":"Leesburg, VA","bio":"","is_friends":null,"url":""},"checkin_id":"551239","beer_id":"4665","brewery_id":"459","beer_name":"Aprihop","brewery_name":"Dogfish Head Craft Brewery","created_at":"Wed, 30 Mar 2011 20:03:03 +0000","check_in_comment":"Love this beer. Similar to Magic Hat #9","checkin_link":"http:\/\/untappd.com\/user\/cmar\/checkin\/551239","beer_stamp":"https:\/\/untappd.s3.amazonaws.com\/site\/assets\/images\/temp\/badge-beer-default.png","venue_name":null,"venue_id":null,"venue_lat":null,"venue_lng":null},
+  
+#User distinct JSON
+#{"http_code":200,"returned_results":2,"next_page":"http:\/\/api.untappd.com\/v3\/user_distinct\/cmar?offset=25","results":[{"user":{"user_name":"cmar","first_name":"cmar","last_name":"","user_avatar":"http:\/\/gravatar.com\/avatar.php?gravatar_id=cf989ae1f7ddd979f38b00ec033a0e7d&amp;rating=X&amp;size=80&amp;default=https:\/\/untappd.s3.amazonaws.com\/site\/assets\/images\/default_avatar.jpg","location":"Leesburg, VA","bio":"","is_friends":null,"url":""},"beer_id":"4665","brewery_id":"459","checkin_id":"551239","beer_name":"Aprihop","brewery_name":"Dogfish Head Craft Brewery","created_at":"Wed, 30 Mar 2011 20:03:03 +0000","checkin_link":"http:\/\/untappd.com\/user\/cmar\/checkin\/551239","beer_stamp":"https:\/\/untappd.s3.amazonaws.com\/site\/assets\/images\/temp\/badge-beer-default.png"},
+  
+#User wishlist JSON
+#{"http_code":200,"returned_results":2,"results":[{"user":{"user_name":"cmar","first_name":"cmar","last_name":"","user_avatar":"http:\/\/gravatar.com\/avatar.php?gravatar_id=cf989ae1f7ddd979f38b00ec033a0e7d&amp;rating=X&amp;size=80&amp;default=https:\/\/untappd.s3.amazonaws.com\/site\/assets\/images\/default_avatar.jpg","location":"Leesburg, VA","bio":"","is_friends":null,"url":""},"beer_name":"Aprihop","beer_id":"4665","brewery_id":"459","brewery_name":"Dogfish Head Craft Brewery","created_at":"Wed, 30 Mar 2011 20:03:27 +0000","beer_stamp":"https:\/\/untappd.s3.amazonaws.com\/site\/assets\/images\/temp\/badge-beer-default.png"},
+  
+#User friends JSON
+#{"http_code":200,"returned_results":1,"next_page":"http:\/\/api.untappd.com\/v3\/friends\/cmar?offset=25","results":[{"user_id":"10819","user_name":"pks1850","first_name":"sam","last_name":"","user_avatar":"http:\/\/gravatar.com\/avatar.php?gravatar_id=414bd46a3e2ccdb0620d80a30c088ac2&amp;rating=X&amp;size=80&amp;default=https:\/\/untappd.s3.amazonaws.com\/site\/assets\/images\/default_avatar.jpg","location":"","bio":"","is_friends":null,"is_requested":null,"url":"http:\/\/WWW.TEST.COM","date_joined":"Thu, 23 Dec 2010 16:58:12 +0000","is_private":"0"}]}
+
+#User Badges JSON
+#{"http_code":200,"returned_results":1,"results":[{"badge_name":"Newbie","checkin_id":"413105","badge_description":"So, you're new around here? Congrats on your first brew! This ones for you.","badge_image_sm":"https:\/\/untappd.s3.amazonaws.com\/assets\/badges\/bdg_newbie_sm.png","badge_image_md":"https:\/\/untappd.s3.amazonaws.com\/assets\/badges\/bdg_newbie_md.png","badge_image_lg":"https:\/\/untappd.s3.amazonaws.com\/assets\/badges\/bdg_newbie_lg.png","badge_category":"Beer Badges","badge_earned_date":"Mon, 07 Mar 2011 01:45:07 +0000","badge_link":"http:\/\/untappd.com\/user\/cmar\/badge\/58708"}]}
+
+
+#User Info JSON
+#{"http_code":200,"results":{"user":{"user_name":"cmar","first_name":"cmar","last_name":"","user_avatar":"http:\/\/gravatar.com\/avatar.php?gravatar_id=cf989ae1f7ddd979f38b00ec033a0e7d&amp;rating=X&amp;size=80&amp;default=https:\/\/untappd.s3.amazonaws.com\/site\/assets\/images\/default_avatar.jpg","location":"Leesburg, VA","bio":"","is_friends":null,"url":"","date_joined":"Thu, 23 Dec 2010 17:22:26 +0000","is_private":"0","total_badges":"1","total_friends":"1","total_checkins":"2","total_beers":"2","total_created_beers":"0","social_accounts":{"facebook":true,"twitter":true,"foursquare":true}}}}

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')
+  s.add_development_dependency('rspec', '>= 2.5.1')
   
   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: 29
+  hash: 27
   prerelease: 
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - cmar
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-08 00:00:00 -04:00
+date: 2011-04-11 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -58,10 +58,12 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
+        hash: 25
         segments: 
-        - 0
-        version: "0"
+        - 2
+        - 5
+        - 1
+        version: 2.5.1
   type: :development
   version_requirements: *id003
 description: wrapper around the untappd.com API
@@ -80,11 +82,16 @@ files:
 - README.rdoc
 - Rakefile
 - examples/aba_checkins.rb
+- examples/user_feed.rb
 - lib/untappd.rb
 - lib/untappd/base.rb
 - lib/untappd/beer.rb
+- lib/untappd/user.rb
 - lib/untappd/version.rb
-- spec/checkins_spec.rb
+- spec/beer_spec.rb
+- spec/spec_helper.rb
+- spec/untappd_spec.rb
+- spec/user_spec.rb
 - untappd.gemspec
 has_rdoc: true
 homepage: http://cmar.me
@@ -121,4 +128,7 @@ signing_key:
 specification_version: 3
 summary: Wrapper around the untappd.com API
 test_files: 
-- spec/checkins_spec.rb
+- spec/beer_spec.rb
+- spec/spec_helper.rb
+- spec/untappd_spec.rb
+- spec/user_spec.rb

data/spec/checkins_spec.rb

@@ -1,5 +0,0 @@
-describe 'checkins' do
-  
-  pending 'write tests please!'
-  
-end