untappd 0.0.5 → 4.0.0

data/.gitignore

@@ -1,3 +1,4 @@
 pkg/*
 *.gem
 .bundle
+.rvmrc

data/Gemfile

@@ -1,4 +1,7 @@
 source "http://rubygems.org"
+gem 'rake'
+
+ruby '1.9.3'
 
 # Specify your gem's dependencies in untappd.gemspec
 gemspec

data/Gemfile.lock

@@ -1,30 +1,38 @@
 PATH
   remote: .
   specs:
-    untappd (0.0.4)
+    untappd (4.0.0)
       hashie (>= 1.0.0)
       httparty (>= 0.7.3)
 
 GEM
   remote: http://rubygems.org/
   specs:
-    crack (0.1.8)
-    diff-lcs (1.1.2)
-    hashie (1.0.0)
-    httparty (0.7.4)
-      crack (= 0.1.8)
-    rspec (2.5.0)
-      rspec-core (~> 2.5.0)
-      rspec-expectations (~> 2.5.0)
-      rspec-mocks (~> 2.5.0)
-    rspec-core (2.5.1)
-    rspec-expectations (2.5.0)
-      diff-lcs (~> 1.1.2)
-    rspec-mocks (2.5.0)
+    diff-lcs (1.1.3)
+    fakeweb (1.3.0)
+    hashie (1.2.0)
+    httparty (0.10.0)
+      multi_json (~> 1.0)
+      multi_xml
+    multi_json (1.5.0)
+    multi_xml (0.5.2)
+    rake (10.0.2)
+    rspec (2.12.0)
+      rspec-core (~> 2.12.0)
+      rspec-expectations (~> 2.12.0)
+      rspec-mocks (~> 2.12.0)
+    rspec-core (2.12.1)
+    rspec-expectations (2.12.0)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.12.0)
+    vcr (2.3.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  rspec (>= 2.5.0)
+  fakeweb (>= 1.3.0)
+  rake
+  rspec (>= 2.12.0)
   untappd!
+  vcr (>= 2.3.0)

data/README.md

@@ -0,0 +1,137 @@
+# Untappd
+
+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: https://untappd.com/api/docs/v4.
+* Required parameters are passed as arguments to the method, optional parameters should be included in the options hash.
+* Methods requiring user authentication will require an OAuth access_token. See OAuth Examples below.
+* All responses are wrapped in a Hashie::Mash
+
+## Releases
+
+* 4.0.0 supports the v4 API (https://untappd.com/api/docs/v4)
+* 0.0.5 Brewery Info and Search
+* 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
+
+## API Coverage
+
+**Beer Object**
+* 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
+
+**User Object**
+* User Feed - Untappd::User.feed(username, options={})
+* User Info - Untappd::User.info(username)
+* User Badges - Untappd::User.badges(username, options={})
+* User Friends - Untappd::User.friends(username, options={})
+* User Wish List - Untappd::User.wish_list(username, options={})
+* User Distinct Beers - Untappd::User.distinct(username, options={})
+* Friend Feed - Untappd::User.friend_feed(access_token, options={})
+
+**Venue Object**
+* Venue Feed - Untappd::Venue.feed(venue_id, options={})
+* Venue Info - Untappd::Venue.info(venue_id)
+
+**Brewery Object**
+* Brewery Checkins - Untappd::Brewery.feed(brewery_id, options={})
+* Brewery Info - Untappd::Brewery.info(brewery_id)
+* Brewery Search - Untappd::Brewery.search(q)
+
+**Checkin Object**
+* Checkin Info - Untappd::Checkin.info(checkin_id)
+* The Pub Feed - Untappd::Checkin.feed(options={})
+* Checkin - Untappd::Checkin.create(access_token, gmt_offset, timezone, beer_id, options={})
+* Add Comment - Untappd::Checkin.add_comment(access_token, checkin_id, comment)
+* Remove Comment - Untappd::Checkin.remove_comment(access_token, comment_id)
+* Toast/Remove Toast - Untappd::Checkin.toggle_toast(access_token, checkin_id)
+
+**TODO**
+* Add To Wish List - /v4/user/wishlist/add
+* Remove From Wish List - /v4/user/wishlist/delete
+* Pending Friends - /v4/user/pending
+* Accept Friends - /v4/friend/accept/TARGET_ID
+* Reject Friends - /v4/friend/reject/TARGET_ID
+* Remove Friends - /v4/friend/remove/TARGET_ID
+* Request Friends - /v4/friend/request/TARGET_ID
+* Notifications - /v4/notifications
+* Foursquare Venue Lookup - /v4/venue/foursquare_lookup/VENUE_ID
+
+## Examples
+
+### Configuration
+
+Add to your Gemfile
+
+    gem 'untappd'
+
+Configure your API KEY
+
+    Untappd.configure do |config|
+      config.client_id = 'YOUR_CLIENT_ID'
+      config.client_secret = 'YOUR_CLIENT_SECRET'
+      config.redirect_url = 'YOUR_OAUTH_REDIRECT_URL' # only if you're using OAuth
+      config.gmt_offset = -5
+    end
+
+### OAuth
+
+To generate an OAuth authentication request, simply call
+
+    Untappd::OAuth.authenticate_url
+
+This will generate a URL that the user can access in order to authorize the application.
+It will look something like this:
+
+     => "https://untappd.com/oauth/authenticate/?client_id=YOUR_CLIENT_ID&response_type=token&redirect_url=YOUR_OAUTH_REDIRECT_URL"
+
+After the user has authenticated your application, they will be redirected back to `YOUR_OAUTH_REDIRECT_URL` with their access token appended to the query string.
+
+### Examples
+
+Get all the checkins for Arrogant Bastard Ale
+
+    checkins = Untappd::Beer.feed(18099) # or Untappd::User.feed("cmar")
+    checkins.checkins.items.each do |checkin|
+      puts "#{checkin.user.first_name} at #{checkin.created_at}"
+    end
+
+Create Checkin
+
+    #foursqure, lat, lng are optional
+    Untappd::Checkin.create(ACCESS_TOKEN, 4665,
+                :foursquare_id => "4ad6bf91f964a520380821e3",
+								:timezone => 'EST',
+                :user_lat => "51.4718",
+                :user_lng => "-0.489278")
+
+Search for beers with the name Stone
+
+    beers = Untappd::Beer.search('stone')
+    beers.beers.items.each do |beer|
+       puts "#{beer.beer.beer_name}"
+    end
+
+Get extended info for Arrogant Bastard Ale
+
+    info = Untappd::Beer.info(18099)
+    puts "#{info.beer.beer_name} by #{info.beer.brewery.brewery_name}"
+
+All Methods can take additional options specified in the API
+
+    checkins = Untappd::Beer.feed(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

data/Rakefile

@@ -1,2 +1,7 @@
-require 'bundler'
-Bundler::GemHelper.install_tasks
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/examples/aba_checkins.rb

@@ -3,50 +3,14 @@ require 'rubygems'
 require 'untappd'
 
 Untappd.configure do |config|
-  config.apikey = 'YOUR_API_KEY'
+  config.client_id = 'YOUR_CLIENT_ID'
+  config.client_secret = 'YOUR_CLIENT_SECRET'
 end
 
 checkins = Untappd::Beer.feed(18099)
-checkins.each do |checkin|
-  puts "#{checkin.user.first_name} at #{checkin.created_at}" 
+checkins.checkins.items.each do |checkin|
+  puts "#{checkin.user.first_name} at #{checkin.created_at}"
 end
 
 info = Untappd::Beer.info(18099)
-puts "#{info.name} by #{info.brewery}"
-puts info.inspect
-
-# Example JSON response
-# {
-#     "next_query":"http:\/\/api.untappd.com\/v3\/beer_checkins?bid=18099&since=603321",
-#     "next_page":"http:\/\/api.untappd.com\/v3\/beer_checkins?bid=18099&offset=25",
-#     "http_code":200,
-#     "results":
-#     [
-#         {
-#             "user":
-#             {
-#                 "user_name":"JJP1115",
-#                 "first_name":"Jim",
-#                 "last_name":"P.",
-#                 "user_avatar":"http:\/\/gravatar.com\/avatar.php?gravatar_id=a0bb3b077c11e0c087e53212bf49ba49&rating=X&size=80&default=https:\/\/untappd.s3.amazonaws.com\/site\/assets\/images\/default_avatar.jpg",
-#                 "location":"Berkeley,
-#                  Illinois",
-#                 "bio":"",
-#                 "is_friends":null,
-#                 "url":"http:\/\/www.facebook.com\/#!\/JPerez1115"
-#             },
-#             "checkin_id":"610208",
-#             "beer_id":"18099",
-#             "brewery_id":"1204",
-#             "beer_name":"Arrogant Bastard Ale",
-#             "brewery_name":"Stone Brewing Co.",
-#             "created_at":"Fri,
-#              08 Apr 2011 05:24:23 +0000",
-#             "check_in_comment":"",
-#             "checkin_link":"http:\/\/untappd.com\/user\/JJP1115\/checkin\/NUekq56",
-#             "beer_stamp":"https:\/\/untappd.s3.amazonaws.com\/site\/beer_logos\/beer-arrogantBastardAle.jpg",
-#             "venue_name":null,
-#             "venue_id":null,
-#             "venue_lat":null,
-#             "venue_lng":null
-#         },
+puts "#{info.beer.beer_name} by #{info.beer.brewery.brewery_name}"

data/examples/checkin.rb

@@ -3,26 +3,25 @@ require 'rubygems'
 require 'untappd'
 
 Untappd.configure do |config|
-  config.apikey = 'YOUR_API_KEY'
-  config.gmt_offset = -5
+  config.client_id = 'YOUR_CLIENT_ID'
+  config.client_secret = 'YOUR_CLIENT_SECRET'
 end
 
-username = "cmar"
-password = "password"
+access_token = 'YOUR_ACCESS_TOKEN'
 
-checkin = Untappd::Checkin.create(username, password, 4665,
-              :foursquare_id => "4ad6bf91f964a520380821e3",
-              :user_lat => "51.4718",
-              :user_lng => "-0.489278")
+Untappd::Checkin.create(access_token, -6, 'CST', 4665
+            :foursquare_id => "4ad6bf91f964a520380821e3",
+            :user_lat => "51.4718",
+            :user_lng => "-0.489278")
 
 puts checkin.inspect
 
 
-feed = Untappd::User.friend_feed(username, password)
+feed = Untappd::User.friend_feed(access_token)
 puts feed.inspect
 
-comment = Untappd::Checkin.add_comment(username, password, 414882, "this is a test")
+comment = Untappd::Checkin.add_comment(access_token, 414882, "this is a test")
 puts comment.inspect
 
-result = Untappd::Checkin.toast(username, password, 414882)
+result = Untappd::Checkin.toggle_toast(access_token, 414882)
 puts result.inspect

data/examples/user_feed.rb

@@ -1,12 +1,13 @@
-#list the recent checkins for Arrogant Bastard Ale
+#list the recent checkins for username "cmar"
 require 'rubygems'
 require 'untappd'
 
 Untappd.configure do |config|
-  config.apikey = 'YOUR_API_KEY'
+  config.client_id = 'YOUR_CLIENT_ID'
+  config.client_secret = 'YOUR_CLIENT_SECRET'
 end
 
 feed = Untappd::User.feed("cmar")
-feed.each do |f|
-  puts "#{f.user.first_name} at #{f.created_at}" 
+feed.checkins.items.each do |f|
+  puts "#{f.beer.beer_name} from #{f.brewery.brewery_name} by #{f.user.first_name} at #{f.created_at}"
 end

data/lib/untappd.rb

@@ -1,6 +1,10 @@
 require 'rubygems'
 
+require 'time'
+
+require "untappd/config"
 require "untappd/base"
+require "untappd/oauth"
 require "untappd/beer"
 require "untappd/user"
 require "untappd/venue"
@@ -8,27 +12,4 @@ require "untappd/brewery"
 require "untappd/checkin"
 
 module Untappd
-  @@apikey = nil
-  @@gmt_offset = 0
-  
-  def self.apikey
-    @@apikey
-  end
-
-  def self.apikey=(apikey)
-    @@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
-    
 end

data/lib/untappd/base.rb

@@ -3,24 +3,26 @@ require 'hashie'
 require 'digest/md5'
 
 module Untappd
-  
+
   class Base
     include HTTParty
-    base_uri 'http://api.untappd.com/v3'
+    base_uri Untappd.config.base_uri
     format :json
-    
+
     def self.response_to_mash(response)
       if response.code == 200
-        Hashie::Mash.new(response).results
+        Hashie::Mash.new(response).response
       else
         Hashie::Mash.new {}
       end
     end
-  
-    def self.auth_hash(username, password)
-      {:username => username, 
-       :password => Digest::MD5.hexdigest(password)}
+
+    def self.auth_options
+      {
+        :client_id => Untappd.config.client_id,
+        :client_secret => Untappd.config.client_secret
+      }
     end
   end
-  
+
 end

data/lib/untappd/beer.rb

@@ -1,56 +1,32 @@
 module Untappd
-  
   class Beer < Base
-    
-    # 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.
+    # options:
+    # * min_id (int, optional) - The numeric ID of the most recent check-in. This is provided to
+    # you in the next_query attribute.
+    # * max_id (int, optional) - The checkin ID that you want the results to start with
+    # * limit (int, optional) - The number of results to return, maximum of 50, default is 25
     def self.feed(beer_id, options={})
-      options.merge!({
-        :key => Untappd::apikey,
-        :bid => beer_id
-      })
-
-      response_to_mash get("/beer_checkins", :query => options)
+      options.merge!(auth_options)
+      response = response_to_mash get("/beer/checkins/#{beer_id}", :query => options)
     end
-    
-    #
-    def self.info(beer_id, options={})
-      options.merge!({
-        :key => Untappd::apikey,
-        :bid => beer_id
-      })
 
-      response_to_mash get("/beer_info", :query => options)
+    def self.info(beer_id, options={})
+      options.merge!(auth_options)
+      response_to_mash get("/beer/info/#{beer_id}", :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,
-        :q => q
-      })
 
-      response_to_mash get("/beer_search", :query => options)
+    # options:
+    # * 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!(auth_options)
+      options.merge!({ :q => q })
+      response_to_mash get("/search/beer/", :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)
+    def self.trending
+      response_to_mash get("/beer/trending", :query => auth_options)
     end
-    
   end
-  
 end