skittles 0.5.0 → 0.6.0

data/README.rdoc

@@ -1,6 +1,6 @@
 = Skittles
 
-Foursquare v2 REST API client library for Ruby
+A Ruby implementation of the Foursquare v2 REST API. This library implements the Foursquare v2 API and the Foursquare Venues Project (beta) endpoints.
 
 == Documentation
 

data/lib/skittles/client.rb

@@ -15,5 +15,6 @@ module Skittles
 		include Skittles::Client::Photo
 		include Skittles::Client::Setting
 		include Skittles::Client::Special
+		include Skittles::Client::List
 	end
 end

data/lib/skittles/client/list.rb

@@ -0,0 +1,67 @@
+module Skittles
+  class Client
+    # Define methods related to lists.
+    # @see https://developer.foursquare.com/docs/lists/lists.html
+    module List
+      def add_list(name, options = {})
+        post("lists/add", { :name => name }.merge(options)).list
+      end
+      
+      # Gives detail about a list.
+      #
+      # @param id [String] The id of the list to retrieve additional information for.
+      # @return [Hashie::Mash] A list object.
+      # @requires_acting_user No
+      # @see https://developer.foursquare.com/docs/lists/lists.html
+      def list(id)
+        get("lists/#{id}").list
+      end
+      
+      # Returns users following this list.
+      #
+      # @note Only valid on user-created lists.
+      # @param id [String] The id of the user created list to retrieve additional information for.
+      # @return [Hashie::Mash] A pageable list of compact user.
+      # @requires_acting_user Yes
+      # @see https://developer.foursquare.com/docs/lists/followers.html
+      def list_followers(id)
+        get("lists/#{id}/followers").followers
+      end
+      
+      # Suggests venues that may be appropriate for this list.
+      #
+      # @note Only valid on user-created lists.
+      # @param id [String] The id of the user created list to retrieve additional information for.
+      # @return [Hashie::Mash] An array of compact venues.
+      # @requires_acting_user Yes
+      # @see https://developer.foursquare.com/docs/lists/suggestvenues.html
+      def list_suggestvenues(id)
+        get("lists/#{id}/suggestvenues").suggestedVenues
+      end
+      
+      # Suggests photos that may be appropriate for this item.
+      #
+      # @note Only valid on user-created lists.
+      # @param list_id [String] The id of the user created list to retrieve additional information for.
+      # @param item_id [String] The id of the item to retrieve for a list.
+      # @return [Hashie::Mash] Returns groups user and others containing lists of photos.
+      # @requires_acting_user Yes
+      # @see https://developer.foursquare.com/docs/lists/suggestphoto.html
+      def list_suggestphoto(list_id, item_id)
+        get("lists/#{list_id}/suggestphoto", { :item_id => item_id }).photos
+      end
+      
+      # Suggests tips that may be appropriate for this item.
+      #
+      # @note Only valid on user-created lists.
+      # @param list_id [String] The id of the user created list to retrieve additional information for.
+      # @param item_id [String] The id of the item to retrieve for a list.
+      # @return [Hashie::Mash] Returns groups user and others containing lists of photos.
+      # @requires_acting_user Yes
+      # @see https://developer.foursquare.com/docs/lists/suggesttip.html 
+      def list_suggesttip(list_id, item_id)
+        get("lists/#{list_id}/suggesttip", { :item_id => item_id }).tips
+      end
+    end
+  end
+end

data/lib/skittles/client/photo.rb

@@ -25,6 +25,7 @@ module Skittles
       # @option options [String] tipId The ID of a tip owned by the user.
       # @option options [String] venueId The ID of a venue, provided only when adding a public photo of the venue in general, rather than a private checkin or tip photo using the parameters above.
       # @option options [String] broadcast Whether to broadcast this photo to twitter, facebook or both.
+      # @option options [Integer] Allows for a public photo and viewable at the venue. Valid values are 1 and 0 (default). 
       # @option options [String] ll Latitude and longitude of the user's location.
       # @option options [Decimal] llAcc Accuracy of the user's latitude and longitude, in meters.
       # @option options [Decimal] alt Altitude of the user's location, in meters.

data/lib/skittles/client/tip.rb

@@ -30,8 +30,21 @@ module Skittles
         get("tips/#{id}").tip
       end
       
+      # The lists that a tip appears on.
+      #
+      # @param id [String] The tip to get lists for.
+      # @param options [Hash] A customizable set of options.
+      # @option options [String] group Either created, edited, followed, friends or suggested.
+      # @return The lists a tip appears on.
+      # @require_acting_user Yes
+      # @see https://developer.foursquare.com/docs/tips/listed.html
+      def tip_listed(id, options = {})
+        get("tips/#{id}/listed", options).lists
+      end
+      
       # Allows the acting user to mark a tip done.
       #
+      # @deprecated
       # @param id [String] The tip you want to mark done.
       # @return [Hashie::Mash] The marked to-do.
       # @requires_acting_user Yes
@@ -42,6 +55,7 @@ module Skittles
       
       # Allows you to mark a tip to-do.
       #
+      # @deprecated
       # @param id [String] The tip you want to mark to-do.
       # @return [Hashie::Mash] The newly-added to-do.
       # @requires_acting_user Yes
@@ -67,6 +81,7 @@ module Skittles
       
       # Allows you to remove a tip from your to-do list or done list.
       #
+      # @deprecated
       # @param id [String] The tip you want to unmark.
       # @return [Hashie::Mash] The tip being acted on.
       # @requires_acting_user No

data/lib/skittles/client/user.rb

@@ -94,14 +94,27 @@ module Skittles
         get('users/leaderboard').leaderboard
       end
       
+      # A user's lists.
+      #
+      # @param id [String] Identity of the user to get lists for. Pass self to get lists of the acting user.
+      # @param options [Hash] A customizable set of options.
+      # @option options [String] group Either created, edited, followed, friends or suggested.
+      # @option options[String] ll Latitude and longitude of the user's location.
+      # @return [Hashie::Mash] A user's lists.
+      # @requies_acting_user Yes
+      # @see https://developer.foursquare.com/docs/users/lists.html
+      def user_lists(id = 'self', options = {})
+        get("users/#{id}/lists", options).lists
+      end
+      
       # Returns a user's mayorships
       #
-      # @params user [String] Identity of the user to get mayorships for. Pass self to get friends of the acting user.
+      # @params id [String] Identity of the user to get mayorships for. Pass self to get friends of the acting user.
       # @return [Hashie::Mash] A count and items of objects which currently only contain compact venue objects.
       # @requires_acting_user Yes
       # @see https://developer.foursquare.com/docs/users/mayorships.html
-      def mayorships(user = 'self')
-        get("users/#{user}/mayorships").mayorships
+      def mayorships(id = 'self')
+        get("users/#{id}/mayorships").mayorships
       end
       
       # Changes whether the acting user will receive pings (phone
@@ -118,6 +131,7 @@ module Skittles
       
       # Returns todos from a user.
       #
+      # @deprecated
       # @param id Identity of the user to get todos for. Pass self to get todos of the acting user.
       # @param sort One of recent or popular. Nearby requires geolat and geolong to be provided.
       # @param options [Hash] A customizable set of options.
@@ -166,7 +180,7 @@ module Skittles
       # @return [Hashie::Mash] Profile information for a given user.
       # @requires_acting_user Yes
       # @see http://developer.foursquare.com/docs/users/users.html
-      def user(id)
+      def user(id = 'self')
         get("users/#{id}").user
       end
       
@@ -199,6 +213,7 @@ module Skittles
       
       # Returns tips from a user.
       #
+      # @deprecated
       # @param id [String] Identity of the user to get tips from. Pass self to get tips of the acting user.
       # @option options [Hash] A customizable set of options.
       # @option options [String] sort One of recent, nearby, or popular. Nearby requires geolat and geolong to be provided.

data/lib/skittles/client/venue.rb

@@ -55,11 +55,12 @@ module Skittles
       # @option options [Decimal] llAcc Accuracy of latitude and longitude, in meters.
       # @option options [Decimal] alt Altitude of the user's location, in meters.
       # @option options [Decimal] altAcc Accuracy of the user's altitude, in meters.
-      # @option radius [Integer] Radius to search within, in meters.
-      # @option section [String] One of food, drinks, coffee, shops, or arts. Limits results to venues with categories matching these terms.
-      # @option query [String] A search term to be applies against tips, category tips, etc. at a venue.
-      # @option limit [Integer] Number of results to return, up to 50.
-      # @option basis [String] If present and set to friends or me, limits results to only places where friends have visited or user has visited, respectively.
+      # @option options radius [Integer] Radius to search within, in meters.
+      # @option options section [String] One of food, drinks, coffee, shops, or arts. Limits results to venues with categories matching these terms.
+      # @option options query [String] A search term to be applies against tips, category tips, etc. at a venue.
+      # @option options limit [Integer] Number of results to return, up to 50.
+      # @option options basis [String] If present and set to friends or me, limits results to only places where friends have visited or user has visited, respectively.
+      # @option options [String] novelty Pass new or old to limit results to places the acting user hasn't been or has been, respectively. Omitting this parameter returns a mixture.
       # @return [Hashie::Mash] Response fields keywords, warnings and groups.
       # @requires_acting_user No
       # @see https://developer.foursquare.com/docs/venues/explore.html
@@ -168,6 +169,10 @@ module Skittles
         get("venues/#{id}").venue
       end
       
+      def venue_events(id)
+        get("venues/#{id}/events").events
+      end
+      
       # Returns URLs or identifier from third parties that have been applied to this
       # venue.
       #
@@ -180,8 +185,21 @@ module Skittles
         get("venues/#{id}/links").links
       end
       
+      # The lists that a venue appears on.
+      #
+      # @param id [String] The venue to get lists for.
+      # @param options [Hash] A customizable set of options.
+      # @option options [String] group Either created, edited, followed, friends or suggested.
+      # @return [Hashie::Mash] The lists a venue appears on.
+      # @requies_acting_user Yes
+      # @see https://developer.foursquare.com/docs/venues/listed.html
+      def venue_listed(id, options = {})
+        get("venues/#{id}/listed", options).lists
+      end
+      
       # Allows a user to mark a venue to-do, with optional text.
       #
+      # @deprecated
       # @param id The venue you want to mark to-do.
       # @param options [Hash] A customizable set of options.
       # @option options [String] text The text of the tip.
@@ -207,6 +225,9 @@ module Skittles
 			# @option options [String] query A search term to be applied against titles.
 			# @option options [Integer] limit Number of results to return, up to 50.
 			# @option options [String] intent Indicates your intent in performing the search.
+			# @option options [Integer] radius Limit results to venues within this many meters of the specified location.
+			# @option options [Decimal] sw With ne, limits results to the bounding quadrangle defined by the latitude and longitude given by sw as its south-west corner, and ne as its north-east corner.
+			# @option options [Decimal] ne See sw 
 			# @option options [String] categoryId A category to limit the results to. (experimental)
 			# @option options [String] url A third-party URL which is attempted to match against a map of venues to URLs. (experimental)
 			# @option options [String] providerId Identifier for a known third party that is part of a map of venues to URLs, used in conjunction with linkedId. (experimental)
@@ -218,6 +239,10 @@ module Skittles
 			  get('venues/search', { :ll => ll }.merge(options)).venues
 			end
 			
+			def venue_suggestcompletion(ll, query, options = {})
+			  get('venues/suggestcompletion', { :ll => ll, :query => query }.merge(options)).minivenues
+			end
+			
 			# Returns tips for a venue.
       #
       # @param id [String] The venue you want tips for.

data/lib/skittles/connection.rb

@@ -5,14 +5,11 @@ module Skittles
 	module Connection
 		private
 		  def connection
-		  	options = {
-		  		:site => endpoint
-		  	}
-		  	puts
-		  	client = OAuth2::Client.new(client_id, client_secret, options)
-		  	oauth_token = OAuth2::AccessToken.new(client, access_token)
-		  	
-		  	oauth_token.token_param = 'oauth_token'
+		  	client = OAuth2::Client.new(client_id, client_secret, { :site => endpoint })
+		  	oauth_token = OAuth2::AccessToken.new(client, access_token, {
+		  	  :mode => :query, 
+		  	  :param_name => 'oauth_token'
+		  	})
 		  	oauth_token
 		  end
 	end

data/lib/skittles/request.rb

@@ -42,14 +42,14 @@ module Skittles
 		  	
 		  	begin
 		  	  response = connection.request(method, paramify(path, options), headers)
-		  	rescue OAuth2::ErrorWithResponse => e
+		  	rescue OAuth2::Error => e
 		  	  Skittles::Utils.handle_foursquare_error(e.response)
 		  	else
 		  	  Skittles::Error
 		  	end
 		  	
 		  	unless raw
-		  		result = Skittles::Utils.parse_json(response)
+		  		result = Skittles::Utils.parse_json(response.body)
 		  	end
 		  	
 		  	raw ? response : result.response

data/lib/skittles/version.rb

@@ -1,3 +1,3 @@
 module Skittles
-	VERSION = '0.5.0'
+	VERSION = '0.6.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: skittles
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,88 +9,88 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-07-29 00:00:00.000000000Z
+date: 2011-11-12 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oauth2
-  requirement: &70223019913040 !ruby/object:Gem::Requirement
+  requirement: &70111005888740 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.4.1
+        version: 0.5.1
   type: :runtime
   prerelease: false
-  version_requirements: *70223019913040
+  version_requirements: *70111005888740
 - !ruby/object:Gem::Dependency
   name: yajl-ruby
-  requirement: &70223019912560 !ruby/object:Gem::Requirement
+  requirement: &70111005888240 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.8.1
+        version: 1.1.0
   type: :runtime
   prerelease: false
-  version_requirements: *70223019912560
+  version_requirements: *70111005888240
 - !ruby/object:Gem::Dependency
   name: hashie
-  requirement: &70223019912080 !ruby/object:Gem::Requirement
+  requirement: &70111005887720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: 1.2.0
   type: :runtime
   prerelease: false
-  version_requirements: *70223019912080
+  version_requirements: *70111005887720
 - !ruby/object:Gem::Dependency
   name: mime-types
-  requirement: &70223019911600 !ruby/object:Gem::Requirement
+  requirement: &70111005887200 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: 1.17.2
   type: :runtime
   prerelease: false
-  version_requirements: *70223019911600
+  version_requirements: *70111005887200
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70223019911120 !ruby/object:Gem::Requirement
+  requirement: &70111005865060 !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: 2.5.0
+        version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70223019911120
+  version_requirements: *70111005865060
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70223019910640 !ruby/object:Gem::Requirement
+  requirement: &70111005864540 !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: 1.0.15
+        version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70223019910640
+  version_requirements: *70111005864540
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &70223019910160 !ruby/object:Gem::Requirement
+  requirement: &70111005863280 !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: 1.6.4
+        version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70223019910160
+  version_requirements: *70111005863280
 - !ruby/object:Gem::Dependency
   name: rcov
-  requirement: &70223019909680 !ruby/object:Gem::Requirement
+  requirement: &70111005862800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -98,18 +98,18 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70223019909680
+  version_requirements: *70111005862800
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &70223019909200 !ruby/object:Gem::Requirement
+  requirement: &70111005862240 !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: 0.7.2
+        version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70223019909200
+  version_requirements: *70111005862240
 description: A Ruby implementation of the Foursquare v2 REST API. This library implements
   the Foursquare v2 API and the Foursquare Venues Project (beta) endpoints.
 email: anthony@sticksnleaves.com
@@ -123,6 +123,7 @@ files:
 - lib/skittles/api.rb
 - lib/skittles/client.rb
 - lib/skittles/client/checkin.rb
+- lib/skittles/client/list.rb
 - lib/skittles/client/photo.rb
 - lib/skittles/client/setting.rb
 - lib/skittles/client/special.rb
@@ -152,7 +153,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3746734199987061722
+      hash: -794761221278105416
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -161,7 +162,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.6
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Foursquare v2 REST API client library for Ruby