collectiveidea-tinder 1.2.2

data/lib/tinder/room.rb

@@ -0,0 +1,246 @@
+module Tinder
+  # A campfire room
+  class Room
+    attr_reader :id, :name
+
+    def initialize(campfire, id, name = nil)
+      @campfire = campfire
+      @id = id
+      @name = name
+    end
+    
+    # Join the room. Pass +true+ to join even if you've already joined.
+    def join(force = false)
+      @room = returning(get("room/#{id}")) do |room|
+        raise Error, "Could not join room" unless verify_response(room, :success)
+        @membership_key = room.body.scan(/\"membershipKey\":\s?\"([a-z0-9]+)\"/).to_s
+        @user_id = room.body.scan(/\"userID\":\s?(\d+)/).to_s
+        @last_cache_id = room.body.scan(/\"lastCacheID\":\s?(\d+)/).to_s
+        @timestamp = room.body.scan(/\"timestamp\":\s?(\d+)/).to_s
+        @idle_since = Time.now
+      end if @room.nil? || force
+      ping
+      true
+    end
+    
+    # Leave a room
+    def leave
+      returning verify_response(post("room/#{id}/leave"), :redirect) do
+        @room, @membership_key, @user_id, @last_cache_id, @timestamp, @idle_since = nil
+      end
+    end
+
+    # Toggle guest access on or off
+    def toggle_guest_access
+      # re-join the room to get the guest url
+      verify_response(post("room/#{id}/toggle_guest_access"), :success) && join(true)
+    end
+
+    # Get the url for guest access
+    def guest_url
+      join
+      link = (Hpricot(@room.body)/"#guest_access h4").first
+      link.inner_html if link
+    end
+    
+    def guest_access_enabled?
+      !guest_url.nil?
+    end
+
+    # The invite code use for guest
+    def guest_invite_code
+      guest_url.scan(/\/(\w*)$/).to_s
+    end
+
+    # Change the name of the room
+    def name=(name)
+      @name = name if verify_response(post("account/edit/room/#{id}", { :room => { :name => name }}, :ajax => true), :success)
+    end
+    alias_method :rename, :name=
+
+    # Change the topic
+    def topic=(topic)
+      topic if verify_response(post("room/#{id}/change_topic", { 'room' => { 'topic' => topic }}, :ajax => true), :success)
+    end
+    
+    # Get the current topic
+    def topic
+      join
+      h = (Hpricot(@room.body)/"#topic")
+      if h
+        (h/:span).remove
+        h.inner_text.strip
+      end
+    end
+    
+    # Lock the room to prevent new users from entering and to disable logging
+    def lock
+      verify_response(post("room/#{id}/lock", {}, :ajax => true), :success)
+    end
+
+    # Unlock the room
+    def unlock
+      verify_response(post("room/#{id}/unlock", {}, :ajax => true), :success)
+    end
+
+    def ping(force = false)
+      returning verify_response(post("room/#{id}/tabs", { }, :ajax => true), :success) do
+        @idle_since = Time.now
+      end if @idle_since < 1.minute.ago || force
+    end
+
+    def destroy
+      verify_response(post("account/delete/room/#{id}"), :success)
+    end
+
+    # Post a new message to the chat room
+    def speak(message, options = {})
+      post_options = {
+        :message => message,
+        :t => Time.now.to_i
+      }.merge(options)
+      
+      post_options.delete(:paste) unless post_options[:paste]
+      response = post("room/#{id}/speak", post_options, :ajax => true)
+        
+      if verify_response(response, :success)
+        message 
+      end
+    end
+
+    def paste(message)
+      speak message, :paste => true
+    end
+    
+    # Get the list of users currently chatting for this room
+    def users
+      @campfire.users name
+    end
+
+    # Get and array of the messages that have been posted to the room. Each
+    # messages is a hash with:
+    # * +:person+: the display name of the person that posted the message
+    # * +:message+: the body of the message
+    # * +:user_id+: Campfire user id
+    # * +:id+: Campfire message id
+    #
+    #   room.listen
+    #   #=> [{:person=>"Brandon", :message=>"I'm getting very sleepy", :user_id=>"148583", :id=>"16434003"}]
+    #
+    # Called without a block, listen will return an array of messages that have been
+    # posted since you joined. listen also takes an optional block, which then polls
+    # for new messages every 5 seconds and calls the block for each message.
+    #
+    #   room.listen do |m|
+    #     room.speak "#{m[:person]}, Go away!" if m[:message] =~ /Java/i
+    #   end
+    #
+    def listen(interval = 5)
+      join
+      if block_given?
+        catch(:stop_listening) do
+          trap('INT') { throw :stop_listening }
+          loop do
+            ping
+            self.messages.each {|msg| yield msg }
+            sleep interval
+          end
+        end
+      else
+        self.messages
+      end
+    end
+    
+    # Get the dates for the available transcripts for this room
+    def available_transcripts
+      @campfire.available_transcripts(id)
+    end
+    
+    # Get the transcript for the given date (Returns a hash in the same format as #listen)
+    #
+    #   room.transcript(room.available_transcripts.first)
+    #   #=> [{:message=>"foobar!",
+    #         :user_id=>"99999",
+    #         :person=>"Brandon",
+    #         :id=>"18659245",
+    #         :timestamp=>=>Tue May 05 07:15:00 -0700 2009}]
+    #
+    # The timestamp slot will typically have a granularity of five minutes.
+    #
+    def transcript(transcript_date)
+      url = "room/#{id}/transcript/#{transcript_date.to_date.strftime('%Y/%m/%d')}"
+      date, time = nil, nil
+      (Hpricot(get(url).body) / ".message").collect do |message|
+        person = (message / '.person span').first
+        if !person
+          # No span for enter/leave the room messages
+          person = (message / '.person').first
+        end
+        body = (message / '.body div').first
+        if d = (message / '.date span').first
+            date = d.inner_html
+        end
+        if t = (message / '.time div').first
+            time = t.inner_html
+        end
+        {:id => message.attributes['id'].scan(/message_(\d+)/).to_s,
+          :person => person ? person.inner_html : nil,
+          :user_id => message.attributes['class'].scan(/user_(\d+)/).to_s,
+          :message => body ? body.inner_html : nil,
+          # Use the transcript_date to fill in the correct year
+          :timestamp => Time.parse("#{date} #{time}", transcript_date)
+        }
+      end
+    end
+    
+    def upload(filename)
+      File.open(filename, "rb") do |file|
+        params = Multipart::MultipartPost.new({'upload' => file, 'submit' => "Upload"})
+        verify_response post("upload.cgi/room/#{@id}/uploads/new", params.query, :multipart => true), :success
+      end
+    end
+    
+    # Get the list of latest files for this room
+    def files(count = 5)
+      join
+      (Hpricot(@room.body)/"#file_list li a").to_a[0,count].map do |link|
+        @campfire.send :url_for, link.attributes['href'][1..-1], :only_path => false
+      end
+    end
+    
+  protected
+    
+    def messages
+      returning [] do |messages|
+        response = post("poll.fcgi", {:l => @last_cache_id, :m => @membership_key,
+          :s => @timestamp, :t => "#{Time.now.to_i}000"}, :ajax => true)
+        if response.body.length > 1
+          lines = response.body.split("\r\n")
+          
+          if lines.length > 0
+            @last_cache_id = lines.pop.scan(/chat.poller.lastCacheID = (\d+)/).to_s
+            lines.each do |msg|
+              unless msg.match(/timestamp_message/)
+                if msg.length > 0
+                  messages << {
+                    :id => msg.scan(/message_(\d+)/).to_s,
+                    :user_id => msg.scan(/user_(\d+)/).to_s,
+                    :person => msg.scan(/\\u003Ctd class=\\"person\\"\\u003E(?:\\u003Cspan\\u003E)?(.+?)(?:\\u003C\/span\\u003E)?\\u003C\/td\\u003E/).to_s,
+                    :message => msg.scan(/\\u003Ctd class=\\"body\\"\\u003E\\u003Cdiv\\u003E(.+?)\\u003C\/div\\u003E\\u003C\/td\\u003E/).to_s
+                  }
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  
+    [:post, :get, :verify_response].each do |method|
+      define_method method do |*args|
+        @campfire.send method, *args
+      end
+    end
+
+  end
+end

data/site/index.html

@@ -0,0 +1,101 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+	"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+	<meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
+	<title>Tinder</title>
+	<link rel="stylesheet" type="text/css" href="http://opensoul.org/stylesheets/code.css" />
+	<link rel="stylesheet" type="text/css" href="stylesheets/style.css" />
+    <link href="http://opensoul.org/stylesheets/ci.css" rel="stylesheet" type="text/css" />
+    <script src="http://opensoul.org/javascripts/code_highlighter.js" type="text/javascript"></script>
+    <script src="http://opensoul.org/javascripts/ruby.js" type="text/javascript"></script>
+</head>
+
+<body>
+<div id="collectiveidea">
+    <a href="http://collectiveidea.com"><img src="http://opensoul.org/images/header_logo.gif" alt="Collective Idea" class="logo" width="17" height="22" /></a>
+    <ul class="links">
+        <li><a href="http://daniel.collectiveidea.com/blog">Daniel</a></li>
+        <li><a href="http://opensoul.org">Brandon</a></li>
+        <li class="name"><a href="http://collectiveidea.com"><img src="http://opensoul.org/images/header_collectiveidea.gif" alt="Collective Idea" width="123" height="21" /></a></li>
+    </ul>
+</div>
+<div id="main">
+    <div id="header">
+        <h1><a href="/">Tinder</a></h1>
+        <p>Getting the campfire started</p>
+        <ul id="nav">
+            <li><a href="tinder">API Docs</a></li>
+            <li><a href="http://rubyforge.org/projects/tinder">RubyForge</a></li>
+            <li><a href="http://opensoul.org/tags/tinder">Blog</a></li>
+        </ul>
+    </div>
+    <div id="content">
+        <p>Tinder is an API for interfacing with <a href="http://campfirenow.com">Campfire</a>, the 37Signals chat application.</p>
+        <h2>Example</h2>
+        
+        <pre><code class="ruby">campfire = Tinder::Campfire.new 'mysubdomain'
+campfire.login 'myemail@example.com', 'mypassword'</code></pre>
+
+<h3>Create, find and destroy rooms</h3>
+<pre><code class="ruby">room = campfire.create_room 'New Room', 'My new campfire room to test tinder'
+room = campfire.find_room_by_name 'Other Room'
+room.destroy</code></pre>
+
+<h3>Speak and Paste</h3>
+<pre><code class="ruby">room.speak 'Hello world!'
+room.paste File.read(&quot;path/to/your/file.txt&quot;)</code></pre>
+
+<h3>Listening</h3>
+<pre><code class="ruby">room.listen
+#=&gt; [{:person=&gt;&quot;Brandon&quot;, :message=&gt;&quot;I'm getting very sleepy&quot;, :user_id=&gt;&quot;148583&quot;, :id=&gt;&quot;16434003&quot;}]
+
+# or in block form
+room.listen do |m|
+  room.speak 'Welcome!' if m[:message] == /hello/
+end</code></pre>
+
+<h3>Guest Access</h3>
+<pre><code class="ruby">room.toggle_guest_access
+room.guest_url         #=> http://mysubdomain.campfirenow.com/11111
+room.guest_invite_code #=> 11111</code></pre>
+
+<h3>Change the name and topic</h3>
+<pre><code class="ruby">room.name = 'Tinder Demo'
+room.topic = 'Showing how to change the room name and topic with tinder…'</code></pre>
+
+<h3>Users</h3>
+<pre><code class="ruby">room.users
+campfire.users # users in all rooms</code></pre>
+
+<h3>Transcripts</h3>
+<pre><code class="ruby">transcript = room.transcript(room.available_transcripts.first)
+#=&gt; [{:message=&gt;&quot;foobar!&quot;, :user_id=&gt;&quot;99999&quot;, :person=&gt;&quot;Brandon&quot;, :id=&gt;&quot;18659245&quot;, :timestamp=&gt;Tue May 05 07:15:00 -0700 2009}]
+</code></pre>
+
+        <p>See the <a href="tinder">API documentation</a> for more details.</p>
+
+        <h2>Installation</h2>
+        
+        <p>Tinder can be installed as a gem or a Rails plugin. Install the gem by executing:</p>
+        
+        <pre>gem install tinder</pre>
+        
+        <p>Or, download it from <a href="http://rubyforge.org/frs/?group_id=2922">RubyForge</a>.</p>
+        
+        <h2>Source</h2>
+        
+        <p>Contributions are welcome and appreciated!  The source is available from:</p>
+        
+        <pre>http://github.com/collectiveidea/tinder</pre>
+    </div>
+</div>
+<script src="http://www.google-analytics.com/urchin.js" type="text/javascript">
+</script>
+<script type="text/javascript">
+_uacct = "UA-194397-8";
+urchinTracker();
+</script>
+</body>
+</html>

data/site/stylesheets/style.css

@@ -0,0 +1,77 @@
+body {
+  font-family: "Lucida Grande", Helvetica, Arial, sans-serif;
+  font-size: 76%;
+  background: #2A2A2A;
+  margin: 0;
+  padding: 0;
+}
+
+#collectiveidea {
+  border-bottom: 1px solid #444;
+}
+
+a {
+  color: #2D5385;
+}
+
+#main {
+  background-color: #FFF;
+  width: 700px;
+  margin: 0 auto;
+  border: 5px #CCC;
+  border-left-style: solid;
+  border-right-style: solid;
+  padding: 0 1em;
+}
+
+#header {
+  position: relative;
+  border-bottom: 1px solid #999;
+  padding: 1em;
+}
+
+#header h1 {
+  margin: 0;
+  padding: 0;
+  color: #2D5385;
+}
+
+#header h1 a {
+  text-decoration: none;
+}
+
+#header p {
+  margin: 0;
+  padding: 0;
+  font-size: 0.8em;
+  color: #999;
+}
+
+#nav {
+  list-style: none;
+  position: absolute;
+  right: 0;
+  top: 0.6em;
+}
+#nav li {
+  display: inline;
+  padding: 0 0.5em;
+}
+
+#content {
+  padding: 1em 0;
+}
+
+dl {
+  background-color: #DDD;
+  padding: 1em;
+  border: 1px solid #CCC;
+}
+dl .pronunciation {
+  color: #C00;
+}
+dl .description {
+  text-transform: uppercase;
+  font-size: 0.8em;
+  font-family: fixed;
+}

data/spec/campfire_spec.rb

@@ -0,0 +1,225 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+describe "Preparing a campfire request" do
+  before do
+    @campfire = Tinder::Campfire.new("foobar")
+    @request = Net::HTTP::Get.new("does_not_matter")
+  end
+  
+  def prepare_request
+    @campfire.send(:prepare_request, @request)
+  end
+  
+  it "should return the request" do
+    prepare_request.should equal(@request)
+  end
+
+  it "should set the cookie" do
+    @campfire.instance_variable_set("@cookie", "foobar")
+    prepare_request['Cookie'].should == 'foobar'
+  end
+  
+  it "should set the user agent" do
+    prepare_request['User-Agent'].should =~ /^Tinder/
+  end
+end
+
+# describe "Performing a campfire request" do
+#   
+#   before do
+#     @response = mock("response")
+#     Net::HTTP.any_instance.stubs(:request).returns(response)
+#     request = Net::HTTP::Get.new("does_not_matter")
+#     response.expects(:[]).with('set-cookie').and_return('foobar')
+#     @campfire.send(:perform_request) { request }
+#   end
+#   
+#   it "should set cookie" do
+#     @campfire.instance_variable_get("@cookie").should == 'foobar'
+#   end
+#   
+# end
+
+describe "Verifying a 200 response" do
+  
+  before do
+    @campfire = Tinder::Campfire.new("foobar")
+    @response = mock("response")
+    @response.should_receive(:code).and_return(200)
+  end
+  
+  it "should return true when expecting success" do
+    @campfire.send(:verify_response, @response, :success).should equal(true)
+  end
+  
+  it "should return false when expecting a redirect" do
+    @campfire.send(:verify_response, @response, :redirect).should equal(false)
+  end
+  
+  it "should return false when expecting a redirect to a specific path" do
+    @campfire.send(:verify_response, @response, :redirect_to => '/foobar').should equal(false)
+  end
+  
+end
+
+describe "Verifying a 302 response" do
+  
+  before do
+    @campfire = Tinder::Campfire.new("foobar")
+    @response = mock("response")
+    @response.should_receive(:code).and_return(302)
+  end
+  
+  it "should return true when expecting redirect" do
+    @campfire.send(:verify_response, @response, :redirect).should equal(true)
+  end
+  
+  it "should return false when expecting success" do
+    @campfire.send(:verify_response, @response, :success).should equal(false)
+  end
+  
+  it "should return true when expecting a redirect to a specific path" do
+    @response.should_receive(:[]).with('location').and_return("/foobar")
+    @campfire.send(:verify_response, @response, :redirect_to => '/foobar').should equal(true)
+  end
+  
+  it "should return false when redirecting to a different path than expected" do
+    @response.should_receive(:[]).with('location').and_return("/baz")
+    @campfire.send(:verify_response, @response, :redirect_to => '/foobar').should equal(false)
+  end
+
+end
+
+describe "A failed login" do
+  
+  before do
+    @campfire = Tinder::Campfire.new 'foobar'
+    @response = mock("response")
+    @campfire.should_receive(:post).and_return(@response)
+    @response.should_receive(:code).and_return("302")
+    @response.should_receive(:[]).with("location").and_return("/login")
+  end
+  
+  it "should raise an error" do
+    lambda do
+      @campfire.login "doesn't", "matter"
+    end.should raise_error(Tinder::Error)
+  end
+  
+  it "should not set logged in status" do
+    @campfire.login 'foo', 'bar' rescue
+    @campfire.logged_in?.should equal(false)
+  end
+  
+end
+
+describe "Accessing a room with guest access" do
+
+  before do
+    @room_id = 123
+    @campfire = Tinder::Campfire.new 'foobar'
+    @response = mock("response")
+    @campfire.stub!(:post).and_return(@response)
+  end
+
+  it "should return a room for the public room" do
+    @response.should_receive(:code).and_return(302)
+    @response.should_receive(:[]).with("location").and_return("/rooms/#{@room_id}")
+
+    room = @campfire.find_room_by_guest_hash "valid_hash", "John Doe"
+    room.should be_kind_of(Tinder::Room)
+  end
+
+  it "should raise an error if given an invalid room hash" do
+    @response.should_receive(:code).and_return(500)
+
+    room = @campfire.find_room_by_guest_hash "invalid_hash", "John Doe"
+    room.should be_nil
+  end
+
+end
+
+describe "Accessing a room" do
+
+  before do
+    @request = mock("request")
+    @response = mock("response")
+    Net::HTTP.stub!(:new).and_return(@request)
+    @request.stub!(:use_ssl=)
+    @request.stub!(:request).and_return(@response)
+    @response.stub!(:[]).and_return(true)
+  end
+
+  describe "when the room is full" do
+  
+    before do
+      @html = File.read(File.dirname(__FILE__) + '/html/full_lobby.html')
+      @response.stub!(:body).and_return(@html)
+      @campfire = Tinder::Campfire.new 'foobar'
+    end
+  
+    it "should return a room" do
+      @campfire.rooms.should_not be_empty
+    end
+    
+    it "should find a room by name" do
+      @campfire.find_room_by_name("Just Fishin").class.should == Tinder::Room
+    end
+  
+  end
+
+  describe "when the room is not full" do
+  
+    before do
+      @html = File.read(File.dirname(__FILE__) + '/html/normal_lobby.html')
+      @response.stub!(:body).and_return(@html)
+      @campfire = Tinder::Campfire.new 'foobar'
+    end
+  
+    it "should return a room" do
+      @campfire.rooms.should_not be_empty
+    end
+  
+    it "should find a room by name" do
+       @campfire.find_room_by_name("Just Fishin").class.should == Tinder::Room
+     end
+  end
+  
+end
+
+describe "Accessing a room's transcript" do
+
+  before do
+    @room = Tinder::Room.new nil, 42
+    @html = File.read(File.dirname(__FILE__) + '/html/transcript.html')
+    @response = mock("response")
+    @response.stub!(:body).and_return(@html)
+    @room.stub!(:get).with("room/42/transcript/2009/05/05").
+        and_return(@response)
+    require 'time'
+    @transcript = @room.transcript(Time.parse("2009-05-05"))
+  end
+
+  it "should return some messages" do
+    @transcript.should_not be_empty
+  end
+
+  describe "the first message" do
+      # This is a timestamp message
+      it "should include a timestamp" do
+        @transcript.first[:timestamp].should == Time.parse("2009-05-05 09:35")
+      end
+  end
+
+  describe "the second message" do
+      it "should include a timestamp" do
+        @transcript.second[:timestamp].should == Time.parse("2009-05-05 09:35")
+      end
+  end
+ 
+  describe "when entering the room" do
+      it "a transcript message should include the person who entered" do
+        @transcript.second[:person].should == "Marcel"
+      end
+  end
+end