slack-ruby-bot 0.9.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d81a287c11826ef682f08066d61ea77084f30fac
-  data.tar.gz: ad1bca7b36da88557f9ee1b50acb1f4f929073a4
+  metadata.gz: d8e23b1dde8a7cb5147d728f4a0269e36f91fb27
+  data.tar.gz: b5355a6b7a7cf15868390e97c0aa423881373f6d
 SHA512:
-  metadata.gz: cfd33b6f5f6e5121d88fb74a24525ce792002e4cb1cf16b4ad36ed242f75df6cfcf7ed055899e61b1d9a2d8a9cdd58d3c85ec41f5894df3cc6dca20c7056dc1f
-  data.tar.gz: 855abd25109430b68e93a7bd1d3f21fc7f5ae54919ea0419a22ce5ecf6624ea35b9eaeed504babc368128077b72df1bbe09216930e971cbcdeb60f5a032f4a57
+  metadata.gz: 726e80f25e3bc5310298205bdea44759b830974a87d7f0723c444ee956113a40d9fdf67c6ca2a9f21138379e28c0cea6e38e3d5efa3796d2334f0f27e8fb1e40
+  data.tar.gz: 9235ebff49dc787ab29514b8c2351fbbad318a097a144168ac18d768b2aeceb743ec4d62767cf5c76d9f7063f56123b6288c530cf8a1b89176c871a963f76c6d

data/.rubocop_todo.yml

@@ -1,5 +1,6 @@
-# This configuration was generated by `rubocop --auto-gen-config`
-# on 2016-02-09 15:33:27 -0500 using RuboCop version 0.32.1.
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2016-09-24 09:10:21 -0400 using RuboCop version 0.38.0.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
@@ -7,48 +8,48 @@
 
 # Offense count: 1
 Lint/HandleExceptions:
-  Enabled: false
+  Exclude:
+    - 'lib/initializers/giphy.rb'
 
-# Offense count: 6
+# Offense count: 5
 Metrics/AbcSize:
-  Max: 42
-
-# Offense count: 1
-# Configuration parameters: CountComments.
-Metrics/ClassLength:
-  Max: 102
+  Max: 36
 
 # Offense count: 2
 Metrics/CyclomaticComplexity:
-  Max: 12
+  Max: 11
 
-# Offense count: 130
-# Configuration parameters: AllowURI, URISchemes.
+# Offense count: 156
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes.
+# URISchemes: http, https
 Metrics/LineLength:
-  Max: 158
+  Max: 147
 
-# Offense count: 7
+# Offense count: 6
 # Configuration parameters: CountComments.
 Metrics/MethodLength:
   Max: 27
 
 # Offense count: 2
 Metrics/PerceivedComplexity:
-  Max: 12
+  Max: 11
 
-# Offense count: 20
+# Offense count: 26
 Style/Documentation:
   Enabled: false
 
-# Offense count: 3
+# Offense count: 1
 Style/DoubleNegation:
-  Enabled: false
+  Exclude:
+    - 'lib/slack-ruby-bot/commands/base.rb'
 
 # Offense count: 1
-# Configuration parameters: Exclude.
+# Configuration parameters: ExpectMatchingDefinition, Regex, IgnoreExecutableScripts.
 Style/FileName:
-  Enabled: false
+  Exclude:
+    - 'lib/slack-ruby-bot.rb'
 
 # Offense count: 1
 Style/ModuleFunction:
-  Enabled: false
+  Exclude:
+    - 'lib/slack-ruby-bot/config.rb'

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+### 0.10.0 (2/9/2017)
+
+* [#111](https://github.com/slack-ruby/slack-ruby-bot/pull/111): Default keyword for GIFs in invalid commands has been changed from `idiot` to `understand` - [@dblock](https://github.com/dblock).
+* [#98](https://github.com/slack-ruby/slack-ruby-bot/pull/98): Fixed a couple of problems in TUTORIAL.md - [@edruder](https://github.com/edruder).
+* [#95](https://github.com/slack-ruby/slack-ruby-bot/pull/95): Log team name and ID on successful connection - [@dblock](https://github.com/dblock).
+* [#94](https://github.com/slack-ruby/slack-ruby-bot/pull/94): Use the slack-ruby-danger gem - [@dblock](https://github.com/dblock).
+* [#86](https://github.com/dblock/slack-ruby-bot/pull/86): Fix: help statements from classes that do not directly inherit from `Base` appear in `bot help` - [@maclover7](https://github.com/maclover7).
+* [#96](https://github.com/slack-ruby/slack-ruby-bot/pull/96): Support help statements in anonymous command and bot classes - [@dblock](https://github.com/dblock).
+* [#75](https://github.com/slack-ruby/slack-ruby-bot/pull/101): Fix: Guarantee order of commands based on load order - [@gconklin](https://github.com/gconklin).
+
 ### 0.9.0 (8/29/2016)
 
 * [#89](https://github.com/slack-ruby/slack-ruby-bot/pull/89): Drop giphy dependency - [@tmsrjs](https://github.com/tmsrjs).

data/Dangerfile

@@ -1 +1 @@
-# inherits from https://github.com/slack-ruby/danger
+danger.import_dangerfile(gem: 'slack-ruby-danger')

data/Gemfile

@@ -4,4 +4,7 @@ gemspec
 
 gem ENV['CONCURRENCY'], require: false if ENV.key?('CONCURRENCY')
 gem 'giphy', require: false if ENV.key?('WITH_GIPHY')
-gem 'danger', '~> 2.0'
+
+group :test do
+  gem 'slack-ruby-danger', '~> 0.1.0', require: false
+end

data/README.md

@@ -19,7 +19,7 @@ If you are not familiar with Slack bots or Slack API concepts, you might want to
 
 ## Stable Release
 
-You're reading the documentation for the **stable** release of slack-ruby-bot. See [CHANGELOG](CHANGELOG.md) for a history of changes and [UPGRADING](UPGRADING.md) for how to upgrade to more recent versions.
+You're reading the documentation for the **stable** release of slack-ruby-bot, 0.10.0. See [CHANGELOG](CHANGELOG.md) for a history of changes and [UPGRADING](UPGRADING.md) for how to upgrade to more recent versions.
 
 ## Usage
 

data/TUTORIAL.md

@@ -19,6 +19,7 @@ gem 'slack-ruby-bot'
 gem 'puma'
 gem 'sinatra'
 gem 'dotenv'
+gem 'celluloid-io'
 
 group :development, :test do
   gem 'rake'
@@ -172,15 +173,18 @@ require 'slack-mathbot'
 
 #### Test the Bot Application
 
-Create a test for the bot application itself in `spec/slack-mathbot/app_spec.rb`.
+Create a test for the bot application itself in `spec/slack-mathbot/bot_spec.rb`.
 
 ```ruby
 require 'spec_helper'
 
-describe SlackMathbot::App do
+describe SlackMathbot::Bot do
   def app
     SlackMathbot::Bot.instance
   end
+
+  subject { app }
+
   it_behaves_like 'a slack ruby bot'
 end
 ```
@@ -196,6 +200,9 @@ describe SlackMathbot::Commands::Calculate do
   def app
     SlackMathbot::Bot.instance
   end
+
+  subject { app }
+
   it 'returns 4' do
     expect(message: "#{SlackRubyBot.config.user} calculate 2+2", channel: 'channel').to respond_with_slack_message('4')
   end

data/examples/minimal/pongbot.rb

@@ -6,4 +6,6 @@ class Bot < SlackRubyBot::Bot
   end
 end
 
+SlackRubyBot::Client.logger.level = Logger::WARN
+
 Bot.run

data/lib/slack-ruby-bot/bot.rb

@@ -11,7 +11,7 @@ module SlackRubyBot
     end
 
     def self.call(client, data, _match)
-      client.say(channel: data.channel, text: "Sorry <@#{data.user}>, I don't understand that command!", gif: 'idiot')
+      client.say(channel: data.channel, text: "Sorry <@#{data.user}>, I don't understand that command!", gif: 'understand')
     end
   end
 end

data/lib/slack-ruby-bot/commands/base.rb

@@ -5,6 +5,13 @@ module SlackRubyBot
       class_attribute :routes
 
       class << self
+        attr_reader :command_classes
+
+        def inherited(subclass)
+          @command_classes ||= []
+          @command_classes << subclass
+        end
+
         def send_message(client, channel, text, options = {})
           logger.warn '[DEPRECATION] `send_message` is deprecated.  Please use `client.say` instead.'
           if text && !text.length.empty?
@@ -25,7 +32,7 @@ module SlackRubyBot
         end
 
         def help(&block)
-          CommandsHelper.instance.capture_help(name, &block)
+          CommandsHelper.instance.capture_help(self, &block)
         end
 
         def default_command_name

data/lib/slack-ruby-bot/commands/help/attrs.rb

@@ -3,10 +3,10 @@ module SlackRubyBot
     module Help
       class Attrs
         attr_accessor :command_name, :command_desc, :command_long_desc
-        attr_reader :class_name, :commands
+        attr_reader :klass, :commands
 
-        def initialize(class_name)
-          @class_name = class_name
+        def initialize(klass)
+          @klass = klass
           @commands = []
         end
 
@@ -23,7 +23,7 @@ module SlackRubyBot
         end
 
         def command(title, &block)
-          @commands << self.class.new(class_name).tap do |k|
+          @commands << self.class.new(klass).tap do |k|
             k.title(title)
             k.instance_eval(&block)
           end

data/lib/slack-ruby-bot/commands/unknown.rb

@@ -4,7 +4,7 @@ module SlackRubyBot
       match(/^(?<bot>\S*)[\s]*(?<expression>.*)$/)
 
       def self.call(client, data, _match)
-        client.say(channel: data.channel, text: "Sorry <@#{data.user}>, I don't understand that command!", gif: 'idiot')
+        client.say(channel: data.channel, text: "Sorry <@#{data.user}>, I don't understand that command!", gif: 'understand')
       end
     end
   end

data/lib/slack-ruby-bot/hooks/hello.rb

@@ -9,7 +9,7 @@ module SlackRubyBot
 
       def call(client, _data)
         return unless client && client.team
-        logger.info "Successfully connected to https://#{client.team.domain}.slack.com."
+        logger.info "Successfully connected team #{client.team.name} (#{client.team.id}) to https://#{client.team.domain}.slack.com."
       end
     end
   end

data/lib/slack-ruby-bot/hooks/message.rb

@@ -26,7 +26,7 @@ module SlackRubyBot
       # @return [Array] Descendants of SlackRubyBot::Commands::Base.
       #
       def command_classes
-        SlackRubyBot::Commands::Base.descendants
+        SlackRubyBot::Commands::Base.command_classes
       end
 
       #

data/lib/slack-ruby-bot/support/commands_helper.rb

@@ -10,8 +10,8 @@ module SlackRubyBot
       @commands_help_attrs = []
     end
 
-    def capture_help(class_name, &block)
-      k = Commands::Help::Attrs.new(class_name)
+    def capture_help(klass, &block)
+      k = Commands::Help::Attrs.new(klass)
       k.instance_eval(&block)
       @commands_help_attrs << k
     end
@@ -66,11 +66,11 @@ module SlackRubyBot
     end
 
     def bot_help_attrs
-      commands_help_attrs.select { |k| k.class_name.constantize.superclass == SlackRubyBot::Bot }
+      commands_help_attrs.select { |k| k.klass.ancestors.include?(SlackRubyBot::Bot) }
     end
 
     def other_commands_help_attrs
-      commands_help_attrs.select { |k| k.class_name.constantize.superclass == SlackRubyBot::Commands::Base }
+      commands_help_attrs.select { |k| k.klass.ancestors.include?(SlackRubyBot::Commands::Base) && !k.klass.ancestors.include?(SlackRubyBot::Bot) }
     end
   end
 end

data/lib/slack-ruby-bot/version.rb

@@ -1,3 +1,3 @@
 module SlackRubyBot
-  VERSION = '0.9.0'.freeze
+  VERSION = '0.10.0'.freeze
 end

data/spec/slack-ruby-bot/commands/commands_command_classes_spec.rb

@@ -0,0 +1,39 @@
+require 'spec_helper'
+
+describe SlackRubyBot::Commands::Base do
+  let! :command1 do
+    Class.new(SlackRubyBot::Commands::Base) do
+      command 'command'
+
+      def self.call(client, data, match)
+        client.say(channel: data.channel, text: "#{match[:command]}: #{match[:expression]}")
+      end
+    end
+  end
+
+  let! :command2 do
+    Class.new(SlackRubyBot::Commands::Base) do
+      command 'command'
+
+      def self.call(client, data, match)
+        client.say(channel: data.channel, text: "#{match[:command]}: #{match[:expression]}")
+      end
+    end
+  end
+
+  def app
+    SlackRubyBot::App.new
+  end
+
+  describe '#command_classes' do
+    it 'returns all registered command classes' do
+      expect(SlackRubyBot::Commands::Base.command_classes).to include command1
+      expect(SlackRubyBot::Commands::Base.command_classes).to include command2
+    end
+
+    it 'returns command1 before command2' do
+      command_classes = SlackRubyBot::Commands::Base.command_classes
+      expect(command_classes.find_index(command1)).to be < command_classes.find_index(command2)
+    end
+  end
+end

data/spec/slack-ruby-bot/support/commands_helper_spec.rb

@@ -1,14 +1,14 @@
 require 'spec_helper'
 
 describe SlackRubyBot::CommandsHelper do
-  let(:bot_class_name) { 'Testing::WeatherBot' }
-  let(:command_class_name) { 'Testing::HelloCommand' }
+  let(:bot_class) { Testing::WeatherBot }
+  let(:command_class) { Testing::HelloCommand }
   let(:commands_helper) { described_class.instance }
 
   describe '#capture_help' do
     let(:help_attrs) { commands_helper.commands_help_attrs }
-    let(:bot_help_attrs) { help_attrs.find { |k| k.class_name == bot_class_name } }
-    let(:command_help_attrs) { help_attrs.find { |k| k.class_name == command_class_name } }
+    let(:bot_help_attrs) { help_attrs.find { |k| k.klass == bot_class } }
+    let(:command_help_attrs) { help_attrs.find { |k| k.klass == command_class } }
 
     it 'should save bot class name' do
       expect(bot_help_attrs).to be
@@ -62,7 +62,8 @@ describe SlackRubyBot::CommandsHelper do
   end
 
   describe '#bot_desc_and_commands' do
-    let(:bot_desc) { commands_helper.bot_desc_and_commands.first }
+    let(:bot_desc_and_commands) { commands_helper.bot_desc_and_commands }
+    let(:bot_desc) { bot_desc_and_commands.first }
 
     it 'returns bot name and description' do
       expect(bot_desc).to include('*Weather Bot* - This bot tells you the weather.')
@@ -81,15 +82,43 @@ describe SlackRubyBot::CommandsHelper do
     it 'do not show description for command without description' do
       expect(bot_desc).to include("*command_without_description*\n")
     end
+
+    context 'subclasses' do
+      let(:another_bot_base) { Class.new(SlackRubyBot::Bot) }
+      let!(:another_bot) do
+        Class.new(another_bot_base) do
+          help do
+            title 'Creating your own base class works too!'
+          end
+        end
+      end
+
+      it 'expose help commands' do
+        expect(bot_desc_and_commands).to include("*Creating your own base class works too!*\n\n*Commands:*\n")
+      end
+    end
   end
 
   describe '#other_commands_descs' do
-    let(:commands_desc) { commands_helper.other_commands_descs }
-    let(:hello_command_desc) { commands_desc.find { |desc| desc =~ /\*hello\*/ } }
+    let(:another_command_base) { Class.new(SlackRubyBot::Commands::Base) }
+    let!(:another_command) do
+      Class.new(another_command_base) do
+        help do
+          title 'Creating your own base class works too!'
+        end
+      end
+    end
+
+    let(:other_commands_descs) { commands_helper.other_commands_descs }
+    let(:hello_command_desc) { other_commands_descs.find { |desc| desc =~ /\*hello\*/ } }
 
     it 'returns command name and description' do
       expect(hello_command_desc).to eq('*hello* - Says hello.')
     end
+
+    it 'includes commands who do not directly inherit from provided base class' do
+      expect(other_commands_descs).to include('*Creating your own base class works too!*')
+    end
   end
 
   describe '#command_full_desc' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: slack-ruby-bot
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.10.0
 platform: ruby
 authors:
 - Daniel Doubrovkine
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-29 00:00:00.000000000 Z
+date: 2017-02-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hashie
@@ -204,6 +204,7 @@ files:
 - spec/slack-ruby-bot/commands/aliases_spec.rb
 - spec/slack-ruby-bot/commands/bot_message_spec.rb
 - spec/slack-ruby-bot/commands/bot_spec.rb
+- spec/slack-ruby-bot/commands/commands_command_classes_spec.rb
 - spec/slack-ruby-bot/commands/commands_precedence_spec.rb
 - spec/slack-ruby-bot/commands/commands_regexp_escape_spec.rb
 - spec/slack-ruby-bot/commands/commands_spaces_spec.rb
@@ -267,6 +268,7 @@ test_files:
 - spec/slack-ruby-bot/commands/aliases_spec.rb
 - spec/slack-ruby-bot/commands/bot_message_spec.rb
 - spec/slack-ruby-bot/commands/bot_spec.rb
+- spec/slack-ruby-bot/commands/commands_command_classes_spec.rb
 - spec/slack-ruby-bot/commands/commands_precedence_spec.rb
 - spec/slack-ruby-bot/commands/commands_regexp_escape_spec.rb
 - spec/slack-ruby-bot/commands/commands_spaces_spec.rb