paid_up 0.2.4 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1e99f660fe6ef9bb9d9afd0ed0335084916ceb65
-  data.tar.gz: c1d31256b8769576aa47b8c8c9d277ecc52a6d8c
+  metadata.gz: da81f695f2094574cefed7cb6aaaffdd15bb9326
+  data.tar.gz: e3c4755cf8c29caea0bde253637001751d1d096a
 SHA512:
-  metadata.gz: 419a3f9468e4e9e91be0b9a1fc1b7183057aa974bde6dc6f1d2a4795f02ec72d1c5668dd716a0da01beccc2330f0ada633fafd5d5f65153a3848d04ea251e683
-  data.tar.gz: b939fe5c9760a1fc9f5bfb8a48e4c2fa68e0466e25073c746354947882355c426ac7d3cfeb274c840952b732e091b186650c6727d6d988e2504de1a42fe44852
+  metadata.gz: 19f7b0cf4a1db0adc4f18272c5f32087887e95631a73986d501498f16ee7b8175749cdb8f37f22ed11e414cacc605f191dfbf0025289a4ff0a8252e3c764305d
+  data.tar.gz: 3f64aa28876b80c9623142b8efca71e0671be455e668aae14caf1eaeb6250d268ba1b11dcc0466abb2a975f6f7df03d70e9669e8ba28a5b0ffb0817e98a189b2

data/Gemfile

@@ -15,6 +15,7 @@ gem 'money', '~> 6.5'
 
 gem 'devise', '~> 3.4'
 gem 'cancan', '~> 1.6'
+gem 'rolify', '~> 4'
 gem 'stripe', '~> 1.21'
 
 group :test, :development do
@@ -22,9 +23,11 @@ group :test, :development do
   gem 'forgery', '~> 0.6'
   gem 'bootstrap-sass', '~> 3.3'
   gem 'sass-rails', '~> 5.0'
+  gem 'high_voltage', '~> 2.3'
 end
 
 group :test do
+  gem 'capybara', '~> 2.4'
   gem 'rspec-rails', '~> 3.2'
   gem 'database_cleaner', '~> 1.4'
   gem 'rspec-collection_matchers', '~> 1.1'

data/README.md

@@ -1,5 +1,4 @@
-Paid Up
-===========
+# 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)
@@ -13,8 +12,8 @@ Paid Up is a start-to-finish Stripe subscription engine. You set up the plans yo
 * 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
-----------------------------
+## Installation
+
 First, add paid_up to your `Gemfile`:
 
     gem 'paid_up'
@@ -29,37 +28,44 @@ Next, install PaidUp for your user model by executing these commands:
     rails g paid_up:install
     rake db:migrate
     
-Configuration
-----------------------------    
+## 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
-----------------------------
+## 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
-----------------------------
+## Features Setup
+
+Set up each `PaidUp::Feature` using the config file. (A config file is used rather than using records in an `ActiveRecord::Base` model because relationships cannot be created at runtime.) Associate the features with the corresponding plans using the `PaidUp::FeaturesPlan` model. For an example, check out the seeds files in [`spec/dummy/db/seeds/`](spec/dummy/db/seeds/)
 
-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/)
+Possible `:setting_type` values are: `boolean`, `table_rows`, `rolify_rows`. The latter two require that a table corresponding to the feature's `:name` value. 
 
-Enabling Javascript
-----------------------------
+#### Setting Type: Table Rows
 
-In order for PaidUp's AJAX functionality to work, you will need to add this to your layout file, preferably at the very end of the <body> element (for speed reasons):
+In the `table_rows` case, the table and its model must exist. the table should have a `:user_id` column, and from there the appropriate `has_many` and `belongs_to` relationships will be created for you.
+
+#### Setting Type: Rolify Rows
+    
+In the `rolify_rows` case, the table and its model must also exist. Once that is done and the corresponding `PaidUp::Feature` is created, the resource model will run the `resourcify` method, and the User method will have had the `rolify` method added to it during install, so no further setup is required.
+
+## Enabling Javascript
+
+In order for PaidUp's AJAX functionality to work (which is required because Stripe uses AJAX), you will need to add this to your layout file, preferably near the end of the <body> element (for speed reasons):
 
     = render_footer_javascript
     
-Abilities
------------------------------
+## Abilities
 
-Abilities corresponding to features you have defined will be generated automatically for you if you include the PaidUp::Ability module and use the `initialize_paid_up(user)` command, like this:
+Abilities corresponding to features you have defined will be generated automatically, as an `:own` ability on the specified tables, if you include the PaidUp::Ability module and use the `initialize_paid_up(user)` command, like this:
 
+    # /app/models/ability.rb
     class Ability
       include CanCan::Ability
       include PaidUp::Ability
@@ -74,8 +80,10 @@ Abilities corresponding to features you have defined will be generated automatic
       end
     end
 
-Contributing to Paid Up
-----------------------------
+Note that you will probably need to set up `:manage` and `:read` , according to your business rules.
+
+## 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.
@@ -85,7 +93,7 @@ Contributing to Paid Up
 * 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
 ---------
 
 Copyright (c) 2015 Gem Vein. See LICENSE.txt for further details.

data/VERSION

@@ -1 +1 @@
-0.2.4
+0.3.0

data/app/helpers/paid_up/features_helper.rb

@@ -15,15 +15,15 @@ module PaidUp
 
     def feature_display(feature, plan)
       if feature.setting_type == 'boolean'
-        if plan.feature_setting(feature.id)
+        if plan.feature_setting(feature.slug)
           icon 'ok'
         else
           icon 'remove'
         end
-      elsif plan.feature_unlimited?(feature.id)
+      elsif plan.feature_unlimited?(feature.slug)
         :unlimited.l
       else
-        plan.feature_setting(feature.id)
+        plan.feature_setting(feature.slug)
       end
     end
 

data/app/models/paid_up/ability.rb

@@ -4,23 +4,41 @@ module PaidUp
 
     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
+            can :read, feature.feature_model
+            if user.table_rows_allowed(feature.slug) > 0 || user.table_rows_unlimited?(feature.slug)
+              can :manage, feature.feature_model, :user => user
+              can :own, feature.feature_model
+              unless user.table_rows_remaining(feature.slug) > 0
+                cannot :create, feature.feature_model
+              end
+            else
+              cannot :delete, feature.feature_model
+              cannot :update, feature.feature_model
+              cannot :own, feature.feature_model
+              cannot :create, feature.feature_model
+            end
+          when 'rolify_rows'
+            can :read, feature.feature_model
+            if user.rolify_rows_allowed(feature.slug) > 0 || user.rolify_rows_unlimited?(feature.slug)
+              can :manage, feature.feature_model do |record|
+                user.has_role? :owner, record
+              end
+              can :own, feature.feature_model
+              unless user.rolify_rows_remaining(feature.slug) > 0
+                cannot :create, feature.feature_model
               end
+            else
+              cannot :delete, feature.feature_model
+              cannot :update, feature.feature_model
+              cannot :own, feature.feature_model
+              cannot :create, feature.feature_model
             end
-            can :read, model
           when 'boolean'
-            if user.plan.feature_setting feature.id
-              can :use, feature.name.to_sym
+            if user.plan.feature_setting feature.slug
+              can :use, feature.slug.to_sym
             end
           else
             raise(:unknown_feature_type.l)

data/app/models/paid_up/feature.rb

@@ -1,19 +1,81 @@
-class PaidUp::Feature < ActiveRecord::Base
-  has_many :features_plans, class_name: 'PaidUp::FeaturesPlan'
-  has_many :plans, :through => :features_plans, class_name: 'PaidUp::Plan'
+class PaidUp::Feature
+  include ActiveModel::Model
+  include ActiveModel::AttributeMethods
 
-  validates_presence_of :name, :title, :setting_type
+  @@instance_collector = {}
 
-  validates_with PaidUp::TableValidator, field: 'setting_type', comparison: 'table_rows', found_in: 'name'
+  attr_accessor :slug, :title, :setting_type, :description
+
+  validates_presence_of :slug, :title, :setting_type
+  validates :setting_type, inclusion: { in: %w(boolean table_rows rolify_rows) }
+  validates_with PaidUp::Validators::TableRows, field: 'setting_type', comparison: 'table_rows', found_in: 'slug'
+  validates_with PaidUp::Validators::RolifyRows, field: 'setting_type', comparison: 'rolify_rows', found_in: 'slug'
+
+  def initialize(attributes = {})
+    super attributes
+    if self.slug.present?
+      @@instance_collector[self.slug.to_sym] = self
+    end
+  end
+
+  def to_s
+    slug
+  end
 
   def feature_model_name
-    if setting_type != 'table_rows'
-      raise :no_conversion_of_type_features_to_table_rows.l type: setting_type
+    acceptable_setting_types = ['table_rows', 'rolify_rows']
+    unless acceptable_setting_types.include? setting_type
+      raise :no_implicit_conversion_of_type_features.l(type: setting_type)
     end
-    name.classify
+    slug.classify
   end
 
   def feature_model
     feature_model_name.constantize
   end
+
+  def self.all
+    @@instance_collector.values
+  end
+
+  def self.find_by_slug(slug)
+    @@instance_collector[slug.to_sym]
+  end
+
+  def self.find_all(**conditions)
+    collection = []
+    for feature in all
+      qualifies = true
+      conditions.each do |key, value|
+        unless feature.send(key) == value
+          qualifies = false
+        end
+      end
+      if qualifies
+        collection << feature
+      end
+    end
+    collection
+  end
+
+  def self.find(**conditions)
+    find_all(conditions).first
+  end
+
+  # Define on self, since it's  a class method
+  def self.method_missing(method_sym, *arguments, &block)
+    # the first argument is a Symbol, so you need to_s it if you want to pattern match
+    if method_sym.to_s =~ /^find_by_(.*)$/
+      self.find($1.to_sym => arguments.first)
+    elsif method_sym.to_s =~ /^find_all_by_(.*)$/
+      self.find_all($1.to_sym => arguments.first)
+    else
+      super
+    end
+  end
+
+  def self.respond_to_missing?(method_name, include_private = false)
+    method_name.to_s.start_with?('find_') || super
+  end
+
 end

data/app/models/paid_up/features_plan.rb

@@ -1,7 +1,6 @@
 class PaidUp::FeaturesPlan < ActiveRecord::Base
   belongs_to :plan, class_name: 'PaidUp::Plan'
-  belongs_to :feature, class_name: 'PaidUp::Feature'
-  validates_presence_of :setting
+  validates_presence_of :setting, :plan, :feature
 
   after_initialize :catch_unlimited_in_setting
 

data/app/models/paid_up/plan.rb

@@ -1,13 +1,14 @@
 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
+  has_many :subscribers, :through => :subscriptions, :source => :subscriber, :source_type => 'User'
 
   after_initialize :load_stripe_data
 
   attr_accessor :stripe_data
 
+  validates_presence_of :name, :stripe_id
+
   default_scope { order('sort_order ASC') }
   scope :subscribable, -> { where('sort_order >=  ?', 0) }
   scope :free, -> { find_by_stripe_id(PaidUp.configuration.free_plan_stripe_id) }
@@ -18,14 +19,9 @@ class PaidUp::Plan < ActiveRecord::Base
     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)
+  def feature_setting(feature_name)
+    feature = PaidUp::Feature.find_by_slug(feature_name) || raise(:feature_not_found.l)
+    raw = features_plans.where(feature: feature_name)
     case feature.setting_type
       when 'boolean'
         if raw.empty?
@@ -33,7 +29,7 @@ class PaidUp::Plan < ActiveRecord::Base
         else
           raw.first.setting != 0
         end
-      when 'table_rows'
+      when 'table_rows', 'rolify_rows'
         if raw.empty?
           0
         else
@@ -44,8 +40,8 @@ class PaidUp::Plan < ActiveRecord::Base
     end
   end
 
-  def feature_unlimited?(feature_id)
-    feature_setting(feature_id) == PaidUp::Unlimited.to_i
+  def feature_unlimited?(feature_name)
+    feature_setting(feature_name) == PaidUp::Unlimited.to_i
   end
 
   def interval

data/app/models/paid_up/unlimited.rb

@@ -0,0 +1,15 @@
+module PaidUp::Unlimited
+  def self.initialize
+    999999999
+  end
+  def self.to_i(format = :default)
+    if format == :db
+      -1
+    else
+      999999999
+    end
+  end
+  def self.to_s
+    :unlimited.l
+  end
+end

data/app/views/paid_up/features/_abilities_table.html.haml

@@ -1,11 +1,11 @@
 %table.abilities.table.table-bordered{ html_options }
   - for feature in features
-    %tr{ id: feature.name + '_ability'}
+    %tr{ id: feature.slug + '_ability'}
       %th= feature.title
       %td
         - case feature.setting_type
           - when 'boolean'
-            - if can? :use, feature.name.to_sym
+            - if can? :use, feature.slug.to_sym
               = icon 'ok'
             - else
               = icon 'remove'
@@ -14,9 +14,18 @@
               = icon 'ok'
             - else
               = icon 'remove'
-            - if current_user.table_rows_unlimited?(feature.name)
+            - if current_user.table_rows_unlimited?(feature.slug)
               = :unlimited.l
             - else
-              = :x_of_y_remaining.l x: current_user.table_rows_remaining(feature.name), y: current_user.table_rows_allowed(feature.name)
+              = :x_of_y_remaining.l x: current_user.table_rows_remaining(feature.slug), y: current_user.table_rows_allowed(feature.slug)
+          - when 'rolify_rows'
+            - if can? :own, feature.feature_model
+              = icon 'ok'
+            - else
+              = icon 'remove'
+            - if current_user.rolify_rows_unlimited?(feature.slug)
+              = :unlimited.l
+            - else
+              = :x_of_y_remaining.l x: current_user.rolify_rows_remaining(feature.slug), y: current_user.rolify_rows_allowed(feature.slug)
           - else
             = :error.l

data/app/views/paid_up/subscriptions/new.html.haml

@@ -11,26 +11,26 @@
       %script{ src: 'https://js.stripe.com/v2/' }
       %input{ name: 'plan_id', value: @plan.id, type: 'hidden' }
       .payment-errors
-        .form-group
-          %label.control-label.col-xs-2= :card.l
-          .col-md-10
-            .group
-              - if current_user.cards.count > 0
-                - current_user.cards.each_with_index do |card, index|
-                  .radio
-                    %label
-                      - if index == 0
-                        %input{ type: :radio, name: 'card', value: card.id, checked: 'checked' }
-                      - else
-                        %input{ type: :radio, name: 'card', value: card.id }
-                      = :card_ending_with.l brand: card.brand, last4: card.last4
-              .radio
-                %label
-                  - if current_user.cards.count == 0
-                    %input{ type: :radio, name: 'card', value: 'stripeToken', checked: 'checked' }
-                  - else
-                    %input{ type: :radio, name: 'card', value: 'stripeToken' }
-                  = :enter_new_card.l
+      .form-group
+        %label.control-label.col-xs-2= :card.l
+        .col-md-10
+          .group
+            - if current_user.cards.count > 0
+              - current_user.cards.each_with_index do |card, index|
+                .radio
+                  %label
+                    - if index == 0
+                      %input{ type: :radio, name: 'card', value: card.id, checked: 'checked' }
+                    - else
+                      %input{ type: :radio, name: 'card', value: card.id }
+                    = :card_ending_with.l brand: card.brand, last4: card.last4
+            .radio
+              %label
+                - if current_user.cards.count == 0
+                  %input{ type: :radio, name: 'card', value: 'stripeToken', checked: 'checked' }
+                - else
+                  %input{ type: :radio, name: 'card', value: 'stripeToken' }
+                = :enter_new_card.l
       #new-card
         .form-group
           %label.control-label.col-xs-2{for: 'number'}= :card_number.l

data/bin/rails

@@ -8,5 +8,12 @@ ENGINE_PATH = File.expand_path('../../lib/paid_up/engine', __FILE__)
 ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
 require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
 
-require 'rails/all'
+# require 'rails/all'
+
+require "active_record/railtie"
+require "action_controller/railtie"
+require "action_mailer/railtie"
+require "action_view/railtie"
+require "sprockets/railtie"
+
 require 'rails/engine/commands'

data/config/locales/en.yml

@@ -48,12 +48,13 @@ en:
   expiration: 'Expiration'
   features: 'Features'
   feature_not_found: "Feature Not Found"
+  feature_not_found_feature: "Feature Not Found: %{feature}"
   forgot_your_password: 'Forgot your password?'
   leave_blank_if_you_dont_want_to_change_it: "(leave blank if you don't want to change it)"
   length_characters_minimum: "(%{length} characters minimum)"
   my_subscription: 'My Subscription'
   my_subscription_information: 'My Subscription Information'
-  no_conversion_of_type_features_to_table_rows: 'No conversion of %{type} Features to table_rows'
+  no_implicit_conversion_of_type_features: 'No implicit conversion of %{type} Features'
   or_sign_in: "Or, Sign In"
   or_sign_up: "Or, Sign Up"
   paid_thru: "Paid Thru"
@@ -78,8 +79,10 @@ en:
   unknown_feature_type: 'Unknown Feature Type'
   unlimited: 'Unlimited'
   update_account: 'Update Account'
+  value_is_not_a_valid_setting_type: "%{value} is not a valid setting_type. Must be one of: boolean, table_rows, rolify_rows"
   we_need_your_current_password_to_confirm_your_changes: '(we need your current password to confirm your changes)'
   when_using_table_rows_table_must_exist: 'When using table_rows, the table must exist.'
+  when_using_rolify_rows_table_must_exist: 'When using rolify_rows, the table must exist.'
   x_of_y_remaining: '%{x} of %{y} remaining'
   you_are_now_subscribed_to_the_plan: "You are now subscribed to the %{plan_name} Plan"
   you_will_be_charged: "You will be charged %{charge_amount}."

data/coverage/.last_run.json

@@ -1,5 +1,5 @@
 {
   "result": {
-    "covered_percent": 78.66
+    "covered_percent": 78.17
   }
 }