grape-slack-bot 1.6.10 → 1.6.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 182ee366d5e5d1fb89152bcd753a75e4361b8f611fa1d9ca0a4b81dc5f6221ab
-  data.tar.gz: 49f18848a1abef7bf401eb3af87a2037ba25850d0a9043428a4f44cba6bd2371
+  metadata.gz: e747b1927fe6e5c4daefb40830a338271b003a964dc857e4e85c0f06c0e72723
+  data.tar.gz: 1d06b0374106aa8dad4c9a9f46e5173a0c3bfe6785ba80f5d7da2429a6057f91
 SHA512:
-  metadata.gz: 8379e1b62eb08f3dcf9507dffa299ac07d4c4753ac544e502ecef8f28107f7166df66c8f2783a338e58cd1a41f8f5702678650ac19aad100c597300097bb330e
-  data.tar.gz: 7ee9589a200c7c105948df9751878ebf231430b3aa6313cfc86533de254e0340e01205e2d339810741fe7c2411c368083a1924511280671de63cb9be2d87f0ca
+  metadata.gz: 0c852fd5c5cb8bf2692b774d42c0fe2e7e074eb138df04ed9b44e34fcaf90d8db281a2cbe17e6fe80dc49c937984f70e36fad8e70b962be1c5eb6c99859e4e4c
+  data.tar.gz: 3fb00ab57011e5b5573970e4e36907482ca0020ec0a2186b6c9db6662097b41614e8d091b493ea843263b8af61fecd5ff6664473b2391619576b1e471bc60818

data/README.md

@@ -1,6 +1,6 @@
 # grape-slack-bot.rb
 
-[![Gem Version](https://badge.fury.io/rb/grape-slack-bot.svg)](https://badge.fury.io/rb/grape-slack-bot) [![Test Status](https://github.com/amkisko/grape-slack-bot.rb/actions/workflows/test.yml/badge.svg)](https://github.com/amkisko/grape-slack-bot.rb/actions/workflows/test.yml)
+[![Gem Version](https://badge.fury.io/rb/grape-slack-bot.svg)](https://badge.fury.io/rb/grape-slack-bot) [![Test Status](https://github.com/amkisko/grape-slack-bot.rb/actions/workflows/test.yml/badge.svg)](https://github.com/amkisko/grape-slack-bot.rb/actions/workflows/test.yml) [![codecov](https://codecov.io/gh/amkisko/grape-slack-bot.rb/graph/badge.svg?token=VIZ94XFOR3)](https://codecov.io/gh/amkisko/grape-slack-bot.rb)
 
 Extensible Slack bot implementation gem for [ruby-grape](https://github.com/ruby-grape/grape)
 
@@ -53,6 +53,7 @@ Interactive component is a component that is requested to be opened by bot app f
 
 Characteristics:
 - Can be associated with slash command
+- Can be associated with event
 
 References:
 - [interaction.rb](lib/slack_bot/interaction.rb)
@@ -114,19 +115,19 @@ References:
 
 ## Specification
 
-[x] Create any amount of endpoints that will handle Slack calls
-[x] Create multiple instances of bots and configure them separately or use the same configuration for all bots
-[x] Define and reuse slash command handlers for Slack slash commands
-[x] Define interactive component handlers for Slack interactive components
-[x] Define and reuse views for slash commands, interactive components and events
-[x] Define event handlers for Slack events
-[x] Define menu options handlers for Slack menu options
-[x] Store interactive component state in cache for usage in other handlers
-[x] Access current user session and user from any handler
-[x] Extend API endpoint with custom hooks and helpers within [grape specification](https://github.com/ruby-grape/grape)
-[x] Supports Slack signature verification
-[ ] Supports Slack socket mode (?)
-[ ] Supports Slack token rotation
+- [x] Create any amount of endpoints that will handle Slack calls
+- [x] Create multiple instances of bots and configure them separately or use the same configuration for all bots
+- [x] Define and reuse slash command handlers for Slack slash commands
+- [x] Define interactive component handlers for Slack interactive components
+- [x] Define and reuse views for slash commands, interactive components and events
+- [x] Define event handlers for Slack events
+- [x] Define menu options handlers for Slack menu options
+- [x] Store interactive component state in cache for usage in other handlers
+- [x] Access current user session and user from any handler
+- [x] Extend API endpoint with custom hooks and helpers within [grape specification](https://github.com/ruby-grape/grape)
+- [x] Supports Slack signature verification
+- [ ] Supports Slack socket mode (?)
+- [ ] Supports Slack token rotation
 
 ## Usage with grape
 
@@ -520,10 +521,14 @@ Contribution policy:
 
 ## Publishing
 
+Prefer using script `usr/bin/release.sh`, it will ensure that repository is synced and after publishing gem will create a tag.
+
 ```sh
+GEM_VERSION=$(grep -Eo "VERSION\s*=\s*'.+'" lib/slack_bot.rb  | grep -Eo "[0-9.]{5,}")
 rm grape-slack-bot-*.gem
 gem build grape-slack-bot.gemspec
-gem push grape-slack-bot-*.gem
+gem push grape-slack-bot-$GEM_VERSION.gem
+git tag $GEM_VERSION && git push --tags
 ```
 
 ## License

data/lib/slack_bot/args.rb

@@ -1,4 +1,5 @@
 require 'rack/utils'
+require 'active_support'
 require 'active_support/core_ext/hash/indifferent_access'
 
 module SlackBot

data/lib/slack_bot/config.rb

@@ -1,3 +1,4 @@
+require 'active_support'
 require 'active_support/core_ext/object'
 
 module SlackBot

data/lib/slack_bot/grape_extension.rb

@@ -1,3 +1,4 @@
+require 'active_support'
 require 'active_support/core_ext/object'
 
 module SlackBot
@@ -34,7 +35,7 @@ module SlackBot
              )
             true
           else
-            raise SlackBot::SignatureAuthenticationError.new("Signature mismatch")
+            raise SlackBot::Errors::SignatureAuthenticationError.new("Signature mismatch")
           end
         end
 
@@ -43,7 +44,7 @@ module SlackBot
           if slack_team_id == fetch_team_id
             true
           else
-            raise SlackBot::TeamAuthenticationError.new("Team is not authorized")
+            raise SlackBot::Errors::TeamAuthenticationError.new("Team is not authorized")
           end
         end
 
@@ -51,7 +52,7 @@ module SlackBot
           if params[:channel_name] == "directmessage"
             true
           else
-            raise SlackBot::ChannelAuthenticationError.new(
+            raise SlackBot::Errors::ChannelAuthenticationError.new(
                     "This command is only available in direct messages"
                   )
           end

data/lib/slack_bot/interaction.rb

@@ -1,3 +1,4 @@
+require 'active_support'
 require 'active_support/core_ext/object'
 
 require 'slack_bot/concerns/view_klass'
@@ -14,7 +15,7 @@ module SlackBot
         SlackBot::ApiClient.new.views_open(trigger_id: trigger_id, view: view)
 
       if !response.ok?
-        raise SlackBot::Errors::OpenModalError.new(response.error, data: response.data, payload: payload)
+        raise SlackBot::Errors::OpenModalError.new(response.error, data: response.data, payload: view)
       end
 
       view_id = response.data.dig("view", "id")
@@ -31,7 +32,7 @@ module SlackBot
         SlackBot::ApiClient.new.views_update(view_id: view_id, view: view)
 
       if !response.ok?
-        raise SlackBot::Errors::UpdateModalError.new(response.error, data: response.data, payload: payload)
+        raise SlackBot::Errors::UpdateModalError.new(response.error, data: response.data, payload: view)
       end
 
       view_id = response.data.dig("view", "id")

data/lib/slack_bot/view.rb

@@ -1,3 +1,4 @@
+require 'active_support'
 require 'active_support/core_ext/hash/indifferent_access'
 require 'slack_bot/concerns/pager_klass'
 

data/lib/slack_bot.rb

@@ -22,5 +22,5 @@ require 'slack_bot/pager'
 require 'slack_bot/grape_extension'
 
 module SlackBot
-  VERSION = '1.6.10'.freeze
+  VERSION = '1.6.12'.freeze
 end

data/spec/slack_bot/event_spec.rb

@@ -3,8 +3,8 @@ require 'spec_helper'
 describe SlackBot::Event do
   let(:current_user) { double(:current_user) }
   let(:params) { double(:params) }
-  let(:callback) { double(:callback) }
-  let(:config) { double(:config) }
+  let(:callback) { instance_double(SlackBot::Callback) }
+  let(:config) { instance_double(SlackBot::Config) }
 
   subject do
     described_class.new(

data/spec/slack_bot/interaction_spec.rb

@@ -1,5 +1,95 @@
 require 'spec_helper'
 
 describe SlackBot::Interaction do
+  subject { described_class.new(current_user: current_user, params: params, callback: callback, config: config) }
 
+  let(:current_user) { double("current_user") }
+  let(:params) { {} }
+  let(:callback) { instance_double(SlackBot::Callback, id: "test-callback-id") }
+  let(:config) { instance_double(SlackBot::Config) }
+
+  before do
+    allow(callback).to receive(:view_id=).and_return(nil)
+    allow(callback).to receive(:save).and_return(nil)
+  end
+
+  it "initializes" do
+    expect(subject.current_user).to eq(current_user)
+    expect(subject.params).to eq(params)
+    expect(subject.callback).to eq(callback)
+    expect(subject.config).to eq(config)
+  end
+
+  describe ".open_modal" do
+    subject(:open_modal) { described_class.open_modal(callback: callback, trigger_id: trigger_id, view: view) }
+
+    let(:trigger_id) { "trigger_id" }
+    let(:view) { {} }
+    let(:response) { instance_double(SlackBot::ApiResponse, ok?: true, data: { "view" => { "id" => "view_id" } }) }
+
+    before do
+      allow(SlackBot::ApiClient).to receive(:new).and_return(instance_double(SlackBot::ApiClient, views_open: response))
+    end
+
+    it "opens modal" do
+      expect(open_modal).to eq(SlackBot::Interaction::SlackViewsReply.new(callback&.id, "view_id"))
+    end
+
+    context "when response is not ok" do
+      let(:response) { instance_double(SlackBot::ApiResponse, ok?: false, error: "error", data: { "view" => { "id" => "view_id" } }) }
+
+      it "raises error" do
+        expect { open_modal }.to raise_error(SlackBot::Errors::OpenModalError)
+      end
+    end
+  end
+
+  describe ".update_modal" do
+    subject(:update_modal) { described_class.update_modal(callback: callback, view_id: view_id, view: view) }
+
+    let(:view_id) { "view_id" }
+    let(:view) { {} }
+    let(:response) { instance_double(SlackBot::ApiResponse, ok?: true, data: { "view" => { "id" => "view_id" } }) }
+
+    before do
+      allow(SlackBot::ApiClient).to receive(:new).and_return(instance_double(SlackBot::ApiClient, views_update: response))
+    end
+
+    it "updates modal" do
+      expect(update_modal).to eq(SlackBot::Interaction::SlackViewsReply.new(callback&.id, "view_id"))
+    end
+
+    context "when response is not ok" do
+      let(:response) { instance_double(SlackBot::ApiResponse, ok?: false, error: "error", data: { "view" => { "id" => "view_id" } }) }
+
+      it "raises error" do
+        expect { update_modal }.to raise_error(SlackBot::Errors::UpdateModalError)
+      end
+    end
+  end
+
+  describe ".publish_view" do
+    subject(:publish_view) { described_class.publish_view(callback: callback, metadata: metadata, user_id: user_id, view: view) }
+
+    let(:user_id) { "user_id" }
+    let(:metadata) { "metadata" }
+    let(:view) { {} }
+    let(:response) { instance_double(SlackBot::ApiResponse, ok?: true, data: { "view" => { "id" => "view_id" } }) }
+
+    before do
+      allow(SlackBot::ApiClient).to receive(:new).and_return(instance_double(SlackBot::ApiClient, views_publish: response))
+    end
+
+    it "publishes view" do
+      expect(publish_view).to eq(SlackBot::Interaction::SlackViewsReply.new(callback&.id, "view_id"))
+    end
+
+    context "when response is not ok" do
+      let(:response) { instance_double(SlackBot::ApiResponse, ok?: false, error: "error", data: { "view" => { "id" => "view_id" } }) }
+
+      it "raises error" do
+        expect { publish_view }.to raise_error(SlackBot::Errors::PublishViewError)
+      end
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grape-slack-bot
 version: !ruby/object:Gem::Version
-  version: 1.6.10
+  version: 1.6.12
 platform: ruby
 authors:
 - Andrei Makarov
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-08-31 00:00:00.000000000 Z
+date: 2023-10-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack