spreedly 1.2.2 → 1.3.0

data/History.txt

@@ -1,3 +1,8 @@
+=== 1.3.0 / 2009-06-04
+
+* Properly handle invalid Subscriber lookup [karnowski].
+* Added support for stopping auto renew [scottmotte, dsimard].
+
 === 1.2.2 / 2009-05-11
 
 * Fixed an error in the README [karnowski].

data/Rakefile

@@ -9,6 +9,7 @@ Hoe.new('spreedly', Spreedly::VERSION) do |project|
   project.rubyforge_name = 'terralien'
   project.developer('Nathaniel Talbott', 'nathaniel@terralien.com')
   project.test_globs = ["test/**/*_test.rb"]
+  project.extra_deps = ["mechanize"]
   project.extra_dev_deps = ["thoughtbot-shoulda"]
 end
 

data/lib/spreedly/mock.rb

@@ -23,7 +23,7 @@ module Spreedly
     end
     
     def initialize(params={})
-      @attributes = params
+      @attributes = params.inject({}){|a,(k,v)| a[k.to_sym] = v; a}
       self.class.attributes.each{|k,v| @attributes[k] = v.call}
     end
     
@@ -50,7 +50,8 @@ module Spreedly
       :store_credit => proc{BigDecimal("0.0")},
       :active_until => proc{nil},
       :feature_level => proc{""},
-      :on_trial => proc{false}
+      :on_trial => proc{false},
+      :recurring => proc{false}
     }
 
     def self.wipe! # :nodoc: all
@@ -58,7 +59,7 @@ module Spreedly
     end
     
     def self.create!(id, email=nil, screen_name=nil) # :nodoc: all
-      sub = new({:id => id, :email => email, :screen_name => screen_name})
+      sub = new({:customer_id => id, :email => email, :screen_name => screen_name})
 
       if subscribers[sub.id]
         raise "Could not create subscriber: already exists."
@@ -91,6 +92,10 @@ module Spreedly
       end
     end
     
+    def id
+      @attributes[:customer_id]
+    end
+    
     def comp(quantity, units, feature_level=nil)
       raise "Could not comp subscriber: no longer exists." unless self.class.find(id)
       raise "Could not comp subscriber: validation failed." unless units && quantity
@@ -112,6 +117,16 @@ module Spreedly
       @attributes[:active] = true
       @attributes[:on_trial] = true
     end
+
+    def stop_auto_renew
+      raise "Could not stop auto renew for subscriber: subscriber does not exist." unless self.class.find(id)
+      @attributes[:recurring] = false
+    end
+    
+    def subscribe(plan_id)
+      @attributes[:active] = true
+      @attributes[:recurring] = true
+    end
   end
   
   class SubscriptionPlan < Resource
@@ -124,7 +139,11 @@ module Spreedly
     end
     
     def self.plans
-      @plans ||= {1 => new(:id => 1, :name => 'Default mock plan'), 2 => new(:id => 2, :name => 'Test Free Trial Plan', :plan_type => 'free_trial')}
+      @plans ||= {
+        1 => new(:id => 1, :name => 'Default mock plan'),
+        2 => new(:id => 2, :name => 'Test Free Trial Plan', :plan_type => 'free_trial'),
+        3 => new(:id => 3, :name => 'Test Regular Plan'),
+      }
     end
     
     def trial?

data/lib/spreedly/version.rb

@@ -1,3 +1,3 @@
 module Spreedly
-  VERSION = "1.2.2"
+  VERSION = "1.3.0"
 end

data/lib/spreedly.rb

@@ -116,7 +116,8 @@ module Spreedly
     
     # Looks a subscriber up by id.
     def self.find(id)
-      new(Spreedly.get("/subscribers/#{id}.xml")['subscriber'])
+      xml = Spreedly.get("/subscribers/#{id}.xml")
+      (xml.nil? ? nil : new(xml['subscriber']))
     end
     
     # Returns all the subscribers in your site.
@@ -156,10 +157,10 @@ module Spreedly
     end
     
     # Activates a free trial on the subscriber.
-    # Requires subscription_id of the free trial plan
-    def activate_free_trial(subscription_id)
+    # Requires plan_id of the free trial plan
+    def activate_free_trial(plan_id)
       result = Spreedly.post("/subscribers/#{id}/subscribe_to_free_trial.xml", :body => 
-        Spreedly.to_xml_params(:subscription_plan => {:id => subscription_id}))
+        Spreedly.to_xml_params(:subscription_plan => {:id => plan_id}))
       case result.code
       when /2../
       when '404'
@@ -173,6 +174,19 @@ module Spreedly
       end
     end
     
+    # Stop the auto renew of the subscriber such that their recurring subscription will no longer be renewed.
+    # usage: @subscriber.stop_auto_renew
+    def stop_auto_renew
+      result = Spreedly.post("/subscribers/#{id}/stop_auto_renew.xml")
+      case result.code
+      when /2../
+      when '404'
+        raise "Could not stop auto renew for subscriber: subscriber does not exist."
+      else
+        raise "Could not stop auto renew for subscriber: result code #{result.code}."
+      end
+    end
+    
   end
   
   class SubscriptionPlan < Resource

data/test/spreedly_gem_test.rb

@@ -1,3 +1,4 @@
+require 'rubygems'
 require 'test/unit'
 require 'shoulda'
 require 'yaml'
@@ -5,6 +6,7 @@ require 'pp'
 
 if ENV["SPREEDLY_TEST"] == "REAL"
   require 'spreedly'
+  require 'spreedly/test_hacks'
 else
   require 'spreedly/mock'
 end
@@ -45,10 +47,15 @@ class SpreedlyGemTest < Test::Unit::TestCase
       assert_nil subscriber.active_until
     end
     
+    should "return nil when getting a subscriber that does NOT exist" do
+      assert_nil Spreedly::Subscriber.find("junk")
+    end
+    
     should "expose and parse attributes" do
       subscriber = create_subscriber
       assert_kind_of Time, subscriber.created_at
       assert_equal false, subscriber.active
+      assert_equal false, subscriber.recurring
       assert_equal BigDecimal('0.0'), subscriber.store_credit
     end
     
@@ -190,6 +197,33 @@ class SpreedlyGemTest < Test::Unit::TestCase
       end
     end
     
+    context "with a Regular plan" do
+      setup do
+        @regular_plan = Spreedly::SubscriptionPlan.all.detect{|e| e.name == "Test Regular Plan"}
+        assert @regular_plan, "For this test to pass in REAL mode you must have a regular plan in your Spreedly test site with the name \"Test Regular Plan\"."
+      end
+
+      should "stop auto renew for subscriber" do
+        subscriber = create_subscriber
+        subscriber.subscribe(@regular_plan.id)
+        
+        subscriber = Spreedly::Subscriber.find(subscriber.id)
+        assert subscriber.active?
+        assert subscriber.recurring
+
+        subscriber.stop_auto_renew
+        subscriber = Spreedly::Subscriber.find(subscriber.id)
+        assert subscriber.active?
+        assert !subscriber.recurring
+      end
+    end
+    
+    should "throw an error if stopping auto renew on a non-existent subscriber" do
+      sub = Spreedly::Subscriber.new('customer_id' => 'bogus')
+      ex = assert_raise(RuntimeError){sub.stop_auto_renew}
+      assert_match %r{does not exist}, ex.message
+    end
+
     only_real do
       should "throw an error if comp is wrong type" do
         sub = create_subscriber

data/test/test_site.yml

@@ -1,2 +1,2 @@
 name: terralien-test
-token: 3a8233463b5f8150d8bab0d2e7bac9272fc31763
+token: 781651cf01c65b7f0c8f6565723ea60436e87a56

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: spreedly
 version: !ruby/object:Gem::Version 
-  version: 1.2.2
+  version: 1.3.0
 platform: ruby
 authors: 
 - Nathaniel Talbott
@@ -9,9 +9,19 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-05-11 00:00:00 -04:00
+date: 2009-06-04 00:00:00 -04:00
 default_executable: 
 dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: mechanize
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
 - !ruby/object:Gem::Dependency 
   name: thoughtbot-shoulda
   type: :development