playnicely 0.1.1 → 0.1.2

data/README.textile

@@ -8,8 +8,6 @@ h2. Installation
 
 Details of how to install the client
 
-(Once I get around to publishing the gem!)
-
 @sudo gem install playnicely@
 
 h2. Getting started
@@ -110,6 +108,31 @@ projects_id = client.user_projects(999, "id") # returns an integer
 
 *Important note:* Only projects to which the authenticated user is also a member will be returned. If you require a complete list of all projects for a user, then you must authenticate as that user.
 
+h3. Errors
+
+*See the "error reference page":http://docs.playnice.ly/api/errors/ for more information*
+
+<pre>
+# now try again but wrap call and check exception content -- stupid shoulda!
+begin
+  PlayNicely::Client.new('robbiehudson', 'password').project(1)
+rescue PlayNicely::Error => e
+  puts "Error type: #{e.error_type}"
+  puts "Error message: #{e.error_message}"
+end
+</pre>
+
+Will print the following:
+
+<pre>
+Error type: ApiPermissionError
+Error message: User ID '2' does not have access to project ID '9999'
+</pre>
+
+h2. Testing
+
+To run the tests just type @rake test@
+
 h2. Contributing
 
 Please feel free to fork this repository and make any changes you feel are necessary. We will be happy to accept pull requests that we feel will benefit other users of the client.

data/lib/playnicely.rb

@@ -15,9 +15,17 @@ module PlayNicely
   def self.client; Client.new end
   
   def_delegators :client, :project
-  class Error < StandardError; end
+  class Error < StandardError
+    attr_reader :error_message, :error_type
+    def initialize(type, error_message=nil)
+      @error_type = type
+      @error_message = error_message
+    end
+  end
+  class BadRequest < Error; end
   class Unauthorized < Error; end
   class NotFound < Error; end
+  class Forbidden < Error; end
   class ClientError < Error; end
   class ServerError < Error; end
 end

data/lib/playnicely/client.rb

@@ -98,11 +98,12 @@ module PlayNicely
 
     def self.handle_response(response)
       case response.code
-      when 401; raise Unauthorized.new Hashie::Mash.new(response).error_message
-      when 403; raise RateLimitExceeded.new Hashie::Mash.new(response).error_message
-      when 404; raise NotFound.new Hashie::Mash.new(response).error_message
-      when 400...500; raise ClientError.new Hashie::Mash.new(response).error_message
-      when 500...600; raise ServerError.new(Hashie::Mash.new(response).error_message)
+      when 400; raise BadRequest.new Hashie::Mash.new(response)["type"], Hashie::Mash.new(response).error_message
+      when 401; raise Unauthorized.new Hashie::Mash.new(response)["type"], Hashie::Mash.new(response).error_message
+      when 403; raise Forbidden.new Hashie::Mash.new(response)["type"], Hashie::Mash.new(response).error_message
+      when 404; raise NotFound.new Hashie::Mash.new(response)["type"], Hashie::Mash.new(response).error_message
+      when 400...500; raise ClientError.new(Hashie::Mash.new(response)["type"], Hashie::Mash.new(response).error_message)
+      when 500...600; raise ServerError.new(Hashie::Mash.new(response)["type"], Hashie::Mash.new(response).error_message)
       else; response
       end
     end

data/lib/playnicely/version.rb

@@ -1,3 +1,3 @@
 module PlayNicely
-  VERSION = "0.1.1".freeze unless defined?(PlayNicely::VERSION)
+  VERSION = "0.1.2".freeze unless defined?(PlayNicely::VERSION)
 end

data/playnicely.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency('httparty', '~> 0.6.1')
   s.add_runtime_dependency('json')
   s.add_development_dependency('fakeweb', '~> 1.3')
-  s.add_development_dependency('jnunemaker-matchy', '~> 0.4')
+  s.add_development_dependency('rspec', '~> 2.4.0')
   s.add_development_dependency('mocha', '~> 0.9')
   s.add_development_dependency('shoulda', '~> 2.11')
   s.name = 'playnicely'

data/test/client_test.rb

@@ -9,16 +9,9 @@ class ClientTest < Test::Unit::TestCase
     
     should "raise server error" do
       stub_get("https://robbiehudson:wrong-password@api.playnice.ly/v1/project/1/show/?detail=compact", "server-error.json", ["500", "Unauthorized"])
-      lambda {PlayNicely::Client.new('robbiehudson', 'wrong-password').project(1)}.should raise_error(PlayNicely::ServerError)
-      
-      # now try again but wrap call and check exception content -- stupid shoulda!
-      begin
-        PlayNicely::Client.new('robbiehudson', 'wrong-password').project(1)
-      rescue PlayNicely::ServerError => e
-        e.message.should == "A description of the problem"
-      else
-        assert_true false
-      end
+      lambda {PlayNicely::Client.new('robbiehudson', 'wrong-password').project(1)}.should raise_error(PlayNicely::ServerError) { |error|
+        error.error_message.should == "A description of the problem"
+      }
     end
     
     should "raise client error" do
@@ -29,6 +22,22 @@ class ClientTest < Test::Unit::TestCase
     should "raise not found error" do
       stub_get("https://robbiehudson:wrong-password@api.playnice.ly/v1/project/1/show/?detail=compact", "server-error.json", ["404", "Unauthorized"])
       lambda {PlayNicely::Client.new('robbiehudson', 'wrong-password').project(1)}.should raise_error(PlayNicely::NotFound)
-    end    
+    end
+    
+    should "raise forbidden error" do
+      stub_get("https://robbiehudson:wrong-password@api.playnice.ly/v1/project/1/show/?detail=compact", "server-error.json", ["403", "Unauthorized"])
+      lambda {PlayNicely::Client.new('robbiehudson', 'wrong-password').project(1)}.should raise_error(PlayNicely::Forbidden) { |error| 
+        error.error_message.should == "A description of the problem"
+        error.error_type.should == "MessageTypeError"
+      }
+    end
+    
+    should "raise bad request error" do
+      stub_get("https://robbiehudson:wrong-password@api.playnice.ly/v1/project/1/show/?detail=compact", "server-error.json", ["400", "Unauthorized"])
+      lambda {PlayNicely::Client.new('robbiehudson', 'wrong-password').project(1)}.should raise_error(PlayNicely::BadRequest) { |error| 
+        error.error_message.should == "A description of the problem"
+        error.error_type.should == "MessageTypeError"
+      }
+    end
   end
 end

data/test/helper.rb

@@ -2,7 +2,8 @@ require 'test/unit'
 require 'pathname'
 
 require 'shoulda'
-require 'matchy'
+# require 'matchy'
+require 'rspec'
 # require 'mocha'
 require 'fakeweb'
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: playnicely
 version: !ruby/object:Gem::Version 
-  hash: 25
+  hash: 31
   prerelease: 
   segments: 
   - 0
   - 1
-  - 1
-  version: 0.1.1
+  - 2
+  version: 0.1.2
 platform: ruby
 authors: 
 - Rob Hudson
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-19 00:00:00 +00:00
+date: 2011-03-23 00:00:00 +00:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -80,18 +80,19 @@ dependencies:
   type: :development
   version_requirements: *id004
 - !ruby/object:Gem::Dependency 
-  name: jnunemaker-matchy
+  name: rspec
   prerelease: false
   requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 3
+        hash: 31
         segments: 
-        - 0
+        - 2
         - 4
-        version: "0.4"
+        - 0
+        version: 2.4.0
   type: :development
   version_requirements: *id005
 - !ruby/object:Gem::Dependency 
@@ -196,7 +197,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.4.1
+rubygems_version: 1.4.2
 signing_key: 
 specification_version: 3
 summary: Wrapper for the PlayNicely API