grape-slack-bot 1.2.0 → 1.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f84c93d79a89045d58deda55e64382c8ef74daf4975e0f47732b480c08619020
-  data.tar.gz: 6f3e952d9a8f85e48de8f045aab1c35f0d69e9ac39b8328c240f38c77c578ad0
+  metadata.gz: 99c07a4830556a1a896dea28c85f7fade663c8b49b6e649d084e2bf115a8eacd
+  data.tar.gz: 6dcce44e9edaf18c97f62dbf65fa248d6b309caad9e9ed6dcf7cdf327a16f063
 SHA512:
-  metadata.gz: 458e378569349642ecf2433fd573d3ad40ef69def84a6253206ff5bcef2b9d983c24b0d1e53a30887de7a8203dcf733ba868bbbbc9b4e215ded1f71487c3dd12
-  data.tar.gz: dd5ef3106d1a1255cb788bef313d905ca986133bc5b3b3e53166c70b9727f8d3b996cce595f724e80b9d08ec4338ca91fbedcf135945878c01a61d32872375ef
+  metadata.gz: 64c24157366d85a69449488dde1aa029f562afde69e0b3c210241d2e4778675842ed9003012f9f19193e0ef04d5a45f48f0acd70bfae9a55cc831667d4c0ee25
+  data.tar.gz: a399297e42b45b7be8bd05587abeb9150fba0276953c1771a46c05bbaee7b29361181cb16fc5b672d58bd68fcfe869b706166dd664261b61ac86e45bd633b3a7

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+# 1.2.2
+
+* `SlackBot::Callback.find` method will raise `SlackBot::Errors::CallbackNotFound` if callback is not resolved or has wrong data
+
+# 1.2.1
+
+* Extract `SlackBot::Logger` to separate file
+
 # 1.2.0
 
 * Remove `Rails.logger` dependency, make logger configurable

data/lib/slack_bot/callback.rb

@@ -6,8 +6,12 @@ module SlackBot
     CALLBACK_CACHE_KEY = "slack-bot-callback".freeze
 
     def self.find(id, config: nil)
+      return if id.blank?
+
       callback = new(id: id, config: config)
       callback.reload
+    rescue SlackBot::Errors::CallbackNotFound
+      nil
     end
 
     def self.create(class_name:, method_name:, user:, channel_id: nil, config: nil)
@@ -34,6 +38,7 @@ module SlackBot
     def reload
       @data = read_data
       SlackBot::DevConsole.log_check("SlackBot::Callback#read_data: #{id} | #{data}")
+      raise SlackBot::Errors::CallbackNotFound if data.nil?
 
       parse_args
       self
@@ -83,7 +88,7 @@ module SlackBot
     private
 
     def parse_args
-      args.raw_args = data&.dig(:args)
+      args.raw_args = data.fetch(:args)
     end
 
     def serialize_args

data/lib/slack_bot/dev_console.rb

@@ -1,9 +1,4 @@
 module SlackBot
-  class Logger
-    def info(*args, **kwargs)
-      puts args, kwargs
-    end
-  end
   class DevConsole
     def self.enabled=(value)
       @enabled = value

data/lib/slack_bot/errors.rb

@@ -18,6 +18,9 @@ module SlackBot
     class MenuOptionsNotImplemented < SlackBot::Error
     end
 
+    class CallbackNotFound < SlackBot::Error
+    end
+
     class SlackResponseError < SlackBot::Error
       attr_reader :error, :data, :payload
       def initialize(error, data: nil, payload: nil)

data/lib/slack_bot/logger.rb

@@ -0,0 +1,8 @@
+module SlackBot
+  class Logger
+    def info(*args, **kwargs)
+      puts args.inspect if args.any?
+      puts kwargs.inspect if kwargs.any?
+    end
+  end
+end

data/lib/slack_bot.rb

@@ -1,3 +1,4 @@
+require 'slack_bot/logger'
 require 'slack_bot/dev_console'
 
 require 'slack_bot/config'
@@ -21,5 +22,5 @@ require 'slack_bot/pager'
 require 'slack_bot/grape_extension'
 
 module SlackBot
-  VERSION = '1.2.0'.freeze
+  VERSION = '1.2.2'.freeze
 end

data/spec/slack_bot/callback_spec.rb

@@ -34,7 +34,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" } } }
+      let(:data) { { class_name: "Test", method_name: "test", user_id: 1, channel_id: "test_channel_id", extra: { test: "test" }, args: "" } }
 
       it "returns callback" do
         expect(find).to be_a(described_class)
@@ -47,6 +47,14 @@ describe SlackBot::Callback do
         expect(find.extra).to eq({ test: "test" })
       end
     end
+
+    context "when callback is not found" do
+      let(:data) { nil }
+
+      it "returns nil" do
+        expect(find).to eq(nil)
+      end
+    end
   end
 
   describe ".create" do
@@ -79,15 +87,112 @@ describe SlackBot::Callback do
   end
 
   describe "#reload" do
+    subject(:reload) { callback.reload }
+    let(:callback) {
+      described_class.new(id: "test_callback_id", config: config)
+    }
+    let(:data) {
+      {
+        class_name: "Test",
+        method_name: "test",
+        user_id: 1,
+        channel_id: "test_channel_id",
+        extra: { test: "test" },
+        args: ""
+      }
+    }
+
+    before do
+      allow(callback_storage_instance).to receive(:read).with("slack-bot-callback:test_callback_id").and_return(data)
+    end
 
+    it "returns callback" do
+      expect(reload).to be_a(described_class)
+      expect(reload.id).to eq("test_callback_id")
+      expect(reload.class_name).to eq("Test")
+      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" })
+    end
+
+    context "when callback is not found" do
+      let(:data) { nil }
+
+      it "raises error" do
+        expect { reload }.to raise_error(SlackBot::Errors::CallbackNotFound)
+      end
+    end
   end
 
   describe "#save" do
+    subject(:save) { callback.save }
+    let(:callback) {
+      described_class.new(
+        class_name: "Test",
+        method_name: "test",
+        user: user,
+        channel_id: "test_channel_id",
+        extra: { test: "test" },
+        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: { test: "test" }
+      }, expires_in: 1.hour)
+    end
 
+    it "returns callback" do
+      expect { save }.not_to raise_error
+      expect(callback).to be_a(described_class)
+      expect(callback.id).to eq("test_callback_id")
+      expect(callback.args).to be_a(SlackBot::Args)
+    end
   end
 
   describe "#update" do
+    subject(:update) { callback.update(payload) }
+    let(:callback) {
+      described_class.new(
+        id: "test_callback_id",
+        class_name: "Test",
+        method_name: "test",
+        user: user,
+        channel_id: "test_channel_id",
+        extra: { test: "test" },
+        config: config
+      )
+    }
 
+    before 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)
+    end
+
+    let(:payload) { { test: "test" } }
+
+    it "returns callback" do
+      expect { update }.not_to raise_error
+      expect(callback).to be_a(described_class)
+      expect(callback.id).to eq("test_callback_id")
+      expect(callback.args).to be_a(SlackBot::Args)
+    end
   end
 
   describe "#destroy" do

data/spec/slack_bot/dev_console_spec.rb

@@ -1,50 +1,3 @@
-module SlackBot
-  class Logger
-    def info(*args, **kwargs)
-      puts args, kwargs
-    end
-  end
-  class DevConsole
-    def self.enabled=(value)
-      @enabled = value
-    end
-
-    def self.enabled?
-      @enabled
-    end
-
-    def self.logger=(value)
-      @logger = value
-    end
-
-    def self.logger
-      @logger ||= Logger.new
-    end
-
-    def self.log(message = nil, &block)
-      return unless enabled?
-
-      message = yield if block_given?
-      logger.info(message)
-    end
-
-    def self.log_input(message = nil, &block)
-      message = yield if block_given?
-      log(">>> #{message}")
-    end
-
-    def self.log_output(message = nil, &block)
-      message = yield if block_given?
-      log("<<< #{message}")
-    end
-
-    def self.log_check(message = nil, &block)
-      message = yield if block_given?
-      log("!!! #{message}")
-    end
-  end
-end
-
 require 'spec_helper'
 
 describe SlackBot::DevConsole do
@@ -85,4 +38,58 @@ describe SlackBot::DevConsole do
       end
     end
   end
+
+  describe '.log_input' do
+    context 'when enabled' do
+      before { described_class.enabled = true }
+      it 'logs the message' do
+        expect(described_class.logger).to receive(:info).with('>>> test')
+        described_class.log_input('test')
+      end
+    end
+
+    context 'when disabled' do
+      before { described_class.enabled = false }
+      it 'does not log the message' do
+        expect(described_class.logger).not_to receive(:info)
+        described_class.log_input('test')
+      end
+    end
+  end
+
+  describe '.log_output' do
+    context 'when enabled' do
+      before { described_class.enabled = true }
+      it 'logs the message' do
+        expect(described_class.logger).to receive(:info).with('<<< test')
+        described_class.log_output('test')
+      end
+    end
+
+    context 'when disabled' do
+      before { described_class.enabled = false }
+      it 'does not log the message' do
+        expect(described_class.logger).not_to receive(:info)
+        described_class.log_output('test')
+      end
+    end
+  end
+
+  describe '.log_check' do
+    context 'when enabled' do
+      before { described_class.enabled = true }
+      it 'logs the message' do
+        expect(described_class.logger).to receive(:info).with('!!! test')
+        described_class.log_check('test')
+      end
+    end
+
+    context 'when disabled' do
+      before { described_class.enabled = false }
+      it 'does not log the message' do
+        expect(described_class.logger).not_to receive(:info)
+        described_class.log_check('test')
+      end
+    end
+  end
 end

data/spec/slack_bot/logger_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+describe SlackBot::Logger do
+  describe '#info' do
+    it 'prints the args' do
+      expect { subject.info('test') }.to output(%(["test"]\n)).to_stdout
+    end
+
+    it 'prints the kwargs' do
+      expect { subject.info(test: 'test') }.to output(%({:test=>"test"}\n)).to_stdout
+    end
+  end
+end

data/spec/slack_bot/pager_spec.rb

@@ -1,5 +1,51 @@
 require 'spec_helper'
 
 describe SlackBot::Pager do
+  let(:args) do
+    instance_double(SlackBot::Args)
+  end
+  before do
+    allow(args).to receive(:[]).with(:page).and_return(1)
+    allow(args).to receive(:[]).with(:per_page).and_return(10)
+  end
 
+  describe '#total_count' do
+    it 'returns the count of the source cursor' do
+      source_cursor = double(count: 10)
+      pager = described_class.new(source_cursor, args: args)
+      expect(pager.total_count).to eq(10)
+    end
+  end
+
+  describe '#pages_count' do
+    it 'returns the count of the source cursor divided by the limit' do
+      source_cursor = double(count: 10)
+      pager = described_class.new(source_cursor, args: args, limit: 5)
+      expect(pager.pages_count).to eq(2)
+    end
+
+    it 'returns the count of the source cursor divided by the limit' do
+      source_cursor = double(count: 11)
+      pager = described_class.new(source_cursor, args: args, limit: 5)
+      expect(pager.pages_count).to eq(3)
+    end
+  end
+
+  describe '#offset' do
+    it 'returns the offset based on the page and limit' do
+      source_cursor = double(count: 10)
+      pager = described_class.new(source_cursor, args: args, limit: 5, page: 2)
+      expect(pager.offset).to eq(5)
+    end
+  end
+
+  describe '#cursor' do
+    it 'returns the cursor with the limit and offset' do
+      source_cursor = double(count: 10)
+      expect(source_cursor).to receive(:limit).with(5).and_return(source_cursor)
+      expect(source_cursor).to receive(:offset).with(5).and_return(source_cursor)
+      pager = described_class.new(source_cursor, args: args, limit: 5, page: 2)
+      expect(pager.cursor).to eq(source_cursor)
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: grape-slack-bot
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.2.2
 platform: ruby
 authors:
 - Andrei Makarov
@@ -174,6 +174,7 @@ files:
 - lib/slack_bot/event.rb
 - lib/slack_bot/grape_extension.rb
 - lib/slack_bot/interaction.rb
+- lib/slack_bot/logger.rb
 - lib/slack_bot/menu_options.rb
 - lib/slack_bot/pager.rb
 - lib/slack_bot/view.rb
@@ -186,6 +187,7 @@ files:
 - spec/slack_bot/event_spec.rb
 - spec/slack_bot/grape_extension_spec.rb
 - spec/slack_bot/interaction_spec.rb
+- spec/slack_bot/logger_spec.rb
 - spec/slack_bot/menu_options_spec.rb
 - spec/slack_bot/pager_spec.rb
 - spec/slack_bot/view_spec.rb
@@ -228,6 +230,7 @@ test_files:
 - spec/slack_bot/event_spec.rb
 - spec/slack_bot/grape_extension_spec.rb
 - spec/slack_bot/interaction_spec.rb
+- spec/slack_bot/logger_spec.rb
 - spec/slack_bot/menu_options_spec.rb
 - spec/slack_bot/pager_spec.rb
 - spec/slack_bot/view_spec.rb