spreedly 1.3.1 → 1.3.2

data/History.txt

@@ -1,3 +1,12 @@
+=== 1.3.2
+
+* Added methods on subscriber: update, allow_free_trial, 
+  add_fee [mateuszzawisza]
+* Fixing tests: generate spreedly url and edit url working with all 
+  site names [mateuszzawisza]
+* Add support for pre-population of the subscribe page via the subscribe
+  url. [davemcp]
+
 === 1.3.1
 
 * Handle new error reporting when creating a subscriber.

data/Rakefile

@@ -8,7 +8,7 @@ hoe = Hoe.spec('spreedly') do
   self.rubyforge_name = 'terralien'
   self.test_globs = ["test/**/*_test.rb"]
   self.extra_deps << ["mechanize"]
-  self.extra_dev_deps << ["thoughtbot-shoulda"]
+  self.extra_dev_deps << ["shoulda"]
 end
 
 def remove_task(*task_names)
@@ -37,7 +37,7 @@ end
 
 desc "Publish documentation."
 replace_task :publish_docs => [:clean, :docs] do
-  host = "terralien@terralien.biz"
+  host = "terralien@terralien.com"
 
   remote_dir = "/var/www/terralien/www/shared/static/projects/spreedly-gem"
   local_dir = 'doc'
@@ -69,4 +69,4 @@ replace_task :multi do
   ruby hoe.make_test_cmd(:multi)
   ENV["SPREEDLY_TEST"] = "REAL"
   ruby hoe.make_test_cmd(:multi)
-end
+end

data/lib/spreedly.rb

@@ -107,7 +107,7 @@ module Spreedly
     #   Spreedly.Subscriber.create!(id, email, screen_name)
     #   Spreedly.Subscriber.create!(id, :email => email, :screen_name => screen_name)
     #   Spreedly.Subscriber.create!(id, email, screen_name, :billing_first_name => first_name)
-    def self.create!(id, *args)
+    def self.create!(id, *args)      
       optional_attrs = args.last.is_a?(::Hash) ? args.pop : {}
       email, screen_name = args
       subscriber = {:customer_id => id, :email => email, :screen_name => screen_name}.merge(optional_attrs)
@@ -152,6 +152,7 @@ module Spreedly
     def comp(quantity, units, feature_level=nil)
       params = {:duration_quantity => quantity, :duration_units => units}
       params[:feature_level] = feature_level if feature_level
+      raise "Feature level is required to comp an inactive subscriber" if !active? and !feature_level
       endpoint = (active? ? "complimentary_time_extensions" : "complimentary_subscriptions")
       result = Spreedly.post("/subscribers/#{id}/#{endpoint}.xml", :body => Spreedly.to_xml_params(endpoint[0..-2] => params))
       case result.code.to_s
@@ -198,8 +199,58 @@ module Spreedly
       end
     end
     
-  end
+    
+    
+    # Update a Subscriber
+    # usage: @subscriber.update(:email => email, :screen_name => screen_name)
+    def update(args)
+      result = Spreedly.put("/subscribers/#{id}.xml", :body => Spreedly.to_xml_params(:subscriber => args))
+
+      case result.code.to_s
+      when /2../
+      when '403'
+        raise "Could not update subscriber: new-customer-id is already in use."
+      when '404'
+        raise "Could not update subscriber: subscriber not found"
+      else
+        raise "Could not update subscriber: result code #{result.code}."
+      end
+    end
+
+
+    #  Allow Another Free Trial
+    # usage: @subscriber.allow_free_trial
+    def allow_free_trial
+      result = Spreedly.post("/subscribers/#{id}/allow_free_trial.xml")
+
+      case result.code.to_s
+      when /2../
+      else
+        raise "Could not allow subscriber to another trial: result code #{result.code}."
+      end
+    end
+
+
+    # Add a Fee to a Subscriber
+    # usage: @subscriber.add_fee(:amount => amount, :group => group_name, :description => description, :name => name)
+    def add_fee(args)
+      result = Spreedly.post("/subscribers/#{id}/fees.xml", :body => Spreedly.to_xml_params(:fee => args))
+
+      case result.code.to_s
+      when /2../
+      when '404'
+        raise "Not Found"
+      when '422'
+        raise "Unprocessable Entity - #{result.body}"
+      else
+        raise "Could not add fee to subscriber: result code #{result.code}."
+      end
+    end
   
+    
+  end
+ 
+
   class SubscriptionPlan < Resource
     # Returns all of the subscription plans defined in your site.
     def self.all

data/lib/spreedly/common.rb

@@ -10,9 +10,24 @@ require 'spreedly/version'
 
 module Spreedly
   # Generates a subscribe url for the given user id and plan.
-  def self.subscribe_url(id, plan, screen_name=nil)
-    screen_name = (screen_name ? URI.escape(screen_name) : "")
-    "https://spreedly.com/#{site_name}/subscribers/#{id}/subscribe/#{plan}/#{screen_name}"
+  # Options:
+  #   :screen_name => a screen name for the user (shows up in the admin UI)
+  #   :email => pre-populate the email field
+  #   :first_name => pre-populate the first name field
+  #   :last_name => pre-populate the last name field
+  def self.subscribe_url(id, plan, options={})
+    %w(screen_name email first_name last_name).each do |option|
+      options[option.to_sym] &&= URI.escape(options[option.to_sym])
+    end
+
+    screen_name = options.delete(:screen_name)
+    params = %w(email first_name last_name).select{|e| options[e.to_sym]}.collect{|e| "#{e}=#{options[e.to_sym]}"}.join('&')
+
+    url = "https://spreedly.com/#{site_name}/subscribers/#{id}/subscribe/#{plan}"
+    url << "/#{screen_name}" if screen_name
+    url << '?' << params unless params == ''
+
+    url
   end
   
   # Generates an edit subscriber for the given subscriber token. The

data/lib/spreedly/mock.rb

@@ -51,7 +51,8 @@ module Spreedly
       :active_until => proc{nil},
       :feature_level => proc{""},
       :on_trial => proc{false},
-      :recurring => proc{false}
+      :recurring => proc{false},
+      :eligible_for_free_trial => proc{false}
     }
 
     def self.wipe! # :nodoc: all
@@ -98,6 +99,14 @@ module Spreedly
       @attributes[:customer_id]
     end
     
+    def update(args)
+      args.each_pair do |key, value|
+        if @attributes.has_key?(key)
+          @attributes[key] = value
+        end
+      end
+    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
@@ -115,11 +124,15 @@ module Spreedly
     def activate_free_trial(plan_id)
       raise "Could not activate free trial for subscriber: validation failed. missing subscription plan id" unless plan_id
       raise "Could not active free trial for subscriber: subscriber or subscription plan no longer exists." unless self.class.find(id) && SubscriptionPlan.find(plan_id)
-      raise "Could not activate free trial for subscriber: subscription plan either 1) isn't a free trial, 2) the subscriber is not eligible for a free trial, or 3) the subscription plan is not enabled." if on_trial?
+      raise "Could not activate free trial for subscriber: subscription plan either 1) isn't a free trial, 2) the subscriber is not eligible for a free trial, or 3) the subscription plan is not enabled." if (on_trial? and !eligible_for_free_trial?)
       @attributes[:on_trial] = true
       plan = SubscriptionPlan.find(plan_id)
       comp(plan.duration_quantity, plan.duration_units, plan.feature_level)
     end
+    
+    def allow_free_trial
+      @attributes[:eligible_for_free_trial] = true  
+    end
 
     def stop_auto_renew
       raise "Could not stop auto renew for subscriber: subscriber does not exist." unless self.class.find(id)
@@ -131,6 +144,12 @@ module Spreedly
       plan = SubscriptionPlan.find(plan_id)
       comp(plan.duration_quantity, plan.duration_units, plan.feature_level)
     end
+    
+    def add_fee(args)
+      raise "Unprocessable Entity" unless (args.keys & [:amount, :group, :name]).size == 3
+      raise "Unprocessable Entity" unless active?
+      nil
+    end
   end
   
   class SubscriptionPlan < Resource

data/lib/spreedly/test_hacks.rb

@@ -5,7 +5,7 @@ module Spreedly
     # This method is *strictly* for use when testing, and will
     # probably only work against a test Spreedly site anyhow.
     def subscribe(plan_id)
-      agent = WWW::Mechanize.new
+      agent = Mechanize.new
       page = agent.get(Spreedly.subscribe_url(id, plan_id))
       page = page.forms.first.submit
       form = page.forms.first
@@ -21,4 +21,4 @@ module Spreedly
       raise "Subscription didn't got through" unless page.title == "Thank you!"
     end
   end
-end
+end

data/lib/spreedly/version.rb

@@ -1,3 +1,3 @@
 module Spreedly
-  VERSION = "1.3.1"
-end
+  VERSION = "1.3.2"
+end

data/test/spreedly_gem_test.rb

@@ -14,6 +14,7 @@ end
 test_site = YAML.load(File.read(File.dirname(__FILE__) + '/test_site.yml'))
 Spreedly.configure(test_site['name'], test_site['token'])
 
+
 class SpreedlyGemTest < Test::Unit::TestCase
   def self.only_real
     yield if ENV["SPREEDLY_TEST"] == "REAL"
@@ -58,6 +59,13 @@ class SpreedlyGemTest < Test::Unit::TestCase
       end
     end # adding a subscriber
     
+    should "update subscriber" do
+      subscriber = Spreedly::Subscriber.create!('joe', :screen_name => "big-joe")
+      assert_equal "big-joe", Spreedly::Subscriber.find(subscriber.id).screen_name
+      subscriber.update(:screen_name => "small-joe")
+      assert_equal "small-joe", Spreedly::Subscriber.find(subscriber.id).screen_name
+    end
+    
     should "get a subscriber" do
       id = create_subscriber.id
       subscriber = Spreedly::Subscriber.find(id)
@@ -69,10 +77,10 @@ class SpreedlyGemTest < Test::Unit::TestCase
     end
     
     should "expose and parse attributes" do
-      subscriber = create_subscriber
+      subscriber = create_subscriber('bob')
       assert_kind_of Time, subscriber.created_at
-      assert_equal false, subscriber.active
-      assert_equal false, subscriber.recurring
+      assert !subscriber.active
+      assert !subscriber.recurring
       assert_equal BigDecimal('0.0'), subscriber.store_credit
     end
     
@@ -107,14 +115,21 @@ class SpreedlyGemTest < Test::Unit::TestCase
     end
     
     should "generate a subscribe url" do
-      assert_equal "https://spreedly.com/terralien-test/subscribers/joe/subscribe/1/Joe%20Bob",
-        Spreedly.subscribe_url('joe', '1', "Joe Bob")
-      assert_equal "https://spreedly.com/terralien-test/subscribers/joe/subscribe/1/",
+      assert_equal "https://spreedly.com/#{Spreedly.site_name}/subscribers/joe/subscribe/1/Joe%20Bob",
+        Spreedly.subscribe_url('joe', '1', :screen_name => "Joe Bob")
+      assert_equal "https://spreedly.com/#{Spreedly.site_name}/subscribers/joe/subscribe/1",
         Spreedly.subscribe_url('joe', '1')
     end
     
+    should "generate a pre-populated subscribe url" do
+      assert_equal "https://spreedly.com/#{Spreedly.site_name}/subscribers/joe/subscribe/1?email=joe.bob@test.com&first_name=Joe&last_name=Bob",
+        Spreedly.subscribe_url('joe', '1', :email => "joe.bob@test.com", :first_name => "Joe", :last_name => "Bob")
+      assert_equal "https://spreedly.com/#{Spreedly.site_name}/subscribers/joe/subscribe/1?first_name=Joe&last_name=Bob",
+        Spreedly.subscribe_url('joe', '1', :first_name => "Joe", :last_name => "Bob")
+    end
+    
     should "generate an edit subscriber url" do
-      assert_equal "https://spreedly.com/terralien-test/subscriber_accounts/zetoken",
+      assert_equal "https://spreedly.com/#{Spreedly.site_name}/subscriber_accounts/zetoken",
         Spreedly.edit_subscriber_url('zetoken')
     end
     
@@ -133,7 +148,7 @@ class SpreedlyGemTest < Test::Unit::TestCase
     should "comp an active subscriber" do
       sub = create_subscriber
       assert !sub.active?
-      sub.comp(1, 'days')
+      sub.comp(1, 'days', 'Sweet!')
 
       sub = Spreedly::Subscriber.find(sub.id)
       assert sub.active?
@@ -149,7 +164,7 @@ class SpreedlyGemTest < Test::Unit::TestCase
       sub = create_subscriber
       Spreedly::Subscriber.wipe!
       ex = assert_raise(RuntimeError) do
-        sub.comp(1, 'days')
+        sub.comp(1, 'days', 'bogus')
       end
       assert_match(/exists/i, ex.message)
     end
@@ -157,7 +172,7 @@ class SpreedlyGemTest < Test::Unit::TestCase
     should "throw an error if comp is invalid" do
       sub = create_subscriber
       ex = assert_raise(RuntimeError) do
-        sub.comp(nil, nil)
+        sub.comp(nil, nil, 'bogus')
       end
       assert_match(/validation/i, ex.message)
       assert_raise(RuntimeError){sub.comp(1, nil)}
@@ -203,6 +218,16 @@ class SpreedlyGemTest < Test::Unit::TestCase
         assert_match %r{not eligible}, ex.message
       end
       
+      should "allow second trial if 'allow_free_trial' is excecuted" do
+        sub = create_subscriber
+        sub.activate_free_trial(@trial.id)
+        sub.allow_free_trial
+        sub.activate_free_trial(@trial.id)
+        sub = Spreedly::Subscriber.find(sub.id)
+        assert sub.active?
+        assert sub.on_trial?
+      end
+      
       should "throw errors on invalid free trial activation" do
         sub = create_subscriber
         
@@ -217,7 +242,7 @@ class SpreedlyGemTest < Test::Unit::TestCase
     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\"."
+        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\". It must be an auto-recurring plan."
       end
 
       should "stop auto renew for subscriber" do
@@ -235,6 +260,37 @@ class SpreedlyGemTest < Test::Unit::TestCase
       end
     end
     
+    context "adding fees" 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\". It must be an auto-recurring plan."
+      end
+      
+      should "be able to add fee to user" do
+        sub = create_subscriber
+        sub.subscribe(@regular_plan.id)
+        sub.add_fee(:name => "Daily Bandwidth Charge", :amount => "2.34", :description => "313 MB used", :group => "Traffic Fees")
+      end
+    
+      should "throw an error when add fee to not active user" do
+        sub = create_subscriber
+        ex = assert_raise(RuntimeError) do 
+          sub.add_fee(:name => "Daily Bandwidth Charge", :amount => "2.34", :description => "313 MB used", :group => "Traffic Fees")
+        end
+        assert_match %r{Unprocessable Entity}, ex.message
+      end
+    
+      should "throw an error when add fee with incomplete arguments" do
+        sub = create_subscriber
+        sub.subscribe(@regular_plan.id)
+        ex = assert_raise(RuntimeError) do 
+          sub.add_fee(:name => "Daily Bandwidth Charge", :description => "313 MB used", :group => "Traffic Fees")
+        end
+        assert_match %r{Unprocessable Entity}, ex.message        
+      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}
@@ -244,9 +300,9 @@ class SpreedlyGemTest < Test::Unit::TestCase
     only_real do
       should "throw an error if comp is wrong type" do
         sub = create_subscriber
-        sub.comp(1, 'days')
+        sub.comp(1, 'days', 'something')
         ex = assert_raise(RuntimeError) do
-          sub.comp(1, 'days')
+          sub.comp(1, 'days', 'something')
         end
         assert_match(/invalid/i, ex.message)
       end
@@ -256,4 +312,4 @@ class SpreedlyGemTest < Test::Unit::TestCase
   def create_subscriber(id=(rand*100000000).to_i, email=nil, screen_name=nil)
     Spreedly::Subscriber.create!(id, email, screen_name)
   end
-end
+end

data/test/test_site.yml

@@ -1,2 +1,2 @@
-name: terralien-test
-token: 781651cf01c65b7f0c8f6565723ea60436e87a56
+name: spreedlygem
+token: 44c633ef5522564f40a117c009ecb6852c0ce3f3

metadata

@@ -1,7 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: spreedly
 version: !ruby/object:Gem::Version 
-  version: 1.3.1
+  hash: 31
+  prerelease: false
+  segments: 
+  - 1
+  - 3
+  - 2
+  version: 1.3.2
 platform: ruby
 authors: 
 - Nathaniel Talbott
@@ -9,39 +15,69 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-09-11 00:00:00 -04:00
+date: 2010-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 
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
         version: "0"
-    version: 
+  type: :runtime
+  version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: thoughtbot-shoulda
+  name: rubyforge
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 2
+        - 0
+        - 4
+        version: 2.0.4
   type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: shoulda
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
         version: "0"
-    version: 
+  type: :development
+  version_requirements: *id003
 - !ruby/object:Gem::Dependency 
   name: hoe
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 2.3.3
-    version: 
+        hash: 23
+        segments: 
+        - 2
+        - 6
+        - 0
+        version: 2.6.0
+  type: :development
+  version_requirements: *id004
 description: |-
   The Spreedly gem provides a convenient Ruby wrapper for the goodness that is
   the http://spreedly.com API. Created by Terralien[http://terralien.com].
@@ -135,21 +171,27 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: terralien
-rubygems_version: 1.3.5
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: The Spreedly gem provides a convenient Ruby wrapper for the goodness that is the http://spreedly.com API