matsimitsu-tinder 1.3.1

data/.gitignore

@@ -0,0 +1,3 @@
+pkg
+rdoc
+test/remote/credentials.rb

data/CHANGELOG.txt

@@ -0,0 +1,39 @@
+1.2.1 - 2009-08-27
+* Fixes for listening after campfire updates [Jordan Byron]
+
+1.2.0 - 2009-01-28
+* Get the list of available files [Christopher MacGown]
+* Upload files [Joshua Wand]
+* Find rooms even when full [Josh Owens]
+* Join rooms as a guest [Ian Lesperance]
+
+1.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]
+
+0.1.5 - 2008-01-25
+* Fixed Room#listen, which was broken by latest Campfire deploy
+* Fixed timeout when listening but not speaking that will eventually log you out [Clinton R. Nixon]
+
+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
+* fixed bug preventing #listen from working without a block
+
+0.1.1 - 2007-01-27
+* fix bug preventing speak from working
+* incorporated "watching" from http://soylentfoo.jnewland.com/articles/2006/12/07/updates-to-marshmallow-the-campfire-bot
+
+0.1.0 - 2007-01-23
+* Initial release as gem
+* Get the users in a room [Tero Parviainen]

data/Manifest.txt

@@ -0,0 +1,10 @@
+CHANGELOG.txt
+Manifest.txt
+README.txt
+Rakefile
+init.rb
+lib/tinder.rb
+lib/tinder/campfire.rb
+lib/tinder/multipart.rb
+lib/tinder/room.rb
+lib/tinder/version.rb

data/README.txt

@@ -0,0 +1,54 @@
+= Tinder - get the Campfire started
+
+
+This branch is a rewrite of Tinder to use the official Campfire API. The API is intended to be backwards compatible so consumers can easily migrate off the HTML API.
+
+-- Joshua Peek (Programmer, 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 = Tinder::Campfire.new 'mysubdomain'
+  campfire.login 'my_token'
+
+  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.
+
+== Installation
+
+Tinder can be installed as a gem or a Rails plugin:
+
+  gem install tinder
+  
+  script/plugin install git://github.com/collectiveidea/tinder.git
+  
+== 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.
+
+== ToDo
+
+* Tests! (unit and remote)
+* Marshmallow-style integration scripts for exception notification and continuous integration

data/Rakefile

@@ -0,0 +1,65 @@
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "matsimitsu-tinder"
+    gem.summary = "An (unofficial) Campfire API"
+    gem.description = "An 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'
+    gem.rubyforge_project = "tinder"
+    gem.add_dependency "activesupport"
+    gem.add_dependency "httparty"
+    gem.add_dependency "mime-types"
+    gem.add_development_dependency "rspec"
+  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')
+    version = File.read('VERSION')
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "tinder #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require 'spec/rake/spectask'
+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 "Run tests"
+task :default => [:spec, :test]

data/VERSION

@@ -0,0 +1 @@
+1.3.1

data/init.rb

@@ -0,0 +1 @@
+require 'lib/tinder'

data/lib/tinder.rb

@@ -0,0 +1,16 @@
+require 'rubygems'
+require 'active_support'
+require 'uri'
+require 'net/http'
+require 'net/https'
+require 'open-uri'
+
+require 'tinder/connection'
+require 'tinder/multipart'
+require 'tinder/campfire'
+require 'tinder/room'
+
+module Tinder
+  class Error < StandardError; end
+  class SSLRequiredError < Error; end
+end

data/lib/tinder/campfire.rb

@@ -0,0 +1,106 @@
+module Tinder
+
+  # == Usage
+  #
+  #   campfire = Tinder::Campfire.new 'mysubdomain'
+  #   campfire.login 'my_token'
+  #
+  #   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
+    HOST = "campfirenow.com"
+
+    attr_reader :connection, :subdomain, :uri
+
+    # Create a new connection to the campfire account with the given +subdomain+.
+    #
+    # == 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 = {})
+      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 token
+    def login(token)
+      connection.basic_auth(token, 'x')
+      @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
+    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)
+      end
+    end
+
+    # Find a campfire room by name
+    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)
+      rooms.detect { |room| room.guest_invite_code == hash }
+    end
+
+    # Creates and returns a new Room with the given +name+ and optionally a +topic+
+    def create_room(name, topic = nil)
+      connection.post('/rooms.json', :body => { :room => { :name => name, :topic => topic } }.to_json)
+      find_room_by_name(name)
+    end
+
+    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
+    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
+    end
+
+    # Is the connection to campfire using ssl?
+    def ssl?
+      uri.scheme == 'https'
+    end
+  end
+end

data/lib/tinder/connection.rb

@@ -0,0 +1,21 @@
+require 'httparty'
+
+module Tinder
+  class Connection
+    def initialize
+      class << self
+        include HTTParty
+
+        headers 'Content-Type' => 'application/json'
+      end
+    end
+
+    def metaclass
+      class << self; self; end
+    end
+
+    def method_missing(*args, &block)
+      metaclass.send(*args, &block)
+    end
+  end
+end

data/lib/tinder/multipart.rb

@@ -0,0 +1,63 @@
+require 'mime/types'
+require 'net/http'
+require 'cgi'
+
+module Multipart #:nodoc:
+  # From: http://deftcode.com/code/flickr_upload/multipartpost.rb
+  ## Helper class to prepare an HTTP POST request with a file upload
+  ## Mostly taken from
+  #http://blade.nagaokaut.ac.jp/cgi-bin/scat.rb/ruby/ruby-talk/113774
+  ### WAS:
+  ## Anything that's broken and wrong probably the fault of Bill Stilwell
+  ##(bill@marginalia.org)
+  ### NOW:
+  ## Everything wrong is due to keith@oreilly.com
+
+  class Param #:nodoc:
+    attr_accessor :k, :v
+    def initialize(k, v)
+      @k = k
+      @v = v
+    end
+
+    def to_multipart
+      "Content-Disposition: form-data; name=\"#{k}\"\r\n\r\n#{v}\r\n"
+    end
+  end
+
+  class FileParam #:nodoc:
+    attr_accessor :k, :filename, :content
+    def initialize(k, filename, content)
+      @k = k
+      @filename = filename
+      @content = content
+    end
+
+    def to_multipart
+      "Content-Disposition: form-data; name=\"#{k}\"; filename=\"#{filename}\"\r\n" +
+        "Content-Transfer-Encoding: binary\r\n" +
+        "Content-Type: #{MIME::Types.type_for(@filename)}\r\n\r\n" +
+        @content + "\r\n"
+    end
+  end
+
+  class MultipartPost #:nodoc:
+    BOUNDARY = 'campfire-is-awesome'
+    HEADER = {"Content-type" => "multipart/form-data, boundary=" + BOUNDARY + " "}
+    TIMEOUT_SECONDS = 30
+
+    attr_accessor :params, :query, :headers
+    def initialize(params)
+      @params = params
+      @query = {}
+      self.prepare_query
+    end
+
+    def prepare_query()
+      @query = @params.map do |k,v|
+        param = v.respond_to?(:read) ? FileParam.new(k, v.path, v.read) : Param.new(k, v)
+        "--#{BOUNDARY}\r\n#{param.to_multipart}"
+      end.join("") + "--#{BOUNDARY}--"
+    end
+  end
+end

data/lib/tinder/room.rb

@@ -0,0 +1,205 @@
+module Tinder
+  # A campfire room
+  class Room
+    attr_reader :id, :name
+
+    def initialize(campfire, attributes = {})
+      @campfire = campfire
+      @id = attributes['id']
+      @name = attributes['name']
+      @loaded = false
+    end
+
+    # Join the room. Pass +true+ to join even if you've already joined.
+    def join(force = false)
+      post 'join'
+    end
+
+    # Leave a room
+    def leave
+      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
+    end
+
+    def guest_access_enabled?
+      load
+      @open_to_guests ? true : false
+    end
+
+    # The invite code use for guest
+    def guest_invite_code
+      load
+      @active_token_value
+    end
+
+    # Change the name of the room
+    def name=(name)
+      connection.post("/room/#{@id}.json", :body => { :room => { :name => name } })
+    end
+    alias_method :rename, :name=
+
+    # Change the topic
+    def topic=(topic)
+      connection.post("/room/#{@id}.json", :body => { :room => { :topic => name } })
+    end
+
+    # Get the current topic
+    def topic
+      load
+      @topic
+    end
+
+    # Lock the room to prevent new users from entering and to disable logging
+    def lock
+      post :lock
+    end
+
+    # Unlock the room
+    def unlock
+      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)
+    end
+
+    def paste(message)
+      send_message(message, 'PasteMessage')
+    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
+    # * +: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)
+      require 'yajl/http_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'] }
+      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)
+    #   #=> [{: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')}.json"
+      connection.get(url)['messages'].map do |room|
+        { :id => room['id'],
+          :user_id => room['user_id'],
+          :message => room['body'],
+          :timestamp => Time.parse(room['created_at']) }
+      end
+    end
+
+    def upload(filename)
+      File.open(filename, "rb") do |file|
+        params = Multipart::MultipartPost.new('upload' => file)
+        connection.post("/room/#{@id}/uploads.json", :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'] }
+    end
+
+    protected
+      def load
+        reload! unless @loaded
+      end
+
+      def reload!
+        attributes = connection.get("/room/#{@id}.json")['room']
+
+        @id = attributes['id']
+        @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'] }
+
+        @loaded = true
+      end
+
+      def send_message(message, type = 'Textmessage')
+        post 'speak', :body => {:message => {:body => message, :type => type}}.to_json
+      end
+
+      def get(action, options = {})
+        connection.get(room_url_for(action), options)
+      end
+
+      def post(action, options = {})
+        connection.post(room_url_for(action), options)
+      end
+
+      def room_url_for(action)
+        "/room/#{@id}/#{action}.json"
+      end
+
+      def connection
+        @campfire.connection
+      end
+  end
+end