jschat 0.1.1

data/MIT-LICENSE

@@ -0,0 +1,23 @@
+Copyright (c) 2009 Alex R. Young
+
+Permission is hereby granted, free of charge, to any person
+obtaining a copy of this software and associated documentation
+files (the "Software"), to deal in the Software without
+restriction, including without limitation the rights to use,
+copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.
+

data/README.textile

@@ -0,0 +1,71 @@
+!http://github.com/alexyoung/jschat/raw/8c11578439770962d86d6444d0c159cfb2affbcd/http/public/images/jschat.gif!
+
+JsChat is a chat system.  It has an easy to learn JSON protocol, an ncurses client, a web app, and a server.  You can try it right now on "jschat.org":http://jschat.org.
+
+JsChat is similar to IRC, but it's a fundamentally simpler system.
+
+The *web app* has lots of interesting features:
+
+* IRC-like commands: /names, /name new_name (/nick works too), /clear, /lastlog
+* It's pretty tiny; it's built with "Sinatra":http://www.sinatrarb.com and "Prototype":http://prototypejs.org
+* Auto-linking: pasting an image displays it inline, youtube and vimeo videos will appear as well
+* Last messages are displayed on join: the last 100 messages are displayed, so you don't feel lost when you join a room
+* Tab completion!
+
+!http://dl.getdropbox.com/u/221414/blogs/jschat.png!
+
+h3. Installation
+
+You can install with rubygems:
+
+<pre>gem install jschat</pre>
+
+Then run <code>jschat-server</code> and <code>jschat-client</code> to try out the console client locally.
+
+To try out the web client, run <code>jschat-web</code> and visit "http://localhost:4567":http://localhost:4567.
+
+h3. Ruby Library Requirements
+
+These gems are required by JsChat:
+
+* eventmachine
+* ncurses (for the client)
+* json
+
+h3. Usage
+
+* Run the server with <em>./server.rb</em>
+* Connect a client with <em>./client.rb</em>
+
+The web app must be run alongside the server.  The web app must be started in production mode:
+
+<code>http/jschat.rb -e production</code>
+
+The web app currently has no database dependencies, it's a wrapper that links cookies to JsChat server proxies.  You can run it on port 80 by configuring Rack or an Apache proxy.  I have Apache set up this way on "jschat.org":http://jschat.org.
+
+h3. Client Commands
+
+* Change name or identify: <code>/nick name</code>
+* Join a room: <code>/join #room</code>
+* Join a room (alias): <code>/j #room</code>
+
+h3. Protocol Design
+
+The protocol is designed to be as close to executable JSON as possible, so clients and servers are simple to implement.
+
+Look at <em>client.rb</em> <code>JsChat::Protocol</code> to see what I mean.
+
+h3. Hey, this is like Campfire!
+
+I love Campfire and I didn't intend for JsChat to compete with it.  JsChat is just a fun project, it doesn't offer Campfire's business-friendly interface, file hosting, transcripts and Basecamp integration.
+
+h3. Credits
+
+JsChat was created by "Alex Young":http://alexyoung.org for "Helicoid":http://helicoid.net.  A growing group of friends are helping out:
+
+* "nickmartini":http://github.com/nickmartini
+* "gabrielg":http://github.com/gabrielg
+* "Simon Starr":http://github.com/sstarr
+* Kevin Ford
+
+If you'd like to contribute, send "alexyoung":http://github.com/alexyoung a message on GitHub.

data/bin/jschat-client

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+
+require 'jschat/client'

data/bin/jschat-server

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+
+require 'logger'
+require 'jschat/server'
+
+logger = Logger.new(STDERR)
+logger = Logger.new(STDOUT)
+
+ServerConfig = {
+  :port => 6789,
+  :ip => '0.0.0.0',
+  :logger => logger,
+  :max_message_length => 500
+}
+
+EM.run do
+  EM.start_server ServerConfig[:ip], ServerConfig[:port], JsChat
+end

data/bin/jschat-web

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+require 'rubygems'
+require 'sinatra'
+
+set :environment, :production
+require 'jschat/http/jschat'
+Sinatra::Application.run!