flamethrower 0.3.0 → 0.3.2

data/Gemfile

@@ -4,6 +4,7 @@ gem 'eventmachine'
 gem 'twitter-stream'
 gem 'json'
 gem 'em-http-request'
+gem 'daemons'
 
 group :test do
   gem 'rspec'

data/Gemfile.lock

@@ -3,6 +3,7 @@ GEM
   specs:
     addressable (2.2.2)
     crack (0.1.8)
+    daemons (1.1.0)
     diff-lcs (1.1.2)
     em-http-request (0.2.15)
       addressable (>= 2.0.0)
@@ -29,6 +30,7 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
+  daemons
   em-http-request
   eventmachine
   json

data/README.rdoc

@@ -1,5 +1,7 @@
 = Flamethrower: An irc to campfire gateway
 
+* Now with ASCII art conversion! (Oooo, shiney!)
+
 Flamethrower gives you the power to use your awesome irc client to
 talk in your campfire rooms.
 
@@ -23,14 +25,18 @@ Then start flamethrower like so:
 
   flamethrower -c ~/myconfig.yml
 
-=== A work in progress
+By default, flamethrower will use the config file located at ~/.flamethrower/config.yml.
+
+=== Contributing
 
-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
+Flamethrower is a constant work in progress. If you find it useful and would like to see it do something, please submit a patch (with tests please)!. Bug reports are
 also highly appreciated.
 
-=== Author
+=== Authors
 
 Flamethrower is written by Blake Smith <blakesmith0@gmail.com>
 
+Contributions by:
+
+Alexander Rakoczy[https://github.com/toothrot]
+

data/Rakefile

@@ -22,6 +22,7 @@ begin
     gemspec.add_dependency('json')
     gemspec.add_dependency('em-http-request')
     gemspec.add_dependency('twitter-stream')
+    gemspec.add_dependency('daemons')
   end
 rescue LoadError
   puts "Jeweler not available. Install it with: gem install jeweler"

data/VERSION

@@ -1 +1 @@
-0.3.0
+0.3.2

data/bin/flamethrower

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

data/bin/flamethrowerd

@@ -0,0 +1,20 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'daemons'
+
+flamethrower_dir = File.join(ENV["HOME"], '.flamethrower')
+config = File.join(flamethrower_dir, 'config.yml')
+options = {
+  :dir => flamethrower_dir,
+  :dir_mode => :normal,
+  :log_output => true,
+  :backtrace => true
+}
+
+if File.exists?(config)
+  script = File.join(File.dirname(__FILE__), 'flamethrower')
+  Daemons.run(script, options)
+else
+  puts "Unable to find config file! Please create $HOME/.flamethrower/config.yml and specify your domain and campfire API token"
+end

data/flamethrower.gemspec

@@ -5,15 +5,14 @@
 
 Gem::Specification.new do |s|
   s.name = %q{flamethrower}
-  s.version = "0.3.0"
+  s.version = "0.3.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Blake Smith"]
-  s.date = %q{2011-01-20}
-  s.default_executable = %q{flamethrower}
+  s.date = %q{2012-04-29}
   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}
-  s.executables = ["flamethrower"]
+  s.executables = ["flamethrower", "flamethrowerd"]
   s.extra_rdoc_files = [
     "README.rdoc"
   ]
@@ -27,34 +26,40 @@ Gem::Specification.new do |s|
      "Rakefile",
      "VERSION",
      "bin/flamethrower",
+     "bin/flamethrowerd",
      "flamethrower.gemspec",
+     "flamethrower.yml.example",
      "lib/flamethrower.rb",
+     "lib/flamethrower/ascii_imager.rb",
      "lib/flamethrower/campfire/connection.rb",
      "lib/flamethrower/campfire/message.rb",
      "lib/flamethrower/campfire/rest_api.rb",
      "lib/flamethrower/campfire/room.rb",
      "lib/flamethrower/campfire/user.rb",
+     "lib/flamethrower/connection.rb",
      "lib/flamethrower/dispatcher.rb",
      "lib/flamethrower/irc/channel.rb",
      "lib/flamethrower/irc/codes.rb",
      "lib/flamethrower/irc/commands.rb",
      "lib/flamethrower/irc/message.rb",
      "lib/flamethrower/irc/user.rb",
-     "lib/flamethrower/server.rb",
      "lib/flamethrower/server/event_server.rb",
-     "lib/flamethrower/server/mock_server.rb",
+     "lib/flamethrower/server/mock_connection.rb",
      "spec/fixtures/enter_message.json",
      "spec/fixtures/kick_message.json",
      "spec/fixtures/leave_message.json",
      "spec/fixtures/message.json",
      "spec/fixtures/paste_message.json",
      "spec/fixtures/paste_message_with_pound.json",
+     "spec/fixtures/recent_messages.json",
      "spec/fixtures/room.json",
      "spec/fixtures/room_update.json",
      "spec/fixtures/rooms.json",
      "spec/fixtures/speak_message.json",
+     "spec/fixtures/streaming_image_message.json",
      "spec/fixtures/streaming_message.json",
      "spec/fixtures/timestamp_message.json",
+     "spec/fixtures/tweet_message.json",
      "spec/fixtures/upload_message.json",
      "spec/fixtures/upload_url_sample",
      "spec/fixtures/user.json",
@@ -63,12 +68,12 @@ Gem::Specification.new do |s|
      "spec/unit/campfire/message_spec.rb",
      "spec/unit/campfire/room_spec.rb",
      "spec/unit/campfire/user_spec.rb",
+     "spec/unit/connection_spec.rb",
      "spec/unit/dispatcher_spec.rb",
      "spec/unit/irc/channel_spec.rb",
      "spec/unit/irc/message_spec.rb",
      "spec/unit/irc/user_spec.rb",
-     "spec/unit/server/event_server_spec.rb",
-     "spec/unit/server_spec.rb"
+     "spec/unit/server/event_server_spec.rb"
   ]
   s.homepage = %q{http://github.com/blakesmith/flamethrower}
   s.rdoc_options = ["--charset=UTF-8"]
@@ -81,12 +86,12 @@ Gem::Specification.new do |s|
      "spec/unit/campfire/message_spec.rb",
      "spec/unit/campfire/room_spec.rb",
      "spec/unit/campfire/user_spec.rb",
+     "spec/unit/connection_spec.rb",
      "spec/unit/dispatcher_spec.rb",
      "spec/unit/irc/channel_spec.rb",
      "spec/unit/irc/message_spec.rb",
      "spec/unit/irc/user_spec.rb",
-     "spec/unit/server/event_server_spec.rb",
-     "spec/unit/server_spec.rb"
+     "spec/unit/server/event_server_spec.rb"
   ]
 
   if s.respond_to? :specification_version then
@@ -98,17 +103,20 @@ Gem::Specification.new do |s|
       s.add_runtime_dependency(%q<json>, [">= 0"])
       s.add_runtime_dependency(%q<em-http-request>, [">= 0"])
       s.add_runtime_dependency(%q<twitter-stream>, [">= 0"])
+      s.add_runtime_dependency(%q<daemons>, [">= 0"])
     else
       s.add_dependency(%q<eventmachine>, [">= 0.12.10"])
       s.add_dependency(%q<json>, [">= 0"])
       s.add_dependency(%q<em-http-request>, [">= 0"])
       s.add_dependency(%q<twitter-stream>, [">= 0"])
+      s.add_dependency(%q<daemons>, [">= 0"])
     end
   else
     s.add_dependency(%q<eventmachine>, [">= 0.12.10"])
     s.add_dependency(%q<json>, [">= 0"])
     s.add_dependency(%q<em-http-request>, [">= 0"])
     s.add_dependency(%q<twitter-stream>, [">= 0"])
+    s.add_dependency(%q<daemons>, [">= 0"])
   end
 end
 

data/flamethrower.yml.example

@@ -0,0 +1,6 @@
+domain: flamethrower # eg, flamethrower.campfirenow.com
+token: c9be61aeb7c1a311f8f5a928ac6a0d41c93c4a72 # your personal API token
+ascii_conversion:
+        enabled: true
+        service: "http://skeeter.blakesmith.me"
+        scale_to_width: 80

data/lib/flamethrower.rb

@@ -9,6 +9,8 @@ require 'twitter/json_stream'
 require 'logger'
 require 'json'
 
+require 'ascii_imager'
+
 require 'irc/codes'
 require 'irc/commands'
 require 'irc/user'
@@ -21,6 +23,6 @@ require 'campfire/message'
 require 'campfire/connection'
 require 'campfire/room'
 
-require 'server'
+require 'connection'
 require 'server/event_server'
 require 'dispatcher'

data/lib/flamethrower/ascii_imager.rb

@@ -0,0 +1,16 @@
+module Flamethrower
+  module AsciiImager
+    DEFAULT_IMAGE_ASCII_SERVICE = "http://skeeter.blakesmith.me"
+    DEFAULT_IMAGE_WIDTH = 80
+
+    def image_get(url)
+      host = config['service'] || DEFAULT_IMAGE_ASCII_SERVICE
+      image_width = config['scale_to_width'] || DEFAULT_IMAGE_WIDTH
+      EventMachine::HttpRequest.new(host).get :query => {'image_url' => url, 'width' => image_width}
+    end
+
+    def config
+      @connection.server.ascii_conversion
+    end
+  end
+end

data/lib/flamethrower/campfire/connection.rb

@@ -5,10 +5,10 @@ module Flamethrower
 
       include Flamethrower::Campfire::RestApi
 
-      def initialize(domain, token, server)
+      def initialize(domain, token, connection)
         @domain = domain
         @token = token
-        @server = server
+        @connection = connection
       end
 
       def fetch_my_user
@@ -17,10 +17,10 @@ module Flamethrower
           case http.response_header.status
           when 200
             json = JSON.parse(http.response)
-            old_user = @server.current_user.nickname
+            old_user = @connection.current_user.nickname
             new_user = Flamethrower::Campfire::User.new(json['user']).to_irc
-            @server.current_user = new_user
-            @server.send_rename(old_user, new_user.nickname)
+            @connection.current_user = new_user
+            @connection.send_rename(old_user, new_user.nickname)
           end
         end
       end
@@ -34,18 +34,15 @@ module Flamethrower
             json = JSON.parse(http.response)
             json['rooms'].each do |room|
               rooms << Room.new(@domain, @token, room).tap do |r|
-                r.server = @server
+                r.connection = @connection
               end
             end
-            @server.irc_channels = rooms.map(&:to_irc)
-            @server.send_channel_list
+            @connection.irc_channels = rooms.map(&:to_irc)
+            @connection.send_channel_list
           else
             ::FLAMETHROWER_LOGGER.debug http.response
           end
         end
-        http.errback do
-          @server.send_message @server.reply(Flamethrower::Irc::Codes::RPL_MOTD, ":ERROR: Unable to fetch room list! Check your connection?")
-        end
       end
     end
   end

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, :user_id
+      attr_accessor :body, :user, :room, :direction, :message_type, :status, :retry_at, :image_converted, :user_id
 
       RETRY_SECONDS = 15
 
@@ -9,9 +9,11 @@ module Flamethrower
         @body = params['body']
         @user = params['user']
         @room = params['room']
-        @user_id = params['user_id']
+        @user_id = set_user_id(params)
         @message_type = params['type']
+        @direction = params['direction']
         @status = "pending"
+        @image_converted = false
       end
 
       def mark_delivered!
@@ -23,6 +25,48 @@ module Flamethrower
         @retry_at = Time.now + RETRY_SECONDS
       end
 
+      def mark_pending!
+        @status = "pending"
+      end
+
+      def failed?
+        @status == "failed"
+      end
+
+      def pending?
+        @status == "pending"
+      end
+
+      def outbound?
+        @direction == "outbound"
+      end
+
+      def inbound?
+        @direction == "inbound"
+      end
+
+      def needs_image_conversion?
+        has_images? && !@image_converted
+      end
+
+      def image_urls
+        if @body
+          @body.scan(/(https?:\/\/.+?\.(?:jpg|jpeg|gif|png))/i).flatten
+        else
+          []
+        end
+      end
+
+      def has_images?
+        image_urls.size > 0
+      end
+
+      def set_ascii_image(str)
+        @body << "\n#{str}"
+        @message_type = "PasteMessage"
+        @image_converted = true
+      end
+
       def to_irc
         case message_type
         when "TextMessage"
@@ -50,6 +94,18 @@ module Flamethrower
         end
         message.join("\r\n")
       end
+
+      def set_user_id(params)
+        if params['user_id']
+          params['user_id']
+        elsif params['user'].is_a?(User)
+          params['user'].number
+        elsif params['user'] && params['user'].is_a?(Hash)
+          params['user']['id']
+        else
+          nil
+        end
+      end
     end
   end
 end

data/lib/flamethrower/campfire/rest_api.rb

@@ -6,15 +6,14 @@ module Flamethrower
         "https://#{@domain}.campfirenow.com"
       end
 
-      private
-      def http
-        EventMachine::HttpRequest.new(host)
-      end
-
-      def campfire_get(path)
+      def campfire_get(path, args = {})
         action_log("get", path, nil)
         full_path = host << path
-        EventMachine::HttpRequest.new(full_path).get :head => {'authorization' => [@token, 'x']}
+        http = EventMachine::HttpRequest.new(full_path).get(
+          :head => {'authorization' => [@token, 'x']},
+          :query => args)
+        http.errback { on_connection_error("get", path) }
+        http
       end
 
       def campfire_post(path, json=nil)
@@ -23,6 +22,8 @@ module Flamethrower
         params = {:head => {'Content-Type' => 'application/json', 'authorization' => [@token, 'x']}}
         params[:body] = json if json
         http = EventMachine::HttpRequest.new(full_path).post params
+        http.errback { on_connection_error("post", path) }
+        http
       end
 
       def campfire_put(path, json=nil)
@@ -30,7 +31,9 @@ module Flamethrower
         full_path = host << path
         params = {:head => {'Content-Type' => 'application/json', 'authorization' => [@token, 'x']}}
         params[:body] = json if json
-        EventMachine::HttpRequest.new(full_path).put params
+        http = EventMachine::HttpRequest.new(full_path).put params
+        http.errback { on_connection_error("put", path) }
+        http
       end
 
       private
@@ -39,6 +42,10 @@ module Flamethrower
         ::FLAMETHROWER_LOGGER.debug "Sending #{action.upcase} #{path} with #{json || 'no'} JSON"
       end
 
+      def on_connection_error(action, path)
+        @connection.send_message @connection.reply(Flamethrower::Irc::Codes::RPL_MOTD, ":ERROR: Unable to make API call #{action.upcase} #{path}. Check your connection?")
+      end
+
     end
   end
 end

data/lib/flamethrower/campfire/room.rb

@@ -1,14 +1,16 @@
 module Flamethrower
   module Campfire
     class Room
+      MAX_RECONNECT_TIMOUT_SECONDS = 20
       POLL_SECONDS = 0.5
       PERIODIC_UPDATE_SECONDS = 60 * 10
 
       include Flamethrower::Campfire::RestApi
+      include Flamethrower::AsciiImager
 
       attr_reader :stream, :token
       attr_writer :topic
-      attr_accessor :inbound_messages, :outbound_messages, :thread_messages, :number, :name, :users, :server
+      attr_accessor :inbound_messages, :outbound_messages, :thread_messages, :number, :name, :users, :connection
       attr_accessor :failed_messages, :joined
 
       def initialize(domain, token, params = {})
@@ -17,6 +19,7 @@ module Flamethrower
         @inbound_messages = Queue.new
         @outbound_messages = Queue.new
         @users_to_fetch = Queue.new
+        @images_to_fetch = Queue.new
         @failed_messages = []
         @number = params['id']
         @name = params['name']
@@ -39,8 +42,8 @@ module Flamethrower
       end
 
       def send_info
-        @server.send_topic(to_irc)
-        @server.send_userlist(to_irc)
+        @connection.send_topic(to_irc)
+        @connection.send_userlist(to_irc)
       end
 
       def fetch_room_info
@@ -55,24 +58,42 @@ module Flamethrower
               @users << Flamethrower::Campfire::User.new(user)
             end
             resolve_renames(old_users, @users)
-            send_info unless @room_info_sent
+            unless @room_info_sent
+              send_info
+              fetch_recent_messages
+            end
             @room_info_sent = true
           end
         end
       end
 
+      def fetch_recent_messages
+        http = campfire_get("/room/#{@number}/recent.json", :limit => 10)
+        http.callback do
+          case http.response_header.status
+          when 200
+            json = JSON.parse(http.response)
+            json['messages'].each do |json_message|
+              process_inbound_json_message(json_message)
+            end
+          end
+        end
+      end
+
       def resolve_renames(old_users, new_users)
         old_users.each do |old_user|
           user = new_users.detect {|new_user| new_user.number == old_user.number}
-          unless old_user.name == user.name
-            @server.send_rename(old_user.to_irc.nickname, user.to_irc.nickname)
+          if user
+            unless old_user.name == user.name
+              @connection.send_rename(old_user.to_irc.nickname, user.to_irc.nickname)
+            end
           end
         end
       end
 
       def say(body, message_type='TextMessage')
-        params = {'body' => translate_nicknames(body), 'type' => message_type}
-        @outbound_messages << Flamethrower::Campfire::Message.new(params)
+        params = {'body' => translate_nicknames(body), 'type' => message_type, 'direction' => 'outbound'}
+        sort_and_dispatch_message(Flamethrower::Campfire::Message.new(params))
       end
 
       def start
@@ -88,18 +109,20 @@ module Flamethrower
         EventMachine.cancel_timer(@polling_timer)
         EventMachine.cancel_timer(@periodic_timer)
         @room_alive = false
+        @room_info_sent = false
       end
 
       def poll
         unless dead?
+          requeue_failed_messages
           fetch_messages
           post_messages
-          requeue_failed_messages
           fetch_users
+          fetch_images
           messages_to_send = to_irc.retrieve_irc_messages
           messages_to_send.each do |m|
             ::FLAMETHROWER_LOGGER.debug "Sending irc message #{m.to_s}"
-            @server.send_message(m.to_s)
+            @connection.send_message(m.to_s)
           end
         end
       end
@@ -124,20 +147,29 @@ module Flamethrower
         @stream = Twitter::JSONStream.connect(:path => "/room/#{@number}/live.json", 
                                     :host => "streaming.campfirenow.com", 
                                     :auth => "#{@token}:x")
+        setup_stream_callbacks
       end
 
       def fetch_messages
         @stream.each_item do |item| 
           ::FLAMETHROWER_LOGGER.debug "Got json message #{item.inspect}"
-          params = JSON.parse(item)
-          params['user'] = @users.find {|u| u.number == params['user_id'] }
-          params['room'] = self
-          message = Flamethrower::Campfire::Message.new(params)
-          unless message.message_type == "TimestampMessage"
-            unless message.user
-              @users_to_fetch << message
-            else
-              @inbound_messages << message
+          process_inbound_json_message(JSON.parse(item))
+        end
+      end
+
+      def fetch_images
+        until @images_to_fetch.empty?
+          message = @images_to_fetch.pop
+          message.image_urls.each do |url|
+            http = image_get(url)
+            http.callback do
+              case http.response_header.status
+              when 200
+                message.set_ascii_image(http.response)
+              else
+                message.mark_failed!
+              end
+              sort_and_dispatch_message(message)
             end
           end
         end
@@ -154,8 +186,10 @@ module Flamethrower
               user = Flamethrower::Campfire::User.new(json['user'])
               message.user = user
               @users << user
-              @inbound_messages << message
+            else
+              message.mark_failed!
             end
+            sort_and_dispatch_message(message)
           end
         end
       end
@@ -173,7 +207,7 @@ module Flamethrower
             else
               ::FLAMETHROWER_LOGGER.debug "Failed to post to campfire API with code: #{http.response_header.status} body: #{http.response}"
               message.mark_failed!
-              @failed_messages << message
+              sort_and_dispatch_message(message)
             end
           end
         end
@@ -184,7 +218,7 @@ module Flamethrower
           until @inbound_messages.empty?
             message = @inbound_messages.pop
             next unless message
-            unless message.user.to_irc.nickname == @server.current_user.nickname
+            unless message.user.to_irc.nickname == @connection.current_user.nickname
               new_array << message
             end
           end
@@ -194,7 +228,8 @@ module Flamethrower
       def requeue_failed_messages
         @failed_messages.each do |m| 
           if m.retry_at > Time.now
-            @outbound_messages << m 
+            m.mark_pending!
+            sort_and_dispatch_message(m)
             @failed_messages.delete(m)
           end
         end
@@ -209,8 +244,50 @@ module Flamethrower
         end
       end
 
+      def on_reconnect
+        ::FLAMETHROWER_LOGGER.debug "Reconnected to #{name} stream"
+      end
+
+      def on_error
+        ::FLAMETHROWER_LOGGER.debug "There was an error connecting to #{name} stream"
+      end
+
+      def on_max_reconnects
+        ::FLAMETHROWER_LOGGER.debug "Failed to reconnect to #{name}, restarting room in #{MAX_RECONNECT_TIMOUT_SECONDS} seconds"
+      end
+
       private
 
+      def sort_and_dispatch_message(message)
+        if message.failed?
+          @failed_messages << message
+        elsif message.inbound?
+          sort_and_dispatch_inbound_message(message)
+        else
+          @outbound_messages << message
+        end
+      end
+
+      def sort_and_dispatch_inbound_message(message)
+        if !message.user
+          @users_to_fetch << message
+        elsif @connection.server.ascii_conversion['enabled'] && message.needs_image_conversion?
+          @images_to_fetch << message
+        else
+          @inbound_messages << message
+        end
+      end
+
+      def process_inbound_json_message(json_message)
+        json_message['user'] = @users.find {|u| u.number == json_message['user_id'] }
+        json_message['room'] = self
+        json_message['direction'] = 'inbound'
+        message = Flamethrower::Campfire::Message.new(json_message)
+        unless message.message_type == "TimestampMessage"
+          sort_and_dispatch_message(message)
+        end
+      end
+
       def translate_nicknames(message_body)
         @users.each do |user|
           if message_body.include?(user.to_irc.nickname)
@@ -220,6 +297,12 @@ module Flamethrower
         message_body
       end
 
+      def setup_stream_callbacks
+        @stream.on_reconnect { self.on_reconnect }
+        @stream.on_error { self.on_error }
+        @stream.on_max_reconnects { self.on_max_reconnects }
+      end
+
     end
   end
 end