skittles 0.1.0 → 0.2.0

data/README.rdoc

@@ -17,7 +17,11 @@ http://rdoc.info/github/anthonator/skittles/
     config.access_token  = '...'
   end
   
-  Skittles.venue('211152')
+  begin
+    Skittles.venue('211152')
+  rescue Skittles::Error => e
+    puts "You recieved the #{e.type} error and a status code of #{e.code} which means #{e.detail}."
+  end
 
 == Contributing to Skittles
  

data/lib/skittles.rb

@@ -1,3 +1,5 @@
+require File.expand_path('../skittles/utils', __FILE__)
+require File.expand_path('../skittles/error', __FILE__)
 require File.expand_path('../skittles/version', __FILE__)
 require File.expand_path('../skittles/configuration', __FILE__)
 require File.expand_path('../skittles/api', __FILE__)

data/lib/skittles/client/photo.rb

@@ -9,7 +9,7 @@ module Skittles
       # Get details of a photo.
       #
       # @param id [String] The id of the photo to retrieve additional information for.
-      # @return A complete photo object.
+      # @return [Hashie::Mash] A complete photo object.
       # @requires_acting_user Yes
       # @see http://developer.foursquare.com/docs/photos/photos.html
       def photo(id)
@@ -29,35 +29,29 @@ module Skittles
       # @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.
       # @option options [Decimal] altAcc Vertical accuracy of the user's location, in meters.
-      # @return The photo that was just created.
+      # @return [Hashie::Mash] The photo that was just created.
       # @requires_acting_user Yes
       # @see http://developer.foursquare.com/docs/photos/add.html
       def add_photo(file, options = {})
-        resp = nil
         options.merge!({
           :file => UploadIO.new(file, 'image/jpeg', 'image.jpg'),
           :oauth_token => access_token
         })
         uri = URI.parse("#{endpoint}/photos/add")
-        File.open(file) do |file|
+        File.open(file) do
           req = Net::HTTP::Post::Multipart.new(uri.path, options)
           http = Net::HTTP.new(uri.host, uri.port)
           http.use_ssl = true if uri.scheme == 'https'
-          resp = http.start do |http|
-            http.request(req)
+          resp = http.start do |net|
+            net.request(req)
+          end
+          
+          case resp.code.to_i
+          when 200..299
+            return Skittles::Utils.parse_json(resp.body).response.photo
+          when 400..599
+            Skittles::Utils.handle_foursquare_error(resp)
           end
-        end
-        case resp.code.to_i
-        when 200..299
-          return Hashie::Mash.new(Yajl::Parser.new.parse(resp.body)).response.photo
-        when 401
-          e = OAuth2::AccessDenied.new("Received HTTP 401 during request.")
-          e.response = resp
-          raise e
-        else
-          e = OAuth2::HTTPError.new("Received HTTP #{resp.code} during request.")
-          e.response = resp
-          raise e
         end
       end
     end

data/lib/skittles/client/setting.rb

@@ -17,6 +17,7 @@ module Skittles
       # @param id [String] Name of setting to change, sendToTwitter, sendToFacebook, receivePings, receiveCommentPings.
       # @param value [Integer] 1 for true, and 0 for false.
       # @requires_acting_user Yes
+      # @return [Hashie::Mash] A confirmation message.
       # @see http://developer.foursquare.com/docs/settings/set.html
       def set_setting(id, value)
         post("settings/#{id}/set", { :value => value }).settings

data/lib/skittles/client/tip.rb

@@ -68,7 +68,7 @@ module Skittles
       # Allows you to remove a tip from your to-do list or done list.
       #
       # @param id [String] The tip you want to unmark.
-      # @return The tip being acted on.
+      # @return [Hashie::Mash] The tip being acted on.
       # @requires_acting_user No
       # @see http://developer.foursquare.com/docs/tips/unmark.html
       def tip_unmark(id)

data/lib/skittles/client/venue.rb

@@ -102,7 +102,6 @@ module Skittles
       # @option options [String] crossStreet The nearest intersecting street or streets.
       # @option options [String] phone The phone number of the venue.
       # @option options [String] primaryCategoryId The id of the category to which you want to assign this venue.
-      # @return nil
       # @requires_acting_user Yes
       # @see http://developer.foursquare.com/docs/venues/proposeedit.html
       def proposeedit(id, name, address, city, state, zip, ll, options = {})

data/lib/skittles/error.rb

@@ -0,0 +1,28 @@
+module Skittles
+  # Custom error class for rescuing from all known Foursquare errors.
+  class Error < StandardError; attr_accessor :code, :type, :detail end
+  
+  # Raised when Foursquare returns HTTP status code 400
+  class BadRequest < Error; end
+  
+  # Raised when Foursquare returns HTTP status code 401
+  class Unauthorized < Error; end
+  
+  # Raised when Foursquare returns HTTP status code 404
+  class NotFound < Error; end
+  
+  # Raised when Foursquare returns HTTP status code 405
+  class MethodNotAllowed < Error; end
+  
+  # Raised when Foursquare returns HTTP status code 500
+  class InternalServerError < Error; end
+  
+  # Raised when Foursquare returns HTTP status code 502
+  class BadGateway < Error; end
+  
+  # Raised when Foursquare returns HTTP status code 503
+  class ServiceUnavailable < Error; end
+  
+  # Raised when Foursquare returns HTTP status code 504
+  class GatewayTimeout < Error; end
+end

data/lib/skittles/request.rb

@@ -5,43 +5,50 @@ require 'hashie'
 module Skittles
 	module Request
 		# Perform an HTTP GET request
-		def get(path, options = {}, raw = false)
-			request(:get, path, options, raw)
+		def get(path, options = {}, headers = {}, raw = false)
+			request(:get, path, options, headers, raw)
 		end
 		
 		# Performs an HTTP POST request
-		def post(path, options = {}, raw = false)
-			request(:post, path, options, raw)
+		def post(path, options = {}, headers = {}, raw = false)
+			request(:post, path, options, headers, raw)
 		end
 		
 		# Performs an HTTP PUT request
-		def put(path, options = {}, raw = false)
-		  request(:put, path, options, raw)
+		def put(path, options = {}, headers = {}, raw = false)
+		  request(:put, path, options, headers, raw)
 		end
 		
 		# Performs an HTTP DELETE request
-		def delete(path, options = {}, raw = false)
-		  request(:delete, path, options, raw)
+		def delete(path, options = {}, headers = {}, raw = false)
+		  request(:delete, path, options, headers, raw)
 		end
 		
 		private
 		  #Perform an HTTP request
-		  def request(method, path, options, raw)
-		  	headers = {
+		  def request(method, path, options, headers, raw)
+		  	headers.merge!({
 		  		'User-Agent' => user_agent
-		  	}
+		  	})
 		  	
 		  	options.merge!({
 		  		:client_id     => client_id,
 		  		:client_secret => client_secret
 		  	})
-		  	response = connection.request(method, paramify(path, options), headers)
+		  	
+		  	begin
+		  	  response = connection.request(method, paramify(path, options), headers)
+		  	rescue OAuth2::AccessDenied || OAuth2::HTTPError => e
+		  	  Skittles::Utils.handle_foursquare_error(e.response)
+		  	else
+		  	  Skittles::Error
+		  	end
 		  	
 		  	unless raw
-		  		result = Yajl::Parser.new.parse(response)
+		  		result = Skittles::Utils.parse_json(response)
 		  	end
 		  	
-		  	raw ? response : Hashie::Mash.new(result).response
+		  	raw ? response : result.response
 		  end
 		  
 		  # Encode path and turn params into HTTP query.

data/lib/skittles/utils.rb

@@ -0,0 +1,38 @@
+module Skittles
+  # @private
+  module Utils
+    private 
+      def self.handle_foursquare_error(response)
+        info = parse_json(response.body).meta
+        case info.code.to_i
+        when 400
+          error = Skittles::BadRequest.new
+        when 401
+          error = Skittles::Unauthorized.new
+        when 404
+          error = Skittles::NotFound.new
+        when 405
+          error = Skittles::MethodNotAllowed.new
+        when 500
+          error = Skittles::InternalServerError.new
+        when 502
+          error = Skittles::BadGateway.new
+        when 503
+          error = Skittles::ServiceUnavailable.new
+        when 504
+          error = Skittles::GatewayTimeout.new
+        else
+          error = Skittles::Error.new
+        end
+        error.code = info.code.to_i
+        error.type = info.errorType
+        error.detail = info.errorDetail
+        raise error
+      end
+      
+      # Parses JSON and returns a Hashie::Mash
+      def self.parse_json(json)
+        Hashie::Mash.new(Yajl::Parser.new.parse(json))
+      end
+  end
+end

data/lib/skittles/version.rb

@@ -1,3 +1,3 @@
 module Skittles
-	VERSION = '0.1.0'
+	VERSION = '0.2.0'
 end

metadata

@@ -2,7 +2,7 @@
 name: skittles
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Anthony Smith
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-22 00:00:00 -05:00
+date: 2011-03-03 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -211,7 +211,9 @@ files:
 - lib/skittles/client/venue.rb
 - lib/skittles/configuration.rb
 - lib/skittles/connection.rb
+- lib/skittles/error.rb
 - lib/skittles/request.rb
+- lib/skittles/utils.rb
 - lib/skittles/version.rb
 - LICENSE.txt
 - README.rdoc
@@ -231,7 +233,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3194088974280100972
+      hash: -3126880121428763984
       segments: 
       - 0
       version: "0"
@@ -244,7 +246,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.5.2
+rubygems_version: 1.5.3
 signing_key: 
 specification_version: 3
 summary: Foursquare v2 REST API client library for Ruby