tinder 0.1.2 → 0.1.3

data/CHANGELOG.txt

@@ -1,3 +1,6 @@
+0.1.3
+* added ssl support [Tero Parviainen]
+
 0.1.2 - 2007-01-27
 * fixed bug preventing #listen from working without a block
 

data/README.txt

@@ -1,14 +1,18 @@
-= Tinder
+= Tinder - get the Campfire started
 
-Tinder is a library for interfacing with Campfire, the chat application from 37Signals.
+Tinder is a library for interfacing with Campfire, the chat application from 37Signals. Unlike Marshmallow, it is designed to be a full-featured API (since 37Signals doesn't provide a real one), allowing you to programatically manage and speak/listen in chat rooms.
+
+== Usage
 
   campfire = Campfire.new 'mysubdomain'
   campfire.login 'myemail@example.com', 'mypassword'
   room = campfire.create_room 'New Room', 'My new campfire room to test tinder'
   room.rename 'New Room Name'
   room.speak 'Hello world!'
-  room.speak "my pasted\ncode", :paste => true
+  room.paste "my pasted\ncode"
   room.destroy
+  
+  See the RDoc for more details.
 
 == Requirements
 
@@ -16,9 +20,21 @@ Tinder is a library for interfacing with Campfire, the chat application from 37S
   gem install activesupport
 * Hpricot
   gem install hpricot
+  
+== Installation
+
+Tinder can be installed as a gem or a Rails plugin:
+
+  gem install tinder
+  
+  script/plugin install http://source.collectiveidea.com/public/tinder/trunk
+  
+== Development
+
+The source for Tinder is available at http://source.collectiveidea.com/public/tinder/trunk. Development can be followed at http://opensoul.org/tags/tinder.  Contributions are welcome!
 
 == ToDo
 
 * Tests! (unit and remote)
 * Log in via guest url
-* SSL
+* Marshmallow-style integration scripts for exception notification and continuous integration

data/lib/tinder.rb

@@ -1,7 +1,9 @@
 
 require 'rubygems'
 require 'active_support'
+require 'uri'
 require 'net/http'
+require 'net/https'
 require 'open-uri'
 require 'hpricot'
 

data/lib/tinder/campfire.rb

@@ -2,41 +2,52 @@ module Tinder
   
   # == Usage
   #
-  #   campfire = Campfire.new 'mysubdomain'
+  #   campfire = Tinder::Campfire.new 'mysubdomain'
   #   campfire.login 'myemail@example.com', 'mypassword'
   #   room = campfire.create_room 'New Room', 'My new campfire room to test tinder'
   #   room.speak 'Hello world!'
   #   room.destroy
   class Campfire
-    attr_accessor :subdomain, :host
+    attr_reader :subdomain, :uri
 
-    def initialize(subdomain)
+    # Create a new connection to the campfire account with the given +subdomain+.
+    # There's an optional +:ssl+ option to use SSL for the connection.
+    #
+    #   c = Tinder::Campfire.new("mysubdomain", :ssl => true)
+    def initialize(subdomain, options = {})
+      options = { :ssl => false }.merge(options)
       @cookie = nil
-      self.subdomain = subdomain
-      self.host = "#{subdomain}.campfirenow.com"
+      @subdomain = subdomain
+      @uri = URI.parse("#{options[:ssl] ? 'https' : 'http' }://#{subdomain}.campfirenow.com")
     end
-  
+    
+    # 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)
     end
-  
+    
     def logged_in?
       @logged_in
     end
   
     def logout
-      @logged_in = !verify_response(get("logout"), :redirect)
+      returning verify_response(get("logout"), :redirect) do |result|
+        @logged_in = !result
+      end
     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)
     end
-
+    
+    # List the users that are currently chatting in any room
     def users(*room_names)
       users = Hpricot(get.body).search("div.room").collect do |room|
         if room_names.empty? || room_names.include?((room/"h2/a").inner_html)
@@ -46,37 +57,52 @@ module Tinder
       users.flatten.compact.uniq.sort
     end
 
+    # Deprecated: only included for backwards compatability
+    def host #:nodoc:
+      uri.host
+    end
+    
+    # Is the connection to campfire using ssl?
+    def ssl?
+      uri.scheme == 'https'
+    end
+  
   private
 
     def url_for(path = "")
-      "http://#{host}/#{path}"
+      "#{uri}/#{path}"
     end
 
     def post(path, data = {}, options = {})
-      @request = returning Net::HTTP::Post.new(url_for(path)) do |request|
-        prepare_request(request, options)
-        request.add_field 'Content-Type', 'application/x-www-form-urlencoded'
-        request.set_form_data flatten(data)
-      end
-      returning @response = Net::HTTP.new(host, 80).start { |http| http.request(@request) } do |response|
-        @cookie = response['set-cookie'] if response['set-cookie']
+      perform_request(options) do
+        returning Net::HTTP::Post.new(url_for(path)) do |request|
+          request.add_field 'Content-Type', 'application/x-www-form-urlencoded'
+          request.set_form_data flatten(data)
+        end
       end
     end
   
     def get(path = nil, options = {})
-      @request = returning Net::HTTP::Get.new(url_for(path)) do |request|
-        prepare_request(request, options)
-      end
-      returning @response = Net::HTTP.new(host, 80).start { |http| http.request(@request) } do |response|
-        @cookie = response['set-cookie'] if response['set-cookie']
-      end
+      perform_request(options) { Net::HTTP::Get.new(url_for(path)) }
     end
   
     def prepare_request(request, options = {})
-      request.add_field 'Cookie', @cookie if @cookie
-      if options[:ajax]
-        request.add_field 'X-Requested-With', 'XMLHttpRequest'
-        request.add_field 'X-Prototype-Version', '1.5.0_rc1'
+      returning request do
+        request.add_field 'Cookie', @cookie if @cookie
+        if options[:ajax]
+          request.add_field 'X-Requested-With', 'XMLHttpRequest'
+          request.add_field 'X-Prototype-Version', '1.5.0_rc1'
+        end
+      end
+    end
+    
+    def perform_request(options = {}, &block)
+      @request = prepare_request(yield, options)
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = ssl?
+      http.verify_mode = OpenSSL::SSL::VERIFY_NONE if ssl?
+      @response = returning http.request(@request) do |response|
+        @cookie = response['set-cookie'] if response['set-cookie']
       end
     end
   
@@ -93,11 +119,12 @@ module Tinder
 
     def verify_response(response, options = {})
       if options.is_a?(Symbol)
-        case options
+        codes = case options
         when :success then [200]
         when :redirect then 300..399
         else raise ArgumentError.new("Unknown response #{options}")
-        end.include?(response.code.to_i)
+        end
+        codes.include?(response.code.to_i)
       elsif options[:redirect_to]
         verify_response(response, :redirect) && response['location'] == options[:redirect_to]
       else

data/lib/tinder/room.rb

@@ -1,67 +1,110 @@
 module Tinder
+  # A campfire room
   class Room
-    attr_accessor :id, :name
+    attr_reader :id, :name
 
     def initialize(campfire, id, name = nil)
       @campfire = campfire
-      self.id = id
-      self.name = name
-      @room = get("room/#{self.id}")
-      @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
+      @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|
+        return false 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
+      true
+    end
+    
+    # Leave a room
     def leave
-      verify_response get("/room/#{@room_id}/leave"), :redirect
+      returning verify_response(get("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/#{self.id}/toggle_guest_access"), :success)
+      verify_response(post("room/#{id}/toggle_guest_access"), :success)
     end
 
+    # Get the url for guest access
     def guest_url
-      (Hpricot(get("room/#{self.id}").body)/"#guest_access h4").first.inner_html
+      join
+      (Hpricot(@room.body)/"#guest_access h4").first.inner_html
     end
 
+    # The invite code use for guest
     def guest_invite_code
-      guest_url.scan(/^http:\/\/#{@campfire.host}\/(\w*)$/).to_s
+      guest_url.scan(/\/(\w*)$/).to_s
     end
 
-    def rename(name)
-      name if verify_response(post("account/edit/room/#{self.id}", { :room => { :name => name }}, :ajax => true), :success)
+    # 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/#{self.id}/change_topic", { 'room' => { 'topic' => topic }}, :ajax => true), :success)
+      topic if verify_response(post("room/#{id}/change_topic", { 'room' => { 'topic' => topic }}, :ajax => true), :success)
     end
-
+    
+    # Lock the room to prevent new users from entering and to disable logging
     def lock
-      verify_response(post("room/#{self.id}/lock", {}, :ajax => true), :success)
+      verify_response(post("room/#{id}/lock", {}, :ajax => true), :success)
     end
 
+    # Unlock the room
     def unlock
-      verify_response(post("room/#{self.id}/unlock", {}, :ajax => true), :success)
+      verify_response(post("room/#{id}/unlock", {}, :ajax => true), :success)
     end
 
     def destroy
-      verify_response(post("account/delete/room/#{self.id}"), :success)
+      verify_response(post("account/delete/room/#{id}"), :success)
     end
 
+    # Post a new message to the chat room
     def speak(message)
+      join
       send message
     end
-
+    
     def paste(message)
+      join
       send message, { :paste => true }
     end
-
+    
+    # Get the list of users currently chatting for this room
     def users
-       @campfire.users self.name
+      @campfire.users name
     end
     
+    # Get and array of the messages that have been posted to the room since you joined. 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"}]
+    #
+    # 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
+      # FIXME: this method needs refactored!
+      join
       continue = true
       while(continue)
         messages = []
@@ -93,7 +136,6 @@ module Tinder
       end
       messages
     end
-    
 
   private
 
@@ -110,7 +152,7 @@ module Tinder
     end
 
     def send(message, options = {})
-      message if verify_response(post("room/#{self.id}/speak", { :message => message, :t => Time.now.to_i }.merge(options), :ajax => true), :success)
+      message if verify_response(post("room/#{id}/speak", { :message => message, :t => Time.now.to_i }.merge(options), :ajax => true), :success)
     end
 
   end

data/lib/tinder/version.rb

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

data/test/test_helper.rb

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

@@ -39,5 +39,23 @@ class CampfireTest < Test::Unit::TestCase
     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

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.8.11
 specification_version: 1
 name: tinder
 version: !ruby/object:Gem::Version 
-  version: 0.1.2
-date: 2007-01-27 00:00:00 -05:00
+  version: 0.1.3
+date: 2007-02-12 00:00:00 -05:00
 summary: An (unofficial) Campfire API
 require_paths: 
 - lib