untappd-api 0.0.2 → 0.1.0

data/spec/untappd/client/venue_spec.rb

@@ -0,0 +1,56 @@
+require 'spec_helper'
+
+describe Untappd::Client do
+  before do
+    @query = { :key => "AK" }
+    @venue_id = "14411"
+    @client = Untappd::Client.new(:application_key => "AK")
+  end
+
+  describe ".venue_feed" do
+    
+    before do
+      @query.merge!({ :venue_id => @venue_id })
+      stub_get("/venue_checkins").
+        with(:query => @query).
+        to_return(:body => fixture("venue_feed.json"),
+                  :headers => { :content_type => "application/json; charset=utf8" } )
+    end
+
+    it "should get the correct resource" do
+      @client.venue_feed(@venue_id)
+      a_get("/venue_checkins").
+        with(:query => @query).
+        should have_been_made
+    end
+
+    it "should return up to 25 of the most recent checkins for this venue" do
+      checkins = @client.venue_feed(@venue_id)
+      checkins.should be_an Array
+      checkins.first.venue_id.should == @venue_id
+    end
+  end
+
+  describe ".venue" do
+    
+    before do
+      @query.merge!({ :venue_id => @venue_id })
+      stub_get("/venue_info").
+        with(:query => @query).
+        to_return(:body => fixture("venue.json"),
+                  :headers => { :content_type => "application/json; charset=utf8" } )
+    end
+
+    it "should get the correct resource" do
+      @client.venue(@venue_id)
+      a_get("/venue_info").
+        with(:query => @query).
+        should have_been_made
+    end
+
+    it "should return the requested venue info" do
+      venue = @client.venue(@venue_id)
+      venue.internal_venue_id.should == @venue_id
+    end
+  end
+end

data/spec/untappd_spec.rb

@@ -0,0 +1,80 @@
+require 'spec_helper'
+
+describe Untappd do
+  
+  before do
+    @key = "APP_KEY"
+    Untappd.configure do |config|
+      config.application_key = @key
+    end
+  end
+  
+  after do
+    Untappd.reset
+  end
+
+  context "when delegating to a client" do
+    before do       
+      stub_get("/user_feed").
+        with(:query => { :key => @key, :user => "gambrinus" }).
+        to_return(:body => fixture("user_feed.json"),
+                  :headers => { :content_type => "application/json; charset=utf-8" })
+    end
+
+    it "should get the correct resource" do
+      Untappd.user_feed(:user => "gambrinus")
+      a_get("/user_feed").
+        with(:query => { :key => @key, :user => "gambrinus" }).
+        should have_been_made
+    end
+
+    it "should return the same results as a client" do
+      Untappd.user_feed(:user => "gambrinus").should == Untappd::Client.new.user_feed(:user => "gambrinus")
+    end
+
+    describe ".client" do
+      it "should be an Untappd::Client" do
+        Untappd.client.should be_a Untappd::Client
+      end
+    end
+
+    describe ".endpoint" do
+      it "should return the default endpoint" do
+        Untappd.endpoint.should == Untappd::Configuration::DEFAULT_ENDPOINT
+      end
+    end
+
+    describe ".endpoint=" do
+      it "should set the endpoint" do
+        Untappd.endpoint = "http://github.com/"
+        Untappd.endpoint.should == "http://github.com/"
+      end
+    end
+
+    describe ".user_agent" do
+      it "should return the default user agent" do
+        Untappd.user_agent.should == Untappd::Configuration::DEFAULT_USER_AGENT
+      end
+    end
+
+    describe ".user_agent=" do
+      it "should set the user agent" do
+        Untappd.user_agent = "Custom User Agent"
+        Untappd.user_agent.should == "Custom User Agent"
+      end
+    end
+
+    describe ".configure" do
+      
+      Untappd::Configuration::VALID_OPTIONS_KEYS.each do |key|
+        
+        it "should set the #{key}" do
+          Untappd.configure do |config|
+            config.send("#{key}=", key.to_s)
+            Untappd.send(key).should == key.to_s
+          end
+        end
+      end
+    end
+  end
+end

data/untappd-api.gemspec

@@ -1,6 +1,6 @@
 # -*- encoding: utf-8 -*-
 $:.push File.expand_path("../lib", __FILE__)
-require "untappd-api/version"
+require "untappd/version"
 
 Gem::Specification.new do |s|
   s.name        = "untappd-api"
@@ -23,14 +23,20 @@ Gem::Specification.new do |s|
     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_development_dependency %q<rspec>, ['~> 2.9.0']
+      s.add_development_dependency %q<webmock>, ['~> 1.6.2']
       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<webmock>, ['~> 1.6.2']
       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<webmock>, ['~> 1.6.2']
     s.add_dependency %q<httparty>, ['~> 0.7.4']
+    s.add_dependency %q<hashie>, ['~> 1.0.0']
   end
 end

metadata

@@ -1,104 +1,168 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: untappd-api
-version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 0
-  - 2
-  version: 0.0.2
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - Jeff Smith
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-02-28 00:00:00 -05:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2012-03-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: rspec
+  requirement: &2152171100 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.9.0
+  type: :development
   prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  version_requirements: *2152171100
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: &2152170340 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 2
-        - 0
-        - 0
-        - beta
-        - 22
-        version: 2.0.0.beta.22
+      - !ruby/object:Gem::Version
+        version: 1.6.2
   type: :development
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: httparty
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *2152170340
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: &2152169740 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        - 7
-        - 4
+      - !ruby/object:Gem::Version
         version: 0.7.4
   type: :runtime
-  version_requirements: *id002
+  prerelease: false
+  version_requirements: *2152169740
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: &2152169060 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *2152169060
 description: Ruby wrapper for the untappd API.
-email: 
+email:
 - jffreyjs@gmail.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - Gemfile
 - MIT-LICENSE
 - README.rdoc
 - Rakefile
-- lib/untappd-api.rb
-- lib/untappd-api/version.rb
-- spec/untappd-api_spec.rb
+- lib/untappd.rb
+- lib/untappd/api.rb
+- lib/untappd/client.rb
+- lib/untappd/client/beer.rb
+- lib/untappd/client/brewery.rb
+- lib/untappd/client/checkin.rb
+- lib/untappd/client/user.rb
+- lib/untappd/client/venue.rb
+- lib/untappd/configuration.rb
+- lib/untappd/error.rb
+- lib/untappd/version.rb
+- spec/fixtures/add_comment.json
+- spec/fixtures/badges.json
+- spec/fixtures/beer.json
+- spec/fixtures/beer_feed.json
+- spec/fixtures/beer_search.json
+- spec/fixtures/brewery.json
+- spec/fixtures/brewery_feed.json
+- spec/fixtures/brewery_search.json
+- spec/fixtures/checkin.json
+- spec/fixtures/checkin_details.json
+- spec/fixtures/delete_comment.json
+- spec/fixtures/distinct_beers.json
+- spec/fixtures/friend_feed.json
+- spec/fixtures/friends.json
+- spec/fixtures/public_feed.json
+- spec/fixtures/toast.json
+- spec/fixtures/trending_beers.json
+- spec/fixtures/untoast.json
+- spec/fixtures/user.json
+- spec/fixtures/user_feed.json
+- spec/fixtures/venue.json
+- spec/fixtures/venue_feed.json
+- spec/fixtures/wish_list.json
+- spec/spec_helper.rb
+- spec/untappd/api_spec.rb
+- spec/untappd/client/beer_spec.rb
+- spec/untappd/client/brewery_spec.rb
+- spec/untappd/client/checkin_spec.rb
+- spec/untappd/client/user_spec.rb
+- spec/untappd/client/venue_spec.rb
+- spec/untappd_spec.rb
 - untappd-api.gemspec
-has_rdoc: true
-homepage: ""
+homepage: ''
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+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 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: untappd-api
-rubygems_version: 1.3.7
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Ruby wrapper for the untappd API.
-test_files: []
-
+test_files:
+- spec/fixtures/add_comment.json
+- spec/fixtures/badges.json
+- spec/fixtures/beer.json
+- spec/fixtures/beer_feed.json
+- spec/fixtures/beer_search.json
+- spec/fixtures/brewery.json
+- spec/fixtures/brewery_feed.json
+- spec/fixtures/brewery_search.json
+- spec/fixtures/checkin.json
+- spec/fixtures/checkin_details.json
+- spec/fixtures/delete_comment.json
+- spec/fixtures/distinct_beers.json
+- spec/fixtures/friend_feed.json
+- spec/fixtures/friends.json
+- spec/fixtures/public_feed.json
+- spec/fixtures/toast.json
+- spec/fixtures/trending_beers.json
+- spec/fixtures/untoast.json
+- spec/fixtures/user.json
+- spec/fixtures/user_feed.json
+- spec/fixtures/venue.json
+- spec/fixtures/venue_feed.json
+- spec/fixtures/wish_list.json
+- spec/spec_helper.rb
+- spec/untappd/api_spec.rb
+- spec/untappd/client/beer_spec.rb
+- spec/untappd/client/brewery_spec.rb
+- spec/untappd/client/checkin_spec.rb
+- spec/untappd/client/user_spec.rb
+- spec/untappd/client/venue_spec.rb
+- spec/untappd_spec.rb

data/lib/untappd-api.rb

@@ -1,192 +0,0 @@
-require 'httparty'
-require 'digest/md5'
-
-module Untappd
-  class Base
-    include HTTParty
-    BASE_URI = 'http://api.untappd.com/v3'
-    base_uri BASE_URI
-
-    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.
-    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 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_info(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 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_info(params={})
-      get('user', params)
-    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
-
-    # 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 = {}
-      options.merge({:basic_auth => @auth}) unless @auth.empty?
-
-      response = self.class.get(URI.escape(path), options)
-      raise_errors(response)
-
-      response.parsed_response
-    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