tinder 1.3.1 → 1.4.0

data/CHANGELOG.txt

@@ -1,3 +1,24 @@
+1.4 - 2010-05-11
+* Remove methods no longer supported by API
+  Campfire#available_transcripts, Room#ping, Room#destroy, Room#toggle_guest_access
+* Added Room#play
+* ActiveSupport 3.0 support
+* Fix streaming API support
+* Allow SSL for listening
+* Add support for HTTP proxies [c13bcc0b]
+
+1.3.1 - 2009-12-17
+* Declare HTTParty dependency
+* Fix Room#paste
+
+1.3.0 - 2009-12-15
+* Rewrite to use Official Campfire API
+
+1.2.2 - 2009-09-12
+* Work around CSRF protection bug
+* Fixes for changes to Campfire markup
+* Include timestamps in the transcript
+
 1.2.1 - 2009-08-27
 * Fixes for listening after campfire updates [Jordan Byron]
 

data/README.markdown

@@ -0,0 +1,39 @@
+# Tinder - get the Campfire started
+
+Tinder is a library for interfacing with Campfire, the chat application from 37Signals, allowing you to programmatically manage and speak/listen in chat rooms.  As of December 2009, thanks to initial work from Joshua Peek at 37signals, it now makes use of the official Campfire API (described at: http://developer.37signals.com/campfire/).
+
+## Usage
+
+    campfire = Tinder::Campfire.new 'mysubdomain', :token => '546884b3d8fee4d80665g561caf7h9f3ea7b999e'
+    # or you can still use username/password and Tinder will look up your token
+    # campfire = Tinder::Campfire.new 'mysubdomain', :username => 'user', :password => 'pass'
+  
+    room = campfire.rooms.first
+    room.rename 'New Room Names'
+    room.speak 'Hello world!'
+    room.paste "my pasted\ncode"
+
+    room = campfire.find_room_by_guest_hash 'abc123', 'John Doe'
+    room.speak 'Hello world!'
+  
+See the RDoc for more details.
+
+## Installation
+
+    gem install tinder
+  
+## How to contribute
+
+If you find what looks like a bug:
+
+1. Check the GitHub issue tracker to see if anyone else has had the same issue.
+   http://github.com/collectiveidea/tinder/issues/
+2. If you don't see anything, create an issue with information on how to reproduce it.
+
+If you want to contribute an enhancement or a fix:
+
+1. Fork the project on github.
+   http://github.com/collectiveidea/tinder
+2. Make your changes with tests.
+3. Commit the changes without making changes to the Rakefile, VERSION, or any other files that aren't related to your enhancement or fix
+4. Send a pull request.

data/Rakefile

@@ -2,8 +2,8 @@ begin
   require 'jeweler'
   Jeweler::Tasks.new do |gem|
     gem.name = "tinder"
-    gem.summary = "An (unofficial) Campfire API"
-    gem.description = "An API for interfacing with Campfire, the 37Signals chat application."
+    gem.summary = "Ruby wrapper for the Campfire API"
+    gem.description = "A Ruby API for interfacing with Campfire, the 37Signals chat application."
     gem.authors = ['Brandon Keepers']
     gem.email = 'brandon@opensoul.org'
     gem.homepage = 'http://github.com/collectiveidea/tinder'
@@ -11,35 +11,16 @@ begin
     gem.add_dependency "activesupport"
     gem.add_dependency "httparty"
     gem.add_dependency "mime-types"
+    gem.add_dependency "twitter-stream"
+    gem.add_dependency "eventmachine"
     gem.add_development_dependency "rspec"
+    gem.add_development_dependency "fakeweb"
   end
   Jeweler::GemcutterTasks.new
 rescue LoadError
   puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
 end
 
-require 'rake/testtask'
-Rake::TestTask.new(:test) do |test|
-  test.libs << 'lib' << 'test'
-  test.pattern = 'test/**/*_test.rb'
-  test.verbose = true
-end
-
-begin
-  require 'rcov/rcovtask'
-  Rcov::RcovTask.new do |test|
-    test.libs << 'test'
-    test.pattern = 'test/**/*_test.rb'
-    test.verbose = true
-  end
-rescue LoadError
-  task :rcov do
-    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
-  end
-end
-
-task :test => :check_dependencies
-
 require 'rake/rdoctask'
 Rake::RDocTask.new do |rdoc|
   if File.exist?('VERSION')
@@ -60,6 +41,11 @@ Spec::Rake::SpecTask.new do |t|
   t.spec_opts = ['--options', "spec/spec.opts"]
   t.spec_files = FileList['spec/**/*_spec.rb']
 end
+task :spec => :check_dependencies
 
-desc "Run tests"
-task :default => [:spec, :test]
+task :default do
+  %w(2.3.5 3.0.0.beta3).each do |version|
+    puts "Running specs with Rails #{version}"
+    system("RAILS_VERSION=#{version} rake -s spec;")
+  end
+end

data/VERSION

@@ -1 +1 @@
-1.3.1
+1.4.0

data/lib/tinder.rb

@@ -1,9 +1,5 @@
-require 'rubygems'
 require 'active_support'
-require 'uri'
-require 'net/http'
-require 'net/https'
-require 'open-uri'
+require 'active_support/json'
 
 require 'tinder/connection'
 require 'tinder/multipart'
@@ -13,4 +9,6 @@ require 'tinder/room'
 module Tinder
   class Error < StandardError; end
   class SSLRequiredError < Error; end
+  class AuthenticationFailed < Error; end
+  class ListenFailed < Error; end
 end

data/lib/tinder/campfire.rb

@@ -2,8 +2,7 @@ module Tinder
 
   # == Usage
   #
-  #   campfire = Tinder::Campfire.new 'mysubdomain'
-  #   campfire.login 'myemail@example.com', 'mypassword'
+  #   campfire = Tinder::Campfire.new 'mysubdomain', :token => 'xyz'
   #
   #   room = campfire.create_room 'New Room', 'My new campfire room to test tinder'
   #   room.speak 'Hello world!'
@@ -12,9 +11,7 @@ module Tinder
   #   room = campfire.find_room_by_guest_hash 'abc123', 'John Doe'
   #   room.speak 'Hello world!'
   class Campfire
-    HOST = "campfirenow.com"
-
-    attr_reader :connection, :subdomain, :uri
+    attr_reader :connection
 
     # Create a new connection to the campfire account with the given +subdomain+.
     #
@@ -25,42 +22,14 @@ module Tinder
     #
     #   c = Tinder::Campfire.new("mysubdomain", :ssl => true)
     def initialize(subdomain, options = {})
-      options = { :ssl => false }.merge(options)
-      @connection = Connection.new
-      @cookie = nil
-      @subdomain = subdomain
-      @uri = URI.parse("#{options[:ssl] ? 'https' : 'http' }://#{subdomain}.#{HOST}")
-      connection.base_uri @uri.to_s
-      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
-
-    # Log in to campfire using your +email+ and +password+
-    def login(username, password)
-      connection.basic_auth(username, password)
-      @logged_in = true
-    end
-
-    # Returns true when successfully logged in
-    def logged_in?
-      @logged_in == true
-    end
-
-    def logout
-      connection.default_options.delete(:basic_auth)
-      @logged_in = false
+      @connection = Connection.new(subdomain, options)
     end
 
     # Get an array of all the available rooms
     # TODO: detect rooms that are full (no link)
     def rooms
       connection.get('/rooms.json')['rooms'].map do |room|
-        Room.new(self, room)
+        Room.new(connection, room)
       end
     end
 
@@ -85,22 +54,13 @@ module Tinder
     end
 
     # List the users that are currently chatting in any room
-    def users(*room_names)
-      rooms.map(&: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)
-      raise NotImplementedError
+    def users
+      rooms.map(&:users).flatten.compact.uniq.sort_by {|u| u[:name]}
     end
 
-    # Is the connection to campfire using ssl?
-    def ssl?
-      uri.scheme == 'https'
+    # get the user info of the current user
+    def me
+      connection.get("/users/me.json")["user"]
     end
   end
 end

data/lib/tinder/connection.rb

@@ -1,13 +1,61 @@
 require 'httparty'
+require 'active_support/core_ext/hash/indifferent_access'
+
+# override HTTParty's json parser to return a HashWithIndifferentAccess
+module HTTParty
+  class Parser
+    protected
+    def json
+      result = Crack::JSON.parse(body)
+      if result.is_a?(Hash)
+        result = HashWithIndifferentAccess.new(result)
+      end
+      result
+    end
+  end
+end
 
 module Tinder
   class Connection
-    def initialize
+    HOST = "campfirenow.com"
+
+    attr_reader :subdomain, :uri, :options
+    
+    def initialize(subdomain, options = {})
+      @subdomain = subdomain
+      @options = { :ssl => false, :proxy => ENV['HTTP_PROXY'] }.merge(options)
+      @uri = URI.parse("#{@options[:ssl] ? 'https' : 'http' }://#{subdomain}.#{HOST}")
+      @token = options[:token]
+      
+      
       class << self
         include HTTParty
-
+        extend HTTPartyExtensions
+        
         headers 'Content-Type' => 'application/json'
       end
+      
+      if @options[:proxy]
+        proxy_uri = URI.parse(@options[:proxy])
+        http_proxy proxy_uri.host, proxy_uri.port
+      end
+      base_uri @uri.to_s
+      basic_auth token, 'X'
+    end
+    
+    module HTTPartyExtensions
+      def perform_request(http_method, path, options) #:nodoc:
+        response = super
+        raise AuthenticationFailed if response.code == 401
+        response
+      end
+    end
+    
+    def token
+      @token ||= begin
+        self.basic_auth(options[:username], options[:password])
+        self.get('/users/me.json')['user']['api_auth_token']
+      end
     end
 
     def metaclass
@@ -17,5 +65,11 @@ module Tinder
     def method_missing(*args, &block)
       metaclass.send(*args, &block)
     end
+    
+    # Is the connection to campfire using ssl?
+    def ssl?
+      uri.scheme == 'https'
+    end
+    
   end
 end

data/lib/tinder/room.rb

@@ -3,8 +3,8 @@ module Tinder
   class Room
     attr_reader :id, :name
 
-    def initialize(campfire, attributes = {})
-      @campfire = campfire
+    def initialize(connection, attributes = {})
+      @connection = connection
       @id = attributes['id']
       @name = attributes['name']
       @loaded = false
@@ -20,18 +20,9 @@ module Tinder
       post 'leave'
     end
 
-    # Toggle guest access on or off
-    def toggle_guest_access
-      raise NotImplementedError
-    end
-
     # Get the url for guest access
     def guest_url
-      if guest_access_enabled?
-        "http://#{@campfire.subdomain}.campfirenow.com/#{guest_invite_code}"
-      else
-        nil
-      end
+      "#{@connection.uri}/#{guest_invite_code}" if guest_access_enabled?
     end
 
     def guest_access_enabled?
@@ -47,13 +38,17 @@ module Tinder
 
     # Change the name of the room
     def name=(name)
-      connection.post("/room/#{@id}.json", :body => { :room => { :name => name } })
+      update :name => name
     end
     alias_method :rename, :name=
 
     # Change the topic
     def topic=(topic)
-      connection.post("/room/#{@id}.json", :body => { :room => { :topic => name } })
+      update :topic => topic
+    end
+    
+    def update(attrs)
+      connection.put("/room/#{@id}.json", :body => {:room => attrs}.to_json)
     end
 
     # Get the current topic
@@ -72,14 +67,6 @@ module Tinder
       post :unlock
     end
 
-    def ping(force = false)
-      raise NotImplementedError
-    end
-
-    def destroy
-      raise NotImplementedError
-    end
-
     # Post a new message to the chat room
     def speak(message, options = {})
       send_message(message)
@@ -89,47 +76,75 @@ module Tinder
       send_message(message, 'PasteMessage')
     end
 
+    def play(sound)
+      send_message(sound, 'SoundMessage')
+    end
+
     # Get the list of users currently chatting for this room
     def users
       reload!
       @users
     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
+    # return the user with the given id; if it isn't in our room cache, do a request to get it
+    def user(id)
+      if id
+        user = users.detect {|u| u[:id] == id }
+        unless user
+          user_data = connection.get("/users/#{id}.json")
+          user = user_data && user_data[:user]
+        end
+        user[:created_at] = Time.parse(user[:created_at])        
+        user
+      end
+    end
+    
+    # Listen for new messages in the room, yielding them to the provided block as they arrive.
+    # Each message is a hash with:
+    # * +:body+: the body of the message
+    # * +:user+: Campfire user, which is itself a hash, of:
+    #   * +:id+: User id
+    #   * +:name+: User name
+    #   * +:email_address+: Email address
+    #   * +:admin+: Boolean admin flag
+    #   * +:created_at+: User creation timestamp
+    #   * +:type+: User type (e.g. Member)
     # * +: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.
+    # * +:type+: Campfire message type
+    # * +:room_id+: Campfire room id
+    # * +:created_at+: Message creation timestamp
     #
     #   room.listen do |m|
-    #     room.speak "#{m[:person]}, Go away!" if m[:message] =~ /Java/i
+    #     room.speak "Go away!" if m[:body] =~ /Java/i
     #   end
-    #
-    def listen(interval = 5)
-      require 'yajl/http_stream'
+    def listen(options = {})
+      raise "no block provided" unless block_given?
+
+      join # you have to be in the room to listen
 
+      require 'twitter/json_stream'
+      
       auth = connection.default_options[:basic_auth]
-      url = URI.parse("http://#{auth[:username]}:#{auth[:password]}@streaming.#{Campfire::HOST}/room/#{@id}/live.json")
-      Yajl::HttpStream.get(url) do |message|
-        { :id => message['id'],
-          :user_id => message['user_id'],
-          :message => message['body'] }
+      options = {
+        :host => "streaming.#{Connection::HOST}",
+        :path => room_url_for(:live),
+        :auth => "#{auth[:username]}:#{auth[:password]}",
+        :timeout => 6,
+        :ssl => connection.options[:ssl]
+      }.merge(options)
+      EventMachine::run do
+        stream = Twitter::JSONStream.connect(options)
+        stream.each_item do |message|
+          message = HashWithIndifferentAccess.new(JSON.parse(message))
+          message[:user] = user(message.delete(:user_id))
+          message[:created_at] = Time.parse(message[:created_at])
+          yield(message)
+        end
+        # if we really get disconnected 
+        raise ListenFailed.new("got disconnected from #{@name}!") if !EventMachine.reactor_running?
       end
     end
 
-    # Get the dates for the available transcripts for this room
-    def available_transcripts
-      raise NotImplementedError
-    end
-
     # Get the transcript for the given date (Returns a hash in the same format as #listen)
     #
     #   room.transcript(room.available_transcripts.first)
@@ -154,13 +169,13 @@ module Tinder
     def upload(filename)
       File.open(filename, "rb") do |file|
         params = Multipart::MultipartPost.new('upload' => file)
-        connection.post("/room/#{@id}/uploads.json", :body => params.query)
+        post(:uploads, :body => params.query)
       end
     end
 
     # Get the list of latest files for this room
     def files(count = 5)
-      connection.get(room_url_for(:uploads))['uploads'].map { |u| u['full_url'] }
+      get(:uploads)['uploads'].map { |u| u['full_url'] }
     end
 
     protected
@@ -175,14 +190,14 @@ module Tinder
         @name = attributes['name']
         @topic = attributes['topic']
         @full = attributes['full']
-        @open_to_guests = attributes['open-to-guests']
-        @active_token_value = attributes['active-token-value']
-        @users = attributes['users'].map { |u| u['name'] }
+        @open_to_guests = attributes['open_to_guests']
+        @active_token_value = attributes['active_token_value']
+        @users = attributes['users']
 
         @loaded = true
       end
 
-      def send_message(message, type = 'Textmessage')
+      def send_message(message, type = 'TextMessage')
         post 'speak', :body => {:message => {:body => message, :type => type}}.to_json
       end
 
@@ -199,7 +214,7 @@ module Tinder
       end
 
       def connection
-        @campfire.connection
+        @connection
       end
   end
 end