mad_chatter 0.2.9 → 0.3.0

data/.gitignore

@@ -2,4 +2,5 @@
 .bundle
 pkg/*
 .daemon
-coverage/
+coverage/
+.project

data/.rvmrc

@@ -0,0 +1 @@
+rvm --create use 1.9.2@mad_chatter

data/Gemfile.lock

@@ -1,11 +1,10 @@
 PATH
   remote: .
   specs:
-    mad_chatter (0.2.8)
+    mad_chatter (0.3.0)
       daemons (= 1.1.4)
       em-websocket
       eventmachine
-      redcarpet
       thor
 
 GEM
@@ -24,7 +23,6 @@ GEM
       guard (>= 0.8.4)
     multi_json (1.0.4)
     rb-fsevent (0.4.3.1)
-    redcarpet (2.0.1)
     rspec (2.7.0)
       rspec-core (~> 2.7.0)
       rspec-expectations (~> 2.7.0)

data/README.md

@@ -1,10 +1,16 @@
 # Mad Chatter
 
-Mad Chatter is a fun, easy to customize chat server. It's written in Ruby and utilizes HTML 5 Web Sockets for fast communication. It also has support for Markdown.
+Mad Chatter is a fun, easy to customize chat server. It's written in Ruby and utilizes HTML 5 Web Sockets for fast communication.
+
+The goal of Mad Chatter is to basically become an open-source version of [Campfire](http://campfirenow.com/), [HipChat](https://www.hipchat.com), or [FlowDock](https://www.flowdock.com). Or at least use those as inspiration.
 
 ## Getting Started
 
-To get started, first install the Mad Chatter gem:
+Since Mad Chatter is written in Ruby, you'll need to install Ruby in order to continue. We have a wiki page to help you with that:
+
+[How to install Ruby and RubyGems](https://github.com/andrewhavens/mad_chatter/wiki/How-to-install-Ruby-and-RubyGems)
+
+Once you have RubyGems installed, you can install the Mad Chatter gem:
 
     gem install mad_chatter
 
@@ -15,27 +21,27 @@ Then generate the directory where your chat application will live:
 This command will generate the following structure:
 
     mychatroom/
-        config.rb
-        extensions.rb
-        web/
-            index.html
-            styles.css
-            mad_chatter.js
-            mad_chatter_actions.js
+        config.yml      # for general configuration
+        extensions.rb   # for writing your own extensions
+        web/            # all of the html, css, and javascript live here
 
 To start your chat server, navigate to the directory that was just created and run...
 
-    mad_chatter start
+    mad_chatter preview
+
+This will start up the Mad Chatter chat server as well as a simple web server for you to preview/demo your new chat room. Now you can check it out by opening http://localhost:3000 in your browser. You should see something like this:
 
-This will start the web socket server on a specific port. You can now open the index.html file in your browser and start playing. All the files necessary to serve to the client are in the web directory. Feel free to copy/move these files if you'd prefer them somewhere else.
+![Mad Chatter screenshot](https://raw.github.com/andrewhavens/mad_chatter/master/screenshot.png)
 
-The start command will launch the web socket server in the background. You can use this command in production to start your server and leave it running. If you need to stop the server, simply run...
+When you're ready to have other people use your chat server (friends, family, co-workers, etc) you'll want to host the server and web directory some place that they can access (on a web server, for example, if it will be used outside your local network). You'll also want to start the chat server and leave it running for a long time in the background. This is known as a "daemon". Here are a few useful commands for that:
 
+    mad_chatter start
     mad_chatter stop
+    mad_chatter restart
 
 ## Chat Actions
 
-Hopefully, the default chatroom will be relatively intuitive to use. However, there are some extra features that Mad Chatter provides. Every chat message is parsed to see if it is a normal chat message, or if its a special action. These actions are much like IRC commands. For example, if I wanted to change my screen name from Andrew to Andy I could chat this message:
+Mad Chatter can do some special things depending on the chat messages you send. Every chat message is parsed to see if it is a normal chat message, or if its a special action. These actions are much like IRC commands. For example, if I wanted to change my screen name from Andrew to Andy I could chat this message:
 
     /nick andy
 
@@ -49,25 +55,25 @@ Or if I wanted to shake everyone's chat window:
 
     /earthquake
 
-You can also create your own actions to do whatever you want.
+You can even create your own actions!
 
 
 ## Customizing
 
 The goal of Mad Chatter is to make it easy to create, host, and customize your own chat server. Let's take a look at the different ways you can customize your new chat server.
 
-If you want to customize the html/css of your chatroom, you'll find it in the web directory.
+If you want to customize the html/css of your chatroom, you'll find it in the `web` directory.
 
-There is an example config file that shows a few examples of things you can customize.
+In the `config.yml` file you can see a few things you can customize.
 
-The extensions.rb file is for you to create your own chat extensions. You will find a few examples in that file.
+The `extensions.rb` file is for you to create your own chat extensions. You will find a few examples in that file.
 
 
 ## Mac, Windows, and Linux Wrappers
 
-Once you've got your chat server running and being used by other people, you might be interested in using/distributing an installable application, so you can leave it running and don't need to pull it up in a browser anymore. Here's a list of the currently available GUI wrapper applications:
+Once you've got your chat server running and being used by other people, you might be interested in using/distributing an installable application so your users have the convenience of clicking on an icon, receiving growl notifications, etc. Here's a list of the currently available "wrapper" applications:
 
- * [Mad Chatter for Mac](https://github.com/andrewhavens/mad_chatter_for_mac) (a MacRuby app based on WebKit)
+ * [Mad Chatter for Mac](https://github.com/andrewhavens/mad_chatter_for_mac)
 
 ## Getting Help / Providing Feedback
 
@@ -82,7 +88,6 @@ Please fork and send pull requests! Or submit issues if you have suggestions on
 ## TODO
 
  - Maybe add support for alternative web socket servers like Juggernaut, Socket.io, or Cramp and web-socket-js
- - Add tests! (I'm new to this, so I need help)
 
 ##Copyright
 

data/lib/mad_chatter/actions/dsl.rb

@@ -18,25 +18,19 @@ module MadChatter
       end
     
       def send_message(text)
-        json = MadChatter::Message.new('message', text).to_json
-        send_json(json)
-        MadChatter::MessageHistory.add(json)
+        MadChatter::Server.send_message MadChatter::Message.new('message', text)
       end
     
       def send_status_message(text)
-        json = MadChatter::Message.new('status', text).to_json
-        send_json(json)
-        MadChatter::MessageHistory.add(json)
+        MadChatter::Server.send_message MadChatter::Message.new('status', text)
       end
     
       def send_users_list
-        message = MadChatter::Message.new('users', MadChatter::Users.current)
-        send_json(message.to_json)
+        MadChatter::Server.send_message MadChatter::Message.new('users', MadChatter::Users.current)
       end
     
       def send_action(action, *args)
-        message = MadChatter::Message.new('action', {function: action, args: args})
-        send_json(message.to_json)
+        MadChatter::Server.send_message MadChatter::Message.new('action', {function: action, args: args})
       end
       
     end

data/lib/mad_chatter/actions.rb

@@ -0,0 +1,29 @@
+module MadChatter
+  module Actions
+    
+    def stop_message_handling
+      raise "Don't call any more message listeners"
+    end
+  
+    # def send_json(json)
+    #   MadChatter.send_json(json)
+    # end
+  
+    def send_message(text, from)
+      MadChatter.send_message MadChatter::Message.new('message', text, from)
+    end
+  
+    def send_status_message(text)
+      MadChatter.send_message MadChatter::Message.new('status', text)
+    end
+  
+    # def send_users_list
+    #   send_json MadChatter::Users.to_json
+    # end
+  
+    def send_action(action, *args)
+      MadChatter.send_message MadChatter::Message.new('action', {function: action, args: args})
+    end
+    
+  end
+end

data/lib/mad_chatter/channel.rb

@@ -0,0 +1,56 @@
+module MadChatter
+  class Channel
+
+    attr_accessor :id, :name, :users, :message_history
+
+    def initialize(name = nil)
+      @id = MadChatter.channels.count.to_s
+      @name = name
+      @users = []
+      @message_history = MadChatter::MessageHistory.new
+    end
+    
+    def add_user(user)
+      @users << user
+      send_users_list
+      @message_history.all.each do |json|
+        user.send(json)
+      end
+      send_message MadChatter::Message.new('status', "#{user.username} has joined the chatroom")
+    end
+    
+    def remove_user(user)
+      if @users.delete(user)
+        send_message MadChatter::Message.new('status', "#{user.username} has left the chatroom")
+        send_users_list
+      end
+    end
+    
+    def send_users_list
+      usernames = []
+      @users.each do |user|
+        usernames << user.username
+      end
+      json = JSON.generate({
+        type: 'users',
+        json: usernames,
+        channel: @id,
+      })
+      send_json(json)
+    end
+    
+    def send_message(message)
+      message.channel = @id
+      json = message.to_json
+      send_json(json)
+      @message_history.add(json) if message.add_to_history?
+    end
+    
+    def send_json(json)
+      @users.each do |user|
+        user.send(json)
+      end
+    end
+    
+  end
+end

data/lib/mad_chatter/config.rb

@@ -4,12 +4,14 @@ module MadChatter
     class << self
       
       def init
-        config = MadChatter::Config.initialize_config
-        MadChatter::Config.initialize_extensions
+        config = init_config
+        init_default_message_listeners
+        init_extensions
+        init_default_channels
         return config
       end
     
-      def initialize_config
+      def init_config
         config_file = File.join(Dir.pwd, 'config.yml')
         abort 'Could not find Mad Chatter config.yml file' unless File.exist?(config_file)
         
@@ -20,12 +22,23 @@ module MadChatter
         }
         @config = defaults.merge!(config)
       end
+      
+      def init_default_message_listeners
+        %w{ Join Nick Image Code Markdown }.each do |listener|
+          MadChatter.message_listeners << Object.const_get('MadChatter').const_get('MessageListeners').const_get(listener).new
+        end
+        # MadChatter.message_listeners << MadChatter::MessageListeners::Join.new
+        # MadChatter.message_listeners << MadChatter::MessageListeners::Nick.new
+        # MadChatter.message_listeners << MadChatter::MessageListeners::Image.new
+        # MadChatter.message_listeners << MadChatter::MessageListeners::Code.new
+        # MadChatter.message_listeners << MadChatter::MessageListeners::Markdown.new
+      end
 
-      def initialize_extensions
+      def init_extensions
         simple_extensions_file = File.join(Dir.pwd, 'extensions.rb')
         if File.exist?(simple_extensions_file)
           file_contents = File.read(simple_extensions_file)
-          MadChatter::Actions::Base.new.instance_eval file_contents
+          # MadChatter::Extensions.module_eval file_contents
         end
         
         # Dir[Dir.pwd + '/extensions/*.rb'].each do |file|
@@ -33,6 +46,10 @@ module MadChatter
         # end
       end
       
+      def init_default_channels
+        MadChatter.channels << MadChatter::Channel.new('default')
+      end
+      
     end
   end
 end

data/lib/mad_chatter/connection.rb

@@ -0,0 +1,29 @@
+module MadChatter
+  class Connection
+    
+    def register_connection(&send_message)
+      subscriber_id = MadChatter::Server.main_channel.subscribe(send_message)
+      token = generate_token
+      send_message.call(MadChatter::Message.new('token', token).to_json)
+      @subscribers[subscriber_id] = token
+      MadChatter::MessageHistory.all.each do |json|
+        send_message.call(json)
+      end
+      subscriber_id
+    end
+    
+    def generate_new_token
+      Digest::SHA1.hexdigest(Time.now.to_s)
+    end
+    
+    def on_close
+      token = @subscribers.delete(id)
+      username = MadChatter::Users.find_username_by_token(token)
+      MadChatter::Server.main_channel.unsubscribe(id)
+      MadChatter::Users.remove(token)
+      MadChatter::Server.send_json(MadChatter::Message.new('status', "#{username} has left the chatroom").to_json)
+      MadChatter::Server.send_json(MadChatter::Message.new('users', MadChatter::Users.current).to_json)
+    end
+    
+  end
+end

data/lib/mad_chatter/extensions.rb

@@ -0,0 +1,12 @@
+module MadChatter
+  module Extensions
+    
+    # include MadChatter::Actions
+    
+    # Used for defining simple extensions
+    def on_message(regex, &block)
+      MadChatter.message_listeners << MadChatter::MessageListener.new(regex, block)
+    end
+    
+  end
+end

data/lib/mad_chatter/markdown_renderer.rb

@@ -1,10 +1,16 @@
 module MadChatter
   class MarkdownRenderer < Redcarpet::Render::HTML
+    
     def link(link, title, alt_text)
       "<a target=\"_blank\" href=\"#{link}\">#{alt_text}</a>"
     end
+    
     def autolink(link, link_type)
       "<a target=\"_blank\" href=\"#{link}\">#{link}</a>"
     end
+    
+    def header(text, header_level)
+      '#' + text
+    end
   end
 end

data/lib/mad_chatter/message.rb

@@ -1,16 +1,40 @@
+require 'cgi'
+
 module MadChatter
   class Message
     
-    attr_accessor :type, :original_text, :filtered_text, :token, :username
+    attr_accessor :type, :original_text, :filtered_text, :html, :token, :channel, :growl, :add_to_history
     
-    def initialize(type, original_text, token = nil, username = nil)
+    def initialize(type, text = nil, token = nil, channel = nil)
       @type = type
-      @original_text = original_text
-      @filtered_text = original_text  # if filter is never called, message will be original text
+      if text
+        @original_text = text
+        @filtered_text = filter(text)
+        @html = @filtered_text
+        @growl = text
+      end
       @token = token
+      @channel = channel
+      @add_to_history = true
+    end
+    
+    def username=(username)
       @username = username
     end
     
+    def username
+      unless @username
+        MadChatter.users.each do |user|
+          @username = user.username if user.has_token?(@token)
+        end
+      end
+      @username
+    end
+    
+    def user
+      MadChatter.find_user_by_token(@token) if @token
+    end
+    
     # Helper method for returning filtered text.
     def text
       @filtered_text
@@ -19,17 +43,20 @@ module MadChatter
     def to_json
       JSON.generate({
         type: @type,
-        message: @filtered_text,
-        username: @username,
+        text: @original_text,
+        html: @html,
+        username: username,
+        channel: @channel,
+        growl: @growl,
       })
     end
     
-    def filter
-      @filtered_text = MadChatter.markdown.render(@original_text)
-      # remove the <p> tags that markdown wraps by default
-      @filtered_text.sub!(/^<p>/, '')
-      @filtered_text.sub!(/<\/p>$/, '')
-      @filtered_text
+    def filter(text)
+      CGI::escapeHTML(text).strip
+    end
+    
+    def add_to_history?
+      @add_to_history
     end
     
   end

data/lib/mad_chatter/message_history.rb

@@ -1,17 +1,20 @@
 module MadChatter
   class MessageHistory
     
-    def self.add(message)
-      @stack ||= []
+    def initialize
+       @stack = []
+    end
+    
+    def add(message)
       @stack << message
       @stack = @stack.pop(10) if @stack.length > 10
     end
     
-    def self.all
-      @stack ||= []
+    def all
+      @stack
     end
     
-    def self.clear
+    def clear
       @stack = []
     end
     

data/lib/mad_chatter/message_listener.rb

@@ -0,0 +1,17 @@
+module MadChatter
+  class MessageListener
+    include MadChatter::Actions
+    
+    def initialize(regex = nil, block = nil)
+      @regex = regex
+      @block = block
+    end
+  
+    def handle(message)
+      if message.original_text =~ @regex
+        args = @regex.match(message.original_text).captures
+        @block.call(args)
+      end
+    end
+  end
+end

data/lib/mad_chatter/message_listeners/code.rb

@@ -0,0 +1,30 @@
+module MadChatter
+  module MessageListeners
+    class Code
+      
+      include MadChatter::Actions
+      
+      @@regex = %r{^/code (.+)}
+      
+      def handle(msg)
+        if msg.original_text =~ @@regex
+          # puts msg.original_text
+          code = parse(msg.original_text)
+          # puts code
+          message = MadChatter::Message.new('message', nil, msg.token, msg.channel)
+          message.html = "<pre>" + message.filter(code) + "</pre>"
+          message.growl = msg.username + ' has shared a code sample' if msg.username
+          channel = MadChatter::find_channel_by_id(msg.channel)
+          channel.send_message(message)
+          stop_message_handling
+        end
+      end
+      
+      def parse(text)
+        text.sub!('/code', '')
+        # @@regex.match(message_text).captures[0]
+      end
+      
+    end
+  end
+end

data/lib/mad_chatter/message_listeners/image.rb

@@ -0,0 +1,27 @@
+module MadChatter
+  module MessageListeners
+    class Image
+      
+      include MadChatter::Actions
+      
+      @@regex = %r{^/img (.+)}
+      
+      def handle(message)
+        if message.text =~ @@regex
+          img_url = parse_url(message.text)
+          img_msg = MadChatter::Message.new('message', img_url, message.token, message.channel)
+          img_msg.html = "<img src='#{img_url}'>"
+          img_msg.growl = message.username + ' has shared an image'
+          channel = MadChatter::find_channel_by_id(message.channel)
+          channel.send_message(img_msg)
+          stop_message_handling
+        end
+      end
+      
+      def parse_url(message_text)
+        @@regex.match(message_text).captures[0]
+      end
+      
+    end
+  end
+end

data/lib/mad_chatter/message_listeners/join.rb

@@ -0,0 +1,30 @@
+module MadChatter
+  module MessageListeners
+    class Join
+      
+      include MadChatter::Actions
+      
+      @@regex = %r{^/join$}
+      
+      def handle(message)
+        if message.text =~ @@regex
+          user = MadChatter.find_user_by_token(message.token)
+          
+          unless user && message.channel
+            stop_message_handling # user should already exist, and channel id is required
+          end
+          
+          channel = MadChatter.find_channel_by_id(message.channel)
+          
+          unless channel
+            stop_message_handling # you cant join a channel that doesnt exist
+          end
+          
+          channel.add_user(user)
+          stop_message_handling
+        end
+      end
+      
+    end
+  end
+end

data/lib/mad_chatter/message_listeners/markdown.rb

@@ -0,0 +1,45 @@
+module MadChatter
+  module MessageListeners
+    class Markdown
+      
+      # Apply markdown to all messages that pass through
+      def handle(message)
+        message.html = apply_markdown(message.filtered_text)
+        return message
+      end
+      
+      def apply_markdown(text)
+
+        # in very clear cases, let newlines become <br /> tags
+        text.gsub!(/^[\w\<][^\n]*\n+/) do |x|
+          x =~ /\n{2}/ ? x : (x.strip!; x << "  \n")
+        end
+
+        # autolink email addresses
+        text.gsub!(/([\w\.%\+\-]+)@([\w\-]+\.)+([\w]{2,})/i) do |x|
+          x = %Q{<a href="mailto:#{$&}">#{$&}</a>}
+        end
+
+        # autolink urls
+        text.gsub!(/(http|https):\/\/[a-z0-9]+([\-\.]{1}[a-z0-9]+)*\.[a-z]{2,5}(([0-9]{1,5})?\/(\S)+)?/i) do |x|
+          href = $&
+           # check if we're in a markdown link
+           if $` =~ /[(]/
+            x = href
+           else
+            x = %Q{<a target="_blank" href="#{href}">#{href}</a>}
+           end
+        end
+        
+        # bold (must come before italic)
+        text.gsub!(%r{(^|\s)(\*\*|__)(.+?)\2(\s|$)}x, %{\\1<strong>\\3</strong>\\4})
+        
+        # italic
+        text.gsub!(%r{(^|\s)([*_])(.+?)\2(\s|$)}x, %{\\1<em>\\3</em>\\4})
+        
+        return text
+      end
+      
+    end
+  end
+end

data/lib/mad_chatter/message_listeners/nick.rb

@@ -0,0 +1,26 @@
+module MadChatter
+  module MessageListeners
+    class Nick
+      
+      include MadChatter::Actions
+      
+      @@regex = %r{^/nick (.+)}
+      
+      def handle(message)
+        if message.text =~ @@regex
+          username = parse_username(message.text)
+          user = message.user
+          if user
+            user.update_username(username)
+          end
+          stop_message_handling
+        end
+      end
+      
+      def parse_username(text)
+        @@regex.match(text).captures[0]
+      end
+      
+    end
+  end
+end