-
clone repository
git clone [email protected]:mikgn/payments.git
-
enter app dir
cd payments
-
build services with docker compose
docker compose up -d --build
sample credentials
username: admin
password: Adminpass
localhost:3000
GET transactions
GET localhost:3000/transactions
GET transaction
GET localhost:3000/transactions/:id
Get JWT
POST localhost:3000/auth/login
{
"merchant": {
"email": "[email protected]",
"password": "Testpass1"
}
}
Create transaction
POST localhost:3000/transactions
{
"transaction": {
"type": "Authorize",
"amount": 100,
"customer_email": "[email protected]",
"customer_phone": "1234567890"
}
}
POST localhost:3000/transactions
<?xml version="1.0" encoding="UTF-8" ?>
<hash>
<transaction>
<type>Authorize</type>
<amount>100</amount>
<customer_email>[email protected]</customer_email>
<customer_phone>1234567890</customer_phone>
</transaction>
</hash>
1. Use the latest stable Rails version
2. Use Slim view engine
3. Frontend Framework
React JS (optional) Bootstrap
4. Cover all changes with Rspec tests
5. Add integration tests using Capybara, Nightwatch.js, Cypress, Puppeteer, Protractor or similar
6. Create factories with FactoryBot 7. Apply Rubocop and other linters
8. For Rails models, try to use:
Single Table Inheritance (STI) Polymorphic associations Scopes
Validations and custom validator object, if necessary Factory pattern
Demonstrate meta-programming by generating/defining similar predicate methods
Encapsulate some logic in a module Class methods
private section
9. For Rails controllers, try to:
Keep them thin
Encapsulate business logic in service objects (1), use cases (2), or similar operations (3), interactors (4)
10. Presentation: Use partials
Define Presenters (View models, Form objects (5)) 11. Try to showcase background and cron jobs
Payment System Task
1. Relations:
1.1. Ensure you have merchant and admin user roles (UI)
1.2. Merchants have many payment transactions of different types
1.3. Transactions are related (belongs_to)
You can also have follow/referenced transactions that refer/depend to/on the initial transaction
Authorize Transaction -\ Charge Transaction -\ Refund Transaction Authorize Transaction -\ Reversal Transaction
Only approved or refunded transactions can be referenced, otherwise the submitted transaction will be created with status error
Ensure you prevent a merchant from being deleted unless there are no related payment transactions
2. Models:
2.1. Merchant: name , description , email , status (active, inactive), total_transaction_sum
2.2. Transaction: uuid , amount , status (approved, reversed, refunded, error), customer_email , customer_phone
Use validations for: uuid , amount \ 0, customer_email , status Use STI
Transaction Types
Authorize transaction - has amount and used to hold customer's amount
Charge transaction - has amount and used to confirm the amount is taken from the customer's account and transferred to the merchant
The merchant's total transactions amount has to be the sum of the approved Charge transactions
Refund transaction - has amount and used to reverse a specific amount (whole amount) of the Charge Transaction and return it to the customer
Transitions the Charge transaction to status refunded
The approved Refund transactions will decrease the merchant's
total transaction amount
Reversal transaction - has no amount , used to invalidate the Authorize Transaction
Transitions the Authorize transaction to status reversed
3. Inputs and tasks:
3.1. Imports new merchants and admins from CSV (rake task)
3.2. A background Job for deleting transactions older than an hour (cron job)
3.3. Accepts payments using XML / JSON API (single point POST request)
Include API authentication layer (Basic authentication, Token-based authentication or JWT tokens)
No transactions can be submitted unless the merchant is in active state
4. Presentation:
4.1. Display, edit, destroy merchants
4.2. Display transactions