payify 0.1.8 → 0.1.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f10be9e82978e57bd4e4c3479855ed1350b368b6184e457e4e376ab4a7573faf
-  data.tar.gz: 8c1d93953f0c323006e3ad4de04a8ff89e222dc35c98834332cfd0d2c6b23f7f
+  metadata.gz: 572e3862b02347baa43df6a50a9dd773c79573a015351f73769d80d7246aa9ce
+  data.tar.gz: 6b609424f7103700effdf62014ac3c609e4e8b30e9665a83d067657a3b447e3b
 SHA512:
-  metadata.gz: dbe479317045d4c67783fa3572de270809559137a5d86fc7155ca6f43e3d1ed59550ca5fe1b1fe7ab32a6fb57b0d0cdd8b6b71c6287cd732c3e2e69f575fbd64
-  data.tar.gz: 3c581ee9826c7fabf7126ecb31dc4cec8c0a940e387af13d21a7d77498e4d4f8e651175ef66ec9ac7c2c2b239fb1459e5881ba32c7baf61c1f897df7371025c1
+  metadata.gz: 96b1731d4008da4e7be38a0fd188cad99307e56cc0021344c6027e395fa9f9268de4f1ea0490523d297a25439dfc4f024b02cb7ee9cc8baf6e4c7051eadb5447
+  data.tar.gz: b7b9045bc3377475728c16bc3f023701b8d1d7d19c3dfc563811d9305c8b1cdeda5e9d742b7b6ac1f55771343c9496a323f1dbd46dcd35e058eef0e75dac52d9

data/README.md

@@ -0,0 +1,164 @@
+# Payify
+
+PayifyRails is a Ruby gem that simplifies payment integration into Ruby on Rails projects. It allows to easily add payment functionality to your models. For example, by applying the HasPaymentConcern to a reservation model, you can manage the payment process for reservations seamlessly.
+
+![Screenshot](./app/assets/images/payify/screenshot.png)
+
+## Installation
+
+To install the gem add it into a Gemfile (Bundler):
+
+```ruby
+gem 'payify', '~> 0.1.0'
+```
+
+And then execute:
+
+```
+bundle install
+```
+
+## Features ✅
+
+- Includes a Payment model
+- Provides concerns to easily add a payment system to your model
+- Enables payment with Stripe
+- Offers a payment form to integrate into your application
+- Allows payment status to be checked via an api route
+- Allows configuration of payment (currency, VAT)
+- Provides a user interface for payment processing
+- Enables management of payment status (pending, paid)
+
+## Configuration
+
+For now, Payify uses Stripe as the payment gateway. You can configure the currency using an initializer.
+
+```ruby
+# initializers/payify.rb
+Payify.setup do |config|
+  config.currency = "usd"
+  config.default_tax_rates_id = "eur"
+end
+```
+
+To handle VAT or different tax rates on your payments, you need to create tax rates on Stripe and define the default_tax_rates_id or, alternatively, define the tax_rates_id method on your payment-related models. Leave it empty if you don't manage any taxes.
+
+You can set your Stripe API credentials using environment variables. (Secret key, Publishable key)
+
+```ruby
+# .env
+STRIPE_API_KEY="..."
+STRIPE_PUBLISHABLE_KEY="..."
+```
+
+## Usage
+
+To enable payment functionality for a model, simply include the HasPayment concern:
+
+```ruby
+class Reservation < ApplicationRecord
+  include Payify::HasPaymentConcern
+
+  def amount_to_pay
+    self.price
+  end
+
+  # Optional : Override the default tax rates id
+  def tax_rates_id
+    'txr_1234567890'
+  end
+end
+```
+
+When you want to request a payment for a model on which you added the concern, you just need to call the create_payment method.
+
+```ruby
+reservation_1.create_payment
+```
+
+Then you can find the id of the new pending payment with payment.id.
+
+```ruby
+reservation_1.payment.id
+```
+
+Now you just have to redirect the user to `/payments/:id/new` or include the payment form in your page.
+
+```ruby
+# reservation/show.html.erb
+<%= render "payify/payments/form", payment: @payment %>
+```
+
+After completing the payment process, the user will be redirected to:
+
+```
+/payments/:id/complete
+```
+
+The application will then verify the payment status with Stripe. You can do it manually calling the following method:
+
+```ruby
+@payment.stripe_confirm_payment
+```
+
+If the payment has been successfully processed, a confirmation message will be displayed to the user. The payment method `paid?` will return `true`.
+
+To customize the page that displays the payment status, you can create the following file:
+
+```ruby
+# views/payify/payments/complete.html.erb
+
+<% if @payment.paid? %>
+  <div class="alert alert-success" role="alert">
+    <%= I18n.t("payments.complete.paid") %>
+  </div>
+<% else %>
+  <div class="alert alert-danger" role="alert">
+    <%= I18n.t("payments.complete.pending") %>
+  </div>
+<% end %>
+```
+
+## API
+
+If you prefer using the Payify API, after creating the payment object, you can initialize a new Stripe payment by making a request to: `/payments/:id/new.json`
+
+This request will return a JSON response containing the `stripe_payment_intent_id` and `stripe_client_secret` required to process a payment using Stripe.
+
+After making the payment, you can make a request to the following endpoint to update the payment status and retrieve its current state:
+
+```
+/payments/:id/complete.json
+```
+
+## Status
+
+You can access the payment status using `@payment.status`. The possible statuses are:
+
+- `pending`: The payment is still being processed.
+- `paid`: The payment has been successfully completed.
+- `failed`: The payment has failed.
+
+## Tests
+
+To run the tests, execute `rspec` command.
+
+You can test the payment process in your web browser by following these steps:
+
+1. Navigate to the `test/dummy` directory.
+2. Run the following commands:
+   - `rails db:create`
+   - `rails db:migrate`
+   - `rails db:seed`
+   - `rails s`
+3. Open your browser and go to: [http://localhost:3000/](http://localhost:3000/).
+
+Each time you run the seed command, your test database will be reset with a reservation that has a payment with an ID of 1. This allows you to test the payment process at the following address: [http://localhost:3000/payments/1/new](http://localhost:3000/payments/1/new).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/andrewdsilva/payify.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/app/assets/config/payify_manifest.js

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

data/app/assets/stylesheets/payify/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/payify/payments_controller.rb

@@ -0,0 +1,29 @@
+module Payify
+  class PaymentsController < ActionController::Base
+    before_action :set_object, only: %i[new complete]
+
+    def new
+      @payment.stripe_init_intent
+
+      respond_to do |format|
+        format.html
+        format.json { render json: @payment }
+      end
+    end
+
+    def complete
+      @payment.stripe_confirm_payment unless @payment.paid?
+
+      respond_to do |format|
+        format.html
+        format.json { render json: @payment }
+      end
+    end
+
+    private
+
+    def set_object
+      @payment = Payment.find(params[:id])
+    end
+  end
+end

data/app/helpers/payify/application_helper.rb

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

data/app/jobs/payify/application_job.rb

@@ -0,0 +1,4 @@
+module Payify
+  class ApplicationJob < ActiveJob::Base
+  end
+end

data/app/mailers/payify/application_mailer.rb

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

data/app/models/concerns/payify/has_payment_concern.rb

@@ -0,0 +1,28 @@
+module Payify
+  module HasPaymentConcern
+    extend ActiveSupport::Concern
+
+    included do
+      has_one :payment, as: :model, dependent: :destroy, class_name: "Payify::Payment"
+    end
+
+    def create_payment
+      build_payment(amount: amount_to_pay)
+
+      payment.save
+      payment
+    end
+
+    def cancel_payment
+      payment.destroy if payment.present?
+    end
+
+    def amount_to_pay
+      raise NotImplementedError, "The 'amount_to_pay' method must be implemented in the including model."
+    end
+
+    def tax_rates_id
+      nil
+    end
+  end
+end

data/app/models/concerns/payify/stripe_payment_concern.rb

@@ -0,0 +1,33 @@
+require "stripe/client"
+
+module Payify
+  module StripePaymentConcern
+    extend ActiveSupport::Concern
+
+    def stripe_client
+      @stripe_client ||= Stripe::Client.new
+    end
+
+    def stripe_init_intent
+      return unless stripe_payment_inent_id.nil? && !paid?
+
+      intent = stripe_client.create_payment_intent(amount, tax_id)
+
+      update_attribute(:stripe_payment_inent_id, intent.id)
+      update_attribute(:stripe_client_secret, intent.client_secret)
+    end
+
+    def stripe_confirm_payment
+      intent = stripe_client.find_intent(stripe_payment_inent_id)
+
+      return unless intent["status"] == "succeeded"
+
+      update_attribute(:paid_at, Time.now)
+      update_attribute(:status, Payify::Payment.statuses[:paid])
+    end
+
+    def tax_id
+      model&.tax_rates_id || Payify.default_tax_rates_id
+    end
+  end
+end

data/app/models/payify/application_record.rb

@@ -0,0 +1,5 @@
+module Payify
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

data/app/models/payify/payment.rb

@@ -0,0 +1,35 @@
+module Payify
+  class Payment < ApplicationRecord
+    include ::Payify::StripePaymentConcern
+
+    enum status: { pending: 0, paid: 1, failed: 2 }
+    enum payment_method: { stripe: 0 }
+
+    belongs_to :model, polymorphic: true, optional: true
+
+    validates :amount, presence: true, numericality: { greater_than_or_equal_to: 0 }
+    validates :status, presence: true
+
+    before_destroy :cannot_destroy_if_paid
+
+    def make_payment(transaction_id)
+      self.transaction_id = transaction_id
+      self.paid_at = Time.current
+      self.status = :paid
+    end
+
+    def can_destroy?
+      !paid?
+    end
+
+    def paid?
+      paid_at.present?
+    end
+
+    private
+
+    def cannot_destroy_if_paid
+      raise ActiveRecord::RecordNotDestroyed if paid?
+    end
+  end
+end

data/app/serializers/payify/payment_serializer.rb

@@ -0,0 +1,10 @@
+module Payify
+  class PaymentSerializer < ActiveModel::Serializer
+    attributes :id, :amount, :status, :payment_method, :transaction_id, :paid_at
+
+    attributes :stripe_payment_inent_id, :stripe_client_secret
+
+    attribute(:paid) { object.paid? }
+    attribute(:can_destroy) { object.can_destroy? }
+  end
+end

data/app/views/payify/application.html.erb

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

data/app/views/payify/payments/_form.html.erb

@@ -0,0 +1,46 @@
+<script src="https://js.stripe.com/v3/"></script>
+
+<%= form_with(id: "payment-form", url: payify.complete_payment_path, method: "post") do |form| %>
+  <div id="payment-element">
+  </div>
+
+  <div id="error-message">
+  </div>
+
+  <%= form.submit I18n.t("payments.submit"), id: "submit", class: "btn btn-primary w-100 mt-4" %>
+<% end %>
+
+<script>
+  const stripe = Stripe("<%= Payify.stripe_publishable_key %>");
+
+  const options = {
+    clientSecret: "<%= payment.stripe_client_secret %>",
+  };
+
+  const elements = stripe.elements(options);
+
+  const paymentElement = elements.create("payment");
+  paymentElement.mount("#payment-element");
+
+  const form = document.getElementById("payment-form");
+
+  form.addEventListener("submit", async (event) => {
+    event.preventDefault();
+
+    const {error} = await stripe.confirmPayment({
+      elements,
+      confirmParams: {
+        return_url: "<%= request.base_url %>/payify/payments/<%= payment.id %>/complete",
+      },
+    });
+
+    if (error) {
+      const messageContainer = document.querySelector("#error-message");
+      messageContainer.textContent = error.message;
+    } else {
+      // Your customer will be redirected to your `return_url`. For some payment
+      // methods like iDEAL, your customer will be redirected to an intermediate
+      // site first to authorize the payment, then redirected to the `return_url`.
+    }
+  });
+</script>

data/app/views/payify/payments/complete.html.erb

@@ -0,0 +1,26 @@
+<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="utf-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1">
+
+    <link href="https://cdn.jsdelivr.net/npm/bootstrap@5.0.2/dist/css/bootstrap.min.css" rel="stylesheet" integrity="sha384-EVSTQN3/azprG1Anm3QDgpJLIm9Nao0Yz1ztcQTwFspd3yD65VohhpuuCOmLASjC" crossorigin="anonymous">
+
+    <title>Payment</title>
+  </head>
+  <body>
+
+    <div class="container py-5 my-5" style="max-width: 500px;">
+      <% if @payment.paid? %>
+        <div class="alert alert-success" role="alert">
+          <%= I18n.t("payments.complete.paid") %>
+        </div>
+      <% else %>
+        <div class="alert alert-danger" role="alert">
+          <%= I18n.t("payments.complete.pending") %>
+        </div>
+      <% end %>
+    </div>
+
+  </body>
+</html>

data/app/views/payify/payments/new.html.erb

@@ -0,0 +1,24 @@
+<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="utf-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1">
+
+    <link href="https://cdn.jsdelivr.net/npm/bootstrap@5.0.2/dist/css/bootstrap.min.css" rel="stylesheet" integrity="sha384-EVSTQN3/azprG1Anm3QDgpJLIm9Nao0Yz1ztcQTwFspd3yD65VohhpuuCOmLASjC" crossorigin="anonymous">
+
+    <title>Payment</title>
+  </head>
+  <body>
+
+    <div class="container py-5 my-5" style="max-width: 500px;">
+      <% if @payment.paid? %>
+        <div class="alert alert-info" role="alert">
+          <%= I18n.t("payments.already_paid") %>
+        </div>
+      <% else %>
+        <%= render "form", payment: @payment %>
+      <% end %>
+    </div>
+
+  </body>
+</html>

data/config/locales/payify.en.yml

@@ -0,0 +1,7 @@
+en:
+  payments:
+    submit: Submit
+    already_paid: Payment has already been completed.
+    complete:
+      pending: Payment pending.
+      paid: Successful payment!

data/config/routes.rb

@@ -0,0 +1,8 @@
+::Payify::Engine.routes.draw do
+  resources :payments do
+    member do
+      get "new"
+      get "complete", as: "complete"
+    end
+  end
+end

data/db/migrate/20230611124944_create_payment.rb

@@ -0,0 +1,15 @@
+class CreatePayment < ActiveRecord::Migration[7.0]
+  def change
+    create_table :payify_payments do |t|
+      t.decimal :amount, precision: 10, scale: 2, null: false
+      t.integer :status, default: 0, null: false
+      t.integer :payment_method
+      t.string :transaction_id
+      t.datetime :paid_at
+      t.string :model_type
+      t.integer :model_id
+
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20230617052430_add_stripe_payment_intent_id.rb

@@ -0,0 +1,6 @@
+class AddStripePaymentIntentId < ActiveRecord::Migration[7.0]
+  def change
+    add_column :payify_payments, :stripe_payment_inent_id, :string
+    add_column :payify_payments, :stripe_client_secret, :string
+  end
+end

data/lib/payify/engine.rb

@@ -0,0 +1,5 @@
+module Payify
+  class Engine < ::Rails::Engine
+    isolate_namespace Payify
+  end
+end

data/lib/payify/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Payify
+  VERSION = "0.1.10"
+end

data/lib/payify.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require_relative "payify/version"
+require "payify/engine"
+require "dotenv/load"
+
+module Payify
+  class Error < StandardError; end
+
+  mattr_accessor :currency
+  @@currency = "usd"
+
+  mattr_accessor :default_tax_rates_id
+  @@default_tax_rates_id = nil
+
+  mattr_accessor :stripe_api_key
+  @@stripe_api_key = ENV["STRIPE_API_KEY"]
+
+  mattr_accessor :stripe_publishable_key
+  @@stripe_publishable_key = ENV["STRIPE_PUBLISHABLE_KEY"]
+
+  def self.setup
+    yield self
+  end
+end

data/lib/stripe/client.rb

@@ -0,0 +1,31 @@
+module Stripe
+  class Client
+    def initialize
+      stripe
+
+      Stripe.api_key = Payify.stripe_api_key
+    end
+
+    def stripe
+      @stripe ||= Stripe::StripeClient.new
+    end
+
+    def create_payment_intent(amount, tax_id = nil, object_invoice = "")
+      infos = {
+        amount: (amount * 100).to_i,
+        currency: Payify.currency,
+        description: object_invoice,
+        setup_future_usage: "off_session",
+        metadata: {
+          "tax_id": tax_id
+        }
+      }
+
+      Stripe::PaymentIntent.create(infos)
+    end
+
+    def find_intent(payment_intent_id)
+      Stripe::PaymentIntent.retrieve(payment_intent_id)
+    end
+  end
+end

data/lib/tasks/payify_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :payify do
+#   # Task goes here
+# end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: payify
 version: !ruby/object:Gem::Version
-  version: 0.1.8
+  version: 0.1.10
 platform: ruby
 authors:
 - Nathan Lopez
@@ -31,7 +31,34 @@ email:
 executables: []
 extensions: []
 extra_rdoc_files: []
-files: []
+files:
+- README.md
+- app/assets/config/payify_manifest.js
+- app/assets/images/payify/screenshot.png
+- app/assets/images/payify/vat.png
+- app/assets/stylesheets/payify/application.css
+- app/controllers/payify/payments_controller.rb
+- app/helpers/payify/application_helper.rb
+- app/jobs/payify/application_job.rb
+- app/mailers/payify/application_mailer.rb
+- app/models/concerns/payify/has_payment_concern.rb
+- app/models/concerns/payify/stripe_payment_concern.rb
+- app/models/payify/application_record.rb
+- app/models/payify/payment.rb
+- app/serializers/payify/payment_serializer.rb
+- app/views/payify/application.html.erb
+- app/views/payify/payments/_form.html.erb
+- app/views/payify/payments/complete.html.erb
+- app/views/payify/payments/new.html.erb
+- config/locales/payify.en.yml
+- config/routes.rb
+- db/migrate/20230611124944_create_payment.rb
+- db/migrate/20230617052430_add_stripe_payment_intent_id.rb
+- lib/payify.rb
+- lib/payify/engine.rb
+- lib/payify/version.rb
+- lib/stripe/client.rb
+- lib/tasks/payify_tasks.rake
 homepage: https://github.com/andrewdsilva/payify
 licenses:
 - MIT