subscription_fu 0.2.1 → 0.3.0

data/Gemfile

@@ -6,7 +6,6 @@ gemspec
 group :development, :test do
   gem 'rails'
   gem 'sqlite3'
-  gem 'rake', "0.8.7"
   gem 'haml'
   gem 'rspec', '>= 2.5.0'
   gem 'rspec-rails'

data/README.md

@@ -22,6 +22,10 @@ Then install the required files:
 
     rails g subscription_fu:install
 
+## Updating
+
+See UPDATING.md
+
 ## Configuration
 
  1. Edit config/initializers/subscription\_fu.rb (generated by the install generator)

data/UPDATING.md

@@ -0,0 +1,19 @@
+# Updating Subscriptions for Rails
+
+## From 0.2.x to 0.3.0
+
+Add the new table subscription_system_initiators using a migration:
+
+    class SubscriptionFuUpdateToZeroThree < ActiveRecord::Migration
+      def self.up
+        create_table "subscription_system_initiators" do |t|
+          t.string "name"
+          t.string "description"
+        end
+      end
+      def self.down
+        drop_table "subscription_system_initiators"
+      end
+    end
+
+

data/app/models/subscription_fu/subscription.rb

@@ -1,7 +1,7 @@
 class SubscriptionFu::Subscription < ActiveRecord::Base
   set_table_name :subscriptions
 
-  AVAILABLE_CANCEL_REASONS = %w( update cancel timeout admin )
+  AVAILABLE_CANCEL_REASONS = %w( update cancel gwcancel timeout admin )
 
   default_scope order("created_at ASC", "id ASC")
 
@@ -18,10 +18,23 @@ class SubscriptionFu::Subscription < ActiveRecord::Base
   validates :cancel_reason, :presence => true, :inclusion => AVAILABLE_CANCEL_REASONS, :if => :canceled?
 
   scope :activated, where("subscriptions.activated_at IS NOT NULL")
+  scope :not_canceled, activated.where("subscriptions.canceled_at IS NULL")
+  scope :using_paypal, where("subscriptions.paypal_profile_id IS NOT NULL")
   scope :current, lambda {|time| activated.where("subscriptions.starts_at <= ? AND (subscriptions.canceled_at IS NULL OR subscriptions.canceled_at > ?)", time, time) }
 
-  # TODO this should probably only take plan?key, prev_sub
-  def self.build_for_initializing(plan_key, start_time = Time.now, billing_start_time = start_time, prev_sub = nil)
+  def self.sync_all_from_gateway
+    SubscriptionFu::Subscription.using_paypal.not_canceled.each do |s|
+      s.sync_from_gateway!
+    end
+  end
+
+  def self.build_for_initializing(plan_key, prev_sub = nil)
+    if prev_sub
+      start_time = prev_sub.successor_start_date(plan_key)
+      billing_start_time = prev_sub.end_date_when_canceled
+    else
+      billing_start_time = start_time = Time.now
+    end
     new(:plan_key => plan_key, :starts_at => start_time, :billing_starts_at => billing_start_time, :prev_subscription => prev_sub)
   end
 
@@ -74,11 +87,11 @@ class SubscriptionFu::Subscription < ActiveRecord::Base
       Time.now
     else
       # otherwise they start with the next billing cycle
-      successor_billing_start_date
+      end_date_when_canceled
     end
   end
 
-  def successor_billing_start_date
+  def end_date_when_canceled
     # in case this plan was already canceled, this date takes
     # precedence (there won't be a next billing time anymore).
     canceled_at || next_billing_date || estimated_next_billing_date || Time.now
@@ -86,19 +99,28 @@ class SubscriptionFu::Subscription < ActiveRecord::Base
 
   # billing API
 
-  def initiate_activation(admin)
+  def initiate_activation(initiator)
     gateway = (plan.free_plan? || sponsored?) ? 'nogw' : 'paypal'
-    transactions.create_activation(gateway, admin).tap do |t|
+    transactions.create_activation(gateway, initiator).tap do |t|
       if prev_subscription
         to_cancel = [prev_subscription]
         to_cancel.push(*prev_subscription.next_subscriptions.where("subscriptions.id <> ?", self).all)
-        to_cancel.each {|s| s.initiate_cancellation(admin, t) }
+        to_cancel.each {|s| s.initiate_cancellation(initiator, t) }
       end
     end
   end
 
-  def initiate_cancellation(admin, activation_transaction)
-    transactions.create_cancellation(admin, activation_transaction, self)
+  def initiate_cancellation(initiator, activation_transaction)
+    transactions.create_cancellation(initiator, activation_transaction, self)
+  end
+
+  def sync_from_gateway!
+    if paypal?
+      if paypal_recurring_details[:status] == SubscriptionFu::Paypal::CANCELED_STATE
+        t = initiate_cancellation(SubscriptionFu::SystemInitiator.paypal_sync_initiator, nil)
+        t.complete(:effective => end_date_when_canceled, :reason => :gwcancel)
+      end
+    end
   end
 
   private

data/app/models/subscription_fu/system_initiator.rb

@@ -0,0 +1,7 @@
+class SubscriptionFu::SystemInitiator < ActiveRecord::Base
+  set_table_name :subscription_system_initiators
+
+  def self.paypal_sync_initiator
+    find_or_create_by_name("paypal sync", :description => "Updates subscription status based on status returned by Paypal")
+  end
+end

data/app/models/subscription_fu/transaction.rb

@@ -54,8 +54,11 @@ class SubscriptionFu::Transaction < ActiveRecord::Base
       update_attributes!(:status => "complete")
     rescue Exception => err
       if defined? ::ExceptionNotifier
-        data = (err.respond_to?(:data) ? err.data : {}).merge(:subscription => subscription.inspect, :transaction => self.inspect)
+        data = {:api_response => err.respond_to?(:response) ? err.response : nil, :subscription => subscription.inspect, :transaction => self.inspect}
         ::ExceptionNotifier::Notifier.background_exception_notification(err, :data => data).deliver
+      elsif defined? ::HoptoadNotifier
+        data = {:subscription => subscription.inspect, :transaction => self.inspect}
+        ::HoptoadNotifier.notify(err, :parameters => data)
       else
         logger.warn(err)
         logger.debug(err.backtrace.join("\n"))
@@ -125,10 +128,17 @@ class SubscriptionFu::Transaction < ActiveRecord::Base
   end
 
   def complete_cancellation_paypal(opts)
-    # update the record beforehand, because paypal raises an error if
-    # the profile is already cancelled
+    begin
+      SubscriptionFu::Paypal.express_request.renew!(sub_paypal_profile_id, :Cancel, :note => sub_cancel_reason)
+    rescue Paypal::Exception::APIError => err
+      if err.response.details.all?{|d| d.error_code == "11556"}
+        # 11556 - Invalid profile status for cancel action; profile should be active or suspended
+        logger.info("Got '#{err.response.details.inspect}' from paypal which indicates profile wasn't active (any more)...")
+      else
+        raise err
+      end
+    end
     complete_cancellation(opts)
-    SubscriptionFu::Paypal.express_request.renew!(sub_paypal_profile_id, :Cancel, :note => sub_cancel_reason)
   end
 
   def complete_cancellation_nogw(opts)

data/lib/generators/subscription_fu/templates/migration.rb

@@ -29,10 +29,16 @@ class CreateSubscriptionFuTables < ActiveRecord::Migration
 
     add_index "subscription_transactions", ["identifier"]
     add_index "subscription_transactions", ["subscription_id"]
+
+    create_table "subscription_system_initiators" do |t|
+      t.string "name"
+      t.string "description"
+    end
   end
 
   def self.down
     drop_table "subscriptions"
     drop_table "subscription_transactions"
+    drop_table "subscription_system_initiators"
   end
 end

data/lib/subscription_fu/models.rb

@@ -41,12 +41,7 @@ module SubscriptionFu
       end
 
       def build_next_subscription(plan_key)
-        if active_subscription
-          # TODO refactor
-          subscriptions.build_for_initializing(plan_key, active_subscription.successor_start_date(plan_key), active_subscription.successor_billing_start_date, active_subscription)
-        else
-          subscriptions.build_for_initializing(plan_key)
-        end
+        subscriptions.build_for_initializing(plan_key, active_subscription)
       end
     end
 

data/lib/subscription_fu/paypal.rb

@@ -3,6 +3,9 @@ require "paypal"
 module SubscriptionFu::Paypal
   UTC_TZ = ActiveSupport::TimeZone.new("UTC")
 
+  CANCELED_STATE = "Cancelled"
+  ACTIVE_STATE = "Active"
+
   def self.express_request
     config = SubscriptionFu.config
     ::Paypal::Express::Request.new(
@@ -13,7 +16,8 @@ module SubscriptionFu::Paypal
 
   def self.recurring_details(profile_id)
     res = SubscriptionFu::Paypal.express_request.subscription(profile_id)
-    { :next_billing_date => UTC_TZ.parse(res.recurring.summary.next_billing_date.to_s),
-      :last_payment_date => UTC_TZ.parse(res.recurring.summary.last_payment_date.to_s), }
+    { :status => res.recurring.status,
+      :next_billing_date => UTC_TZ.parse(res.recurring.summary.next_billing_date.to_s),
+      :last_payment_date => UTC_TZ.parse(res.recurring.summary.last_payment_date.to_s) }
   end
 end

data/lib/subscription_fu/railtie.rb

@@ -6,6 +6,9 @@ module SubscriptionFu
         include SubscriptionFu::Models
       end
     end
+    rake_tasks do
+      load "subscription_fu/rake.tasks"
+    end
   end
 end
 

data/lib/subscription_fu/rake.tasks

@@ -0,0 +1,6 @@
+namespace :subfu do
+  desc "sync subscriptions with gateways"
+  task :gwsync => :environment do
+    SubscriptionFu::Subscription.sync_all_from_gateway
+  end
+end

data/lib/subscription_fu/version.rb

@@ -1,3 +1,3 @@
 module SubscriptionFu
-  VERSION = "0.2.1"
+  VERSION = "0.3.0"
 end

data/spec/app/db/migrate/20110701061927_subscription_fu_update_to_zero_three.rb

@@ -0,0 +1,12 @@
+class SubscriptionFuUpdateToZeroThree < ActiveRecord::Migration
+  def self.up
+    create_table "subscription_system_initiators" do |t|
+      t.string "name"
+      t.string "description"
+    end
+  end
+
+  def self.down
+    drop_table "subscription_system_initiators"
+  end
+end

data/spec/app/db/schema.rb

@@ -10,7 +10,7 @@
 #
 # It's strongly recommended to check this file into your version control system.
 
-ActiveRecord::Schema.define(:version => 20110516070948) do
+ActiveRecord::Schema.define(:version => 20110701061927) do
 
   create_table "initiators", :force => true do |t|
     t.string   "desc"
@@ -25,6 +25,11 @@ ActiveRecord::Schema.define(:version => 20110516070948) do
     t.datetime "updated_at"
   end
 
+  create_table "subscription_system_initiators", :force => true do |t|
+    t.string "name"
+    t.string "description"
+  end
+
   create_table "subscription_transactions", :force => true do |t|
     t.integer  "subscription_id",                      :null => false
     t.integer  "initiator_id",                         :null => false

data/spec/models/subscription_spec.rb

@@ -117,7 +117,7 @@ describe SubscriptionFu::Subscription do
             it "should cancel previous sub with failure" do
               sub = instance_variable_get("@#{sub_instance}").prev_subscription.reload
               sub.canceled_at.should be_present
-              sub.transactions.last.status.should == "failed"
+              sub.transactions.last.status.should == "complete"
             end
           end unless first_sub || prev_sub_is_free
           context "complete with error in create" do
@@ -194,11 +194,11 @@ describe SubscriptionFu::Subscription do
       end
 
       context "active on paypal" do
-        before { mock_paypal_profile_details("fgsga564aa", "ActiveProfile", "2010-01-10", "2010-02-10") }
+        before { mock_paypal_profile_details("fgsga564aa", "Active", "2010-01-10", "2010-02-10") }
         it("should return next_billing_date") { @sub.next_billing_date.should == @next_billing }
         it("should return last_billing_date") { @sub.last_billing_date.should == Time.parse("2010-01-10 00:00 UTC") }
         it("should return estimated_next_billing_date") { @sub.estimated_next_billing_date.should == @next_billing }
-        it("should return successor_billing_start_date") { @sub.successor_billing_start_date.should == @next_billing }
+        it("should return end_date_when_canceled") { @sub.end_date_when_canceled.should == @next_billing }
         context "profess successor" do
           before { at_time(@now) { @succ = @sub.subject.build_next_subscription('profess'); @succ.save! } }
           should_build_valid_successor("profess", :now, :next_billing)
@@ -217,11 +217,11 @@ describe SubscriptionFu::Subscription do
       end
 
       context "canceled on paypal" do
-        before { mock_paypal_profile_details("fgsga564aa", "CanceledProfile", "2010-01-10", nil) }
+        before { mock_paypal_profile_details("fgsga564aa", "Cancelled", "2010-01-10", nil) }
         it("should return next_billing_date") { @sub.next_billing_date.should be_nil }
         it("should return last_billing_date") { @sub.last_billing_date.should == Time.parse("2010-01-10 00:00 UTC") }
         it("should return estimated_next_billing_date") { @sub.estimated_next_billing_date.should == @next_billing }
-        it("should return successor_billing_start_date") { @sub.successor_billing_start_date.should == @next_billing }
+        it("should return end_date_when_canceled") { @sub.end_date_when_canceled.should == @next_billing }
         context "profess successor" do
           before { at_time(@now) { @succ = @sub.subject.build_next_subscription('profess'); @succ.save! } }
           should_build_valid_successor("profess", :now, :next_billing)
@@ -234,14 +234,24 @@ describe SubscriptionFu::Subscription do
           before { at_time(@now) { @succ = @sub.subject.build_next_subscription('free'); @succ.save! } }
           should_build_valid_successor("free", :next_billing, :next_billing)
         end
+        context "sync" do
+          before { mock_paypal_delete_profile_with_error("fgsga564aa") }
+          before { at_time(@now) { @sub.sync_from_gateway! } }
+          it "should mark subscription as cancelled" do
+            @sub.reload.should be_canceled
+            @sub.canceled_at.should == Time.parse("2010-02-10 00:00 UTC")
+            @sub.cacnel_reason.should == "gwcacnel"
+            @sub.transactions.last.status.should == "complete"
+          end
+        end
       end
 
       context "canceled on paypal, no payments made" do
-        before { mock_paypal_profile_details("fgsga564aa", "CanceledProfile", nil, nil) }
+        before { mock_paypal_profile_details("fgsga564aa", "Cancelled", nil, nil) }
         it("should return next_billing_date") { @sub.next_billing_date.should be_nil }
         it("should return last_billing_date") { @sub.last_billing_date.should be_nil }
         it("should return estimated_next_billing_date") { @sub.estimated_next_billing_date.should be_nil }
-        it("should return successor_billing_start_date") { at_time(@now) { @sub.successor_billing_start_date.should == @now } }
+        it("should return end_date_when_canceled") { at_time(@now) { @sub.end_date_when_canceled.should == @now } }
         context "profess successor" do
           before { at_time(@now) { @succ = @sub.subject.build_next_subscription('profess'); @succ.save! } }
           should_build_valid_successor("profess", :now, :now)
@@ -258,7 +268,7 @@ describe SubscriptionFu::Subscription do
 
       context "canceled on our side" do
         before { @sub.update_attributes(:canceled_at => @next_billing, :cancel_reason => 'admin') }
-        it("should return successor_billing_start_date") { @sub.successor_billing_start_date.should == @next_billing }
+        it("should return end_date_when_canceled") { @sub.end_date_when_canceled.should == @next_billing }
         context "profess successor" do
           before { at_time(@now) { @succ = @sub.subject.build_next_subscription('profess'); @succ.save! } }
           should_build_valid_successor("profess", :now, :next_billing)

metadata

@@ -1,12 +1,8 @@
 --- !ruby/object:Gem::Specification 
 name: subscription_fu
 version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 2
-  - 1
-  version: 0.2.1
+  prerelease: 
+  version: 0.3.0
 platform: ruby
 authors: 
 - Paul McMahon
@@ -15,7 +11,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-06-07 00:00:00 +09:00
+date: 2011-07-01 00:00:00 +09:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -26,10 +22,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        segments: 
-        - 3
-        - 0
-        - 3
         version: 3.0.3
   type: :runtime
   version_requirements: *id001
@@ -41,10 +33,6 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        - 3
-        - 0
         version: 0.3.0
   type: :runtime
   version_requirements: *id002
@@ -62,8 +50,10 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- UPDATING.md
 - app/models/subscription_fu/plan.rb
 - app/models/subscription_fu/subscription.rb
+- app/models/subscription_fu/system_initiator.rb
 - app/models/subscription_fu/transaction.rb
 - config/locales/en.yml
 - examples/routes.rb
@@ -79,6 +69,7 @@ files:
 - lib/subscription_fu/models.rb
 - lib/subscription_fu/paypal.rb
 - lib/subscription_fu/railtie.rb
+- lib/subscription_fu/rake.tasks
 - lib/subscription_fu/version.rb
 - spec/app/.gitignore
 - spec/app/Rakefile
@@ -103,6 +94,7 @@ files:
 - spec/app/db/migrate/20110516061428_create_subjects.rb
 - spec/app/db/migrate/20110516061443_create_initiators.rb
 - spec/app/db/migrate/20110516070948_create_subscription_fu_tables.rb
+- spec/app/db/migrate/20110701061927_subscription_fu_update_to_zero_three.rb
 - spec/app/db/schema.rb
 - spec/app/script/rails
 - spec/factories/initiator.rb
@@ -129,21 +121,17 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      segments: 
-      - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      segments: 
-      - 0
       version: "0"
 requirements: []
 
 rubyforge_project: subscriptionfu
-rubygems_version: 1.3.7
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: Rails support for handling free/paid subscriptions