flamethrower 0.0.1 → 0.1.0

data/.gitignore

@@ -1,3 +1,4 @@
 *.swp
 *.swo
 *.swn
+*.gem

data/README.rdoc

@@ -16,15 +16,17 @@ in the MOTD message. /join anyone of these and start chatting.
 
 You can also create a YAML file with domain and token specified like so:
 
-domain: mydomain
-token: aoeu1234
+  domain: mydomain
+  token: aoeu1234
 
 Then start flamethrower like so:
 
-flamethrower -c ~/myconfig.yml
+  flamethrower -c ~/myconfig.yml
 
 === A work in progress
 
+TODO: Switch Net::HTTP sync calls to async EM::HttpRequest calls.
+
 Flamethrower is a work in progress. Right now basic messaging works, but
 it still needs a lot of love. If you find it useful and would like to see
 it do something, please submit a patch (with tests please)!. Bug reports are

data/VERSION

@@ -1 +1 @@
-0.0.1
+0.1.0

data/bin/flamethrower

@@ -56,4 +56,10 @@ end
 FLAMETHROWER_LOGGER = Logger.new(options['logger'] || STDOUT)
 
 server = Flamethrower::EventServer.new(options['host'], options['port'], options['domain'], options['token'])
+
+trap("INT") do
+  FLAMETHROWER_LOGGER.info("Received shutdown signal, killing connections")
+  server.stop
+end
+
 server.start

data/flamethrower.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{flamethrower}
-  s.version = "0.0.1"
+  s.version = "0.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Blake Smith"]
-  s.date = %q{2010-12-22}
+  s.date = %q{2011-01-12}
   s.default_executable = %q{flamethrower}
   s.description = %q{Flamethrower gives you the power to use your awesome irc client to talk in your campfire rooms.}
   s.email = %q{blakesmith0@gmail.com}
@@ -48,11 +48,16 @@ Gem::Specification.new do |s|
      "spec/fixtures/leave_message.json",
      "spec/fixtures/message.json",
      "spec/fixtures/paste_message.json",
+     "spec/fixtures/paste_message_with_pound.json",
      "spec/fixtures/room.json",
      "spec/fixtures/room_update.json",
      "spec/fixtures/rooms.json",
      "spec/fixtures/speak_message.json",
      "spec/fixtures/streaming_message.json",
+     "spec/fixtures/timestamp_message.json",
+     "spec/fixtures/upload_message.json",
+     "spec/fixtures/upload_url_sample",
+     "spec/fixtures/user.json",
      "spec/spec_helper.rb",
      "spec/unit/campfire/connection_spec.rb",
      "spec/unit/campfire/message_spec.rb",

data/lib/flamethrower/campfire/message.rb

@@ -1,7 +1,7 @@
 module Flamethrower
   module Campfire
     class Message
-      attr_accessor :body, :user, :room, :message_type, :status, :retry_at
+      attr_accessor :body, :user, :room, :message_type, :status, :retry_at, :user_id
 
       RETRY_SECONDS = 15
 
@@ -9,6 +9,7 @@ module Flamethrower
         @body = params['body']
         @user = params['user']
         @room = params['room']
+        @user_id = params['user_id']
         @message_type = params['type']
         @status = "pending"
       end
@@ -34,6 +35,8 @@ module Flamethrower
           irc_string = ":#{@user.to_irc.to_s} PART #{@room.to_irc.name}"
         when "PasteMessage"
           irc_string = ":#{@user.to_irc.to_s} PRIVMSG #{@room.to_irc.name} :#{@body}"
+        else
+          return
         end
         Flamethrower::Irc::Message.new(irc_string)
       end

data/lib/flamethrower/campfire/room.rb

@@ -13,6 +13,7 @@ module Flamethrower
         @token = token
         @inbound_messages = Queue.new
         @outbound_messages = Queue.new
+        @users_to_fetch = Queue.new
         @failed_messages = []
         @number = params['id']
         @name = params['name']
@@ -52,6 +53,7 @@ module Flamethrower
             fetch_messages
             post_messages
             requeue_failed_messages
+            fetch_users
             messages_to_send = to_irc.retrieve_irc_messages
             messages_to_send.each do |m| 
               ::FLAMETHROWER_LOGGER.debug "Sending irc message #{m.to_s}"
@@ -91,7 +93,29 @@ module Flamethrower
           ::FLAMETHROWER_LOGGER.debug "Got json message #{params.inspect}"
           params['user'] = @users.find {|u| u.number == params['user_id'] }
           params['room'] = self
-          @inbound_messages << Flamethrower::Campfire::Message.new(params)
+          message = Flamethrower::Campfire::Message.new(params)
+          unless message.message_type == "TimestampMessage"
+            unless message.user
+              @users_to_fetch << message
+            else
+              @inbound_messages << message
+            end
+          end
+        end
+      end
+
+      def fetch_users
+        until @users_to_fetch.empty?
+          message = @users_to_fetch.pop
+          response = campfire_get("/users/#{message.user_id}.json")
+          case response
+          when Net::HTTPOK
+            json = JSON.parse(response.body)
+            user = Flamethrower::Campfire::User.new(json['user'])
+            message.user = user
+            @users << user
+            @inbound_messages << message
+          end
         end
       end
 

data/lib/flamethrower/irc/channel.rb

@@ -47,7 +47,7 @@ module Flamethrower
       private
 
       def display_message?(message)
-        message.message_type != "TimestampMessage"
+        message && message.message_type != "TimestampMessage"
       end
 
     end

data/lib/flamethrower/server/event_server.rb

@@ -3,26 +3,65 @@ module Flamethrower
     include Flamethrower::Server
 
     attr_accessor :server
+
+    def unbind
+      @server.connections.delete(self)
+    end
   end
 
   class EventServer
-    attr_reader :host, :port, :campfire_connection
+    attr_reader :host, :port, :campfire_connection, :connections
 
     def initialize(host, port, domain, token)
       @host = host || "0.0.0.0"
       @port = port || 6667
       @domain = domain
       @token = token
+      @connections = []
     end
 
     def start
       EventMachine::run do
         FLAMETHROWER_LOGGER.info "Flamethrower started at #{@host}:#{@port} on domain #{@domain}"
-        EventMachine::start_server(@host, @port, EventConnection) do |connection|
+        @signature = EventMachine::start_server(@host, @port, EventConnection) do |connection|
+          @connections << connection
           connection.server = self
           connection.campfire_connection = Flamethrower::Campfire::Connection.new(@domain, @token, connection)
         end
       end
     end
+
+    def stop
+      FLAMETHROWER_LOGGER.info("Killing room threads")
+      @connections.each do |connection|
+        connection.irc_channels.map do |channel|
+          channel.to_campfire.kill_thread!
+        end
+      end
+      EventMachine.stop_server(@signature)
+      die_safely
+    end
+
+    def die_safely
+      FLAMETHROWER_LOGGER.info("Waiting for streams and connections to die")
+      if streams_alive? && connections_alive?
+        EventMachine.add_periodic_timer(1) { die_safely }
+      else
+        FLAMETHROWER_LOGGER.info("Done.")
+        EventMachine.stop
+      end
+    end
+
+    def streams_alive?
+      @connections.any? do |connection|
+        connection.irc_channels.any? do |channel|
+          channel.to_campfire.alive?
+        end
+      end
+    end
+
+    def connections_alive?
+      @connections.size <= 0
+    end
   end
 end

data/spec/fixtures/paste_message_with_pound.json

@@ -0,0 +1 @@
+{"room_id":73541,"created_at":"2011/01/12 16:45:37 +0000","body":"#secure_asset_host: secure-assets-uat.example.com\nsecure_asset_host: assets1-uat.example.com","id":298515252,"user_id":627807,"type":"PasteMessage"}

data/spec/fixtures/timestamp_message.json

@@ -0,0 +1 @@
+{"room_id":73541,"created_at":"2010/12/14 20:09:23 +0000","body":null,"id":289361911,"user_id":489198,"type":"TimestampMessage"}

data/spec/fixtures/upload_message.json

@@ -0,0 +1 @@
+{"room_id":73541,"created_at":"2011/01/12 15:24:25 +0000","body":"Steak.jpeg","id":298466819,"user_id":786985,"type":"UploadMessage"}

data/spec/fixtures/upload_url_sample

@@ -0,0 +1 @@
+The upload_message.json fixture generated this URL: https://thepoint.campfirenow.com/room/73541/uploads/1711244/Steak.jpeg

data/spec/fixtures/user.json

@@ -0,0 +1 @@
+{"user":{"type":"Member","created_at":"2010/11/10 03:47:24 +0000","admin":true,"email_address":"bsmith@groupon.com","id":734581,"name":"blake"}}

data/spec/spec_helper.rb

@@ -4,6 +4,7 @@ require 'flamethrower'
 require 'server/mock_server'
 require 'json'
 require 'fakeweb'
+require 'time'
 
 ::FLAMETHROWER_LOGGER = Logger.new("/dev/null") unless Object.const_defined?("FLAMETHROWER_LOGGER")
 

data/spec/unit/campfire/message_spec.rb

@@ -27,6 +27,16 @@ describe Flamethrower::Campfire::Message do
       @message.to_irc.to_s.should == ":#{@irc_user.to_s} PRIVMSG #{@channel.name} :thebody"
     end
 
+    it "returns if the message type is unhandled" do
+      json = JSON.parse(json_fixture('enter_message'))
+      json['type'] = "BogusMessage"
+      message = Flamethrower::Campfire::Message.new(json)
+      message.user = @campfire_user
+      message.room = @room
+      Flamethrower::Irc::Message.should_not_receive(:new)
+      message.to_irc.should be_nil
+    end
+
     it "converts a EnterMessage to a join irc message" do
       json = JSON.parse(json_fixture('enter_message'))
       message = Flamethrower::Campfire::Message.new(json)

data/spec/unit/campfire/room_spec.rb

@@ -57,7 +57,40 @@ describe Flamethrower::Campfire::Room do
       @room.fetch_room_info
       FakeWeb.last_request['authorization'].should == "Basic #{Base64::encode64("#{@room.token}:x").chomp}"
     end
+  end
+
+  describe "#fetch_users" do
+    it "makes a call to the campfire api to fetch user information" do
+      FakeWeb.register_uri(:get, "https://mytoken:x@mydomain.campfirenow.com/users/734581.json", :body => json_fixture("user"), :status => ["200", "OK"])
+      @room.instance_variable_get("@users_to_fetch") << Flamethrower::Campfire::Message.new(JSON.parse(json_fixture("enter_message")))
+      @room.fetch_users
+      @room.users.map(&:name).should == ["blake"]
+    end
+
+    it "fetches using the 'user_id' field if a streaming message" do
+      FakeWeb.register_uri(:get, "https://mytoken:x@mydomain.campfirenow.com/users/734581.json", :body => json_fixture("user"), :status => ["200", "OK"])
+      @room.instance_variable_get("@users_to_fetch") << Flamethrower::Campfire::Message.new(JSON.parse(json_fixture("enter_message")))
+      @room.should_receive(:campfire_get).with("/users/734581.json")
+      @room.fetch_users
+    end
+
+    context "successfully get user info" do
+      it "enqueues an EnterMessage into @inbound_messages for displaying in irc" do
+        FakeWeb.register_uri(:get, "https://mytoken:x@mydomain.campfirenow.com/users/734581.json", :body => json_fixture("user"), :status => ["200", "OK"])
+        @room.instance_variable_get("@users_to_fetch") << Flamethrower::Campfire::Message.new(JSON.parse(json_fixture("enter_message")))
+        @room.fetch_users
+        message = @room.inbound_messages.pop.user.number.should == 734581
+      end
+    end
 
+    context "fails to get user info" do
+      it "doesn't enqueue an EnterMessage" do
+        FakeWeb.register_uri(:get, "https://mytoken:x@mydomain.campfirenow.com/users/734581.json", :status => ["400", "Bad Request"])
+        @room.instance_variable_get("@users_to_fetch") << Flamethrower::Campfire::Message.new(JSON.parse(json_fixture("enter_message")))
+        @room.fetch_users
+        message = @room.inbound_messages.size.should == 0
+      end
+    end
   end
 
   describe "#join" do
@@ -79,45 +112,13 @@ describe Flamethrower::Campfire::Room do
     end
   end
 
-  describe "#thread" do
-    before do
-      Kernel.stub(:sleep)
-    end
-
-    context "in a Thread" do
-      it "calls connect at the start of the thread" do
-        @room.stub(:fetch_messages)
-        @room.stub(:post_messages)
-        @room.should_receive(:connect).at_least(1).times
-        @room.start_thread
-        @room.kill_thread!
-      end
-
-      it "fetches messages from the stream" do
-        @room.stub(:connect)
-        @room.stub(:post_messages)
-        @room.should_receive(:fetch_messages).at_least(1).times
-        @room.start_thread
-        @room.kill_thread!
-      end
-
-      it "posts messages to the campfire API" do
-        @room.stub(:connect)
-        @room.stub(:fetch_messages)
-        @room.should_receive(:post_messages).at_least(1).times
-        @room.start_thread
-        @room.kill_thread!
-      end
-
-    end
-  end
-
   describe "#fetch_messages" do
     before do
       Twitter::JSONStream.stub(:connect).and_return("stream")
-      item = json_fixture("streaming_message")
+      @item = json_fixture("streaming_message")
+      @room.users << @user
       @room.connect
-      @room.stream.stub(:each_item).and_yield(item)
+      @room.stream.stub(:each_item).and_yield(@item)
     end
 
     it "iterates over each stream item and sends to the message queue" do
@@ -132,7 +133,6 @@ describe Flamethrower::Campfire::Room do
 
     it "maps the message sender to the right user" do
       @room.users << @user2
-      @room.users << @user
       @room.fetch_messages
       @room.inbound_messages.pop.user.should == @user
     end
@@ -141,6 +141,22 @@ describe Flamethrower::Campfire::Room do
       @room.fetch_messages
       @room.inbound_messages.pop.room.should == @room
     end
+
+    it "discards timestamp messages altogether" do
+      item = json_fixture("timestamp_message")
+      @room.stream.stub(:each_item).and_yield(item)
+      @room.fetch_messages
+      @room.instance_variable_get("@inbound_messages").size.should == 0
+      @room.instance_variable_get("@users_to_fetch").size.should == 0
+    end
+
+    it "puts messages that don't have an existing user into the users_to_fetch queue" do
+      enter_message = JSON.parse(json_fixture("streaming_message"))
+      enter_message['user_id'] = 98765
+      @room.stream.stub(:each_item).and_yield(enter_message.to_json)
+      @room.fetch_messages
+      @room.instance_variable_get("@users_to_fetch").size.should == 1
+    end
   end
 
   describe "#say" do

data/spec/unit/irc/channel_spec.rb

@@ -46,6 +46,11 @@ describe Flamethrower::Irc::Channel do
       @channel.retrieve_irc_messages.should be_empty
     end
 
+    it "doesn't add messages that return nil from to_irc" do
+      @room.inbound_messages << nil
+      @channel.retrieve_irc_messages.should be_empty
+    end
+
     xit "doesn't send the message if the source is the current user" do
       message = Flamethrower::Campfire::Message.new('body' => 'Hello there', 'user' => @campfire_user, 'room' => @room, 'type' => 'TextMessage')
       @room.inbound_messages << message

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: flamethrower
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: false
   segments: 
   - 0
-  - 0
   - 1
-  version: 0.0.1
+  - 0
+  version: 0.1.0
 platform: ruby
 authors: 
 - Blake Smith
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-12-22 00:00:00 -06:00
+date: 2011-01-12 00:00:00 -06:00
 default_executable: flamethrower
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -101,11 +101,16 @@ files:
 - spec/fixtures/leave_message.json
 - spec/fixtures/message.json
 - spec/fixtures/paste_message.json
+- spec/fixtures/paste_message_with_pound.json
 - spec/fixtures/room.json
 - spec/fixtures/room_update.json
 - spec/fixtures/rooms.json
 - spec/fixtures/speak_message.json
 - spec/fixtures/streaming_message.json
+- spec/fixtures/timestamp_message.json
+- spec/fixtures/upload_message.json
+- spec/fixtures/upload_url_sample
+- spec/fixtures/user.json
 - spec/spec_helper.rb
 - spec/unit/campfire/connection_spec.rb
 - spec/unit/campfire/message_spec.rb