slack-ruby-bot 0.1.0

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

@@ -0,0 +1,9 @@
+module SlackRubyBot
+  module Commands
+    class Default < Base
+      def self.call(data, _command, _arguments)
+        send_message_with_gif data.channel, SlackRubyBot::ABOUT, 'selfie'
+      end
+    end
+  end
+end

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

@@ -0,0 +1,27 @@
+module SlackRubyBot
+  module Commands
+    class Base
+      def self.send_message(channel, text)
+        Slack.chat_postMessage(channel: channel, text: text)
+      end
+
+      def self.send_message_with_gif(channel, text, keywords)
+        gif = begin
+          Giphy.random(keywords)
+        rescue StandardError => e
+          logger.warn "Giphy.random: #{e.message}"
+          nil
+        end
+        text = text + "\n" + gif.image_url.to_s if gif
+        send_message channel, text
+      end
+
+      def self.logger
+        @logger ||= begin
+          $stdout.sync = true
+          Logger.new(STDOUT)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,9 @@
+module SlackRubyBot
+  module Commands
+    class Help < Base
+      def self.call(data, _command, _arguments)
+        send_message_with_gif data.channel, 'See https://github.com/dblock/slack-ruby-bot, please.', 'help'
+      end
+    end
+  end
+end

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

@@ -0,0 +1,9 @@
+module SlackRubyBot
+  module Commands
+    class Hi < Base
+      def self.call(data, _command, _arguments)
+        send_message_with_gif data.channel, "Hi <@#{data.user}>!", 'hi'
+      end
+    end
+  end
+end

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

@@ -0,0 +1,9 @@
+module SlackRubyBot
+  module Commands
+    class Unknown < Base
+      def self.call(data, _command, _arguments)
+        send_message_with_gif data.channel, "Sorry <@#{data.user}>, I don't understand that command!", 'idiot'
+      end
+    end
+  end
+end

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

@@ -0,0 +1,5 @@
+require 'slack-ruby-bot/commands/base'
+require 'slack-ruby-bot/commands/about'
+require 'slack-ruby-bot/commands/help'
+require 'slack-ruby-bot/commands/hi'
+require 'slack-ruby-bot/commands/unknown'

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

@@ -0,0 +1,13 @@
+module SlackRubyBot
+  module Config
+    extend self
+
+    attr_accessor :token
+    attr_accessor :url
+    attr_accessor :user
+    attr_accessor :user_id
+    attr_accessor :team
+    attr_accessor :team_id
+    attr_accessor :secret
+  end
+end

data/lib/slack-ruby-bot/fixtures/slack/auth_test.yml

@@ -0,0 +1,48 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://slack.com/api/auth.test
+    body:
+      encoding: UTF-8
+      string: token=test
+    headers:
+      Accept:
+      - application/json; charset=utf-8
+      User-Agent:
+      - Slack Ruby Gem 1.1.6
+      Content-Type:
+      - application/x-www-form-urlencoded
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Access-Control-Allow-Origin:
+      - "*"
+      Content-Type:
+      - application/json; charset=utf-8
+      Date:
+      - Thu, 02 Jul 2015 17:55:20 GMT
+      Server:
+      - Apache
+      Strict-Transport-Security:
+      - max-age=31536000; includeSubDomains; preload
+      Vary:
+      - Accept-Encoding
+      X-Content-Type-Options:
+      - nosniff
+      X-Xss-Protection:
+      - '0'
+      Content-Length:
+      - '55'
+      Connection:
+      - keep-alive
+    body:
+      encoding: UTF-8
+      string: '{"ok":false,"error":"invalid_auth"}'
+    http_version: 
+  recorded_at: Thu, 02 Jul 2015 17:55:48 GMT
+recorded_with: VCR 2.9.3

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

@@ -0,0 +1,10 @@
+module SlackRubyBot
+  module Hooks
+    module Base
+      def included(caller)
+        caller.hooks ||= []
+        caller.hooks << name.demodulize.underscore.to_sym
+      end
+    end
+  end
+end

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

@@ -0,0 +1,11 @@
+module SlackRubyBot
+  module Hooks
+    module Hello
+      extend Base
+
+      def hello(_data)
+        logger.info "Successfully connected to #{SlackRubyBot.config.url}."
+      end
+    end
+  end
+end

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

@@ -0,0 +1,41 @@
+module SlackRubyBot
+  module Hooks
+    module Message
+      extend Base
+
+      def message(data)
+        data = Hashie::Mash.new(data)
+        bot_name, command, arguments = parse_command(data.text)
+        return unless bot_name == SlackRubyBot.config.user
+        klass = command_to_class(command || 'Default')
+        klass.call data, command, arguments
+      end
+
+      private
+
+      def parse_command(text)
+        return unless text
+        text = '= ' + text[1..text.length] if text[0] == '='
+        parts = text.split.reject(&:blank?)
+        if parts && parts[0] == '='
+          parts[0] = SlackRubyBot.config.user
+          parts.insert 1, 'calculate'
+        end
+        [parts.first.downcase, parts[1].try(:downcase), parts[2..parts.length]] if parts && parts.any?
+      end
+
+      def command_classes(include_slack_ruby_bot = false)
+        klasses = SlackRubyBot::Commands::Base.descendants
+        klasses.reject! { |k| k.name.starts_with? 'SlackRubyBot::Commands::' } unless include_slack_ruby_bot
+        klasses
+      end
+
+      def command_to_class(command)
+        # prioritize implementations to built-in classes
+        klass = command_classes.detect { |d| d.name.ends_with? "::#{command.titleize}" }
+        klass ||= command_classes(true).detect { |d| d.name.ends_with? "::#{command.titleize}" }
+        klass || SlackRubyBot::Commands::Unknown
+      end
+    end
+  end
+end

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

@@ -0,0 +1,3 @@
+require 'slack-ruby-bot/hooks/base'
+require 'slack-ruby-bot/hooks/hello'
+require 'slack-ruby-bot/hooks/message'

data/lib/slack-ruby-bot/rspec/fixtures/slack/auth_test.yml

@@ -0,0 +1,48 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://slack.com/api/auth.test
+    body:
+      encoding: UTF-8
+      string: token=test
+    headers:
+      Accept:
+      - application/json; charset=utf-8
+      User-Agent:
+      - Slack Ruby Gem 1.1.6
+      Content-Type:
+      - application/x-www-form-urlencoded
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Access-Control-Allow-Origin:
+      - "*"
+      Content-Type:
+      - application/json; charset=utf-8
+      Date:
+      - Thu, 02 Jul 2015 17:48:15 GMT
+      Server:
+      - Apache
+      Strict-Transport-Security:
+      - max-age=31536000; includeSubDomains; preload
+      Vary:
+      - Accept-Encoding
+      X-Content-Type-Options:
+      - nosniff
+      X-Xss-Protection:
+      - '0'
+      Content-Length:
+      - '55'
+      Connection:
+      - keep-alive
+    body:
+      encoding: UTF-8
+      string: '{"ok":false,"error":"invalid_auth"}'
+    http_version: 
+  recorded_at: Thu, 02 Jul 2015 17:48:42 GMT
+recorded_with: VCR 2.9.3

data/lib/slack-ruby-bot/rspec/support/fixtures/slack/auth_test.yml

@@ -0,0 +1,103 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://slack.com/api/auth.test
+    body:
+      encoding: UTF-8
+      string: token=token
+    headers:
+      Accept:
+      - application/json; charset=utf-8
+      User-Agent:
+      - Slack Ruby Gem 1.1.1
+      Content-Type:
+      - application/x-www-form-urlencoded
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Access-Control-Allow-Origin:
+      - '*'
+      Cache-Control:
+      - private, no-cache, no-store, must-revalidate
+      Content-Type:
+      - application/json; charset=utf-8
+      Date:
+      - Tue, 28 Apr 2015 12:55:23 GMT
+      Expires:
+      - Mon, 26 Jul 1997 05:00:00 GMT
+      Pragma:
+      - no-cache
+      Server:
+      - Apache
+      Strict-Transport-Security:
+      - max-age=31536000; includeSubDomains; preload
+      Vary:
+      - Accept-Encoding
+      X-Accepted-Oauth-Scopes:
+      - identify
+      X-Content-Type-Options:
+      - nosniff
+      X-Oauth-Scopes:
+      - identify,read,post,client
+      X-Xss-Protection:
+      - '0'
+      Content-Length:
+      - '128'
+      Connection:
+      - keep-alive
+    body:
+      encoding: UTF-8
+      string: '{"ok":true,"url":"https:\/\/rubybot.slack.com\/","team":"team","user":"user","team_id":"TDEADBEEF","user_id":"UBAADFOOD"}'
+    http_version:
+  recorded_at: Tue, 28 Apr 2015 12:55:22 GMT
+- request:
+    method: post
+    uri: https://slack.com/api/rtm.start
+    body:
+      encoding: UTF-8
+      string: token=token
+    headers:
+      Accept:
+      - application/json; charset=utf-8
+      User-Agent:
+      - Slack Ruby Gem 1.1.1
+      Content-Type:
+      - application/x-www-form-urlencoded
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Access-Control-Allow-Origin:
+      - '*'
+      Content-Type:
+      - application/json; charset=utf-8
+      Date:
+      - Tue, 28 Apr 2015 21:41:33 GMT
+      Server:
+      - Apache
+      Strict-Transport-Security:
+      - max-age=31536000; includeSubDomains; preload
+      Vary:
+      - Accept-Encoding
+      X-Content-Type-Options:
+      - nosniff
+      X-Xss-Protection:
+      - '0'
+      Content-Length:
+      - '55'
+      Connection:
+      - keep-alive
+    body:
+      encoding: UTF-8
+      string: '{"ok":false,"error":"invalid_auth"}'
+    http_version:
+  recorded_at: Tue, 28 Apr 2015 21:41:33 GMT
+recorded_with: VCR 2.9.3

data/lib/slack-ruby-bot/rspec/support/slack-ruby-bot/it_behaves_like_a_slack_bot.rb

@@ -0,0 +1,27 @@
+shared_examples 'a slack ruby bot' do
+  context 'not configured' do
+    before do
+      @slack_api_token = ENV.delete('SLACK_API_TOKEN')
+    end
+    after do
+      ENV['SLACK_API_TOKEN'] = @slack_api_token
+    end
+    it 'requires SLACK_API_TOKEN' do
+      expect { subject }.to raise_error RuntimeError, "Missing ENV['SLACK_API_TOKEN']."
+    end
+  end
+  context 'configured', vcr: { cassette_name: 'auth_test' } do
+    context 'run' do
+      before do
+        subject.send(:auth!)
+      end
+      it 'succeeds auth' do
+        expect(subject.config.url).to eq 'https://rubybot.slack.com/'
+        expect(subject.config.team).to eq 'team'
+        expect(subject.config.user).to eq 'user'
+        expect(subject.config.team_id).to eq 'TDEADBEEF'
+        expect(subject.config.user_id).to eq 'UBAADFOOD'
+      end
+    end
+  end
+end

data/lib/slack-ruby-bot/rspec/support/slack-ruby-bot/respond_with_error.rb

@@ -0,0 +1,31 @@
+require 'rspec/expectations'
+
+RSpec::Matchers.define :respond_with_error do |expected|
+  match do |actual|
+    channel, user, message = parse(actual)
+    app = SlackRubyBot::App.new
+    SlackRubyBot.config.user = 'rubybot'
+    allow(Giphy).to receive(:random)
+    begin
+      expect do
+        app.send(:message, text: message, channel: channel, user: user)
+      end.to raise_error ArgumentError, expected
+    rescue RSpec::Expectations::ExpectationNotMetError => e
+      @error_message = e.message
+      raise e
+    end
+    true
+  end
+
+  failure_message do |actual|
+    _, _, message = parse(actual)
+    @error_message || "expected for '#{message}' to fail with '#{expected}'"
+  end
+
+  private
+
+  def parse(actual)
+    actual = { message: actual } unless actual.is_a?(Hash)
+    [actual[:channel] || 'channel', actual[:user] || 'user', actual[:message]]
+  end
+end

data/lib/slack-ruby-bot/rspec/support/slack-ruby-bot/respond_with_slack_message.rb

@@ -0,0 +1,19 @@
+require 'rspec/expectations'
+
+RSpec::Matchers.define :respond_with_slack_message do |expected|
+  match do |actual|
+    channel, user, message = parse(actual)
+    SlackRubyBot.config.user ||= 'rubybot'
+    allow(Giphy).to receive(:random)
+    expect(SlackRubyBot::Commands::Base).to receive(:send_message).with(channel, expected)
+    app.send(:message, text: message, channel: channel, user: user)
+    true
+  end
+
+  private
+
+  def parse(actual)
+    actual = { message: actual } unless actual.is_a?(Hash)
+    [actual[:channel] || 'channel', actual[:user] || 'user', actual[:message]]
+  end
+end

data/lib/slack-ruby-bot/rspec/support/slack_api_key.rb

@@ -0,0 +1,5 @@
+RSpec.configure do |config|
+  config.before :all do
+    ENV['SLACK_API_TOKEN'] ||= 'test'
+  end
+end

data/lib/slack-ruby-bot/rspec/support/slack_ruby_bot_configure.rb

@@ -0,0 +1,4 @@
+SlackRubyBot.configure do |config|
+  config.token = 'testtoken'
+  config.user = 'rubybot'
+end

data/lib/slack-ruby-bot/rspec/support/vcr.rb

@@ -0,0 +1,8 @@
+require 'vcr'
+
+VCR.configure do |config|
+  config.cassette_library_dir = File.join(File.dirname(__FILE__), 'fixtures/slack')
+  config.hook_into :webmock
+  # config.default_cassette_options = { record: :new_episodes }
+  config.configure_rspec_metadata!
+end

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

@@ -0,0 +1,12 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..'))
+
+require 'rubygems'
+require 'rspec'
+require 'rack/test'
+
+require 'config/environment'
+require 'slack-ruby-bot'
+
+Dir[File.join(File.dirname(__FILE__), 'rspec/support', '**/*.rb')].each do |file|
+  require file
+end

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

@@ -0,0 +1,3 @@
+module SlackRubyBot
+  VERSION = '0.1.0'
+end

data/lib/slack-ruby-bot.rb

@@ -0,0 +1,20 @@
+require File.expand_path('../config/environment', __FILE__)
+
+require 'slack-ruby-bot/version'
+require 'slack-ruby-bot/about'
+require 'slack-ruby-bot/config'
+require 'slack-ruby-bot/hooks'
+require 'slack-ruby-bot/commands'
+require 'slack-ruby-bot/app'
+
+module SlackRubyBot
+  class << self
+    def configure
+      block_given? ? yield(Config) : Config
+    end
+
+    def config
+      Config
+    end
+  end
+end

data/lib/slack_ruby_bot.rb

@@ -0,0 +1 @@
+require 'slack-ruby-bot'

data/slack-ruby-bot.gemspec

@@ -0,0 +1,27 @@
+$LOAD_PATH.push File.expand_path('../lib', __FILE__)
+require 'slack-ruby-bot/version'
+
+Gem::Specification.new do |s|
+  s.name = 'slack-ruby-bot'
+  s.version = SlackRubyBot::VERSION
+  s.authors = ['Daniel Doubrovkine']
+  s.email = 'dblock@dblock.org'
+  s.platform = Gem::Platform::RUBY
+  s.required_rubygems_version = '>= 1.3.6'
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- spec/*`.split("\n")
+  s.require_paths = ['lib']
+  s.homepage = 'http://github.com/dblock/slack-ruby-bot'
+  s.licenses = ['MIT']
+  s.summary = 'Generic bot framework written in Ruby.'
+  s.add_dependency 'hashie'
+  s.add_dependency 'slack-api', '~> 1.1.6'
+  s.add_dependency 'activesupport'
+  s.add_dependency 'giphy', '~> 2.0.2'
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'rack-test'
+  s.add_development_dependency 'vcr'
+  s.add_development_dependency 'webmock'
+  s.add_development_dependency 'rubocop', '0.32.1'
+end

data/spec/slack-ruby-bot/app_spec.rb

@@ -0,0 +1,8 @@
+require 'spec_helper'
+
+describe SlackRubyBot::App do
+  def app
+    SlackRubyBot::App.new
+  end
+  it_behaves_like 'a slack ruby bot'
+end

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

@@ -0,0 +1,16 @@
+require 'spec_helper'
+
+describe SlackRubyBot::Commands::Default do
+  def app
+    SlackRubyBot::App.new
+  end
+  before do
+    app.config.user = 'rubybot'
+  end
+  it 'rubybot' do
+    expect(message: 'rubybot').to respond_with_slack_message(SlackRubyBot::ABOUT)
+  end
+  it 'Rubybot' do
+    expect(message: 'Rubybot').to respond_with_slack_message(SlackRubyBot::ABOUT)
+  end
+end

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

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+describe SlackRubyBot::Commands::Help do
+  def app
+    SlackRubyBot::App.new
+  end
+  before do
+    app.config.user = 'rubybot'
+  end
+  it 'help' do
+    expect(message: 'rubybot help').to respond_with_slack_message('See https://github.com/dblock/slack-ruby-bot, please.')
+  end
+end

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

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+describe SlackRubyBot::Commands::Hi do
+  def app
+    SlackRubyBot::App.new
+  end
+  before do
+    app.config.user = 'rubybot'
+  end
+  it 'says hi' do
+    expect(message: 'rubybot hi').to respond_with_slack_message('Hi <@user>!')
+  end
+end

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

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+describe SlackRubyBot::Commands::Unknown, vcr: { cassette_name: 'user_info' } do
+  def app
+    SlackRubyBot::App.new
+  end
+  before do
+    app.config.user = 'rubybot'
+  end
+  it 'invalid command' do
+    expect(message: 'rubybot foobar').to respond_with_slack_message("Sorry <@user>, I don't understand that command!")
+  end
+  it 'does not respond to sad face' do
+    expect(SlackRubyBot::Commands::Base).to_not receive(:send_message)
+    SlackRubyBot::App.new.send(:message, text: ':((')
+  end
+end

data/spec/slack-ruby-bot/version_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe SlackRubyBot do
+  it 'has a version' do
+    expect(SlackRubyBot::VERSION).to_not be nil
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require 'slack-ruby-bot/rspec'