stripe_model_callbacks 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b9d3e6bf9290c17976c275cdabe05a67ba264a3ddb8f1f7af6b75dc4daea6b29
+  data.tar.gz: 0bd3eea3af9cf54996441dfd0e33969ce114107a42f01aee61b93185a16bee33
+SHA512:
+  metadata.gz: e280ae9def15e1de122489e8a348949dc9e86af188650fef9d18bcf217be5bf52ef04df9c5e73b563e27a6208dc681f313ced34c7e0da4c5b680bfaa125c9c74
+  data.tar.gz: 1d99e5f48fd7c022d06406bb5b1b52b55ce21822b8d1190f702f0465f1f8317ec0aa202df46e2af59d3cd4b967f12ad32d9e4acec3c8595a040e951b6216ec48

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2018 kaspernj
+
+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

@@ -0,0 +1,153 @@
+# StripeModelCallbacks
+Stripe database models using ActiveRecord, Stripe event webhooks synchronization and PublicActivity.
+
+This is supposed to make it easier implementing a full blown Stripe implementation into your application,
+so that you can code your app using ActiveRecord and all your favorite gems without having to mess around
+with webhooks, custom and complicated tests and more.
+
+The purpose is that the complicated webhook stuff is done by this gem, and you can trust our tests to work,
+so you dont have to write those thousand of lines yourself.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'stripe_model_callbacks'
+```
+
+And then execute:
+```bash
+bundle
+```
+
+You also need to install and setup the gems `public_activity`, `stripe` and `stripe_event`. Do this:
+
+Install the migration for Public Activity, which will provide logging:
+```bash
+rails g public_activity:migration
+```
+
+Do something like this in `config/routes.rb`:
+```ruby
+Rails.application.routes.draw do
+  mount StripeEvent::Engine => "/stripe-events"
+end
+```
+
+Do something like this in `config/initializers/stripe.rb`:
+```ruby
+Stripe.api_key = ENV.fetch("STRIPE_PUBLIC_KEY")
+StripeEvent.signing_secret = ENV.fetch("STRIPE_SIGNING_KEY")
+
+Rails.configuration.stripe = {
+  publishable_key: ENV.fetch("STRIPE_PUBLIC_KEY"),
+  secret_key: ENV.fetch("STRIPE_SECRET_KEY")
+}
+
+StripeEvent.configure do |events|
+  StripeModelCallbacks::ConfigureService.execute!(events: events)
+end
+```
+
+Add the migrations for the Stripe models to your project like this:
+```bash
+rake stripe_model_callbacks:install:migrations
+```
+
+You should set up your Stripe account to post events to your website using a URL that looks something like this:
+`https://www.yourdomain.com/stripe-events`.
+
+Your application should now receive event webhooks from Stripe and then create, update, mark as deleted,
+log and more automatically using the ActiveRecord models.
+
+You can use a service like Ultrahook to set up a proxy for your local development machine to test against.
+
+## Usage
+
+### Queries with ActiveRecord
+
+To see a list of transfers, you can do something like this, as you would with any given model:
+
+```ruby
+StripeTransfer.where("stripe_transfers.created > ?", Time.zone.now.beginning_of_month)
+```
+
+You can inspect the tables and see which tables and columns that are available. Most of it alligns with
+the attributes mentioned in Stripe's own API.
+
+### Updating on Stripe
+
+You can update the data on Stripe like this:
+
+```ruby
+stripe_subscription = StripeSubscription.find(id)
+stripe_subscription.update_on_stripe!(tax_percent: 10)
+```
+
+Create a record from a Stripe object
+
+```ruby
+object = Stripe::Subscription.retrieve(id)
+stripe_subscription = StripeSubscription.create_from_stripe!(object)
+```
+
+Sync data from Stripe:
+```ruby
+stripe_subscription = StripeSubscription.find(id)
+stripe_subscription.reload_from_stripe!
+```
+
+Delete on Stripe:
+```ruby
+stripe_subscription = StripeSubscription.find(id)
+stripe_subscription.destroy_on_stripe!
+```
+
+Convert model to a Stripe object:
+```ruby
+stripe_subscription = StripeSubscription.find(id)
+stripe_subscription.to_stripe.delete(at_period_end: true)
+
+# We should probably reload so the model reflect that change instantly (else it should receive it through a sync event in a short while)
+stripe_subscription.reload_from_stripe!
+```
+
+## Testing
+
+### Factories
+
+If you need some FactoryBot factories, then you can do like this in `spec/rails_helper.rb`:
+```ruby
+require "stripe_model_callbacks/factory_bot_definitions"
+```
+
+You can take a look at the factories here:
+https://github.com/kaspernj/stripe_model_callbacks/tree/master/spec/factories
+
+### Mock events
+
+You can mock Stripe events by using the helper method `mock_stripe_event` by including this helper:
+
+```
+RSpec.configure do |config|
+  config.include StripeModelCallbacks::EventMocker
+end
+```
+
+You can find all the events you can mock here: https://github.com/kaspernj/stripe_model_callbacks/tree/master/spec/fixtures/stripe_events
+
+You can mock the events by their file name like this:
+```ruby
+mock_stripe_event("charge.refunded")
+```
+
+You can change the data of the event like this:
+```ruby
+mock_stripe_event("invoice.created", data: {object: {discount: {"customer": "cus_CLI9d5IHGcdWBY"}}})
+```
+
+## Contributing
+Contribution directions go here.
+
+## License
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,26 @@
+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    = "StripeModelCallbacks"
+  rdoc.options << "--line-numbers"
+  rdoc.rdoc_files.include("README.md")
+  rdoc.rdoc_files.include("lib/**/*.rb")
+end
+
+APP_RAKEFILE = File.expand_path("spec/dummy/Rakefile", __dir__)
+load "rails/tasks/engine.rake"
+load "rails/tasks/statistics.rake"
+
+require "bundler/gem_tasks"
+
+if Rails.env.development? || Rails.env.test?
+  require "best_practice_project"
+  BestPracticeProject.load_tasks
+end

data/app/assets/config/stripe_model_callbacks_manifest.js

@@ -0,0 +1,2 @@
+//= link_directory ../javascripts/stripe_model_callbacks .js
+//= link_directory ../stylesheets/stripe_model_callbacks .css

data/app/assets/javascripts/stripe_model_callbacks/application.js

@@ -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 any plugin's vendor/assets/javascripts directory 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
+// compiled file. JavaScript code in this file should be added after the last require_* statement.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/app/assets/stylesheets/stripe_model_callbacks/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/stripe_model_callbacks/application_controller.rb

@@ -0,0 +1,3 @@
+class StripeModelCallbacks::ApplicationController < ActionController::Base
+  protect_from_forgery with: :exception
+end

data/app/jobs/stripe_model_callbacks/application_job.rb

@@ -0,0 +1,2 @@
+class StripeModelCallbacks::ApplicationJob < ActiveJob::Base
+end

data/app/mailers/stripe_model_callbacks/application_mailer.rb

@@ -0,0 +1,4 @@
+class StripeModelCallbacks::ApplicationMailer < ActionMailer::Base
+  default from: "from@example.com"
+  layout "mailer"
+end

data/app/models/stripe_model_callbacks/application_record.rb

@@ -0,0 +1,60 @@
+class StripeModelCallbacks::ApplicationRecord < ActiveRecord::Base
+  include PublicActivity::Model
+  tracked
+
+  self.abstract_class = true
+
+  attr_writer :stripe_object
+
+  def self.create_from_stripe!(object)
+    model = new
+    model.stripe_object = object
+    model.assign_from_stripe(object)
+    model.save!
+    model
+  end
+
+  def self.create_on_stripe!(attributes)
+    object = stripe_class.create(attributes)
+    create_from_stripe!(object)
+  end
+
+  def to_stripe
+    @to_stripe ||= self.class.stripe_class.retrieve(stripe_id)
+  end
+
+  def reload_from_stripe!
+    assign_from_stripe(to_stripe)
+    save!
+  end
+
+  def reload!(*args, &blk)
+    @to_stripe = nil
+    super
+  end
+
+  def update_on_stripe(attributes)
+    attributes.each do |key, value|
+      to_stripe.__send__("#{key}=", value)
+    end
+
+    to_stripe.save
+    reload_from_stripe!
+    true
+  end
+
+  def update_on_stripe!(attributes)
+    raise ActiveRecord::RecordInvalid, self unless update_on_stripe(attributes)
+  end
+
+  def destroy_on_stripe
+    to_stripe.delete
+    update!(deleted_at: Time.zone.now) if respond_to?(:deleted_at)
+    reload_from_stripe!
+    true
+  end
+
+  def destroy_on_stripe!
+    raise ActiveRecord::RecordInvalid, self unless destroy_on_stripe
+  end
+end

data/app/services/stripe_model_callbacks/account/external_account/updated_service.rb

@@ -0,0 +1,13 @@
+class StripeModelCallbacks::Account::ExternalAccount::UpdatedService < StripeModelCallbacks::BaseEventService
+  def execute
+    bank_account = StripeBankAccount.find_or_initialize_by(stripe_id: object.id)
+    bank_account.assign_from_stripe(object)
+
+    if bank_account.save
+      bank_account.create_activity :deleted if event.type == "account.external_account.deleted"
+      succeed!
+    else
+      fail! bank_account.errors.full_messages
+    end
+  end
+end

data/app/services/stripe_model_callbacks/attributes_assigner_service.rb

@@ -0,0 +1,35 @@
+class StripeModelCallbacks::AttributesAssignerService < ServicePattern::Service
+  attr_reader :attributes, :model, :stripe_model
+
+  def initialize(attributes:, model:, stripe_model:)
+    @attributes = attributes
+    @model = model
+    @stripe_model = stripe_model
+  end
+
+  def execute
+    attributes.each do |attribute|
+      next unless stripe_model.respond_to?(attribute)
+
+      value = stripe_model.__send__(attribute)
+
+      if attribute == "metadata"
+        value = JSON.generate(value)
+      elsif attribute == "created" && value
+        value = Time.zone.at(value)
+      end
+
+      model.__send__(setter_method(attribute), value)
+    end
+
+    succeed!
+  end
+
+  def setter_method(attribute)
+    if attribute == "id"
+      "stripe_id="
+    else
+      "#{attribute}="
+    end
+  end
+end

data/app/services/stripe_model_callbacks/base_event_service.rb

@@ -0,0 +1,9 @@
+class StripeModelCallbacks::BaseEventService < StripeModelCallbacks::BaseService
+  attr_reader :event, :object
+
+  def initialize(event: nil, object: nil)
+    @event = event
+    @object = object
+    @object ||= event.data.object
+  end
+end

data/app/services/stripe_model_callbacks/base_service.rb

@@ -0,0 +1,26 @@
+class StripeModelCallbacks::BaseService < ServicePattern::Service
+  def self.reported_execute!(*args, &blk)
+    with_exception_notifications do
+      response = execute(*args, &blk)
+      raise response.errors.join(". ") unless response.success?
+
+      return response
+    end
+  end
+
+  def self.with_exception_notifications
+    yield
+  rescue => e # rubocop:disable Style/RescueStandardError
+    Rails.logger.error "ERROR: #{e.message}"
+
+    cleaned = Rails.backtrace_cleaner.clean(e.backtrace)
+    if cleaned.any?
+      Rails.logger.error cleaned
+    else
+      Rails.logger.error e.backtrace.join("\n")
+    end
+
+    ExceptionNotifier.notify_exception(e) if Object.const_defined?("ExceptionNotifier")
+    raise e
+  end
+end

data/app/services/stripe_model_callbacks/charge/dispute_updated_service.rb

@@ -0,0 +1,29 @@
+class StripeModelCallbacks::Charge::DisputeUpdatedService < StripeModelCallbacks::BaseEventService
+  def execute
+    dispute.assign_from_stripe(object)
+
+    if dispute.save
+      create_activity
+      succeed!
+    else
+      fail! dispute.errors.full_messages
+    end
+  end
+
+private
+
+  def dispute
+    @dispute ||= StripeDispute.find_or_initialize_by(stripe_id: object.id)
+  end
+
+  def create_activity
+    case event.type
+    when "charge.dispute.closed"
+      dispute.create_activity :closed
+    when "charge.dispute.funds_reinstated"
+      dispute.create_activity :funds_reinstated
+    when "charge.dispute.funds_withdrawn"
+      dispute.create_activity :funds_withdrawn
+    end
+  end
+end