@bigbinary/neeto-integrations-frontend 2.9.0 → 2.10.1

package/README.md

@@ -1,19 +1,22 @@
-@bigbinary/neeto-integrations-frontend
+# neeto-integrations-nano
+
+1. [Engine and package installation](./docs/engine-and-package-installation.md)
+2. [Building and releasing](./docs/building-and-releasing.md)
+
+## @bigbinary/neeto-integrations-frontend
 
 ![npm](https://img.shields.io/npm/v/@bigbinary/neeto-integrations-frontend?color=greenyellow)
 ![npm](https://img.shields.io/npm/dw/@bigbinary/neeto-integrations-frontend?color=greenyellow)
 
 UI for integrations for all neeto products.
 
-## Installation
+### Installation
 
 ```bash
 yarn add @bigbinary/neeto-integrations-frontend
 ```
 
-## Usage
-
-Available components:
+### Usage
 
 Available components:
 
@@ -21,10 +24,9 @@ Available components:
 - [Finish](./docs/finish/README.md)
 - [Demo](./docs/demo/README.md)
 - [DisconnectAlert](./docs/DisconnectAlert/README.md)
+- [GoogleCalendar](./docs/GoogleCalendar/README.md)
 
-View the [example app](./example/src/App.jsx) to see usage.
-
-## Development
+### Development
 
 Install all the dependencies by executing the following command
 
@@ -32,11 +34,6 @@ Install all the dependencies by executing the following command
 yarn install
 ```
 
-### Using example app
-
-Start the development server using the `yarn start` command. Development server
-will run the example app using webpack.
-
 ### Using host application
 
 1. Clone this repository.
@@ -55,12 +52,12 @@ will run the example app using webpack.
    webpack-dev-server in host if changes are not applied.
 8. Video explanation on how to use yalc: https://vimeo.com/722958162/9e931b640c
 
-## Exports and Types
+### Exports and Types
 
 The **neeto-integrations-frontend** JavaScript library offers two types of
 exports: the common bundle and the per-component bundle.
 
-### Common Bundle
+#### Common Bundle
 
 The common bundle includes components such as `Card`, `Modal`, and `Connect`.
 You can import them using the following syntax:
@@ -77,7 +74,7 @@ To add a component to the common bundle, follow these steps:
 3. Export the component in the `index.js` file located in the library's root
    directory
 
-### Per-Component Bundle
+#### Per-Component Bundle
 
 Each component inside the `components/Integrations` folder has its own bundle.
 For example, the `ZapierForm` component can be imported using the following
@@ -92,28 +89,6 @@ To export a component as its own bundle, follow these steps:
 1. Place the component strictly inside the `components/Integrations` folder.
 2. Add the necessary types for the component in the `types` folder.
 
-## Building and releasing.
-
-The `@bigbinary/neeto-integrations-frontend` package gets published to NPM when
-we merge a PR with `patch`, `minor` or `major` label to the `main` branch. The
-`patch` label is used for bug fixes, `minor` label is used for new features and
-`major` label is used for breaking changes. You can checkout the
-`Create and publish releases` workflow in GitHub Actions to get a live update.
-
-In case if you missed to add the label, you can manually publish the package.
-For that first you need to create a PR to update the version number in the
-`package.json` file and merge it to the `main` branch. After merging the PR, you
-need to create a
-[new github release](https://github.com/bigbinary/neeto-integrations-frontend/releases/new)
-from main branch. Whenever a new release is created with a new version number,
-the github actions will automatically publish the built package to npm. You can
-checkout the `Publish to npm` workflow in GitHub Actions to get a live update.
-
-Please note that before publishing the package, you need to verify the
-functionality in some of the neeto web-apps locally using `yalc` package
-manager. The usage of yalc is explained in this video:
-https://youtu.be/QBiYGP0Rhe0
-
 # Product integrations
 
 | Projects     | IntegrationsFrontend |
@@ -122,6 +97,166 @@ https://youtu.be/QBiYGP0Rhe0
 | neetoDesk    |  :white_check_mark:  |
 | neetoForm    |  :white_check_mark:  |
 | neetoInvoice |  :white_check_mark:  |
-| neetoBugtrap |  :white_check_mark:  |
+| neetoKB      |  :white_check_mark:  |
 | neetoMonitor |  :white_check_mark:  |
 | neetoCal     |  :white_check_mark:  |
+
+## neeto-integrations-engine
+
+This engine handles the authentication and token management for integrations
+with the following providers.
+
+- Meta ( Facebook, Instagram, WhatsApp )
+- Google ( Analytics, YouTube )
+- Microsoft ( MS Teams)
+- Zapier
+- Twilio
+
+Host can provide required permissions for a supported third party integration,
+then engine will handle the authentication, token expiry for the host. Tokens
+and account details are stored in a table handled by the engine.
+
+This engine also webhook support and post Integration Video walkthrough support
+for MS Teams, Facebook Pages, and WhatsApp Integration.
+
+### Usage
+
+1. Add the gem to your `Gemfile`.
+
+```ruby
+source "https://O6Ts9-SVDaUZpHMRs2CpJp22RwbETDE@gems.neeto.com" do
+  gem "neeto-integrations-engine"
+end
+```
+
+2. Run `bundle install`
+
+3. Add the required env variables to `.env.development` and update your
+   `secrets.yml`. Refer [here](./docs/setup.md) for more details on specific
+   integrations.
+
+4. Import migrations to your project:
+
+```bash
+bundle exec rails neeto_integrations_engine:install:migrations
+```
+
+5. Add the migrations to the database:
+
+```bash
+bundle exec rails db:migrate
+```
+
+6. Add the Integrations List required to `config/neeto_integrations.yml`. Also,
+   add the required integration(not natively supported by engine) as
+   `other_applications` for post Integration UI support.
+
+```yml
+applications:
+  - title: "Instagram Chat"
+    service_name: Instagram
+    provider: Facebook
+    service_type: Social
+    scope:
+      - email
+      - public_profile
+      - pages_show_list
+      - instagram_manage_messages
+      - instagram_basic
+other_applications:
+  - title: "neetoDesk"
+    service_name: neetoDesk
+    service_type: Support
+    provider: neeto
+```
+
+Refer the [here](./docs/setup.md) for list of supported `provider`,
+`service_name` and `service_type`.
+
+7. Import data migration to update the integrations list with the newly added
+   integration from `config/neeto_integrations.yml`:
+
+```bash
+bundle exec rails generate neeto_integrations_engine:integrations_list:update
+```
+
+Or manually execute the following command in all the environments to update the
+integrations list. Although the above approach is recommended.
+
+```bash
+bundle exec rails neeto_integrations_engine:integrations_list:update
+```
+
+8. Mount Neeto Integrations to your `routes.rb`:
+
+```ruby
+mount NeetoIntegrationsEngine::Engine => "/neeto_integrations"
+```
+
+9. Add association to `User` model:
+
+```ruby
+has_many :auth_requests, class_name: "NeetoIntegrationsEngine::AuthRequest", dependent: :destroy
+```
+
+10. Add association to `Organization` model:
+
+```ruby
+has_many :integrated_apps, class_name: "NeetoIntegrationsEngine::IntegratedApp", dependent: :destroy
+```
+
+11. If you want your integration to be specific to other model like `User`,
+    `Form` , etc, add association as:
+
+```ruby
+has_many :integrated_apps, as: :integrable, class_name: "NeetoIntegrationsEngine::IntegratedApp", dependent: :destroy
+```
+
+### Endpoints
+
+|                 Endpoint                  |                       Usage                        |
+| :---------------------------------------: | :------------------------------------------------: |
+|      `/neeto_integrations/auth/url`       |      For generating oauth URL for integration      |
+|      `/neeto_integrations/settings`       |   For getting integrated_app and setting details   |
+|     `/neeto_integrations/disconnect`      |        For disconnecting an integrated_app         |
+|       `/neeto_integrations/status`        | For getting demoShown status for an integrated_app |
+|   `/neeto_integrations/zapier/api-keys`   |     For creating and destroying Zapier API key     |
+| `/neeto_integrations/zapier/subscription` |  For creating and destroying Zapier Subscription   |
+
+⚠️ **Note**: By default, the `integrable` is the current `organization`. You
+should add `integrableType` and `integrableId` in the payload, to fetch the
+integrated_app properly.
+
+### Errors
+
+#### Response format
+
+- `status`: failure
+- `state`: Any state that was passed during Auth
+- `error`: Contains the error `message` and `code`
+
+#### Errors list
+
+|             Error              |                               Description                               |
+| :----------------------------: | :---------------------------------------------------------------------: |
+|       `AuthRequestError`       |             When an invalid `AuthRequest` ID has been given             |
+|     `InvalidServiceError`      |       When an unsupported `service_name` is provided for seeding        |
+|     `InvalidProviderError`     |        When an unsupported `provider` name is given for seeding         |
+|  `InvalidCallbackParamsError`  |          When the `params` received during callback is invalid          |
+| `InsufficientPermissionsError` |             When the user denies any permissions requested              |
+|     `InvalidRequestError`      |         When an invalid request is created in RequestDispatcher         |
+|   `InvalidRefreshTokenError`   |      When the invalid refresh token is given for refreshing token       |
+|          `TokenError`          |         When an error has occurred while fetching token details         |
+|  `MissingImplementationError`  | When a service has been inherited but the method(s) are not implemented |
+|  `TokenDebuggerServiceError`   |        When an error has occurred while fetching `token details`        |
+|  `AccountDetailsServiceError`  |       When an error has occurred while fetching `account details`       |
+|          `OauthError`          |               When an error occurred in the Oauth process               |
+
+## neeto products currently using this engine
+
+|  Products   |                   Integrated (Used in production)                    | Integration (Currently in development/staging) |
+| :---------: | :------------------------------------------------------------------: | :--------------------------------------------: |
+|  neetoChat  |                                 :x:                                  | Instagram, WhatsApp, Twilio, Zapier, MS Teams  |
+| neetoSocial | Instagram(page), Facebook(page), Google(Analytics, YouTube), Twitter |                      :x:                       |
+|  neetoCal   |                               MS Teams                               |                      :x:                       |
+|  neetoForm  |                                 :x:                                  |                    MS Teams                    |

package/{src → app/javascript/src}/translations/en.json

@@ -101,6 +101,19 @@
         "title": "Disconnect Zoom integration?",
         "message": "This action will disconnect Zoom integration."
       }
+    },
+    "google": {
+      "connect": {
+        "title": "Connect your Google account",
+        "signIn": "Sign in with Google",
+        "reminderToAcceptPermissions": "When connecting to  your Google Account, please make sure to <strong>select the checkbox</strong> that grants app access to your Google Calendar after clicking the 'Sign in with Google' button. This checkbox can be found in the permission request screen as shown in the picture below.",
+        "selectCheckbox": "select the checkbox"
+      },
+      "finish": {
+        "title": "Google account is successfully integrated to neetoCal"
+      },
+      "calendar": "Google calendar",
+      "statusForbidden": "An unknown error occurred in your google integration, please reconnect."
     }
   }
 }