saucy 0.8.5 → 0.9.0

data/CHANGELOG.md

@@ -1,3 +1,24 @@
+0.9.0
+
+Added billed observer event.
+
+Extracted and renamed the observer/notification code.
+If you register any observers, you should update your code from:
+
+    Saucy::Configuration.observe(my_observer)
+
+to:
+
+    Saucy::Notifications.register_observer(my_observer)
+
+0.8.6
+
+For each notification event, only notify observers that respond_to that event.
+
+0.8.5
+
+Added plan_downgraded observer event.
+
 0.8.3
 
 Added coupon support. In your app, add the following migration:

data/app/controllers/accounts_controller.rb

@@ -9,8 +9,8 @@ class AccountsController < ApplicationController
   def new
     @plan = Plan.find(params[:plan_id])
     @signup = Signup.new
-    Saucy::Configuration.notify("plan_viewed", :request => request,
-                                               :plan    => @plan)
+    Saucy::Notifications.notify_observers("plan_viewed", :request => request,
+                                                         :plan    => @plan)
   end
 
   def create
@@ -22,8 +22,8 @@ class AccountsController < ApplicationController
     @signup.plan   = @plan
 
     if @signup.save
-      Saucy::Configuration.notify("account_created", :request => request,
-                                                     :account => @signup.account)
+      Saucy::Notifications.notify_observers("account_created", :request => request,
+                                                               :account => @signup.account)
       flash[:success] = "Account was created."
       sign_in @signup.user
       redirect_to new_account_project_path(@signup.account)

data/app/controllers/plans_controller.rb

@@ -32,10 +32,10 @@ class PlansController < ApplicationController
   end
 
   def notify_observers(event_name, from_plan, to_plan)
-    Saucy::Configuration.notify(event_name,
-                                :account   => @account,
-                                :request   => request,
-                                :from_plan => from_plan,
-                                :to_plan   => to_plan)
+    Saucy::Notifications.notify_observers(event_name,
+                                          :account   => @account,
+                                          :request   => request,
+                                          :from_plan => from_plan,
+                                          :to_plan   => to_plan)
   end
 end

data/lib/saucy/configuration.rb

@@ -6,24 +6,11 @@ module Saucy
     cattr_accessor :manager_email_address
     cattr_accessor :support_email_address
     cattr_accessor :merchant_account_id
-    cattr_accessor :observers
 
     def initialize
       @@manager_email_address = 'manager@example.com'
       @@support_email_address = 'support@example.com'
-      @@layouts       = Layouts.new
-      @@observers     = []
-    end
-
-    def self.observe(observer)
-      @@observers << observer
-    end
-
-    def self.notify(event, data)
-      @@observers.each do |observer|
-        observer.send(event, data)
-      end
+      @@layouts = Layouts.new
     end
   end
 end
-

data/lib/saucy/notifications.rb

@@ -0,0 +1,21 @@
+require 'saucy/layouts'
+
+module Saucy
+  module Notifications
+    @@observers = []
+
+    def self.clear_observers
+      @@observers = []
+    end
+
+    def self.register_observer(observer)
+      @@observers << observer
+    end
+
+    def self.notify_observers(event, data)
+      @@observers.each do |observer|
+        observer.send(event, data) if observer.respond_to?(event)
+      end
+    end
+  end
+end

data/lib/saucy/subscription.rb

@@ -229,6 +229,7 @@ module Saucy
             BillingMailer.problem(account, account.subscription.transactions.last).deliver!
           else
             BillingMailer.receipt(account, account.subscription.transactions.last).deliver!
+            Saucy::Notifications.notify_observers("billed", :account => account)
           end
         end
       end

data/lib/saucy.rb

@@ -5,6 +5,7 @@ require 'saucy/project'
 require 'saucy/plan'
 require 'saucy/account_authorization'
 require 'saucy/configuration'
+require 'saucy/notifications'
 require 'saucy/engine'
 require 'saucy/projects_controller'
 require 'saucy/coupons'

data/spec/models/invitation_spec.rb

@@ -39,11 +39,11 @@ describe Invitation, "saved" do
     subject.account_name.should == subject.account.name
   end
 
-  it "defauls new user email to invited email" do
+  it "defaults new user email to invited email" do
     subject.new_user_email.should == subject.email
   end
 
-  it "defauls existing user email to invited email" do
+  it "defaults existing user email to invited email" do
     subject.authenticating_user_email.should == subject.email
   end
 
@@ -211,11 +211,11 @@ describe Invitation, "saved" do
     subject.account_name.should == subject.account.name
   end
 
-  it "defauls new user email to invited email" do
+  it "defaults new user email to invited email" do
     subject.new_user_email.should == subject.email
   end
 
-  it "defauls existing user email to invited email" do
+  it "defaults existing user email to invited email" do
     subject.authenticating_user_email.should == subject.email
   end
 

data/spec/models/subscription_spec.rb

@@ -306,78 +306,95 @@ describe Account, "with a paid subscription" do
     end
   end
 
-  it "gets marked as not past due and updates its next_billing_date when the subscription is active after its billing date" do
-    subscription = FakeBraintree.subscriptions[subject.subscription_token]
-    subscription["status"] = Braintree::Subscription::Status::Active
-    subscription["next_billing_date"] = 2.months.from_now
-    FakeBraintree.transaction = { :status => Braintree::Transaction::Status::Settled,
-                                  :subscription_id => subject.subscription_token }
-    subscription["transactions"] = [FakeBraintree.generated_transaction]
-
-    Timecop.travel(subject.next_billing_date + 1.day) do
-      Account.update_subscriptions!
-      subject.reload.subscription_status.should == Braintree::Subscription::Status::Active
-      subject.next_billing_date.to_s.should == subscription["next_billing_date"].to_s
+  context "when billing didn't work" do
+    let(:subscription) { FakeBraintree.subscriptions[subject.subscription_token] }
+
+    before do
+      subscription["status"] = Braintree::Subscription::Status::PastDue
+      subscription["next_billing_date"] = 2.months.from_now
+      FakeBraintree.transaction = { :status => Braintree::Transaction::Status::Failed,
+                                    :subscription_id => subject.subscription_token }
+      subscription["transactions"] = [FakeBraintree.generated_transaction]
     end
-  end
 
-  it "receives a receipt email at it's billing email with transaction details" do
-    subscription = FakeBraintree.subscriptions[subject.subscription_token]
-    subscription["status"] = Braintree::Subscription::Status::Active
-    subscription["next_billing_date"] = 2.months.from_now
-    FakeBraintree.transaction = { :status => Braintree::Transaction::Status::Settled,
-                                  :subscription_id => subject.subscription_token }
-    subscription["transactions"] = [FakeBraintree.generated_transaction]
+    it "receives a receipt email at it's billing email with a notice that it failed when billing didn't work" do
+      Timecop.travel(subject.next_billing_date + 1.day) do
+        ActionMailer::Base.deliveries.clear
 
-    Timecop.travel(subject.next_billing_date + 1.day) do
-      ActionMailer::Base.deliveries.clear
+        Account.update_subscriptions!
 
-      Account.update_subscriptions!
+        ActionMailer::Base.deliveries.any? do |email|
+          email.to == [subject.billing_email] &&
+          email.subject =~ /problem/i
+        end.should be
+      end
+    end
 
-      ActionMailer::Base.deliveries.any? do |email|
-        email.to == [subject.billing_email] &&
-        email.subject =~ /receipt/i
-      end.should be
+    it "does not notify observers of billing when billing didn't work" do
+      Timecop.travel(subject.next_billing_date + 1.day) do
+        Account.update_subscriptions!
+        should_not notify_observers("billed", :account => subject)
+      end
     end
   end
 
-  it "doesn't receive a receipt email when it's already been billed" do
-    subscription = FakeBraintree.subscriptions[subject.subscription_token]
-    subscription["status"] = Braintree::Subscription::Status::Active
-    subscription["next_billing_date"] = 2.months.from_now
-    FakeBraintree.transaction = { :status => Braintree::Transaction::Status::Settled,
-                                  :subscription_id => subject.subscription_token }
-    subscription["transactions"] = [FakeBraintree.generated_transaction]
+  context "and an active subscription due 2 months from now" do
+    let(:subscription) { FakeBraintree.subscriptions[subject.subscription_token] }
 
-    Timecop.travel(subject.next_billing_date - 1.day) do
-      ActionMailer::Base.deliveries.clear
+    before do
+      subscription["status"] = Braintree::Subscription::Status::Active
+      subscription["next_billing_date"] = 2.months.from_now
+      FakeBraintree.transaction = { :status => Braintree::Transaction::Status::Settled,
+                                    :subscription_id => subject.subscription_token }
+      subscription["transactions"] = [FakeBraintree.generated_transaction]
+    end
 
-      Account.update_subscriptions!
+    it "gets marked as not past due and updates its next_billing_date when the subscription is active after its billing date" do
+      Timecop.travel(subject.next_billing_date + 1.day) do
+        Account.update_subscriptions!
+        subject.reload.subscription_status.should == Braintree::Subscription::Status::Active
+        subject.next_billing_date.to_s.should == subscription["next_billing_date"].to_s
+      end
+    end
+
+    it "receives a receipt email at it's billing email with transaction details" do
+      Timecop.travel(subject.next_billing_date + 1.day) do
+        ActionMailer::Base.deliveries.clear
+
+        Account.update_subscriptions!
 
-      ActionMailer::Base.deliveries.select do |email|
-        email.to == [subject.billing_email] &&
-        email.subject =~ /receipt/i
-      end.should be_empty
+        ActionMailer::Base.deliveries.any? do |email|
+          email.to == [subject.billing_email] &&
+          email.subject =~ /receipt/i
+        end.should be
+      end
     end
-  end
 
-  it "receives a receipt email at it's billing email with a notice that it failed when billing didn't work" do
-    subscription = FakeBraintree.subscriptions[subject.subscription_token]
-    subscription["status"] = Braintree::Subscription::Status::PastDue
-    subscription["next_billing_date"] = 2.months.from_now
-    FakeBraintree.transaction = { :status => Braintree::Transaction::Status::Failed,
-                                  :subscription_id => subject.subscription_token }
-    subscription["transactions"] = [FakeBraintree.generated_transaction]
+    it "notifies observers of billing" do
+      Timecop.travel(subject.next_billing_date + 1.day) do
+        Account.update_subscriptions!
+        should notify_observers("billed", :account => subject)
+      end
+    end
 
-    Timecop.travel(subject.next_billing_date + 1.day) do
-      ActionMailer::Base.deliveries.clear
+    it "doesn't receive a receipt email when it's already been billed" do
+      Timecop.travel(subject.next_billing_date - 1.day) do
+        ActionMailer::Base.deliveries.clear
 
-      Account.update_subscriptions!
+        Account.update_subscriptions!
+
+        ActionMailer::Base.deliveries.select do |email|
+          email.to == [subject.billing_email] &&
+          email.subject =~ /receipt/i
+        end.should be_empty
+      end
+    end
 
-      ActionMailer::Base.deliveries.any? do |email|
-        email.to == [subject.billing_email] &&
-        email.subject =~ /problem/i
-      end.should be
+    it "does not notify observers of billing when it's already been billed" do
+      Timecop.travel(subject.next_billing_date - 1.day) do
+        Account.update_subscriptions!
+        should_not notify_observers("billed", :account => subject)
+      end
     end
   end
 end

data/spec/{saucy_spec.rb → saucy/configuration_spec.rb}

@@ -17,23 +17,6 @@ describe Saucy::Configuration do
     subject.merchant_account_id.should be_nil
   end
 
-  it "can listen for events" do
-    observer = stub("an observer")
-    cleanup_observers do
-      Saucy::Configuration.observe(observer)
-      Saucy::Configuration.observers.should include(observer)
-    end
-  end
-
-  it "can notify observers" do
-    observer = stub("an observer", :some_event => nil)
-    cleanup_observers do
-      Saucy::Configuration.observe(observer)
-      Saucy::Configuration.notify("some_event", "some_data")
-      observer.should have_received("some_event").with("some_data")
-    end
-  end
-
   it "can assign a manager email address" do
     old_address = subject.manager_email_address
     begin
@@ -53,10 +36,4 @@ describe Saucy::Configuration do
       subject.support_email_address = old_address
     end
   end
-
-  def cleanup_observers
-    yield
-  ensure
-    subject.observers.clear
-  end
 end

data/spec/saucy/notifications_spec.rb

@@ -0,0 +1,50 @@
+require 'spec_helper'
+
+describe Saucy::Notifications do
+  let(:observer_class) do
+    Class.new do
+      def some_event(*args)
+      end
+    end
+  end
+
+  it "can notify observers" do
+    observer = observer_class.new
+    observer.stubs(:some_event => true)
+
+    cleanup_observers do
+      Saucy::Notifications.register_observer(observer)
+      Saucy::Notifications.notify_observers("some_event", "some_data")
+      observer.should have_received("some_event").with("some_data")
+    end
+  end
+
+  it "only notifies observers that respond to a given event" do
+    observer = Object.new
+
+    cleanup_observers do
+      expect do
+        Saucy::Notifications.register_observer(observer)
+        Saucy::Notifications.notify_observers("some_event", "some_data")
+      end.should_not raise_error
+    end
+  end
+
+  it "can clear its observers" do
+    observer = observer_class.new
+    observer.stubs(:some_event => true)
+
+    cleanup_observers do
+      Saucy::Notifications.register_observer(observer)
+      Saucy::Notifications.clear_observers
+      Saucy::Notifications.notify_observers("some_event", "some_data")
+      observer.should_not have_received("some_event").with("some_data")
+    end
+  end
+
+  def cleanup_observers
+    yield
+  ensure
+    subject.clear_observers
+  end
+end

data/spec/support/notifications.rb

@@ -24,12 +24,20 @@ class RecordedEvent
 end
 
 class RecordingObserver
-  attr_reader :events
+  def self.instance
+    @@instance ||= self.new
+  end
+
+  attr_accessor :events
 
   def initialize
     @events = []
   end
 
+  def respond_to?(message)
+    true
+  end
+
   def method_missing(name, data)
     @events << RecordedEvent.new(name, data)
   end
@@ -46,12 +54,14 @@ RSpec::Matchers.define :notify_observers do |event_name, data|
   end
 
   def recorder
-    Saucy::Configuration.observers.last
+    RecordingObserver.instance
   end
 end
 
 RSpec.configure do |config|
   config.before do
-    Saucy::Configuration.observers = [RecordingObserver.new]
+    Saucy::Notifications.clear_observers
+    Saucy::Notifications.register_observer(RecordingObserver.instance)
+    RecordingObserver.instance.events = []
   end
 end

metadata

@@ -1,19 +1,21 @@
 --- !ruby/object:Gem::Specification 
 name: saucy
 version: !ruby/object:Gem::Version 
-  hash: 53
+  hash: 59
   prerelease: 
   segments: 
   - 0
-  - 8
-  - 5
-  version: 0.8.5
+  - 9
+  - 0
+  version: 0.9.0
 platform: ruby
 authors: 
 - thoughtbot, inc.
 - Joe Ferris
 - Mike Burns
 - Chad Pytel
+- Jason Morrison
+- Ben Orenstein
 autorequire: 
 bindir: bin
 cert_chain: []
@@ -22,9 +24,7 @@ date: 2011-06-28 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  prerelease: false
-  type: :runtime
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -35,12 +35,12 @@ dependencies:
         - 11
         - 0
         version: 0.11.0
+  requirement: *id001
   name: clearance
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
   prerelease: false
   type: :runtime
-  requirement: &id002 !ruby/object:Gem::Requirement 
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -50,12 +50,12 @@ dependencies:
         - 1
         - 2
         version: "1.2"
+  requirement: *id002
   name: formtastic
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
   prerelease: false
   type: :runtime
-  requirement: &id003 !ruby/object:Gem::Requirement 
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -66,12 +66,12 @@ dependencies:
         - 0
         - 3
         version: 3.0.3
+  requirement: *id003
   name: railties
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
   prerelease: false
   type: :runtime
-  requirement: &id004 !ruby/object:Gem::Requirement 
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -82,12 +82,12 @@ dependencies:
         - 6
         - 2
         version: 2.6.2
+  requirement: *id004
   name: braintree
-  version_requirements: *id004
-- !ruby/object:Gem::Dependency 
   prerelease: false
   type: :runtime
-  requirement: &id005 !ruby/object:Gem::Requirement 
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - "="
@@ -98,12 +98,12 @@ dependencies:
         - 3
         - 3
         version: 1.3.3
+  requirement: *id005
   name: sham_rack
-  version_requirements: *id005
-- !ruby/object:Gem::Dependency 
   prerelease: false
   type: :runtime
-  requirement: &id006 !ruby/object:Gem::Requirement 
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -114,12 +114,12 @@ dependencies:
         - 1
         - 2
         version: 1.1.2
+  requirement: *id006
   name: sinatra
-  version_requirements: *id006
-- !ruby/object:Gem::Dependency 
   prerelease: false
-  type: :development
-  requirement: &id007 !ruby/object:Gem::Requirement 
+  type: :runtime
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id007 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - "="
@@ -130,8 +130,10 @@ dependencies:
         - 2
         - 6
         version: 0.2.6
+  requirement: *id007
   name: aruba
-  version_requirements: *id007
+  prerelease: false
+  type: :development
 description: Clearance-based Rails engine for Software as a Service (Saas) that provides account and project management
 email: support@thoughtbot.com
 executables: []
@@ -231,6 +233,7 @@ files:
 - lib/saucy/engine.rb
 - lib/saucy/fake_braintree.rb
 - lib/saucy/layouts.rb
+- lib/saucy/notifications.rb
 - lib/saucy/plan.rb
 - lib/saucy/project.rb
 - lib/saucy/projects_controller.rb
@@ -283,7 +286,8 @@ files:
 - spec/models/subscription_spec.rb
 - spec/models/user_spec.rb
 - spec/route_extensions_spec.rb
-- spec/saucy_spec.rb
+- spec/saucy/configuration_spec.rb
+- spec/saucy/notifications_spec.rb
 - spec/scaffold/config/routes.rb
 - spec/spec_helper.rb
 - spec/support/authentication_helpers.rb