untappd 0.0.3 → 0.0.4

data/Gemfile.lock

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

data/README.rdoc

@@ -10,6 +10,7 @@ the API documentation.
 
 == Releases
 
+* 0.0.4 Complete coverage of v3 API. Checkins, Comments, Toasts, gmt_offset configuration
 * 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
@@ -17,54 +18,59 @@ the API documentation.
 == API Coverage
 
 Beer Object
-* Beer Feed - Untappd::Beer.feed
-* Beer Info - Untappd::Beer.info
-* Beer Search - Untappd::Beer.search
-* Trending - Untappd::Beer.trending
+* Beer Feed - Untappd::Beer.feed(beer_id, options={})
+* Beer Info - Untappd::Beer.info(beer_id, options={})
+* Beer Search - Untappd::Beer.search(q, options={})
+* Trending - Untappd::Beer.trending(options={})
 
 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
+* User Feed - Untappd::User.feed(user, options={})
+* User Info - Untappd::User.info(user, options={})
+* User Badges - Untappd::User.badges(user, options={})
+* User Friends - Untappd::User.friends(user, options={})
+* User Wish List - Untappd::User.wish_list(user, options={})
+* User Distinct Beers - Untappd::User.distinct(user, options={})
+* Friend Feed - Untappd::User.friend_feed(username, password, options={})
 
 Venue Object
-* Venue Feed - Untappd::Venue.feed
-* Venue Info - Untappd::Venue.info
+* Venue Feed - Untappd::Venue.feed(venue_id, options={})
+* Venue Info - Untappd::Venue.info(venue_id, options={})
 
 Brewery Object
-* Brewery Checkins - Untappd::Brewery.feed
+* Brewery Checkins - Untappd::Brewery.feed(brewery_id, options={})
 
 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
+* The Pub Feed - Untappd::Checkin.feed(options={})
+* Checkin Info - Untappd::Checkin.info(checkin_id, options={})
+* Checkin (Test) - Untappd::Checkin.test(username, password, beer_id, options={})
+* Checkin - Untappd::Checkin.create(username, password, beer_id, options={})
+* Add Comment - Untappd::Checkin.add_comment(username, password, checkin_id, comment, options={})
+* Remove Comment - Untappd::Checkin.remove_comment(username, password, comment_id, options={})
+* Toast - Untappd::Checkin.toast(username, password, checkin_id)
+* Remove Toast - Untappd::Checkin.untoast(username, password, checkin_id)
 
 == Examples
 Configure your API KEY
 
   Untappd.configure do |config|
     config.apikey = 'YOUR_API_KEY'
+    config.gmt_offset = -5
   end
 
 Get all the checkins for Arrogant Bastard Ale
 
-  checkins = Untappd::Beer.checkins(18099)
+  checkins = Untappd::Beer.feed(18099) # or Untappd::User.feed("cmar")
   checkins.each do |checkin|
     puts "#{checkin.user.first_name} at #{checkin.created_at}" 
   end
 
+Create Checkin
+  #foursqure, lat, lng are optional
+  Untappd::Checkin.create("cmar", "PASSWORD", 4665,
+              :foursquare_id => "4ad6bf91f964a520380821e3",
+              :user_lat => "51.4718",
+              :user_lng => "-0.489278")
+              
 Search for beers with the name Stone
 
   beers = Untappd::Beer.search('stone')

data/examples/aba_checkins.rb

@@ -6,7 +6,7 @@ Untappd.configure do |config|
   config.apikey = 'YOUR_API_KEY'
 end
 
-checkins = Untappd::Beer.checkins(18099)
+checkins = Untappd::Beer.feed(18099)
 checkins.each do |checkin|
   puts "#{checkin.user.first_name} at #{checkin.created_at}" 
 end

data/examples/checkin.rb

@@ -0,0 +1,28 @@
+#a couple of checkin methods
+require 'rubygems'
+require 'untappd'
+
+Untappd.configure do |config|
+  config.apikey = 'YOUR_API_KEY'
+  config.gmt_offset = -5
+end
+
+username = "cmar"
+password = "password"
+
+checkin = Untappd::Checkin.create(username, password, 4665,
+              :foursquare_id => "4ad6bf91f964a520380821e3",
+              :user_lat => "51.4718",
+              :user_lng => "-0.489278")
+
+puts checkin.inspect
+
+
+feed = Untappd::User.friend_feed(username, password)
+puts feed.inspect
+
+comment = Untappd::Checkin.add_comment(username, password, 414882, "this is a test")
+puts comment.inspect
+
+result = Untappd::Checkin.toast(username, password, 414882)
+puts result.inspect

data/lib/untappd.rb

@@ -8,8 +8,9 @@ require "untappd/brewery"
 require "untappd/checkin"
 
 module Untappd
-  @apikey = nil
-
+  @@apikey = nil
+  @@gmt_offset = 0
+  
   def self.apikey
     @@apikey
   end
@@ -18,6 +19,14 @@ module Untappd
     @@apikey = apikey
   end
 
+  def self.gmt_offset
+    @@gmt_offset
+  end
+
+  def self.gmt_offset=(gmt_offset)
+    @@gmt_offset = gmt_offset
+  end
+  
   def self.configure
     yield self
   end

data/lib/untappd/base.rb

@@ -1,5 +1,6 @@
 require 'httparty'
 require 'hashie'
+require 'digest/md5'
 
 module Untappd
   
@@ -15,6 +16,11 @@ module Untappd
         Hashie::Mash.new {}
       end
     end
+  
+    def self.auth_hash(username, password)
+      {:username => username, 
+       :password => Digest::MD5.hexdigest(password)}
+    end
   end
   
 end

data/lib/untappd/checkin.rb

@@ -23,7 +23,85 @@ module Untappd
 
       response_to_mash get("/thepub", :query => options)
     end
+   
+    # foursquare_id (optional) - The MD5 hash ID of the Venue you want to attach 
+    #        the beer checkin. This HAS TO BE the MD5 non-numeric hash from the foursquare v2. Older numeric id will not be accepted.
+    # user_lat (optional) - The numeric Latitude of the user. This is required if you add a location.
+    # user_lng (optional) - The numeric Longitude of the user. This is required if you add a location.
+    # shout (optional) - The text you would like to include as a comment of the checkin. Max of 140 characters.
+    # facebook (optional) - Default = "off", Pass "on" to post to facebook
+    # twitter (optional) - Default = "off", Pass "on" to post to twitter
+    # foursquare (optional) - Default = "off", Pass "on" to checkin on foursquare
+    def self.create(username, password, beer_id, options={})
+      
+      options.merge!({
+        :gmt_offset => Untappd::gmt_offset,
+        :bid => beer_id
+      })
+      
+      response = post("/checkin", :query => { :key => Untappd::apikey },
+            :body => options, :basic_auth => auth_hash(username, password))
+            
+      Hashie::Mash.new(response)
+    end
+    
+    # foursquare_id (optional) - The MD5 hash ID of the Venue you want to attach the beer checkin.
+    #       This HAS TO BE the MD5 non-numeric hash from the foursquare v2. Older numeric id will not be accepted.
+    # user_lat (optional) - The numeric Latitude of the user. This is required if you add a location.
+    # user_lng (optional) - The numeric Longitude of the user. This is required if you add a location.
+    def self.test(username, password, beer_id, options={})
+      options.merge!({
+        :gmt_offset => Untappd::gmt_offset,
+        :bid => beer_id 
+      })
+      
+      response = post("/checkin_test", :query => { :key => Untappd::apikey },
+            :body => options, :basic_auth => auth_hash(username, password))
+      
+      Hashie::Mash.new(response)
+    end
+    
+    #
+    def self.add_comment(username, password, checkin_id, comment, options={})
+      options.merge!({
+        :checkin_id => checkin_id,
+        :comment => comment 
+      })
+      
+      response_to_mash post("/add_comment", :query => { :key => Untappd::apikey },
+            :body => options, :basic_auth => auth_hash(username, password))
+    end
     
+    #
+    def self.remove_comment(username, password, comment_id, options={})
+      options.merge!({
+        :comment_id => comment_id
+      })
+      
+      response_to_mash post("/delete_comment", :query => { :key => Untappd::apikey },
+            :body => options, :basic_auth => auth_hash(username, password))
+    end
+    
+    #
+    def self.toast(username, password, checkin_id, options={})
+      options.merge!({
+        :checkin_id => checkin_id
+      })
+      
+      response_to_mash post("/toast", :query => { :key => Untappd::apikey },
+            :body => options, :basic_auth => auth_hash(username, password))
+    end
+    
+    #
+    def self.untoast(username, password, checkin_id, options={})
+      options.merge!({
+        :checkin_id => checkin_id
+      })
+      
+      response_to_mash post("/delete_toast", :query => { :key => Untappd::apikey },
+            :body => options, :basic_auth => auth_hash(username, password))
+    end
+      
   end
   
 end

data/lib/untappd/user.rb

@@ -58,6 +58,19 @@ module Untappd
 
       response_to_mash get("/user_feed", :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.friend_feed(username, password, options={})
+      options.merge!({
+        :key => Untappd::apikey
+      })
+
+      response_to_mash get("/feed", :basic_auth => auth_hash(username, password),
+                            :query => options)
+    end
+    
   end
   
 end

data/lib/untappd/version.rb

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

data/spec/beer_spec.rb

@@ -14,40 +14,48 @@ describe "Beer" do
     Untappd::Beer.stub(:get => @response)
   end
   
-  it "should get feed" do
+  it "get feed" do
     @response[:results] << {:checkin_id => "610208",
                             :beer_id => "18099",
                             :beer_name => "Arrogant Bastard Ale",
                             :brewery_name => "Stone Brewing Co."}
 
+    Untappd::Beer.should_receive(:get).with("/beer_checkins", anything())
+    
     checkins = Untappd::Beer.feed(18099)    
     checkins.first.beer_name.should == "Arrogant Bastard Ale"
   end
   
-  it "should get info" do
+  it "get info" do
     @response[:results] = {:brewery_id => "1204",
                             :beer_id => "18099",
                             :name => "Arrogant Bastard Ale",
                             :brewery => "Stone Brewing Co."}
 
+    Untappd::Beer.should_receive(:get).with("/beer_info", anything())
+    
     info = Untappd::Beer.info(18099)    
     info.name.should == "Arrogant Bastard Ale"
   end
   
-  it "should search" do
+  it "get search" do
     @response[:results] << {:beer_id => "18099",
                             :beer_name => "Arrogant Bastard Ale",
                             :brewery_name => "Stone Brewing Co."}
     
-    search = Untappd::Beer.info('stone')    
+    Untappd::Beer.should_receive(:get).with("/beer_search", anything())
+    
+    search = Untappd::Beer.search('stone')    
     search.first.beer_name.should == "Arrogant Bastard Ale"
   end
   
-  it "gets the trending beers" do
+  it "get trending beers" do
     @response[:results] << {:beer_id => "18099",
                             :beer_name => "Arrogant Bastard Ale",
                             :brewery_name => "Stone Brewing Co."}
     
+    Untappd::Beer.should_receive(:get).with("/trending", anything())
+    
     trending = Untappd::Beer.trending()    
     trending.first.beer_name.should == "Arrogant Bastard Ale"
   end

data/spec/brewery_spec.rb

@@ -14,13 +14,15 @@ describe "Brewery" do
     Untappd::Brewery.stub(:get => @response)
   end
   
-  it "gets the feed" do
+  it "get feed" do
     @response[:results] << { :user => {:user_name => "cmar"},
                              :checkin_id => "610233",
                              :beer_id => "18099",
                              :beer_name => "Arrogant Bastard Ale",
                              :brewery_name => "Stone Brewing Co."}
 
+    Untappd::Brewery.should_receive(:get).with("/brewery_checkins", anything())
+    
     feed = Untappd::Brewery.feed(18099)    
     feed.first.beer_name.should == "Arrogant Bastard Ale"
   end

data/spec/checkin_spec.rb

@@ -7,33 +7,83 @@ describe "Checkin" do
         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"
+  context "post" do
+    
+    before(:each) do
+      Untappd::Checkin.stub(:post => @response)
+    end
+    
+    it "add comment" do
+      Untappd::Checkin.should_receive(:post).with("/add_comment", anything())
+      Untappd::Checkin.add_comment("cmar", "password", 666, "my fancy comment")
+    end
+    
+    it "removes comment" do
+      Untappd::Checkin.should_receive(:post).with("/delete_comment", anything())
+      Untappd::Checkin.remove_comment("cmar", "password", 666)
+    end
+    
+    it "adds toast" do
+      Untappd::Checkin.should_receive(:post).with("/toast", anything())
+      Untappd::Checkin.toast("cmar", "password", 666)
+    end
+    
+    it "removes toast" do
+      Untappd::Checkin.should_receive(:post).with("/delete_toast", anything())
+      Untappd::Checkin.untoast("cmar", "password", 666)
+    end
+    
+    it "creates checkin" do
+      Untappd::Checkin.should_receive(:post).with("/checkin", anything())
+      Untappd::Checkin.create("cmar", "password", 4665)
+    end
+    
+    it "creates test checkin" do
+      Untappd::Checkin.should_receive(:post).with("/checkin_test", anything())
+      Untappd::Checkin.test("cmar", "password", 4665)
+    end
+    
   end
   
-  it "gets thepub feed" do
-    @response[:results] << {:checkin_id => "610208",
-                            :beer_id => "18099",
-                            :beer_name => "Arrogant Bastard Ale",
-                            :brewery_name => "Stone Brewing Co."}
+  context "get" do
+    
+    before(:each) do
+      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."}
 
-    checkins = Untappd::Checkin.feed()    
-    checkins.first.beer_name.should == "Arrogant Bastard Ale"
+      Untappd::Checkin.should_receive(:get).with("/details", anything())
+      
+      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."}
+
+      Untappd::Checkin.should_receive(:get).with("/thepub", anything())
+      
+      checkins = Untappd::Checkin.feed()    
+      checkins.first.beer_name.should == "Arrogant Bastard Ale"
+    end
+    
   end
+  
 end
 
 

data/spec/user_spec.rb

@@ -14,70 +14,95 @@ describe "User" do
     Untappd::User.stub(:get => @response)
   end
   
-  it "should get info" do
+  it "get info" do
     @response[:results] = {:user => {
                               :user_name => "cmar",
                               :first_name => "cmar"
                               }
                            }
-
+    
+    Untappd::User.should_receive(:get).with("/user", anything())
+    
     info = Untappd::User.info("cmar")    
     info.user.user_name.should == "cmar"
   end
   
-  it "should get badges" do
+  it "get badges" do
     @response[:results] << {
                               :badge_name => "Newbie",
                               :checkin_id => "413105"
                             }
-
+                            
+    Untappd::User.should_receive(:get).with("/user_badge", anything())
+                            
     badges = Untappd::User.badges("cmar")    
     badges.first.badge_name.should == "Newbie"
   end
   
-  it "should get friends" do
+  it "get friends" do
     @response[:results] << {
                               :user_name => "pks1850",
                               :user_id => "10819"
                             }
 
+    Untappd::User.should_receive(:get).with("/friends", anything())
+   
     friends = Untappd::User.friends("cmar")    
     friends.first.user_name.should == "pks1850"
   end
   
-  it "should get the wish list" do
+  it "get wish list" do
      @response[:results] << {
                                 :user => {:user_name => "cmar"},
                                 :beer_name => "Aprihop",
                                 :beer_id => "4665"
                             }
 
+    Untappd::User.should_receive(:get).with("/wish_list", anything())
+   
     wish_list = Untappd::User.wish_list("cmar")    
     wish_list.first.beer_name.should == "Aprihop"
   end
   
-  it "should get distinct beers" do
+  it "get distinct beers" do
      @response[:results] << {
                                 :user => {:user_name => "cmar"},
                                 :beer_name => "Aprihop",
                                 :beer_id => "4665"
                             }
-
+                            
+    Untappd::User.should_receive(:get).with("/distinct", anything())
+                            
     distinct_beers = Untappd::User.distinct("cmar")    
     distinct_beers.first.beer_name.should == "Aprihop"
   end
   
-  it "should get feed" do
+  it "get feed" do
      @response[:results] << {
                                 :user => {:user_name => "cmar"},
                                 :beer_name => "Aprihop",
                                 :checkin_id => "551239"
                             }
 
+    Untappd::User.should_receive(:get).with("/user_feed", anything())
+    
     feed = Untappd::User.feed("cmar")    
     feed.first.beer_name.should == "Aprihop"
   end
   
+  it "get friend feed" do
+     @response[:results] << {
+                                :user => {:user_name => "cmar"},
+                                :beer_name => "Aprihop",
+                                :checkin_id => "551239"
+                            }
+
+    Untappd::User.should_receive(:get).with("/feed", anything())
+                            
+    feed = Untappd::User.friend_feed("cmar", "password")    
+    feed.first.checkin_id.should == "551239"
+  end
+  
 end
 
 #User feed JSON

data/spec/venue_spec.rb

@@ -20,7 +20,9 @@ describe "Venue" do
                              :beer_id => "18099",
                              :beer_name => "Arrogant Bastard Ale",
                              :brewery_name => "Stone Brewing Co."}
-
+    
+    Untappd::Venue.should_receive(:get).with("/venue_checkins", anything())
+    
     feed = Untappd::Venue.feed(18099)    
     feed.first.beer_name.should == "Arrogant Bastard Ale"
   end
@@ -30,6 +32,8 @@ describe "Venue" do
                              :foursquare_id => "4ad6bf91f964a520380821e3"
                             }
 
+    Untappd::Venue.should_receive(:get).with("/venue_info", anything())
+
     info = Untappd::Venue.info(18099)    
     info.name.should == "Terminal 5"
   end

data/untappd.gemspec

@@ -7,7 +7,7 @@ Gem::Specification.new do |s|
   s.version     = Untappd::VERSION
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["cmar"]
-  s.email       = ["cmar@github.com"]
+  s.email       = ["christopher.mar@gmail.com"]
   s.homepage    = "http://cmar.me"
   s.summary     = %q{Wrapper around the untappd.com API}
   s.description = %q{wrapper around the untappd.com API}

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: untappd
 version: !ruby/object:Gem::Version 
-  hash: 25
+  hash: 23
   prerelease: 
   segments: 
   - 0
   - 0
-  - 3
-  version: 0.0.3
+  - 4
+  version: 0.0.4
 platform: ruby
 authors: 
 - cmar
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-12 00:00:00 -04:00
+date: 2011-04-14 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -68,7 +68,7 @@ dependencies:
   version_requirements: *id003
 description: wrapper around the untappd.com API
 email: 
-- cmar@github.com
+- christopher.mar@gmail.com
 executables: []
 
 extensions: []
@@ -82,6 +82,7 @@ files:
 - README.rdoc
 - Rakefile
 - examples/aba_checkins.rb
+- examples/checkin.rb
 - examples/user_feed.rb
 - lib/untappd.rb
 - lib/untappd/base.rb