spreedly 1.3.0 → 1.3.1

data/History.txt

@@ -1,3 +1,10 @@
+=== 1.3.1
+
+* Handle new error reporting when creating a subscriber.
+* Use a more sane way of setting attributes in the mock, and make plans have a
+  plan type [seancribbs].
+* Allow optional arguments to be passed when creating subscribers [jaknowlden].
+
 === 1.3.0 / 2009-06-04
 
 * Properly handle invalid Subscriber lookup [karnowski].

data/Manifest.txt

@@ -6,6 +6,7 @@ TODO
 lib/spreedly.rb
 lib/spreedly/common.rb
 lib/spreedly/mock.rb
+lib/spreedly/test_hacks.rb
 lib/spreedly/version.rb
 test/spreedly_gem_test.rb
 test/test_site.yml

data/README.txt

@@ -1,6 +1,6 @@
 = Spreedly-Gem
 
-* Docs[http://terralien.com/static/projects/spreedly-gem/]
+* http://terralien.com/static/projects/spreedly-gem/
 * Source[http://github.com/terralien/spreedly-gem]
 
 == DESCRIPTION:

data/Rakefile

@@ -3,14 +3,12 @@ require './lib/spreedly/version.rb'
 
 ENV["COPYFILE_DISABLE"] = "true" # Lose all the fugly ._ files when tar'ing
 
-hoe = nil
-Hoe.new('spreedly', Spreedly::VERSION) do |project|
-  hoe = 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"]
+hoe = Hoe.spec('spreedly') do
+  developer('Nathaniel Talbott', 'nathaniel@terralien.com')
+  self.rubyforge_name = 'terralien'
+  self.test_globs = ["test/**/*_test.rb"]
+  self.extra_deps << ["mechanize"]
+  self.extra_dev_deps << ["thoughtbot-shoulda"]
 end
 
 def remove_task(*task_names)

data/lib/spreedly.rb

@@ -101,14 +101,25 @@ module Spreedly
     # Creates a new subscriber on Spreedly. The subscriber will NOT
     # be active - they have to pay or you have to comp them for that
     # to happen.
-    def self.create!(id, email=nil, screen_name=nil)
-      result = Spreedly.post('/subscribers.xml', :body => 
-        Spreedly.to_xml_params(:subscriber => {:customer_id => id, :email => email, :screen_name => screen_name}))
+    #
+    # Usage:
+    #   Spreedly.Subscriber.create!(id, email)
+    #   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)
+      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)
+      result = Spreedly.post('/subscribers.xml', :body => Spreedly.to_xml_params(:subscriber => subscriber))
       case result.code.to_s
       when /2../
         new(result['subscriber'])
       when '403'
-        raise "Could not create subscriber: no id passed OR already exists."
+        raise "Could not create subscriber: already exists."
+      when '422'
+        errors = [*result['errors']].collect{|e| e.last}
+        raise "Could not create subscriber: #{errors.join(', ')}"
       else
         raise "Could not create subscriber: result code #{result.code}."
       end
@@ -117,7 +128,7 @@ module Spreedly
     # Looks a subscriber up by id.
     def self.find(id)
       xml = Spreedly.get("/subscribers/#{id}.xml")
-      (xml.nil? ? nil : new(xml['subscriber']))
+      (xml.nil? || xml.empty? ? nil : new(xml['subscriber']))
     end
     
     # Returns all the subscribers in your site.
@@ -161,7 +172,7 @@ module Spreedly
     def activate_free_trial(plan_id)
       result = Spreedly.post("/subscribers/#{id}/subscribe_to_free_trial.xml", :body => 
         Spreedly.to_xml_params(:subscription_plan => {:id => plan_id}))
-      case result.code
+      case result.code.to_s
       when /2../
       when '404'
         raise "Could not active free trial for subscriber: subscriber or subscription plan no longer exists."
@@ -178,7 +189,7 @@ module Spreedly
     # usage: @subscriber.stop_auto_renew
     def stop_auto_renew
       result = Spreedly.post("/subscribers/#{id}/stop_auto_renew.xml")
-      case result.code
+      case result.code.to_s
       when /2../
       when '404'
         raise "Could not stop auto renew for subscriber: subscriber does not exist."
@@ -205,4 +216,4 @@ module Spreedly
       (plan_type == 'free_trial')
     end
   end
-end
+end

data/lib/spreedly/common.rb

@@ -21,4 +21,4 @@ module Spreedly
   def self.edit_subscriber_url(token)
     "https://spreedly.com/#{site_name}/subscriber_accounts/#{token}"
   end
-end
+end

data/lib/spreedly/mock.rb

@@ -23,8 +23,8 @@ module Spreedly
     end
     
     def initialize(params={})
-      @attributes = params.inject({}){|a,(k,v)| a[k.to_sym] = v; a}
-      self.class.attributes.each{|k,v| @attributes[k] = v.call}
+      @attributes = self.class.attributes.inject({}){|a,(k,v)| a[k.to_sym] = v.call; a}
+      params.each {|k,v| @attributes[k.to_sym] = v }
     end
     
     def id
@@ -58,8 +58,10 @@ module Spreedly
       @subscribers = nil
     end
     
-    def self.create!(id, email=nil, screen_name=nil) # :nodoc: all
-      sub = new({:customer_id => id, :email => email, :screen_name => screen_name})
+    def self.create!(id, *args) # :nodoc: all
+      optional_attrs = args.last.is_a?(::Hash) ? args.pop : {}
+      email, screen_name = args
+      sub = new({:customer_id => id, :email => email, :screen_name => screen_name}.merge(optional_attrs))
 
       if subscribers[sub.id]
         raise "Could not create subscriber: already exists."
@@ -88,7 +90,7 @@ module Spreedly
     def initialize(params={})
       super
       if !id || id == ''
-        raise "Could not create subscriber: no id passed OR already exists."
+        raise "Could not create subscriber: Customer ID can't be blank."
       end
     end
     
@@ -114,8 +116,9 @@ module Spreedly
       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?
-      @attributes[:active] = true
       @attributes[:on_trial] = true
+      plan = SubscriptionPlan.find(plan_id)
+      comp(plan.duration_quantity, plan.duration_units, plan.feature_level)
     end
 
     def stop_auto_renew
@@ -124,12 +127,18 @@ module Spreedly
     end
     
     def subscribe(plan_id)
-      @attributes[:active] = true
       @attributes[:recurring] = true
+      plan = SubscriptionPlan.find(plan_id)
+      comp(plan.duration_quantity, plan.duration_units, plan.feature_level)
     end
   end
   
   class SubscriptionPlan < Resource
+    self.attributes = {
+      :plan_type => proc{'regular'},
+      :feature_level => proc{''}
+    }
+    
     def self.all
       plans.values
     end
@@ -140,9 +149,9 @@ module Spreedly
     
     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'),
-        3 => new(:id => 3, :name => 'Test Regular Plan'),
+        1 => new(:id => 1, :name => 'Default mock plan', :duration_quantity => 1, :duration_units => 'days'),
+        2 => new(:id => 2, :name => 'Test Free Trial Plan', :plan_type => 'free_trial', :duration_quantity => 1, :duration_units => 'days'),
+        3 => new(:id => 3, :name => 'Test Regular Plan', :duration_quantity => 1, :duration_units => 'days'),
       }
     end
     

data/lib/spreedly/test_hacks.rb

@@ -0,0 +1,24 @@
+require 'mechanize'
+
+module Spreedly
+  class Subscriber
+    # 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
+      page = agent.get(Spreedly.subscribe_url(id, plan_id))
+      page = page.forms.first.submit
+      form = page.forms.first
+      form['credit_card[first_name]'] = 'Joe'
+      form['credit_card[last_name]'] = 'Bob'
+      form['subscriber[email]'] = 'joe@example.com'
+      form['credit_card[number]'] = '4222222222222'
+      form['credit_card[card_type]'] = 'visa'
+      form['credit_card[verification_value]'] = '234'
+      form['credit_card[month]'] = '1'
+      form['credit_card[year]'] = '2024'
+      page = form.click_button
+      raise "Subscription didn't got through" unless page.title == "Thank you!"
+    end
+  end
+end

data/lib/spreedly/version.rb

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

data/test/spreedly_gem_test.rb

@@ -34,12 +34,29 @@ class SpreedlyGemTest < Test::Unit::TestCase
       assert subscribers.size == 1
       assert_equal two.id, subscribers.first.id
     end
+
+    context "adding a subscriber" do
+      should "generate a token" do
+        subscriber = Spreedly::Subscriber.create!('joe')
+        assert_not_nil subscriber.token
+        assert_equal subscriber.token, Spreedly::Subscriber.find('joe').token
+      end
     
-    should "add a subscriber" do
-      subscriber = Spreedly::Subscriber.create!('joe')
-      assert_not_nil subscriber.token
-      assert_equal subscriber.token, Spreedly::Subscriber.find('joe').token
-    end
+      should "accept email address as an argument" do
+        subscriber = Spreedly::Subscriber.create!('joe', 'a@b.cd')
+        assert_equal 'a@b.cd', Spreedly::Subscriber.find('joe').email
+      end
+
+      should "accept screen name as an argument" do
+        subscriber = Spreedly::Subscriber.create!('joe', 'a@b.cd', 'tuna')
+        assert_equal 'tuna', Spreedly::Subscriber.find('joe').screen_name
+      end
+
+      should "accept optional arguments: like billing first name" do
+        subscriber = Spreedly::Subscriber.create!('joe', {:billing_first_name => 'Joe'})
+        assert_equal 'Joe', Spreedly::Subscriber.find('joe').billing_first_name
+      end
+    end # adding a subscriber
     
     should "get a subscriber" do
       id = create_subscriber.id
@@ -71,7 +88,7 @@ class SpreedlyGemTest < Test::Unit::TestCase
       ex = assert_raise(RuntimeError) do
         create_subscriber('')
       end
-      assert_match(/no id/i, ex.message)
+      assert_match(/customer id can't be blank/i, ex.message)
     end
     
     should "create with additional params" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: spreedly
 version: !ruby/object:Gem::Version 
-  version: 1.3.0
+  version: 1.3.1
 platform: ruby
 authors: 
 - Nathaniel Talbott
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-06-04 00:00:00 -04:00
+date: 2009-09-11 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -40,9 +40,11 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 1.12.2
+        version: 2.3.3
     version: 
-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].
+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].
 email: 
 - nathaniel@terralien.com
 executables: []
@@ -62,6 +64,7 @@ files:
 - lib/spreedly.rb
 - lib/spreedly/common.rb
 - lib/spreedly/mock.rb
+- lib/spreedly/test_hacks.rb
 - lib/spreedly/version.rb
 - test/spreedly_gem_test.rb
 - test/test_site.yml
@@ -122,7 +125,9 @@ files:
 - vendor/httparty/website/css/common.css
 - vendor/httparty/website/index.html
 has_rdoc: true
-homepage: Docs[http://terralien.com/static/projects/spreedly-gem/]
+homepage: http://terralien.com/static/projects/spreedly-gem/
+licenses: []
+
 post_install_message: 
 rdoc_options: 
 - --main
@@ -144,9 +149,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: terralien
-rubygems_version: 1.3.1
+rubygems_version: 1.3.5
 signing_key: 
-specification_version: 2
+specification_version: 3
 summary: The Spreedly gem provides a convenient Ruby wrapper for the goodness that is the http://spreedly.com API
 test_files: 
 - test/spreedly_gem_test.rb