untappd-api 0.0.1 → 0.0.2

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Jeff Smith
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -4,13 +4,12 @@ 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.
+Each method returns a Hash representing the response.
 
 === 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."
+  client = Untappd::Base.new(API_KEY)
+  beer = client.beer_info(:bid => 17904)["results"]
+  beer["name"] # => "Third Coast Old Ale"
+  beer["brewery"] #=> "Bell's Brewery, Inc."

data/lib/untappd-api.rb

@@ -1,20 +1,29 @@
 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 = 'http://api.untappd.com/v3'
     base_uri BASE_URI
 
-    def initialize(user, pass, key)
-      @auth = { :username => user, :password => Digest::MD5.hexdigest(pass) }
+    def initialize(key, user = nil, pass = nil)
+      @auth = {}
+      if user && pass
+        @auth = { :username => user, :password => Digest::MD5.hexdigest(pass) }
+      end
       @key = key
     end
 
+    # Get the beer's feed
+    # Params: 
+    #   :bid => Your API Key provided when you are approved
+    #   :since => The numeric ID of the last recent check-in. (Optional)
+    #   :offset => The offset that you like the dataset to begin with. (Optional)
+    def beer_feed(params={})
+      get('beer_checkins', params)
+    end
+
     # Get extended information about a beer.
     # Params:
     #   :bid => The numeric beer ID of the beer you wish to look up.
@@ -29,11 +38,20 @@ module Untappd
       get('beer_search', params)
     end
 
+    # Get the brewery's feed
+    # Params: 
+    #   :brewery_id => Your API Key provided when you are approved
+    #   :since => The numeric ID of the last recent check-in. (Optional)
+    #   :offset => The offset that you like the dataset to begin with. (Optional)
+    def brewery_feed(params={})
+      get('brewery_checkins', 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={})
+    def checkin_info(params={})
       get('details', params)
     end
 
@@ -55,12 +73,22 @@ module Untappd
       get('thepub', params)
     end
 
+    # Get currently trending beers.
+    # Params:
+    #   :type => "all", "macro", "micro", "local".  "all" set to default. (Optional)
+    #   :limit => The number of records that will return (max 10). (Optional)
+    #   :age => "daily", "weekly", "monthly". (Optional)
+    #   :geolat =>  The numeric Latitude to filter the public feed. (Optional, required for type "local")
+    #   :geolng =>  The numeric Longitude to filter the public feed. (Optional, required for type "local")
+    def trending(params={})
+      get('trending', 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?
+    def user_info(params={})
+      get('user', params)
     end
 
     # Get a list of the user's badges.
@@ -104,17 +132,35 @@ module Untappd
       get('wish_list', params)
     end
 
+    # Get the venue's feed
+    # Params: 
+    #   :venue_id => Your API Key provided when you are approved
+    #   :since => The numeric ID of the last recent check-in. (Optional)
+    #   :offset => The offset that you like the dataset to begin with. (Optional)
+    def venue_feed(params={})
+      get('venue_checkins', params)
+    end
+
+    # Get extended information about a venue.
+    # Params:
+    #   :venue_id => The numeric beer ID of the beer you wish to look up.
+    def venue_info(params={})
+      get('venue_info', 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}
+      options = {}
+      options.merge({:basic_auth => @auth}) unless @auth.empty?
+
       response = self.class.get(URI.escape(path), options)
       raise_errors(response)
 
-      response.parsed_response.to_mash.results 
+      response.parsed_response
     end
 
     def raise_errors(response)

data/lib/untappd-api/version.rb

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

data/spec/untappd-api_spec.rb

@@ -1,103 +1,5 @@
 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
+  pending "Add some tests..."
 end

data/untappd-api.gemspec

@@ -25,15 +25,12 @@ Gem::Specification.new do |s|
     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

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - Jeff Smith
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-20 00:00:00 -05:00
+date: 2011-02-28 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -49,21 +49,6 @@ dependencies:
         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
@@ -76,6 +61,7 @@ extra_rdoc_files: []
 files: 
 - .gitignore
 - Gemfile
+- MIT-LICENSE
 - README.rdoc
 - Rakefile
 - lib/untappd-api.rb