pay 0.0.0 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 97d7054e2b890c369fd44bfe2c4e1e68babe8917
-  data.tar.gz: b624bf659702eee9a4ec8189cd9413048c76703d
+  metadata.gz: 92f9482ce3c201c076c2717a75c9e0670f412c4b
+  data.tar.gz: cd8a5de08bf9fdf46b71648202967b3202615f9c
 SHA512:
-  metadata.gz: b795e7fa1662cbf011395415c89954d17d47e5b456b09a28770cbd6be24b144f0f8505ab74ecb31cafc1366865b45292f8e1a8589f39e78f97f6e31bcc3dcfb7
-  data.tar.gz: 45b359a5faffc2d7f6c16eaec04a612c1cfb3f7c5ab857c2118b07fee9637aff6a306414fb6ccee2bcf79b533fd388e688003a2a9a6f58a57da7081c4c531c0a
+  metadata.gz: 7383c1f3dcbd887dd185c4cc28277513e4d9f1ab29229ebb042342ffb3301ad2e25e86dd45889c88b85df6a388ee831152c7ba594ccc14aef30f4ee0dae27336
+  data.tar.gz: a8431aee8abb65ff7d8550ed471ebdada798b686de30bfe21830554c1e59d509406e0031fd834236e1bbdd56cfb12f1c67b1c2455fff1a42a0a252da777dcf41

data/README.md

@@ -1,8 +1,17 @@
 # Pay
-Short description and motivation.
+[ ![Codeship Status for jasoncharnes/pay](https://img.shields.io/codeship/72941cf0-31a8-0135-af58-3a3212f0f89d/master.svg)](https://app.codeship.com/projects/225793)
 
-## Usage
-How to use my plugin.
+Pay is a subscription engine for Ruby on Rails.
+
+Supports Ruby on Rails 4.2 and higher.
+
+**Current Payment Providers**
+* Stripe
+
+**Payment Providers In Development**
+* Braintree
+
+Want to add a new payment provider? Contributions are welcome and the instructions [are here](https://github.com/jasoncharnes/pay/wiki/New-Payment-Provider).
 
 ## Installation
 Add this line to your application's Gemfile:
@@ -21,8 +30,191 @@ Or install it yourself as:
 $ gem install pay
 ```
 
+## Setup
+#### Migrations
+This engine will create a subscription model and the neccessary migrations for the model you want to make "billable." The most common use case for the billable model is a User.
+
+To add the migrations to your application, run the following migration:
+
+`$ bin/rails pay:install:migrations`
+
+This will install two migrations:
+- db/migrate/create_subscriptions.rb
+- db/migrate/add_fields_to_users.rb
+
+#### Non-User Model
+If you need to use a model other than `User`, check out the [wiki page](https://github.com/jasoncharnes/pay/wiki/Model-Other-Than-User).
+
+#### Run the Migrations
+Finally, run the migrations with `$ rake db:migrate`
+
+#### Stripe
+You'll need to add your private Stripe API key to your Rails secrets. `config/secrets.yml`
+
+```yaml
+development:
+  stripe_api_key: sk_test_....
+```
+
+## Usage
+Include the `Pay::Billable` module in the model you want to know about subscriptions.
+
+```ruby
+# app/models/user.rb
+class User < ActiveRecord::Base
+  include Pay::Billable
+end
+```
+
+**To see how to use Stripe Elements JS & Devise, [click here](https://github.com/jasoncharnes/pay/wiki/Using-Stripe-Elements-and-Devise).**
+
+## User API
+#### Creating a Subscription
+
+```ruby
+user = User.find_by(email: 'michael@bluthcompany.co')
+user.card_token = 'stripe-token'
+user.subscribe
+```
+
+A `card_token` must be provided as an attribute.
+
+The subscribe method has three optional arguments with default values.
+
+```ruby
+def subscribe(name = 'default', plan = 'default', processor = 'stripe')
+  ...
+end
+```
+
+##### Name
+Name is an internally used name for the subscription.
+
+##### Plan
+Plan is the plan ID from the payment processor.
+
+#### Retrieving a Subscription from the Database
+```ruby
+user = User.find_by(email: 'gob@bluthcompany.co')
+user.subscription
+```
+
+#### Checking a User's Subscription Status
+
+```ruby
+user = User.find_by(email: 'george.senior@bluthcompany.co')
+user.subscribed?
+```
+
+The `subscribed?` method has two optional arguments with default values.
+
+```ruby
+def subscribed?(name = 'default', plan = nil)
+  ...
+end
+```
+
+##### Name
+Name is an internally used name for the subscription.
+
+##### Plan
+Plan is the plan ID from the payment processor.
+
+##### Processor
+Processor is the string value of the payment processor subscription. Pay currently only supports Stripe, but other implementations are welcome.
+
+#### Retrieving a Payment Processor Account
+
+```ruby
+user = User.find_by(email: 'george.michael@bluthcompany.co')
+user.customer
+```
+
+#### Updating a Customer's Credit Card
+
+```ruby
+user = User.find_by(email: 'tobias@bluthcompany.co')
+user.update_card('stripe-token')
+```
+
+#### Retrieving a Customer's Subscription from the Processor
+
+```ruby
+user = User.find_by(email: 'lucille@bluthcompany.co')
+user.processor_subscription(subscription_id)
+```
+
+## Subscription API
+#### Checking a Subscription's Trial Status
+
+```ruby
+user = User.find_by(email: 'lindsay@bluthcompany.co')
+user.subscription.on_trial?
+```
+
+#### Checking a Subscription's Cancellation Status
+
+```ruby
+user = User.find_by(email: 'buster@bluthcompany.co')
+user.subscription.cancelled?
+```
+
+#### Checking a Subscription's Grace Period Status
+
+```ruby
+user = User.find_by(email: 'her?@bluthcompany.co')
+user.subscription.on_grace_period?
+```
+
+#### Checking to See If a Subscription Is Active
+
+```ruby
+user = User.find_by(email: 'carl.weathers@bluthcompany.co')
+user.subscription.active?
+```
+
+#### Cancel a Subscription (At End of Billing Cycle)
+
+```ruby
+user = User.find_by(email: 'oscar@bluthcompany.co')
+user.subscription.cancel
+```
+
+#### Cancel a Subscription Immediately
+
+```ruby
+user = User.find_by(email: 'annyong@bluthcompany.co')
+user.subscription.cancel_now!
+```
+
+#### Resume a Subscription on a Grace Period
+
+```ruby
+user = User.find_by(email: 'steve.holt@bluthcompany.co')
+user.subscription.resume
+```
+
+#### Retrieving the Subscription from the Processor
+
+```ruby
+user = User.find_by(email: 'lucille2@bluthcompany.co')
+user.subscription.processor_subscription
+```
+
+## Contributors
+* [Jason Charnes](https://twitter.com/jmcharnes)
+* [Chris Oliver](https://twitter.com/excid3)
+
 ## Contributing
-Contribution directions go here.
+👋 Thanks for your interest in contributing. Feel free to fork this repo.
+
+If you have an issue you'd like to submit, please do so using the issue tracker in GitHub. In order for us to help you in the best way possible, please be as detailed as you can.
+
+If you'd like to open a PR please make sure the following things pass:
+* `rake test`
+* `rubocop`
+
+These will need to be passing in order for a Pull Request to be accepted.
 
 ## License
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -14,14 +14,11 @@ RDoc::Task.new(:rdoc) do |rdoc|
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
 
-APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+APP_RAKEFILE = File.expand_path('../test/dummy/Rakefile', __FILE__)
 load 'rails/tasks/engine.rake'
 
-
 load 'rails/tasks/statistics.rake'
 
-
-
 require 'bundler/gem_tasks'
 
 require 'rake/testtask'
@@ -33,5 +30,16 @@ Rake::TestTask.new(:test) do |t|
   t.verbose = false
 end
 
-
 task default: :test
+
+task :console do
+  require 'irb'
+  require 'irb/completion'
+  require 'pay'
+  ARGV.clear
+  IRB.start
+end
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new

data/app/models/subscription.rb

@@ -0,0 +1,59 @@
+class Subscription < ApplicationRecord
+  # Associations
+  belongs_to :owner, class_name: Pay.billable_class, foreign_key: :owner_id
+
+  # Validations
+  validates :name, presence: true
+  validates :processor, presence: true
+  validates :processor_id, presence: true
+  validates :processor_plan, presence: true
+  validates :quantity, presence: true
+
+  # Scopes
+  scope :for_name, ->(name) { where(name: name) }
+
+  def on_trial?
+    trial_ends_at? && Time.zone.now < trial_ends_at
+  end
+
+  def cancelled?
+    ends_at?
+  end
+
+  def on_grace_period?
+    cancelled? && Time.zone.now < ends_at
+  end
+
+  def active?
+    ends_at.nil? || on_grace_period? || on_trial?
+  end
+
+  def cancel
+    subscription = processor_subscription.delete(at_period_end: true)
+    update(ends_at: Time.at(subscription.current_period_end))
+  end
+
+  def cancel_now!
+    subscription = processor_subscription.delete
+    update(ends_at: Time.at(subscription.current_period_end))
+  end
+
+  def resume
+    unless on_grace_period?
+      raise StandardError,
+            'You can only resume subscriptions within their grace period.'
+    end
+
+    subscription = processor_subscription
+    subscription.plan = processor_plan
+    subscription.trial_end = on_trial? ? trial_ends_at.to_i : 'now'
+    subscription.save
+
+    update(ends_at: nil)
+    self
+  end
+
+  def processor_subscription
+    owner.processor_subscription(processor_id)
+  end
+end

data/config/initializers/pay.rb

@@ -0,0 +1,3 @@
+Pay.setup do |config|
+  # billable_class = "User"
+end

data/config/initializers/stripe.rb

@@ -0,0 +1 @@
+Stripe.api_key = Rails.application.secrets.stripe_api_key

data/db/migrate/20170205020145_create_subscriptions.rb

@@ -0,0 +1,16 @@
+class CreateSubscriptions < ActiveRecord::Migration[4.2]
+  def change
+    create_table :subscriptions do |t|
+      t.references :owner
+      t.string :name, null: false
+      t.string :processor, null: false
+      t.string :processor_id, null: false
+      t.string :processor_plan, null: false
+      t.integer :quantity, default: 1, null: false
+      t.datetime :trial_ends_at
+      t.datetime :ends_at
+
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20170503131610_add_fields_to_users.rb

@@ -0,0 +1,15 @@
+class AddFieldsToUsers < ActiveRecord::Migration[4.2]
+  def change
+    unless ActiveRecord::Base.connection.table_exists?(Pay.billable_table)
+      create_table Pay.billable_table.to_sym
+    end
+
+    add_column Pay.billable_table, :processor, :string
+    add_column Pay.billable_table, :processor_id, :string
+    add_column Pay.billable_table, :card_token, :string
+    add_column Pay.billable_table, :card_brand, :string
+    add_column Pay.billable_table, :card_last4, :string
+    add_column Pay.billable_table, :card_exp_month, :string
+    add_column Pay.billable_table, :card_exp_year, :string
+  end
+end

data/lib/pay.rb

@@ -1,5 +1,15 @@
-require "pay/engine"
+require 'stripe'
+require 'pay/engine'
+require 'pay/billable'
 
 module Pay
-  # Your code goes here...
+  # Define who owns the subscription
+  mattr_accessor :billable_class
+  mattr_accessor :billable_table
+  @@billable_class = 'User'
+  @@billable_table = @@billable_class.tableize
+
+  def self.setup
+    yield self
+  end
 end

data/lib/pay/billable.rb

@@ -0,0 +1,79 @@
+require 'pay/billable/stripe'
+require 'pay/billable/braintree'
+
+module Pay
+  module Billable
+    extend ActiveSupport::Concern
+
+    included do
+      include Pay::Billable::Stripe
+      include Pay::Billable::Braintree
+
+      has_many :subscriptions, foreign_key: :owner_id
+
+      attribute :plan, :string
+      attribute :quantity, :integer
+      attribute :card_token, :string
+    end
+
+    def customer(token = nil)
+      check_for_processor
+      send("#{processor}_customer", token)
+    end
+
+    def subscribe(name = 'default', plan = 'default', processor = 'stripe')
+      self.processor = processor
+      send("create_#{processor}_subscription", name, plan)
+    end
+
+    def update_card(token)
+      check_for_processor
+      send("update_#{processor}_card", token)
+    end
+
+    def processor_subscription(subscription_id)
+      check_for_processor
+      send("#{processor}_subscription", subscription_id)
+    end
+
+    def subscribed?(name = 'default', plan = nil)
+      subscription = subscription(name)
+
+      return false if subscription.nil?
+      return subscription.active? if plan.nil?
+
+      subscription.active? && subscription.plan == plan
+    end
+
+    def subscription(name = 'default')
+      subscriptions.for_name(name).last
+    end
+
+    private
+
+    def check_for_processor
+      raise StandardError, 'No processor selected' unless processor
+    end
+
+    def create_subscription(subscription, processor, name, plan, qty = 1)
+      subscriptions.create!(
+        name: name || 'default',
+        processor: processor,
+        processor_id: subscription.id,
+        processor_plan: plan,
+        trial_ends_at: trial_end_date(subscription),
+        quantity: qty,
+        ends_at: nil
+      )
+    end
+
+    def update_card_on_file(card)
+      update!(
+        card_brand: card.brand,
+        card_last4: card.last4,
+        card_exp_month: card.exp_month,
+        card_exp_year: card.exp_year
+      )
+    end
+  end
+end

data/lib/pay/billable/braintree.rb

@@ -0,0 +1,57 @@
+module Pay
+  module Billable
+    module Braintree
+      # def braintree_customer(token = nil)
+      #   if processor_id?
+      #     result = ::Braintree::PaymentMethod.create(
+      #       customer_id: processor_id,
+      #       payment_method_nonce: token,
+      #       options: { make_default: true }
+      #     )
+
+      #     raise StandardError, result.inspect unless result.success?
+      #     ::Braintree::Customer.find(processor_id)
+      #   else
+      #     result = ::Braintree::Customer.create(
+      #       email: email,
+      #       payment_method_nonce: token
+      #     )
+
+      #     raise StandardError, result.inspect unless result.success?
+      #     update(processor: 'braintree', processor_id: result.customer.id)
+
+      #     result.customer
+      #   end
+      # end
+
+      # def create_braintree_subscription(name = 'default')
+      #   token = braintree_customer.payment_methods.find(&:default?).token
+
+      #   result = ::Braintree::Subscription.create(
+      #     payment_method_token: token,
+      #     plan_id: plan
+      #   )
+
+      #   if result.success?
+      #     subscription = subscriptions.create(
+      #       name: name || 'default',
+      #       processor: processor,
+      #       processor_id: result.subscription.id,
+      #       processor_plan: plan,
+      #       trial_ends_at: ,
+      #       quantity: quantity || 1,
+      #       ends_at: nil
+      #     )
+      #   else
+      #     raise StandardError, result.inspect
+      #   end
+
+      #   subscription
+      # end
+
+      # def update_braintree_card(token)
+      #   # Placeholder
+      # end
+    end
+  end
+end

data/lib/pay/billable/stripe.rb

@@ -0,0 +1,47 @@
+module Pay
+  module Billable
+    module Stripe
+      def stripe_customer
+        if processor_id?
+          customer = ::Stripe::Customer.retrieve(processor_id)
+        else
+          customer = ::Stripe::Customer.create(email: email, source: card_token)
+          update(processor: 'stripe', processor_id: customer.id)
+        end
+
+        customer
+      end
+
+      def create_stripe_subscription(name, plan)
+        stripe_sub = stripe_customer.subscriptions.create(plan: plan)
+        subscription = create_subscription(stripe_sub, 'stripe', name, plan)
+        subscription
+      end
+
+      def update_stripe_card(token)
+        customer = stripe_customer
+        token = ::Stripe::Token.retrieve(token)
+
+        return if token.card.id == customer.default_source
+        save_stripe_card(token, customer)
+      end
+
+      def stripe_subscription(subscription_id)
+        ::Stripe::Subscription.retrieve(subscription_id)
+      end
+
+      private
+
+      def save_stripe_card(token, customer)
+        card = customer.sources.create(source: token.id)
+        customer.default_source = card.id
+        customer.save
+        update_card_on_file(card)
+      end
+
+      def trial_end_date(stripe_sub)
+        stripe_sub.trial_end.present? ? Time.at(stripe_sub.trial_end) : nil
+      end
+    end
+  end
+end

data/lib/pay/version.rb

@@ -1,3 +1,3 @@
 module Pay
-  VERSION = '0.0.0'
+  VERSION = '0.0.2'
 end

metadata

@@ -1,29 +1,113 @@
 --- !ruby/object:Gem::Specification
 name: pay
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.0.2
 platform: ruby
 authors:
 - Jason Charnes
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-01 00:00:00.000000000 Z
+date: 2017-06-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: stripe
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: braintree
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.0.1
+        version: '2.75'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.0.1
+        version: '2.75'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  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: mocha
+  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: pry
+  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: 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
@@ -38,7 +122,21 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: A wrapper for handing subscriptions in Rails.
+- !ruby/object:Gem::Dependency
+  name: stripe-ruby-mock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+description: A Ruby on Rails subscription engine.
 email:
 - jason@thecharnes.com
 executables: []
@@ -56,9 +154,18 @@ files:
 - app/jobs/pay/application_job.rb
 - app/mailers/pay/application_mailer.rb
 - app/models/pay/application_record.rb
+- app/models/subscription.rb
 - app/views/layouts/pay/application.html.erb
+- config/initializers/pay.rb
+- config/initializers/stripe.rb
 - config/routes.rb
+- db/development.sqlite3
+- db/migrate/20170205020145_create_subscriptions.rb
+- db/migrate/20170503131610_add_fields_to_users.rb
 - lib/pay.rb
+- lib/pay/billable.rb
+- lib/pay/billable/braintree.rb
+- lib/pay/billable/stripe.rb
 - lib/pay/engine.rb
 - lib/pay/version.rb
 - lib/tasks/pay_tasks.rake
@@ -82,8 +189,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.6.12
 signing_key: 
 specification_version: 4
-summary: A wrapper for handing subscriptions in Rails.
+summary: A Ruby on Rails subscription engine.
 test_files: []