rspreedly 0.1.2 → 0.1.3

data/README.rdoc

@@ -69,6 +69,12 @@ Raise an invoice, and pay it
     payment = RSpreedly::PaymentMethod::CreditCard(:card_type => 'visa', :number => '123456', ...)
     invoice.pay(payment)
 
+Error messages
+  
+    invoice = RSpreedly::Invoice.new
+    invoice.save => false
+    invoice.errors => ["You must specify both the subscription plan id and subscriber information."]
+
 See the specs and API docs at Spreedly for more details and the rest of the things it can do.
 
 https://www.spreedly.com/manual/integration-reference/url-reference/

data/VERSION

@@ -1 +1 @@
-0.1.2
+0.1.3

data/lib/rspreedly/base.rb

@@ -5,6 +5,8 @@ module RSpreedly
     format :xml
     base_uri "https://spreedly.com/api/v4"
 
+    attr_reader :errors
+
     def self.api_request(type, path, options={})
       path = "/#{::RSpreedly::Config.site_name}#{path}"
       options.merge!({
@@ -20,21 +22,22 @@ module RSpreedly
       
       case response.code.to_i
       when 401
-        raise(RSpreedly::Error::AccessDenied.new, message)        
+        raise(RSpreedly::Error::AccessDenied.new(response), message)
       when 403
-        raise(RSpreedly::Error::Forbidden.new, message)
+        raise(RSpreedly::Error::Forbidden.new(response), message)
       when 422
-        raise(RSpreedly::Error::BadRequest.new, message)
+        raise(RSpreedly::Error::BadRequest.new(response), message)
       when 404
-        raise(RSpreedly::Error::NotFound.new, message)        
+        raise(RSpreedly::Error::NotFound.new(response), message)
       when 504
-        raise(RSpreedly::Error::GatewayTimeout.new, message)                
+        raise(RSpreedly::Error::GatewayTimeout.new(response), message)
       end      
 
       response
     end
 
     def initialize(attrs={})
+      @errors = []
       self.attributes = attrs
     end
     
@@ -45,7 +48,19 @@ module RSpreedly
     end
     
     def api_request(type, path, options={})
-      self.class.api_request(type, path, options)
+      @errors = []
+      begin
+        self.class.api_request(type, path, options)
+      rescue RSpreedly::Error::Base => e
+        if e.response.is_a?(Hash)
+          if e.response.has_key?("errors")
+            @errors = [*e.response["errors"]["error"]]
+          else
+            @errors = [e.response.body]
+          end      
+        end
+        raise
+      end
     end
 
     # TODO - do this nicer

data/lib/rspreedly/error.rb

@@ -1,6 +1,14 @@
 module RSpreedly
   module Error
-    class Base            < StandardError;    end
+
+    class Base < StandardError;    
+      attr_reader :response
+      
+      def initialize(response=nil)
+        @response  = response
+      end
+    end
+    
     class AccessDenied    < Base;             end # 401 errors    
     class Forbidden       < Base;             end # 403 errors
     class BadRequest      < Base;             end # 422 errors

data/lib/rspreedly/subscriber.rb

@@ -68,6 +68,10 @@ module RSpreedly
       self.new_record? ? self.create : self.update
     end
 
+    def save!
+      self.new_record? ? self.create! : self.update!
+    end
+
     # Create a subscriber (more)
     # POST /api/v4/[short site name]/subscribers.xml    
     def create!

data/rspreedly.gemspec

@@ -2,11 +2,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{rspreedly}
-  s.version = "0.1.2"
+  s.version = "0.1.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Richard Livsey"]
-  s.date = %q{2009-11-03}
+  s.date = %q{2009-11-04}
   s.email = %q{richard@livsey.org}
   s.extra_rdoc_files = [
     "LICENSE",
@@ -38,6 +38,9 @@ Gem::Specification.new do |s|
      "spec/fixtures/complimentary_not_valid.xml",
      "spec/fixtures/complimentary_success.xml",
      "spec/fixtures/create_subscriber.xml",
+     "spec/fixtures/error.xml",
+     "spec/fixtures/error_string.txt",
+     "spec/fixtures/errors.xml",
      "spec/fixtures/existing_subscriber.xml",
      "spec/fixtures/free_plan_not_elligable.xml",
      "spec/fixtures/free_plan_not_free.xml",

data/spec/base_spec.rb

@@ -1,13 +1,68 @@
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+class TestAPI < RSpreedly::Base; end
+
 describe RSpreedly::Base do
 
-  describe "#api_request" do
+  describe ".api_request" do
     it "should raise AccessDenied if a 401 is received" do
       stub_http_with_code(401)
       lambda{
         RSpreedly::Base.api_request(:put, '/')
       }.should raise_error(RSpreedly::Error::AccessDenied)
     end
+  end
+    
+  describe "error messages" do
+    
+    before(:each) do
+      @api = TestAPI.new
+    end
+  
+    def do_request
+      @api.api_request(:post, "/")
+    end
+    
+    def failing_request
+      lambda{
+        do_request
+      }.should raise_error
+    end
+  
+    it "should not set any errors on a successful request" do
+      stub_http_with_code(200)          
+      do_request
+      @api.errors.should be_empty
+    end
+    
+    it "should set one error in the error array if a string is return " do
+      stub_http_with_fixture("error_string.txt", 422)          
+      failing_request
+      @api.errors.should == ["Some error back from the response as a string"]
+    end
+    
+    it "should set one error in the error array if an xml error with one item is returned" do
+      stub_http_with_fixture("error.xml", 422)          
+      failing_request
+      @api.errors.should == ["Email can't be blank"]    
+    end
+      
+    it "should set multiple errors in the error array if an xml error with multiple items is returned" do
+      stub_http_with_fixture("errors.xml", 422)          
+      failing_request
+      @api.errors.should == ["Email can't be blank", "Name can't be blank"]    
+    end      
     
+    it "should reset errors on each call" do
+      # failing one first, which will generate some errors
+      stub_http_with_fixture("errors.xml", 422)          
+      failing_request
+      @api.errors.should_not be_empty
+      
+      # now a successful one should clear the errors
+      stub_http_with_code(200)          
+      do_request
+      @api.errors.should be_empty
+    end
   end
-end
+end

data/spec/fixtures/error.xml

@@ -0,0 +1,4 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<errors>
+  <error>Email can't be blank</error>
+</errors>

data/spec/fixtures/error_string.txt

@@ -0,0 +1 @@
+Some error back from the response as a string

data/spec/fixtures/errors.xml

@@ -0,0 +1,5 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<errors>
+  <error>Email can't be blank</error>
+  <error>Name can't be blank</error>  
+</errors>

data/spec/spec_helper.rb

@@ -1,6 +1,5 @@
 require 'rubygems'
 require 'spec'
-require 'net-http-spy'
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 require 'rspreedly'

data/spec/subscriber_spec.rb

@@ -71,6 +71,23 @@ describe RSpreedly::Subscriber do
       @subscriber.save      
     end
   end
+  
+  describe "#save!" do
+    before(:each) do
+      @subscriber = RSpreedly::Subscriber.new
+    end    
+    
+    it "should call #create! for a non existing subscriber" do
+      @subscriber.should_receive(:create!)      
+      @subscriber.save!
+    end
+    
+    it "should call update! for an existing subscriber" do
+      @subscriber.token = "something"
+      @subscriber.should_receive(:update!)
+      @subscriber.save!     
+    end
+  end  
 
   describe "#create!" do
     it "should return true if successful" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: rspreedly
 version: !ruby/object:Gem::Version 
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors: 
 - Richard Livsey
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-11-03 00:00:00 +01:00
+date: 2009-11-04 00:00:00 +01:00
 default_executable: 
 dependencies: []
 
@@ -48,6 +48,9 @@ files:
 - spec/fixtures/complimentary_not_valid.xml
 - spec/fixtures/complimentary_success.xml
 - spec/fixtures/create_subscriber.xml
+- spec/fixtures/error.xml
+- spec/fixtures/error_string.txt
+- spec/fixtures/errors.xml
 - spec/fixtures/existing_subscriber.xml
 - spec/fixtures/free_plan_not_elligable.xml
 - spec/fixtures/free_plan_not_free.xml