payify 0.1.17 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d2a72ee40f171a59366aafdae3a4a164350a4f6abce4722eea01d8b81ead5d4d
-  data.tar.gz: b250cfb7c1692d82208d532313a44cded79e43a21d91f0a66c796794e4b742d9
+  metadata.gz: d3256b950f558c1a65f1a1f1aaaa0746c2f61fd77157ed0595597f813ad44b85
+  data.tar.gz: 79ff6a4cac237777cafa252056beec61fc350c3635792275152b64777fb75548
 SHA512:
-  metadata.gz: fb80e767f463c6ea8967b980ae76ac23b5d3f89d084cc2f4bc216ca387498bdeac5b6a09cf5d243177583d11a3d012439ac78704dfaac281bf375bdf3ee9f98f
-  data.tar.gz: e830d91f014df3ad9c143be2127a4ec52f9a435db3969e0b9cf9eba228d34941d39709c7c28189a7989120cce901c42070a051f888ee51cb76ca875ad7e88f9e
+  metadata.gz: cd048981b50ef906688ed6c5081aaea402f737963c4faba2660f79d809f2f8e876a8c14a2602606f35a71565ab89c521d7a841783ac19dc88c3ac2830663e79e
+  data.tar.gz: b11df362c1c24b8d5e2714bcd394c7db55bcf7bddd5bf6255666f43256696927763a4a853abb42621d219c25410460db61b97edf8f70a47231ab35403743099e

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/lib/payify/version.rb

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

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: payify
 version: !ruby/object:Gem::Version
-  version: 0.1.17
+  version: 1.0.0
 platform: ruby
 authors:
 - Nathan Lopez
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-06-22 00:00:00.000000000 Z
+date: 2023-07-22 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
@@ -121,7 +135,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.14
+rubygems_version: 3.0.3.1
 signing_key: 
 specification_version: 4
 summary: Payment integration for Ruby on Rails projects.