subscription_fu 0.1.0

data/lib/subscription_fu/models.rb

@@ -0,0 +1,54 @@
+module SubscriptionFu
+  module Models
+    def self.included(base)
+      base.send(:extend, ClassMethods)
+    end
+
+    module ClassMethods
+      def needs_subscription
+        send(:include, InstanceMethods)
+        has_many :subscriptions, :class_name => "SubscriptionFu::Subscription", :as => :subject, :dependent => :destroy
+        delegate :plan, :sponsored?, :canceled?, :prefix => :subscription, :to => :active_subscription, :allow_nil => true
+        delegate :plan, :prefix => :upcoming_subscription, :to => :upcoming_subscription, :allow_nil => true
+      end
+    end
+
+    module InstanceMethods
+      def human_description_for_subscription
+        self.class.model_name.human
+      end
+
+      def active_subscription
+        @active_subscription ||= subscriptions.current(Time.now).last
+      end
+
+      def active_subscription?
+        !active_subscription.nil?
+      end
+
+      def upcoming_subscription
+        active_subscription ? active_subscription.next_subscriptions.activated.last : nil
+      end
+
+      def pending_transaction(identifier)
+        sub = subscriptions.last
+        if sub.activated?
+          logger.info("Latest subscription is already activated")
+          nil
+        else
+          sub.transactions.initiated.find_by_identifier(identifier)
+        end
+      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
+      end
+    end
+
+  end
+end

data/lib/subscription_fu/paypal.rb

@@ -0,0 +1,101 @@
+require "rest-client"
+
+class SubscriptionFu::Paypal
+
+  def self.paypal
+    new(SubscriptionFu.config.paypal_api_user_id,
+        SubscriptionFu.config.paypal_api_pwd,
+        SubscriptionFu.config.paypal_api_sig,
+        SubscriptionFu.config.paypal_nvp_api_url,
+        Rails.logger)
+  end
+
+  class Failure < RuntimeError
+    attr_reader :request_opts, :response
+
+    def initialize(request_opts, response)
+      @request_opts = request_opts
+      @response = response
+      super "PayPal did not return success: #{@response.inspect}"
+    end
+    alias :data :request_opts
+  end
+
+  def initialize(user, pwd, sig, api_url, logger)
+    @user = user
+    @pwd = pwd
+    @sig = sig
+    @api_url = api_url
+    @logger = logger
+  end
+
+  def start_checkout(return_url, cancel_url, email, maxamt, currency_code, desc)
+    res = call_paypal('SetExpressCheckout',
+                      'RETURNURL' => return_url,
+                      'CANCELURL' => cancel_url,
+                      'EMAIL' => email,
+                      'NOSHIPPING' => 1,
+                      'MAXAMT' => maxamt,
+                      'PAYMENTREQUEST_0_AMT' => 0,
+                      'PAYMENTREQUEST_0_CURRENCYCODE' => currency_code,
+                      'L_BILLINGTYPE0' => 'RecurringPayments',
+                      'L_BILLINGAGREEMENTDESCRIPTION0' => desc)
+    res['TOKEN'].first
+  end
+
+  def create_recurring(token, start_date, amt, taxamt, currency_code, desc)
+    res = call_paypal('CreateRecurringPaymentsProfile',
+                      'PROFILESTARTDATE' => start_date.utc.iso8601,
+                      'BILLINGPERIOD' => 'Month',
+                      'BILLINGFREQUENCY' => 1,
+                      'MAXFAILEDPAYMENTS' => 0,
+                      'AUTOBILLOUTAMT' => 'AddToNextBilling',
+                      'AMT' => amt,
+                      'TAXAMT' => taxamt,
+                      'CURRENCYCODE' => currency_code,
+                      'DESC' => desc,
+                      'TOKEN' => token)
+    [res['PROFILEID'].first, res['PROFILESTATUS'].first || res['STATUS'].first]
+  end
+
+  def recurring_details(profile_id)
+    utc = ActiveSupport::TimeZone.new("UTC")
+    res = call_paypal('GetRecurringPaymentsProfileDetails', 'PROFILEID' => profile_id)
+    { :id => res['PROFILEID'].first,
+      :status => res['PROFILESTATUS'].first || res['STATUS'].first,
+      :next_billing_date => utc.parse(res['NEXTBILLINGDATE'].first.to_s),
+      :start_date => utc.parse(res['PROFILESTARTDATE'].first.to_s),
+      :cycles_completed => res['NUMCYCLESCOMPLETED'].first.to_i,
+      :outstanding_balance => res['OUTSTANDINGBALANCE'].first.to_f,
+      :last_payment_date => utc.parse(res['LASTPAYMENTDATE'].first.to_s) }
+  end
+
+  def cancel_recurring(profile_id, reason)
+    call_paypal('ManageRecurringPaymentsProfileStatus',
+                'PROFILEID' => profile_id,
+                'ACTION' => 'Cancel',
+                'NOTE' => I18n.t(reason, :scope => [:subscription_fu, :subscription, :cancel_notes]))
+  end
+
+  private
+
+  def call_paypal(method, opts)
+    full_opts = paypal_api_opts(method, opts)
+    CGI.parse(RestClient.post(@api_url, full_opts)).tap do |result|
+      if result['ACK'].first != 'Success'
+        @logger.warn("PayPal did not return success for call to #{method}")
+        @logger.info("  called with: #{full_opts.inspect}")
+        @logger.info("  result: #{result.inspect}")
+        raise Failure.new(full_opts, result)
+      else
+        @logger.info("PayPal returned success for call to #{method}")
+        @logger.info("  result: #{result.inspect}")
+      end
+    end
+  end
+
+  def paypal_api_opts(method, opts)
+    opts.merge('USER' => @user, 'PWD' => @pwd, 'SIGNATURE' => @sig, 'VERSION' => '65.0', 'METHOD' => method)
+  end
+
+end

data/lib/subscription_fu/railtie.rb

@@ -0,0 +1,12 @@
+module SubscriptionFu
+  class Railtie < ::Rails::Railtie
+    config.subscription_fu = SubscriptionFu.config
+    initializer "subscription_fu.extend.active_record" do |app|
+      ActiveSupport.on_load :active_record do
+        include SubscriptionFu::Models
+      end
+    end
+  end
+end
+
+require "subscription_fu/models"

data/lib/subscription_fu/version.rb

@@ -0,0 +1,3 @@
+module SubscriptionFu
+  VERSION = "0.1.0"
+end

data/lib/subscription_fu.rb

@@ -0,0 +1,15 @@
+module SubscriptionFu
+  autoload :Config, "subscription_fu/config"
+  autoload :Paypal, "subscription_fu/paypal"
+
+  def self.config
+    @config ||= SubscriptionFu::Config.new
+  end
+
+  def self.friendly_token
+    ActiveSupport::SecureRandom.base64(44).tr('+/=', 'xyz')
+  end
+end
+
+require 'subscription_fu/railtie'
+require 'subscription_fu/engine'

data/spec/app/.gitignore

@@ -0,0 +1 @@
+log

data/spec/app/Rakefile

@@ -0,0 +1,8 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+require 'rake'
+
+Rails.application.load_tasks

data/spec/app/app/controllers/application_controller.rb

@@ -0,0 +1,6 @@
+# Filters added to this controller apply to all controllers in the application.
+# Likewise, all the methods added will be available for all controllers.
+
+class ApplicationController < ActionController::Base
+  protect_from_forgery
+end

data/spec/app/app/models/initiator.rb

@@ -0,0 +1,2 @@
+class Initiator < ActiveRecord::Base
+end

data/spec/app/app/models/subject.rb

@@ -0,0 +1,4 @@
+class Subject < ActiveRecord::Base
+  needs_subscription
+
+end

data/spec/app/app/views/layouts/application.html.haml

@@ -0,0 +1,6 @@
+%html
+  %head
+    %meta{"http-equiv" => "Content-Type", :content => "text/html;charset=UTF-8"}
+    = yield :head if content_for?(:head)
+  %body
+    = yield

data/spec/app/config/application.rb

@@ -0,0 +1,11 @@
+require File.expand_path('../boot', __FILE__)
+
+require "action_controller/railtie"
+require "active_record/railtie"
+require "rails/test_unit/railtie"
+require 'subscription_fu'
+
+module RailsApp
+  class Application < Rails::Application
+  end
+end

data/spec/app/config/boot.rb

@@ -0,0 +1,4 @@
+require 'rubygems'
+require 'bundler'
+$:.unshift File.expand_path('../../../../lib', __FILE__)
+

data/spec/app/config/database.yml

@@ -0,0 +1,18 @@
+# SQLite version 3.x
+#   gem install sqlite3-ruby (not necessary on OS X Leopard)
+development:
+  adapter: sqlite3
+  database: db/development.sqlite3
+  pool: 5
+  timeout: 5000
+
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
+test:
+  adapter: sqlite3
+  database: ":memory:"
+
+production:
+  adapter: sqlite3
+  database: ":memory:"

data/spec/app/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the rails application
+require File.expand_path('../application', __FILE__)
+
+# Initialize the rails application
+RailsApp::Application.initialize!

data/spec/app/config/environments/development.rb

@@ -0,0 +1,18 @@
+RailsApp::Application.configure do
+  # Settings specified here will take precedence over those in config/environment.rb
+
+  # In the development environment your application's code is reloaded on
+  # every request.  This slows down response time but is perfect for development
+  # since you don't have to restart the webserver when you make code changes.
+  config.cache_classes = false
+
+  # Log error messages when you accidentally call methods on nil.
+  config.whiny_nils = true
+
+  # Show full error reports and disable caching
+  config.consider_all_requests_local       = true
+  config.action_view.debug_rjs             = true
+  config.action_controller.perform_caching = false
+
+  config.active_support.deprecation = :stderr
+end

data/spec/app/config/environments/test.rb

@@ -0,0 +1,22 @@
+RailsApp::Application.configure do
+  # Settings specified here will take precedence over those in config/environment.rb
+
+  # The test environment is used exclusively to run your application's
+  # test suite.  You never need to work with it otherwise.  Remember that
+  # your test database is "scratch space" for the test suite and is wiped
+  # and recreated between test runs.  Don't rely on the data there!
+  config.cache_classes = true
+
+  # Log error messages when you accidentally call methods on nil.
+  config.whiny_nils = true
+
+  # Show full error reports and disable caching
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  # Disable request forgery protection in test environment
+  config.action_controller.allow_forgery_protection    = false
+
+  config.action_dispatch.show_exceptions = false
+  config.active_support.deprecation = :stderr
+end

data/spec/app/config/initializers/backtrace_silencers.rb

@@ -0,0 +1,7 @@
+# Be sure to restart your server when you modify this file.
+
+# You can add backtrace silencers for libraries that you're using but don't wish to see in your backtraces.
+# Rails.backtrace_cleaner.add_silencer { |line| line =~ /my_noisy_library/ }
+
+# You can also remove all the silencers if you're trying to debug a problem that might stem from framework code.
+Rails.backtrace_cleaner.remove_silencers!

data/spec/app/config/initializers/inflections.rb

@@ -0,0 +1,2 @@
+ActiveSupport::Inflector.inflections do |inflect|
+end

data/spec/app/config/initializers/secret_token.rb

@@ -0,0 +1,2 @@
+Rails.application.config.secret_token = 'afvrbanwvUY89vafbvahjkb'
+Rails.application.config.session_store :cookie_store, :key => "_my_app"

data/spec/app/config/initializers/subscription_fu.rb

@@ -0,0 +1,28 @@
+class MyCustomPlan < SubscriptionFu::Plan
+  attr_accessor :tickets
+
+  def private_events?
+    price > 1000
+  end
+
+  def custom_email_from?
+    price > 1000
+  end
+
+  def extra_promotion?
+    ! free_plan?
+  end
+end
+
+RailsApp::Application.configure do
+  config.subscription_fu.paypal_api_user_id = "michae_1272617165_biz_api1.mobalean.com"
+  config.subscription_fu.paypal_api_pwd = "1272617171"
+  config.subscription_fu.paypal_api_sig = "ATpPRKe6SEGaLcgDfFD-kBQgVsGuA9iFQwK6d4x6Qs4iti0XYRkZQl9Q"
+
+  config.subscription_fu.plan_class_name = "MyCustomPlan"
+
+  config.subscription_fu.add_free_plan 'free', :tickets => 100
+  config.subscription_fu.add_plan 'basic', 1000, :tickets => 100
+  config.subscription_fu.add_plan 'premium', 5000, :tickets => 200
+  config.subscription_fu.add_plan 'profess', 20000, :tickets => 1000
+end

data/spec/app/config/locales/subscription_fu.en.yml

@@ -0,0 +1,17 @@
+en:
+  subscription_fu:
+    subscription:
+      # description used for Paypal
+      description: "%{plan_name} subscription for %{subject_desc}, %{price} per month"
+      # cancel notes used as description for Paypal
+      cancel_notes:
+        update: "Changed subscription plan"
+        cancel: "Subscription cancelled"
+    plan:
+      options:
+        # match this section with the plan names you are using in
+        # config/initializers/subscription_fu.rb to get human readable names
+        profess: Professional
+        premium: Premium
+        basic: Basic
+        free: Free

data/spec/app/config/routes.rb

@@ -0,0 +1,3 @@
+Rails.application.routes.draw do
+  root :to => "home#index"
+end

data/spec/app/config.ru

@@ -0,0 +1,4 @@
+# This file is used by Rack-based servers to start the application.
+
+require ::File.expand_path('../config/environment',  __FILE__)
+run RailsApp::Application

data/spec/app/db/.gitignore

@@ -0,0 +1 @@
+*.sqlite3

data/spec/app/db/migrate/20110516061428_create_subjects.rb

@@ -0,0 +1,13 @@
+class CreateSubjects < ActiveRecord::Migration
+  def self.up
+    create_table :subjects do |t|
+      t.string :desc
+
+      t.timestamps
+    end
+  end
+
+  def self.down
+    drop_table :subjects
+  end
+end

data/spec/app/db/migrate/20110516061443_create_initiators.rb

@@ -0,0 +1,14 @@
+class CreateInitiators < ActiveRecord::Migration
+  def self.up
+    create_table :initiators do |t|
+      t.string :desc
+      t.string :email
+
+      t.timestamps
+    end
+  end
+
+  def self.down
+    drop_table :initiators
+  end
+end

data/spec/app/db/migrate/20110516070948_create_subscription_fu_tables.rb

@@ -0,0 +1,38 @@
+class CreateSubscriptionFuTables < ActiveRecord::Migration
+  def self.up
+    create_table "subscriptions", :force => true do |t|
+      t.references "subject",          :polymorphic => true
+      t.references "prev_subscription"
+      t.string     "plan_key",         :limit => 10, :null => false
+      t.boolean    "sponsored",                      :null => false, :default => false
+      t.string     "paypal_profile_id"
+      t.datetime   "starts_at",                      :null => false
+      t.datetime   "billing_starts_at",              :null => false
+      t.datetime   "activated_at"
+      t.datetime   "canceled_at"
+      t.string     "cancel_reason",     :limit => 10
+      t.timestamps
+    end
+
+    add_index "subscriptions", ["subject_id", "subject_type"]
+
+    create_table "subscription_transactions" do |t|
+      t.references "subscription",                 :null => false
+      t.references "initiator",                    :null => false, :polymorphic => true
+      t.string     "action",         :limit => 15, :null => false
+      t.string     "status",         :limit => 15, :null => false
+      t.string     "gateway",        :limit => 10, :null => false
+      t.string     "identifier"
+      t.references "related_transaction"
+      t.timestamps
+    end
+
+    add_index "subscription_transactions", ["identifier"]
+    add_index "subscription_transactions", ["subscription_id"]
+  end
+
+  def self.down
+    drop_table "subscriptions"
+    drop_table "subscription_transactions"
+  end
+end

data/spec/app/db/schema.rb

@@ -0,0 +1,62 @@
+# This file is auto-generated from the current state of the database. Instead
+# of editing this file, please use the migrations feature of Active Record to
+# incrementally modify your database, and then regenerate this schema definition.
+#
+# Note that this schema.rb definition is the authoritative source for your
+# database schema. If you need to create the application database on another
+# system, you should be using db:schema:load, not running all the migrations
+# from scratch. The latter is a flawed and unsustainable approach (the more migrations
+# you'll amass, the slower it'll run and the greater likelihood for issues).
+#
+# It's strongly recommended to check this file into your version control system.
+
+ActiveRecord::Schema.define(:version => 20110516070948) do
+
+  create_table "initiators", :force => true do |t|
+    t.string   "desc"
+    t.string   "email"
+    t.datetime "created_at"
+    t.datetime "updated_at"
+  end
+
+  create_table "subjects", :force => true do |t|
+    t.string   "desc"
+    t.datetime "created_at"
+    t.datetime "updated_at"
+  end
+
+  create_table "subscription_transactions", :force => true do |t|
+    t.integer  "subscription_id",                      :null => false
+    t.integer  "initiator_id",                         :null => false
+    t.string   "initiator_type",                       :null => false
+    t.string   "action",                 :limit => 15, :null => false
+    t.string   "status",                 :limit => 15, :null => false
+    t.string   "gateway",                :limit => 10, :null => false
+    t.string   "identifier"
+    t.integer  "related_transaction_id"
+    t.datetime "created_at"
+    t.datetime "updated_at"
+  end
+
+  add_index "subscription_transactions", ["identifier"], :name => "index_subscription_transactions_on_identifier"
+  add_index "subscription_transactions", ["subscription_id"], :name => "index_subscription_transactions_on_subscription_id"
+
+  create_table "subscriptions", :force => true do |t|
+    t.integer  "subject_id"
+    t.string   "subject_type"
+    t.integer  "prev_subscription_id"
+    t.string   "plan_key",             :limit => 10,                    :null => false
+    t.boolean  "sponsored",                          :default => false, :null => false
+    t.string   "paypal_profile_id"
+    t.datetime "starts_at",                                             :null => false
+    t.datetime "billing_starts_at",                                     :null => false
+    t.datetime "activated_at"
+    t.datetime "canceled_at"
+    t.string   "cancel_reason",        :limit => 10
+    t.datetime "created_at"
+    t.datetime "updated_at"
+  end
+
+  add_index "subscriptions", ["subject_id", "subject_type"], :name => "index_subscriptions_on_subject_id_and_subject_type"
+
+end

data/spec/app/script/rails

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails 3 gems installed from the root of your application.
+
+ENV_PATH  = File.expand_path('../../config/environment',  __FILE__)
+BOOT_PATH = File.expand_path('../../config/boot',  __FILE__)
+APP_PATH  = File.expand_path('../../config/application',  __FILE__)
+ROOT_PATH = File.expand_path('../..',  __FILE__)
+
+require BOOT_PATH
+require 'rails/commands'

data/spec/factories/initiator.rb

@@ -0,0 +1,4 @@
+Factory.sequence(:initiator_email) {|n| "mail#{n}@mobalean.com"}
+Factory.define(:initiator) do |a|
+  a.email {|o| Factory.next(:initiator_email) }
+end

data/spec/factories/subject.rb

@@ -0,0 +1,2 @@
+Factory.define(:subject) do |s|
+end

data/spec/factories/subscription.rb

@@ -0,0 +1,6 @@
+Factory.define :subscription, :class => "SubscriptionFu::Subscription" do |s|
+  s.subject {|s| Factory(:subject) }
+  s.starts_at Time.now
+  s.billing_starts_at Time.now
+  s.plan_key "premium"
+end

data/spec/factories/transaction.rb

@@ -0,0 +1,7 @@
+Factory.define :transaction, :class => "SubscriptionFu::Transaction" do |t|
+  t.association :subscription
+  t.association :initiator
+  t.gateway "nogw"
+  t.status "initiated"
+  t.action "activation"
+end