@bigbinary/neeto-payments-frontend 1.3.1 → 1.3.3

package/README.md

@@ -1,13 +1,29 @@
-# @bigbinary/neeto-payments-frontend
+# neeto-payments-nano
+
+- [Engine and package installation](./docs/engine-and-package-installation.md)
+- [Building and releasing](./docs/building-and-releasing.md)
+
+## Integrations
+
+|   Project    |     Integrated     |
+| :----------: | :----------------: |
+|   neetoCal   | :white_check_mark: |
+| neetoInvoice | :white_check_mark: |
+| neetoCourse  |        :x:         |
+|  neetoForm   |        :x:         |
+
+## @bigbinary/neeto-payments-frontend
 
 ![npm](https://img.shields.io/npm/v/@bigbinary/neeto-payments-frontend?color=greenyellow)
 ![npm](https://img.shields.io/npm/dw/@bigbinary/neeto-payments-frontend?color=greenyellow)
 
 neetoPayments is the library that manages payments across neeto products.
 
-## Installation
+### Installation
 
-1.  **neetoPayments** has a few peer dependencies that are required for the proper functioning of the package. Install all the peer dependencies using the below command:
+1.  **neetoPayments** has a few peer dependencies that are required for the
+    proper functioning of the package. Install all the peer dependencies using
+    the below command:
 
     ```zsh
     yarn add @bigbinary/neeto-commons-frontend@2.0.54 @bigbinary/neeto-filters-frontend@2.8.1 @bigbinary/neeto-icons@1.9.22 @bigbinary/neeto-molecules@1.0.9 @bigbinary/neetoui@4.4.10 @honeybadger-io/js@5.1.1 @honeybadger-io/react@5.1.3 axios@1.3.4 classnames@2.3.2 formik@2.2.9 js-logger@1.6.1 mixpanel-browser@2.45.0 ramda@0.28.0 react-helmet@6.1.0 react-query@3.39.3 react-router-dom@5.3.4 react-toastify@8.2.0 yup@1.0.2
@@ -19,7 +35,7 @@ neetoPayments is the library that manages payments across neeto products.
     yarn add @bigbinary/neeto-payments-frontend
     ```
 
-## Usage
+### Usage
 
 neeto-payments-frontend exports:
 
@@ -27,19 +43,26 @@ neeto-payments-frontend exports:
 - `buildStripeTransactionLink()` function
 - `useStripePromise()` hook
 
-### 1. `Dashboard` component
+#### 1. `Dashboard` component
 
-#### Props
+##### Props
 
-1. **holdableId**: To specify the ID of the entity that holds the stripe account. This is an optional prop. If the value is not specified, the current organization ID is taken as the default value while querying for transactions.
+1. **holdableId**: To specify the ID of the entity that holds the stripe
+   account. This is an optional prop. If the value is not specified, the current
+   organization ID is taken as the default value while querying for
+   transactions.
 
-2. **payableEntityColumns**: To specify the columns from the payable entity which need to be additionally displayed. It is an optional prop that defaults to `[]` if not specified.
+2. **payableEntityColumns**: To specify the columns from the payable entity
+   which need to be additionally displayed. It is an optional prop that defaults
+   to `[]` if not specified.
 
 3. **searchProps**: To specify the properties of the search bar in `Dashboard`.
 
-4. **tabs**: To specify the tabs to be displayed in the payments dashboard. It is an optional parameter.
+4. **tabs**: To specify the tabs to be displayed in the payments dashboard. It
+   is an optional parameter.
 
-5. **headerProps**: To specify the props to be passed to the neetoUI `Header` component used in the `Dashboard`.
+5. **headerProps**: To specify the props to be passed to the neetoUI `Header`
+   component used in the `Dashboard`.
 
 **More about `payableEntityColumns`**
 
@@ -81,15 +104,21 @@ const payableEntityColumns = [
 ];
 ```
 
-The `payableEntityColumns` is similar to `columnData` prop used in `Table` component in **NeetoUI**. The prop can be modified accordingly to customize the columns in the table. For more customizations, refer
+The `payableEntityColumns` is similar to `columnData` prop used in `Table`
+component in **NeetoUI**. The prop can be modified accordingly to customize the
+columns in the table. For more customizations, refer
 [NeetoUI docs](https://neeto-ui.neeto.com/?path=/docs/components-table--default).
 
-The additional keys are `isFilterable` and `filterProps`. `filterProps` is used to build the list of columns to be represented in the filters pane. The `isFilterable` key must be `true` for `filterProps` to be considered.
+The additional keys are `isFilterable` and `filterProps`. `filterProps` is used
+to build the list of columns to be represented in the filters pane. The
+`isFilterable` key must be `true` for `filterProps` to be considered.
 
 > :memo: **Note:** The data about the payable entity is in the format
-> `{ payable: {...} }`. So the `dataIndex` key must be used accordingly. Refer the example above.
+> `{ payable: {...} }`. So the `dataIndex` key must be used accordingly. Refer
+> the example above.
 
-> In the case of columns with filter type as `single_option` or `multi_option`, `values` key can be passed along with `filterProps`.
+> In the case of columns with filter type as `single_option` or `multi_option`,
+> `values` key can be passed along with `filterProps`.
 
 **More about `searchProps` prop**
 
@@ -104,24 +133,30 @@ const searchProps = {
 };
 ```
 
-This is passed to the `FiltersBar` and `FiltersPane` components from `neeto-filters-frontend`. This is similar to the `keyword` prop used in `neeto-filters-frontend` with an additional `placeholder` key which is used as the placeholder in the search bar.
+This is passed to the `FiltersBar` and `FiltersPane` components from
+`neeto-filters-frontend`. This is similar to the `keyword` prop used in
+`neeto-filters-frontend` with an additional `placeholder` key which is used as
+the placeholder in the search bar.
 
 To know more about the working of `node` and `model` keys, refer the
 [`neeto-filters-frontend` documentation](https://github.com/bigbinary/neeto-filters-frontend/blob/main/README.md).
 
 **More about `tabs` prop**
 
-`tabs` is an array of strings. It has default value as this: `["all", "successful", "pending", "declined", "refunded"]`.It should only be a subset of the array above. Preferably it shouldn't be an empty array.
-
+`tabs` is an array of strings. It has default value as this:
+`["all", "successful", "pending", "declined", "refunded"]`.It should only be a
+subset of the array above. Preferably it shouldn't be an empty array.
 
-### 2. `buildStripeTransactionLink` function
+#### 2. `buildStripeTransactionLink` function
 
-This function is used to generate the stripe transaction link from a payment identifier.
+This function is used to generate the stripe transaction link from a payment
+identifier.
 
 The arguments are:
 
 1. `identifier`: The payment identifier
-2. `isLive`: Specifying whether or not the environment is live. It defaults to `true`.
+2. `isLive`: Specifying whether or not the environment is live. It defaults to
+   `true`.
 
 Example usage
 
@@ -132,11 +167,14 @@ const transactionLink = buildStripeTransactionLink(
 );
 ```
 
-### 3. `useStripePromise` hook
+#### 3. `useStripePromise` hook
 
-This hook is used to generate the `stripePromise` object to be passed to the stripe `<Elements>` context. The `useStripePromise` hook takes a stripe account identifier as input and returns a `Promise`.
+This hook is used to generate the `stripePromise` object to be passed to the
+stripe `<Elements>` context. The `useStripePromise` hook takes a stripe account
+identifier as input and returns a `Promise`.
 
-> :memo: **Note:** `STRIPE_PUBLISHABLE_KEY` environment variable must be present for this hook to work.
+> :memo: **Note:** `STRIPE_PUBLISHABLE_KEY` environment variable must be present
+> for this hook to work.
 
 Example usage
 
@@ -150,9 +188,9 @@ Example usage
 
 ```
 
-### 4. `PaymentKindRestrictionAlert` component
+#### 4. `PaymentKindRestrictionAlert` component
 
-#### Props
+##### Props
 
 1. **isOpen**: To specify whether the Stripe connect restriction alert should be
    opened or closed.
@@ -175,7 +213,154 @@ Example usage
 />
 ```
 
-## Other References
+## neetoPaymentsEngine
+
+neeto-payments-engine is a Rails engine that manages payment across the neeto
+products. It offers the following features to the users.
+
+- Integrate payment gateway account.
+- To set a charge for a service.
+- Collect the charge from End-User.
+- Refund amount collected by value or percentage.
+
+Currently, the engine only supports [Stripe](https://stripe.com) payment gateway
+integration from the following countries _Australia, Austria, Belgium, Canada,
+Cyprus, Estonia, Finland, France, Germany, Gibraltar, Greece, Iceland, India,
+Italy, Latvia, Lithuania, Luxembourg, Malta, Netherlands, Portugal, Slovakia,
+Slovenia, Spain, United Kingdom, United States_. International transfers are not
+possible for Indian business Stripe accounts.
+
+### Installation
+
+1. Add this line to your application's Gemfile:
+
+   ```ruby
+   gem 'neeto-payments-engine', git: 'https://github.com/bigbinary/neeto-payments-engine.git', branch: 'stable'
+   ```
+
+2. And then execute:
+
+   ```shell
+   bundle install
+   ```
+
+3. Add this line to your application's `config/routes.rb` file (replace `at` to
+   your desired route):
+
+   ```ruby
+   mount NeetoPaymentsEngine::Engine, at: '/payments'
+   ```
+
+4. Configure the following environment variables.
+
+   ```yaml
+   APP_URL=#Application URL
+   STRIPE_PUBLISHABLE_KEY='pk_test_fnFiGXjRkMXnLkueiNKJidGU00V83aRC0V'
+   STRIPE_SECRET_KEY='sk_test_eyKnYYoSDcvojBAiFoDv3QJQ00z0yOlt89'
+   ```
+
+   NB: Replace `APP_URL` environment variable value with the host application's
+   base URL without a trailing slash for example: `https://app.neetocal.net`.
+   Stripe environment variables values are `test` mode keys.
+
+5. Run the following command to subscribe Stripe webhooks events.
+
+   ```shell
+   bundle exec rails neeto_payments_engine:stripe:webhooks:subscribe
+   ```
+
+   - After successful subscription, the above command will return the list of
+     events subscribed and the details of environment variable.
+   - Sample output
+     ```
+       *** Successfully subscribed for webhooks ***
+       Please add the following environment variable
+       STRIPE_WEBHOOK_SECRET='whsec_06LHs3IOmLOgEzXDm3otErje8I4Q15ME'
+       ==============================================
+       Subscribed events: [
+          "account.updated",
+          "payment_intent.payment_failed",
+          "payment_intent.processing",
+          "payment_intent.succeeded",
+          "charge.refund.updated",
+          "charge.refunded"
+       ]
+     ```
+   - Add the returned environment variable and its value.
+
+6. Add the following secret values to `config/secrets.yml`.
+
+   ```yaml
+   host: <%= ENV['APP_URL'] || ENV['HEROKU_APP_URL'] %>
+   stripe:
+     publishable_key: <%= ENV['STRIPE_PUBLISHABLE_KEY'] %>
+     secret_key: <%= ENV['STRIPE_SECRET_KEY'] %>
+     webhooks:
+       secret: <%= ENV['STRIPE_WEBHOOK_SECRET'] %>
+   ```
+
+7. Add the following line to application's
+   `config/initializer/neeto_payments_engine.rb` file. Replace the
+   `holdable_class` value with a model name where you want to associate your
+   Stripe account in the host application.
+
+   ```ruby
+    NeetoPaymentsEngine.holdable_class = "Organization"
+   ```
+
+8. Add the following association to the model you defined as holdable_class in
+   step 6.
+
+   ```ruby
+    has_one :stripe_integration, class_name: "::NeetoPaymentsEngine::Stripe::Account", foreign_key: :holdable_id
+   ```
+
+9. Add the following association to the chargeable model. The chargeable model
+   is the model in the host application which needs to charge for its service.
+   For example `Meeting` model in `neetoCal` where meeting service is a
+   chargeable one.
+   ```ruby
+    has_one :charge, as: :chargeable, class_name: "::NeetoPaymentsEngine::Stripe::Charge", dependent: :destroy
+   ```
+10. Add the following association to the payable model.
+
+    ```ruby
+     has_one :payment, as: :payable, class_name: "::NeetoPaymentsEngine::Stripe::Transaction", dependent: :destroy
+    ```
+
+11. Add the following queue to your sidekiq config file `config/sidekiq.yml`
+    ```yaml
+    queues:
+      - payment # For neeto-payments-engine
+    ```
+
+### Development
+
+1. Add this line to your application's Gemfile (replace the path to the local
+   copy of neetoPayments' engine):
+
+   ```ruby
+   gem 'neeto-payments-engine', path: '../neeto-payments-engine'
+   ```
+
+2. And then execute:
+
+   ```shell
+   bundle install
+   ```
+
+3. Add this line to your application's `config/routes.rb` file (replace `at` to
+   your desired route):
+
+   ```ruby
+   mount NeetoPaymentsEngine::Engine, at: '/payments'
+   ```
+
+### Usage
+
+This engine can be used to integrate a payment gateway and to do payments to
+your application. Currently, the engine only supports the Stripe payment
+gateway.
 
-- [Development instructions](./docs/general/development-instructions.md)
-- [Building and releasing](./docs/general/building-and-releasing.md)
+1.  [Stripe Integration](./docs/stripe_integration.md)
+2.  [Stripe Payment](./docs/stripe_payment.md)