freemium 0.0.1

data/lib/generators/active_record/freemium_generator.rb

@@ -0,0 +1,28 @@
+require 'rails/generators/active_record'
+require 'generators/freemium/orm_helpers'
+
+module ActiveRecord
+  module Generators
+    class FreemiumGenerator < ActiveRecord::Generators::Base
+      argument :attributes, :type => :array, :default => [], :banner => "field:type field:type"
+
+      include Freemium::Generators::OrmHelpers
+      source_root File.expand_path("../templates", __FILE__)
+
+      def copy_freemium_migration
+        migration_template "migrations/#{table_name}.rb", "db/migrate/freemium_create_#{table_name}"
+      end
+
+      def generate_model
+        invoke "active_record:model", [name], :migration => false unless model_exists? && behavior == :invoke
+      end
+
+      def inject_freemium_content
+        inject_into_class(model_path, class_name, model_contents + <<CONTENT) if model_exists?
+# Setup accessible (or protected) attributes for your model
+include Freemium::#{class_name}
+CONTENT
+      end
+    end
+  end
+end

data/lib/generators/active_record/templates/migrations/account_transactions.rb

@@ -0,0 +1,17 @@
+class CreateAccountTransactions < ActiveRecord::Migration
+  def self.up
+    create_table :account_transactions, :force => true do |t|
+      t.column :subscription_id, :integer, :null => false
+      t.column :success, :boolean, :null => false
+      t.column :billing_key, :string, :null => false
+      t.column :amount_cents, :integer, :null => false
+      t.column :message, :string, :null => true
+      t.column :created_at, :timestamp, :null => false
+    end
+    add_index :account_transactions, :subscription_id
+  end
+
+  def self.down
+    drop_table :account_transactions
+  end
+end

data/lib/generators/active_record/templates/migrations/coupon_redemptions.rb

@@ -0,0 +1,18 @@
+class CreateCouponRedemptions < ActiveRecord::Migration
+  def self.up
+
+    create_table :coupon_redemptions, :force => true do |t|
+      t.column :subscription_id, :integer, :null => false
+      t.column :coupon_id, :integer, :null => false
+      t.column :redeemed_on, :date, :null => false
+      t.column :expired_on, :date, :null => true
+    end
+
+    add_index :coupon_redemptions, :subscription_id
+
+  end
+
+  def self.down
+    drop_table :coupon_redemptions
+  end
+end

data/lib/generators/active_record/templates/migrations/coupons.rb

@@ -0,0 +1,28 @@
+class CreateCoupons < ActiveRecord::Migration
+  def self.up
+
+    create_table :coupons, :force => true do |t|
+      t.column :description, :string, :null => false
+      t.column :discount_percentage, :integer, :null => false
+      t.column :redemption_key, :string, :null => true
+      t.column :redemption_limit, :integer, :null => true
+      t.column :redemption_expiration, :date, :null => true
+      t.column :duration_in_months, :integer, :null => true
+    end
+
+    create_table :coupons_subscription_plans, :id => false, :force => true do |t|
+      t.column :coupon_id, :integer, :null => false
+      t.column :subscription_plan_id, :integer, :null => false
+    end
+
+
+    add_index :coupons_subscription_plans, :coupon_id, :name => :on_coupon_id
+    add_index :coupons_subscription_plans, :subscription_plan_id, :name => :on_subscription_plan_id
+
+  end
+
+  def self.down
+    drop_table :coupons
+    drop_table :coupons_subscription_plans
+  end
+end

data/lib/generators/active_record/templates/migrations/credit_cards.rb

@@ -0,0 +1,14 @@
+class CreateCreditCards < ActiveRecord::Migration
+  def self.up
+    create_table :credit_cards, :force => true do |t|
+      t.column :display_number, :string, :null => false
+      t.column :card_type, :string, :null => false
+      t.column :expiration_date, :timestamp, :null => false
+      t.column :zip_code, :string, :null => true
+    end
+  end
+
+  def self.down
+    drop_table :credit_cards
+  end
+end

data/lib/generators/active_record/templates/migrations/subscription_changes.rb

@@ -0,0 +1,18 @@
+class CreateSubscriptionChanges < ActiveRecord::Migration
+  def self.up
+    create_table :subscription_changes, :force => true do |t|
+      t.column :subscribable_id, :integer, :null => false
+      t.column :subscribable_type, :string, :null => false
+      t.column :original_subscription_plan_id, :integer, :null => true
+      t.column :new_subscription_plan_id, :integer, :null => true
+      t.column :reason, :string, :null => false
+      t.column :created_at, :timestamp, :null => false
+    end
+    add_index :subscription_changes, :reason
+    add_index :subscription_changes, [:subscribable_id, :subscribable_type], :name => :on_subscribable_id_and_type
+  end
+
+  def self.down
+    drop_table :subscription_changes
+  end
+end

data/lib/generators/active_record/templates/migrations/subscription_plans.rb

@@ -0,0 +1,14 @@
+class CreateSubscriptionPlans < ActiveRecord::Migration
+  def self.up
+    create_table :subscription_plans, :force => true do |t|
+      t.column :name, :string, :null => false
+      t.column :key, :string, :null => false
+      t.column :rate_cents, :integer, :null => false
+      t.column :feature_set_id, :string, :null => false
+    end
+  end
+
+  def self.down
+    drop_table :subscription_plans
+  end
+end

data/lib/generators/active_record/templates/migrations/subscriptions.rb

@@ -0,0 +1,30 @@
+class CreateSubscriptions < ActiveRecord::Migration
+  def self.up
+    create_table :subscriptions, :force => true do |t|
+      t.column :subscribable_id, :integer, :null => false
+      t.column :subscribable_type, :string, :null => false
+      t.column :billing_key, :string, :null => true
+      t.column :credit_card_id, :integer, :null => true
+      t.column :subscription_plan_id, :integer, :null => false
+      t.column :paid_through, :date, :null => true
+      t.column :expire_on, :date, :null => true
+      t.column :billing_key, :string, :null => true
+      t.column :started_on, :date, :null => true
+      t.column :last_transaction_at, :datetime, :null => true
+      t.column :in_trial, :boolean, :null => false, :default => false
+    end
+    # for polymorphic association queries
+    add_index :subscriptions, :subscribable_id
+    add_index :subscriptions, :subscribable_type
+    add_index :subscriptions, [:subscribable_id, :subscribable_type], :name => :on_subscribable_id_and_type
+    # for finding due, pastdue, and expiring subscriptions
+    add_index :subscriptions, :paid_through
+    add_index :subscriptions, :expire_on
+    # for applying transactions from automated recurring billing
+    add_index :subscriptions, :billing_key
+  end
+
+  def self.down
+    drop_table :subscriptions
+  end
+end

data/lib/generators/active_record/templates/models/account_transaction.rb

@@ -0,0 +1,3 @@
+class AccountTransaction < ActiveRecord::Base
+  include Freemium::Transaction
+end

data/lib/generators/active_record/templates/models/coupon.rb

@@ -0,0 +1,3 @@
+class Coupon < ActiveRecord::Base
+  include Freemium::Coupon
+end

data/lib/generators/active_record/templates/models/coupon_redemption.rb

@@ -0,0 +1,3 @@
+class CouponRedemption < ActiveRecord::Base
+  include Freemium::CouponRedemption
+end

data/lib/generators/active_record/templates/models/credit_card.rb

@@ -0,0 +1,3 @@
+class CreditCard < ActiveRecord::Base
+  include Freemium::CreditCard
+end

data/lib/generators/active_record/templates/models/subscription.rb

@@ -0,0 +1,3 @@
+class Subscription < ActiveRecord::Base
+  include Freemium::Subscription
+end

data/lib/generators/active_record/templates/models/subscription_change.rb

@@ -0,0 +1,3 @@
+class SubscriptionChange < ActiveRecord::Base
+  include Freemium::SubscriptionChange
+end

data/lib/generators/active_record/templates/models/subscription_plan.rb

@@ -0,0 +1,3 @@
+class SubscriptionPlan < ActiveRecord::Base
+  include Freemium::SubscriptionPlan
+end

data/lib/generators/freemium/freemium_generator.rb

@@ -0,0 +1,15 @@
+module Freemium
+  module Generators
+    class FreemiumGenerator < Rails::Generators::NamedBase
+      include Rails::Generators::ResourceHelpers
+
+      namespace "freemium"
+      source_root File.expand_path("../templates", __FILE__)
+
+      desc "Generates a model with the given NAME (if one does not exist) with freemium " <<
+           "configuration plus a migration file and freemium routes."
+
+      hook_for :orm
+    end
+  end
+end

data/lib/generators/freemium/install_generator.rb

@@ -0,0 +1,28 @@
+require 'securerandom'
+
+module Freemium
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path("../../templates", __FILE__)
+
+      desc "Creates a Freemium initializer and copy locale files to your application."
+      class_option :orm
+
+      def copy_initializer
+        template "freemium.rb", "config/initializers/freemium.rb"
+      end
+
+      def copy_feature_sets
+        template "freemium_feature_sets.yml", "config/freemium_feature_sets.yml"
+      end
+
+      def copy_locale
+        copy_file "../../../config/locales/en.yml", "config/locales/freemium.en.yml"
+      end
+
+      def show_readme
+        readme "README" if behavior == :invoke
+      end
+    end
+  end
+end

data/lib/generators/freemium/orm_helpers.rb

@@ -0,0 +1,27 @@
+module Freemium
+  module Generators
+    module OrmHelpers
+      def model_contents
+<<-CONTENT
+#from OrmHelpers#model_contents
+CONTENT
+      end
+
+      def model_exists?
+        File.exists?(File.join(destination_root, model_path))
+      end
+
+      def migration_exists?(table_name)
+        Dir.glob("#{File.join(destination_root, migration_path)}/[0-9]*_*.rb").grep(/\d+_freemium_create_#{table_name}.rb$/).first
+      end
+
+      def migration_path
+        @migration_path ||= File.join("db", "migrate")
+      end
+
+      def model_path
+        @model_path ||= File.join("app", "models", "#{file_path}.rb")
+      end
+    end
+  end
+end

data/lib/generators/templates/freemium.rb

@@ -0,0 +1,43 @@
+# Sample configuration, but this will get you bootstrapped with BrainTree
+# TODO:
+# - information on where to register...
+# - setting up production passwords...
+# - better way to do production/test changes?
+
+Freemium.gateway = Freemium::Gateways::BrainTree.new
+Freemium.gateway.username = "demo"
+Freemium.gateway.password = "password"
+
+# If you want Freemium to take care of the billing itself
+# (ie, handle everything within your app, with recurring payments via cron
+# or some other batch job)
+# use :manual
+#
+# if you want to use the gateways recuring payment system
+# use :gateway
+Freemium.billing_handler = :manual
+
+# the class name of mailer used to send out emails to subscriber
+Freemium.mailer = SubscriptionMailer
+
+# uncomment to be cc'ed on all freemium emails that go out to the user
+#Freemium.admin_report_recipients = %w{admin@site.com}
+
+# the grace period, in days, before Freemium triggers additional mails
+# for the client. Defaults to 3
+Freemium.days_grace = 3
+
+# would you like to offer a free trial? Change this to specify the
+# length of the trial. Defaults to 0 days
+Freemium.days_free_trial = 30
+
+##### See vendor/plugins/freemium/freemium.rb for additional choices
+
+if Rails.env == 'production'
+  # put your production password information here....
+  Freemium.gateway.username = "demo"
+  Freemium.gateway.password = "password"
+elsif Rails.env == 'test'
+  # prevents you from calling BrainTree during your tests
+  Freemium.gateway = Freemium::Gateways::Test.new
+end

data/lib/generators/templates/freemium_feature_sets.yml

@@ -0,0 +1,5 @@
+# TODO Fill out with feature sets for your subscription plans
+#- id: free
+#  ads: true
+#- id: paid
+#  ads: false

data/spec/dummy/Rakefile

@@ -0,0 +1,7 @@
+# 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'
+
+Dummy::Application.load_tasks

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

@@ -0,0 +1,3 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery
+end

data/spec/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/spec/dummy/app/models/models.rb

@@ -0,0 +1,32 @@
+class User < ActiveRecord::Base
+  has_many :subscriptions, :as => :subscribable
+end
+
+class CouponRedemption < ActiveRecord::Base
+  include Freemium::CouponRedemption
+end
+
+class Subscription < ActiveRecord::Base
+  include Freemium::Subscription
+  include Freemium::ManualBilling
+end
+
+class SubscriptionPlan < ActiveRecord::Base
+  include Freemium::SubscriptionPlan
+end
+
+class CreditCard < ActiveRecord::Base
+  include Freemium::CreditCard
+end
+
+class Coupon < ActiveRecord::Base
+  include Freemium::Coupon
+end
+
+class AccountTransaction < ActiveRecord::Base
+  include Freemium::Transaction
+end
+
+class SubscriptionChange < ActiveRecord::Base
+  include Freemium::SubscriptionChange
+end

data/spec/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag :all %>
+  <%= javascript_include_tag :defaults %>
+  <%= csrf_meta_tag %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/spec/dummy/config/application.rb

@@ -0,0 +1,45 @@
+require File.expand_path('../boot', __FILE__)
+
+require "active_model/railtie"
+require "active_record/railtie"
+require "action_controller/railtie"
+require "action_view/railtie"
+require "action_mailer/railtie"
+
+Bundler.require
+require "freemium"
+
+module Dummy
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Custom directories with classes and modules you want to be autoloadable.
+    # config.autoload_paths += %W(#{config.root}/extras)
+
+    # Only load the plugins named here, in the order given (default is alphabetical).
+    # :all can be used as a placeholder for all plugins not explicitly named.
+    # config.plugins = [ :exception_notification, :ssl_requirement, :all ]
+
+    # Activate observers that should always be running.
+    # config.active_record.observers = :cacher, :garbage_collector, :forum_observer
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+
+    # JavaScript files you want as :defaults (application.js is always included).
+    # config.action_view.javascript_expansions[:defaults] = %w(jquery rails)
+
+    # Configure the default encoding used in templates for Ruby 1.9.
+    config.encoding = "utf-8"
+
+    # Configure sensitive parameters which will be filtered from the log file.
+    config.filter_parameters += [:password]
+  end
+end

data/spec/dummy/config/boot.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+gemfile = File.expand_path('../../../../Gemfile', __FILE__)
+
+if File.exist?(gemfile)
+  ENV['BUNDLE_GEMFILE'] = gemfile
+  require 'bundler'
+  Bundler.setup
+end
+
+$:.unshift File.expand_path('../../../../lib', __FILE__)

data/spec/dummy/config/database.yml

@@ -0,0 +1,22 @@
+# 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: db/test.sqlite3
+  pool: 5
+  timeout: 5000
+
+production:
+  adapter: sqlite3
+  database: db/production.sqlite3
+  pool: 5
+  timeout: 5000

data/spec/dummy/config/environment.rb

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

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

@@ -0,0 +1,26 @@
+Dummy::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
+
+  # Don't care if the mailer can't send
+  config.action_mailer.raise_delivery_errors = false
+
+  # Print deprecation notices to the Rails logger
+  config.active_support.deprecation = :log
+
+  # Only use best-standards-support built into browsers
+  config.action_dispatch.best_standards_support = :builtin
+end
+

data/spec/dummy/config/environments/production.rb

@@ -0,0 +1,49 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/environment.rb
+
+  # The production environment is meant for finished, "live" apps.
+  # Code is not reloaded between requests
+  config.cache_classes = true
+
+  # Full error reports are disabled and caching is turned on
+  config.consider_all_requests_local       = false
+  config.action_controller.perform_caching = true
+
+  # Specifies the header that your server uses for sending files
+  config.action_dispatch.x_sendfile_header = "X-Sendfile"
+
+  # For nginx:
+  # config.action_dispatch.x_sendfile_header = 'X-Accel-Redirect'
+
+  # If you have no front-end server that supports something like X-Sendfile,
+  # just comment this out and Rails will serve the files
+
+  # See everything in the log (default is :info)
+  # config.log_level = :debug
+
+  # Use a different logger for distributed setups
+  # config.logger = SyslogLogger.new
+
+  # Use a different cache store in production
+  # config.cache_store = :mem_cache_store
+
+  # Disable Rails's static asset server
+  # In production, Apache or nginx will already do this
+  config.serve_static_assets = false
+
+  # Enable serving of images, stylesheets, and javascripts from an asset server
+  # config.action_controller.asset_host = "http://assets.example.com"
+
+  # Disable delivery errors, bad email addresses will be ignored
+  # config.action_mailer.raise_delivery_errors = false
+
+  # Enable threaded mode
+  # config.threadsafe!
+
+  # Enable locale fallbacks for I18n (makes lookups for any locale fall back to
+  # the I18n.default_locale when a translation can not be found)
+  config.i18n.fallbacks = true
+
+  # Send deprecation notices to registered listeners
+  config.active_support.deprecation = :notify
+end

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

@@ -0,0 +1,35 @@
+Dummy::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
+
+  # Raise exceptions instead of rendering exception templates
+  config.action_dispatch.show_exceptions = false
+
+  # Disable request forgery protection in test environment
+  config.action_controller.allow_forgery_protection    = false
+
+  # Tell Action Mailer not to deliver emails to the real world.
+  # The :test delivery method accumulates sent emails in the
+  # ActionMailer::Base.deliveries array.
+  config.action_mailer.delivery_method = :test
+
+  # Use SQL instead of Active Record's schema dumper when creating the test database.
+  # This is necessary if your schema can't be completely dumped by the schema dumper,
+  # like if you have constraints or database-specific column types
+  # config.active_record.schema_format = :sql
+
+  # Print deprecation notices to the stderr
+  config.active_support.deprecation = :stderr
+end

data/spec/dummy/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/dummy/config/initializers/inflections.rb

@@ -0,0 +1,10 @@
+# Be sure to restart your server when you modify this file.
+
+# Add new inflection rules using the following format
+# (all these examples are active by default):
+# ActiveSupport::Inflector.inflections do |inflect|
+#   inflect.plural /^(ox)$/i, '\1en'
+#   inflect.singular /^(ox)en/i, '\1'
+#   inflect.irregular 'person', 'people'
+#   inflect.uncountable %w( fish sheep )
+# end

data/spec/dummy/config/initializers/mime_types.rb

@@ -0,0 +1,5 @@
+# Be sure to restart your server when you modify this file.
+
+# Add new mime types for use in respond_to blocks:
+# Mime::Type.register "text/richtext", :rtf
+# Mime::Type.register_alias "text/html", :iphone

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

@@ -0,0 +1,7 @@
+# Be sure to restart your server when you modify this file.
+
+# Your secret key for verifying the integrity of signed cookies.
+# If you change this key, all old signed cookies will become invalid!
+# Make sure the secret is at least 30 characters and all random,
+# no regular words or you'll be exposed to dictionary attacks.
+Dummy::Application.config.secret_token = '32ff0922af7d72911ef15e5683529d342aeb03d85258fd55ca9e3899a66c411ab2a97c2acbaadae3edb5854b612414a46e30738cd0edfba6596ab042c51f0943'

data/spec/dummy/config/initializers/session_store.rb

@@ -0,0 +1,8 @@
+# Be sure to restart your server when you modify this file.
+
+Dummy::Application.config.session_store :cookie_store, :key => '_dummy_session'
+
+# Use the database for sessions instead of the cookie-based default,
+# which shouldn't be used to store highly confidential information
+# (create the session table with "rake db:sessions:create")
+# Dummy::Application.config.session_store :active_record_store

data/spec/dummy/config/locales/en.yml

@@ -0,0 +1,5 @@
+# Sample localization file for English. Add more files in this directory for other locales.
+# See http://github.com/svenfuchs/rails-i18n/tree/master/rails%2Flocale for starting points.
+
+en:
+  hello: "Hello world"