mad_chatter 0.3.2 → 0.3.3

data/README.md

@@ -2,7 +2,7 @@
 
 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.
+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
 
@@ -22,7 +22,7 @@ This command will generate the following structure:
 
     mychatroom/
         config.yml      # for general configuration
-        extensions.rb   # for writing your own extensions
+        extensions/     # 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...
@@ -33,7 +33,7 @@ This will start up the Mad Chatter chat server as well as a simple web server fo
 
 ![Mad Chatter screenshot](https://raw.github.com/andrewhavens/mad_chatter/master/screenshot.png)
 
-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:
+When you're ready to have other people start using your new chat server (friends, family, co-workers, etc) you'll need to set up a web server so other people can access it. Set up your web server to serve the `web` directory that we created above. Now you're ready to start Mad Chatter and leave it running in the background. Here are a few useful commands for that:
 
     mad_chatter start
     mad_chatter stop
@@ -41,7 +41,7 @@ When you're ready to have other people use your chat server (friends, family, co
 
 ## Chat Actions
 
-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:
+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 it's a special action. These actions are much like IRC commands. For example, if I wanted to change my name from Andrew to Andy I could chat this message:
 
     /nick andy
 
@@ -62,31 +62,30 @@ You can even create your own actions!
 
 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.
+All of the HTML, CSS, and Javascript is available for you to customize in the `web` directory.
 
 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` directory contains all of your extensions. If you wanted to create a custom action, this is where you would put it. You will find a few examples in that directory.
 
 
 ## 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 your users have the convenience of clicking on an icon, receiving growl notifications, etc. Here's a list of the currently available "wrapper" applications:
+Once you've got your chat server running and being used by other people, you might be interested in using and 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)
 
 ## Getting Help / Providing Feedback
 
-Feel free to submit bug reports and feature requests to our [GitHub Issues page](https://github.com/andrewhavens/mad_chatter/issues), or post to the [Google Group](https://groups.google.com/group/mad-chatter), or send me a message on GitHub.
+If you need help or have feedback, feel free to submit bug reports and feature requests to our [GitHub Issues page](https://github.com/andrewhavens/mad_chatter/issues), or post to the [Google Group](https://groups.google.com/group/mad-chatter).
 
 You can also vote on upcoming features: https://madchatter.uservoice.com
 
 ## Contributing
 
+Please fork and send pull requests! Or submit issues if you have suggestions on how to improve Mad Chatter.
 [![Build Status](https://secure.travis-ci.org/andrewhavens/mad_chatter.png)](http://travis-ci.org/andrewhavens/mad_chatter)
 
-Please fork and send pull requests! Or submit issues if you have suggestions on how to improve.
-
 ##Copyright
 
-Copyright (c) 2011-2012 Andrew Havens. MIT license. See LICENSE.txt for further details.
+Created by Andrew Havens and released under the MIT license.

data/bin/mad_chatter

@@ -14,10 +14,17 @@ module MadChatter
     desc "new [name]", "Generates a new Mad Chatter application"
     def new(name)
       copy_file "templates/config.yml", "#{name}/config.yml"
-      copy_file "templates/extensions.rb", "#{name}/extensions.rb"
+      directory "templates/extensions", "#{name}/extensions"
       directory "templates/web", "#{name}/web"
     end
     
+    desc "update", "Updates an existing Mad Chatter application"
+    def new(name)
+      copy_file "templates/config.yml", "config.yml"
+      directory "templates/extensions", "extensions"
+      directory "templates/web", "web"
+    end
+    
     desc 'preview', 'Starts both a web server and the Mad Chatter chat server'
     def preview
       t1 = Thread.new { require 'mad_chatter/web_server' }

data/lib/mad_chatter/actions.rb

@@ -4,25 +4,23 @@ module MadChatter
     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)
+    
+    def send_message(text, from = nil)
+      m = MadChatter::Message.new('message', text)
+      m.username = from || @message.username
+      m.channel = @message.channel
+      MadChatter.send_message(m)
     end
   
     def send_status_message(text)
-      MadChatter.send_message MadChatter::Message.new('status', text)
+      MadChatter.send_message MadChatter::Message.new('status', text, nil, @message.channel)
     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})
+      m = MadChatter::Message.new('action')
+      m.json = {function: action, args: args}
+      m.channel = @message.channel
+      MadChatter.send_message(m)
     end
     
   end

data/lib/mad_chatter/config.rb

@@ -17,7 +17,6 @@ module MadChatter
         
         config = YAML::load(File.open(config_file))
         defaults = {
-          'websocket_backend' => 'websocket-rack',
           'websocket_port' => 8100,
         }
         @config = defaults.merge!(config)
@@ -30,15 +29,17 @@ module MadChatter
       end
 
       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::Extensions.module_eval file_contents
-        end
-        
-        # Dir[Dir.pwd + '/extensions/*.rb'].each do |file|
-        #   require file
+        # simple_extensions_file = File.join(Dir.pwd, 'extensions.rb')
+        # if File.exist?(simple_extensions_file)
+        #   file_contents = File.read(simple_extensions_file)
+        #   MadChatter::Extensions.class_eval file_contents
         # end
+        
+        # Auto-require User Defined Extension Classes
+        Dir[Dir.pwd + '/extensions/*.rb'].each do |file|
+          require file
+          # MadChatter.message_listeners << Object.const_get('MadChatter').const_get('Extensions').const_get(file).new
+        end
       end
       
       def init_default_channels

data/lib/mad_chatter/extension.rb

@@ -0,0 +1,16 @@
+module MadChatter
+  class Extension
+    include MadChatter::Actions
+    
+    attr_accessor :message
+    
+    def self.inherited(klass)
+      MadChatter.message_listeners << klass.new
+    end
+  
+    def handle(message)
+      # subclasses should override this function, or use the on_message shortcut method
+    end
+    
+  end
+end

data/lib/mad_chatter/message.rb

@@ -3,7 +3,7 @@ require 'cgi'
 module MadChatter
   class Message
     
-    attr_accessor :type, :original_text, :filtered_text, :html, :token, :channel, :growl, :add_to_history, :timestamp
+    attr_accessor :type, :original_text, :filtered_text, :html, :json, :token, :channel, :growl, :add_to_history, :timestamp
     
     def initialize(type, text = nil, token = nil, channel_id = nil)
       @type = type
@@ -46,6 +46,7 @@ module MadChatter
         type: @type,
         text: @original_text,
         html: @html,
+        json: @json,
         username: username,
         channel: @channel,
         growl: @growl,

data/lib/mad_chatter/message_listeners/code.rb

@@ -4,16 +4,13 @@ module MadChatter
       
       include MadChatter::Actions
       
-      @@regex = %r{^/code (.+)}
-      
       def handle(msg)
-        if msg.original_text =~ @@regex
+        if msg.original_text =~ %r{^/code (.+)}
           code = parse(msg.original_text)
           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)
+          MadChatter.send_message(message)
           stop_message_handling
         end
       end

data/lib/mad_chatter/message_listeners/image.rb

@@ -12,8 +12,7 @@ module MadChatter
           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)
+          MadChatter.send_message(message)
           stop_message_handling
         end
       end

data/lib/mad_chatter/message_listeners/video.rb

@@ -0,0 +1,26 @@
+module MadChatter
+  module MessageListeners
+    class Video
+      
+      include MadChatter::Actions
+      
+      @@youtube = %r{^/youtube http://youtu.be/(.*)$}
+      
+      def handle(message)
+        if message.original_text =~ @@youtube
+          youtube_id = parse_youtube_id(message.original_text)
+          img_msg = MadChatter::Message.new('message', nil, message.token, message.channel)
+          img_msg.html = "<iframe width='560' height='315' src='http://www.youtube.com/embed/#{youtube_id}' frameborder='0' allowfullscreen></iframe>"
+          img_msg.growl = message.username + ' has shared a YouTube video'
+          MadChatter.send_message(message)
+          stop_message_handling
+        end
+      end
+      
+      def parse_youtube_id(text)
+        @@youtube.match(text).captures[0]
+      end
+      
+    end
+  end
+end

data/lib/mad_chatter/server.rb

@@ -7,12 +7,7 @@ module MadChatter
     end
     
     def initialize_server
-      # TODO: Figure out a better (more flexible/dynamic) way to initialize the server class
-      if @config['websocket_backend'] && @config['websocket_backend'] == 'MadChatter::Servers::EventMachineWebSocket'
-        return MadChatter::Servers::EventMachineWebSocket.new(@config['websocket_port'], self)
-      end
-      
-      raise 'You did not specify a valid class name for websocket_backend'
+      return MadChatter::Servers::EventMachineWebSocket.new(@config['websocket_port'], self)
     end
   
     def start

data/lib/mad_chatter/version.rb

@@ -1,5 +1,5 @@
 module MadChatter
   
-  VERSION = '0.3.2'
+  VERSION = '0.3.3'
 
 end

data/lib/mad_chatter.rb

@@ -19,15 +19,13 @@ require 'mad_chatter/message'
 require 'mad_chatter/message_history'
 
 require 'mad_chatter/actions'
+require 'mad_chatter/extension'
 require 'mad_chatter/message_listeners/channel_commands'
 require 'mad_chatter/message_listeners/markdown'
 require 'mad_chatter/message_listeners/nick'
 require 'mad_chatter/message_listeners/image'
 require 'mad_chatter/message_listeners/code'
 
-require 'mad_chatter/extensions'
-require 'mad_chatter/message_listener'
-
 module MadChatter
   
   class << self
@@ -95,6 +93,7 @@ module MadChatter
       
       begin
         message_listeners.each do |listener|
+          listener.message = message if listener.respond_to?('message=')
           listener.handle(message)
         end
         send_message(message)

data/spec/simple_extensions_spec.rb

@@ -0,0 +1,14 @@
+require 'spec_helper'
+
+describe 'Mad Chatter Simple Extensions' do
+  
+  before(:each) do
+    MadChatter.users = []
+    MadChatter.channels = []
+  end
+  
+  it 'should allow you to define simple extensions that work' do
+    
+  end
+  
+end

data/templates/config.yml

@@ -2,5 +2,4 @@
 #       Mad Chatter Configuration      #
 # ------------------------------------ #
 
-websocket_backend: MadChatter::Servers::EventMachineWebSocket
 websocket_port: 8100

data/templates/extensions/earthquake.rb

@@ -0,0 +1,11 @@
+class Earthquake < MadChatter::Extension
+
+  def handle(message)
+    if message.text == '/earthquake'
+      send_status_message "#{message.username} has just caused an earthquake!"
+      send_action 'earthquake' # call a javascript function named 'earthquake'
+      stop_message_handling
+    end
+  end
+
+end

data/templates/extensions/example.rb

@@ -1,16 +1,12 @@
-# this definitely doesnt work anymore
-
-class Example
-  # include MadChatter::Extension
+class MadChatterExtensionExample < MadChatter::Extension
   
   def handle(message)
     if message.text == 'show me an example'
       send_status_message "#{message.username} really wants an example"
       send_message 'I said...I want an example!!!'
-      stop_message_handling   # and don't let any other extensions handle it
-    else
-      # let other extensions handle it
+      stop_message_handling
     end
+    # ...otherwise, let other extensions have a chance at handling it
   end
   
 end

data/templates/extensions.rb

@@ -1,31 +1,19 @@
 #
 # Simple Mad Chatter Extensions
 #
-# You can add as many extensions as you want in this file using the 
-# simple extension syntax. For more complicated extensions, add your
-# classes to the extensions directory.
+# This file provides you with an easy way to extend Mad Chatter
+# and react to different chat messages.
 #
-# Example:
-#
-#   on_message /hey andrew: (.+)/ do |regex_capture|
-#     send_status_message 'Someone is talking to andrew'
-#   end
+# Example Extension:
 #
+# on_message %r{ hey andrew: (.+) } do |regex_capture|
+#   send_status_message "Someone is talking to Andrew"
+#   send_message "message: #{regex_capture}"
+#   stop_message_handling
+# end
 
-#nothing in this file will work, now that we have multiple channels, sorry!!
 
 # on_message %r{^/youtube http://youtu.be/(.*)$} do |youtube_id|
 #   send_message "<iframe width='560' height='315' src='http://www.youtube.com/embed/#{youtube_id}' frameborder='0' allowfullscreen></iframe>"
 #   stop_message_handling
-# end
-# 
-# on_message %r{^/alert (.*)$} do |alert_message|
-#   send_action 'show_alert', alert_message
-#   stop_message_handling
-# end
-# 
-# on_message %r{^/earthquake$} do
-#   send_status_message 'Someone has just caused an earthquake!'
-#   send_action 'earthquake'
-#   stop_message_handling
 # end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mad_chatter
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.3.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-17 00:00:00.000000000Z
+date: 2012-02-18 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
-  requirement: &2165016220 !ruby/object:Gem::Requirement
+  requirement: &2160471460 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2165016220
+  version_requirements: *2160471460
 - !ruby/object:Gem::Dependency
   name: eventmachine
-  requirement: &2165009100 !ruby/object:Gem::Requirement
+  requirement: &2160471040 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2165009100
+  version_requirements: *2160471040
 - !ruby/object:Gem::Dependency
   name: em-websocket
-  requirement: &2165008680 !ruby/object:Gem::Requirement
+  requirement: &2160470620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2165008680
+  version_requirements: *2160470620
 - !ruby/object:Gem::Dependency
   name: daemons
-  requirement: &2165008180 !ruby/object:Gem::Requirement
+  requirement: &2160470120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - =
@@ -54,10 +54,10 @@ dependencies:
         version: 1.1.4
   type: :runtime
   prerelease: false
-  version_requirements: *2165008180
+  version_requirements: *2160470120
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2165007700 !ruby/object:Gem::Requirement
+  requirement: &2160469700 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2165007700
+  version_requirements: *2160469700
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: &2165007160 !ruby/object:Gem::Requirement
+  requirement: &2160469180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2165007160
+  version_requirements: *2160469180
 - !ruby/object:Gem::Dependency
   name: guard
-  requirement: &2165006660 !ruby/object:Gem::Requirement
+  requirement: &2160468740 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,10 +87,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2165006660
+  version_requirements: *2160468740
 - !ruby/object:Gem::Dependency
   name: guard-rspec
-  requirement: &2165006100 !ruby/object:Gem::Requirement
+  requirement: &2160468220 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -98,10 +98,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2165006100
+  version_requirements: *2160468220
 - !ruby/object:Gem::Dependency
   name: rb-fsevent
-  requirement: &2165005240 !ruby/object:Gem::Requirement
+  requirement: &2160467720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -109,10 +109,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2165005240
+  version_requirements: *2160467720
 - !ruby/object:Gem::Dependency
   name: ruby-growl
-  requirement: &2165004800 !ruby/object:Gem::Requirement
+  requirement: &2160467040 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -120,7 +120,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2165004800
+  version_requirements: *2160467040
 description: Mad Chatter is a fun, easy to customize chat server, utilizing HTML 5
   Web Sockets
 email:
@@ -145,15 +145,15 @@ files:
 - lib/mad_chatter/channel.rb
 - lib/mad_chatter/config.rb
 - lib/mad_chatter/daemon.rb
-- lib/mad_chatter/extensions.rb
+- lib/mad_chatter/extension.rb
 - lib/mad_chatter/message.rb
 - lib/mad_chatter/message_history.rb
-- lib/mad_chatter/message_listener.rb
 - lib/mad_chatter/message_listeners/channel_commands.rb
 - lib/mad_chatter/message_listeners/code.rb
 - lib/mad_chatter/message_listeners/image.rb
 - lib/mad_chatter/message_listeners/markdown.rb
 - lib/mad_chatter/message_listeners/nick.rb
+- lib/mad_chatter/message_listeners/video.rb
 - lib/mad_chatter/server.rb
 - lib/mad_chatter/servers/em_websocket.rb
 - lib/mad_chatter/user.rb
@@ -167,9 +167,11 @@ files:
 - spec/message_listeners/code_spec.rb
 - spec/message_listeners/markdown_spec.rb
 - spec/message_spec.rb
+- spec/simple_extensions_spec.rb
 - spec/spec_helper.rb
 - templates/config.yml
 - templates/extensions.rb
+- templates/extensions/earthquake.rb
 - templates/extensions/example.rb
 - templates/web/css/bootstrap.css
 - templates/web/css/bootstrap.min.css
@@ -219,4 +221,5 @@ test_files:
 - spec/message_listeners/code_spec.rb
 - spec/message_listeners/markdown_spec.rb
 - spec/message_spec.rb
+- spec/simple_extensions_spec.rb
 - spec/spec_helper.rb

data/lib/mad_chatter/extensions.rb

@@ -1,12 +0,0 @@
-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/message_listener.rb

@@ -1,17 +0,0 @@
-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