em-campfire 0.0.1 → 1.0.0

data/.gitignore

@@ -0,0 +1,8 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+examples/Gemfile
+examples/Gemfile.lock
+coverage/
+.rvmrc

data/CONTRIBUTING.md

@@ -0,0 +1,24 @@
+## How to contribute
+
+Here's the most direct way to get your work merged into the project:
+
+1. Fork the project
+2. Clone down your fork
+3. Create a feature branch
+4. Add your feature + tests
+5. Document new features in the README
+6. Make sure everything still passes by running the tests
+7. If necessary, rebase your commits into logical chunks, without errors
+8. Push the branch up
+9. Send a pull request for your branch
+
+# What to contribute?
+
+See the github issues or the TODO section in the README for some features to work on
+
+# Coverage
+
+When you run the tests a coverage report is made. We're not aiming for 100% coverage, it's just a guide.
+
+Take a look at the TODO list or known issues for some inspiration if you need it.
+

data/Gemfile

@@ -1,2 +1,2 @@
-source :rubygems
+source "https://rubygems.org"
 gemspec

data/README.md

@@ -1,6 +1,107 @@
+em-campfire is a library for interacting with the [Campfire](http://campfirenow.com/) chat application. It was extracted from the [Scamp](https://github.com/wjessop/Scamp) v1 bot framework.
 
-This isn't ready for production use yet, so don't use it!
+## Installation
+
+`gem install em-campfire` or put `gem 'em-campfire'` in your Gemfile.
 
 ## Example
 
-See examples/simple.rb
+``` ruby
+require 'em-campfire'
+
+EM.run {
+  connection = EM::Campfire.new(:subdomain => "foo", :api_key => "jhhekrlfjnksdjnliyherkjb", :verbose => true)
+
+  # Join a room, you will need the room id
+  connection.join(10101)
+
+  # Stream a room, need to join it first
+  connection.join(2345) {|id| connection.stream(id) }
+
+  # Dump out any message we get
+  connection.on_message do |msg|
+    puts msg.inspect
+  end
+
+  # Give lib a chance to connect
+  EM::Timer.new(10) do
+    # Say something on a specific channel
+    connection.say "foofoofoo", 10101
+
+    # Paste something
+    connection.paste "foo\nfoo\nfoo", 10101
+
+    # Play a sound
+    connection.play "nyan", 10101
+  end
+}
+```
+
+For more features see the examples.
+
+### Connection options
+
+There are a few optional parameters you can create an EM::Campfire with:
+
+``` ruby
+require 'em-campfire'
+
+EM.run {
+  connection = EM::Campfire.new(
+    :subdomain => "foo",
+    :api_key => "jhhekrlfjnksdjnliyherkjb",
+    :verbose => true,
+    :logger => Logger::Syslog.new('process_name', Syslog::LOG_PID | Syslog::LOG_CONS),
+    :cache => custom_cache_object
+  )
+
+  # more code
+}
+```
+
+#### :verbose
+
+If set to true sets the log level to DEBUG, defaults to false.
+
+#### :logger
+
+em-campfire uses a Logger instance from stdlib by default, you can switch this out by passing in your own logger instance.
+
+#### :cache
+
+em-campfire caches responses from the Campfire API and issues conditional requests using ETags. By default it uses an in-memory cache of data returned, and this is fine for most people, but if you want something custom, possibly more permanent, you can pass in your own cache object.
+
+The cache object should conform to the get/set API of the [redis-rb](https://github.com/redis/redis-rb) lib (making that a drop-in replacement). Just make sure that you use the synchrony driver.
+
+#### :ignore_self
+
+em-campfire receives messages that it posted on it's streaming connections. By default it processes these just as it would any other message. set :ignore_self to true to make it ignore messages it sends.
+
+## Requirements
+
+I've tested it in Ruby >= 1.9.3.
+
+## TODO
+
+* I mock is\_me? in "should be able to ignore itself" in connection_spec.rb for convenience, work out a way to not do that
+* See if http connection/cacheing/failure handling can be abstracted
+* Allow user to pass success/error callbacks
+* Re-try failed HTTP requests
+* Maybe encapsulate actions in objects, for instance a Room object
+
+### Missing features
+
+em-campfire was written primarily to support [Scamp](https://github.com/wjessop/Scamp)/[scamp-campfire ](https://github.com/omgitsads/scamp-campfire) so I've implemented the features required for that first. There are other features left-over that I didn't need and I'll get round to at some point. If you need one before then ping me and I might write it, or a pull request is of course welcome.
+
+See the [Campfire API](https://github.com/37signals/campfire-api) for reference:
+
+* [Messages (recent, highlight, unhighlight)](https://github.com/37signals/campfire-api/blob/master/sections/messages.md)
+* [Rooms (updating, locking, unlocking, leaving)](https://github.com/37signals/campfire-api/blob/master/sections/rooms.md)
+* [Transcripts](https://github.com/37signals/campfire-api/blob/master/sections/transcripts.md)
+* [Uploads](https://github.com/37signals/campfire-api/blob/master/sections/uploads.md)
+* [Search](https://github.com/37signals/campfire-api/blob/master/sections/search.md)
+* [Account](https://github.com/37signals/campfire-api/blob/master/sections/account.md)
+
+## Contributing
+
+See the CONTRIBUTING file

data/em-campfire.gemspec

@@ -16,12 +16,13 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
   
-  s.add_dependency('eventmachine', '~> 1.0.0.beta.4')
-  s.add_dependency('yajl-ruby', '~> 0.8.3')
-  s.add_dependency('em-http-request', '~> 1.0.0.beta.4')
+  s.add_dependency 'eventmachine', '~> 1.0'
+  s.add_dependency 'yajl-ruby', '~> 1.1'
+  s.add_dependency 'em-http-request', '~> 1.0'
 
-  s.add_development_dependency "rake", "~> 0.9.2"
-  s.add_development_dependency "rspec", "~> 2.6.0"
-  s.add_development_dependency "mocha", "~> 0.10.0"
-  s.add_development_dependency "webmock", "~> 1.7.6"
+  s.add_development_dependency "rake"
+  s.add_development_dependency "rspec", '~> 2.11'
+  s.add_development_dependency "mocha", '~> 0.12'
+  s.add_development_dependency "webmock", '~> 1.8.10'
+  s.add_development_dependency "simplecov"
 end

data/examples/simple.rb

@@ -3,17 +3,40 @@ $:.unshift File.join(File.dirname(__FILE__), '../lib')
 require 'em-campfire'
 
 EM.run {
-  connection = EM::Campfire.new(:subdomain => "foo", :api_key => "foo")
-  connection.join 293788 # Robot Army
-  connection.join 401839 # Monitoring
-  
+  connection = EM::Campfire.new(:subdomain => "foo", :api_key => "jhhekrlfjnksdjnliyherkjb", :verbose => true)
+
+  # Join a room, you will need the room id
+  connection.join(10101)
+
+  # Stream a room, need to join it first
+  connection.join(2345) {|id| connection.stream(id) }
+
+  # Dump out any message we get
   connection.on_message do |msg|
     puts msg.inspect
   end
-  
+
+  # Pull data for a room
+  connection.room_data_from_room_id(2345) {|data| puts data.inspect }
+
+  # Pull data for all rooms
+  connection.room_data_for_all_rooms {|data| puts data.inspect }
+
+  # Fetch user data for a specific user
+  connection.fetch_user_data_for_user_id(123) {|data| puts data.inspect }
+
+  # Fetch data about the 'sef' user
+  connection.fetch_user_data_for_self {|data| puts data.inspect }
+
   # Give lib a chance to connect
-  EM::Timer.new(10) do
+  EM::Timer.new(5) do
     # Say something on a specific channel
-    connection.say "foofoofoo", "Robot Army"
+    connection.say "foofoofoo", 10101
+
+    # Paste something
+    connection.paste "foo\nfoo\nfoo", 10101
+
+    # Play a sound
+    connection.play "nyan", 10101
   end
 }

data/lib/em-campfire/cache.rb

@@ -0,0 +1,25 @@
+module EventMachine
+  class Campfire
+    class Cache
+      def get(key)
+        key = cache_key_for(key)
+        yield store[key] if block_given?
+        store[key]
+      end
+
+      def set(key, val)
+        store[cache_key_for(key)] = val
+      end
+
+      private
+
+      def cache_key_for(object)
+        "em-campfire-#{object}"
+      end
+
+      def store
+        @store ||= {}
+      end
+    end
+  end
+end

data/lib/em-campfire/connection.rb

@@ -1,28 +1,29 @@
 module EventMachine
   class Campfire
     module Connection
-      
       attr_accessor :ignore_self
-      
+
       def on_message &blk
         @on_message_block = blk
       end
-          
+
       private
-      
+
       attr_accessor :on_message_block
-      
+
       def process_message(msg)
         logger.debug "Received message #{msg.inspect}"
-        return false if ignore_self && is_me?(msg[:user_id])
-        if on_message_block
-          logger.debug "on_message callback exists, calling it #{msg.inspect}"
-          on_message_block.call(msg)
+        if ignore_self && is_me?(msg[:user_id])
+          logger.debug "Ignoring message with user_id #{msg[:user_id]} as that is me and ignore_self is true"
         else
-          logger.debug "on_message callback does not exist"
+          if on_message_block
+            logger.debug "on_message callback exists, calling it with #{msg.inspect}"
+            on_message_block.call(msg)
+          else
+            logger.debug "on_message callback does not exist"
+          end
         end
       end
-          
     end
   end
 end

data/lib/em-campfire/messages.rb

@@ -2,7 +2,7 @@ module EventMachine
   class Campfire
     module Messages
       def say(message, room_id_or_name)
-        send_message(room_id_or_name, message, "Textmessage")
+        send_message(room_id_or_name, message, "TextMessage")
       end
 
       def paste(message, room_id_or_name)
@@ -15,16 +15,15 @@ module EventMachine
     
       private
     
-      #  curl -vvv -H 'Content-Type: application/json' -d '{"message":{"body":"Yeeeeeaaaaaahh", "type":"Textmessage"}}' -u API_KEY:X https://something.campfirenow.com/room/2345678/speak.json
-      def send_message(room_id_or_name, payload, type)
-        if room_cache.size < 1
-          logger.error "Couldn't post message \"#{payload}\" to room #{room_id_or_name} as no rooms have been joined"
-          return
+      # curl -vvv -H 'Content-Type: application/json' -d '{"message":{"body":"Yeeeeeaaaaaahh", "type":"TextMessage"}}' -u API_KEY:X https://something.campfirenow.com/room/2345678/speak.json
+      def send_message(room_id, payload, type)        
+        unless joined_rooms[room_id]
+          logger.error "Couldn't post message \"#{payload}\" to room #{room_id} as no rooms have been joined"
+          return false
         end
         
-        room_id = room_id(room_id_or_name)
         url = "https://#{subdomain}.campfirenow.com/room/#{room_id}/speak.json"
-        http = EventMachine::HttpRequest.new(url).post :head => {'Content-Type' => 'application/json', 'authorization' => [api_key, 'X']}, :body => Yajl::Encoder.encode({:message => {:body => payload, :type => type}})
+        http = EventMachine::HttpRequest.new(url).post :head => {'Content-Type' => 'application/json', 'authorization' => [api_key, 'X']}, :body => Yajl::Encoder.encode({:message => {:body => payload.to_s, :type => type}})
         http.errback { logger.error "Couldn't connect to #{url} to post message \"#{payload}\" to room #{room_id}" }
         http.callback {
           if [200,201].include? http.response_header.status

data/lib/em-campfire/rooms.rb

@@ -1,122 +1,118 @@
 module EventMachine
   class Campfire
     module Rooms
-      
-#       attr_accessor :rooms
-      attr_accessor :room_cache
 
-      def join(room, &blk)
-        id = room_id(room)
-        # logger.info "Joining room #{id}"
-        if id
-          url = "https://#{subdomain}.campfirenow.com/room/#{id}/join.json"
-          http = EventMachine::HttpRequest.new(url).post :head => {'Content-Type' => 'application/json', 'authorization' => [api_key, 'X']}
-          http.errback { logger.error "Error joining room: #{id}" }
-          http.callback {
-            if http.response_header.status == 200
-              logger.info "Joined room #{id} successfully"
-              # fetch_room_data(id)
-              stream(id)
-            else
-              logger.error "Error joining room: #{id}"
-            end
-          }
-        end
+      attr_accessor :room_cache, :joined_rooms
+
+      def join(room_id, &blk)
+        logger.info "Joining room #{room_id}"
+        url = "https://#{subdomain}.campfirenow.com/room/#{room_id}/join.json"
+        http = EventMachine::HttpRequest.new(url).post :head => {'Content-Type' => 'application/json', 'authorization' => [api_key, 'X']}
+        http.errback { logger.error "Error joining room: #{room_id}" }
+        http.callback {
+          if http.response_header.status == 200
+            logger.info "Joined room #{room_id} successfully"
+            joined_rooms[room_id] = true
+            yield(room_id) if block_given?
+          else
+            logger.error "Error joining room: #{room_id}"
+          end
+        }
       end
 
-      private
-      
-      attr_accessor :populating_room_list
-      
       def stream(room_id)
         json_parser = Yajl::Parser.new :symbolize_keys => true
         json_parser.on_parse_complete = method(:process_message)
-            
+        
         url = "https://streaming.campfirenow.com/room/#{room_id}/live.json"
         # Timeout per https://github.com/igrigorik/em-http-request/wiki/Redirects-and-Timeouts
         http = EventMachine::HttpRequest.new(url, :connect_timeout => 20, :inactivity_timeout => 0).get :head => {'authorization' => [api_key, 'X']}
-        http.errback { logger.error "Couldn't stream room #{room_id} at url #{url}" }
-        http.callback { logger.info "Disconnected from #{url}"; join(room_id) if rooms[room_id] }
-        http.stream {|chunk| json_parser << chunk }
-      end
-      
-      
-      def room_id(room_id_or_name)
-        if room_id_or_name.is_a? Integer
-          return room_id_or_name
-        else
-          return room_id_from_room_name(room_id_or_name)
-        end
-      end
-      
-      def room_id_from_room_name(room_name)
-        logger.debug "Looking for room id for #{room_name}"
-        
-        if room_cache.has_key? room_name
-          return room_cache[room_name]["id"]
-        else
-          logger.warn "Attempted to join #{room_name} but could not find an ID for it"
-          return false
+        http.errback {
+          logger.error "Couldn't stream room #{room_id} at url #{url}, error was #{http.error}"
+          EM.next_tick {stream(room_id)}
+        }
+        http.callback {
+          if http.response_header.status == 200
+            logger.info "Disconnected from #{url}"
+          else
+            logger.error "Couldn't stream room with url #{url}, http response from API was #{http.response_header.status}"
+          end
+          EM.next_tick {stream(room_id)}
+        }
+        http.stream do |chunk|
+          begin
+            json_parser << chunk
+          rescue Yajl::ParseError => e
+            logger.error "Couldn't parse json data for room 123, data was #{chunk}, error was: #{e}"
+          end
         end
       end
-      
+
       #  curl -vvv -H 'Content-Type: application/json' -u API_KEY:X https://something.campfirenow.com/rooms.json
-      def populate_room_list
-        url = "https://#{subdomain}.campfirenow.com/rooms.json"
-        http = EventMachine::HttpRequest.new(url).get :head => {'authorization' => [api_key, 'X']}
-        http.errback { logger.error "Couldn't connect to url #{url} to fetch room list"; puts http.inspect }
+      def room_data_from_room_id(room_id, &block)
+        url = "https://#{subdomain}.campfirenow.com/room/#{room_id}.json"
+
+        etag_header = {}
+        if cached_room_data = cache.get(room_cache_key(room_id))
+          etag_header = {"ETag" => cached_room_data["etag"]}
+        end
+
+        http = EventMachine::HttpRequest.new(url).get :head => {'authorization' => [api_key, 'X'], 'Content-Type'=>'application/json'}.merge(etag_header)
+        http.errback { logger.error "Couldn't connect to url #{url} to fetch room data" }
         http.callback {
           if http.response_header.status == 200
-            logger.debug "Fetched room list"
-            new_rooms = {}
-            Yajl::Parser.parse(http.response)['rooms'].each do |c|
-              new_rooms[c["name"]] = c
-            end
-            @room_cache = new_rooms # replace existing room list
+            room_data = Yajl::Parser.parse(http.response)['room']
+            cache.set(room_cache_key(room_id), room_data.merge({'etag' => http.response_header.etag}))
+            logger.debug "Fetched room data for #{room_id} (#{room_data['name']})"
+            yield room_data if block_given?
+          elsif http.response_header.status == 304
+            logger.debug "HTTP response was 304, serving room data for room #{room_id} (#{cached_room_data['name']}) from cache"
+            yield cached_room_data if block_given?
           else
-            logger.error "Couldn't fetch room list with url #{url}, http response from API was #{http.response_header.status}"
+            logger.error "Couldn't fetch room data with url #{url}, http response from API was #{http.response_header.status}"
           end
         }
       end
-      
-      # def fetch_room_data(room_id)
-      #   url = "https://#{subdomain}.campfirenow.com/room/#{room_id}.json"
-      #   http = EventMachine::HttpRequest.new(url).get :head => {'authorization' => [api_key, 'X']}
-      #   http.errback { logger.error "Couldn't connect to #{url} to fetch room data for room #{room_id}" }
-      #   http.callback {
-      #     if http.response_header.status == 200
-      #       logger.debug "Fetched room data for #{room_id}"
-      #       room = Yajl::Parser.parse(http.response)['room']
-      #       room_cache[room["id"]] = room
-      # 
-      #       room['users'].each do |u|
-      #         update_user_cache_with(u["id"], u)
-      #       end
-      #     else
-      #       logger.error "Couldn't fetch room data for room #{room_id} with url #{url}, http response from API was #{http.response_header.status}"
-      #     end
-      #   }
-      # end
-    
-      def fetch_room_data(room_id)
-        url = "https://#{subdomain}.campfirenow.com/room/#{room_id}.json"
-        http = EventMachine::HttpRequest.new(url).get :head => {'authorization' => [api_key, 'X']}
-        http.errback { logger.error "Couldn't connect to #{url} to fetch room data for room #{room_id}" }
+
+      def room_data_for_all_rooms
+        url = "https://#{subdomain}.campfirenow.com/rooms.json"
+
+        etag_header = {}
+        if cached_room_list_data = cache.get(room_list_data_cache_key)
+          etag_header = {"ETag" => cached_room_list_data["etag"]}
+        end
+
+        http = EventMachine::HttpRequest.new(url).get :head => {'Content-Type' => 'application/json', 'authorization' => [api_key, 'X']}.merge(etag_header)
+
+        http.errback { logger.error "Error processing url #{url} to fetch room data: #{http.error}" }
         http.callback {
           if http.response_header.status == 200
-            logger.debug "Fetched room data for #{room_id}"
-            room = Yajl::Parser.parse(http.response)['room']
-            room_cache[room["id"]] = room
-
-            room['users'].each do |u|
-              update_user_cache_with(u["id"], u)
-            end
+            room_data = Yajl::Parser.parse(http.response)['rooms']
+            cache.set(room_list_data_cache_key, {'data' => room_data, 'etag' => http.response_header.etag})
+            logger.debug "Fetched room data for all rooms"
+            yield room_data if block_given?
+          elsif http.response_header.status == 304
+            logger.debug "HTTP response was 304, serving room list data from cache"
+            yield cached_room_list_data if block_given?
           else
-            logger.error "Couldn't fetch room data for room #{room_id} with url #{url}, http response from API was #{http.response_header.status}"
+            logger.error "Couldn't fetch room list with url #{url}, http response from API was #{http.response_header.status}"
           end
         }
       end
-      
+
+      private
+
+      def joined_rooms
+        @rooms ||= {}
+      end
+
+      def room_cache_key(room_id)
+        "room-data-#{room_id}"
+      end
+
+      def room_list_data_cache_key
+        "room-list-data"
+      end
     end # Rooms
   end # Campfire
 end # EventMachine