grape-slack-bot 1.2.3 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3472ece85beebd447e192f73013849e3e37a366fdc22b4f4864ef0908f58f502
-  data.tar.gz: 7f25928036698338c354238d9615ccd980d136a0c88056be1a1989304c95eae9
+  metadata.gz: 0f8fc51cbef0f57cb132347ce71c02fba8ca5130749cca04ed3ffdbefb482ce1
+  data.tar.gz: a1a96768a308005a8bf8aa709c3c3a29f927c31a624c4ad9bfc6d7e60b9b01ad
 SHA512:
-  metadata.gz: a2902bfc733cd9aec81df154e0c43ac2bfe9eca7fd6105cb7b6d2f1ea1631daae093e2a96698388accaf35b46c4da826218333bab3c78bed7781c17583e01312
-  data.tar.gz: 04a70f1a3a5251d44d2b4bb21cdaa113296d50c51b0fae010f27f5c1a7caeb5b41eb635c6d349672701a5aef13c58f39249f8e740a2310ab5024dd822e7341ce
+  metadata.gz: 2d372b748e6242a8766799b762afbfb205023491cb5c1fb6f453cc2454d389d89eecfb0e3f7257ef92b545b3215e579103c325dcc5ba0a40bb5a48f6ab4451d3
+  data.tar.gz: 2c72725ce9911a95c74ae015e6f24aa77eae793afd97b7c2d5c934598c3c9195c61bd386bdd40661b2ce3d89bd875e426ed926c3ec711f709090ed2e591ffaf8

data/CHANGELOG.md

@@ -1,3 +1,15 @@
+# 1.5.0
+
+* Complete upgrade of callback storage logic
+
+# 1.4.0
+
+* Allow setting callback expiration time on save and update
+
+# 1.3.0
+
+* Clean up callback arguments, remove unused `method_name`
+
 # 1.2.3
 
 * Minor fix for Events API

data/lib/slack_bot/callback.rb

@@ -4,6 +4,7 @@ require 'active_support/core_ext/numeric/time'
 module SlackBot
   class Callback
     CALLBACK_CACHE_KEY = "slack-bot-callback".freeze
+    CALLBACK_RECORD_EXPIRES_IN = 15.minutes.freeze
 
     def self.find(id, config: nil)
       return if id.blank?
@@ -14,32 +15,33 @@ module SlackBot
       nil
     end
 
-    def self.create(class_name:, method_name:, user:, channel_id: nil, config: nil)
+    def self.create(class_name:, user:, channel_id: nil, config: nil, payload: nil, expires_in: nil)
       callback =
-        new(class_name: class_name, method_name: method_name, user: user, channel_id: channel_id, config: config)
+        new(class_name: class_name, user: user, channel_id: channel_id, payload: payload, config: config, expires_in: expires_in)
       callback.save
       callback
     end
 
-    attr_reader :id, :data, :args, :config
-    def initialize(id: nil, class_name: nil, method_name: nil, user: nil, channel_id: nil, extra: nil, config: nil)
+    attr_reader :id, :data, :args, :config, :expires_in
+    def initialize(id: nil, class_name: nil, user: nil, channel_id: nil, payload: nil, config: nil, expires_in: nil)
       @id = id
       @data = {
         class_name: class_name,
-        method_name: method_name,
         user_id: user&.id,
         channel_id: channel_id,
-        extra: extra
+        payload: payload
       }
       @args = SlackBot::Args.new
       @config = config || SlackBot::Config.current_instance
+      @expires_in = expires_in || CALLBACK_RECORD_EXPIRES_IN
     end
 
     def reload
-      @data = read_data
-      SlackBot::DevConsole.log_check("SlackBot::Callback#read_data: #{id} | #{data}")
-      raise SlackBot::Errors::CallbackNotFound if data.nil?
+      cached_data = read_data
+      SlackBot::DevConsole.log_check("SlackBot::Callback#read_data: #{id} | #{cached_data}")
+      raise SlackBot::Errors::CallbackNotFound if cached_data.nil?
 
+      @data = cached_data
       parse_args
       self
     end
@@ -56,7 +58,12 @@ module SlackBot
       return if id.blank?
       return if data.blank?
 
-      @data = data.merge(payload)
+      if @data[:payload].is_a?(Hash)
+        @data[:payload] = @data[:payload].merge(payload)
+      else
+        @data[:payload] = payload
+      end
+
       save
     end
 
@@ -73,6 +80,23 @@ module SlackBot
       end
     end
 
+    def user=(user)
+      @user = user
+      @data[:user_id] = user&.id
+    end
+
+    def class_name=(class_name)
+      @data[:class_name] = class_name
+    end
+
+    def channel_id=(channel_id)
+      @data[:channel_id] = channel_id
+    end
+
+    def payload=(payload)
+      @data[:payload] = payload
+    end
+
     def handler_class
       return if class_name.blank?
 
@@ -81,6 +105,7 @@ module SlackBot
 
     def method_missing(method_name, *args, &block)
       return data[method_name.to_sym] if data.key?(method_name.to_sym)
+      return data[:payload][method_name.to_s] if data[:payload].is_a?(Hash) && data[:payload].key?(method_name.to_s)
 
       super
     end
@@ -92,7 +117,7 @@ module SlackBot
     end
 
     def serialize_args
-      data[:args] = args.to_s
+      @data[:args] = args.to_s
     end
 
     def generate_id
@@ -103,8 +128,9 @@ module SlackBot
       config.callback_storage_instance.read("#{CALLBACK_CACHE_KEY}:#{id}")
     end
 
-    def write_data(data)
-      config.callback_storage_instance.write("#{CALLBACK_CACHE_KEY}:#{id}", data, expires_in: 1.hour)
+    def write_data(data, expires_in: nil)
+      expires_in ||= CALLBACK_RECORD_EXPIRES_IN
+      config.callback_storage_instance.write("#{CALLBACK_CACHE_KEY}:#{id}", data, expires_in: expires_in)
     end
 
     def delete_data

data/lib/slack_bot/command.rb

@@ -48,7 +48,7 @@ module SlackBot
 
     private
 
-    def open_modal(view_name, method_name: nil, context: nil)
+    def open_modal(view_name, context: nil)
       view = self.class.view_klass.new(
         args: args,
         current_user: @current_user,
@@ -61,7 +61,6 @@ module SlackBot
         trigger_id: params[:trigger_id],
         channel_id: params[:channel_id],
         class_name: self.class.name,
-        method_name: method_name,
         user: @current_user,
         payload: payload,
         config: config

data/lib/slack_bot/grape_extension.rb

@@ -88,7 +88,7 @@ module SlackBot
           callback = SlackBot::Callback.find(callback_id, config: config)
           raise SlackBot::Errors::CallbackNotFound.new if callback.blank?
 
-          SlackBot::DevConsole.log_check "SlackApi::Interactions##{__method__}: #{callback.id} #{callback.extra} #{callback.user_id} #{user&.id}"
+          SlackBot::DevConsole.log_check "SlackApi::Interactions##{__method__}: #{callback.id} #{callback.payload} #{callback.user_id} #{user&.id}"
 
           if callback.user_id != user.id
             raise "Callback user is not equal to action user"

data/lib/slack_bot/interaction.rb

@@ -12,7 +12,6 @@ module SlackBot
       trigger_id:,
       payload:,
       class_name:,
-      method_name:,
       user:,
       channel_id:,
       config: nil
@@ -20,7 +19,6 @@ module SlackBot
       callback =
         Callback.create(
           class_name: class_name,
-          method_name: method_name,
           user: user,
           channel_id: channel_id,
           config: config
@@ -45,7 +43,6 @@ module SlackBot
       view_id:,
       payload:,
       class_name: nil,
-      method_name: nil,
       user: nil,
       channel_id: nil,
       config: nil
@@ -54,7 +51,6 @@ module SlackBot
       callback ||=
         Callback.create(
           class_name: class_name,
-          method_name: method_name,
           user: user,
           channel_id: channel_id,
           config: config

data/lib/slack_bot.rb

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

data/spec/slack_bot/callback_spec.rb

@@ -4,10 +4,9 @@ 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" },
+      payload: { test: "test" },
       config: config
     )
   }
@@ -34,7 +33,7 @@ describe SlackBot::Callback do
     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" }, args: "" } }
+      let(:data) { { class_name: "Test", user_id: 1, channel_id: "test_channel_id", payload: { test: "test" }, args: "" } }
 
       it "returns callback" do
         expect(find).to be_a(described_class)
@@ -43,8 +42,7 @@ describe SlackBot::Callback do
         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" })
+        expect(find.payload).to eq({ test: "test" })
       end
     end
 
@@ -58,21 +56,20 @@ describe SlackBot::Callback do
   end
 
   describe ".create" do
-    subject(:create) { described_class.create(class_name: "Test", method_name: "test", user: user, channel_id: "test_channel_id", config: config) }
+    subject(:create) { described_class.create(class_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)
+        payload: nil
+      }, expires_in: SlackBot::Callback::CALLBACK_RECORD_EXPIRES_IN)
     end
 
-    let(:data) { { class_name: "Test", method_name: "test", user_id: 1, channel_id: "test_channel_id", extra: nil } }
+    let(:data) { { class_name: "Test", user_id: 1, channel_id: "test_channel_id", payload: nil } }
 
     it "returns callback" do
       expect(create).to be_a(described_class)
@@ -81,8 +78,7 @@ describe SlackBot::Callback do
       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)
+      expect(create.payload).to eq(nil)
     end
   end
 
@@ -94,10 +90,9 @@ describe SlackBot::Callback do
     let(:data) {
       {
         class_name: "Test",
-        method_name: "test",
         user_id: 1,
         channel_id: "test_channel_id",
-        extra: { test: "test" },
+        payload: { test: "test payload" },
         args: ""
       }
     }
@@ -113,8 +108,7 @@ describe SlackBot::Callback do
       expect(reload.user).to eq(user)
       expect(reload.user_id).to eq(1)
       expect(reload.channel_id).to eq("test_channel_id")
-      expect(reload.method_name).to eq("test")
-      expect(reload.extra).to eq({ test: "test" })
+      expect(reload.payload).to eq({ test: "test payload" })
     end
 
     context "when callback is not found" do
@@ -131,10 +125,9 @@ describe SlackBot::Callback do
     let(:callback) {
       described_class.new(
         class_name: "Test",
-        method_name: "test",
         user: user,
         channel_id: "test_channel_id",
-        extra: { test: "test" },
+        payload: { test: "test payload" },
         config: config
       )
     }
@@ -144,15 +137,14 @@ describe SlackBot::Callback do
       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: { test: "test" }
-      }, expires_in: 1.hour)
+        payload: { test: "test payload" }
+      }, expires_in: SlackBot::Callback::CALLBACK_RECORD_EXPIRES_IN)
     end
 
     it "returns callback" do
-      expect { save }.not_to raise_error
+      save
       expect(callback).to be_a(described_class)
       expect(callback.id).to eq("test_callback_id")
       expect(callback.args).to be_a(SlackBot::Args)
@@ -165,10 +157,9 @@ describe SlackBot::Callback do
       described_class.new(
         id: "test_callback_id",
         class_name: "Test",
-        method_name: "test",
         user: user,
         channel_id: "test_channel_id",
-        extra: { test: "test" },
+        payload: { test: "test payload" },
         config: config
       )
     }
@@ -177,18 +168,16 @@ describe SlackBot::Callback do
       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: { test: "test" },
-        test: "test"
-      }, expires_in: 1.hour)
+        payload: { test: "test payload 2" }
+      }, expires_in: SlackBot::Callback::CALLBACK_RECORD_EXPIRES_IN)
     end
 
-    let(:payload) { { test: "test" } }
+    let(:payload) { { test: "test payload 2" } }
 
     it "returns callback" do
-      expect { update }.not_to raise_error
+      update
       expect(callback).to be_a(described_class)
       expect(callback.id).to eq("test_callback_id")
       expect(callback.args).to be_a(SlackBot::Args)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: grape-slack-bot
 version: !ruby/object:Gem::Version
-  version: 1.2.3
+  version: 1.5.0
 platform: ruby
 authors:
 - Andrei Makarov