scamp 0.1.1 → 0.1.2

data/README.md

@@ -83,7 +83,7 @@ Matchers are tested in order and all that satisfy the match and conditions will
       end
       
       # 
-      # Named captures become avaiable in your match block
+      # Named captures become available in your match block
       # 
       match /^say (?<yousaid>.+)$/ do
         say "You said #{yousaid}"
@@ -129,7 +129,11 @@ In the room/user conditions and say/play commands you can use the name or ID of
     say "#{user} said something in room #{room}", 237872
     say "#{user} said something in room #{room}", "System Administration"
 
-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
+By default Scamp listens to itself. This could either be fun, or dangerous, you decide. You can turn this off by passing :ignore\_self => true in the initialisation options:
+
+    scamp = Scamp.new(:api_key => "YOUR API KEY", :subdomain => "yoursubdomain", :ignore_self => true)
+
+Scamp will also run _all_ match blocks that an input string matches, you can make Scamp only run the first block it matches by passing in :first\_match\_only => true:
 
     scamp = Scamp.new(:api_key => "YOUR API KEY", :subdomain => "yoursubdomain", :first_match_only => true)
 

data/lib/scamp.rb

@@ -18,7 +18,8 @@ class Scamp
   include Messages
 
   attr_accessor :rooms, :user_cache, :room_cache, :matchers, :api_key, :subdomain,
-                :logger, :verbose, :first_match_only, :required_prefix, :rooms_to_join
+                :logger, :verbose, :first_match_only, :ignore_self, :required_prefix,
+                :rooms_to_join
 
   def initialize(options = {})
     options ||= {}
@@ -81,6 +82,7 @@ class Scamp
   
   def process_message(msg)
     logger.debug "Received message #{msg.inspect}"
+    return false if ignore_self && is_me?(msg[:user_id])
     matchers.each do |matcher|
       break if first_match_only & matcher.attempt(msg)
     end

data/lib/scamp/connection.rb

@@ -17,6 +17,9 @@ class Scamp
           @rooms_to_join = room_list.map{|c| room_id(c) }
         end
         
+        # populate bot data separately, in case we are ignoring ourselves
+        fetch_data_for('me')
+        
       end
     end
       

data/lib/scamp/users.rb

@@ -8,6 +8,15 @@ class Scamp
       return user_id.to_s
     end
     
+    def is_me?(user_id)
+      if user_cache['me']
+        return user_cache['me']['id'] == user_id
+      else
+        fetch_data_for('me')
+        return false        
+      end
+    end
+    
     private
     
     def fetch_data_for(user_id)

data/lib/scamp/version.rb

@@ -1,3 +1,3 @@
 class Scamp
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

data/spec/lib/scamp_spec.rb

@@ -3,7 +3,7 @@ require "spec_helper"
 describe Scamp do
   before do
     @valid_params = {:api_key => "6124d98749365e3db2c9e5b27ca04db6", :subdomain => "oxygen"} 
-    @valid_user_cache_data = {123 => {"name" => "foo"}, 456 => {"name" => "bar"}}
+    @valid_user_cache_data = {123 => {"name" => "foo"}, 456 => {"name" => "bar"}, 'me' => {"name" => "bot", "id" => 123}}
     
     # Stub fetch for room data
     @valid_room_cache_data = {
@@ -183,6 +183,21 @@ describe Scamp do
         bot.send(:process_message, {:room_id => 123, :user_id => 456, :body => "a string"})
         bot.send(:process_message, {:room_id => 456, :user_id => 123, :body => "a string"})
       end
+      
+      it "should ignore itself if so requested" do
+        canary = mock
+        canary.expects(:bang).never
+
+        bot = a Scamp
+        bot.user_cache = @valid_user_cache_data
+        bot.ignore_self = true
+        bot.ignore_self.should be_true
+        bot.behaviour do
+          match("a string") {canary.bang}
+        end
+        
+        bot.send(:process_message, {:user_id => 123, :body => "a string"})
+      end
     end
     
     describe "strings" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: scamp
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-09-24 00:00:00.000000000Z
+date: 2011-09-27 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: eventmachine
-  requirement: &70295424002980 !ruby/object:Gem::Requirement
+  requirement: &2152286680 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 1.0.0.beta.4
   type: :runtime
   prerelease: false
-  version_requirements: *70295424002980
+  version_requirements: *2152286680
 - !ruby/object:Gem::Dependency
   name: yajl-ruby
-  requirement: &70295424002200 !ruby/object:Gem::Requirement
+  requirement: &2152286140 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 0.8.3
   type: :runtime
   prerelease: false
-  version_requirements: *70295424002200
+  version_requirements: *2152286140
 - !ruby/object:Gem::Dependency
   name: em-http-request
-  requirement: &70295424001540 !ruby/object:Gem::Requirement
+  requirement: &2152285600 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: 1.0.0.beta.4
   type: :runtime
   prerelease: false
-  version_requirements: *70295424001540
+  version_requirements: *2152285600
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70295424000840 !ruby/object:Gem::Requirement
+  requirement: &2152285080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +54,10 @@ dependencies:
         version: 2.6.0
   type: :development
   prerelease: false
-  version_requirements: *70295424000840
+  version_requirements: *2152285080
 - !ruby/object:Gem::Dependency
   name: mocha
-  requirement: &70295424000160 !ruby/object:Gem::Requirement
+  requirement: &2152284560 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,10 +65,10 @@ dependencies:
         version: 0.10.0
   type: :development
   prerelease: false
-  version_requirements: *70295424000160
+  version_requirements: *2152284560
 - !ruby/object:Gem::Dependency
   name: webmock
-  requirement: &70295423999460 !ruby/object:Gem::Requirement
+  requirement: &2152284020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -76,7 +76,7 @@ dependencies:
         version: 1.7.6
   type: :development
   prerelease: false
-  version_requirements: *70295423999460
+  version_requirements: *2152284020
 description: Eventmachine based Campfire bot framework
 email:
 - will@willj.net