flamethrower 0.0.1

data/lib/flamethrower/server.rb

@@ -0,0 +1,43 @@
+module Flamethrower
+  module Server
+    include Flamethrower::Irc::Commands
+
+    attr_accessor :campfire_connection, :current_user, :dispatcher, :irc_channels
+
+    def initialize(options = {})
+      @irc_channels = []
+      @current_user = Flamethrower::Irc::User.new
+      @dispatcher = Flamethrower::Dispatcher.new(self)
+    end
+
+    def after_connect
+      send_motd
+      populate_irc_channels
+      send_channel_list
+    end
+
+    def send_message(msg)
+      send_data "#{msg}\r\n"
+      ::FLAMETHROWER_LOGGER.debug ">> #{msg}"
+      msg
+    end
+
+    def receive_data(msg)
+      messages = msg.split("\r\n")
+      messages.each do |message|
+        dispatcher.handle_message(Flamethrower::Irc::Message.new(message))
+        ::FLAMETHROWER_LOGGER.debug "<< #{message}"
+      end
+    end
+
+    def send_messages(*messages)
+      yield(messages) if block_given?
+      messages.each {|msg| send_message(msg)}
+    end
+
+    def populate_irc_channels
+      @irc_channels = campfire_connection.rooms.map(&:to_irc)
+    end
+
+  end
+end

data/lib/flamethrower/server/event_server.rb

@@ -0,0 +1,28 @@
+module Flamethrower
+  class EventConnection < EventMachine::Connection
+    include Flamethrower::Server
+
+    attr_accessor :server
+  end
+
+  class EventServer
+    attr_reader :host, :port, :campfire_connection
+
+    def initialize(host, port, domain, token)
+      @host = host || "0.0.0.0"
+      @port = port || 6667
+      @domain = domain
+      @token = token
+    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|
+          connection.server = self
+          connection.campfire_connection = Flamethrower::Campfire::Connection.new(@domain, @token, connection)
+        end
+      end
+    end
+  end
+end

data/lib/flamethrower/server/mock_server.rb

@@ -0,0 +1,13 @@
+module Flamethrower
+  class MockServer
+    include Flamethrower::Server
+
+    def send_data(msg)
+    end
+
+    def campfire_connection
+      Flamethrower::Campfire::Connection.new("mydomain", "mytoken", self)
+    end
+
+  end
+end

data/spec/fixtures/enter_message.json

@@ -0,0 +1 @@
+{"room_id":73541,"created_at":"2010/12/14 20:47:11 +0000","body":null,"id":289382823,"user_id":734581,"type":"EnterMessage"}

data/spec/fixtures/kick_message.json

@@ -0,0 +1 @@
+{"room_id":73541,"created_at":"2010/12/14 20:40:26 +0000","body":null,"id":289379507,"user_id":613191,"type":"KickMessage"}

data/spec/fixtures/leave_message.json

@@ -0,0 +1 @@
+{"room_id":347348,"created_at":"2010/12/15 08:16:32 +0000","body":null,"id":289594534,"user_id":734581,"type":"LeaveMessage"}

data/spec/fixtures/message.json

@@ -0,0 +1 @@
+{"room_id":347348,"created_at":"Tue Nov 09 22:34:55 -0600 2010","body":"Wait for the message.","id":277226443,"type":"TextMessage","user":{"name":"Blake Smith","created_at":"Tue Nov 09 21:47:24 -0600 2010","admin":true,"id":734581,"type":"Member","email_address":"bsmith@groupon.com"}}

data/spec/fixtures/paste_message.json

@@ -0,0 +1 @@
+{"room_id":73541,"created_at":"2010/12/14 20:48:30 +0000","body":"Line one\\n\\tpoint one\\n\\tpoint two\\npoint three","id":289383470,"user_id":703609,"type":"PasteMessage"}

data/spec/fixtures/room.json

@@ -0,0 +1 @@
+{"room":{"name":"Room 1","created_at":"2010/11/10 03:47:24 +0000","full":false,"updated_at":"2010/11/10 03:47:24 +0000","topic":null,"open_to_guests":false,"id":347348,"users":[{"type":"Member","created_at":"2010/11/10 03:47:24 +0000","admin":true,"email_address":"bsmith@groupon.com","id":734581,"name":"Blake Smith"}],"membership_limit":4,"locked":false}}

data/spec/fixtures/room_update.json

@@ -0,0 +1 @@
+{"room":{"name":"Room 1","topic":"some topic"}}

data/spec/fixtures/rooms.json

@@ -0,0 +1 @@
+{"rooms":[{"name":"Room 1","created_at":"2010/11/10 03:47:24 +0000","updated_at":"2010/11/10 03:47:24 +0000","topic":"some topic","id":347348,"membership_limit":4,"locked":false}]}

data/spec/fixtures/speak_message.json

@@ -0,0 +1 @@
+{"message":{"type":"TextMessage","room_id":347348,"created_at":"2010/11/23 13:15:49 +0000","body":"Hello there","id":282030462,"user_id":734581}}

data/spec/fixtures/streaming_message.json

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

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+$:.unshift File.join(File.dirname(__FILE__), "../lib")
+
+require 'flamethrower'
+require 'server/mock_server'
+require 'json'
+require 'fakeweb'
+
+::FLAMETHROWER_LOGGER = Logger.new("/dev/null") unless Object.const_defined?("FLAMETHROWER_LOGGER")
+
+def json_fixture(name)
+  file = File.join(File.dirname(__FILE__), "fixtures/#{name}.json")
+  File.read(file)
+end

data/spec/unit/campfire/connection_spec.rb

@@ -0,0 +1,37 @@
+require File.join(File.dirname(__FILE__), "../../spec_helper")
+
+describe Flamethrower::Campfire::Connection do
+  before do
+    @server = Flamethrower::MockServer.new
+    @connection = @server.campfire_connection
+    FakeWeb.allow_net_connect = false
+  end
+
+  describe "#rooms" do
+    it "retrieves a list of rooms from JSON" do
+      FakeWeb.register_uri(:get, "https://mytoken:x@mydomain.campfirenow.com/rooms.json", :body => json_fixture("rooms"), :status => ["200", "OK"])
+      room = @connection.rooms.first
+      room.number.should == 347348
+      room.name.should == "Room 1"
+      room.topic.should == "some topic"
+    end
+
+    it "makes the http request with a token in basic auth" do
+      FakeWeb.register_uri(:get, "https://mytoken:x@mydomain.campfirenow.com/rooms.json", :body => json_fixture("rooms"), :status => ["200", "OK"])
+      @connection.rooms
+      FakeWeb.last_request['authorization'].should == "Basic #{Base64::encode64("#{@connection.token}:x").chomp}"
+    end
+
+    it "returns empty set if not a successful response" do
+      FakeWeb.register_uri(:get, "https://mytoken:x@mydomain.campfirenow.com/rooms.json", :status => ["400", "Bad Request"])
+      @connection.rooms.should == []
+    end
+
+    it "sends a motd error message if unable to fetch room list" do
+      @connection.should_receive(:campfire_get).and_raise(SocketError) 
+      @server.should_receive(:send_message).with(@server.reply(Flamethrower::Irc::Codes::RPL_MOTD, ":ERROR: Unable to fetch room list! Check your connection?"))
+      @connection.rooms.should == []
+    end
+  end
+
+end

data/spec/unit/campfire/message_spec.rb

@@ -0,0 +1,85 @@
+require File.join(File.dirname(__FILE__), "../../spec_helper")
+
+describe Flamethrower::Campfire::Message do
+  before do
+    @room = Flamethrower::Campfire::Room.new("mydomain", "mytoken", {'name' => "flamethrower"})
+    @channel = Flamethrower::Irc::Channel.new("#flamethrower", @room)
+    @campfire_user = Flamethrower::Campfire::User.new('name' => "bob", 'id' => 734581)
+    @room.users << @campfire_user
+    @irc_user = @campfire_user.to_irc
+    @message = Flamethrower::Campfire::Message.new('user' => @campfire_user, 'room' => @room, 'body' => 'thebody', 'type' => "TextMessage")
+  end
+
+  it "should have the message body" do
+    @message.body.should == "thebody"
+  end
+
+  it "should have the message type" do
+    @message.message_type.should == "TextMessage"
+  end
+
+  it "initializes the status to 'pending'" do
+    @message.status.should == "pending"
+  end
+
+  describe "#to_irc" do
+    it "converts the message to an irc message" do
+      @message.to_irc.to_s.should == ":#{@irc_user.to_s} PRIVMSG #{@channel.name} :thebody"
+    end
+
+    it "converts a EnterMessage to a join irc message" do
+      json = JSON.parse(json_fixture('enter_message'))
+      message = Flamethrower::Campfire::Message.new(json)
+      message.user = @campfire_user
+      message.room = @room
+      message.to_irc.to_s.should == ":#{@irc_user.to_s} JOIN #{@channel.name}"
+    end
+
+    it "converts a KickMessage to a part irc message" do
+      json = JSON.parse(json_fixture('kick_message'))
+      message = Flamethrower::Campfire::Message.new(json)
+      message.user = @campfire_user
+      message.room = @room
+      message.to_irc.to_s.should == ":#{@irc_user.to_s} PART #{@channel.name}"
+    end
+
+    it "converts a LeaveMessage to a part irc message" do
+      json = JSON.parse(json_fixture('leave_message'))
+      message = Flamethrower::Campfire::Message.new(json)
+      message.user = @campfire_user
+      message.room = @room
+      message.to_irc.to_s.should == ":#{@irc_user.to_s} PART #{@channel.name}"
+    end
+
+
+    it "makes a PasteMessage a PRIVMSG" do
+      json = JSON.parse(json_fixture('paste_message'))
+      message = Flamethrower::Campfire::Message.new(json)
+      message.user = @campfire_user
+      message.room = @room
+      message.to_irc.to_s.should == ":#{@irc_user.to_s} PRIVMSG #{@channel.name} :Line one\\n\\tpoint one\\n\\tpoint two\\npoint three"
+    end
+  end
+
+  describe "#mark_delivered!" do
+    it "sets the status to delivered" do
+      @message.status.should_not == "delivered"
+      @message.mark_delivered!
+      @message.status.should == "delivered"
+    end
+  end
+
+  describe "#mark_failed!" do
+    it "sets the status to failed" do
+      @message.status.should_not == "delivered"
+      @message.mark_failed!
+      @message.status.should == "failed"
+    end
+
+    it "sets the retry_at to 15 seconds from now" do
+      Time.stub(:now).and_return(Time.parse("9:00AM"))
+      @message.mark_failed!
+      @message.retry_at.should == Time.parse("9:00:15AM")
+    end
+  end
+end

data/spec/unit/campfire/room_spec.rb

@@ -0,0 +1,296 @@
+require File.join(File.dirname(__FILE__), "../../spec_helper")
+
+describe Flamethrower::Campfire::Room do
+  before do
+    @room = Flamethrower::Campfire::Room.new("mydomain", "mytoken", "id" => 347348, "topic" => "some topic", "name" => "some name")
+    @user = Flamethrower::Campfire::User.new('name' => "bob", 'id' => 489198)
+    @user2 = Flamethrower::Campfire::User.new('name' => "bill", 'id' => 123456)
+  end
+
+  describe "params" do
+    it "has number" do
+      @room.number.should == 347348
+    end
+    
+    it "has name" do
+      @room.name.should == "some name"
+    end
+  end
+
+  describe "#topic" do
+    it "has topic" do
+      @room.topic.should == "some topic"
+    end
+
+    it "displays 'No topic' if the topic is nil" do
+      @room.topic = nil
+      @room.topic.should == "No topic"
+    end
+  end
+
+  describe "#send_topic!" do
+    it "sets the topic when the campfire API returns 200" do
+      FakeWeb.register_uri(:put, "https://mytoken:x@mydomain.campfirenow.com/room/347348.json", :body => json_fixture("room_update"), :status => ["200", "OK"])
+      @room.send_topic!("some updated topic")
+      @room.topic.should == "some updated topic"
+    end
+
+    it "keeps the previous topic when the campfire API returns non 200" do
+      FakeWeb.register_uri(:put, "https://mytoken:x@mydomain.campfirenow.com/room/347348.json", :body => json_fixture("room_update"), :status => ["400", "Bad Request"])
+      @room.instance_variable_set("@topic", "some old topic")
+      @room.send_topic!("some updated topic")
+      @room.topic.should == "some old topic"
+    end
+  end
+
+  describe "#fetch_room_info" do
+    before do
+      FakeWeb.register_uri(:get, "https://mytoken:x@mydomain.campfirenow.com/room/347348.json", :body => json_fixture("room"), :status => ["200", "OK"])
+    end
+
+    it "retrieves a list of users and stores them as user objects" do
+      @room.fetch_room_info
+      @room.users.all? {|u| u.is_a?(Flamethrower::Campfire::User)}.should be_true
+    end
+
+    it "makes the http request with a token in basic auth" do
+      @room.fetch_room_info
+      FakeWeb.last_request['authorization'].should == "Basic #{Base64::encode64("#{@room.token}:x").chomp}"
+    end
+
+  end
+
+  describe "#join" do
+    it "returns true when posting to the room join call succeeds" do
+      FakeWeb.register_uri(:post, "https://mytoken:x@mydomain.campfirenow.com/room/347348/join.json", :status => ["200", "OK"])
+      @room.join.should == true
+    end
+
+    it "returns false when posting to the room join call fails" do
+      FakeWeb.register_uri(:post, "https://mytoken:x@mydomain.campfirenow.com/room/347348/join.json", :status => ["400", "Bad Request"])
+      @room.join.should == false
+    end
+  end
+
+  describe "#connect" do
+    it "initializes the twitter jsonstream with the right options" do
+      Twitter::JSONStream.should_receive(:connect).with(:path => "/room/347348/live.json", :host => "streaming.campfirenow.com", :auth => "mytoken:x")
+      @room.connect
+    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")
+      @room.connect
+      @room.stream.stub(:each_item).and_yield(item)
+    end
+
+    it "iterates over each stream item and sends to the message queue" do
+      @room.fetch_messages
+      @room.inbound_messages.size.should == 1
+    end
+
+    it "maps the message body to a message object with the right body" do
+      @room.fetch_messages
+      @room.inbound_messages.pop.body.should == "yep"
+    end
+
+    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
+
+    it "maps the message room to the right room" do
+      @room.fetch_messages
+      @room.inbound_messages.pop.room.should == @room
+    end
+  end
+
+  describe "#say" do
+    it "queues a campfire message given a message body" do
+      message = Flamethrower::Campfire::Message.new('body' => 'Hello there', 'user' => @user, 'room' => @room)
+      @room.say('Hello there')
+      popped_message = @room.outbound_messages.pop
+      popped_message.body.should == 'Hello there'
+    end
+
+    it "takes an optional message type" do
+      message = Flamethrower::Campfire::Message.new('type' => 'TextMessage', 'body' => 'Hello there', 'user' => @user, 'room' => @room)
+      @room.say('Hello there', 'TextMessage')
+      popped_message = @room.outbound_messages.pop
+      popped_message.message_type.should == 'TextMessage'
+    end
+  end
+
+  describe "#requeue_failed_messages" do
+    it "queues a message whos retry_at is greater than now" do
+      Time.stub(:now).and_return(Time.parse("9:00AM"))
+      message = Flamethrower::Campfire::Message.new('type' => 'TextMessage', 'body' => 'Hello there', 'user' => @user, 'room' => @room)
+      message.retry_at = Time.parse("9:00:01AM")
+      @room.failed_messages << message
+      @room.requeue_failed_messages
+      @room.outbound_messages.size.should == 1
+      @room.failed_messages.size.should == 0
+    end
+
+    it "doesn't queue a message whos retry_at is less than now" do
+      Time.stub(:now).and_return(Time.parse("9:00AM"))
+      message = Flamethrower::Campfire::Message.new('type' => 'TextMessage', 'body' => 'Hello there', 'user' => @user, 'room' => @room)
+      message.retry_at = Time.parse("8:59AM")
+      @room.failed_messages << message
+      @room.requeue_failed_messages
+      @room.outbound_messages.size.should == 0
+      @room.failed_messages.size.should == 1
+    end
+  end
+
+  describe "#post_messages" do
+    it "pops the message off the queue and posts it to the campfire api" do
+      FakeWeb.register_uri(:post, "https://mytoken:x@mydomain.campfirenow.com/room/347348/speak.json", :body => json_fixture("speak_message"), :status => ["201", "Created"])
+      message = Flamethrower::Campfire::Message.new('type' => 'TextMessage', 'body' => 'Hello there', 'user' => @user, 'room' => @room)
+      @room.outbound_messages << message
+      @room.post_messages
+      @room.outbound_messages.size.should == 0
+    end
+
+    it "adds the message to the failed_messages array if it fails to post to the campfire API" do
+      FakeWeb.register_uri(:post, "https://mytoken:x@mydomain.campfirenow.com/room/347348/speak.json", :status => ["400", "Bad Request"])
+      message = Flamethrower::Campfire::Message.new('type' => 'TextMessage', 'body' => 'Hello there', 'user' => @user, 'room' => @room)
+      @room.outbound_messages << message
+      @room.post_messages
+      @room.outbound_messages.size.should == 0
+      @room.failed_messages.size.should == 1
+    end
+
+    it "marks the message as failed when not able to deliver" do
+      FakeWeb.register_uri(:post, "https://mytoken:x@mydomain.campfirenow.com/room/347348/speak.json", :status => ["400", "Bad Request"])
+      message = Flamethrower::Campfire::Message.new('type' => 'TextMessage', 'body' => 'Hello there', 'user' => @user, 'room' => @room)
+      @room.outbound_messages << message
+      @room.post_messages
+      message.status.should == "failed"
+    end
+
+    it "marks the message as delivered if successfully posted to campfire" do
+      FakeWeb.register_uri(:post, "https://mytoken:x@mydomain.campfirenow.com/room/347348/speak.json", :body => json_fixture("speak_message"), :status => ["201", "Created"])
+      message = Flamethrower::Campfire::Message.new('type' => 'TextMessage', 'body' => 'Hello there', 'user' => @user, 'room' => @room)
+      @room.outbound_messages << message
+      @room.post_messages
+      message.status.should == "delivered"
+    end
+
+    it "sends the right json" do
+      FakeWeb.register_uri(:post, "https://mytoken:x@mydomain.campfirenow.com/room/347348/speak.json", :body => json_fixture("speak_message"), :status => ["201", "Created"])
+      message = Flamethrower::Campfire::Message.new('type' => 'TextMessage', 'body' => 'Hello there', 'user' => @user, 'room' => @room)
+      @room.outbound_messages << message
+      expected_json = {"message"=>{"body"=>"Hello there", "type"=>"TextMessage"}}.to_json
+      @room.should_receive(:campfire_post).with("/room/#{@room.number}/speak.json", expected_json)
+      @room.post_messages
+    end
+  end
+
+  describe "#retrieve_messages" do
+    it "returns all the messages in the message buffer" do
+      @room.inbound_messages << "one"
+      @room.inbound_messages << "two"
+      @room.retrieve_messages.should == ["one", "two"]
+    end
+
+    it "pops the messages from the messages array" do
+      @room.inbound_messages << "one"
+      @room.retrieve_messages.should == ["one"]
+      @room.inbound_messages.size.should == 0
+    end
+  end
+
+  describe "#to_irc" do
+    it "returns an irc channel object" do
+      @room.to_irc.is_a?(Flamethrower::Irc::Channel).should be_true
+    end
+
+    it "references the same room when doing conversions" do
+      @room.to_irc.to_campfire.should == @room
+    end
+
+    it "sends the current campfire topic" do
+      @room.to_irc.topic.should == @room.topic
+    end
+
+    it "replaces newlines with spaces" do
+      @room.topic = "Some topic\nyeah"
+      @room.to_irc.topic.should == "Some topic yeah"
+    end
+
+    context "channel name" do
+      it "maps the campfire room name to the channel name" do
+        @room.name = "somename"
+        @room.to_irc.name.should == "#somename"
+      end
+
+      it "downcases channel names" do
+        @room.name = "Somename"
+        @room.to_irc.name.should == "#somename"
+      end
+
+      it "separates replaces name spaces with underscores" do
+        @room.name = "Some Name 1"
+        @room.to_irc.name.should == "#some_name_1"
+      end
+
+      it "replaces slashes with underscores" do
+        @room.name = "API/Mobile"
+        @room.to_irc.name.should == "#api_mobile"
+      end
+
+      it "replaces ampersands with underscores" do
+        @room.name = "Stuff & Something"
+        @room.to_irc.name.should == "#stuff_something"
+      end
+
+    end
+
+    context "populating users" do
+      it "fills the irc channel's user array with mapped campfire users" do
+        @room.users = [Flamethrower::Campfire::User.new('name' => "bob")]
+        @room.to_irc.users.first.is_a?(Flamethrower::Irc::User).should be_true
+      end
+    end
+
+  end
+end