tinder 0.1.6 → 0.1.8

data/CHANGELOG.txt

@@ -1,3 +1,14 @@
+0.1.8
+* Get the list of available files [Christopher MacGown]
+* Upload files [Joshua Want]
+* Find rooms even when full [Josh Owens]
+* Join rooms as a guest [Ian Lesperance]
+
+0.1.7 - 2008-07-24
+* Don't join the room when only speaking [Brian Donovan]
+* Added support for HTTP proxies
+* Fix listening for messages that contain URLs [Jared Kuolt]
+
 0.1.6 - 2008-03-07
 * Added Room#topic for getting the current topic [Even Weaver]
 * Trap INT in #listen(&block) [borrowed from Chris Shea's Pyre]

data/README.txt

@@ -6,11 +6,15 @@ Tinder is a library for interfacing with Campfire, the chat application from 37S
 
   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.paste "my pasted\ncode"
   room.destroy
+
+  room = campfire.find_room_by_guest_hash 'abc123', 'John Doe'
+  room.speak 'Hello world!'
   
   See the RDoc for more details.
 
@@ -36,5 +40,4 @@ The source for Tinder is available at http://source.collectiveidea.com/public/ti
 == ToDo
 
 * Tests! (unit and remote)
-* Log in via guest url
 * Marshmallow-style integration scripts for exception notification and continuous integration

data/Rakefile

@@ -1,5 +1,12 @@
 require 'rubygems'
 require 'hoe'
+begin
+  require 'spec/rake/spectask'
+rescue LoadError
+  puts 'To use rspec for testing you must install rspec gem:'
+  puts '$ sudo gem install rspec'
+  exit
+end
 require File.join(File.dirname(__FILE__), 'lib', 'tinder', 'version')
 
 # RDOC_OPTS = ['--quiet', '--title', "Tinder",
@@ -21,4 +28,14 @@ hoe = Hoe.new('tinder', ENV['VERSION'] || Tinder::VERSION::STRING) do |p|
   p.changes = p.paragraphs_of('CHANGELOG.txt', 0..1).join("\n\n")
   p.extra_deps << ['activesupport']
   p.extra_deps << ['hpricot']
+  p.extra_deps << ['mime-types']
+end
+
+desc "Run the specs under spec"
+Spec::Rake::SpecTask.new do |t|
+  t.spec_opts = ['--options', "spec/spec.opts"]
+  t.spec_files = FileList['spec/**/*_spec.rb']
 end
+
+desc "Default task is to run specs"
+task :default => :spec

data/lib/tinder.rb

@@ -10,4 +10,5 @@ Dir[File.join(File.dirname(__FILE__), 'tinder/**/*.rb')].sort.each { |lib| requi
 
 module Tinder
   class Error < StandardError; end
+  class SSLRequiredError < Error; end
 end

data/lib/tinder/campfire.rb

@@ -4,14 +4,22 @@ module Tinder
   #
   #   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
+  #
+  #   room = campfire.find_room_by_guest_hash 'abc123', 'John Doe'
+  #   room.speak 'Hello world!'
   class Campfire
     attr_reader :subdomain, :uri
 
     # Create a new connection to the campfire account with the given +subdomain+.
-    # There's an +:ssl+ option to use SSL for the connection.
+    #
+    # == Options:
+    # * +:ssl+: use SSL for the connection, which is required if you have a Campfire SSL account.
+    #           Defaults to false
+    # * +:proxy+: a proxy URI. (e.g. :proxy => 'http://user:pass@example.com:8000')
     #
     #   c = Tinder::Campfire.new("mysubdomain", :ssl => true)
     def initialize(subdomain, options = {})
@@ -19,6 +27,12 @@ module Tinder
       @cookie = nil
       @subdomain = subdomain
       @uri = URI.parse("#{options[:ssl] ? 'https' : 'http' }://#{subdomain}.campfirenow.com")
+      if options[:proxy]
+        uri = URI.parse(options[:proxy])
+        @http = Net::HTTP::Proxy(uri.host, uri.port, uri.user, uri.password)
+      else
+        @http = Net::HTTP
+      end
       @logged_in = false
     end
     
@@ -27,12 +41,14 @@ module Tinder
       unless verify_response(post("login", :email_address => email, :password => password), :redirect_to => url_for(:only_path => false))
         raise Error, "Campfire login failed"
       end
+      # ensure that SSL is set if required on this account
+      raise SSLRequiredError, "Your account requires SSL" unless verify_response(get, :success)
       @logged_in = true
     end
     
     # Returns true when successfully logged in
     def logged_in?
-      @logged_in === true
+      @logged_in == true
     end
   
     def logout
@@ -44,8 +60,10 @@ module Tinder
     # 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)
+      Hpricot(get.body).search("//div.room").collect do |a|
+        name = a.search("//h2/a").inner_html.strip
+        name = a.search("//h2").inner_html.strip if name.empty?
+        Room.new(self, room_id_from_element(a.attributes['id']), name)
       end
     end
   
@@ -53,6 +71,13 @@ module Tinder
     def find_room_by_name(name)
       rooms.detect {|room| room.name == name }
     end
+
+    # Find a campfire room by its guest hash
+    def find_room_by_guest_hash(hash, name)
+      res = post(hash, :name => name)
+
+      Room.new(self, room_id_from_url(res['location'])) if verify_response(res, :redirect)
+    end
     
     # Creates and returns a new Room with the given +name+ and optionally a +topic+
     def create_room(name, topic = nil)
@@ -99,6 +124,10 @@ module Tinder
     def room_id_from_url(url)
       url.scan(/room\/(\d*)/).to_s
     end
+    
+    def room_id_from_element(element)
+      element.split("_").last
+    end
 
     def url_for(*args)
       options = {:only_path => true}.merge(args.last.is_a?(Hash) ? args.pop : {})
@@ -109,8 +138,11 @@ module Tinder
     def post(path, data = {}, options = {})
       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)
+          if options[:multipart]
+            request.body = data
+          else
+            request.set_form_data(flatten(data))
+          end
         end
       end
     end
@@ -127,12 +159,17 @@ module Tinder
           request.add_field 'X-Requested-With', 'XMLHttpRequest'
           request.add_field 'X-Prototype-Version', '1.5.1.1'
         end
+        if options[:multipart]
+          request.add_field 'Content-Type', 'multipart/form-data, boundary=' + Multipart::MultipartPost::BOUNDARY + " "
+        else
+          request.add_field 'Content-Type', 'application/x-www-form-urlencoded'
+        end
       end
     end
     
     def perform_request(options = {}, &block)
       @request = prepare_request(yield, options)
-      http = Net::HTTP.new(uri.host, uri.port)
+      http = @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|
@@ -154,9 +191,9 @@ module Tinder
     def verify_response(response, options = {})
       if options.is_a?(Symbol)
         codes = case options
-        when :success then [200]
-        when :redirect then 300..399
-        else raise ArgumentError.new("Unknown response #{options}")
+        when :success; [200]
+        when :redirect; 300..399
+        else raise(ArgumentError, "Unknown response #{options}")
         end
         codes.include?(response.code.to_i)
       elsif options[:redirect_to]

data/lib/tinder/room.rb

@@ -44,13 +44,11 @@ module Tinder
     end
     
     def guest_access_enabled?
-      join
       !guest_url.nil?
     end
 
     # The invite code use for guest
     def guest_invite_code
-      join
       guest_url.scan(/\/(\w*)$/).to_s
     end
 
@@ -97,13 +95,20 @@ module Tinder
 
     # Post a new message to the chat room
     def speak(message, options = {})
-      join
-      message if verify_response(post("room/#{id}/speak", {:message => message,
-        :t => Time.now.to_i}.merge(options), :ajax => true), :success)
+      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)
-      join
       speak message, :paste => true
     end
     
@@ -111,7 +116,7 @@ module Tinder
     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
@@ -167,25 +172,35 @@ module Tinder
         }
       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
-          # deal with "chat.redirectTo('/');" - relogin
-          join(true) && self.messages if response.body.match('chat\.redirectTo')
-
           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/)
-                # pull out only the chat.transcript.queueMessage part for now
-                msg = msg.scan(/(chat\.transcript\.queueMessage(?:.+?);)/).to_s
                 if msg.length > 0
                   messages << {
                     :id => msg.scan(/message_(\d+)/).to_s,

data/lib/tinder/version.rb

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

data/test/remote/remote_campfire_test.rb

@@ -3,9 +3,20 @@ require File.dirname(__FILE__) + '/../test_helper'
 class RemoteCampfireTest < Test::Unit::TestCase
   
   def setup
-    @campfire = Tinder::Campfire.new 'domain'
+    # @subdomain = 'domain'
     # @user, @pass = 'email@example.com', 'password'
-    raise "Set your campfire credentials before running the remote tests" unless @user && @pass
+    @ssl = false
+    raise "Set your campfire credentials before running the remote tests" unless @user && @pass && @subdomain
+    @campfire = Tinder::Campfire.new @subdomain, :ssl => @ssl
+  end
+  
+  def test_ssl_required
+    if @ssl
+      campfire = Tinder::Campfire.new @subdomain
+      assert_raises(Tinder::SSLRequiredError) do
+        campfire.login(@user, @pass)
+      end
+    end
   end
   
   def test_create_and_delete_room

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: tinder
 version: !ruby/object:Gem::Version 
-  version: 0.1.6
+  version: 0.1.8
 platform: ruby
 authors: 
 - Brandon Keepers
@@ -9,11 +9,12 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-03-07 00:00:00 -05:00
+date: 2009-01-28 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: activesupport
+  type: :runtime
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
@@ -23,6 +24,17 @@ dependencies:
     version: 
 - !ruby/object:Gem::Dependency 
   name: hpricot
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: mime-types
+  type: :runtime
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
@@ -32,12 +44,13 @@ dependencies:
     version: 
 - !ruby/object:Gem::Dependency 
   name: hoe
+  type: :development
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 1.5.1
+        version: 1.8.2
     version: 
 description: An API for interfacing with Campfire, the 37Signals chat application.
 email: brandon@opensoul.org
@@ -82,7 +95,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: tinder
-rubygems_version: 1.0.1
+rubygems_version: 1.3.1
 signing_key: 
 specification_version: 2
 summary: An (unofficial) Campfire API