pay_features 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4eab8434035887b300af20a8c5f228fd803d284badb50e867cb115e5d41ea83d
+  data.tar.gz: f4d4a7aa9b788f4d13fa19417d1a0c8007cae8ebbea50e46b5ef1461b824d98a
+SHA512:
+  metadata.gz: 242fc928e8e1d3195d8ae20ead69a859aae2bf7c8516c4845d5fdaf0a85804a61846c17d27f186377b115e3e5ab537a664fc1cb677b8a0c37c5e2ebc0358d323
+  data.tar.gz: 80bf87c6352c3701512e948f7fcef5a88d8580b002ec4d20529eb37528b411b9aef8f96947abb5add5768bd33054e6b449d9797488ff5872a7f69e6aa7df4daa

data/README.md

@@ -0,0 +1,125 @@
+# PayFeatures
+
+PayFeatures is a gem to add `plan` features to your subscription plan. Let's say a user is subscribed to the Simple plan, which allows for 2 team_members. You can easily set up features and checks to use in your app and to display on your pricing page.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'pay_features'
+```
+
+And then execute:
+
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+
+```bash
+$ gem install pay_features
+```
+
+## Migrations
+
+Install migrations by running
+
+```bash
+rails pay_features:install:migrations
+```
+
+That will add two new tables as well as add `previous_plan_id` to your existing `plans` table.
+
+## Usage
+
+Per default we rely on an existing `plans` table to be present. This is only needed if you want the feature inheritance between plans.
+
+In your existing `plan` model, add the following:
+
+```ruby
+class Plan < ActiveModel
+  include PayFeatures::Plan
+end
+```
+
+You can then set up features and your plans like this:
+
+```ruby
+first_plan = Plan.create(name: "First plan")
+second_plan = Plan.create(name: "Second plan", previous_plan: first_plan)
+
+first_plan.features.create(identifier: "users", amount: 2)
+first_plan.features.create(identifier: "can_create_teams", description: "Can create teams")
+second_plan.features.create(identifier: "users", amount: 10)
+second_plan.features.create(identifier: "api_access", description: "Use the API")
+```
+
+You can perform simple checks like this:
+
+```ruby
+first_plan.has_feature?(:users)
+# => true
+
+first_plan.amount_for(:users)
+# => 2
+
+# Features are inherited when previous_plan is set
+second_plan.has_feature?(:can_create_teams)
+# => true
+
+first_plan.has_feature?(:api_access)
+# => false
+
+second_plan.has_feature?(:api_access)
+# => true
+```
+
+If you want to display the features on your pricing page, you can access `plan.display_features` which will give you an array similar to this:
+
+```ruby
+{
+  identifier: "users",
+  description: "2 users",
+  amount: 2,
+}
+```
+
+If a feature exists on the previous plan, and you add it to the plan after similar to this:
+
+```ruby
+first_plan = Plan.create(name: "First plan")
+second_plan = Plan.create(name: "Second plan", previous_plan: first_plan)
+
+first_plan.features.create(identifier: "users", amount: 2, description: "2 users")
+second_plan.features.create(identifier: "users", amount: 10, description: "10 users")
+second_plan.features.create(identifier: "api_access", description: "API Access")
+```
+
+If you call `second_plan.display_features` you'll see the `users` feature marked as a new feature. This is so you can highlight differences in your pricing table.
+
+```ruby
+[
+  {
+    identifier: "users",
+    description: "10 users",
+    amount: 10,
+    new_feature: true,
+  },
+  {
+    identifier: "api_access",
+    description: "API Access",
+    amount: nil,
+    new_feature: true,
+  },
+]
+```
+
+## Contributing
+
+Open up Issue/PR if you encounter any problems or have ideas.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'PayFeatures'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path('test/dummy/Rakefile', __dir__)
+load 'rails/tasks/engine.rake'
+
+load 'rails/tasks/statistics.rake'
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/app/assets/config/pay_features_manifest.js

@@ -0,0 +1 @@
+//= link_directory ../stylesheets/pay_features .css

data/app/assets/stylesheets/pay_features/application.css

@@ -0,0 +1,15 @@
+/*
+ * 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 any plugin's vendor/assets/stylesheets directory 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 bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/controllers/pay_features/application_controller.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module PayFeatures
+  class ApplicationController < ActionController::Base
+    protect_from_forgery with: :exception
+  end
+end

data/app/helpers/pay_features/application_helper.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module PayFeatures
+  module ApplicationHelper
+  end
+end

data/app/jobs/pay_features/application_job.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module PayFeatures
+  class ApplicationJob < ActiveJob::Base
+  end
+end

data/app/mailers/pay_features/application_mailer.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module PayFeatures
+  class ApplicationMailer < ActionMailer::Base
+    default from: 'from@example.com'
+    layout 'mailer'
+  end
+end

data/app/models/pay_features/application_record.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module PayFeatures
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

data/app/models/pay_features/pay_feature.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module PayFeatures
+  class PayFeature < ApplicationRecord
+    self.table_name = 'pay_features_pay_features'
+
+    has_many :plan_features, class_name: 'PayFeatures#PlanFeature'
+    has_many :plans, through: :plan_features
+
+    scope :ordered, -> { order(:order) }
+  end
+end

data/app/models/pay_features/plan_feature.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module PayFeatures
+  class PlanFeature < ApplicationRecord
+    self.table_name = 'pay_features_plan_features'
+
+    belongs_to :plan
+    belongs_to :pay_feature, class_name: 'PayFeatures::PayFeature'
+  end
+end

data/app/views/layouts/pay_features/application.html.erb

@@ -0,0 +1,15 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Pay features</title>
+  <%= csrf_meta_tags %>
+  <%= csp_meta_tag %>
+
+  <%= stylesheet_link_tag    "pay_features/application", media: "all" %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/config/routes.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+PayFeatures::Engine.routes.draw do
+end

data/db/migrate/20191230040540_create_pay_features_features.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+class CreatePayFeaturesFeatures < ActiveRecord::Migration[6.0]
+  def change
+    create_table :pay_features_pay_features do |t|
+      t.string :description
+      t.string :identifier
+      t.integer :amount
+      t.integer :order
+      t.boolean :hidden
+      t.boolean :enabled
+
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20191230182348_create_pay_features_plan_features.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+class CreatePayFeaturesPlanFeatures < ActiveRecord::Migration[6.0]
+  def change
+    create_table :pay_features_plan_features do |t|
+      t.references :plan, null: false, foreign_key: true
+      t.references :pay_feature, null: false, foreign_key: { to_table: :pay_features_pay_features }
+
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20191231065514_add_fields_to_plan.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+class AddFieldsToPlan < ActiveRecord::Migration[6.0]
+  def change
+    add_column PayFeatures.plan_table, :previous_plan_id, :integer
+    add_index PayFeatures.plan_table, :previous_plan_id
+  end
+end

data/lib/pay_features.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require 'pay_features/engine'
+require 'pay_features/plan'
+
+module PayFeatures
+  mattr_accessor :plan_class
+  mattr_accessor :plan_table
+
+  @@plan_class = 'Plan'
+  @@plan_table = 'plans'
+
+  def self.setup
+    yield self
+  end
+
+  def self.plan_model
+    if Rails.application.config.cache_classes
+      @@plan_model ||= plan_class.constantize
+    else
+      plan_class.constantize
+    end
+  end
+end

data/lib/pay_features/engine.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module PayFeatures
+  class Engine < ::Rails::Engine
+    isolate_namespace PayFeatures
+  end
+end

data/lib/pay_features/plan.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+require 'active_support/concern'
+
+module PayFeatures
+  module Plan
+    extend ActiveSupport::Concern
+
+    BIGGEST_AMOUNT = 9_999_999
+    SMALLEST_AMOUNT = -9_999_999
+
+    included do
+      has_many :plan_features, class_name: 'PayFeatures::PlanFeature'
+      has_many :pay_features, through: :plan_features, foreign_key: :pay_feature_id
+
+      belongs_to :previous_plan, class_name: PayFeatures.plan_class, optional: true
+
+      def amount_for(identifier)
+        feature = find_feature(identifier)
+        return SMALLEST_AMOUNT unless feature
+        return feature.amount if feature.amount
+
+        BIGGEST_AMOUNT
+      end
+
+      def has_feature?(identifier)
+        find_feature(identifier).present?
+      end
+
+      def display_features
+        display_features = features_from_previous
+
+        pay_features.ordered.each do |f|
+          index = display_features.index { |df| df[:identifier] == f.identifier }
+          value = { identifier: f.identifier, description: f.description, amount: f.amount }
+
+          if index
+            display_features[index] = value.merge(new_feature: true)
+          else
+            value.merge!(new_feature: true) if previous_plan
+            display_features << value
+          end
+        end
+
+        display_features.flatten
+      end
+
+      def find_feature(identifier)
+        feature = pay_features.find_by(identifier: identifier)
+
+        if feature
+          feature
+        elsif !feature && previous_plan.present?
+          previous_plan.find_feature(identifier)
+        end
+      end
+
+      private
+
+      def previous_plan_display_features
+        previous_plan.display_features
+      end
+
+      def features_from_previous
+        previous_features = []
+        return previous_features unless previous_plan
+
+        previous_plan_display_features.each do |f|
+          previous_features << { identifier: f[:identifier], description: f[:description] }
+        end
+
+        previous_features
+      end
+    end
+  end
+end

data/lib/pay_features/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module PayFeatures
+  VERSION = '0.1.0'
+end

data/lib/tasks/pay_features_tasks.rake

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+# desc "Explaining what the task does"
+# task :pay_features do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: pay_features
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jesper Christiansen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-12-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Specify features for your subscription plans and check that the user
+  has access to those
+email:
+- hi@jespr.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- app/assets/config/pay_features_manifest.js
+- app/assets/stylesheets/pay_features/application.css
+- app/controllers/pay_features/application_controller.rb
+- app/helpers/pay_features/application_helper.rb
+- app/jobs/pay_features/application_job.rb
+- app/mailers/pay_features/application_mailer.rb
+- app/models/pay_features/application_record.rb
+- app/models/pay_features/pay_feature.rb
+- app/models/pay_features/plan_feature.rb
+- app/views/layouts/pay_features/application.html.erb
+- config/routes.rb
+- db/migrate/20191230040540_create_pay_features_features.rb
+- db/migrate/20191230182348_create_pay_features_plan_features.rb
+- db/migrate/20191231065514_add_fields_to_plan.rb
+- lib/pay_features.rb
+- lib/pay_features/engine.rb
+- lib/pay_features/plan.rb
+- lib/pay_features/version.rb
+- lib/tasks/pay_features_tasks.rake
+homepage: https://github.com/jespr/pay_features
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Specify features for your subscription plans and check that the user has
+  access to those
+test_files: []