lita-campfire 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f3d87d9a72b0fb2b3a0946d8726e5d7d203af62c
-  data.tar.gz: 08132be5b307927c3be6dfcbecde8557de5815c9
+  metadata.gz: 711b381aa5f58bc007ea46b6e7dca13f856fe4ad
+  data.tar.gz: 503b935c87bc152db95400c2c52aa2629d640334
 SHA512:
-  metadata.gz: a16ec0f3f7408fdb2ef4fc292ed7dcff1fa4cb62570f7d1ec8377925ef4824d65197fb509c3601ac4158b51b0bebb886f43bfceccd1a01448736147968191de1
-  data.tar.gz: a0336c226895101714e01cb3162877c60b7dad05b53f51e4cfa04a1160c44a9243f04b78b4881614259da89a8711b5582c08cc33220ddd379e5976bdae8f27c6
+  metadata.gz: a9c7cf1f3614b76e0487aeded9bfc31a5d89d624d28b2e8b5da90074a519e637d2c4886c933432b1edbb648a9f1246f43c55767030c10c3c4b6e7a7f6782d53b
+  data.tar.gz: 89750d635765c465bb5d871c27951e40e16852d629a3d325d4b6d343798fd66af5a2c1937fcbaa7e61635e04e46d8dece6b4f782da4b9e8c9b095977132fd7c1

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    lita-campfire (0.1.3)
+    lita-campfire (0.1.4)
       lita (~> 2.7.0)
       tinder (~> 1.9.0)
 

data/README.md

@@ -1,7 +1,6 @@
 # Campfire adapter for Lita
 
-## Continuous Integration
-
+[![Gem Version](https://badge.fury.io/rb/lita-campfire.png)](http://badge.fury.io/rb/lita-campfire)
 [![Build Status](https://secure.travis-ci.org/josacar/lita-campfire.png)](http://travis-ci.org/josacar/lita-campfire)
 [![Coverage Status](https://coveralls.io/repos/josacar/lita-campfire/badge.png)](https://coveralls.io/r/josacar/lita-campfire)
 [![Code Climate](https://codeclimate.com/github/josacar/lita-campfire.png)](https://codeclimate.com/github/josacar/lita-campfire)
@@ -36,6 +35,7 @@ Values needed to work like apikey can be found on 'My info' link when logged, su
 ### Optional attributes
 
 * `debug` (Boolean) - If `true`, turns on the underlying Campfire library's (tinder) logger, which is fairly verbose. Default: `false`.
+* `tinder_options` (Hash) - If set passes the options to tinder listen method when called
 
 **Note** You must set also `config.robot.name` and `config.robot.mention_name` to work.
 
@@ -59,6 +59,7 @@ Lita.configure do |config|
   config.adapter.apikey = ENV["CAMPFIRE_APIKEY"]
   config.adapter.rooms = ENV["CAMPFIRE_ROOMS"].split(',')
   config.adapter.debug = false
+  config.adapter.tinder_options = { timeout: 30, user_agent: 'lita-campfire' }
 
   config.redis.url = ENV["REDISTOGO_URL"]
   config.http.port = ENV["PORT"]

data/lib/lita/adapters/campfire.rb

@@ -2,18 +2,24 @@ module Lita
   module Adapters
     class Campfire < Adapter
       require_configs :subdomain, :apikey, :rooms
+      OPTIONAL_CONFIG_OPTIONS = %i(debug tinder_options)
 
       attr_reader :connector
 
       def initialize(robot)
         super
 
-        @connector = Connector.new(
-          robot,
+        options = {
           subdomain: config.subdomain,
           apikey: config.apikey,
           rooms: rooms,
-          debug: config.debug
+        }
+
+        options.merge!(optional_config_options)
+
+        @connector = Connector.new(
+          robot,
+          options
         )
       end
 
@@ -50,6 +56,13 @@ module Lita
       def disconnect
         connector.disconnect
       end
+
+      def optional_config_options
+        OPTIONAL_CONFIG_OPTIONS.each_with_object({}) do |config_option, options|
+          config_option_value = config.public_send(config_option)
+          options[config_option] = config_option_value if config_option_value
+        end
+      end
     end
 
     Lita.register_adapter(:campfire, Campfire)

data/lib/lita/adapters/campfire/callback.rb

@@ -14,8 +14,8 @@ module Lita
           end
         end
 
-        def listen
-          @room.listen do |event|
+        def listen(options={})
+          @room.listen(options) do |event|
             receive event
           end
         end
@@ -74,7 +74,7 @@ module Lita
           def _receive(event)
             text    = event.body
             user    = @callback.create_user(event.user)
-            source  = Source.new(user, event.room_id.to_s)
+            source  = Source.new(user: user, room: event.room_id.to_s)
             message = Message.new(@robot, text, source)
             @robot.receive message
           end
@@ -94,4 +94,4 @@ module Lita
       end
     end
   end
-end
+end

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

@@ -3,24 +3,33 @@ module Lita
     class Campfire < Adapter
       class Connector
         def initialize(robot, opts)
-          @robot     = robot
-          @subdomain = opts.fetch(:subdomain)
-          @apikey    = opts.fetch(:apikey)
-          @rooms     = opts.fetch(:rooms)
-          @debug     = opts.fetch(:debug) { false }
+          @robot          = robot
+          @subdomain      = opts.fetch(:subdomain)
+          @apikey         = opts.fetch(:apikey)
+          @rooms          = opts.fetch(:rooms)
+          @debug          = opts.fetch(:debug) { false }
+          @tinder_options = opts.fetch(:tinder_options) { Hash.new }
         end
 
         def connect
           @campfire = Tinder::Campfire.new(@subdomain, token: @apikey)
         end
 
+        def disconnect
+          Lita.logger.info("Disconnecting from Campfire.")
+          rooms.each do |room_id|
+            room = fetch_room(room_id)
+            room.leave
+          end
+        end
+
         def join_rooms
           rooms.each do |room_id|
             room = fetch_room(room_id)
             room.join
             callback = Callback.new(@robot, room)
             callback.register_users
-            callback.listen
+            callback.listen(@tinder_options)
           end
         end
 
@@ -36,12 +45,8 @@ module Lita
           end
         end
 
-        def disconnect
-          Lita.logger.info("Disconnecting from Campfire.")
-          rooms.each do |room_id|
-            room = fetch_room(room_id)
-            room.leave
-          end
+        def set_topic(room_id, topic)
+          fetch_room(room_id).topic = topic
         end
 
         private

data/lita-campfire.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name          = "lita-campfire"
-  spec.version       = "0.1.3"
+  spec.version       = "0.1.4"
   spec.authors       = ["Jose Luis Salas", "Zac Stewart"]
   spec.email         = ["josacar@gmail.com", "zgstewart@gmail.com"]
   spec.description   = %q{A Campfire adapter for Lita.}

data/spec/lita/adapters/campfire/callback_spec.rb

@@ -3,19 +3,19 @@ require 'spec_helper'
 describe Campfire::Callback do
 
   class DummyRoom < Struct.new(:id, :message, :users)
-    def listen
+    def listen(options={})
       yield message
     end
   end
 
-  let(:event)         { double('Event') }
+  let(:event)         { instance_double('Event') }
   let(:campfire_user) { { id: 1, name: 'Bender Bending Rodriguez' } }
-  let(:message)       { double('Message') }
-  let(:robot)         { double('Robot', mention_name: 'Robot') }
+  let(:message)       { instance_double(Lita::Message) }
+  let(:robot)         { instance_double(Lita::Robot, mention_name: 'Robot') }
   let(:room)          { DummyRoom.new(1, event, users) }
-  let(:source)        { double('Source') }
+  let(:source)        { instance_double(Lita::Source) }
   let(:text)          { "Yes it's the apocalypse alright. I always though is have a hand in it." }
-  let(:user)          { double('User') }
+  let(:user)          { instance_double(Lita::User) }
   let(:users)         { [ {id: 2, name: 'Bender'}, {id: 3, name: 'Washbucket'} ] }
 
   subject { described_class.new(robot, room) }
@@ -27,7 +27,7 @@ describe Campfire::Callback do
     %w( TextMessage PasteMessage ).each do |message_type|
       describe "with a #{message_type}" do
         let(:event) do
-          double('Event',
+          instance_double('Event',
                  type:     message_type,
                  body:     text,
                  user:     campfire_user,
@@ -36,7 +36,7 @@ describe Campfire::Callback do
 
         it 'passes the message to Robot#receive' do
           expect(Lita::User).to receive(:create).with(1, name: 'Bender Bending Rodriguez').and_return(user)
-          expect(Lita::Source).to receive(:new).with(user, '1').and_return(source)
+          expect(Lita::Source).to receive(:new).with(user: user, room: '1').and_return(source)
           expect(Lita::Message).to receive(:new).with(robot, text, source).and_return(message)
           expect(robot).to receive(:receive).with(message)
           subject.listen
@@ -45,7 +45,7 @@ describe Campfire::Callback do
     end
 
     describe 'EnterMessage' do
-      let(:event) { double('Event', type: 'EnterMessage', user: campfire_user) }
+      let(:event) { instance_double('Event', type: 'EnterMessage', user: campfire_user) }
 
       it 'creates a user' do
         expect(Lita::User).to receive(:create).with(1, name: 'Bender Bending Rodriguez').and_return(user)
@@ -53,6 +53,15 @@ describe Campfire::Callback do
       end
     end
 
+    describe 'when options are set in connector' do
+      let(:room) { double(:room) }
+      it 'passes options to underlying tinder' do
+        tinder_options = { timeout: 30 }
+
+        expect(room).to receive(:listen).with(tinder_options)
+        subject.listen(tinder_options)
+      end
+    end
   end
 
   describe '#register_users' do
@@ -66,4 +75,4 @@ describe Campfire::Callback do
     end
   end
 
-end
+end

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

@@ -1,17 +1,19 @@
 require 'spec_helper'
 
 describe Campfire::Connector do
-  let(:robot) { double }
+  let(:robot) { instance_double(Lita::Robot) }
   let(:subdomain) { 'mycampfire' }
   let(:apikey) { '2e9f45bb934c0fa13e9f19ee0901c316fda9fc1' }
   let(:rooms) { %w( 12345 ) }
   let(:options) { { subdomain: subdomain, apikey: apikey, rooms: rooms } }
-  let(:campfire) { double }
+  let(:campfire) { instance_double(Tinder::Campfire) }
+  let(:room) { instance_double(Tinder::Room) }
 
   subject { described_class.new(robot, options) }
 
   before do
     allow(Tinder::Campfire).to receive(:new).and_return(campfire)
+    allow(campfire).to receive(:find_room_by_id).and_return(room)
   end
 
   describe '#connect' do
@@ -21,78 +23,101 @@ describe Campfire::Connector do
     end
   end
 
-  describe '#join_rooms' do
-    describe 'when I have access to the room' do
-      let(:room) { double('Room', id: 666) }
+  context 'when connected to campfire' do
+    before do
+      subject.connect
+    end
+    let(:callback) { instance_double(Campfire::Callback) }
 
-      before do
-        allow(campfire).to receive(:find_room_by_id).and_return(room)
-        subject.connect
+    describe '#disconnect' do
+
+      it "leaves joined rooms" do
+        expect(room).to receive(:leave)
+        subject.disconnect
       end
+    end
 
-      it 'joins each room, registers the users and listens for messages' do
-        expect(Campfire::Callback).to receive(:new).
-          with(robot, room).
-          and_return(callback = double('Callback'))
+    describe 'when tinder options are set' do
+      let(:tinder_options) { { timeout: 30 } }
+      let(:options) do
+        {
+          subdomain: subdomain,
+          apikey: apikey,
+          rooms: rooms,
+          tinder_options: tinder_options
+        }
+      end
 
-        expect(room).to receive(:join)
-        expect(callback).to receive(:listen)
-        expect(callback).to receive(:register_users)
+      it 'passes options to underlying tinder lib' do
+        allow(campfire).to receive(:find_room_by_id).and_return(room)
+        subject.connect
+        allow(Campfire::Callback).to receive(:new).and_return(callback)
 
+        allow(room).to receive(:join)
+        allow(callback).to receive(:register_users)
+        expect(callback).to receive(:listen).with(tinder_options)
         subject.join_rooms
       end
     end
 
-    describe "when I don't have access to the room" do
-      before do
-        allow(campfire).to receive(:find_room_by_id).and_return(nil)
-        subject.connect
-      end
+    describe '#join_rooms' do
+      describe 'when I have access to the room' do
+        it 'joins each room, registers the users and listens for messages' do
+          expect(Campfire::Callback).to receive(:new).
+            with(robot, room).
+            and_return(callback)
 
-      it 'raises an exception' do
-        expect { subject.join_rooms }.to raise_error(Campfire::RoomNotAvailable)
+          expect(room).to receive(:join)
+          expect(callback).to receive(:listen)
+          expect(callback).to receive(:register_users)
+
+          subject.join_rooms
+        end
       end
-    end
-  end
 
-  describe '#send_messages' do
-    let(:room) { double }
+      describe "when I don't have access to the room" do
+        before do
+          allow(campfire).to receive(:find_room_by_id).and_return(nil)
+        end
 
-    before do
-      allow(campfire).to receive(:find_room_by_id).and_return(room)
-      subject.connect
+        it 'raises an exception' do
+          expect { subject.join_rooms }.to raise_error(Campfire::RoomNotAvailable)
+        end
+      end
     end
 
-    context 'with a one line message' do
-      let(:message) { "I'm gonna drink 'til I reboot." }
+    describe '#send_messages' do
+      context 'with a one line message' do
+        let(:message) { "I'm gonna drink 'til I reboot." }
 
-      it 'speaks each message into room' do
-        expect(room).to receive(:speak).with(message)
-        subject.send_messages double(id: 1), [ message ]
+        it 'speaks each message into room' do
+          expect(room).to receive(:speak).with(message)
+          subject.send_messages room, [ message ]
+        end
       end
-    end
 
-    context 'with a multi line message' do
-      let(:message) { "I'm gonna drink 'til I reboot.\nNow I'm too drunk" }
+      context 'with a multi line message' do
+        let(:message) { "I'm gonna drink 'til I reboot.\nNow I'm too drunk" }
 
-      it 'pastes each message into room' do
-        expect(room).to receive(:paste).with(message)
-        subject.send_messages double(id: 1), [ message ]
+        it 'pastes each message into room' do
+          expect(room).to receive(:paste).with(message)
+          subject.send_messages room, [ message ]
+        end
       end
     end
-  end
 
-  describe '#disconnect' do
-    let(:room) { double('Room', id: 666) }
-
-    before do
-      allow(campfire).to receive(:find_room_by_id).and_return(room)
-      subject.connect
-    end
+    describe '#set_topic' do
+      before do
+        allow(Lita.logger).to receive(:info)
+        allow(campfire).to receive(:find_room_by_id).and_return(room)
+        subject.connect
+      end
+      let(:topic) { 'Let it be wadus' }
 
-    it "leaves joined rooms" do
-      expect(room).to receive(:leave)
-      subject.disconnect
+      it 'sets toom topic' do
+        expect(room).to receive(:topic=).with(topic)
+        subject.set_topic(room, topic)
+      end
     end
   end
 end

data/spec/lita/adapters/campfire_spec.rb

@@ -13,8 +13,8 @@ describe Lita::Adapters::Campfire do
 
   subject { described_class.new(robot) }
 
-  let(:robot) { double("Lita::Robot") }
-  let(:connector) { double("Lita::Adapters::Campfire::Connector") }
+  let(:robot) { instance_double(Lita::Robot) }
+  let(:connector) { instance_double(Lita::Adapters::Campfire::Connector) }
 
   it "registers with Lita" do
     expect(Lita.adapters[:campfire]).to eql(described_class)
@@ -26,6 +26,26 @@ describe Lita::Adapters::Campfire do
     expect { subject }.to raise_error(SystemExit)
   end
 
+  context 'passing optional variables' do
+    optional_config = described_class::OPTIONAL_CONFIG_OPTIONS
+    optional_config.each do |option|
+      it "does not set #{option} hash value if option is not set" do
+        expect(described_class::Connector).not_to receive(:new).with(robot, hash_including(option.to_sym))
+        subject
+      end
+    end
+
+    it 'can receive hash with tinder options' do
+      tinder_options = { timeout: 30, auto_reconnect: false }
+      Lita.configure do |config|
+        config.adapter.tinder_options = tinder_options
+      end
+
+      expect(described_class::Connector).to receive(:new).with(robot, hash_including(:tinder_options => tinder_options))
+      subject
+    end
+  end
+
   describe '#run' do
     before do
       allow(subject.connector).to receive(:connect)
@@ -59,7 +79,7 @@ describe Lita::Adapters::Campfire do
 
   describe '#send_messages' do
     it 'sends messages to rooms' do
-      source = double("Lita::Source", room: "room_id")
+      source = instance_double(Lita::Source, room: "room_id")
       expect(subject.connector).to receive(:send_messages).with(
         'room_id',
         ["Hello!"]
@@ -70,7 +90,7 @@ describe Lita::Adapters::Campfire do
 
   describe "#set_topic" do
     it "sets a new topic for a room" do
-      source = double("Lita::Source", room: "room_id")
+      source = instance_double(Lita::Source, room: "room_id")
       expect(subject.connector).to receive(:set_topic).with(
         "room_id",
         "Topic"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lita-campfire
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Jose Luis Salas
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-03 00:00:00.000000000 Z
+date: 2014-01-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lita
@@ -163,4 +163,3 @@ test_files:
 - spec/lita/adapters/campfire/connector_spec.rb
 - spec/lita/adapters/campfire_spec.rb
 - spec/spec_helper.rb
-has_rdoc: