tinder 0.1.3 → 0.1.4

data/CHANGELOG.txt

@@ -1,4 +1,8 @@
-0.1.3
+0.1.4 - 2007-07-23
+* Support for transcripts
+* Fixed Room#leave, which was broken by a Campfire deployment [Andy Smith]
+
+0.1.3 - 2007-02-12
 * added ssl support [Tero Parviainen]
 
 0.1.2 - 2007-01-27

data/Manifest.txt

@@ -7,6 +7,3 @@ lib/tinder.rb
 lib/tinder/campfire.rb
 lib/tinder/room.rb
 lib/tinder/version.rb
-test/remote/remote_campfire_test.rb
-test/test_helper.rb
-test/unit/campfire_test.rb

data/lib/tinder.rb

@@ -1,4 +1,3 @@
-
 require 'rubygems'
 require 'active_support'
 require 'uri'
@@ -9,3 +8,7 @@ require 'hpricot'
 
 
 Dir[File.join(File.dirname(__FILE__), 'tinder/**/*.rb')].sort.each { |lib| require lib }
+
+module Tinder
+  class Error < StandardError; end
+end

data/lib/tinder/campfire.rb

@@ -11,7 +11,7 @@ module Tinder
     attr_reader :subdomain, :uri
 
     # Create a new connection to the campfire account with the given +subdomain+.
-    # There's an optional +:ssl+ option to use SSL for the connection.
+    # There's an +:ssl+ option to use SSL for the connection.
     #
     #   c = Tinder::Campfire.new("mysubdomain", :ssl => true)
     def initialize(subdomain, options = {})
@@ -23,11 +23,15 @@ module Tinder
     
     # Log in to campfire using your +email+ and +password+
     def login(email, password)
-      @logged_in = verify_response(post("login", :email_address => email, :password => password), :redirect_to => url_for)
+      unless verify_response(post("login", :email_address => email, :password => password), :redirect_to => url_for(:only_path => false))
+        raise Error, "Campfire login failed"
+      end
+      @logged_in = true
     end
     
+    # Returns true when successfully logged in
     def logged_in?
-      @logged_in
+      @logged_in === true
     end
   
     def logout
@@ -35,16 +39,27 @@ module Tinder
         @logged_in = !result
       end
     end
+    
+    # Get an array of all the available rooms
+    # TODO: detect rooms that are full (no link)
+    def rooms
+      Hpricot(get.body).search("//h2/a").collect do |a|
+        Room.new(self, room_id_from_url(a.attributes['href']), a.inner_html)
+      end
+    end
   
+    # Find a campfire room by name
+    def find_room_by_name(name)
+      rooms.detect {|room| room.name == name }
+    end
+    
     # Creates and returns a new Room with the given +name+ and optionally a +topic+
     def create_room(name, topic = nil)
       find_room_by_name(name) if verify_response(post("account/create/room?from=lobby", {:room => {:name => name, :topic => topic}}, :ajax => true), :success)
     end
     
-    # Find a campfire room by name
-    def find_room_by_name(name)
-      link = Hpricot(get.body).search("//h2/a").detect { |a| a.inner_html == name }
-      link.blank? ? nil : Room.new(self, link.attributes['href'].scan(/room\/(\d*)$/).to_s, name)
+    def find_or_create_room_by_name(name)
+      find_room_by_name(name) || create_room(name)
     end
     
     # List the users that are currently chatting in any room
@@ -56,7 +71,23 @@ module Tinder
       end
       users.flatten.compact.uniq.sort
     end
-
+    
+    # Get the dates of the available transcripts by room
+    #
+    #   campfire.available_transcripts
+    #   #=> {"15840" => [#<Date: 4908311/2,0,2299161>, #<Date: 4908285/2,0,2299161>]}
+    #
+    def available_transcripts(room = nil)
+      url = "files%2Btranscripts"
+      url += "?room_id#{room}" if room
+      transcripts = (Hpricot(get(url).body) / ".transcript").inject({}) do |result,transcript|
+        link = (transcript / "a").first.attributes['href']
+        (result[room_id_from_url(link)] ||= []) << Date.parse(link.scan(/\/transcript\/(\d{4}\/\d{2}\/\d{2})/).to_s)
+        result
+      end
+      room ? transcripts[room.to_s] : transcripts
+    end
+    
     # Deprecated: only included for backwards compatability
     def host #:nodoc:
       uri.host
@@ -68,9 +99,15 @@ module Tinder
     end
   
   private
+  
+    def room_id_from_url(url)
+      url.scan(/room\/(\d*)/).to_s
+    end
 
-    def url_for(path = "")
-      "#{uri}/#{path}"
+    def url_for(*args)
+      options = {:only_path => true}.merge(args.last.is_a?(Hash) ? args.pop : {})
+      path = args.shift
+      "#{options[:only_path] ? '' : uri}/#{path}"
     end
 
     def post(path, data = {}, options = {})
@@ -88,6 +125,7 @@ module Tinder
   
     def prepare_request(request, options = {})
       returning request do
+        request.add_field 'User-Agent', "Tinder/#{Tinder::VERSION::STRING} (http://tinder.rubyforge.org)"
         request.add_field 'Cookie', @cookie if @cookie
         if options[:ajax]
           request.add_field 'X-Requested-With', 'XMLHttpRequest'
@@ -106,7 +144,7 @@ module Tinder
       end
     end
   
-    # flatten a nested hash
+    # flatten a nested hash (:room => {:name => 'foobar'} to 'user[name]' => 'foobar')
     def flatten(params)
       params = params.dup
       params.stringify_keys!.each do |k,v| 
@@ -131,6 +169,6 @@ module Tinder
         false
       end
     end
-  
+    
   end
 end

data/lib/tinder/room.rb

@@ -12,31 +12,37 @@ module Tinder
     # Join the room. Pass +true+ to join even if you've already joined.
     def join(force = false)
       @room = returning(get("room/#{id}")) do |room|
-        return false unless verify_response(room, :success)
+        raise Error, "Could not join room" unless verify_response(room, :success)
         @membership_key = room.body.scan(/\"membershipKey\": \"([a-z0-9]+)\"/).to_s
         @user_id = room.body.scan(/\"userID\": (\d+)/).to_s
         @last_cache_id = room.body.scan(/\"lastCacheID\": (\d+)/).to_s
         @timestamp = room.body.scan(/\"timestamp\": (\d+)/).to_s
-      end unless @room || force
+      end if @room.nil? || force
       true
     end
     
     # Leave a room
     def leave
-      returning verify_response(get("room/#{id}/leave"), :redirect) do
+      returning verify_response(post("room/#{id}/leave"), :redirect) do
         @room, @membership_key, @user_id, @last_cache_id, @timestamp = nil
       end
     end
 
     # Toggle guest access on or off
     def toggle_guest_access
-      verify_response(post("room/#{id}/toggle_guest_access"), :success)
+      # 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
-      (Hpricot(@room.body)/"#guest_access h4").first.inner_html
+      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
@@ -136,6 +142,28 @@ module Tinder
       end
       messages
     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"}]
+    #
+    def transcript(date)
+      (Hpricot(get("room/#{id}/transcript/#{date.to_date.strftime('%Y/%m/%d')}").body) / ".message").collect do |message|
+        person = (message / '.person span').first
+        body = (message / '.body div').first
+        {: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
+        }
+      end
+    end
 
   private
 

data/lib/tinder/version.rb

@@ -2,7 +2,7 @@ module Tinder #:nodoc:
   module VERSION #:nodoc:
     MAJOR = 0
     MINOR = 1
-    TINY  = 3
+    TINY  = 4
     
     STRING = [MAJOR, MINOR, TINY].join('.')
   end

data/test/remote/remote_campfire_test.rb

@@ -3,24 +3,34 @@ require File.dirname(__FILE__) + '/../test_helper'
 class RemoteCampfireTest < Test::Unit::TestCase
   
   def setup
-    @campfire = Tinder::Campfire.new 'opensoul'
-    @user, @pass = 'brandon@opensoul.org', 'testing'
+    @campfire = Tinder::Campfire.new 'domain'
+    #@user, @pass = 'email@example.com', 'password'
+    raise "Set your campfire credentials before running the remote tests" unless @user && @pass
   end
   
   def test_create_and_delete_room
     assert login
-    room = @campfire.create_room('Testing123')
+    assert @campfire.logged_in?
     
-    assert Tinder::Room, room
+    room = @campfire.create_room("Testing#{Time.now.to_i}")
+    
+    assert_instance_of Tinder::Room, room
     assert_not_nil room.id
-    assert_equal "new name", room.rename("new name")
+    
+    room.name = "new name"
+    assert_equal "new name", room.name
     
     room.destroy
-    assert_nil @campfire.find_room_by_name('Testing123')
+    assert_nil @campfire.find_room_by_name(room.name)
+    
+    assert @campfire.logout
+  ensure
+    room.destroy rescue nil
   end
   
   def test_failed_login
     assert !@campfire.login(@user, 'notmypassword')
+    assert !@campfire.logged_in?
   end
   
   def test_find_nonexistent_room

data/test/unit/room_test.rb

@@ -0,0 +1,30 @@
+require File.dirname(__FILE__) + '/../test_helper'
+
+class RoomTest < Test::Unit::TestCase
+  
+  def setup
+    @campfire = Tinder::Campfire.new("foobar")
+    @room = Tinder::Room.new(@campfire, 1, "Room 1")
+  end
+  
+  def test_toggle_guest_access_rejoins_room
+    @response = mock("response")
+    @response.expects(:code).returns("200")
+    @campfire.expects(:post).with('room/1/toggle_guest_access').returns(@response)
+    @campfire.expects(:get).with('room/1').returns(@response)
+    @room.toggle_guest_access
+  end
+  
+  def test_guest_access?
+    mock_response :guest_access_enabled
+    assert @room.guest_access_enabled?
+  end
+  
+private
+
+  def mock_response(response)
+    FakeWeb.register_uri('http://foobar.campfirenow.com/room/1',
+      :file => "#{FIXTURE_DIR}/pages/room/#{response}.html")
+  end
+  
+end

metadata

@@ -1,10 +1,10 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.8.11
+rubygems_version: 0.9.2
 specification_version: 1
 name: tinder
 version: !ruby/object:Gem::Version 
-  version: 0.1.3
-date: 2007-02-12 00:00:00 -05:00
+  version: 0.1.4
+date: 2007-07-23 00:00:00 +03:00
 summary: An (unofficial) Campfire API
 require_paths: 
 - lib
@@ -25,6 +25,7 @@ required_ruby_version: !ruby/object:Gem::Version::Requirement
 platform: ruby
 signing_key: 
 cert_chain: 
+post_install_message: 
 authors: 
 - Brandon Keepers
 files: 
@@ -37,16 +38,16 @@ files:
 - lib/tinder/campfire.rb
 - lib/tinder/room.rb
 - lib/tinder/version.rb
-- test/remote/remote_campfire_test.rb
-- test/test_helper.rb
-- test/unit/campfire_test.rb
 test_files: 
 - test/remote/remote_campfire_test.rb
-- test/unit/campfire_test.rb
-rdoc_options: []
-
-extra_rdoc_files: []
-
+- test/unit/room_test.rb
+rdoc_options: 
+- --main
+- README.txt
+extra_rdoc_files: 
+- CHANGELOG.txt
+- Manifest.txt
+- README.txt
 executables: []
 
 extensions: []
@@ -79,5 +80,5 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 1.1.7
+        version: 1.2.1
     version: 

data/test/test_helper.rb

@@ -1,7 +0,0 @@
-require 'test/unit'
-require 'rubygems'
-require 'active_support'
-require 'breakpoint'
-require File.dirname(__FILE__) + '/../lib/tinder.rb'
-require 'mocha'
-require 'stubba'

data/test/unit/campfire_test.rb

@@ -1,61 +0,0 @@
-require File.dirname(__FILE__) + '/../test_helper'
-
-class CampfireTest < Test::Unit::TestCase
-  
-  def setup
-    @campfire = Tinder::Campfire.new("foobar")
-    @response = mock("response")
-  end
-  
-  def test_verify_response_redirect_true
-    @response.expects(:code).returns(302)
-    assert true === @campfire.send(:verify_response, @response, :redirect)
-  end
-  
-  def test_verify_response_redirect_false
-    @response.expects(:code).returns(200)
-    assert false === @campfire.send(:verify_response, @response, :redirect)
-  end
-    
-  def test_verify_response_success
-    @response.expects(:code).returns(200)
-    assert true === @campfire.send(:verify_response, @response, :success)
-  end
-
-  def test_verify_response_redirect_to
-    @response.expects(:code).returns(304)
-    @response.expects(:[]).with('location').returns("/foobar")
-    assert true === @campfire.send(:verify_response, @response, :redirect_to => '/foobar')
-  end
-  
-  def test_verify_response_redirect_to_without_redirect
-    @response.expects(:code).returns(200)
-    assert false === @campfire.send(:verify_response, @response, :redirect_to => '/foobar')
-  end
-  
-  def test_verify_response_redirect_to_wrong_path
-    @response.expects(:code).returns(302)
-    @response.expects(:[]).with('location').returns("/baz")
-    assert false === @campfire.send(:verify_response, @response, :redirect_to => '/foobar')
-  end
-  
-  def test_prepare_request_returns_request
-    request = Net::HTTP::Get.new("does_not_matter")
-    assert_equal request, @campfire.send(:prepare_request, request)
-  end
-  
-  def test_prepare_request_sets_cookie
-    request = Net::HTTP::Get.new("does_not_matter")
-    @campfire.instance_variable_set("@cookie", "foobar")
-    assert_equal "foobar", @campfire.send(:prepare_request, request)['Cookie']
-  end
-  
-  def test_perform_request
-    response = mock("response")
-    Net::HTTP.any_instance.stubs(:request).returns(response)
-    request = Net::HTTP::Get.new("does_not_matter")
-    response.expects(:[]).with('set-cookie')
-    
-    assert_equal response, @campfire.send(:perform_request) { request }
-  end
-end