lita-flowdock 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 838b561f440f09f8aa0979fdb4d3b13ba90d7977
-  data.tar.gz: 860cf748150b895e1f43084eb05817887e19ad2b
+  metadata.gz: da12f1db04490cd7aae9b115c0279377ca28adee
+  data.tar.gz: 2939919dbfc81e1f5d52f4d04f2cb3644b158ae9
 SHA512:
-  metadata.gz: bb8cc72b3421a7a4a64421bc40ac3ffd90313e6f1b8a00e64893c4aad1932e16e5514d1b503ce69dc88e03a1a7b57e996f42281cd0b320784be939b9cfca5ce4
-  data.tar.gz: 517866c822c741dfbe6c3e627216c835aa4fc1f1dd1ab8460f106934d3ff22eb889a5a20e94799c1a68ee3d24719e70619d90d65f0abc8f4884d3d319f73db03
+  metadata.gz: d5836b2e3558a090f8f71976874ae0825f32566510b4658837cb3ffe8c04dd6e4e30bda07f4e54865d12af114ebb6d6bbe89711246ab619bc9f392e7b004776f
+  data.tar.gz: d2d4f7094d1dc4610a3ba72f554f9775e9ddea01e90af6eca6c4e95f1c6bd3f4f905728439012c9aa622b6953d5923cad83c98628c489c7fcf90e39c1cc5dffd

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+### v0.2.0
+
+* add option to thread responses in Flowdock
+ * enabled by default
+ * disable by setting `config.adapters.flowdock.thread_responses = :disabled`

data/GETTING_STARTED.md

@@ -41,7 +41,7 @@ Lita.configure do |config|
   config.robot.mention_name = "!"
   config.robot.log_level = :debug
   config.robot.adapter = :flowdock
-  config.adapters.flowdock.api_key = "$FLOWDOCK_API_TOKEN"
+  config.adapters.flowdock.api_token = "$FLOWDOCK_API_TOKEN"
   config.adapters.flowdock.organization = "$ORG"
   config.adapters.flowdock.flows = ["$FLOW_NAME"]
 end

data/README.md

@@ -33,6 +33,12 @@ For quick setup, see the [Getting Started](https://github.com/bhouse/lita-flowdo
 * `organization` (String) - The organization for the flowdock account
 * `flows` (Array) - Array of flows the bot should connect to, i.e. `main`
 
+### Optional Attributes
+* `thread_responses` (Symbol) - Respond to the original message in a Flowdock
+  thread
+ * default: `:enabled`
+ * other values: `:disabled`
+
 ### Example
 
 #### lita_config.rb

data/lib/lita/adapters/flowdock.rb

@@ -9,6 +9,7 @@ module Lita
       config :api_token, type: String, required: true
       config :organization, type: String, required: true
       config :flows, type: Array, required: true
+      config :thread_responses, type: Symbol, required: false, default: :enabled
 
 
       def mention_format(name)
@@ -25,20 +26,19 @@ module Lita
         )
 
         connector.run
-      rescue Interrupt
-        shut_down
       end
 
       def shut_down
         return unless connector
         connector.shut_down
-      rescue RuntimeError
-        robot.trigger(:disconnected)
-        log.info('Disconnected')
       end
 
       def send_messages(target, messages)
-        connector.send_messages(target.room, messages)
+        if config.thread_responses.eql?(:enabled)
+          connector.send_messages(target.room, messages, target.message_id)
+        else
+          connector.send_messages(target.room, messages)
+        end
       end
 
       private

data/lib/lita/adapters/flowdock/connector.rb

@@ -16,14 +16,16 @@ module Lita
           @flows = flows
           @client =
             flowdock_client || ::Flowdock::Client.new(api_token: api_token)
+          @stream_url =
+            "https://#{api_token}@stream.flowdock.com/flows?filter=#{request_flows}"
 
           UsersCreator.create_users(client.get('/users'))
         end
 
-        def run
+        def run(url=stream_url, queue=nil)
           EM.run do
             @source = EventMachine::EventSource.new(
-              "https://#{api_token}@stream.flowdock.com/flows?filter=#{request_flows}",
+              url,
               {query: 'text/event-stream'},
               {'Accept' => 'text/event-stream'}
             )
@@ -39,27 +41,34 @@ module Lita
             end
 
             source.error do |error|
-              log.error(error.inspect)
-              EM.stop
+              log.error(error)
+              robot.trigger(:disconnected)
+              log.info('Disconnected')
             end
 
             source.start
+            queue << source if queue
           end
         end
 
-        def send_messages(target, messages)
+        def send_messages(target, messages, message_id = nil)
           messages.each do |message|
-            client.chat_message(flow: target, content: message)
+            client.chat_message(
+              flow: target,
+              content: message,
+              message: message_id
+            )
           end
         end
 
         def shut_down
           source.close
+          EM.stop if EM.reactor_running?
         end
 
         private
           attr_reader :robot, :api_token, :organization, :flows, :source,
-            :client
+            :client, :stream_url
 
           def log
             Lita.logger

data/lib/lita/adapters/flowdock/message_handler.rb

@@ -1,4 +1,5 @@
 require 'lita/adapters/flowdock/users_creator'
+require 'lita/source/flowdock_source'
 
 module Lita
   module Adapters
@@ -33,7 +34,7 @@ module Lita
           end
 
           def dispatch_message(user)
-            source = Source.new(user: user, room: flow)
+            source = FlowdockSource.new(user: user, room: flow, message_id: id)
             message = Message.new(robot, body, source)
             robot.receive(message)
           end
@@ -42,6 +43,10 @@ module Lita
             data['flow']
           end
 
+          def id
+            data['id']
+          end
+
           def from_self?(user)
             user.id.to_i == robot_id
           end

data/lib/lita/source/flowdock_source.rb

@@ -0,0 +1,10 @@
+module Lita
+  class FlowdockSource < Source
+    attr_reader :message_id
+
+    def initialize(user: nil, room: nil, private_message: false, message_id: nil)
+      super(user: user, room: room, private_message: private_message)
+      @message_id = message_id
+    end
+  end
+end

data/lita-flowdock.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name          = "lita-flowdock"
-  spec.version       = "0.1.2"
+  spec.version       = "0.2.0"
   spec.authors       = ["Ben House"]
   spec.email         = ["ben@benhouse.io"]
   spec.description   = %q{flowdock adapter for lita.io}

data/spec/lita/adapters/flowdock/connector_spec.rb

@@ -1,7 +1,17 @@
 require 'spec_helper'
 
 describe Lita::Adapters::Flowdock::Connector, lita: true do
-  subject { described_class }
+  def with_eventsource(subject, queue)
+    thread = Thread.new { subject.run(url, queue) }
+    thread.abort_on_exception = true
+    yield queue.pop
+    subject.shut_down
+    thread.join
+  end
+
+    subject {
+      described_class.new(robot, api_token, organization, flows, fd_client)
+    }
 
   let(:registry) { Lita::Registry.new }
   let(:robot) { Lita::Robot.new(registry) }
@@ -10,8 +20,12 @@ describe Lita::Adapters::Flowdock::Connector, lita: true do
   let(:flows) { ['testing'] }
   let(:fd_client) { instance_double('Flowdock::Client') }
   let(:users) { [ user_hash(1), user_hash(2) ] }
+  let(:queue) { Queue.new }
+  let(:url) { "http://example.com" }
 
   describe "#new" do
+    subject { described_class }
+
     it "creates users" do
       expect(fd_client).to receive(:get).with('/users').and_return(users)
       expect(Lita::Adapters::Flowdock::UsersCreator).to receive(
@@ -22,22 +36,35 @@ describe Lita::Adapters::Flowdock::Connector, lita: true do
   end
 
   describe "#run" do
+    before do
+      allow(fd_client).to receive(:get).with('/users').and_return([])
+    end
+
+    it "starts the reactor" do
+      with_eventsource(subject, queue) do
+        expect(EM.reactor_running?).to be_truthy
+      end
+    end
+
+    it "creates the event source" do
+      with_eventsource(subject, queue) do |source|
+        expect(source).to be_an_instance_of(EventMachine::EventSource)
+      end
+    end
   end
 
   describe "#send_messages" do
     let(:target) { 'testing:lita-test' }
     let(:message) { 'foo' }
-    subject {
-      described_class.new(robot, api_token, organization, flows, fd_client)
-    }
+    let(:message_id) { 1234 }
 
     before do
       allow(fd_client).to receive(:get).with('/users').and_return(users)
     end
 
     it "sends messages" do
-      expect(fd_client).to receive(:chat_message).with(flow: target, content: message)
-      subject.send_messages(target, [message])
+      expect(fd_client).to receive(:chat_message).with(flow: target, content: message, message: message_id)
+      subject.send_messages(target, [message], message_id)
     end
   end
 end

data/spec/lita/adapters/flowdock/message_handler_spec.rb

@@ -25,23 +25,26 @@ describe Lita::Adapters::Flowdock::MessageHandler, lita: true do
 
   describe "#handle" do
     context "a normal message" do
+      let(:id) { 2345 }
       let(:data) do
         {
           'content' => 'Hello World!',
           'event'   => 'message',
           'flow'    => test_flow,
+          'id'      => id,
           'user'    => test_user_id
         }
       end
       let(:message) { instance_double('Lita::Message', command!: false) }
-      let(:source) { instance_double('Lita::Source', private_message?: false) }
+      let(:source) { instance_double('Lita::FlowdockSource', private_message?: false, message_id: id) }
       let(:user) { user_double(test_user_id) }
 
       before do
         allow(Lita::User).to receive(:find_by_id).and_return(user)
-        allow(Lita::Source).to receive(:new).with(
+        allow(Lita::FlowdockSource).to receive(:new).with(
           user: user,
-          room: test_flow
+          room: test_flow,
+          message_id: id
         ).and_return(source)
         allow(Lita::Message).to receive(:new).with(
           robot, 'Hello World!', source).and_return(message)
@@ -60,6 +63,7 @@ describe Lita::Adapters::Flowdock::MessageHandler, lita: true do
             'event'   => 'message',
             'flow'    => test_flow,
             'user'    => test_user_id,
+            'id'      => id
           }
         end
 

data/spec/lita/adapters/flowdock_spec.rb

@@ -45,17 +45,30 @@ describe Lita::Adapters::Flowdock, lita: true do
   end
 
   describe "#send_messages" do
-    let(:room_source) { Lita::Source.new(room: '1234abcd') }
+    let(:id) { 8888 }
+    let(:room_source) { Lita::FlowdockSource.new(room: '1234abcd', message_id: id) }
     let(:user) { Lita::User.new('987654') }
     let(:user_source) { Lita::Source.new(user: user) }
 
     it "sends messages to flows" do
-      expect(connector).to receive(:send_messages).with(room_source.room, ['foo'])
+      expect(connector).to receive(:send_messages).with(room_source.room, ['foo'], room_source.message_id)
 
       subject.run
 
       subject.send_messages(room_source, ['foo'])
     end
+
+    context "with thread_responses disabled" do
+      before do
+        registry.config.adapters.flowdock.thread_responses = :disabled
+      end
+
+      it "sends messages to flow without the original message id" do
+        expect(connector).to receive(:send_messages).with(room_source.room, ['foo'])
+        subject.run
+        subject.send_messages(room_source, ['foo'])
+      end
+    end
   end
 
   describe "#shut_down" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lita-flowdock
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Ben House
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-08 00:00:00.000000000 Z
+date: 2015-03-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lita
@@ -173,6 +173,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".travis.yml"
+- CHANGELOG.md
 - GETTING_STARTED.md
 - Gemfile
 - LICENSE
@@ -183,6 +184,7 @@ files:
 - lib/lita/adapters/flowdock/connector.rb
 - lib/lita/adapters/flowdock/message_handler.rb
 - lib/lita/adapters/flowdock/users_creator.rb
+- lib/lita/source/flowdock_source.rb
 - lita-flowdock.gemspec
 - locales/en.yml
 - spec/lita/adapters/flowdock/connector_spec.rb