payify 0.1.16 → 0.1.18

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9a9d1ca2475c701c3c4c52cf336fe15f4c4af67bd0bda8881f3e46c6138d4e4b
-  data.tar.gz: 5b860f6d917cdf5d8b5c488ff178b4543fe944abafc2678a373a93af2004e9ea
+  metadata.gz: 70ae7f58afc3e60048eb7fd0805544c7ba63998c515eb27ee32596d5a655a093
+  data.tar.gz: 54d8895cfb775340d9e4a582bb5129ec13597cd755fc055f063067a7c5fd3755
 SHA512:
-  metadata.gz: ad029b4c099016f6d332d1174323f8a7a2dc68e43173690651959d20e80310a8feb8d6794b88149608861035d61f1b9decfc1ebd059a2eca97b4fcff797f3a99
-  data.tar.gz: 1378445bd65037c4b0593387d25efb9cce4ee738d4546da5f4f8a08105317dbd174deb512b7cb636dc10354df239c072872dd82be4475452548a629512d7c3ff
+  metadata.gz: 69995924741921bd60e5687bdc45093267ae5269530e24a3d63219de930819d0f810066edfedb2f5a76bfeb81b0c6405bb563a04f236fa09cd36bd5543136996
+  data.tar.gz: 78ca6aebe7be93be3cb78732710d0ebd09b4ba4edf1340663b2de9873dc5263c8807d65d12466a44bf3e354785de8e197c6694faebd17863fa0ab18d879956a8

data/README.md

@@ -1,5 +1,11 @@
 # Payify
 
+<span>[![Gem Version](https://img.shields.io/gem/v/payify.svg?label=payify&colorA=D30001&colorB=DF3B3C)](https://rubygems.org/gems/payify)</span> <span>
+[![ruby](https://img.shields.io/badge/ruby-2.6+%20*-ruby.svg?colorA=D30001&colorB=DF3B3C)](https://github.com/andrewdsilva/payify)</span> <span>
+![Rubocop Status](https://img.shields.io/badge/rubocop-passing-rubocop.svg?colorA=1f7a1f&colorB=2aa22a)</span> <span>
+[![MIT license](https://img.shields.io/badge/license-MIT-mit.svg?colorA=1f7a1f&colorB=2aa22a)](http://opensource.org/licenses/MIT)</span> <span>
+![Downloads](https://img.shields.io/gem/dt/payify.svg?colorA=004d99&colorB=0073e6)</span>
+
 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)
@@ -16,34 +22,44 @@ And then execute:
 
 ```
 bundle install
+
+rails payify_engine:install:migrations
 ```
 
 ## 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)
+- Easily create a payment using your models (e.g., from a reservation)
+- Set up payment with Stripe in just 2 minutes
+- Add a payment form to an existing page in your application
+- You can configure the currency and tax rates (VAT)
+- You can track the status of your payments (pending, paid)
+- You can check the payment status through the API
 
 ## Configuration
 
-For now, Payify uses Stripe as the payment gateway. You can configure the currency using an initializer.
+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"
+  config.default_tax_rates_id = "txr_1234567890"
 end
 ```
 
+### Tax rates
+
 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)
+To create a tax rate on Stripe, follow these steps:
+
+1. Go to the "Products" menu in your Stripe account.
+2. Navigate to the "Tax Rates" tab.
+3. Click on the "New" button located at the top right corner.
+
+### API key
+
+You need to set your Stripe API credentials using environment variables. (Secret key, Publishable key)
 
 ```ruby
 # .env
@@ -53,11 +69,13 @@ STRIPE_PUBLISHABLE_KEY="..."
 
 ## Usage
 
+### Add the functionality to your model
+
 To enable payment functionality for a model, simply include the HasPayment concern:
 
 ```ruby
 class Reservation < ApplicationRecord
-  include Payify::HasPaymentConcern
+  include ::Payify::HasPaymentConcern
 
   def amount_to_pay
     self.price
@@ -70,23 +88,50 @@ class Reservation < ApplicationRecord
 end
 ```
 
+### Create a payment
+
 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.
 
+Then you can find the id of the new pending payment with payment.id.
+
 ```ruby
 reservation_1.create_payment
+reservation_1.payment.id # new payment id
 ```
 
-Then you can find the id of the new pending payment with payment.id.
+You can use the `after_save` event on your model to automatically create the payment. Here's an example of how you can implement it:
 
 ```ruby
-reservation_1.payment.id
+class Booking < ApplicationRecord
+  include ::Payify::HasPaymentConcern
+
+  after_save :create_payment
+
+  def amount_to_pay
+    total_ttc
+  end
+end
 ```
 
-Now you just have to redirect the user to `/payments/:id/new` or include the payment form in your page.
+### Include the routes
+
+To be able to use the routes of Payify, you need to add the following line to your `config/routes.rb` file:
+
+```ruby
+mount Payify::Engine => '/payify', as: 'payify'
+```
+
+### Request a payment
+
+To allow the user to make a payment, you have two options:
+
+1. Redirect the user to the payment form: You can redirect the user to the payment form using the URL `/payify/payments/:id/new`, where `:id` represents the payment id.
+
+2. Include the payment form on your page:
 
 ```ruby
 # reservation/show.html.erb
-<%= render "payify/payments/form", payment: @payment %>
+<%= render "payify/payments/form", payment: @object.payment %>
 ```
 
 After completing the payment process, the user will be redirected to:
@@ -95,6 +140,8 @@ After completing the payment process, the user will be redirected to:
 /payments/:id/complete
 ```
 
+### Verify the payment
+
 The application will then verify the payment status with Stripe. You can do it manually calling the following method:
 
 ```ruby
@@ -119,7 +166,22 @@ To customize the page that displays the payment status, you can create the follo
 <% end %>
 ```
 
-## API
+### Override the controller
+
+If you want to override the `PaymentsController`, create the following file:
+
+```ruby
+# app/controllers/payify/payments_controller.rb
+module Payify
+  class PaymentsController < ApplicationController
+    include ::Payify::PaymentsControllerConcern
+
+    ...
+  end
+end
+```
+
+### Using the 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`
 
@@ -131,7 +193,7 @@ After making the payment, you can make a request to the following endpoint to up
 /payments/:id/complete.json
 ```
 
-## Status
+### Status
 
 You can access the payment status using `@payment.status`. The possible statuses are:
 

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

@@ -1,5 +1,3 @@
-<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>
@@ -11,36 +9,50 @@
 <% end %>
 
 <script>
-  const stripe = Stripe("<%= Payify.stripe_publishable_key %>");
+  function loadStripeAndExecuteCode() {
+    if (typeof Stripe === "undefined") {
+      var script = document.createElement("script");
+      script.src = "https://js.stripe.com/v3/";
+      script.onload = function() {
+        executeCode();
+      };
+      document.head.appendChild(script);
+    } else {
+      executeCode();
+    }
+  }
+
+  function executeCode() {
+    const stripe = Stripe("<%= Payify.stripe_publishable_key %>");
 
-  const options = {
-    clientSecret: "<%= payment.stripe_client_secret %>",
-  };
+    const options = {
+      clientSecret: "<%= payment.stripe_client_secret %>",
+    };
 
-  const elements = stripe.elements(options);
+    const elements = stripe.elements(options);
 
-  const paymentElement = elements.create("payment");
-  paymentElement.mount("#payment-element");
+    const paymentElement = elements.create("payment");
+    paymentElement.mount("#payment-element");
 
-  const form = document.getElementById("payment-form");
+    const form = document.getElementById("payment-form");
 
-  form.addEventListener("submit", async (event) => {
-    event.preventDefault();
+    form.addEventListener("submit", async (event) => {
+      event.preventDefault();
 
-    const {error} = await stripe.confirmPayment({
-      elements,
-      confirmParams: {
-        return_url: "<%= request.base_url %>/payify/payments/<%= payment.id %>/complete",
-      },
+      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 {
+      }
     });
+  }
 
-    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`.
-    }
-  });
+  loadStripeAndExecuteCode();
 </script>

data/lib/payify/version.rb

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

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: payify
 version: !ruby/object:Gem::Version
-  version: 0.1.16
+  version: 0.1.18
 platform: ruby
 authors:
 - Nathan Lopez
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-06-22 00:00:00.000000000 Z
+date: 2023-07-14 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: active_model_serializers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.13
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.13
 - !ruby/object:Gem::Dependency
   name: dotenv-rails
   requirement: !ruby/object:Gem::Requirement
@@ -106,7 +120,7 @@ homepage: https://github.com/andrewdsilva/payify
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -121,8 +135,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.14
-signing_key: 
+rubygems_version: 3.1.6
+signing_key:
 specification_version: 4
 summary: Payment integration for Ruby on Rails projects.
 test_files: []