Drop giphy dependency (#89)

* Drop giphy dependency
* Enable GIFs by default when giphy is installed

.travis.yml

@@ -2,5 +2,6 @@ rvm:
   - 2.3.0
 env:
   - CONCURRENCY=celluloid-io
+  - CONCURRENCY=celluloid-io WITH_GIPHY=true
   - CONCURRENCY=faye-websocket
-
+  - CONCURRENCY=faye-websocket WITH_GIPHY=true

CHANGELOG.md

@@ -1,6 +1,7 @@
 ### 0.8.3 (Next)
 
 * Your contribution here.
+* [#89](https://github.com/dblock/slack-ruby-bot/pull/89): Drop giphy dependency - [@tmsrjs](https://github.com/tmsrjs).
 
 ### 0.8.2 (7/10/2016)
 

Gemfile

@@ -3,3 +3,4 @@ source 'http://rubygems.org'
 gemspec
 
 gem ENV['CONCURRENCY'], require: false if ENV.key?('CONCURRENCY')
+gem 'giphy', require: false if ENV.key?('WITH_GIPHY')

README.md

@@ -210,11 +210,30 @@ class Phone < SlackRubyBot::Commands::Base
 end
 ```
 
-The `SlackRubyBot::Client` implementation comes with GIF support.
+### Animated GIFs
 
-#### say(channel: ..., text: ..., gif: ...)
+The `SlackRubyBot::Client` implementation comes with GIF support.  
+To enable it simply add `gem 'giphy'` to your **Gemfile**.  
+**Note:** Bots send animated GIFs in default commands and errors.
 
-Sends text and/or a random GIF that matches a keyword using a RealTime client to a channel.
+```ruby
+class Phone < SlackRubyBot::Commands::Base
+  command 'call'
+
+  def self.call(client, data, match)
+    client.say(channel: data.channel, text: 'called', gif: 'phone')
+    # Sends the text 'called' and a random GIF that matches the keyword 'phone'.
+  end
+end
+```
+
+If you use giphy for something else but don't want your bots to send GIFs you can set `ENV['SLACK_RUBY_BOT_SEND_GIFS']` or `SlackRubyBot::Config.send_gifs` to `false`. The latter takes precedence.
+
+```ruby
+SlackRubyBot.configure do |config|
+  config.send_gifs = false
+end
+```
 
 ### Built-In Commands
 
@@ -291,16 +310,6 @@ These will get pushed into the hook set on initialization.
 
 Either by configuration, explicit assignment or hook blocks, multiple handlers can exist for the same event type.
 
-### Disable Animated GIFs
-
-By default bots send animated GIFs in default commands and errors. To disable animated GIFs set `send_gifs` or `ENV['SLACK_RUBY_BOT_SEND_GIFS']` to `false`.
-
-```ruby
-SlackRubyBot.configure do |config|
-  config.send_gifs = false
-end
-```
-
 ### Message Loop Protection
 
 By default bots do not respond to their own messages. If you wish to change that behavior, set `allow_message_loops` to `true`.

UPGRADING.md

@@ -1,6 +1,13 @@
 Upgrading SlackRubyBot
 ======================
 
+### Upgrading to >= 0.8.3
+
+#### Add giphy to your Gemfile for GIF support
+
+The dependency on giphy was dropped, if you want GIF support you need to add `gem 'giphy'` to your **Gemfile**.
+You can ignore this if you had already disabled GIFs for your bot.
+
 ### Upgrading to >= 0.8.0
 
 #### Require a concurrency library

lib/config/boot.rb

@@ -4,4 +4,3 @@
 require 'active_support/core_ext'
 require 'hashie'
 require 'slack'
-require 'giphy'

lib/initializers/giphy.rb

@@ -1,5 +1,8 @@
-require 'giphy'
-
-Giphy::Configuration.configure do |config|
-  config.api_key = ENV['GIPHY_API_KEY'] || 'dc6zaTOxFJmzC' # from https://github.com/Giphy/GiphyAPI
+begin
+  require 'giphy'
+rescue LoadError
+else
+  Giphy::Configuration.configure do |config|
+    config.api_key = ENV['GIPHY_API_KEY'] || 'dc6zaTOxFJmzC' # from https://github.com/Giphy/GiphyAPI
+  end
 end

lib/slack-ruby-bot/client.rb

@@ -7,7 +7,7 @@ class Client < Slack::RealTime::Client
     def initialize(attrs = {})
       super(attrs)
       @aliases = attrs[:aliases]
-      @send_gifs = attrs.key?(:send_gifs) ? !!attrs[:send_gifs] : true
+      @send_gifs = attrs[:send_gifs]
     end
 
     def names
@@ -30,7 +30,8 @@ def name?(name)
     end
 
     def send_gifs?
-      send_gifs
+      return false unless defined?(Giphy)
+      send_gifs.nil? ? SlackRubyBot::Config.send_gifs? : send_gifs
     end
 
     def name
@@ -52,7 +53,7 @@ def say(options = {})
       rescue StandardError => e
         logger.warn "Giphy.random: #{e.message}"
         nil
-      end if SlackRubyBot::Config.send_gifs? && send_gifs? && keywords
+      end if keywords && send_gifs?
       text = [text, gif && gif.image_url.to_s].compact.join("\n")
       message({ text: text }.merge(options))
     end

lib/slack-ruby-bot/config.rb

@@ -10,8 +10,9 @@ def allow_message_loops?
     end
 
     def send_gifs?
+      return false unless defined?(Giphy)
       v = boolean_from_env('SLACK_RUBY_BOT_SEND_GIFS')
-      v.nil? ? (send_gifs.nil? || send_gifs) : v
+      send_gifs.nil? ? (v.nil? || v) : send_gifs
     end
 
     def reset!

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

@@ -2,8 +2,6 @@
 
 RSpec::Matchers.define :respond_with_error do |error, error_message|
   match do |actual|
-    allow(Giphy).to receive(:random)
-
     client = if respond_to?(:client)
                send(:client)
              else
@@ -13,6 +11,8 @@
     message_command = SlackRubyBot::Hooks::Message.new
     channel, user, message = parse(actual)
 
+    allow(Giphy).to receive(:random) if defined?(Giphy)
+
     begin
       expect do
         message_command.call(client, Hashie::Mash.new(text: message, channel: channel, user: user))

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

@@ -9,9 +9,9 @@
              end
 
     message_command = SlackRubyBot::Hooks::Message.new
-
     channel, user, message = parse(actual)
-    allow(Giphy).to receive(:random)
+
+    allow(Giphy).to receive(:random) if defined?(Giphy)
 
     expect(client).to receive(:message).with(channel: channel, text: expected)
     message_command.call(client, Hashie::Mash.new(text: message, channel: channel, user: user))

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

@@ -6,4 +6,8 @@
       c.user_id = 'DEADBEEF'
     end
   end
+
+  config.after :each do
+    SlackRubyBot::Config.reset!
+  end
 end

lib/slack-ruby-bot/server.rb

@@ -11,7 +11,7 @@ class Server
     def initialize(options = {})
       @token = options[:token]
       @aliases = options[:aliases]
-      @send_gifs = options.key?(:send_gifs) ? !!options[:send_gifs] : true
+      @send_gifs = options[:send_gifs]
 
       # Hook Handling
       flush_hook_blocks

slack-ruby-bot.gemspec

@@ -16,7 +16,6 @@ Gem::Specification.new do |s|
   s.summary = 'The easiest way to write a Slack bot in Ruby.'
   s.add_dependency 'hashie'
   s.add_dependency 'slack-ruby-client', '>= 0.6.0'
-  s.add_dependency 'giphy', '~> 2.0.2'
   s.add_development_dependency 'rake'
   s.add_development_dependency 'rspec'
   s.add_development_dependency 'rack-test'

spec/slack-ruby-bot/client_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+
+describe SlackRubyBot::Client do
+  describe '#send_gifs?' do
+    context 'without giphy is false', unless: ENV.key?('WITH_GIPHY') do
+      it 'by default' do
+        expect(subject.send_gifs?).to be false
+      end
+
+      it 'when set to true' do
+        subject.send_gifs = true
+        expect(subject.send_gifs?).to be false
+      end
+
+      it 'when set to true via config' do
+        SlackRubyBot::Config.send_gifs = true
+        expect(SlackRubyBot::Config.send_gifs?).to be false
+      end
+    end
+
+    context 'with giphy', if: ENV.key?('WITH_GIPHY') do
+      it 'default is true' do
+        expect(subject.send_gifs?).to be true
+      end
+
+      it 'defaults to SlackRubyBot::Config.send_gifs? if set' do
+        SlackRubyBot::Config.send_gifs = false
+        expect(subject.send_gifs?).to be false
+      end
+
+      it 'client setting takes precedence' do
+        SlackRubyBot::Config.send_gifs = true
+        subject.send_gifs = false
+        expect(subject.send_gifs?).to be false
+        SlackRubyBot::Config.send_gifs = false
+        subject.send_gifs = true
+        expect(subject.send_gifs?).to be true
+      end
+    end
+  end
+end

spec/slack-ruby-bot/commands/empty_text_spec.rb

@@ -11,7 +11,6 @@ def self.call(client, data, _match)
     end
   end
   it 'sends default text' do
-    allow(Giphy).to receive(:random)
     expect(message: "#{SlackRubyBot.config.user} empty_text", channel: 'channel', user: 'user').to respond_with_slack_message('')
   end
 end

spec/slack-ruby-bot/commands/message_loop_spec.rb

@@ -10,7 +10,6 @@ def app
 
   before do
     allow(client).to receive(:self).and_return(Hashie::Mash.new('id' => 'UDEADBEEF'))
-    allow(Giphy).to receive(:random)
   end
 
   context 'default' do
@@ -21,18 +20,10 @@ def app
   end
   context 'with allow_message_loops=true' do
     before do
-      SlackRubyBot.configure do |config|
-        config.allow_message_loops = true
-      end
-    end
-    after do
-      SlackRubyBot.configure do |config|
-        config.allow_message_loops = nil
-      end
+      SlackRubyBot::Config.allow_message_loops = true
     end
     it 'responds to self' do
-      expect(client).to receive(:message)
-      message_hook.call(client, Hashie::Mash.new(text: "#{SlackRubyBot.config.user} hi", channel: 'channel', user: 'UDEADBEEF'))
+      expect(message: "#{SlackRubyBot.config.user} hi").to respond_with_slack_message('Hi <@user>!')
     end
   end
 end

spec/slack-ruby-bot/commands/nil_message_spec.rb

@@ -16,7 +16,6 @@ def self.call(_client, data, _match)
   let(:message_hook) { SlackRubyBot::Hooks::Message.new }
 
   it 'ignores nil messages' do
-    allow(Giphy).to receive(:random)
     expect(client).to_not receive(:message)
     message_hook.call(client, Hashie::Mash.new(text: nil, channel: 'channel', user: 'user'))
   end

spec/slack-ruby-bot/commands/send_gif_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe SlackRubyBot::Commands do
+describe SlackRubyBot::Commands, if: ENV.key?('WITH_GIPHY') do
   let! :command do
     Class.new(SlackRubyBot::Commands::Base) do
       command 'send_gif_spec' do |client, data, _match|
@@ -10,6 +10,7 @@
   end
 
   let(:gif_image_url) { 'http://media2.giphy.com/media/pzOijFsdDrsS4/giphy.gif' }
+
   it 'sends a gif' do
     gif = Giphy::RandomGif.new('image_url' => gif_image_url)
     expect(Giphy).to receive(:random).and_return(gif)

spec/slack-ruby-bot/commands/send_message_with_gif_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe SlackRubyBot::Commands do
+describe SlackRubyBot::Commands, if: ENV.key?('WITH_GIPHY') do
   let! :command do
     Class.new(SlackRubyBot::Commands::Base) do
       command 'send_message_with_gif_spec' do |client, data, match|
@@ -16,7 +16,7 @@
     expect(message: "#{SlackRubyBot.config.user} send_message_with_gif_spec message").to respond_with_slack_message("message\n#{gif_image_url}")
   end
 
-  it 'eats up the error' do
+  it 'eats up errors' do
     expect(Giphy).to receive(:random) { raise 'oh no!' }
     expect(message: "#{SlackRubyBot.config.user} send_message_with_gif_spec message").to respond_with_slack_message('message')
   end
@@ -26,44 +26,14 @@
     expect(message: "#{SlackRubyBot.config.user} send_message_with_gif_spec message").to respond_with_slack_message('message')
   end
 
-  context 'send_gifs' do
-    context 'set to false via client' do
-      let(:client) { SlackRubyBot::Client.new }
-
-      before do
-        client.send_gifs = false
-      end
-
-      it 'does not send a gif' do
-        expect(Giphy).to_not receive(:random)
-        expect(message: "#{SlackRubyBot.config.user} send_message_with_gif_spec message").to respond_with_slack_message('message')
-      end
-    end
-
-    context 'set to false via config' do
-      before do
-        SlackRubyBot::Config.send_gifs = false
-      end
-      it 'does not send a gif' do
-        expect(Giphy).to_not receive(:random)
-        expect(message: "#{SlackRubyBot.config.user} send_message_with_gif_spec message").to respond_with_slack_message('message')
-      end
-      after do
-        SlackRubyBot::Config.reset!
-      end
+  context 'when client.send_gifs is false' do
+    let :client do
+      SlackRubyBot::Client.new.tap { |c| c.send_gifs = false }
     end
 
-    context 'set to false via SLACK_RUBY_BOT_SEND_GIFS' do
-      before do
-        ENV['SLACK_RUBY_BOT_SEND_GIFS'] = 'false'
-      end
-      it 'does not send a gif' do
-        expect(Giphy).to_not receive(:random)
-        expect(message: "#{SlackRubyBot.config.user} send_message_with_gif_spec message").to respond_with_slack_message('message')
-      end
-      after do
-        ENV.delete 'SLACK_RUBY_BOT_SEND_GIFS'
-      end
+    it 'does not send a gif' do
+      expect(Giphy).to_not receive(:random)
+      expect(message: "#{SlackRubyBot.config.user} send_message_with_gif_spec message").to respond_with_slack_message('message')
     end
   end
 end