paid_up 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8749a10b3993668ec11892a4a49391b4235db01c
+  data.tar.gz: 6f348418bef2d0fdc4c5b4b485050574bb8dbec9
+SHA512:
+  metadata.gz: c58032ff450db87621d911fb5162b148359fa0c0af89a584e0dbd5b14c985ac58b226ec16d6b8390809a85dda234bdd1a524769edb700d874f726f9f125e5a68
+  data.tar.gz: 199c1168d660868995886ded446078f81403f91fa3ae144cf714417bffdc3ac13baddf09aeaa6d9336c134d84108a5ac5597cf1612de83cb135d076ce24bf0d3

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - ruby-2.2.1

data/Gemfile

@@ -0,0 +1,46 @@
+source "https://rubygems.org"
+
+gem 'rails', '>= 4.2'
+gem 'rails-i18n'
+gem 'haml-rails'
+gem 'jquery-rails'
+gem 'uglifier'
+gem 'jeweler'
+
+gem 'bootstrap_leather'
+
+gem 'seedbank'
+gem 'chronic'
+gem 'money'
+
+gem 'devise'
+gem 'cancan'
+gem 'stripe'
+
+group :test, :development do
+  gem 'rspec-rails'
+  gem 'rspec-collection_matchers'
+  gem 'database_cleaner'
+  gem 'sqlite3'
+  gem 'high_voltage'
+  gem 'forgery'
+  gem 'bootstrap-sass', '~> 3.3.4'
+  gem 'sass-rails', '>= 3.2'
+end
+
+group :test do
+  gem 'cucumber-rails', require: false
+  gem 'shoulda-matchers'
+  gem 'minitest', '~>5.5.1'
+  gem "launchy", "~> 2.1.2", require: false
+  gem 'factory_girl_rails', require: false
+  gem 'coveralls', require: false
+end
+
+# Declare any dependencies that are still in development here instead of in
+# your gemspec. These might include edge Rails or gems from your path or
+# Git. Remember to move these dependencies to your gemspec before releasing
+# your gem to rubygems.org.
+
+# To use debugger
+# gem 'debugger'

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2015 Gem Vein
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2015 YOURNAME
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,64 @@
+Paid Up
+===========
+
+[![GitHub version](https://badge.fury.io/gh/gemvein%2Fpaid_up.svg)](http://badge.fury.io/gh/gemvein%2Fpaid_up)
+[![Build Status](https://travis-ci.org/gemvein/paid_up.svg)](https://travis-ci.org/gemvein/paid_up)
+[![Coverage Status](https://coveralls.io/repos/gemvein/paid_up/badge.png)](https://coveralls.io/r/gemvein/paid_up)
+
+Paid Up is a start-to-finish Stripe subscription engine. You set up the plans you want on Stripe, and the gem gives you a way to tie those plans to authenticated users, granting them abilities based on the features outlined for their plan.
+
+* Ruby 2, Rails 4
+* Authentication by Devise
+* Authorization by CanCan
+* Subscription by Stripe
+* Assumes you will be using some variety of Bootstrap, and designed to be quite responsive out of the box, but included views can be overridden with custom views.
+
+Installation
+----------------------------
+First, add paid_up to your `Gemfile`:
+
+    gem 'paid_up'
+    
+To start with, you will need a User model and the corresponding table, set up with your business rules for users, such as profile fields or theme configuration.
+
+Next, install PaidUp for your user model by executing these commands:
+
+    bundle install
+    rails g paid_up:install
+    rake db:migrate
+    
+Configuration
+----------------------------    
+
+Edit your config file at `config/initializers/paid_up.rb` to set up some other key details.
+
+Set your environment variables with your STRIPE_PUBLISHABLE_KEY and your STRIPE_SECRET_KEY. (Check your operating system or IDE's documentation for details)
+
+Stripe Setup
+----------------------------
+
+Using your own code or Stripe's convenient web interface, add the plans you intend to offer. Each will also need a record in your own database, so for each `Stripe::Plan` you create, note the `id` and use it as the `stripe_id` in the corresponding `PaidUp::Plan`. At a minimum, you will need an anonymous plan, a free plan, both with a cost amount of `0`; and also at least one paid plan.
+
+Next, add a `Stripe::Customer` to serve as the Anonymous User, and subscribe that customer to the anonymous plan. Note the customer's `id` and copy that into your stripe configuration file.
+
+Features Setup
+----------------------------
+
+Set up each `PaidUp::Feature` using your own admin, the console, or seed data. Associate the features with the corresponding plans using the `PaidUp::FeaturesPlan` joining table model. For example, check out the seeds files in [`spec/dummy/db/seeds/`](spec/dummy/db/seeds/)
+
+Contributing to Paid Up
+----------------------------
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+Copyright
+---------
+
+Copyright (c) 2015 Gem Vein. See LICENSE.txt for further details.
+

data/Rakefile

@@ -0,0 +1,48 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "paid_up"
+  gem.homepage = "http://www.gemvein.com/museum/cases/paid_up"
+  gem.license = "MIT"
+  gem.summary = %Q{Allows a model of your choosing to subscribe to a plan, which enables features.}
+  gem.description = %Q{Allows a model of your choosing (such as users) to subscribe to a plan, which enables features.}
+  gem.email = "karen.e.lundgren@gmail.com"
+  gem.authors = ["Karen Lundgren"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'PaidUp'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+Bundler::GemHelper.install_tasks
+

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/app/controllers/paid_up/paid_up_controller.rb

@@ -0,0 +1,12 @@
+module PaidUp
+  class PaidUpController < ApplicationController
+    helper :all
+
+    before_action :set_locale
+
+  private
+    def set_locale
+      I18n.locale = params[:locale] || I18n.default_locale
+    end
+  end
+end

data/app/controllers/paid_up/plans_controller.rb

@@ -0,0 +1,7 @@
+module PaidUp
+  class PlansController < PaidUpController
+    def index
+      @plans = PaidUp::Plan.subscribable
+    end
+  end
+end

data/app/controllers/paid_up/subscriptions_controller.rb

@@ -0,0 +1,37 @@
+module PaidUp
+  class SubscriptionsController < PaidUpController
+    before_filter :authenticate_user!
+    before_filter :set_plan, only: [:new, :create]
+
+    def index
+      # nothing to do, everything we need is in current_user
+    end
+
+    def new
+      # nothing to do, @plan set by #set_plan
+      if current_user.can_downgrade_to? @plan || @plan.amount == 0
+        create
+      end
+    end
+
+    def create
+      # @plan set by #set_plan
+      if current_user.subscribe_to_plan(@plan, params[:stripeToken])
+        redirect_to subscriptions_path, flash: { notice: :you_are_now_subscribed_to_the_plan.l(plan_name: current_user.plan.name) }
+      else
+        redirect_to new_plan_subscription_path @plan, flash: { error: current_user.errors.full_messages || :could_not_subscribe_to_plan.l(plan: @plan.name) }
+      end
+    rescue Stripe::InvalidRequestError => e
+      flash[:error] = e.message
+      redirect_to plans_path
+    rescue Stripe::CardError => e
+      flash[:error] = e.message
+      redirect_to new_plan_subscription_path
+    end
+
+    private
+    def set_plan
+      @plan = PaidUp::Plan.find(params[:plan_id])
+    end
+  end
+end

data/app/helpers/paid_up/features_helper.rb

@@ -0,0 +1,65 @@
+module PaidUp
+  module FeaturesHelper
+    include PaidUp::PaidUpHelper
+
+    def features_dl(plan)
+      data = {}
+      features = PaidUp::Feature.all
+
+      for feature in features
+        data[feature.title] = feature_display feature, plan
+      end
+
+      dl data
+    end
+
+    def feature_display(feature, plan)
+      if feature.setting_type == 'boolean'
+        if plan.feature_setting(feature.id)
+          icon 'ok'
+        else
+          icon 'remove'
+        end
+      elsif plan.feature_unlimited?(feature.id)
+        :unlimited.l
+      else
+        plan.feature_setting(feature.id)
+      end
+    end
+
+    def features_table(options = {})
+      features = PaidUp::Feature.all
+
+      if !options[:should_add_buttons].nil?
+        should_add_buttons = options[:should_add_buttons]
+        options.delete(:should_add_buttons)
+      else
+        should_add_buttons = true
+      end
+
+      plans = PaidUp::Plan.subscribable
+      if options[:only].present?
+        plans = plans.where('id IN (?)', options[:only])
+        options.delete(:only)
+      end
+      if options[:except].present?
+        plans = plans.where('NOT ( id IN (?) )', options[:except])
+        options.delete(:except)
+      end
+
+      if options[:highlight].present?
+        highlight_plan = options[:highlight]
+        options.delete(:highlight)
+      else
+        highlight_plan = nil
+      end
+
+      render(partial: 'paid_up/features/table', locals: { should_add_buttons: should_add_buttons, plans: plans, features: features, highlight_plan: highlight_plan, html_options: options})
+    end
+
+    def feature_abilities_table(options = {})
+      features = PaidUp::Feature.all
+      render(partial: 'paid_up/features/abilities_table', locals: { features: features, html_options: options})
+    end
+  end
+end

data/app/helpers/paid_up/paid_up_helper.rb

@@ -0,0 +1,14 @@
+module PaidUp
+  module PaidUpHelper
+    def date_range(start_date, end_date)
+      dates = []
+      if start_date.present? && (start_date.is_a?(Date) || start_date.is_a?(Integer))
+        dates << start_date.to_date
+      end
+      if end_date.present? && (end_date.is_a?(Date) || end_date.is_a?(Integer))
+        dates << end_date.to_date
+      end
+      dates.join('&mdash;').html_safe
+    end
+  end
+end

data/app/helpers/paid_up/plans_helper.rb

@@ -0,0 +1,53 @@
+module PaidUp
+  module PlansHelper
+    include ::ActionView::Helpers::NumberHelper
+
+    def plan_charge_human(plan)
+      plan.money.format + '/' + plan_period_phrase(plan)
+    end
+
+    def plan_period_phrase(plan)
+      period_phrase = ''
+      if plan.interval_count > 1
+        period_phrase += plan.interval_count.to_s
+        period_phrase += ' '
+      end
+      period_phrase + plan.interval.capitalize
+    end
+
+    def plan_button(plan, text = nil, html_options = {})
+      data = {}
+      css_class = 'btn '
+      disabled_state = false
+      link = paid_up.new_plan_subscription_path(plan)
+      if user_signed_in?
+        text ||= :subscribe.l
+        if current_user.can_upgrade_to? plan
+          icon_class = 'arrow-up'
+          css_class += 'btn-success'
+        elsif current_user.can_downgrade_to? plan
+          icon_class = 'arrow-down'
+          css_class += 'btn-danger'
+          data[:confirm] = :are_you_sure.l
+        elsif current_user.is_subscribed_to? plan
+          icon_class = 'ok'
+          css_class += 'btn-disabled'
+          disabled_state = true
+          link = '#'
+          text = :already_subscribed.l
+        else # Plans are equal in sort_order
+          icon_class = 'arrow-right'
+          css_class += 'btn-info'
+        end
+      else
+        text ||= :sign_up.l
+        icon_class = 'arrow-right'
+        css_class += 'btn-success'
+      end
+      html_options[:method] ||= :get
+      html_options[:disabled] ||= disabled_state
+      icon_button_to css_class, icon_class, text, link, html_options
+    end
+
+  end
+end

data/app/helpers/paid_up/subscriptions_helper.rb

@@ -0,0 +1,21 @@
+module PaidUp
+  module SubscriptionsHelper
+    include PaidUp::PaidUpHelper
+
+    def subscription_dl(subscription)
+      data = {}
+
+      data[:status.l] = subscription.status
+
+      if subscription.current_period_start || subscription.current_period_end
+        data[:paid_thru.l]= date_range(subscription.current_period_start, subscription.current_period_end)
+      end
+
+      if subscription.trial_start || subscription.trial_end
+        data[:trial_period.l]= date_range(subscription.trial_start, subscription.trial_end)
+      end
+
+      dl data
+    end
+  end
+end

data/app/models/ability.rb

@@ -0,0 +1,37 @@
+class Ability
+  include CanCan::Ability
+
+  def initialize(user)
+    user ||= User.new # anonymous user (not logged in)
+
+    # Rails Application's initialization could go here.
+
+    initialize_paid_up(user)
+  end
+
+  def initialize_paid_up(user)
+    features = PaidUp::Feature.all
+
+    for feature in features
+
+      case feature.setting_type
+        when 'table_rows'
+          model = feature.name.classify.constantize
+          if user.table_rows_allowed(feature.name) > 0 || user.table_rows_allowed(feature.name) == -1
+            can :manage, model, :user => user
+            can :own, model
+            unless user.table_rows_remaining(feature.name) > 0
+              cannot :create, model
+            end
+          end
+          can :read, model
+        when 'boolean'
+          if user.plan.feature_setting feature.id
+            can :use, feature.name.to_sym
+          end
+        else
+          raise(:unknown_feature_type.l)
+      end
+    end
+  end
+end

data/app/models/paid_up/feature.rb

@@ -0,0 +1,19 @@
+class PaidUp::Feature < ActiveRecord::Base
+  has_many :features_plans, class_name: 'PaidUp::FeaturesPlan'
+  has_many :plans, :through => :features_plans, class_name: 'PaidUp::Plan'
+
+  validates_presence_of :name, :title, :setting_type
+
+  validates_with PaidUp::TableValidator, field: 'setting_type', comparison: 'table_rows', found_in: 'name'
+
+  def feature_model_name
+    if setting_type != 'table_rows'
+      raise :no_conversion_of_type_features_to_table_rows.l type: setting_type
+    end
+    name.classify
+  end
+
+  def feature_model
+    feature_model_name.constantize
+  end
+end

data/app/models/paid_up/features_plan.rb

@@ -0,0 +1,14 @@
+class PaidUp::FeaturesPlan < ActiveRecord::Base
+  belongs_to :plan, class_name: 'PaidUp::Plan'
+  belongs_to :feature, class_name: 'PaidUp::Feature'
+  validates_presence_of :setting
+
+  after_initialize :catch_unlimited_in_setting
+
+  private
+    def catch_unlimited_in_setting
+      if setting == PaidUp::Unlimited.to_i(:db)
+        self.setting = PaidUp::Unlimited
+      end
+    end
+end

data/app/models/paid_up/plan.rb

@@ -0,0 +1,99 @@
+class PaidUp::Plan < ActiveRecord::Base
+  has_many :features_plans, class_name: 'PaidUp::FeaturesPlan'
+  has_many :features, :through => :features_plans, class_name: 'PaidUp::Feature'
+
+  validates_presence_of :description, :name
+
+  after_initialize :load_stripe_data
+
+  attr_accessor :stripe_data
+
+  default_scope { order('sort_order ASC') }
+  scope :subscribable, -> { where('sort_order >=  ?', 0) }
+  scope :free, -> { find_by_stripe_id(PaidUp.configuration.free_plan_stripe_id) }
+
+  def reload(*args, &blk)
+    super *args, &blk
+    load_stripe_data
+    self
+  end
+
+  def feature_setting_by_name(feature_name)
+    feature = PaidUp::Feature.find_by_name(feature_name) || raise(:feature_not_found.l)
+    feature_setting(feature.id)
+  end
+
+  def feature_setting(feature_id)
+    feature = PaidUp::Feature.find(feature_id) || raise(:feature_not_found.l)
+    raw = features_plans.where(feature_id: feature_id)
+    case feature.setting_type
+      when 'boolean'
+        if raw.empty?
+          false
+        else
+          raw.first.setting != 0
+        end
+      when 'table_rows'
+        if raw.empty?
+          0
+        else
+          raw.first.setting
+        end
+      else
+        raise :error_handling_feature_setting.l feature: feature
+    end
+  end
+
+  def feature_unlimited?(feature_id)
+    feature_setting(feature_id) == PaidUp::Unlimited.to_i
+  end
+
+  def interval
+    if stripe_data.present?
+      stripe_data.interval
+    else
+      :default_interval.l
+    end
+  end
+
+  def interval_count
+    if stripe_data.present?
+      stripe_data.interval_count
+    else
+      1
+    end
+  end
+
+  def amount
+    if stripe_data.present?
+      stripe_data.amount
+    else
+      0
+    end
+  end
+
+  def money
+    Money.new(amount, currency)
+  end
+
+  def charge
+    money.amount
+  end
+
+  def currency
+    if stripe_data.present?
+      stripe_data.currency.upcase
+    else
+      :default_currency.l.upcase
+    end
+  end
+
+  private
+
+  def load_stripe_data
+    if stripe_id.present?
+      self.stripe_data = Stripe::Plan.retrieve stripe_id
+    end
+  end
+
+end

data/app/views/devise/confirmations/new.html.haml

@@ -0,0 +1,13 @@
+- add_title :resend_confirmation_instructions.l
+= form_for(resource, as: resource_name, url: confirmation_path(resource_name), class: 'form-horizontal', html: { method: :post }) do |f|
+  = devise_error_messages!
+  .form-group
+    = f.label :email, class: 'col-sm-2 control-label'
+    .col-sm-2
+      = f.email_field :email, autofocus: true, class: 'col-sm-offset-2 form-control'
+  .form-group
+    .col-sm-2
+      .col-sm-offset-2
+        = f.submit :resend_confirmation_instructions.l
+- add_widget do
+  = render "devise/shared/links"

data/app/views/devise/passwords/edit.html.haml

@@ -0,0 +1,19 @@
+- add_title :change_your_password.l
+= form_for(resource, as: resource_name, url: password_path(resource_name), html: { method: :put, class: 'form-horizontal' }) do |f|
+  = devise_error_messages!
+  = f.hidden_field :reset_password_token
+  .form-group
+    = f.label :password, "New password", class: 'col-sm-2 control-label'
+    .col-sm-2
+      = f.password_field :password, autofocus: true, autocomplete: "off", class: 'col-sm-offset-2 form-control'
+  .form-group
+    = f.label :password_confirmation, "Confirm new password", class: 'col-sm-2 control-label'
+    .col-sm-2
+      = f.password_field :password_confirmation, autocomplete: "off", class: 'col-sm-offset-2 form-control'
+  .form-group
+    .col-sm-2
+    .col-sm-2
+      .col-sm-offset-2
+        = f.submit :change_your_password.l, class: 'btn btn-primary'
+- add_widget do
+  = render "devise/shared/links"

data/app/views/devise/passwords/new.html.haml

@@ -0,0 +1,14 @@
+- add_title :forgot_your_password.l
+= form_for(resource, as: resource_name, url: password_path(resource_name), html: { method: :post, class: 'form-horizontal' }) do |f|
+  = devise_error_messages!
+  .form-group
+    = f.label :email, class: 'col-sm-2 control-label'
+    .col-sm-2
+      = f.email_field :email, autofocus: true, class: 'col-sm-offset-2 form-control'
+  .form-group
+    .col-sm-2
+    .col-sm-2
+      .col-sm-offset-2
+        = f.submit :send_me_reset_password_instructions.l, class: 'btn btn-primary'
+- add_widget do
+  = render "devise/shared/links"