Update ENV sample and generalise env variable names (#50)

Author: ABizzinotto

README.md

@@ -19,12 +19,7 @@ Get Daily Puzzles delivered to your preferred server channel with a "Is it Ruby
 ```
 Check the .env.sample file for information on what environment variables you will need.
 
-# Run the server and bot
-
-Running the server (this is not necessary to run the bot):
-`bundle exec rails server`
--or-
-`bundle exec rails s`
+# Run the Discord bot
 
 Registering and re-registering the bot commands:
 `bundle exec rake discord:reset_commands`
@@ -37,3 +32,41 @@ Be aware that it is possible to start the bot multiple times at once, and this c
 This application is using `sidekiq` to run jobs.
 Running sidekiq:
 `bundle exec sidekiq -c 2 -q default`
+
+# Optional Functionality
+
+The Discord bot can run without the admin panel or Slackbot, those are optional features included with the project.
+
+## Admin Panel
+
+The admin panel allows you to manage puzzles and is set up with Google OAuth for authentication by default.
+
+To run the admin panel with google, you'll need to create a google oauth client to get the client ID and secret.
+
+Go to [Google Cloud Console](https://console.cloud.google.com/apis/credentials) and create a new OAuth 2.0 client ID.
+Set the redirect URI to `http://localhost:3000/auth/google_oauth2/callback` for local development.
+Copy the client ID and secret to your `.env` file as `GOOGLE_CLIENT_ID` and `GOOGLE_CLIENT_SECRET`.
+
+Run the Rails server:
+
+`bundle exec rails server`
+-or-
+`bundle exec rails s`
+
+## Slackbot
+
+The Slackbot supports a slash command to suggest new puzzles and notifications when running low on puzzles (less then 5 approved puzzles).
+
+To set up the Slackbot, you'll need to create a Slack app:
+
+1. Go to [Slack API](https://api.slack.com/apps) and create a new app.
+2. Add a slash command (e.g., `/suggest_puzzle`) and set the endpoint of the request URL to `/slack/new_puzzle`.
+3. Configure `Interactivity & Shortcuts` to point to the `/slack/puzzle` endpoint.
+4. Install the Slack app to your workspace and add the bot token and secret to the `.env` file as `SLACK_TOKEN` and `SLACK_SIGNING_SECRET`.
+5. To use the notifications feature, also set the `SLACK_NOTIFICATIONS_CHANNEL` in the `.env` file with the channel ID where you want to receive notifications.
+6. Optionally, you can also tag a specific Slack user group in the notification, just set the `SLACK_GROUP_ID` in the `.env` file with the group ID.
+
+Slack sends POST requests to the specified URLs, for local development, you can use a tool like [ngrok](https://ngrok.com/) to expose your local server to the internet.
+Use the ngrok URL as the request URL for the slash command and interactivity in your Slack app settings.
+
+The Slackbot will be ready to use once you have set up the Slack app and configured the environment variables. Make sure the Rails server is running.

app/controllers/sessions_controller.rb

@@ -3,11 +3,14 @@ def create
     auth = request.env["omniauth.auth"]
     user_email = auth.info.email
 
-    unless user_email.end_with?("@ombulabs.com")
-      reset_session
-      flash[:error] = "Access denied. Please access with your @ombulabs.com email address."
-      redirect_to root_path
-      return
+    domain_allowlist = ENV.fetch("DOMAIN_ALLOWLIST").split(",").map(&:strip)
+    if domain_allowlist.present?
+      unless domain_allowlist.any? { |domain| user_email.end_with?("@#{domain}") }
+        reset_session
+        flash[:error] = "Access denied. Please access with a valid email address."
+        redirect_to root_path
+        return
+      end
     end
 
     session[:user_token] = auth.credentials.token

app/controllers/slack/puzzles_controller.rb

@@ -12,7 +12,7 @@ def create
     if puzzle.save
       view = SlackClient::Views::Success.new.create
       notification_message = SlackClient::Messages::NewPuzzleNotification.new(puzzle).create
-      send_message(notification_message, channel_id: ENV.fetch("SHIELD_NOTIFICATIONS_CHANNEL", nil))
+      send_message(notification_message, channel_id: ENV.fetch("SLACK_NOTIFICATIONS_CHANNEL", nil))
     else
       view = SlackClient::Views::Failure.new.create
     end

app/lib/slack_client/messages/new_puzzle_notification.rb

@@ -1,9 +1,9 @@
 module SlackClient
   module Messages
     class NewPuzzleNotification
-      def initialize(puzzle, shield_group_id: ENV["SHIELD_GROUP_ID"])
+      def initialize(puzzle, slack_group_id: ENV["SLACK_GROUP_ID"])
         @puzzle = puzzle
-        @shield_group_id = shield_group_id
+        @slack_group_id = slack_group_id
       end
 
       def create
@@ -21,7 +21,7 @@ def create
 
       def body_text
         <<~TEXT
-          Hey <!subteam^#{@shield_group_id}>!
+          Hey <!subteam^#{@slack_group_id}>!
 
           <@#{@puzzle.suggested_by}> has submitted a new suggestion for a puzzle:
 

env.sample

@@ -1 +1,11 @@
-DISCORD_BOT_TOKEN=<insert bot token here>
+APP_URL=<admin panel app URL> # optional, only if using Slackbot functionality
+DISCORD_BOT_TOKEN=<insert bot token here>  # required
+DOMAIN_ALLOWLIST=<comma-separated list of allowed domains for google authentication>  # optional, only if using Google OAuth and wanting to restrict access to certain domains
+GOOGLE_CLIENT_ID=<google client id from google cloud oauth credentials>  # optional, required if using the admin panel with Google OAuth
+GOOGLE_CLIENT_SECRET=<google client secret from google cloud oauth credentials>  # optional, required if using the admin panel with Google OAuth
+RAILS_EMOJI_ID=<custom emoji id>  # optional, if not set, will fallback to a default emoji
+RUBY_EMOJI_ID=<custom emoji id>  # optional, if not set, will fallback to a default emoji
+SLACK_GROUP_ID=<slack group id>  # optional, only if using Slackbot notification functionality
+SLACK_NOTIFICATIONS_CHANNEL=<slack notifications channel id>  # optional, only if using Slackbot notification functionality
+SLACK_SIGNING_SECRET=<slack signing secret>  # optional, only if using Slackbot functionality
+SLACK_TOKEN=<slack signing secret>  # optional, only if using Slackbot functionality