scamp 0.0.4 → 0.1.0

data/README.md

@@ -2,6 +2,10 @@
 
 A framework for writing [Campfire](http://campfirenow.com/) bots. Scamp is in early development so use it at your own risk, pull requests welcome.
 
+Scamp is designed to be simple, to get out of your way and to let you do what you want. It doesn't have any baggage, so no administration web interfaces, no built in commands. It's a blank slate for you to build on.
+
+If you like or use Scamp I'd love to hear from you. Drop me at line at will at 37signals dot com and tell me how you are using it.
+
 ## Requirements
 
 Ruby >= 1.9.2 (At least for the named captures)
@@ -28,10 +32,10 @@ Matchers are tested in order and all that satisfy the match and conditions will
       end
       
       # 
-      # A special user and channel method is available in match blocks.
+      # A special user and room method is available in match blocks.
       # 
       match "a user said" do
-        say "#{user} said something in channel #{channel}"
+        say "#{user} said something in room #{room}"
       end
       
       match "Hello!" do
@@ -39,35 +43,42 @@ Matchers are tested in order and all that satisfy the match and conditions will
       end
       
       # 
-      # Limit the match to certain channels, users or both.
+      # You can play awesome sounds
       # 
-      match /^Lets match (.+)$/, :conditions => {:channel => "Some Channel"} do
-        say "Only said if channel name mathces /someregex/"
+      match "ohmy" do
+        play "yeah"
+      end
+      
+      # 
+      # Limit the match to certain rooms, users or both.
+      # 
+      match /^Lets match (.+)$/, :conditions => {:room => "Some Room"} do
+        say "Only said if room name mathces /someregex/"
       end
       
       match "some text", :conditions => {:user => "Some User"} do
         say "Only said if user name mathces /someregex/"
       end
       
-      match /some other text/, :conditions => {:user => "Some User", :channel => 123456} do
+      match /some other text/, :conditions => {:user => "Some User", :room => 123456} do
         say "You can mix conditions"
       end
       
       # 
-      # Named caputres become avaiable in your match block
+      # Named captures become avaiable in your match block
       # 
       match /^say (?<yousaid>.+)$/ do
         say "You said #{yousaid}"
       end
       
       # 
-      # You can say multiple times, and you can specify an alternate channel.
-      # Default behaviour is to 'say' in the channel that caused the match.
+      # You can say multiple times, and you can specify an alternate room.
+      # Default behaviour is to 'say' in the room that caused the match.
       # 
       match "something" do
-        say "#{user} said something in channel #{channel}"
-        say "#{user} said something in channel #{channel}", 237872
-        say "#{user} said something in channel #{channel}", "System Administration"
+        say "#{user} said something in room #{room}"
+        say "#{user} said something in room #{room}", 237872
+        say "#{user} said something in room #{room}", "System Administration"
       end
       
       # 
@@ -86,34 +97,36 @@ Matchers are tested in order and all that satisfy the match and conditions will
       end
     end
       
-    # Connect and join some channels
+    # Connect and join some rooms
     scamp.connect!([293788, "Monitoring"])
 
-In the channel/user conditions you can use the name, regex or ID of a user or channel, in say you can ise a string or ID, eg:
+In the room/user conditions you can use the name, regex or ID of a user or room, in say you can ise a string or ID, eg:
 
-    :conditions => {:channel => /someregex/}
-    :conditions => {:channel => "some string"}
-    :conditions => {:channel => 123456}
+    :conditions => {:room => /someregex/}
+    :conditions => {:room => "some string"}
+    :conditions => {:room => 123456}
 
     :conditions => {:user => /someregex/}
     :conditions => {:user => "some string"}
     :conditions => {:user => 123456}
 
-    say "#{user} said something in channel #{channel}", 237872
-    say "#{user} said something in channel #{channel}", "System Administration"
+    say "#{user} said something in room #{room}", 237872
+    say "#{user} said something in room #{room}", "System Administration"
 
-## TODO
+By default Scamp listens to itself. This could either be fun, or dangerous, you decide. You can turn this off by passing :first\_match\_only => true in the initialisation options
 
-* Write more tests
-* Allow multiple values for conditions, eg: :conditions => {:channel => [/someregex/, "Some channel"]}
-* Add paste/play support
-* Add option to stop bot responding to itself
+    scamp = Scamp.new(:api_key => "YOUR API KEY", :subdomain => "yoursubdomain", :first_match_only => true)
 
-## Known issues
+Scamp will listen to all messages that are sent on the rooms it is listening on and doesn't need to be addressed by name. If you prefer to only trigger bot commands when you address your bot directly add the :required\_prefix initialisation option:
 
-* Bot doesn't detect that it's been kicked out of a channel and reconnect
-* Bot tends to crash when it encounters an error.
-* When encountering a problem straming (Couldn't stream channel 401839 at url https://streaming.campfirenow.com/room/<channel_id>/live.json) no attempt is made to re-connect
+    scamp = Scamp.new(:api_key => "YOUR API KEY", :subdomain => "yoursubdomain", :required_prefix => 'Bot: ')
+
+Scamp will now require commands to begin with 'Bot: ' (or whatever you have specified), and will strip out this prefix before handing the message onto your match block.
+
+## TODO
+
+* Allow multiple values for conditions, eg: :conditions => {:room => ["This room", "Some room"]}
+* Add paste support
 
 ## How to contribute
 
@@ -130,6 +143,13 @@ Here's the most direct way to get your work merged into the project:
 
 Take a look at the TODO list or known issues for some inspiration if you need it.
 
+## Thanks
+
+First class support, commits and pull requests, thanks guys!
+
+* [Caius Durling](http://caius.name/)
+* Sudara Williams of [Ramen Music](http://ramenmusic.com)
+
 ## License
 
 Copyright (C) 2011 by Will Jessop

data/examples/bot.rb

@@ -7,15 +7,15 @@ require 'scamp'
 scamp = Scamp.new(:api_key => "YOUR API KEY", :subdomain => "37s")
 
 scamp.behaviour do
-  # Match some regex limited to a channel condition based on a channel id
-  match /^channel id (.+)$/, :conditions => {:channel => 401839} do
-    # Reply in the current channel
-    say "Match some regex limited to a channel condition based on a channel id"
+  # Match some regex limited to a room condition based on a room id
+  match /^room id (.+)$/, :conditions => {:room => 401839} do
+    # Reply in the current room
+    say "Match some regex limited to a room condition based on a room id"
   end
   
-  # Limit a match to a channel condition based on a string
-  match "channel name check", :conditions => {:channel => "Monitoring"} do
-    say "Limit a match to a channel condition based on a string"
+  # Limit a match to a room condition based on a string
+  match "room name check", :conditions => {:room => "Monitoring"} do
+    say "Limit a match to a room condition based on a string"
   end
   
   # Limit a match to a user condition based on a string
@@ -28,10 +28,10 @@ scamp.behaviour do
      say "Limit a match to a user condition based on an ID"
    end
    
-   # Limit a match to a channel & user condition combined
-   match /^something (.+)$/, :conditions => {:channel => "Monitoring", :user => "Will Jessop"} do
-     # Reply in the current channel
-     say "Limit a match to a channel & user condition combined"
+   # Limit a match to a room & user condition combined
+   match /^something (.+)$/, :conditions => {:room => "Monitoring", :user => "Will Jessop"} do
+     # Reply in the current room
+     say "Limit a match to a room & user condition combined"
    end
      
    # Match text with a regex, access the captures from the match object
@@ -44,23 +44,29 @@ scamp.behaviour do
      say "You said #{yousaid}"
    end
    
-   # Simple string match, interpolating the channel and user in response.
+   # Simple string match, interpolating the room and user in response.
    match "something" do |data|
-     # Send the response to a different channel
-     say "#{user} said something in channel #{channel}", "Robot Army"
+     # Send the response to a different room
+     say "#{user} said something in room #{room}", "Robot Army"
      
-     # Send the response to a different channel, using the channel ID
-     say "#{user} said something in channel #{channel}", 293788
+     # Send the response to a different room, using the room ID
+     say "#{user} said something in room #{room}", 293788
      
-     # Send the response to the originating channel
-     say "#{user} said something in channel #{channel}"
+     # Send the response to the originating room
+     say "#{user} said something in room #{room}"
    end
    
-   match "multi-condition match", :conditions => {:channel => [401839, "Monitoring"], :nick => ["Will Jessop", "Noah Lorang"]} do
-     # Reply in the current channel
+   # Play some sounds
+   match "ohmy" do
+     play "yeah"
+     play "drama"
+   end
+   
+   match "multi-condition match", :conditions => {:room => [401839, "Monitoring"], :user => ["Will Jessop", "Noah Lorang"]} do
+     # Reply in the current room
      say "multi-condition match"
    end
 end
 
-# FIXME: this does if the channel doesn't exist. Need a better error.
+# FIXME: this does if the room doesn't exist. Need a better error.
 scamp.connect!([293788, "Monitoring"])

data/lib/scamp/action.rb

@@ -1,6 +1,6 @@
 #
 # Actions are run in the context of a Scamp::Action.
-# This allows us to make channel, nick etc. methods
+# This allows us to make room, user etc. methods
 # available on a per-message basis
 #
 
@@ -27,8 +27,12 @@ class Scamp
       end if match.respond_to?(:names) # 1.8 doesn't support named captures
     end
     
-    def channel
-      bot.channel_name_for @message[:room_id]
+    def room_id
+      @message[:room_id]
+    end
+    
+    def room
+      bot.room_name_for @message[:room_id]
     end
     
     def user
@@ -53,8 +57,12 @@ class Scamp
       bot.command_list
     end
     
-    def say(msg, channel_id_or_name = channel)
-      bot.say(msg, channel_id_or_name)
+    def say(msg, room_id_or_name = room_id)
+      bot.say(msg, room_id_or_name)
+    end
+    
+    def play(sound, room_id_or_name = room_id)
+      bot.play(sound, room_id_or_name)
     end
   end
 end

data/lib/scamp/connection.rb

@@ -2,19 +2,19 @@ class Scamp
   module Connection
     private
     
-    def connect(api_key, channel_list)
+    def connect(api_key, room_list)
       EventMachine.run do
         
-        # Check for channels to join, and join them
+        # Check for rooms to join, and join them
         EventMachine::add_periodic_timer(5) do
-          while id = @channels_to_join.pop
+          while id = @rooms_to_join.pop
             join_and_stream(id)
           end
         end
         
-        populate_channel_list do
-          logger.debug "Adding #{channel_list.join ', '} to list of channels to join"
-          @channels_to_join = channel_list.map{|c| channel_id(c) }
+        populate_room_list do
+          logger.debug "Adding #{room_list.join ', '} to list of rooms to join"
+          @rooms_to_join = room_list.map{|c| room_id(c) }
         end
         
       end

data/lib/scamp/matcher.rb

@@ -1,6 +1,6 @@
 class Scamp
   class Matcher
-    attr_accessor :conditions, :trigger, :action, :bot
+    attr_accessor :conditions, :trigger, :action, :bot, :required_prefix
     
     def initialize(bot, params = {})
       params ||= {}
@@ -26,6 +26,10 @@ class Scamp
     private
     
     def triggered_by(message_text)
+      if message_text && required_prefix 
+        message_text = handle_prefix(message_text)
+        return false unless message_text
+      end
       if trigger.is_a? String
         return true if trigger == message_text
       elsif trigger.is_a? Regexp
@@ -36,6 +40,25 @@ class Scamp
       false
     end
     
+    def handle_prefix(message_text)
+      return false unless message_text
+      if required_prefix.is_a? String
+        if required_prefix == message_text[0...required_prefix.length]
+          message_text.gsub(required_prefix,'') 
+        else
+          false
+        end
+      elsif required_prefix.is_a? Regexp
+        if required_prefix.match message_text
+          message_text.gsub(required_prefix,'')
+        else
+          false
+        end
+      else
+        false
+      end
+    end 
+    
     def run(msg, match = nil)
       action_run = Action.new(bot, action, msg)
       action_run.matches = match if match
@@ -45,18 +68,18 @@ class Scamp
     def conditions_satisfied_by(msg)
       bot.logger.debug "Checking message against #{conditions.inspect}"
       
-      # item will be :nick or :channel
+      # item will be :user or :room
       # cond is the int or string value.
       conditions.each do |item, cond|
         bot.logger.debug "Checking #{item} against #{cond}"
         bot.logger.debug "msg is #{msg.inspect}"
         if cond.is_a? Integer
-          # bot.logger.debug "item is #{msg[{:channel => :room_id, :user => :user_id}[item]]}"
-          return false unless msg[{:channel => :room_id, :user => :user_id}[item]] == cond
+          # bot.logger.debug "item is #{msg[{:room => :room_id, :user => :user_id}[item]]}"
+          return false unless msg[{:room => :room_id, :user => :user_id}[item]] == cond
         elsif cond.is_a? String
           case item
-          when :channel
-            return false unless bot.channel_name_for(msg[:room_id]) == cond
+          when :room
+            return false unless bot.room_name_for(msg[:room_id]) == cond
           when :user
             return false unless bot.username_for(msg[:user_id]) == cond
           end

data/lib/scamp/messages.rb

@@ -0,0 +1,31 @@
+class Scamp
+  module Messages
+    
+    def say(message, room_id_or_name)
+      send_message(room_id_or_name, message, "Textmessage")
+    end
+    
+    def play(sound, room_id_or_name)
+      send_message(room_id_or_name, sound, "SoundMessage")
+    end
+    
+    private
+    
+    #  curl -vvv -H 'Content-Type: application/json' -d '{"message":{"body":"Yeeeeeaaaaaahh", "type":"Textmessage"}}' -u API_KEY:X https://37s.campfirenow.com/room/293788/speak.json
+    def send_message(room_id_or_name, payload, type)
+      # post 'speak', :body => {:message => {:body => message, :type => type}}.to_json
+      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.errback { logger.error "Couldn't connect to #{url} to post message \"#{payload}\" to room #{room_id}" }
+      http.callback {
+        if http.response_header.status == 200
+          logger.debug "Posted message \"#{payload}\" to room #{room_id}"
+        else
+          logger.error "Couldn't post message \"#{payload}\" to room #{room_id} using url #{url}, http response from the API was #{http.response_header.status}"
+        end
+      }
+    end
+      
+  end
+end

data/lib/scamp/rooms.rb

@@ -0,0 +1,113 @@
+class Scamp
+  module Rooms
+    # TextMessage (regular chat message),
+    # PasteMessage (pre-formatted message, rendered in a fixed-width font),
+    # SoundMessage (plays a sound as determined by the message, which can be either “rimshot”, “crickets”, or “trombone”),
+    # TweetMessage (a Twitter status URL to be fetched and inserted into the chat)
+    
+    def paste(text, room)
+    end
+    
+    def upload
+    end
+    
+    def join(room_id)
+      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 {
+        yield if block_given?
+      }
+    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_name_for(room_id)
+      data = room_cache_data(room_id)
+      return data["name"] if data
+      room_id.to_s
+    end
+    
+    private
+    
+    def room_cache_data(room_id)
+      return room_cache[room_id] if room_cache.has_key? room_id
+      fetch_room_data(room_id)
+      return false
+    end
+    
+    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" }
+      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
+          # No idea why using the "rooms" accessor here doesn't
+          # work but accessing the ivar directly does. There's
+          # Probably a bug.
+          @rooms = new_rooms # replace existing room list
+          yield if block_given?
+        else
+          logger.error "Couldn't fetch room list 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 join_and_stream(id)
+      join(id) do
+        logger.info "Joined room #{id} successfully"
+        fetch_room_data(id)
+        stream(id)
+      end
+    end
+    
+    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}"; rooms_to_join << room_id}
+      http.stream {|chunk| json_parser << chunk }
+    end
+
+    def room_id_from_room_name(room_name)
+      logger.debug "Looking for room id for #{room_name}"
+      rooms[room_name]["id"]
+    end
+  end
+end

data/lib/scamp/users.rb

@@ -1,16 +1,5 @@
 class Scamp
   module Users
-    
-    # <user>
-    #   <id type="integer">1</id>
-    #   <name>Jason Fried</name>
-    #   <email-address>jason@37signals.com</email-address>
-    #   <admin type="boolean">true</admin>
-    #   <created-at type="datetime">2009-11-20T16:41:39Z</created-at>
-    #   <type>Member</type>
-    #   <avatar-url>http://asset0.37img.com/global/.../avatar.png</avatar-url>
-    # </user>
-    
     # Return the user_id if we haven't got the real name and
     # kick off a user data fetch
     def username_for(user_id)
@@ -24,13 +13,16 @@ class Scamp
     def fetch_data_for(user_id)
       url = "https://#{subdomain}.campfirenow.com/users/#{user_id}.json"
       http = EventMachine::HttpRequest.new(url).get(:head => {'authorization' => [api_key, 'X'], "Content-Type" => "application/json"})
-      logger.debug http.inspect
       http.callback do
-        logger.debug "Got the data for #{user_id}"
-        update_user_cache_with(user_id, Yajl::Parser.parse(http.response)['user'])
+        if http.response_header.status == 200
+          logger.debug "Got the data for #{user_id}"
+          update_user_cache_with(user_id, Yajl::Parser.parse(http.response)['user'])
+        else
+          logger.error "Couldn't fetch user data for user #{user_id} with url #{url}, http response from API was #{http.response_header.status}"
+        end
       end
       http.errback do
-        logger.error "Couldn't fetch user data for #{user_id} with url #{url}\n#{http.response_header.status.inspect}\n#{http.response_header.inspect}\n#{http.response.inspect}"
+        logger.error "Couldn't connect to #{url} to fetch user data for user #{user_id}"
       end
     end
     

data/lib/scamp/version.rb

@@ -1,3 +1,3 @@
 class Scamp
-  VERSION = "0.0.4"
+  VERSION = "0.1.0"
 end

data/lib/scamp.rb

@@ -5,17 +5,20 @@ require "logger"
 
 require "scamp/version"
 require 'scamp/connection'
-require 'scamp/channels'
+require 'scamp/rooms'
 require 'scamp/users'
 require 'scamp/matcher'
 require 'scamp/action'
+require 'scamp/messages'
 
 class Scamp
   include Connection
-  include Channels
+  include Rooms
   include Users
+  include Messages
 
-  attr_accessor :channels, :user_cache, :channel_cache, :matchers, :api_key, :subdomain, :logger, :verbose, :first_match_only, :channels_to_join
+  attr_accessor :rooms, :user_cache, :room_cache, :matchers, :api_key, :subdomain,
+                :logger, :verbose, :first_match_only, :required_prefix, :rooms_to_join
 
   def initialize(options = {})
     options ||= {}
@@ -31,10 +34,10 @@ class Scamp
       end
     end
     
-    @channels_to_join = []
-    @channels = {}
+    @rooms_to_join = []
+    @rooms = {}
     @user_cache = {}
-    @channel_cache = {}
+    @room_cache = {}
     @matchers ||= []
   end
   
@@ -42,9 +45,9 @@ class Scamp
     instance_eval &block
   end
   
-  def connect!(channel_list)
+  def connect!(room_list)
     logger.info "Starting up"
-    connect(api_key, channel_list)
+    connect(api_key, room_list)
   end
   
   def command_list
@@ -73,7 +76,7 @@ class Scamp
 
   def match trigger, params={}, &block
     params ||= {}
-    matchers << Matcher.new(self, {:trigger => trigger, :action => block, :conditions => params[:conditions]})
+    matchers << Matcher.new(self, {:trigger => trigger, :action => block, :conditions => params[:conditions], :required_prefix => required_prefix})
   end
   
   def process_message(msg)

data/scamp.gemspec

@@ -7,7 +7,7 @@ Gem::Specification.new do |s|
   s.version     = Scamp::VERSION
   s.authors     = ["Will Jessop"]
   s.email       = ["will@willj.net"]
-  s.homepage    = ""
+  s.homepage    = "https://github.com/wjessop/Scamp"
   s.summary     = %q{Eventmachine based Campfire bot framework}
   s.description = %q{Eventmachine based Campfire bot framework}
 
@@ -22,4 +22,5 @@ Gem::Specification.new do |s|
 
   s.add_development_dependency "rspec", "~> 2.6.0"
   s.add_development_dependency "mocha", "~> 0.10.0"
+  s.add_development_dependency "webmock", "~> 1.7.6"
 end