rspreedly 0.0.1

data/spec/invoice_spec.rb

@@ -0,0 +1,129 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe RSpreedly::Invoice do
+
+  describe "#create!" do
+
+    before(:each) do
+      @subscriber = RSpreedly::Subscriber.new(:customer_id => 42, :screen_name => "bob", :email => "test@example.com")
+      @invoice    = RSpreedly::Invoice.new(:subscriber => @subscriber, :subscription_plan_id => 2502)
+    end
+
+    it "should return true if successful" do
+      stub_http_with_fixture("invoice_created.xml", 201)     
+      @invoice.create.should be_true
+    end    
+    
+    it "should update the invoice if successful" do
+      stub_http_with_fixture("invoice_created.xml", 200)           
+      lambda{
+        @invoice.create
+      }.should change(@invoice, :price).to("$0.00")
+    end
+    
+    it "should setup line items in the invoice if successful" do
+      stub_http_with_fixture("invoice_created.xml", 200)           
+      @invoice.create
+      @invoice.line_items.size.should == 1
+      @invoice.line_items[0].should be_a(RSpreedly::LineItem)
+    end            
+    
+    it "should raise NotFound if the plan doesn't exist" do
+      stub_http_with_fixture("plan_not_found.xml", 404)    
+      lambda{
+        @invoice.create!
+      }.should raise_error(RSpreedly::Error::NotFound)      
+    end
+    
+    it "should raise BadRequest if the invoice is invalid" do
+      stub_http_with_fixture("invoice_invalid.xml", 422)      
+      lambda{
+        @invoice.create!
+      }.should raise_error(RSpreedly::Error::BadRequest)
+    end
+    
+    it "should raise Forbidden if the plan is disabled" do
+      stub_http_with_fixture("plan_disabled.xml", 403)            
+      lambda{
+        @invoice.create!
+      }.should raise_error(RSpreedly::Error::Forbidden)      
+    end    
+  end
+  
+  describe "#create" do
+
+    before(:each) do
+      @subscriber = RSpreedly::Subscriber.new(:customer_id => 42, :screen_name => "bob", :email => "test@example.com")
+      @invoice    = RSpreedly::Invoice.new(:subscriber => @subscriber, :subscription_plan_id => 2502)
+    end
+
+    it "should return true if successful" do
+      stub_http_with_fixture("invoice_created.xml", 201)     
+      @invoice.create.should be_true
+    end    
+        
+    it "should return nil if the plan doesn't exist" do
+      stub_http_with_fixture("plan_not_found.xml", 404)    
+      @invoice.create.should be_nil
+    end
+    
+    it "should return nil if the invoice is invalid" do
+      stub_http_with_fixture("invoice_invalid.xml", 422)      
+      @invoice.create.should be_nil
+    end
+    
+    it "should return nil if the plan is disabled" do
+      stub_http_with_fixture("plan_disabled.xml", 403)            
+      @invoice.create.should be_nil
+    end    
+  end
+  
+  
+  describe "#pay" do
+    
+    before(:each) do
+      @invoice = RSpreedly::Invoice.new(:token => "5b1f186651dd988865c6573921ec87fa4bec23b8")
+      @payment = RSpreedly::PaymentMethod::CreditCard.new(:number     => "4222222222222", 
+                                                          :card_type  => "visa", 
+                                                          :verification_value => "234", 
+                                                          :month      => 1, 
+                                                          :year       => 2011, 
+                                                          :first_name => "Joe", 
+                                                          :last_name  => "Bob")
+    end 
+   
+    it "should return true if successful" do
+      stub_http_with_fixture("payment_success.xml", 200)    
+      @invoice.pay(@payment).should be_true
+    end   
+      
+    it "should update the Invoice if successful" do
+      stub_http_with_fixture("payment_success.xml", 200)    
+      
+      lambda{
+        @invoice.pay(@payment)
+      }.should change(@invoice, :closed).to(true)
+    end
+    
+    it "should raise NotFound if the invoice doesn't exist" do
+      stub_http_with_fixture("payment_not_found.xml", 404)    
+      lambda{
+        @invoice.pay(@payment)
+      }.should raise_error(RSpreedly::Error::NotFound)      
+    end
+    
+    it "should raise BadRequest if the payment method is invalid" do
+      stub_http_with_fixture("payment_invalid.xml", 422)      
+      lambda{
+        @invoice.pay(@payment)
+      }.should raise_error(RSpreedly::Error::BadRequest)
+    end
+      
+      it "should raise Forbidden if the invoice is already paid" do
+        stub_http_with_fixture("payment_already_paid.xml", 403)            
+        lambda{
+          @invoice.pay(@payment)
+        }.should raise_error(RSpreedly::Error::Forbidden)      
+      end    
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,44 @@
+require 'rubygems'
+require 'spec'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'rspreedly'
+
+# setup a config with dummy data
+RSpreedly::Config.setup do |config|
+  config.api_key        = "your-api-key-here"
+  config.site_name      = "you-site-name-here"
+end
+
+Spec::Runner.configure do |config|
+  
+end
+
+def load_fixture(file)
+  response_file = File.join(File.dirname(__FILE__), 'fixtures', file)
+  File.read(response_file)
+end
+
+def stub_http_with_fixture(fixture, status = 200)
+  stub_http_response(:body => load_fixture(fixture), :code => status)
+end
+
+def stub_http_with_code(status = 200)
+  stub_http_response(:code => status)
+end
+
+def stub_http_response(opts={})
+  http_response = mock(:response)
+  
+  http_response.stub!(:body).and_return(opts[:body] || "")
+  http_response.stub!(:message).and_return("")  
+  http_response.stub!(:kind_of?).and_return(true)
+  http_response.stub!(:code).and_return(opts[:code] || 200)
+  http_response.stub!(:to_hash).and_return({})  
+  
+  mock_http = mock(:net_http, :null_object => true)
+  mock_http.stub!(:request).and_return(http_response)
+  
+  Net::HTTP.stub!(:new).and_return(mock_http)
+end

data/spec/subscriber_spec.rb

@@ -0,0 +1,442 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+describe RSpreedly::Subscriber do
+
+  describe ".find" do
+    describe "with the symbol :all" do
+      it "should pass to RSpreedly::Subscriber.all" do
+        RSpreedly::Subscriber.should_receive(:all)
+        RSpreedly::Subscriber.find(:all)
+      end      
+    end
+
+    it "should return nil with an id for a subscriber who doesn't exist" do
+      stub_http_with_fixture("subscriber_not_found.xml", 404)
+      RSpreedly::Subscriber.find(42).should be_nil
+    end
+
+    it "should return a Subscriber with an id for an existing subscriber" do
+      stub_http_with_fixture("subscriber.xml", 200)
+      RSpreedly::Subscriber.find(42).should be_a(RSpreedly::Subscriber)
+    end
+  end
+  
+  describe ".all" do
+    it "should return an empty array if there are no subscribers" do
+      stub_http_with_fixture("no_subscribers.xml", 200)
+      RSpreedly::Subscriber.all.should == []
+    end
+    
+    it "should return an array of subscribers if there are any to find" do
+      stub_http_with_fixture("subscribers.xml", 200)
+      RSpreedly::Subscriber.all.size.should == 3 # there are 3 in the fixture
+      RSpreedly::Subscriber.all.select{|x| x.is_a?(RSpreedly::Subscriber )}.size.should == 3
+    end
+  end
+  
+  describe ".destroy_all" do
+    it "should return true if successful" do
+      stub_http_with_code(200)    
+      RSpreedly::Subscriber.destroy_all.should be_true
+    end    
+  end
+
+  describe "#new_record?" do
+    before(:each) do
+      @subscriber = RSpreedly::Subscriber.new
+    end
+    
+    it "should return true if the subscriber doesn't have a token" do
+      @subscriber.new_record?.should be_true
+    end
+    
+    it "should return false if the subscriber has a token" do
+      @subscriber.token = "something"
+      @subscriber.new_record?.should be_false
+    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
+      stub_http_with_fixture("create_subscriber.xml", 201)
+      @subscriber = RSpreedly::Subscriber.new(:customer_id => 42, :screen_name => "bob")
+      @subscriber.create!.should be_true
+    end
+    
+    it "should raise a BadRequest error if the data is invalid" do
+      stub_http_with_fixture("invalid_subscriber.xml", 422)
+      @subscriber = RSpreedly::Subscriber.new
+      lambda{
+        @subscriber.create!
+      }.should raise_error(RSpreedly::Error::BadRequest)
+    end
+    
+    it "should update the subscriber if successful" do
+      stub_http_with_fixture("create_subscriber.xml", 200)           
+      @subscriber = RSpreedly::Subscriber.new(:customer_id => 42, :screen_name => "bob")      
+      lambda{
+        @subscriber.create!
+      }.should change(@subscriber, :token).to("6af9994a57e420345897b1abb4c27a9db27fa4d0")
+    end    
+    
+    it "should raise a Forbidden error if there is already a subscriber with that ID" do
+      stub_http_with_fixture("existing_subscriber.xml", 403)     
+      @subscriber = RSpreedly::Subscriber.new(:customer_id => 42, :screen_name => "bob")
+      lambda{
+        @subscriber.create!
+      }.should raise_error(RSpreedly::Error::Forbidden)      
+    end
+  end
+
+  describe "#create" do
+    it "should return true if successful" do
+      stub_http_with_fixture("create_subscriber.xml", 201)
+      @subscriber = RSpreedly::Subscriber.new
+      @subscriber.customer_id = 42
+      @subscriber.screen_name = "bob"
+      @subscriber.create.should be_true
+    end
+    
+    it "should return nil if the data is invalid" do
+      stub_http_with_fixture("invalid_subscriber.xml", 422)
+      @subscriber = RSpreedly::Subscriber.new
+      @subscriber.create.should be_nil
+    end
+    
+    it "should return nil if there is already a subscriber with that ID" do
+      stub_http_with_fixture("existing_subscriber.xml", 403)     
+      @subscriber = RSpreedly::Subscriber.new
+      @subscriber.customer_id = 42
+      @subscriber.screen_name = "bob"
+      @subscriber.create.should be_nil
+    end
+  end
+
+  describe "#update!" do
+    before(:each) do
+      @subscriber = RSpreedly::Subscriber.new      
+    end
+    
+    describe "with basic information" do
+      it "should return true if successful" do
+        stub_http_with_code(200)
+        @subscriber.customer_id = 42
+        @subscriber.email = "new@email.com"
+        @subscriber.update!.should be_true
+      end
+      
+      it "should raise NotFound if the subscriber doesn't exist" do
+        stub_http_with_fixture("subscriber_not_found.xml", 404)            
+        @subscriber.customer_id = 400
+        lambda{
+          @subscriber.update!
+        }.should raise_error(RSpreedly::Error::NotFound)        
+      end      
+      
+      it "should raise BadRequest if the data is invalid" do
+        stub_http_with_fixture("invalid_update.xml", 422)    
+        @subscriber.customer_id = 42        
+        lambda{
+          @subscriber.update!
+        }.should raise_error(RSpreedly::Error::BadRequest)        
+      end
+    end
+    
+    describe "with new_customer_id" do
+      it "should return true if successful" do
+        stub_http_with_code(200)
+        @subscriber.customer_id = 42
+        @subscriber.new_customer_id = 43
+        @subscriber.email = "new@email.com"
+        @subscriber.update!.should be_true
+      end
+      
+      it "should raise NotFound if the subscriber doesn't exist" do
+        stub_http_with_fixture("subscriber_not_found.xml", 404)            
+        @subscriber.customer_id = 400
+        @subscriber.new_customer_id = 401
+        lambda{
+          @subscriber.update!
+        }.should raise_error(RSpreedly::Error::NotFound)        
+      end      
+      
+      it "should raise BadRequest if the data is invalid" do
+        stub_http_with_fixture("invalid_update.xml", 422)    
+        @subscriber.new_customer_id = 43        
+        lambda{
+          @subscriber.update!
+        }.should raise_error(RSpreedly::Error::BadRequest)        
+      end      
+    end
+    
+    describe "with payment information" do
+      before(:each) do
+        @subscriber.customer_id = 42        
+        @subscriber.payment_method = RSpreedly::PaymentMethod::CreditCard.new(:number => "1233445", :verification_value => "234")
+      end
+      
+      it "should return true if successful" do
+        stub_http_with_code(200)
+        @subscriber.update!.should be_true
+      end
+      
+      it "should raise NotFound if the subscriber doesn't exist" do
+        stub_http_with_fixture("subscriber_not_found.xml", 404)            
+        lambda{
+          @subscriber.update!
+        }.should raise_error(RSpreedly::Error::NotFound)        
+      end      
+      
+      it "should raise BadRequest if the data is invalid" do
+        stub_http_with_fixture("invalid_update.xml", 422)    
+        lambda{
+          @subscriber.update!
+        }.should raise_error(RSpreedly::Error::BadRequest)        
+      end      
+
+      it "should raise Forbidden if the data is invalid" do
+        stub_http_with_fixture("invalid_update.xml", 403)    
+        lambda{
+          @subscriber.update!
+        }.should raise_error(RSpreedly::Error::Forbidden)        
+      end      
+    end
+  end
+  
+  describe "#update" do
+    before(:each) do
+      @subscriber = RSpreedly::Subscriber.new      
+    end     
+     
+    describe "with basic information" do
+      it "should return true if successful" do
+        stub_http_with_code(200)
+        @subscriber.customer_id = 42
+        @subscriber.email = "new@email.com"
+        @subscriber.update!.should be_true
+      end
+      
+      it "should return nil if the subscriber doesn't exist" do
+        stub_http_with_fixture("subscriber_not_found.xml", 404)            
+        @subscriber.customer_id = 400
+        @subscriber.update.should be_nil
+      end      
+      
+      it "should return nil if the data is invalid" do
+        stub_http_with_fixture("invalid_update.xml", 422)    
+        @subscriber.customer_id = 42        
+        @subscriber.update.should be_nil
+      end
+    end     
+  end
+  
+  describe "#destroy" do
+    before(:each) do
+      @subscriber = RSpreedly::Subscriber.new(:customer_id => 42)
+    end    
+    
+    it "should return nil if the subscriber doesn't exist" do
+      stub_http_with_fixture("subscriber_not_found.xml", 404)            
+      @subscriber.destroy.should be_nil
+    end    
+    
+    it "should return true if successful" do
+      stub_http_with_code(200)    
+      @subscriber.destroy.should be_true
+    end    
+  end
+
+  describe "#comp_subscription" do
+    before(:each) do
+      @subscriber = RSpreedly::Subscriber.new(:customer_id => 42, :feature_level => "Lowly")
+      @subscription = RSpreedly::ComplimentarySubscription.new(:duration_quantity => 42, :duration_units => "months", :feature_level => "Pro")      
+    end
+    
+    it "should return true if successful" do
+      stub_http_with_fixture("complimentary_success.xml", 201)     
+      @subscriber.comp_subscription(@subscription).should be_true
+    end    
+    
+    it "should update the subscriber if successful" do
+      stub_http_with_fixture("complimentary_success.xml", 201)           
+      lambda{
+        @subscriber.comp_subscription(@subscription)
+      }.should change(@subscriber, :feature_level).to("Pro")
+    end
+    
+    it "should raise NotFound if the subscriber doesn't exist" do
+      stub_http_with_fixture("subscriber_not_found.xml", 404)    
+      lambda{
+        @subscriber.comp_subscription(@subscription)
+      }.should raise_error(RSpreedly::Error::NotFound)      
+    end
+    
+    it "should raise BadRequest if validation fails on the subscription" do
+      stub_http_with_fixture("complimentary_not_valid.xml", 422)      
+      lambda{
+        @subscriber.comp_subscription(@subscription)
+      }.should raise_error(RSpreedly::Error::BadRequest)
+    end
+    
+    it "should raise Forbidden if the subscriber is active" do
+      stub_http_with_fixture("complimentary_failed_active.xml", 403)            
+      lambda{
+        @subscriber.comp_subscription(@subscription)
+      }.should raise_error(RSpreedly::Error::Forbidden)      
+    end
+  end
+
+  describe "#comp_time_extension" do
+    before(:each) do
+      @subscriber = RSpreedly::Subscriber.new(:customer_id => 42, :feature_level => "Lowly")
+      @subscription = RSpreedly::ComplimentaryTimeExtension.new(:duration_quantity => 42, :duration_units => "months")      
+    end
+    
+    it "should return true if successful" do
+      stub_http_with_fixture("complimentary_success.xml", 201)     
+      @subscriber.comp_time_extension(@subscription).should be_true
+    end    
+    
+    it "should update the subscriber if successful" do
+      stub_http_with_fixture("complimentary_success.xml", 201)           
+      lambda{
+        @subscriber.comp_time_extension(@subscription)
+      }.should change(@subscriber, :active_until).to(Time.parse("Sun Feb 21 19:04:28 UTC 2010"))
+    end
+    
+    it "should raise NotFound if the subscriber doesn't exist" do
+      stub_http_with_fixture("subscriber_not_found.xml", 404)    
+      lambda{
+        @subscriber.comp_time_extension(@subscription)
+      }.should raise_error(RSpreedly::Error::NotFound)      
+    end
+    
+    it "should raise BadRequest if validation fails on the subscription" do
+      stub_http_with_fixture("complimentary_not_valid.xml", 422)      
+      lambda{
+        @subscriber.comp_time_extension(@subscription)
+      }.should raise_error(RSpreedly::Error::BadRequest)
+    end
+    
+    it "should raise Forbidden if the subscriber is inactive" do
+      stub_http_with_fixture("complimentary_failed_inactive.xml", 403)            
+      lambda{
+        @subscriber.comp_time_extension(@subscription)
+      }.should raise_error(RSpreedly::Error::Forbidden)      
+    end
+  end
+ 
+  describe "#stop_auto_renew" do
+    before(:each) do
+      @subscriber = RSpreedly::Subscriber.new(:customer_id => 42)
+    end    
+    
+    it "should return true if successful" do
+      stub_http_with_code(200)     
+      @subscriber.stop_auto_renew.should be_true
+    end    
+    
+    it "should raise NotFound if the subscriber doesn't exist" do
+      stub_http_with_fixture("subscriber_not_found.xml", 404)    
+      lambda{
+        @subscriber.stop_auto_renew
+      }.should raise_error(RSpreedly::Error::NotFound)      
+    end    
+  end
+
+  describe "#subscribe_to_free_trial" do
+    before(:each) do
+      @subscriber = RSpreedly::Subscriber.new(:customer_id => 42)
+      @plan = RSpreedly::SubscriptionPlan.new(:id => 2533)
+    end
+    
+    it "should return true if successful" do
+      stub_http_with_fixture("free_plan_success.xml", 200)     
+      @subscriber.subscribe_to_free_trial(@plan).should be_true
+    end    
+    
+    it "should update the subscriber if successful" do
+      stub_http_with_fixture("free_plan_success.xml", 200)           
+      lambda{
+        @subscriber.subscribe_to_free_trial(@plan)
+      }.should change(@subscriber, :grace_until).to(Time.parse("2013-05-02T00:07:37Z"))
+    end
+    
+    it "should raise NotFound if the subscriber doesn't exist" do
+      stub_http_with_fixture("subscriber_not_found.xml", 404)    
+      lambda{
+        @subscriber.subscribe_to_free_trial(@plan)
+      }.should raise_error(RSpreedly::Error::NotFound)      
+    end
+    
+    it "should raise NotFound if the plan doesn't exist" do
+      stub_http_with_fixture("plan_not_found.xml", 404)    
+      lambda{
+        @subscriber.subscribe_to_free_trial(@plan)
+      }.should raise_error(RSpreedly::Error::NotFound)      
+    end    
+    
+    it "should raise BadRequest if no plan is specified" do
+      stub_http_with_fixture("free_plan_not_set.xml", 422)      
+      @plan.id = nil
+      lambda{
+        @subscriber.subscribe_to_free_trial(@plan)
+      }.should raise_error(RSpreedly::Error::BadRequest)
+    end
+    
+    it "should raise Forbidden if the subscriber isn't elligable" do
+      stub_http_with_fixture("free_plan_not_elligable.xml", 403)            
+      lambda{
+        @subscriber.subscribe_to_free_trial(@plan)
+      }.should raise_error(RSpreedly::Error::Forbidden)      
+    end    
+
+    it "should raise Forbidden if the plan isn't a free trial" do
+      stub_http_with_fixture("free_plan_not_free.xml", 403)            
+      lambda{
+        @subscriber.subscribe_to_free_trial(@plan)
+      }.should raise_error(RSpreedly::Error::Forbidden)      
+    end    
+  end
+
+  describe "#allow_free_trial" do
+    before(:each) do
+      @subscriber = RSpreedly::Subscriber.new(:customer_id => 42)
+    end
+    
+    it "should return true if successful" do
+      stub_http_with_fixture("free_plan_success.xml", 200)     
+      @subscriber.allow_free_trial.should be_true
+    end    
+    
+    it "should update the subscriber if successful" do
+      stub_http_with_fixture("free_plan_success.xml", 200)           
+      lambda{
+        @subscriber.allow_free_trial
+      }.should change(@subscriber, :grace_until).to(Time.parse("2013-05-02T00:07:37Z"))
+    end
+    
+    it "should raise NotFound if the subscriber doesn't exist" do
+      stub_http_with_fixture("subscriber_not_found.xml", 404)    
+      lambda{
+        @subscriber.allow_free_trial
+      }.should raise_error(RSpreedly::Error::NotFound)      
+    end
+  end
+end

data/spec/subscription_plan_spec.rb

@@ -0,0 +1,36 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe RSpreedly::SubscriptionPlan do
+
+  describe ".find" do
+    describe "with the symbol :all" do
+      it "should pass to RSpreedly::SubscriptionPlan.all" do
+        RSpreedly::SubscriptionPlan.should_receive(:all)
+        RSpreedly::SubscriptionPlan.find(:all)
+      end      
+    end
+
+    it "should return nil with an id for a plan which doesn't exist" do
+      stub_http_with_fixture("subscription_plan_list.xml", 200)
+      RSpreedly::SubscriptionPlan.find(99).should be_nil
+    end
+
+    it "should return a SubscriptionPlan with an id for an existing plan" do
+      stub_http_with_fixture("subscription_plan_list.xml", 200)
+      RSpreedly::SubscriptionPlan.find(42).should be_a(RSpreedly::SubscriptionPlan)
+    end
+  end
+
+  describe ".all" do
+    it "should return an empty array if there are no plans" do
+      stub_http_with_fixture("no_plans.xml", 200)
+      RSpreedly::SubscriptionPlan.all.should == []
+    end
+
+    it "should return an array of SubscriptionPlans if there are any to find" do
+      stub_http_with_fixture("subscription_plan_list.xml", 200)
+      RSpreedly::SubscriptionPlan.all.size.should == 4 # there are 4 in the fixture
+      RSpreedly::SubscriptionPlan.all.select{|x| x.is_a?(RSpreedly::SubscriptionPlan )}.size.should == 4
+    end
+  end
+end