grape-slack-bot 1.0.0

data/spec/slack_bot/api_client_spec.rb

@@ -0,0 +1,479 @@
+require 'spec_helper'
+
+describe SlackBot::ApiClient do
+  subject(:client) { described_class.new(authorization_token: authorization_token) }
+  let(:authorization_token) { "test_authorization_token" }
+
+  it "does not raise errors" do
+    expect { client }.not_to raise_error
+  end
+
+  context "when the authorization token is not set" do
+    let(:authorization_token) { nil }
+    it "raises an error" do
+      expect { client }.to raise_error("Slack bot API token is not set")
+    end
+  end
+
+  describe "#users_info" do
+    before do
+      stub_request(:post, "https://slack.com/api/users.info").to_return(response)
+    end
+    subject(:users_info) { client.users_info(user_id: user_id) }
+    let(:user_id) { "U0R7JM" }
+    let(:response) {
+      {
+        status: 200,
+        body: {
+          "ok" => true,
+          "user" => {
+            "id" => "W012A3CDE",
+            "team_id" => "T012AB3C4",
+            "name" => "spengler",
+            "deleted" => false,
+            "color" => "9f69e7",
+            "real_name" => "Egon Spengler",
+            "tz" => "America/Los_Angeles",
+            "tz_label" => "Pacific Daylight Time",
+            "tz_offset" => -25200,
+            "profile" => {
+              "avatar_hash" => "ge3b51ca72de",
+              "status_text" => "Print is dead",
+              "status_emoji" => ":books:",
+              "real_name" => "Egon Spengler",
+              "display_name" => "spengler",
+              "real_name_normalized" => "Egon Spengler",
+              "display_name_normalized" => "spengler",
+              "email" => "spengler@ghostbusters.example.com",
+              "image_original" => "https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg",
+              "image_24" => "https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg",
+              "image_32" => "https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg",
+              "image_48" => "https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg",
+              "image_72" => "https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg",
+              "image_192" => "https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg",
+              "image_512" => "https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg",
+              "team" => "T012AB3C4"
+            },
+            "is_admin" => true,
+            "is_owner" => false,
+            "is_primary_owner" => false,
+            "is_restricted" => false,
+            "is_ultra_restricted" => false,
+            "is_bot" => false,
+            "updated" => 1502138686,
+            "is_app_user" => false,
+            "has_2fa" => false
+          }
+        }.to_json
+      }
+    }
+    it "sends authorization token" do
+      expect(users_info.response.env.request_headers["Authorization"]).to eq("Bearer #{authorization_token}")
+    end
+    it "returns a successful response" do
+      expect(users_info.ok?).to eq(true)
+    end
+    context "when the response is not successful" do
+      let(:response) {
+        {
+          status: 200,
+          body: {
+            "ok" => false,
+            "error" => "user_not_found"
+          }.to_json
+        }
+      }
+      it "returns an unsuccessful response" do
+        expect(users_info.ok?).to eq(false)
+      end
+    end
+  end
+
+  describe "#views_open" do
+    before do
+      stub_request(:post, "https://slack.com/api/views.open").to_return(response)
+    end
+    subject(:views_open) {
+      client.views_open(
+        trigger_id: "trigger_id",
+        view: {
+          "type" => "modal",
+          "title" => {
+            "type" => "plain_text",
+            "text" => "Quite a plain modal"
+          },
+          "submit" => {
+            "type" => "plain_text",
+            "text" => "Create"
+          },
+          "blocks" => [
+            {
+              "type" => "input",
+              "block_id" => "a_block_id",
+              "label" => [
+                "type" => "plain_text",
+                "text" => "A simple label",
+                "emoji" => true
+              ],
+              "optional" => false,
+              "element" => {
+                "type" => "plain_text_input",
+                "action_id" => "an_action_id"
+              }
+            }
+          ],
+        }
+      )
+    }
+    let(:response) {
+      {
+        status: 200,
+        body: {
+          "ok" => true,
+          "view" => {
+            "id" => "VMHU10V25",
+            "team_id" => "T8N4K1JN",
+            "type" => "modal",
+            "title" => {
+              "type" => "plain_text",
+              "text" => "Quite a plain modal"
+            },
+            "submit" => {
+              "type" => "plain_text",
+              "text" => "Create"
+            },
+            "blocks" => [
+              {
+                "type" => "input",
+                "block_id" => "a_block_id",
+                "label" => {
+                  "type" => "plain_text",
+                  "text" => "A simple label",
+                  "emoji" => true
+                },
+                "optional" => false,
+                "element" => {
+                  "type" => "plain_text_input",
+                  "action_id" => "an_action_id"
+                }
+              }
+            ],
+            "private_metadata" => "Shh it is a secret",
+            "callback_id" => "identify_your_modals",
+            "external_id" => "",
+            "state" => {
+              "values" => {}
+            },
+            "hash" => "156772938.1827394",
+            "clear_on_close" => false,
+            "notify_on_close" => false,
+            "root_view_id" => "VMHU10V25",
+            "app_id" => "AA4928AQ",
+            "bot_id" => "BA13894H"
+          }
+        }.to_json
+      }
+    }
+    it "returns a successful response" do
+      expect(views_open.ok?).to eq(true)
+    end
+
+    context "when the response is unsuccessful" do
+      let(:response) {
+        {
+          status: 200,
+          body: {
+            "ok" => false,
+            "error" => "invalid_arguments",
+            "response_metadata" => {
+              "messages" => [
+                "invalid `trigger_id`"
+              ]
+            }
+          }.to_json
+        }
+      }
+      it "returns an unsuccessful response" do
+        expect(views_open.ok?).to eq(false)
+      end
+    end
+  end
+
+  describe "#views_update" do
+    before do
+      stub_request(:post, "https://slack.com/api/views.update").to_return(response)
+    end
+    subject(:views_update) {
+      client.views_update(
+        view_id: "VMHU10V25",
+        view: {
+          "type" => "modal",
+          "title" => {
+            "type" => "plain_text",
+            "text" => "Quite a plain modal"
+          },
+          "submit" => {
+            "type" => "plain_text",
+            "text" => "Create"
+          },
+          "blocks" => [
+            {
+              "type" => "input",
+              "block_id" => "a_block_id",
+              "label" => [
+                "type" => "plain_text",
+                "text" => "A simple label",
+                "emoji" => true
+              ],
+              "optional" => false,
+              "element" => {
+                "type" => "plain_text_input",
+                "action_id" => "an_action_id"
+              }
+            }
+          ],
+        }
+      )
+    }
+    let(:response) {
+      {
+        status: 200,
+        body: {
+          "ok" => true,
+          "view" => {
+            "id" => "VMHU10V25",
+            "team_id" => "T8N4K1JN",
+            "type" => "modal",
+            "title" => {
+              "type" => "plain_text",
+              "text" => "Quite a plain modal"
+            },
+            "submit" => {
+              "type" => "plain_text",
+              "text" => "Create"
+            },
+            "blocks" => [
+              {
+                "type" => "input",
+                "block_id" => "a_block_id",
+                "label" => {
+                  "type" => "plain_text",
+                  "text" => "A simple label",
+                  "emoji" => true
+                },
+                "optional" => false,
+                "element" => {
+                  "type" => "plain_text_input",
+                  "action_id" => "an_action_id"
+                }
+              }
+            ],
+            "private_metadata" => "Shh it is a secret",
+            "callback_id" => "identify_your_modals",
+            "external_id" => "",
+            "state" => {
+              "values" => {}
+            },
+            "hash" => "156772938.1827394",
+            "clear_on_close" => false,
+            "notify_on_close" => false,
+            "root_view_id" => "VMHU10V25",
+            "app_id" => "AA4928AQ",
+            "bot_id" => "BA13894H"
+          }
+        }.to_json
+      }
+    }
+    it "returns a successful response" do
+      expect(views_update.ok?).to eq(true)
+    end
+    context "when the response is unsuccessful" do
+      let(:response) {
+        {
+          status: 200,
+          body: {
+            "ok" => false,
+            "error" => "invalid_arguments",
+            "response_metadata" => {
+              "messages" => [
+                "invalid `trigger_id`"
+              ]
+            }
+          }.to_json
+        }
+      }
+      it "returns an unsuccessful response" do
+        expect(views_update.ok?).to eq(false)
+      end
+    end
+  end
+
+  describe "#chat_post_message" do
+    before do
+      stub_request(:post, "https://slack.com/api/chat.postMessage").to_return(response)
+    end
+    subject(:chat_post_message) {
+      client.chat_post_message(
+        channel: "C1234567890",
+        text: "Hello world",
+        blocks: [
+          {
+            "type" => "section",
+            "text" => {
+              "type" => "mrkdwn",
+              "text" => "Hello world"
+            }
+          }
+        ]
+      )
+    }
+    let(:response) {
+      {
+        status: 200,
+        body: {
+          "ok" => true,
+          "channel" => "C1234567890",
+          "ts" => "1503435956.000247",
+          "message" => {
+            "text" => "Hello world",
+            "username" => "ecto1",
+            "bot_id" => "B19LU7CSY",
+            "attachments" => [
+              {
+                "text" => "This is an attachment",
+                "id" => 1,
+                "fallback" => "This is an attachment's fallback"
+              }
+            ],
+            "type" => "message",
+            "subtype" => "bot_message",
+            "ts" => "1503435956.000247"
+          }
+        }.to_json
+      }
+    }
+    it "returns a successful response" do
+      expect(chat_post_message.ok?).to eq(true)
+    end
+    context "when the response is unsuccessful" do
+      let(:response) {
+        {
+          status: 200,
+          body: {
+            "ok" => false,
+            "error" => "too_many_attachments"
+          }.to_json
+        }
+      }
+      it "returns an unsuccessful response" do
+        expect(chat_post_message.ok?).to eq(false)
+      end
+    end
+  end
+
+  describe "#chat_update" do
+    before do
+      stub_request(:post, "https://slack.com/api/chat.update").to_return(response)
+    end
+    subject(:chat_update) {
+      client.chat_update(
+        channel: "C1234567890",
+        ts: "1503435956.000247",
+        text: "Hello world",
+        blocks: [
+          {
+            "type" => "section",
+            "text" => {
+              "type" => "mrkdwn",
+              "text" => "Hello world"
+            }
+          }
+        ]
+      )
+    }
+    let(:response) {
+      {
+        status: 200,
+        body: {
+          "ok" => true,
+          "channel" => "C1234567890",
+          "ts" => "1503435956.000247",
+          "message" => {
+            "text" => "Hello world",
+            "username" => "ecto1",
+            "bot_id" => "B19LU7CSY",
+            "attachments" => [
+              {
+                "text" => "This is an attachment",
+                "id" => 1,
+                "fallback" => "This is an attachment's fallback"
+              }
+            ],
+            "type" => "message",
+            "subtype" => "bot_message",
+            "ts" => "1503435956.000247"
+          }
+        }.to_json
+      }
+    }
+    it "returns a successful response" do
+      expect(chat_update.ok?).to eq(true)
+    end
+    context "when the response is unsuccessful" do
+      let(:response) {
+        {
+          status: 200,
+          body: {
+            "ok" => false,
+            "error" => "too_many_attachments"
+          }.to_json
+        }
+      }
+      it "returns an unsuccessful response" do
+        expect(chat_update.ok?).to eq(false)
+      end
+    end
+  end
+
+  describe "#views_publish" do
+    before do
+      stub_request(:post, "https://slack.com/api/views.publish").to_return(response)
+    end
+    subject(:views_publish) {
+      client.views_publish(
+        user_id: "U0R7JM",
+        view: {
+          "type" => "home",
+          "blocks" => [
+            {
+              "type" => "section",
+              "text" => {
+                "type" => "mrkdwn",
+                "text" => "Welcome to your _App's Home_* :tada:"
+              }
+            },
+            {
+              "type" => "divider"
+            },
+            {
+              "type" => "section",
+              "text" => {
+                "type" => "mrkdwn",
+                "text" => "This is a section block with a button."
+              },
+              "accessory" => {
+                "type" => "button",
+                "text" => {
+                  "type" => "plain_text",
+                  "text" => "Click Me"
+                },
+                "action_id" => "button_click"
+              }
+            }
+          ]
+        }
+      )
+    }
+    # TODO: Add a test for the response
+  end
+end

data/spec/slack_bot/args_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+
+describe SlackBot::Args do
+  let(:args) { SlackBot::Args.new }
+  let(:raw_args) { "foo=bar&baz=qux" }
+
+  describe "#raw_args=" do
+    it "parses raw args" do
+      args.raw_args = raw_args
+      expect(args.args).to eq({ "foo" => "bar", "baz" => "qux" }.with_indifferent_access)
+    end
+  end
+
+  describe "#to_s" do
+    it "builds args" do
+      args.raw_args = raw_args
+      expect(args.to_s).to eq(raw_args)
+    end
+  end
+
+  describe "#merge" do
+    it "merges args" do
+      args.raw_args = raw_args
+      expect(args.merge(foo: "baz").args).to eq({ "foo" => "baz", "baz" => "qux" }.with_indifferent_access)
+    end
+  end
+
+  describe "#except" do
+    it "removes args" do
+      args.raw_args = raw_args
+      expect(args.except(:foo).args).to eq({ "baz" => "qux" }.with_indifferent_access)
+    end
+  end
+end

data/spec/slack_bot/callback_spec.rb

@@ -0,0 +1,104 @@
+require 'spec_helper'
+
+describe SlackBot::Callback do
+  subject(:callback) {
+    described_class.new(
+      class_name: "Test",
+      method_name: "test",
+      user: user,
+      channel_id: "test_channel_id",
+      extra: { test: "test" },
+      config: config
+    )
+  }
+
+  let(:config) {
+    instance_double(
+      SlackBot::Config,
+      callback_storage_instance: callback_storage_instance,
+      callback_user_finder_method: callback_user_finder_method
+    )
+  }
+  let(:callback_storage_instance) { instance_double(SlackBot::CallbackStorage) }
+  let(:callback_user_finder_method) { ->(user_id) { user } }
+
+  let(:user) { double(:user, id: 1) }
+
+  let(:callback_id) { "test_callback_id" }
+
+  describe ".find" do
+    subject(:find) { described_class.find(callback_id, config: config) }
+
+    before do
+      allow(callback_storage_instance).to receive(:read).with("slack-bot-callback:test_callback_id").and_return(data)
+    end
+
+    context "when callback is found" do
+      let(:data) { { class_name: "Test", method_name: "test", user_id: 1, channel_id: "test_channel_id", extra: { test: "test" } } }
+
+      it "returns callback" do
+        expect(find).to be_a(described_class)
+        expect(find.id).to eq(callback_id)
+        expect(find.class_name).to eq("Test")
+        expect(find.user).to eq(user)
+        expect(find.user_id).to eq(1)
+        expect(find.channel_id).to eq("test_channel_id")
+        expect(find.method_name).to eq("test")
+        expect(find.extra).to eq({ test: "test" })
+      end
+    end
+  end
+
+  describe ".create" do
+    subject(:create) { described_class.create(class_name: "Test", method_name: "test", user: user, channel_id: "test_channel_id", config: config) }
+
+    before do
+      allow_any_instance_of(described_class).to receive(:generate_id).and_return("test_callback_id")
+      allow(callback_storage_instance).to receive(:write).with("slack-bot-callback:test_callback_id", {
+        args: "",
+        class_name: "Test",
+        method_name: "test",
+        user_id: 1,
+        channel_id: "test_channel_id",
+        extra: nil
+      }, expires_in: 1.hour)
+    end
+
+    let(:data) { { class_name: "Test", method_name: "test", user_id: 1, channel_id: "test_channel_id", extra: nil } }
+
+    it "returns callback" do
+      expect(create).to be_a(described_class)
+      expect(create.id).to eq("test_callback_id")
+      expect(create.class_name).to eq("Test")
+      expect(create.user).to eq(user)
+      expect(create.user_id).to eq(1)
+      expect(create.channel_id).to eq("test_channel_id")
+      expect(create.method_name).to eq("test")
+      expect(create.extra).to eq(nil)
+    end
+  end
+
+  describe "#reload" do
+
+  end
+
+  describe "#save" do
+
+  end
+
+  describe "#update" do
+
+  end
+
+  describe "#destroy" do
+
+  end
+
+  describe "#user" do
+
+  end
+
+  describe "#handler_class" do
+
+  end
+end

data/spec/slack_bot/command_spec.rb

@@ -0,0 +1,5 @@
+require 'spec_helper'
+
+describe SlackBot::Command do
+
+end

data/spec/slack_bot/config_spec.rb

@@ -0,0 +1,57 @@
+require 'spec_helper'
+
+describe SlackBot::Config do
+  subject(:config) { described_class.new }
+
+  describe ".configure" do
+
+  end
+
+  describe ".current_instance" do
+
+  end
+
+  describe "#callback_storage" do
+
+  end
+
+  describe "#callback_user_finder" do
+
+  end
+
+  describe "#event" do
+
+  end
+
+  describe "#slash_command_endpoint" do
+
+  end
+
+  describe "#menu_options" do
+
+  end
+
+  describe "#handler_class" do
+
+  end
+
+  describe "#find_event_handler" do
+
+  end
+
+  describe "#find_slash_command_config" do
+
+  end
+
+  describe "#find_menu_options" do
+
+  end
+
+  describe "#find_handler_class" do
+
+  end
+
+  describe "#find_command_config" do
+
+  end
+end

data/spec/slack_bot/event_spec.rb

@@ -0,0 +1,5 @@
+require 'spec_helper'
+
+describe SlackBot::Event do
+
+end

data/spec/slack_bot/grape_extension_spec.rb

@@ -0,0 +1,5 @@
+require 'spec_helper'
+
+describe SlackBot::GrapeExtension do
+
+end

data/spec/slack_bot/interaction_spec.rb

@@ -0,0 +1,5 @@
+require 'spec_helper'
+
+describe SlackBot::Interaction do
+
+end