@bigbinary/neeto-slack-frontend 2.2.2 → 2.2.4

package/README.md

@@ -1,17 +1,34 @@
-@bigbinary/neeto-slack-frontend
+# neeto-slack-nano
+
+[Engine and package installation](./docs/engine-and-package-installation.md)
+[Building and releasing](./docs/building-and-releasing.md)
+
+## Integrations
+
+| Projects     |     Integrated     |
+| ------------ | :----------------: |
+| neetoForm    | :white_check_mark: |
+| neetoChat    | :white_check_mark: |
+| neetoDesk    | :white_check_mark: |
+| neetoInvoice | :white_check_mark: |
+| neetoMonitor | :white_check_mark: |
+| neetoBugtrap | :white_check_mark: |
+| neetoCal     | :white_check_mark: |
+
+## @bigbinary/neeto-slack-frontend
 
 ![npm](https://img.shields.io/npm/v/@bigbinary/neeto-slack-frontend?color=greenyellow)
 ![npm](https://img.shields.io/npm/dw/@bigbinary/neeto-slack-frontend?color=greenyellow)
 
 UI for slack integration for all neeto products.
 
-## Installation
+### Installation
 
 ```bash
 yarn add @bigbinary/neeto-slack-frontend
 ```
 
-## Usage
+### Usage
 
 Available components:
 
@@ -20,9 +37,11 @@ Available components:
 - [Finish](./docs/finish/README.md)
 - [Settings](./docs/settings/README.md)
 
-View the [example app](./example/src/App.jsx) to see usage.
+Hook:
 
-## Development
+- [useFetchSlackIntegrationsStatus](./docs/useFetchSlackIntegrationsStatus/README.md)
+
+### Development
 
 Install all the dependencies by executing the following command
 
@@ -30,12 +49,7 @@ 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
+#### Using host application
 
 1. Clone this repository.
 2. Run `yarn install` to download the dependencies and setup the development
@@ -53,34 +67,180 @@ will run the example app using webpack.
    host if changes are not applied.
 8. Video explanation on how to use yalc: https://vimeo.com/722958162/9e931b640c
 
-# Building and releasing.
+## neetoSlackEngine
+
+To manage slack integration on neeto applications.
+
+### Installation
+
+1. Add this line to your application's Gemfile:
+
+   ```ruby
+   gem "neeto-slack-engine", git: 'https://github.com/bigbinary/neeto-slack-engine.git', branch: 'stable'
+   ```
+
+2. And then execute:
+
+   ```shell
+   bundle install
+   ```
 
-The `@bigbinary/neeto-slack-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.
+3. Install the migrations
+
+   \*\* Add a migration to add slack_chat_api_key to Organization of host app if
+   it doesn't exist already. Then run
+
+   ```ruby
+    # frozen_string_literal: true
 
-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-slack-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.
+    class AddSlackChatApiKeyToOrganization < ActiveRecord::Migration[7.0]
+      def change
+        add_column :organizations, :slack_chat_api_key, :string
+      end
+    end
+   ```
+
+   ```shell
+   bin/rails neeto_slack_engine:install:migrations
+   bin/rails db:migrate
+   ```
 
-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
+4. Configure model to add below association to the integrable class
+
+   ```ruby
+   has_one :slack_team, as: :integrable, class_name: "NeetoSlackEngine::SlackTeam", dependent: :destroy
+   ```
+
+5. Configure the following Environment Variables and secrets with suitable
+   values
 
-# Product integrations
+   Under .env
 
-| Projects     |   SlackFrontend    |
-| ------------ | :----------------: |
-| neetoChat    | :white_check_mark: |
-| neetoDesk    | :white_check_mark: |
-| neetoForm    | :white_check_mark: |
-| neetoInvoice | :white_check_mark: |
-| neetoBugtrap | :white_check_mark: |
+   ```yaml
+   SLACK_CLIENT_ID=#Value from Slack App console at
+   https://api.slack.com/apps/APP_ID/general SLACK_CLIENT_SECRET=#Value from
+   Slack App console at https://api.slack.com/apps/APP_ID/general
+   SLACK_CLIENT_SIGNING_SECRET=#Value from Slack App console at
+   https://api.slack.com/apps/APP_ID/general ATTR_ENCRYPTION_KEY=#Random varying
+   char. key with min. 32 chars. SLACK_REDIRECT_PATH=#Path controller if
+   Callbacks controller of application is to be used instead of Engine's
+   SLACK_HOST_URL=#Host url if different than application host url or in
+   development for use of Ngrok
+   ```
+
+   Under secrets.yml
+
+   ```yaml
+   application_name: #Application name
+   attr_encrypted:
+     encryption_key: <%= ENV['ATTR_ENCRYPTION_KEY'] %>
+   slack:
+     client_id: "<%= ENV['SLACK_CLIENT_ID'] %>"
+     client_secret: <%= ENV['SLACK_CLIENT_SECRET'] %>
+     client_signing_secret: <%= ENV['SLACK_CLIENT_SIGNING_SECRET'] %>
+   ```
+
+6. Add this line to your application's `config/routes.rb` file (replace `at` to
+   your desired route):
+
+   ```ruby
+   mount NeetoSlackEngine::Engine, at: '/integrations-slack'
+   ```
+
+7. Slack Integration supports customizing scopes required for host app on usage
+   basis, for adding/removing the scope file with name `neeto_slack_engine.yml`
+   can be added under host app `config` directory. In case the file is not
+   present the Engine fallbacks to set of default scopes defined under Engine
+   config. File scope structure
+   ```yml
+    scopes:
+      v1:
+        bot:
+        ...
+        user:
+        ...
+      v2:
+        bot:
+        ...
+        user:
+        ...
+   ```
+   Ref. -
+   https://github.com/bigbinary/neeto-slack-engine/blob/e229fec17fd1b7e8596ca1ca55bd2926133fb88f/test/dummy/config/neeto_slack_engine.yml
+
+### Development
+
+1. Add this line to your application's Gemfile (replace the path to the local
+   copy of neetoIntegrationsSlack's engine):
+
+   ```ruby
+   gem 'neeto-slack-engine', path: '../neeto-slack-nano'
+   ```
+
+2. And then execute:
+
+   ```shell
+   bundle install
+   ```
+
+3. Install the migrations
+
+   \*\* Additional migration to add Slack Chat API key to Organization of host
+   app.
+
+   ```ruby
+    # frozen_string_literal: true
+
+    class AddSlackChatApiKeyToOrganization < ActiveRecord::Migration[7.0]
+      def change
+        add_column :organizations, :slack_chat_api_key, :string
+      end
+    end
+   ```
+
+   ```shell
+   bin/rails neeto_integrations_slack_engine:install:migrations
+   bin/rails db:migrate
+   ```
+
+4. Configure model to add below association to the integrable class
+
+   ```ruby
+   has_one :slack_team, as: :integrable, class_name: "NeetoSlackEngine::SlackTeam", dependent: :destroy
+   ```
+
+5. Configure the following Environment Variables and secrets with suitable
+   values
+
+   Under `.env.development` or `.env` in application
+
+   ```yaml
+   SLACK_CLIENT_ID=#Value from Slack App console at
+   https://api.slack.com/apps/APP_ID/general SLACK_CLIENT_SECRET=#Value from
+   Slack App console at https://api.slack.com/apps/APP_ID/general
+   SLACK_CLIENT_SIGNING_SECRET=#Value from Slack App console at
+   https://api.slack.com/apps/APP_ID/general ATTR_ENCRYPTION_KEY=#Random varying
+   char. key with min. 32 chars. SLACK_REDIRECT_PATH=#Path controller if
+   Callbacks controller of application is to be used instead of Engine's
+   SLACK_HOST_URL=#Host url if different than application host url or in
+   development for use of Ngrok INTEGRATIONS_SLACK_ENGINE_DEVELOPMENT=true
+   ```
+
+   Under secrets.yml
+
+   ```yaml
+   application_name: #Application name
+   attr_encrypted:
+     encryption_key: <%= ENV['ATTR_ENCRYPTION_KEY'] %>
+   slack:
+     client_id: "<%= ENV['SLACK_CLIENT_ID'] %>"
+     client_secret: <%= ENV['SLACK_CLIENT_SECRET'] %>
+     client_signing_secret: <%= ENV['SLACK_CLIENT_SIGNING_SECRET'] %>
+   ```
+
+6. Add this line to your application's `config/routes.rb` file (replace `at` to
+   your desired route):
+
+   ```ruby
+   mount NeetoSlackEngine::Engine, at: '/integrations-slack'
+   ```

package/app/javascript/src/translations/en.json

@@ -0,0 +1,38 @@
+{
+  "neetoSlack": {
+    "common": {
+      "continue": "Continue",
+      "save": "Save",
+      "edit": "Edit",
+      "done": "Done",
+      "required": "{{entity}} is required"
+    },
+    "slack": {
+      "placeholder": "Notification Channel",
+      "channelName": "Channel Name",
+      "editPane": "Edit slack integration",
+      "channelListRefreshToastr": "Slack channels list is updated",
+      "channelListRefreshButton": "Refresh channels list",
+      "steps": {
+        "finish": "Finish"
+      },
+      "connect": {
+        "title": "Connect your Slack account",
+        "description": "There’s no linked Slack account yet",
+        "loginButton": "Login to Slack"
+      },
+      "configure": {
+        "title": "You are connecting to <a><strong>{{teamName}}</strong></a> workspace.",
+        "sendTo": "Send to",
+        "sendToDescription": "Choose a Slack channel that will receive notifications",
+        "refreshSlackChannelList": "Refresh Slack channel list"
+      },
+      "finish": {
+        "title": "You are successfully connected to the <strong>{{teamName}}</strong> workspace."
+      },
+      "settings": {
+        "title": "You are connected to <a><strong>{{teamName}}</strong></a> workspace."
+      }
+    }
+  }
+}

package/app/javascript/src/translations/index.js

@@ -0,0 +1 @@
+export { default as en } from "./en.json";