RubyGems - tellimus - Versions diffs - 0.0.3 - Mend

tellimus 0.0.3

Files changed (87) hide show

checksums.yaml +7 -0
data/MIT-LICENSE +20 -0
data/README.md +152 -0
data/Rakefile +10 -0
data/app/assets/javascripts/tellimus/application.js +13 -0
data/app/assets/stylesheets/tellimus/application.css +13 -0
data/app/assets/stylesheets/tellimus/pricing-table.scss +78 -0
data/app/concerns/tellimus/plan.rb +8 -0
data/app/concerns/tellimus/subscription.rb +275 -0
data/app/controllers/tellimus/application_controller.rb +6 -0
data/app/controllers/tellimus/subscriptions_controller.rb +189 -0
data/app/helpers/tellimus/application_helper.rb +20 -0
data/app/views/layouts/tellimus/application.html.erb +13 -0
data/app/views/tellimus/subscriptions/_braintree_js.html.erb +8 -0
data/app/views/tellimus/subscriptions/_card.html.erb +26 -0
data/app/views/tellimus/subscriptions/_pricing_table.html.erb +40 -0
data/app/views/tellimus/subscriptions/_social_proof.html.erb +11 -0
data/app/views/tellimus/subscriptions/edit.html.erb +7 -0
data/app/views/tellimus/subscriptions/index.html.erb +2 -0
data/app/views/tellimus/subscriptions/new.html.erb +1 -0
data/app/views/tellimus/subscriptions/show.html.erb +15 -0
data/app/views/tellimus/subscriptions/unauthorized.html.erb +1 -0
data/config/environment.rb +0 -0
data/config/locales/en.yml +58 -0
data/config/routes.rb +10 -0
data/lib/generators/tellimus/install_generator.rb +66 -0
data/lib/generators/tellimus/templates/app/models/plan.rb +6 -0
data/lib/generators/tellimus/templates/app/models/subscription.rb +7 -0
data/lib/generators/tellimus/templates/config/initializers/tellimus.rb +14 -0
data/lib/generators/tellimus/views_generator.rb +31 -0
data/lib/tasks/tellimus_tasks.rake +12 -0
data/lib/tellimus/engine.rb +20 -0
data/lib/tellimus/errors.rb +4 -0
data/lib/tellimus/version.rb +3 -0
data/lib/tellimus.rb +83 -0
data/spec/concerns/tellimus/plan_spec.rb +39 -0
data/spec/concerns/tellimus/subscription_spec.rb +0 -0
data/spec/controllers/tellimus/subscriptions_controller.rb +21 -0
data/spec/dummy/README.rdoc +261 -0
data/spec/dummy/Rakefile +7 -0
data/spec/dummy/app/assets/javascripts/application.js +15 -0
data/spec/dummy/app/assets/stylesheets/application.css +13 -0
data/spec/dummy/app/controllers/application_controller.rb +3 -0
data/spec/dummy/app/helpers/application_helper.rb +2 -0
data/spec/dummy/app/models/plan.rb +7 -0
data/spec/dummy/app/models/subscription.rb +6 -0
data/spec/dummy/app/models/user.rb +5 -0
data/spec/dummy/app/views/layouts/application.html.erb +14 -0
data/spec/dummy/app/views/tellimus/subscriptions/_social_proof.html.erb +11 -0
data/spec/dummy/config/application.rb +55 -0
data/spec/dummy/config/boot.rb +10 -0
data/spec/dummy/config/database.yml +25 -0
data/spec/dummy/config/environment.rb +5 -0
data/spec/dummy/config/environments/development.rb +32 -0
data/spec/dummy/config/environments/production.rb +69 -0
data/spec/dummy/config/environments/test.rb +36 -0
data/spec/dummy/config/initializers/backtrace_silencers.rb +7 -0
data/spec/dummy/config/initializers/devise.rb +0 -0
data/spec/dummy/config/initializers/inflections.rb +15 -0
data/spec/dummy/config/initializers/mime_types.rb +5 -0
data/spec/dummy/config/initializers/secret_token.rb +7 -0
data/spec/dummy/config/initializers/session_store.rb +8 -0
data/spec/dummy/config/initializers/tellimus.rb +14 -0
data/spec/dummy/config/initializers/wrap_parameters.rb +14 -0
data/spec/dummy/config/locales/devise.en.yml +59 -0
data/spec/dummy/config/locales/en.yml +5 -0
data/spec/dummy/config/routes.rb +6 -0
data/spec/dummy/config.ru +4 -0
data/spec/dummy/db/development.sqlite3 +0 -0
data/spec/dummy/db/migrate/20130318201927_create_customers.rb +8 -0
data/spec/dummy/db/migrate/20130318204455_create_subscriptions.rb +15 -0
data/spec/dummy/db/migrate/20130318204458_create_plans.rb +14 -0
data/spec/dummy/db/migrate/20130520163946_add_interval_to_plan.rb +5 -0
data/spec/dummy/db/schema.rb +44 -0
data/spec/dummy/db/test.sqlite3 +0 -0
data/spec/dummy/log/development.log +59 -0
data/spec/dummy/log/test.log +48 -0
data/spec/dummy/public/404.html +26 -0
data/spec/dummy/public/422.html +26 -0
data/spec/dummy/public/500.html +25 -0
data/spec/dummy/public/favicon.ico +0 -0
data/spec/dummy/script/rails +6 -0
data/spec/dummy/test/fixtures/customers.yml +7 -0
data/spec/dummy/test/unit/customer_test.rb +7 -0
data/spec/dummy/tmp/development_secret.txt +1 -0
data/spec/spec_helper.rb +30 -0
metadata +306 -0

checksums.yaml ADDED Viewed

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1b9357bda0c37119e06e966a8c4c646ce8657fdc9b4d2fd3ecc6315b5ecbbfca
+  data.tar.gz: e7999a21034571119aaf8b4f4ed324f6d0d18f008edfc515fe81629ac12a13a5
+SHA512:
+  metadata.gz: 3381634d0f210a10b1095cb0211bc6b25dbdaf5f1122b30540aca77b292a7f6bf01de4d0e4ff5eced5cf9b4b0f99395330b3c249e82034e7a024dd730969e79d
+  data.tar.gz: c2ec10112720a00d9b411103cac24a9e9b9d174be2a6b6109487336e8122bd7b049bee0ee1f424facd7bdef8f580a7c499d831eddcf7caa1edef852e1ac71757

data/MIT-LICENSE ADDED Viewed

@@ -0,0 +1,20 @@
+Copyright 2013 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 ADDED Viewed

@@ -0,0 +1,152 @@
+# Tellimus
+Robust subscription support for Ruby on Rails apps using [Braintree](https://braintreepayments.com), including out-of-the-box pricing pages, payment pages, and  subscription management for your customers. This is a fork of [Koudoku](https://github.com/andrewculver/koudoku) specifically for Braintree.
+## Installation
+Include the following in your `Gemfile`:
+```ruby
+    gem 'tellimus'
+```
+After running `bundle install`, you can run a Rails generator to do the rest.  You should have a user model.
+```ruby
+    rails g tellimus:install
+    rake db:migrate
+```
+Add the following to `app/views/layouts/application.html.erb` before your `<head>` tag closes:
+```ruby
+    <script src="https://js.braintreegateway.com/js/braintree-2.32.1.min.js"></script>
+    <%= yield :tellimus %>
+```
+(This allows us to inject a Braintree `<script>` tag in the correct place. If you don't, the payment form will not work.)
+After installing, you'll need to add some subscription plans. (You can see an explanation of each of the attributes in the table below.)
+**Note:** You need to create the plans in your [Braintree Dashboard](https://braintreepayments.com) separately.
+```ruby
+    Plan.create({
+      name: 'Personal',
+      price: 10.00,
+      interval: 'month',
+      braintree_id: '1',
+      features: ['1 Project', '1 Page', '1 User', '1 Organization'].join("\n\n"),
+      display_order: 1
+    })
+    Plan.create({
+      name: 'Team',
+      highlight: true, # This highlights the plan on the pricing page.
+      price: 30.00,
+      interval: 'month',
+      braintree_id: '2',
+      features: ['3 Projects', '3 Pages', '3 Users', '3 Organizations'].join("\n\n"),
+      display_order: 2
+    })
+    Plan.create({
+      name: 'Enterprise',
+      price: 100.00,
+      interval: 'month',
+      braintree_id: '3',
+      features: ['10 Projects', '10 Pages', '10 Users', '10 Organizations'].join("\n\n"),
+      display_order: 3
+    })
+```
+To help you understand the attributes:
+| Attribute       | Type    | Function |
+| --------------- | ------- | -------- |
+| `name`          | string  | Name for the plan to be presented to customers. |
+| `price`         | float   | Price per billing cycle. |
+| `interval`      | string  | *Optional.* What is the billing cycle? Valid options are `month`, `year`, `week`, `3-month`, `6-month`. Defaults to `month`. |
+| `braintree_id`     | string  | The Plan ID in Braintree. |
+| `features`      | string  | A list of features. Supports Markdown syntax. |
+| `display_order` | integer | Order in which to display plans. |
+| `highlight`     | boolean | *Optional.* Whether to highlight the plan on the pricing page. |
+The only view installed locally into your app by default is the `koudoku/subscriptions/_social_proof.html.erb` partial which is displayed alongside the pricing table. It's designed as a placeholder where you can provide quotes about your product from customers that could positively influence your visitors.
+### Configuring Braintree API Keys
+You can supply your publishable and secret API keys in `config/initializers/tellimus.rb`. However, by default it will use the `BRAINTREE_PUBLISHABLE_KEY` and `BRAINTREE_SECRET_KEY` shell environment variables. This encourages people to keep these API keys out of version control. You may want to rename these environment variables to be more application specific.
+In a bash shell, you can set them in `~/.bash_profile` like so:
+```bash
+    export BRAINTREE_PUBLIC_KEY=pk_0CJwDH9sdh98f79FDHDOjdiOxQob0
+    export BRAINTREE_PRIVATE_KEY=sk_0CJwFDIUshdfh97JDJOjZ5OIDjOCH
+    export BRAINTREE_MERCHANT_ID=2dj90d2j3dhnxn2
+    export BRAINTREE_ENVIRONMENT="sandbox"
+```
+(Reload your terminal for these settings to take effect.)
+## User-Facing Subscription Management
+By default a `pricing_path` route is defined which you can link to in order to show visitors a pricing table. If a user is signed in, this pricing table will take into account their current plan. For example, you can link to this page like so:
+```ruby
+    <%= link_to 'Pricing', main_app.pricing_path %>
+```
+(Note: Tellimus uses the application layout, so it's important that application paths referenced in that layout are prefixed with "`main_app.`" like you see above or Rails will try to look the paths up in the Tellimus engine instead of your application.)
+Existing users can view available plans, select a plan, enter credit card details, review their subscription, change plans, and cancel at the following route:
+```ruby
+    tellimus.owner_subscriptions_path(@user)
+```
+In these paths, `owner` refers to `User` by default, or whatever model has been configured to be the owner of the `Subscription` model.
+A number of views are provided by default. To customize the views, use the following generator:
+```ruby
+    rails g tellimus:views
+```
+### Pricing Table
+Tellimus ships with a stock pricing table. By default it depends on Twitter Bootstrap, but also has some additional styles required. In order to import these styles, add the following to your `app/assets/stylesheets/application.css`:
+```css
+    *= require 'tellimus/pricing-table'
+```
+Or, if you've replaced your `application.css` with an `application.scss` (like I always do):
+```css
+    @import "tellimus/pricing-table"
+```
+## Implementing Logging, Notifications, etc.
+The included module defines the following empty "template methods" which you're able to provide an implementation for in `Subscription`:
+ - `prepare_for_plan_change`
+ - `prepare_for_new_subscription`
+ - `prepare_for_upgrade`
+ - `prepare_for_downgrade`
+ - `prepare_for_cancelation`
+ - `prepare_for_card_update`
+ - `finalize_plan_change!`
+ - `finalize_new_subscription!`
+ - `finalize_upgrade!`
+ - `finalize_downgrade!`
+ - `finalize_cancelation!`
+ - `finalize_card_update!`
+ - `card_was_declined`
+Be sure to include a call to `super` in each of your implementations, especially if you're using multiple concerns to break all this logic into smaller pieces.
+Between `prepare_for_*` and `finalize_*`, so far I've used `finalize_*` almost exclusively. The difference is that `prepare_for_*` runs before we settle things with Stripe, and `finalize_*` runs after everything is settled in Stripe. For that reason, please be sure not to implement anything in `finalize_*` implementations that might cause issues with ActiveRecord saving the updated state of the subscription.
+```

data/Rakefile ADDED Viewed

@@ -0,0 +1,10 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(spec: 'app:db:test:prepare')
+task default: :spec

data/app/assets/javascripts/tellimus/application.js ADDED Viewed

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// the compiled file.
+//
+// WARNING: THE FIRST BLANK LINE MARKS THE END OF WHAT'S TO BE PROCESSED, ANY BLANK LINE SHOULD
+// GO AFTER THE REQUIRES BELOW.
+//
+//= require_tree .

data/app/assets/stylesheets/tellimus/application.css ADDED Viewed

@@ -0,0 +1,13 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+ */

data/app/assets/stylesheets/tellimus/pricing-table.scss ADDED Viewed

@@ -0,0 +1,78 @@
+ul.tellimus-pricing-table {
+  position: relative;
+  margin: 20px 0;
+  margin-left: 25px;
+  li.plan {
+    text-align: center;
+    background-color: #f5f5f5;
+    margin-top: 17px;
+    margin-left: 0;
+    position: relative;
+    z-index: 99;
+    &.plan-primary {
+      background-color: #f9f9f9;
+      margin-top: 0px;
+      margin-left: -5px;
+      margin-right: -5px;
+      z-index: 100;
+      h3 {
+        font-size: 32.5px;
+        line-height: 51px;
+      }
+      h4 {
+        line-height: 22px;
+      }
+      a, input[type=submit] {
+        font-size: 21.5px;
+        line-height: 26px;
+      }
+      ul.features {
+        margin-bottom: 12px;
+        li {
+          font-size: 12pt;
+        }
+      }
+    }
+    .call-to-action {
+      margin: 10px 0;
+    }
+    .features {
+      margin: 0;
+      li {
+        list-style: none;
+        padding: 8px;
+        line-height: 18px;
+        vertical-align: top;
+        border-top: 1px solid #dddddd;
+      }
+      li:first-child {
+        border-top: none;
+      }
+    }
+  }
+  .social-proof {
+    padding: 17px 0;
+    blockquote {
+      h2, h3, h4 {
+        padding: 5px 0;
+      }
+    }
+  }
+}

data/app/concerns/tellimus/plan.rb ADDED Viewed

@@ -0,0 +1,8 @@
+module Tellimus::Plan
+  extend ActiveSupport::Concern
+  def is_upgrade_from?(plan)
+    (price || 0) >= (plan.price || 0)
+  end
+end

data/app/concerns/tellimus/subscription.rb ADDED Viewed

@@ -0,0 +1,275 @@
+module Tellimus::Subscription
+  extend ActiveSupport::Concern
+  included do
+    # We don't store these one-time use tokens, but this is what Braintree provides
+    # client-side after storing the credit card information.
+    attr_accessor :payment_method_nonce
+    belongs_to :plan, optional: true
+    # update details.
+    before_save :processing!
+    def processing!
+      # if their package level has changed ..
+      if changing_plans?
+        prepare_for_plan_change
+        # and a subscription exists in stripe ..
+        if braintree_id.present?
+          # if a new plan has been selected
+          if self.plan.present?
+            # Record the new plan pricing.
+            self.current_price = self.plan.price
+            prepare_for_downgrade if downgrading?
+            prepare_for_upgrade if upgrading?
+            # update the package level with braintree.
+            Tellimus.gateway.subscription.update(
+              self.braintree_id,
+              plan_id: self.plan.braintree_id
+            )
+            finalize_downgrade! if downgrading?
+            finalize_upgrade! if upgrading?
+          # if no plan has been selected.
+          else
+            prepare_for_cancelation
+            # Remove the current pricing.
+            self.current_price = nil
+            # delete the subscription.
+            Tellimus.gateway.subscription.cancel(self.braintree_id)
+            finalize_cancelation!
+          end
+        # when customer DOES NOT exist in braintree ..
+        else
+          # if a new plan has been selected
+          if self.plan.present?
+            # Record the new plan pricing.
+            self.current_price = self.plan.price
+            prepare_for_new_subscription
+            prepare_for_upgrade
+            begin
+              raise Tellimus::NilCardToken, "No card token received. Check for JavaScript errors breaking Braintree.js on the previous page." unless payment_method_nonce.present?
+              customer_attributes = {
+                email: subscription_owner_email,
+                payment_method_nonce: payment_method_nonce
+              }
+              # create a customer at that package level.
+              result = Tellimus.gateway.customer.create(customer_attributes)
+              unless result.success?
+                errors[:base] << result.errors
+                card_was_declined
+                return false
+              end
+              finalize_new_customer!(result.customer.id, plan.price)
+              payment_method = result.customer.payment_methods.last
+              subscription_result = Tellimus.gateway.subscription.create(
+                payment_method_token: payment_method.token,
+                plan_id: self.plan.braintree_id
+              )
+              unless subscription_result.success?
+                errors[:base] << subscription.errors
+                card_was_declined
+                return false
+              end
+            # store the customer id.
+            self.braintree_customer_id = result.customer.id
+            self.braintree_id = subscription_result.subscription.id
+            if payment_method.class == Braintree::PayPalAccount
+              self.payment_signature = payment_method.email
+              self.payment_type = "Paypal"
+            else
+              self.payment_signature = payment_method.last_4
+              self.payment_type = payment_method.card_type
+            end
+            finalize_new_subscription!
+            finalize_upgrade!
+            rescue StandardError => e
+              errors[:base] << e
+              return false
+            end
+          else
+            # This should never happen.
+            self.plan_id = nil
+            # Remove any plan pricing.
+            self.current_price = nil
+          end
+        end
+        finalize_plan_change!
+      # if they're updating their credit card details.
+      elsif self.payment_method_nonce.present?
+        prepare_for_card_update
+        # fetch the customer.
+        customer = Tellimus.gateway.customer.find(self.braintree_customer_id)
+        payment_method_response = Tellimus.gateway.payment_method.create(
+          :customer_id => self.braintree_customer_id,
+          :payment_method_nonce => self.payment_method_nonce
+        )
+        subscription_response = Tellimus.gateway.subscription.update(
+          self.braintree_id,
+          payment_method_token: payment_method_response.payment_method.token,
+        )
+        unless subscription_response.success?
+          errors[:base] << subscription_response.errors
+          card_was_declined
+          return false
+        end
+        payment_method_token = subscription_response.subscription.payment_method_token
+        payment_method = Tellimus.gateway.payment_method.find(payment_method_token)
+        if payment_method.class == Braintree::PayPalAccount
+          self.payment_signature = payment_method.email
+          self.payment_type = "Paypal"
+        else
+          self.payment_signature = payment_method.last_4
+          self.payment_type = payment_method.card_type
+        end
+        finalize_card_update!
+      end
+    end
+  end
+  def describe_difference(plan_to_describe)
+    if plan.nil?
+      if persisted?
+        I18n.t('tellimus.plan_difference.upgrade')
+      else
+        if Tellimus.free_trial?
+          I18n.t('tellimus.plan_difference.start_trial')
+        else
+          I18n.t('tellimus.plan_difference.upgrade')
+        end
+      end
+    else
+      if plan_to_describe.is_upgrade_from?(plan)
+        I18n.t('tellimus.plan_difference.upgrade')
+      else
+        I18n.t('tellimus.plan_difference.downgrade')
+      end
+    end
+  end
+  # Pretty sure this wouldn't conflict with anything someone would put in their model
+  def subscription_owner
+    # Return whatever we belong to.
+    # If this object doesn't respond to 'name', please update owner_description.
+    send Tellimus.subscriptions_owned_by
+  end
+  def subscription_owner=(owner)
+    # e.g. @subscription.user = @owner
+    send Tellimus.owner_assignment_sym, owner
+  end
+  def subscription_owner_description
+    # assuming owner responds to name.
+    # we should check for whether it responds to this or not.
+    "#{subscription_owner.try(:name) || subscription_owner.try(:id)}"
+  end
+  def subscription_owner_email
+    "#{subscription_owner.try(:email)}"
+  end
+  def changing_plans?
+    plan_id_changed?
+  end
+  def downgrading?
+    plan.present? and plan_id_was.present? and plan_id_was > self.plan_id
+  end
+  def upgrading?
+    (plan_id_was.present? and plan_id_was < plan_id) or plan_id_was.nil?
+  end
+  # Template methods.
+  def prepare_for_plan_change
+  end
+  def prepare_for_new_subscription
+  end
+  def prepare_for_upgrade
+  end
+  def prepare_for_downgrade
+  end
+  def prepare_for_cancelation
+  end
+  def prepare_for_card_update
+  end
+  def finalize_plan_change!
+  end
+  def finalize_new_subscription!
+  end
+  def finalize_new_customer!(customer_id, amount)
+  end
+  def finalize_upgrade!
+  end
+  def finalize_downgrade!
+  end
+  def finalize_cancelation!
+  end
+  def finalize_card_update!
+  end
+  def card_was_declined
+  end
+  # stripe web-hook callbacks.
+  def payment_succeeded(amount)
+  end
+  def charge_failed
+  end
+  def charge_disputed
+  end
+end

data/app/controllers/tellimus/application_controller.rb ADDED Viewed

@@ -0,0 +1,6 @@
+module Tellimus
+  class ApplicationController < ::ApplicationController
+    layout Tellimus.layout
+    helper :application
+  end
+end