firering 0.1.1 → 1.0.0

data/README.rdoc

@@ -4,31 +4,29 @@ Campfire API interface powered by EventMachine and Yajl.
 
   require 'firering'
 
-  Firering.subdomain = "subdomain"
-  Firering.token     = "token"
+  print "Enter subdomain: "; subdomain = gets.chomp
+  print "Enter user: "     ; login     = gets.chomp
+  print "Enter password: " ; password  = gets.chomp
 
-  EM.run do
-    Firering.rooms do |rooms|
-      rooms.each do |room|
-        if room.name == "RoomName"
-
-          puts "Joining #{room.name}"
+  conn = Firering::Connection.new("http://#{subdomain}.campfirenow.com") do |c|
+    c.login = login
+    c.password = password
+  end
 
-          Firering.room_join(room.id) do
-            Firering.stream(room.id) do |message|
+  EM.run do
+    conn.authenticate do |user|
+      conn.rooms do |rooms|
 
-              if message.from_user?
-                Firering.user(message.user_id) do |user|
-                  puts "( #{user.name} ) #{message.body}"
-                end
-              else
-                puts message.body if message.body.to_s !~ /^\s*$/
-              end
+        rooms.each do |room|
+          if room.name == "Room Name"
 
+            room.stream do |message|
+              message.user { |user| puts "#{user}: #{message}" }
             end
-          end
 
+          end
         end
+
       end
     end
 
@@ -37,10 +35,10 @@ Campfire API interface powered by EventMachine and Yajl.
 
 = campf-notify
 
-The gem bundles an executable script for spawning libnotify powered notifications.
-To be able to use it, check your distro package repositories for the apropriate
-package containing the "notify-send" command line utility. In the case of archlinux,
-the package name is "libnotify".
+The gem bundles an executable script for spawning libnotify powered
+notifications.  To be able to use it, check your distro package repositories
+for the apropriate package containing the "notify-send" command line utility.
+In the case of archlinux, the package name is "libnotify".
 
 The script needs the following environment variables in place:
 
@@ -55,10 +53,12 @@ And watch the lovely notifications each time something is posted to a room.
 
 == Running the specs
 
-For running the specs, I opted for running a sinatra application for serving
-the fixture data. The server runs automatically when "rake spec" is executed,
-it runs on the standard sinatra port (4567), so you should make sure that
-port is free when running the specs.
+When the specs are run a process is forked where a Rack application is run.
+This rack application serves all the fixtured responses that mimic the working
+of the real campfire app. The only caveat here is you may get a conflict if you
+are already running something on the port (8909). If this happens you'll need
+to open the specs/spec_helper.rb file and change the port used to run the
+fixtures server.
 
 For more details take a look at spec/fixtures/load_server.rb file.
 

data/Rakefile

@@ -92,7 +92,7 @@ task :release => :build do
   sh "git commit --allow-empty -a -m 'Release #{version}'"
   sh "git tag v#{version}"
   sh "git push origin master"
-  sh "git push v#{version}"
+  sh "git push --tags"
   sh "gem push pkg/#{name}-#{version}.gem"
 end
 

data/bin/campf-notify

@@ -3,51 +3,45 @@
 require 'firering'
 require 'shellwords'
 
-Firering.subdomain = ENV["CAMPFIRE_SUBDOMAIN"].to_s
-Firering.token     = ENV["CAMPFIRE_TOKEN"].to_s
+subdomain, token = ENV["CAMPFIRE_SUBDOMAIN"], ENV["CAMPFIRE_TOKEN"]
+room_name, icon_path = ARGV
 
-room_name = ARGV[0].to_s
-icon_path = ARGV[1].to_s
-
-if Firering.subdomain =~ /^\s*$/ || Firering.token =~ /^\s*$/ || room_name =~ /^\s*$/ || !File.exists?(icon_path)
-  puts "USAGE: campf-notify room-name notify-send-icon-path"
+if subdomain.to_s =~ /^\s*$/ || token.to_s =~ /^\s*$/ || room_name.to_s =~ /^\s*$/ || icon_path.nil? || !File.file?(icon_path)
+  puts "USAGE: campf-notify room-name icon-path"
+  puts
+  puts "Icon path #{icon_path} is incorrect" unless icon_path && File.exists?(icon_path)
+  puts "Room name #{room_name} is missing"   unless room_name =~ /\S/
   puts
-  puts "Icon path #{icon_path} is incorrect\n" unless File.exists?(icon_path)
-  puts "Room name #{room_name} is missing" unless room_name !~ /^\s*$/
-
   puts "The following environment variables are needed: "
   puts
-  puts "CAMPFIRE_SUBDOMAIN: #{Firering.subdomain}"
-  puts "CAMPFIRE_TOKEN:     #{Firering.token}"
+  puts "CAMPFIRE_SUBDOMAIN: #{subdomain || 'missing!'}"
+  puts "CAMPFIRE_TOKEN:     #{token || 'missing!'}"
   puts
-  exit
+  exit 1
 else
-  puts "connecting to #{Firering.subdomain}.#{Firering::HTTP.host}"
+  host = "http://#{subdomain}.campfirenow.com"
+  puts "connecting to #{host}"
 end
 
-EM.run do
-  Firering.rooms do |rooms|
-    rooms.each do |room|
-      if room.name == room_name
+conn = Firering::Connection.new(host) {|c| c.token = token }
 
-        puts "Joining #{room.name}"
-
-        Firering.room_join(room.id) do
-          Firering.stream(room.id) do |message|
+EM.run do
+  conn.rooms do |rooms|
+    room = rooms.detect { |r| r.name == room_name }
 
-            if message.from_user?
-              Firering.user(message.user_id) do |user|
-                m = "( #{user.name} ) #{message.body}"
-                system("notify-send -i #{icon_path.shellescape} -t 10000 Campfire #{m.shellescape}")
-              end
-            else
-              m = message.body.to_s
-              system("notify-send -i #{icon_path.shellescape} -t 10000 Campfire #{m.shellescape}") if m !~ /^\s*$/
-            end
+    unless room
+      puts "Could not find that room. Found rooms:"
+      rooms.each { |room| puts "  * #{room}" }
+      exit 1
+    end
 
-          end
-        end
+    puts "Streaming #{room}"
 
+    room.stream do |message|
+      if message.from_user?
+        message.user { |user| system("notify-send -i #{icon_path.shellescape} -t 10000 Campfire #{ "( #{user} ) #{message}".shellescape }") }
+      else
+        system("notify-send -i #{icon_path.shellescape} -t 10000 Campfire #{message.to_s.shellescape}") if message.to_s =~ /\S/
       end
     end
   end

data/examples/authenticate.rb

@@ -2,19 +2,21 @@ require 'firering'
 
 puts "If you prefer it, you can authenticate your user with u/p instead of the campfire token."
 
-print "Enter subdomain: "
-subdomain = gets.chomp
+print "Enter subdomain: "; subdomain = gets.chomp
+print "Enter user: "     ; login     = gets.chomp
+print "Enter password: " ; password  = gets.chomp
 
-print "Enter user: "
-user = gets.chomp
-
-print "Enter password: "
-password = gets.chomp
+conn = Firering::Connection.new("http://#{subdomain}.campfirenow.com") do |c|
+  c.login = login
+  c.password = password
+end
 
 EM.run do
-  Firering.authenticate(subdomain, user, password) do |user|
+  conn.authenticate do |user|
 
     puts "Token for user #{user.name} is #{user.token}"
+    puts "You can set an environment variable for using it on scripts:"
+    puts "export CAMPFIRE_TOKEN=#{user.token}"
 
     EM.stop
 

data/examples/events.rb

@@ -1,15 +1,21 @@
 require 'firering'
 
-Firering.subdomain = ENV["CAMPFIRE_SUBDOMAIN"]
-Firering.token     = ENV["CAMPFIRE_TOKEN"]
+print "Enter subdomain: "; subdomain = gets.chomp
+print "Enter user: "     ; login     = gets.chomp
+print "Enter password: " ; password  = gets.chomp
+
+conn = Firering::Connection.new("http://#{subdomain}.campfirenow.com") do |c|
+  c.login = login
+  c.password = password
+end
 
 EM.run do
-  Firering.rooms do |rooms|
-    rooms.each do |room|
-      if room.name == "test2"
-        Firering.room_join(room.id) do
-          Firering.stream(room.id) do |message|
+  conn.authenticate do |user|
+    conn.rooms do |rooms|
+      rooms.each do |room|
 
+        if room.name == "test2"
+          room.stream do |message|
             case
             when message.advertisement?   then puts "Handle Ad"
             when message.allow_guests?    then puts "Handle Allow Guests"
@@ -28,9 +34,12 @@ EM.run do
             when message.upload?          then puts "Handle Upload"
             end
 
-            puts message.to_s
+            message.user do |user|
+              puts "#{user}: #{message}"
+            end
           end
         end
+
       end
     end
   end

data/examples/recent_messages.rb

@@ -1,41 +1,53 @@
 require 'firering'
 
-Firering.subdomain = ENV["CAMPFIRE_SUBDOMAIN"]
-Firering.token     = ENV["CAMPFIRE_TOKEN"]
+print "Enter subdomain: "; subdomain = gets.chomp
+print "Enter user: "     ; login     = gets.chomp
+print "Enter password: " ; password  = gets.chomp
 
-EM.run do
-  Firering.rooms do |rooms|
-
-    rooms.each do |room|
-      puts "Users in room #{room.name} (#{room.topic})"
+conn = Firering::Connection.new("http://#{subdomain}.campfirenow.com") do |c|
+  c.login = login
+  c.password = password
+end
 
-      if room.users.empty?
-        puts "  empty (locked: #{room.locked?})"
-      else
-        room.users.each do |u|
-          puts "  #{ u.name }. Admin: #{ u.admin? }"
+EM.run do
+  conn.authenticate do
+    conn.rooms do |rooms|
+
+      rooms.each do |room|
+        puts "Users in room #{room.name} (#{room.topic})"
+
+        room.users do |users|
+          if users.empty?
+            puts "  empty (locked: #{room.locked?})"
+          else
+            users.each do |u|
+              puts "  #{ u.name }. Admin: #{ u.admin? }"
+            end
+          end
         end
-      end
 
-      if room.locked?
-        puts "  can't get recent messages in a locked room'"
-      else
-        Firering.room_recent_messages(room.id) do |messages|
+        if room.locked?
+          puts "  can't get recent messages in a locked room'"
+        else
+          room.recent_messages do |messages|
 
-          puts "-" * 80
-          puts "recent message on #{room.name}"
-          puts "-" * 80
+            puts "-" * 80
+            puts "recent message on #{room.name}"
+            puts "-" * 80
 
-          messages.slice(0, 4).each do |m|
-            puts "\n  (#{m.user_id})"
+            messages.slice(0, 4).each do |m|
+              m.user do |u|
+                puts "\n  (#{u})"
 
-            m.body.to_s.split("\n").each do |chunk|
-              puts "  > #{chunk}"
+                m.body.to_s.split("\n").each do |chunk|
+                  puts "  > #{chunk}"
+                end
+              end
             end
           end
         end
-      end
 
+      end
     end
   end
 

data/examples/rooms.rb

@@ -1,20 +1,25 @@
 require 'firering'
 
-Firering.subdomain = ENV["CAMPFIRE_SUBDOMAIN"]
-Firering.token     = ENV["CAMPFIRE_TOKEN"]
+conn = Firering::Connection.new("http://#{ENV["CAMPFIRE_SUBDOMAIN"]}.campfirenow.com") do |c|
+  c.token = ENV["CAMPFIRE_TOKEN"]
+end
 
 EM.run do
-  Firering.rooms do |rooms|
-
+  conn.rooms do |rooms|
     rooms.each do |room|
-      puts "Users in room #{room.name}"
 
-      if room.users.empty?
-        puts "  empty (locked: #{room.locked?})"
-      else
-        room.users.each do |u|
-          puts "  #{ u.name }"
+      room.users do |users|
+        puts "Users in room #{room.name}"
+
+        if users.empty?
+          puts "  empty (locked: #{room.locked?})"
+        else
+          users.each do |u|
+            puts "  #{ u.name }"
+          end
         end
+
+        puts
       end
 
     end

data/examples/update_room.rb

@@ -1,31 +1,34 @@
 require 'firering'
 
-Firering.subdomain = ENV["CAMPFIRE_SUBDOMAIN"]
-Firering.token     = ENV["CAMPFIRE_TOKEN"]
+conn = Firering::Connection.new("http://#{ENV["CAMPFIRE_SUBDOMAIN"]}.campfirenow.com") do |c|
+  c.token = ENV["CAMPFIRE_TOKEN"]
+end
 
 ROOM = "test2"
 
 EM.run do
-  Firering.rooms do |rooms|
+  conn.rooms do |rooms|
     rooms.each do |room|
+
       if room.name == ROOM
-        Firering.room_join(room.id) do
+        room.join do
 
-          Firering.update_room(room.id, "topic" => "test test test") do |response|
-            puts "  * Updating topic: "
-            puts response.response_header.status
+          room.update("topic" => "test test test") do |data, http|
+            print "  * Updating topic. HTTP Status returned: "
+            puts http.response_header.status
           end
 
-          Firering.text(room.id, "hola") do
-            puts "texted"
+          room.text("this is a test from the refactored gem") do
+            puts "sent text"
           end
 
-          Firering.paste(room.id, "hola\nmundo") do
-            puts "pasted"
+          room.paste("this is a\npaste\nfrom the refactored gem") do
+            puts "sent paste"
           end
 
         end
       end
+
     end
   end
 

data/firering.gemspec

@@ -4,8 +4,8 @@ Gem::Specification.new do |s|
   s.rubygems_version = '1.3.5'
 
   s.name              = 'firering'
-  s.version           = '0.1.1'
-  s.date              = '2010-08-08'
+  s.version           = '1.0.0'
+  s.date              = '2010-08-16'
   s.rubyforge_project = 'firering'
 
   s.summary     = "Campfire API interface powered by EventMachine and Yajl."
@@ -43,16 +43,19 @@ Gem::Specification.new do |s|
     examples/update_room.rb
     firering.gemspec
     lib/firering.rb
+    lib/firering/connection.rb
     lib/firering/data.rb
     lib/firering/data/message.rb
     lib/firering/data/room.rb
     lib/firering/data/upload.rb
     lib/firering/data/user.rb
-    lib/firering/http.rb
     lib/firering/requests.rb
-    lib/firering/streaming.rb
+    log/.gitignore
+    spec/firering/connection_spec.rb
+    spec/firering/data/message_spec.rb
+    spec/firering/data/room_spec.rb
+    spec/firering/data/user_spec.rb
     spec/firering/data_spec.rb
-    spec/firering/requests_spec.rb
     spec/fixtures/headers/delete_messages_ID_star.json
     spec/fixtures/headers/get_room_ID.json
     spec/fixtures/headers/get_room_ID_live.json
@@ -90,8 +93,8 @@ Gem::Specification.new do |s|
     spec/fixtures/json/put_room_ID.json
     spec/fixtures/load_server.rb
     spec/fixtures/retrieve.rb
-    spec/fixtures/server.rb
     spec/spec_helper.rb
+    spec/support/helpers.rb
   ]
   # = MANIFEST =
 

data/lib/firering/connection.rb

@@ -0,0 +1,125 @@
+module Firering
+  class Connection
+    include Firering::Requests
+
+    attr_accessor :host
+    attr_accessor :streaming_host
+    attr_accessor :max_retries
+    attr_accessor :retry_delay
+    attr_accessor :redirects
+    attr_accessor :logger
+    attr_accessor :password
+    attr_accessor :token
+    attr_accessor :login
+
+    def initialize(host, streaming_host = "https://streaming.campfirenow.com")
+      @retry_delay, @redirects, @max_retries = 2, 1, 2
+      self.host, self.streaming_host = host, streaming_host
+      yield self if block_given?
+    end
+
+    def logger
+      @logger ||= Logger.new(STDOUT)
+    end
+
+    def host=(host)
+      @host = Addressable::URI.parse(host)
+    end
+
+    def streaming_host=(host)
+      @streaming_host = Addressable::URI.parse(host)
+    end
+
+    def auth_headers
+      token ? {'authorization' => [token, "X"] } : {'authorization' => [login, password] }
+    end
+
+    def parameters(data = nil)
+      parameters = {
+        :redirects => redirects,
+        :head => auth_headers.merge("Content-Type" => "application/json")
+      }
+      parameters.merge!(:body => data.is_a?(String) ? data : Yajl::Encoder.encode(data)) if data
+      parameters
+    end
+
+    def http(method, path, data = nil, &callback)
+      uri = host.join(path)
+      logger.info("performing request to #{uri}")
+
+      http = EventMachine::HttpRequest.new(uri).send(method, parameters(data))
+
+      http.errback do
+        perform_retry(http) do
+          http(method, path, data, &callback)
+        end
+      end
+
+      http.callback {
+        @performed_retries = 0
+        if callback
+          data = Yajl::Parser.parse(http.response, :symbolize_keys => true) rescue Hash.new
+          callback.call(data, http)
+        end
+      }
+
+      http
+    end
+
+    # Streaming
+    #
+    # The Streaming API allows you to monitor a room in real time. The
+    # authenticated user must already have joined the room in order to use this
+    # API.
+    def stream(room_id, &callback)
+      parser = Yajl::Parser.new(:symbolize_keys => true)
+
+      parser.on_parse_complete = proc do |data|
+        callback.call(Firering::Message.instantiate(self, data)) if callback
+      end
+
+      uri = streaming_host.join("/room/#{room_id}/live.json")
+      logger.info("performing streaming request to #{uri.to_s}")
+      http = EventMachine::HttpRequest.new(uri).get(parameters)
+
+      http.stream { |chunk| parser << chunk; @performed_retries= 0 }
+
+      # Campfire servers will try to hold the streaming connections open indefinitely.
+      # However, API clients must be able to handle occasional timeouts or
+      # disruptions. Upon unexpected disconnection, API clients should wait for a
+      # few seconds before trying to reconnect.  Formats
+      http.errback do
+        perform_retry(http) do
+          stream(room_id, url, &callback)
+        end
+      end
+
+      http
+    end
+
+    def perform_retry(http, &callback)
+      if EventMachine.reactor_running? && (@performed_retries.nil? || @performed_retries < @max_retries)
+        logger.error("http error #{http.error}. Trying again in #{retry_delay} seconds...")
+        EventMachine::add_timer(retry_delay) do
+          @performed_retries = (@performed_retries || 0) + 1
+          logger.info("Reconnecting...")
+          callback.call
+        end
+      else
+        logger.error("The event machine loop is not running")
+        raise Firering::Connection::HTTPError.new(http)
+      end
+    end
+
+    class HTTPError < RuntimeError
+      attr_reader :http
+      def initialize(http)
+        @http = http
+      end
+      def to_s
+        "http error #{@http.error if @http.respond_to?(:error)}".strip
+      end
+    end
+
+  end
+end

data/lib/firering/data/message.rb

@@ -1,29 +1,49 @@
-module Firering
-  class Message < Firering::Data
-    key :id, :room_id, :user_id, :body, :created_at, :type
-
-    MESSAGE_TYPES = %w[
-      TextMessage PasteMessage SoundMessage AdvertisementMessage
-      AllowGuestsMessage DisallowGuestsMessage IdleMessage KickMessage
-      LeaveMessage SystemMessage TimestampMessage TopicChangeMessage
-      UnidleMessage UnlockMessage UploadMessage
-    ]
-
-    # txs activesupport
-    underscore = proc do |word|
-      word.to_s.gsub(/::/, '/').gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').gsub(/([a-z\d])([A-Z])/,'\1_\2').tr("-", "_").downcase
-    end
+class Firering::Message < Firering::Data
 
-    MESSAGE_TYPES.each do |message_type|
-      current_type = (message_type =~ /(.+)Message/) && $1
-      define_method("#{underscore[current_type]}?") do
-        type == message_type
-      end
-    end
+  data_attributes :id, :room_id, :user_id, :body, :created_at, :type
 
-    def from_user?
-      !user_id.nil? && (!user_id.instance_of?(String) || user_id !~ /~\s*$/)
+  MESSAGE_TYPES = %w[
+    TextMessage PasteMessage SoundMessage AdvertisementMessage
+    AllowGuestsMessage DisallowGuestsMessage IdleMessage KickMessage
+    LeaveMessage SystemMessage TimestampMessage TopicChangeMessage
+    UnidleMessage UnlockMessage UploadMessage
+  ]
+
+  # txs activesupport
+  underscore = proc do |word|
+    w = word.to_s.gsub(/::/, '/')
+    w = w.gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2')
+    w = w.gsub(/([a-z\d])([A-Z])/,'\1_\2')
+    w.tr("-", "_").downcase
+  end
+
+  MESSAGE_TYPES.each do |message_type|
+    current_type = (message_type =~ /(.+)Message/) && $1
+    define_method("#{underscore[current_type]}?") do
+      type == message_type
     end
+  end
+
+  def from_user?
+    !user_id.nil? && (!user_id.instance_of?(String) || user_id !~ /^\s*$/)
+  end
+
+  # Highlights a message / Removes a message highlight.
+  def star(id, yes_or_no = true, &callback)
+    connection.star_message(id, yes_or_no, &callback)
+  end
 
+  def room(&callback)
+    connection.room(room_id, &callback)
   end
+
+  def user(&callback)
+    if from_user?
+      connection.user(user_id, &callback)
+    else
+      callback.call(nil, connection)
+    end
+  end
+
+  alias_method :to_s, :body
 end