pay_me 0.5.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e18795d8af901a878f1d13c1a86de08fa1f2d50f73376813e46fc438311bd36e
+  data.tar.gz: adfdcca8ec3e7060f0076a5de4192161e47b775b91d556e59f539052e38ce505
+SHA512:
+  metadata.gz: 7acc778c322a0a4af83d521ba81e797f9ba8c283e658e346c358f52e0e63fa29b444582d9eb6b29288b927ea8c65631efdb1431caefb15ef577c1f19cc7de3fc
+  data.tar.gz: 9da7a3ffdfdc90bba5e8203e47e99e32d02c68ba09a639409de79c10186b929e2c859eadb08fd741f397e328621f9e621a8a3299875283503dc32e4d42ceebab

data/README.md

@@ -0,0 +1,111 @@
+PayMe
+=========
+
+## This gem is currently a work in progress, follows semver, and may change significantly until version 1.0
+
+### A gem for attaching a payment system to business login in Rails
+TODO...
+
+### Details
+TODO...
+
+### Testing
+Ensure you have `STRIPE_TEST_SECRET_KEY` as an ENV variable.
+This progect uses [dotenv](https://github.com/bkeepers/dotenv) so you can create a `.env` file.
+You can run the tests using `rake test`.
+
+### Installation
+Add the gem to your Gemfile: `gem 'pay_me'`.
+
+Run `bundle install` to install it.
+
+Run `rails g pay_me:install`
+
+Add the following to your routes
+```ruby
+...
+  pay_me_customerable_for :users
+...
+```
+
+Add the following to your customer model controller
+```ruby
+require 'pay_me/concerns/controllers/customerable'
+...
+class UsersController < BaseController
+  include PayMe::Concerns::Controllers::Customerable
+...
+```
+
+Add the following to your customer model
+```ruby
+require 'pay_me/concerns/models/customerable'
+...
+class User < ActiveRecord::Base
+  include PayMe::Concerns::Models::Customerable
+...
+```
+The model will also need a `receipt_email` attribute and `customer_id`.
+
+The installer will automatically add the following to your `secrets.yml` for `development` `test` and `production`.
+`secrets.yml`
+```yml
+development:
+  ###
+  # Other configs
+  ###
+  stripe_publishable_key: <%= ENV['STRIPE_PUBLISHABLE_KEY'] %>
+  stripe_secret_key: <%= ENV['STRIPE_SECRET_KEY'] %>
+  stripe_webhook_secret: <%= ENV['STRIPE_WEBHOOK_SECRET'] %>
+  stripe_signing_secret: <%= ENV['STRIPE_SIGNING_SECRET'] %>
+
+```
+
+or using inheritance:
+`secrets.yml`
+```yml
+stripe: &stripe
+  stripe_publishable_key: <%= ENV['STRIPE_PUBLISHABLE_KEY'] %>
+  stripe_secret_key: <%= ENV['STRIPE_SECRET_KEY'] %>
+  stripe_webhook_secret: <%= ENV['STRIPE_WEBHOOK_SECRET'] %>
+  stripe_signing_secret: <%= ENV['STRIPE_SIGNING_SECRET'] %>
+
+development:
+  <<: *stripe
+  ...
+
+test:
+  <<: *stripe
+  ...
+
+production:
+  <<: *stripe
+  ...
+```
+
+You will need to add the stripe keys to your `ENV`.
+- `STRIPE_PUBLISHABLE_KEY` is your stripe publishable key.
+- `STRIPE_SECRET_KEY` is your stripe secret key.
+- `STRIPE_WEBHOOK_SECRET` is a secret that is used for stripe as a password for basic authentication to the webhook. You can use `rake secret` to generate a suitable secret. This is also used when configuring the stripe webhook in stripe: `https://stripe:STRIPE_WEBHOOK_SECRET@myapplication.com/pay_me-stripe_webhooks`
+- `STRIPE_SIGNING_SECRET` is used by stripe to sign webhooks. It can be found in your stripe webhook settings.
+
+PayMe adds to rake task for caching Stripe plans locally to reduce calls to stripe.
+They are:
+- `pay_me:stripe:add_stripe_plans` This will add missing Stripe plans, but not delete local ones that no longer exist on stripe.
+- `pay_me:stripe:sync_stripe_plans` This will add missing Stripe plans and delete local ones that don't exist on stripe.
+
+You are now setup!
+
+### Stripe Configuration Checklist
+- [ ] Get API keys and add to `ENV`
+- [ ] Add webhook URL and webhook secret to `ENV`
+- [ ] Get webhook signing secret and add to `ENV`
+- [ ] Add plan(s) to Stripe.
+TODO...
+
+### Usage
+#### Todo:
+- [ ] TODO...
+
+## License
+Copyright (c) 2015, Pay Me is developed and maintained by Wildland

data/Rakefile

@@ -0,0 +1,33 @@
+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    = 'PayMe'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path('../test/dummy/Rakefile', __FILE__)
+load 'rails/tasks/engine.rake'
+
+load 'rails/tasks/statistics.rake'
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/app/controllers/pay_me/api/v1/invoices_controller.rb

@@ -0,0 +1,30 @@
+require_dependency 'pay_me/application_controller'
+module PayMe
+  module Api
+    module V1
+      class InvoicesController < ApplicationController # TODO ApiMe Integration
+        def index
+          invoices = PayMe.configuration.stripe_invoice_class.list
+
+          render status: 200, json: {
+            invoices: invoices.map do |invoice|
+              invoice.as_json.tap do |i|
+                i.store('stripe_id', i.delete('id'))
+              end
+            end
+          }
+        end
+
+        def show
+          invoice = PayMe.configuration.stripe_invoice_class.retrieve(params[:id])
+
+          render status: 200, json: {
+            invoice: invoice.as_json.tap do |i|
+              i.store('stripe_id', i.delete('id'))
+            end
+          }
+        end
+      end
+    end
+  end
+end

data/app/controllers/pay_me/api/v1/stripe_plans_controller.rb

@@ -0,0 +1,35 @@
+require_dependency 'pay_me/application_controller'
+
+module PayMe
+  module Api
+    module V1
+      class StripePlansController < ApplicationController # TODO ApiMe Integration
+        def index
+          plans = Stripe::Plan.list
+
+          pay_me_plans = PayMe::Plan.all.pluck(:plan_id)
+
+          plans = plans.to_a.select{ |p| pay_me_plans.include?(p['id']) }
+
+          render status: 200, json: {
+            stripePlans: plans.map do |plan|
+              plan.as_json.tap do |p|
+                p.store('stripe_id', p.delete('id'))
+              end
+            end
+          }
+        end
+
+        def show
+          plan = Stripe::Plan.retrieve(params[:id])
+
+          render status: 200, json: {
+            stripePlans: plan.as_json.tap do |p|
+              p.store('stripe_id', p.delete('id'))
+            end
+          }
+        end
+      end
+    end
+  end
+end

data/app/controllers/pay_me/application_controller.rb

@@ -0,0 +1,10 @@
+module PayMe
+  class ApplicationController < ActionController::Base
+    protect_from_forgery with: :exception
+
+    rescue_from Stripe::StripeError do |e|
+      logger.error { e.to_s }
+      render status: e.http_status, json: { reason: e.message, errors: [e.message] }
+    end
+  end
+end

data/app/helpers/pay_me/application_helper.rb

@@ -0,0 +1,4 @@
+module PayMe
+  module ApplicationHelper
+  end
+end

data/app/subscribers/pay_me/customer_subscriber.rb

@@ -0,0 +1,42 @@
+module PayMe
+  class CustomerSubscriber < WebhookEventSubscriber
+    def call(event)
+      case event.type
+      when 'customer.created'
+        customer_created(event.data.object)
+      when 'customer.deleted'
+        customer_deleted(event.data.object)
+      when 'customer.updated'
+        customer_updated(event.data.object)
+      end
+    end
+
+    def customer_created(stripe_customer)
+      ActiveRecord::Base.transaction do
+        PayMe::Customer.created_webhook!(stripe_customer)
+        unless PayMe::Customer.exists?(customer_id: stripe_customer.id)
+          @logger.warn "[STRIPE] Stripe customer stripe_ID:#{stripe_customer.id} created through stripe interface."
+        end
+      end
+    end
+
+    def customer_deleted(stripe_customer)
+      ActiveRecord::Base.transaction do
+        PayMe::Customer.deleted_webhook!(stripe_customer)
+        if PayMe::Customer.exists?(customer_id: stripe_customer.id)
+          @logger.warn "[STRIPE] Stripe customer stripe_ID:#{stripe_customer.id} deleted through stripe interface."
+          PayMe::Customer.find_by!(customer_id: stripe_customer.id).destroy
+        end
+      end
+    end
+
+    def customer_updated(stripe_customer)
+      ActiveRecord::Base.transaction do
+        PayMe::Customer.updated_webhook!(stripe_customer)
+        unless PayMe::Customer.exists?(customer_id: stripe_customer.id)
+          @logger.warn "[STRIPE] Unable to find stripe customer stripe_ID:#{stripe_customer.id} on update."
+        end
+      end
+    end
+  end
+end

data/app/subscribers/pay_me/plan_subscriber.rb

@@ -0,0 +1,38 @@
+module PayMe
+  class PlanSubscriber < WebhookEventSubscriber
+    def call(event)
+      case event.type
+      when 'plan.created'
+        plan_created(event.data.object)
+      when 'plan.deleted'
+        plan_deleted(event.data.object)
+      when 'plan.updated'
+        plan_updated(event.data.object)
+      end
+    end
+
+    def plan_created(stripe_plan)
+      ActiveRecord::Base.transaction do
+        PayMe::Plan.created_webhook!(stripe_plan)
+        unless PayMe::Plan.exists?(plan_id: stripe_plan.id)
+          PayMe::Plan.create!(plan_id: stripe_plan.id)
+        end
+      end
+    end
+
+    def plan_deleted(stripe_plan)
+      ActiveRecord::Base.transaction do
+        PayMe::Plan.deleted_webhook!(stripe_plan)
+        if PayMe::Plan.exists?(plan_id: stripe_plan.id)
+          PayMe::Plan.find_by!(plan_id: stripe_plan.id).destroy
+        end
+      end
+    end
+
+    def plan_updated(stripe_plan)
+      ActiveRecord::Base.transaction do
+        PayMe::Plan.updated_webhook!(stripe_plan)
+      end
+    end
+  end
+end

data/app/subscribers/pay_me/subscription_subscriber.rb

@@ -0,0 +1,50 @@
+module PayMe
+  class SubscriptionSubscriber < WebhookEventSubscriber
+    def call(event)
+      case event.type
+      when 'customer.subscription.created'
+        subscription_created(event.data.object)
+      when 'customer.subscription.deleted'
+        subscription_deleted(event.data.object)
+      when 'customer.subscription.updated'
+        subscription_updated(event.data.object)
+      end
+    end
+
+    def subscription_created(stripe_subscription)
+      ActiveRecord::Base.transaction do
+        PayMe::Subscription.created_webhook!(stripe_subscription)
+        unless PayMe::Subscription.exists?(subscription_id: stripe_subscription.id)
+          @logger.warn "[STRIPE] Stripe subscription stripe_ID:#{stripe_subscription.id} created in stripe interface."
+        end
+      end
+    end
+
+    def subscription_deleted(stripe_subscription)
+      ActiveRecord::Base.transaction do
+        PayMe::Subscription.deleted_webhook!(stripe_subscription)
+        if PayMe::Subscription.exists?(subscription_id: stripe_subscription.id)
+          @logger.warn "[STRIPE] Stripe subscription stripe_ID:#{stripe_subscription.id} delete in stripe interface."
+          PayMe::Subscription.destroy(subscription_id: stripe_subscription.id)
+        end
+      end
+    end
+
+    def subscription_updated(stripe_subscription)
+      ActiveRecord::Base.transaction do
+        PayMe::Subscription.updated_webhook!(stripe_subscription)
+        @subscription = PayMe::Subscription.find_by!(subscription_id: stripe_subscription.id)
+        case stripe_subscription.status
+        when 'trialing', 'active'
+          @subscription.update!(is_active: true, past_due: false)
+        when 'past_due'
+          @subscription.update!(is_active: true, past_due: true)
+        when 'canceled', 'unpaid'
+          @subscription.update!(is_active: false, past_due: false)
+        end
+      end
+    rescue ActiveRecord::RecordNotFound => e
+      @logger.warn "[STRIPE] Unable to find stripe subscription stripe_ID:#{stripe_subscription.id}"
+    end
+  end
+end

data/app/subscribers/pay_me/webhook_event_subscriber.rb

@@ -0,0 +1,11 @@
+module PayMe
+  class WebhookEventSubscriber
+    def initialize(logger)
+      @logger = logger
+    end
+
+    def call(event)
+      @logger.info "[STRIPE] Event :#{event.type}:#{event.id}"
+    end
+  end
+end

data/config/routes.rb

@@ -0,0 +1,11 @@
+PayMe::Engine.routes.draw do
+  namespace :api do
+    namespace :v1 do
+      resources :invoices, only: [:index, :show]
+      resources :stripe_plans, only: [:index, :show]
+      resources :plans, only: [:index, :show]
+      resources :subscriptions, only: [:index, :show]
+    end
+  end
+  mount StripeEvent::Engine, at: '/stripe_webhooks'
+end

data/db/migrate/20160725204454_create_pay_me_subscriptions.rb

@@ -0,0 +1,16 @@
+class CreatePayMeSubscriptions < ActiveRecord::Migration
+  def change
+    create_table :pay_me_subscriptions do |t|
+      t.string :subscription_id, null: false
+      t.boolean :is_active, null: false
+      t.references :customerable, polymorphic: true, null: false
+
+      t.timestamps null: false
+    end
+
+    add_index :pay_me_subscriptions, :subscription_id, unique: true
+    add_index :pay_me_subscriptions,
+              [:customerable_id, :customerable_type],
+              unique: true, name: 'subscription_customerable_index'
+  end
+end

data/db/migrate/20161011170659_create_pay_me_plans.rb

@@ -0,0 +1,8 @@
+class CreatePayMePlans < ActiveRecord::Migration
+  def change
+    create_table :pay_me_plans do |t|
+      t.string :plan_id, null: false
+    end
+    add_reference :pay_me_subscriptions, :pay_me_plan, index: true
+  end
+end

data/db/migrate/20171030174731_add_quantity_to_pay_me_subscription.rb

@@ -0,0 +1,6 @@
+class AddQuantityToPayMeSubscription < ActiveRecord::Migration
+  def change
+    add_column :pay_me_subscriptions, :quantity, :integer
+    add_column :pay_me_subscriptions, :coupon_id, :string
+  end
+end

data/db/migrate/20171130192525_create_pay_me_customers.rb

@@ -0,0 +1,11 @@
+class CreatePayMeCustomers < ActiveRecord::Migration
+  def change
+    create_table :pay_me_customers do |t|
+      t.string :customer_id
+
+      t.timestamps null: false
+    end
+
+    add_reference(:pay_me_subscriptions, :pay_me_customers, index: true)
+  end
+end