untappd-api 0.0.1

data/.gitignore

@@ -0,0 +1,6 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+.rvmrc
+*.swp

data/Gemfile

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

data/README.rdoc

@@ -0,0 +1,16 @@
+= untappd-api
+A simple Ruby wrapper for accessing the Untappd API.
+
+For more information, see http://untappd.com/api/dashboard.
+
+== Usage
+Each method returns a Hashie::Mash (an extended Hash that gives object-like access, see https://github.com/intridea/hashie) or an Array of Hashie::Mash.
+
+=== Example:
+  require 'untappd-api'
+
+  client = Untappd::Base.new("gambrinus", PASSWORD, API_KEY)
+  client.user.first_name  #=> "Jeff"
+  beer = client.beer_info(:bid => 17904) 
+  beer.name #=> "Third Coast Old Ale"
+  beer.brewery #=> "Bell's Brewery, Inc."

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/lib/untappd-api.rb

@@ -0,0 +1,146 @@
+require 'httparty'
+require 'hashie'
+require 'digest/md5'
+
+Hash.send :include, Hashie::HashExtensions
+
+module Untappd
+  class Base
+    include HTTParty
+    BASE_URI = 'http://api.untappd.com/v2'
+    base_uri BASE_URI
+
+    def initialize(user, pass, key)
+      @auth = { :username => user, :password => Digest::MD5.hexdigest(pass) }
+      @key = key
+    end
+
+    # Get extended information about a beer.
+    # Params:
+    #   :bid => The numeric beer ID of the beer you wish to look up.
+    def beer_info(params={})
+      get('beer_info', params)
+    end
+
+    # Get a list of matching beers.
+    # Params:
+    #   :q => Name of the beer you wish to search for.
+    def beer_search(params={})
+      get('beer_search', params)
+    end
+
+    # Get extended details for a particular checkin, 
+    # which includes location, comments and toasts.
+    # Params:
+    #   :id => The numeric ID of the check-in.
+    def checkin_details(params={})
+      get('details', params)
+    end
+
+    # Get the friend check-in feed of the authenticated user.
+    # Params:
+    #   :since => The numeric ID of the last recent check-in. (Optional)
+    #   :offset => The offset that you like the dataset to begin with. (Optional)
+    def friend_feed(params={})
+      get('feed', params)
+    end
+
+    # Get the public feed for Untappd.
+    # Params:
+    #   :latitude =>  The numeric Latitude to filter the public feed. (Optional)
+    #   :longitude =>  The numeric Longitude to filter the public feed. (Optional)
+    #   :since => The numeric ID of the last recent check-in. (Optional)
+    #   :offset => The offset that you like the dataset to begin with. (Optional)
+    def public_feed(params={})
+      get('thepub', params)
+    end
+
+    # Get the user information for a selected user.
+    # Params:
+    #   :user => The username of the person who you wish to obtain the user information. (Optional)
+    def user(params={})
+      result = get('user', params)
+      result.user unless result.nil?
+    end
+
+    # Get a list of the user's badges.
+    # Params: 
+    #   :user => The username of the person who you wish to obtain the user information. (Optional)
+    #   :sort => Filters the badge list by type: "beer", "venue", or "special". (Optional)
+    def user_badges(params={})
+      get('user_badge', params)
+    end
+
+    # Get the user's distinct beers.
+    # Params:
+    #   :user => The username that you wish to call the request upon. (Optional)
+    #   :offset => The offset that you like the dataset to begin with. (Optional)
+    def user_distinct_beers(params={})
+      get('user_distinct', params)
+    end
+
+    # Get the friend check-in feed of the selected user. 
+    # Params:
+    #   :user => The username that you wish to call the request upon. (Optional)
+    #   :since => The numeric ID of the last recent check-in. (Optional)
+    #   :offset => The offset that you like the dataset to begin with. (Optional)
+    def user_feed(params={})
+      get('user_feed', params)
+    end
+
+    # Get a list of the user's friends.
+    # Params:
+    #   :user => The username that you wish to call the request upon. (Optional)
+    #   :offset => The offset that you like the dataset to begin with. (Optional)
+    def user_friends(params={})
+      get('friends', params)
+    end
+
+    # Get the user's wish listed beers.
+    # Params:
+    #   :user => The username that you wish to call the request upon. (Optional)
+    #   :offset => The offset that you like the dataset to begin with. (Optional)
+    def user_wish_list(params={})
+      get('wish_list', params)
+    end
+
+    private
+
+    def get(method, params={})
+      path = "/#{method}?key=#{@key}"
+      params.each { |k,v| path += "&#{k.to_s}=#{v.to_s}" }
+
+      options = {:basic_auth => @auth}
+      response = self.class.get(URI.escape(path), options)
+      raise_errors(response)
+
+      response.parsed_response.to_mash.results 
+    end
+
+    def raise_errors(response)
+      message = "#{response.body} - #{BASE_URI}#{response.request.path}"
+
+      case response.code
+        when 400
+          raise BadRequest, message
+        when 401
+          raise Unauthorized, message
+        when 403
+          raise General, message
+        when 404
+          raise NotFound, message
+        when 500
+          raise InternalError, message
+        when 501..503
+          raise Unavailable, message
+      end
+    end
+  end
+
+  class BadRequest    < StandardError; end
+  class Unauthorized  < StandardError; end
+  class General       < StandardError; end
+  class Unavailable   < StandardError; end
+  class InternalError < StandardError; end
+  class NotFound      < StandardError; end
+end

data/lib/untappd-api/version.rb

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

data/spec/untappd-api_spec.rb

@@ -0,0 +1,103 @@
+require 'untappd-api'
+
+describe Untappd::Base do
+  before do
+    @user = "YOUR_USERNAME"
+    pass = "YOUR_PASSWORD"
+    key = "YOUR_KEY" 
+    @client = Untappd::Base.new(@user, pass, key)
+  end
+
+  describe "beer_info method" do
+    it "should find the correct beer" do
+      beer_name = "Hocus Pocus"
+      @client.beer_info(:bid => 1).name.should == beer_name
+    end
+
+    it "should raise Unauthorized exception with bad parameters" do
+      expect {
+        @client.beer_info
+      }.to raise_exception(Untappd::Unauthorized, /You must provide a beer id to continue/)
+    end
+  end
+
+  describe "beer_search method" do
+    it "should return an Array of search results" do
+      @client.beer_search(:q => "Devil").size.should >= 0
+    end
+
+    it "should raise Unavailable exception with bad parameters" do
+      expect {
+        @client.beer_search
+      }.to raise_exception(Untappd::Unavailable, /You have not passed anything to search/)
+    end
+  end
+
+  describe "checkin_details method" do
+    it "should return the checkin details for given checkin id" do
+      pending("Checkin id is currently not exposed.")
+    end
+
+    it "should raise Unauthorized exception with bad parameters" do
+      expect {
+        @client.checkin_details
+      }.to raise_exception(Untappd::Unauthorized, /You must provide a check-in ID to continue/)
+    end
+  end
+
+  describe "friend_feed method" do
+    it "should return the authenticated user's friend feed" do
+      @client.friend_feed.size.should >= 0
+    end
+  end
+
+  describe "public_feed method" do
+    it "should return the public feed" do
+      @client.public_feed.size.should >= 0
+    end
+  end
+
+  describe "user method" do
+    it "should return the authenticated user if no user specified" do
+      @client.user.user_name.should == @user
+    end
+
+    it "should return the specified user if user parameter is set" do
+      @client.user(:user => "gambrinus").user_name.should == "gambrinus"
+    end
+
+    it "should return nil if the specified user is not found" do
+      @client.user(:user => ".....").should be_nil
+    end
+  end
+
+  describe "user_badges method" do
+    it "should return the authenticated user's badges" do
+      @client.user_badges.size.should >= 0
+    end
+  end
+
+  describe "user_distinct_beers method" do
+    it "should return the authenticated user's distinct beers" do
+      @client.user_distinct_beers.size.should >= 0
+    end
+  end
+
+  describe "user_feed method" do
+    it "should return the authenticated user's feed" do
+      @client.user_feed.size.should >= 0
+    end
+  end
+
+  describe "user_friends method" do
+    it "should return the authenticated user's friends" do
+      @client.user_friends.size.should >= 0
+    end
+  end
+
+  describe "user_wish_list method" do
+    it "should return the authenticated user's wish list" do
+      @client.user_wish_list.size.should >= 0
+    end
+  end
+end

data/untappd-api.gemspec

@@ -0,0 +1,39 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "untappd-api/version"
+
+Gem::Specification.new do |s|
+  s.name        = "untappd-api"
+  s.version     = Untappd::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Jeff Smith"]
+  s.email       = ["jffreyjs@gmail.com"]
+  s.homepage    = ""
+  s.summary     = %q{Ruby wrapper for the untappd API.}
+  s.description = %q{Ruby wrapper for the untappd API.}
+
+  s.rubyforge_project = "untappd-api"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency %q<rspec>, ['~> 2.0.0.beta.22']
+      s.add_dependency %q<httparty>, ['~> 0.7.4']
+      s.add_dependency %q<hashie>, ['~> 1.0.0']
+    else
+      s.add_dependency %q<rspec>, ['~> 2.0.0.beta.22']
+      s.add_dependency %q<httparty>, ['~> 0.7.4']
+      s.add_dependency %q<hashie>, ['~> 1.0.0']     
+    end
+  else
+    s.add_dependency %q<rspec>, ['~> 2.0.0.beta.22']
+    s.add_dependency %q<httparty>, ['~> 0.7.4']
+    s.add_dependency %q<hashie>, ['~> 1.0.0']     
+  end
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification 
+name: untappd-api
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Jeff Smith
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-02-20 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 0
+        - 0
+        - beta
+        - 22
+        version: 2.0.0.beta.22
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: httparty
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 7
+        - 4
+        version: 0.7.4
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: hashie
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :runtime
+  version_requirements: *id003
+description: Ruby wrapper for the untappd API.
+email: 
+- jffreyjs@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- README.rdoc
+- Rakefile
+- lib/untappd-api.rb
+- lib/untappd-api/version.rb
+- spec/untappd-api_spec.rb
+- untappd-api.gemspec
+has_rdoc: true
+homepage: ""
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: untappd-api
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Ruby wrapper for the untappd API.
+test_files: []
+