lita-slack 1.0.5 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f17abc31f51924e4c36f96a2e4bfbdbb4ffd2d4f
-  data.tar.gz: 1df989c692141fcc9e052ffcd701fbefda6dcfb0
+  metadata.gz: 5f2cd3d13734b1d4f33b836c9c72a01b7bc6f2b9
+  data.tar.gz: b88e3e65f52bd8b0a8856d0bfa1af5f280a4a6ae
 SHA512:
-  metadata.gz: 5018da29c4758866976afc93ea3f649a27877b54ae1eb531e8f4af941b13e68e0f6793f3c157d6ff4b7885eddade956df031783d487c12604e8b76b08e00a2d2
-  data.tar.gz: 5c44dace1fa28b9af419a67d1718d104173d3ba7a3f397cf060467b5cbd1a174dbbd96d9e2c6da1b7881ebb69ed597fae3e331c723b5135ff1f96261ea70effd
+  metadata.gz: da158116c3b5e68c6f521d31220e9551ec09bc5e10026ab25eb24633039dd50ed71aa247237ead686c4cc0179ae53ffae86fa2441df0681e280631ffac2efcef
+  data.tar.gz: f2315307596784cc435e4cbc908a72faad4ae383ee0be4e58df522a6a93cd4955511519110459b329fda4f8ad47332011b505884187388e94a08879440168e82

data/.travis.yml

@@ -6,4 +6,10 @@ before_install:
   - gem update --system
 services:
   - redis-server
-
+branches:
+  except:
+    - /^v[0-9]/
+notifications:
+  webhooks:
+    urls:
+      - https://lita-freenode.herokuapp.com/travis

data/README.md

@@ -1,5 +1,8 @@
 # lita-slack
 
+[![Gem Version](https://badge.fury.io/rb/lita-slack.png)](http://badge.fury.io/rb/lita-slack)
+[![Build Status](https://travis-ci.org/kenjij/lita-slack.png?branch=master)](https://travis-ci.org/kenjij/lita-slack)
+
 **lita-slack** is an adapter for [Lita](https://www.lita.io/) that allows you to use the robot with [Slack](https://slack.com/). The current adapter is not compatible with pre-1.0.0 versions, as it now uses Slack's [Real Time Messaging API](https://api.slack.com/rtm).
 
 ## Installation
@@ -16,6 +19,10 @@ gem "lita-slack"
 
 * `token` (String) – The bot's Slack API token. Create a bot and get its token at https://my.slack.com/services/new/lita.
 
+### Optional attributes
+
+* `proxy` (String) – Specify a HTTP proxy URL. (e.g. "http://squid.example.com:3128")
+
 **Note**: When using lita-slack, the adapter will overwrite the bot's name and mention name with the values set on the server, so `config.robot.name` and `config.robot.mention_name` will have no effect.
 
 ### config.robot.admins

data/lib/lita/adapters/slack/api.rb

@@ -8,8 +8,8 @@ module Lita
   module Adapters
     class Slack < Adapter
       class API
-        def initialize(token, stubs = nil)
-          @token = token
+        def initialize(config, stubs = nil)
+          @config = config
           @stubs = stubs
         end
 
@@ -33,12 +33,12 @@ module Lita
         private
 
         attr_reader :stubs
-        attr_reader :token
+        attr_reader :config
 
         def call_api(method, post_data = {})
           response = connection.post(
             "https://slack.com/api/#{method}",
-            { token: token }.merge(post_data)
+            { token: config.token }.merge(post_data)
           )
 
           data = parse_response(response, method)
@@ -52,7 +52,11 @@ module Lita
           if stubs
             Faraday.new { |faraday| faraday.adapter(:test, stubs) }
           else
-            Faraday.new
+            options = {}
+            unless config.proxy.nil?
+              options = { proxy: config.proxy }
+            end
+            Faraday.new(options)
           end
         end
 

data/lib/lita/adapters/slack/rtm_connection.rb

@@ -14,14 +14,15 @@ module Lita
         MAX_MESSAGE_BYTES = 16_000
 
         class << self
-          def build(robot, token)
-            new(robot, token, API.new(token).rtm_start)
+          def build(robot, config)
+            new(robot, config, API.new(config).rtm_start)
           end
         end
 
-        def initialize(robot, token, team_data)
+        def initialize(robot, config, team_data)
           @robot = robot
-          @im_mapping = IMMapping.new(API.new(token), team_data.ims)
+          @config = config
+          @im_mapping = IMMapping.new(API.new(config), team_data.ims)
           @websocket_url = team_data.websocket_url
           @robot_id = team_data.self.id
 
@@ -32,14 +33,21 @@ module Lita
           im_mapping.im_for(user_id)
         end
 
-        def run(queue = nil)
+        def run(queue = nil, options = {})
           EM.run do
             log.debug("Connecting to the Slack Real Time Messaging API.")
-            @websocket = Faye::WebSocket::Client.new(websocket_url, nil, ping: 10)
+            @websocket = Faye::WebSocket::Client.new(
+              websocket_url,
+              nil,
+              websocket_options.merge(options)
+            )
 
             websocket.on(:open) { log.debug("Connected to the Slack Real Time Messaging API.") }
             websocket.on(:message) { |event| receive_message(event) }
-            websocket.on(:close) { log.info("Disconnected from Slack.") }
+            websocket.on(:close) do
+              log.info("Disconnected from Slack.")
+              shut_down
+            end
             websocket.on(:error) { |event| log.debug("WebSocket error: #{event.message}") }
 
             queue << websocket if queue
@@ -63,6 +71,7 @@ module Lita
 
         private
 
+        attr_reader :config
         attr_reader :im_mapping
         attr_reader :robot
         attr_reader :robot_id
@@ -97,6 +106,12 @@ module Lita
 
           payload
         end
+
+        def websocket_options
+          options = { ping: 10 }
+          options[:proxy] = { :origin => config.proxy } if config.proxy
+          options
+        end
       end
     end
   end

data/lib/lita/adapters/slack.rb

@@ -5,12 +5,13 @@ module Lita
     class Slack < Adapter
       # Required configuration attributes.
       config :token, type: String, required: true
+      config :proxy, type: String
 
       # Starts the connection.
       def run
         return if rtm_connection
 
-        @rtm_connection = RTMConnection.build(robot, config.token)
+        @rtm_connection = RTMConnection.build(robot, config)
         rtm_connection.run
       end
 

data/lita-slack.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name          = "lita-slack"
-  spec.version       = "1.0.5"
+  spec.version       = "1.1.0"
   spec.authors       = ["Ken J.", "Jimmy Cuadra"]
   spec.email         = ["kenjij@gmail.com", "jimmy@jimmycuadra.com"]
   spec.description   = %q{Lita adapter for Slack.}

data/spec/lita/adapters/slack/api_spec.rb

@@ -1,10 +1,15 @@
 require "spec_helper"
 
 describe Lita::Adapters::Slack::API do
-  subject { described_class.new(token, stubs) }
+  subject { described_class.new(config, stubs) }
 
   let(:http_status) { 200 }
   let(:token) { 'abcd-1234567890-hWYd21AmMH2UHAkx29vb5c1Y' }
+  let(:config) { Lita::Adapters::Slack.configuration_builder.build }
+
+  before do
+    config.token = token
+  end
 
   describe "#im_open" do
     let(:channel_id) { 'D024BFF1M' }

data/spec/lita/adapters/slack/rtm_connection_spec.rb

@@ -2,14 +2,14 @@ require "spec_helper"
 
 describe Lita::Adapters::Slack::RTMConnection, lita: true do
   def with_websocket(subject, queue)
-    thread = Thread.new { subject.run(queue) }
+    thread = Thread.new { subject.run(queue, ping: nil) }
     thread.abort_on_exception = true
     yield queue.pop
     subject.shut_down
     thread.join
   end
 
-  subject { described_class.new(robot, token, rtm_start_response) }
+  subject { described_class.new(robot, config, rtm_start_response) }
 
   let(:api) { instance_double("Lita::Adapters::Slack::API") }
   let(:registry) { Lita::Registry.new }
@@ -24,27 +24,33 @@ describe Lita::Adapters::Slack::RTMConnection, lita: true do
   end
   let(:token) { 'abcd-1234567890-hWYd21AmMH2UHAkx29vb5c1Y' }
   let(:queue) { Queue.new }
+  let(:proxy_url) { "http://foo:3128" }
+  let(:config) { Lita::Adapters::Slack.configuration_builder.build }
+
+  before do
+    config.token = token
+  end
 
   describe ".build" do
     before do
-      allow(Lita::Adapters::Slack::API).to receive(:new).with(token).and_return(api)
+      allow(Lita::Adapters::Slack::API).to receive(:new).with(config).and_return(api)
       allow(api).to receive(:rtm_start).and_return(rtm_start_response)
     end
 
     it "constructs a new RTMConnection with the results of rtm.start data" do
-      expect(described_class.build(robot, token)).to be_an_instance_of(described_class)
+      expect(described_class.build(robot, config)).to be_an_instance_of(described_class)
     end
 
     it "creates users with the results of rtm.start data" do
       expect(Lita::Adapters::Slack::UserCreator).to receive(:create_users)
 
-      described_class.build(robot, token)
+      described_class.build(robot, config)
     end
   end
 
   describe "#im_for" do
     before do
-      allow(Lita::Adapters::Slack::API).to receive(:new).with(token).and_return(api)
+      allow(Lita::Adapters::Slack::API).to receive(:new).with(config).and_return(api)
       allow(
         Lita::Adapters::Slack::IMMapping
       ).to receive(:new).with(api, []).and_return(im_mapping)
@@ -72,6 +78,28 @@ describe Lita::Adapters::Slack::RTMConnection, lita: true do
         expect(websocket).to be_an_instance_of(Faye::WebSocket::Client)
       end
     end
+
+    context "with a proxy server specified" do
+      before do
+        config.proxy = proxy_url
+      end
+
+      it "creates the WebSocket" do
+        with_websocket(subject, queue) do |websocket|
+          expect(websocket).to be_an_instance_of(Faye::WebSocket::Client)
+        end
+      end
+    end
+
+    context "when the WebSocket is closed" do
+      it "shuts down the reactor" do
+        with_websocket(subject, queue) do |websocket|
+          websocket.close
+
+          expect(EM.reactor_running?).to be_falsy
+        end
+      end
+    end
   end
 
   describe "#send_messages" do

data/spec/lita/adapters/slack_spec.rb

@@ -13,7 +13,7 @@ describe Lita::Adapters::Slack, lita: true do
 
     allow(
       described_class::RTMConnection
-    ).to receive(:build).with(robot, token).and_return(rtm_connection)
+    ).to receive(:build).with(robot, subject.config).and_return(rtm_connection)
     allow(rtm_connection).to receive(:run)
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lita-slack
 version: !ruby/object:Gem::Version
-  version: 1.0.5
+  version: 1.1.0
 platform: ruby
 authors:
 - Ken J.
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-26 00:00:00.000000000 Z
+date: 2015-01-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: eventmachine