scamp 0.1.2 → 0.2.0

data/LICENSE.md

@@ -0,0 +1,19 @@
+Copyright (C) 2011 by Will Jessop
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -18,135 +18,197 @@ Ruby >= 1.9.2 (At least for the named captures)
 
 ### The most simple example:
 
-    require 'scamp'
-    
-    scamp = Scamp.new(:api_key => "YOUR API KEY", :subdomain => "yoursubdomain", :verbose => true)
-    
-    scamp.behaviour do
-      # Simple matching based on regex or string:
-      match "ping" do
-        say "pong"
+``` ruby
+require 'scamp'
+
+scamp = Scamp.new(:api_key => "YOUR API KEY", :subdomain => "yoursubdomain", :verbose => true)
+
+scamp.behaviour do
+  # Simple matching based on regex or string:
+  match "ping" do
+    say "pong"
+  end
+end
+
+# Connect and join some rooms
+scamp.connect!([293788, "Monitoring"])
+```
+
+### Everyone wants an image search
+
+``` ruby
+require 'scamp'
+require 'cgi'
+
+scamp = Scamp.new(:api_key => "YOUR API KEY", :subdomain => "yoursubdomain", :verbose => true)
+
+scamp.behaviour do
+  match /^artme (?<search>\w+)/ do
+    url = "http://ajax.googleapis.com/ajax/services/search/images?rsz=large&start=0&v=1.0&q=#{CGI.escape(search)}"
+    http = EventMachine::HttpRequest.new(url).get
+    http.errback { say "Couldn't get #{url}: #{http.response_status.inspect}" }
+    http.callback {
+      if http.response_header.status == 200
+        results = Yajl::Parser.parse(http.response)
+        if results['responseData']['results'].size > 0
+          say results['responseData']['results'][0]['url']
+        else
+          say "No images matched #{search}"
+        end
+      else
+        # logger.warn "Couldn't get #{url}"
+        say "Couldn't get #{url}"
       end
-    end
-    
-    # Connect and join some rooms
-    scamp.connect!([293788, "Monitoring"])
+    }
+  end
+end
+
+# Connect and join some rooms
+scamp.connect!([293788, "Monitoring"])
+```
 
 ### A more in-depth run through
 
 Matchers are tested in order and all that satisfy the match and conditions will be run. Careful, Scamp listens to itself, you could easily create an infinite loop. Look in the examples dir for more.
 
-    require 'scamp'
-
-    # Add :verbose => true to get debug output, otherwise the logger will output INFO
-    scamp = Scamp.new(:api_key => "YOUR API KEY", :subdomain => "yoursubdomain", :verbose => true)
+``` ruby
+require 'scamp'
+
+# Add :verbose => true to get debug output, otherwise the logger will output INFO
+scamp = Scamp.new(:api_key => "YOUR API KEY", :subdomain => "yoursubdomain", :verbose => true)
+
+scamp.behaviour do
+  # 
+  # Simple matching based on regex or string:
+  # 
+  match /^repeat (\w+), (\w+)$/ do
+    say "You said #{matches[0]} and #{matches[1]}"
+  end
+
+  #
+  # You can specifically paste text: 
+  #
+  
+  match "paste stuff" do
+    paste "Awesome texts"
     
-    scamp.behaviour do
-      # 
-      # Simple matching based on regex or string:
-      # 
-      match /^repeat (\w+), (\w+)$/ do
-        say "You said #{matches[0]} and #{matches[1]}"
-      end
-      
-      # 
-      # A special user and room method is available in match blocks.
-      # 
-      match "a user said" do
-        say "#{user} said something in room #{room}"
-      end
-      
-      match "Hello!" do
-        say "Hi there"
-      end
-      
-      # 
-      # You can play awesome sounds
-      # 
-      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", :room => 123456} do
-        say "You can mix conditions"
-      end
-      
-      # 
-      # Named captures become available in your match block
-      # 
-      match /^say (?<yousaid>.+)$/ do
-        say "You said #{yousaid}"
-      end
-      
-      # 
-      # 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 room #{room}"
-        say "#{user} said something in room #{room}", 237872
-        say "#{user} said something in room #{room}", "System Administration"
-      end
-      
-      # 
-      # A list of commands is available as command_list this matcher uses it
-      # to format a help text
-      # 
-      match "help" do
-        max_command_length = command_list.map{|cl| cl.first.to_s }.max_by(&:size).size
-        format_string = "%#{max_command_length + 1}s"
-        formatted_commands = command_list.map{|action, conds| "#{sprintf(format_string, action)} | #{conds.size == 0 ? '' : conds.inspect}"}
-        say <<-EOS
-    #{sprintf("%-#{max_command_length + 1}s", "Command match")} | Conditions
-    --------------------------------------------------------------------------------
-    #{formatted_commands.join("\n")}
-        EOS
-      end
-    end
-      
-    # Connect and join some rooms
-    scamp.connect!([293788, "Monitoring"])
+    # say()'ing multiline strings will paste automatically however:
+    say <<-EOS
+This will be pasted
+even though you called say
+    EOS
+  end
+  
+  # 
+  # A special user and room method is available in match blocks.
+  # 
+  match "a user said" do
+    say "#{user} said something in room #{room}"
+  end
+  
+  match "Hello!" do
+    say "Hi there"
+  end
+  
+  # 
+  # You can play awesome sounds
+  # 
+  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 matches 'Some Room'"
+  end
+  
+  match "some text", :conditions => {:user => "Some User"} do
+    say "Only said if user name matches 'Some User'"
+  end
+  
+  match /some other text/, :conditions => {:user => "Some User", :room => 123456} do
+    say "You can mix conditions"
+  end
+
+  match "some text", :conditions => {:room => ["Some Room", "Some Other Room"]} do
+    say "You can list multiple rooms"
+  end
+
+  # 
+  # Named captures become available in your match block
+  # 
+  match /^say (?<yousaid>.+)$/ do
+    say "You said #{yousaid}"
+  end
+  
+  # 
+  # 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 room #{room}"
+    say "#{user} said something in room #{room}", 237872
+    say "#{user} said something in room #{room}", "System Administration"
+  end
+  
+  # 
+  # A list of commands is available as command_list this matcher uses it
+  # to format a help text
+  # 
+  match "help" do
+    max_command_length = command_list.map{|cl| cl.first.to_s }.max_by(&:size).size
+    format_string = "%#{max_command_length + 1}s"
+    formatted_commands = command_list.map{|action, conds| "#{sprintf(format_string, action)} | #{conds.size == 0 ? '' : conds.inspect}"}
+    say <<-EOS
+#{sprintf("%-#{max_command_length + 1}s", "Command match")} | Conditions
+--------------------------------------------------------------------------------
+#{formatted_commands.join("\n")}
+    EOS
+  end
+end
+  
+# Connect and join some rooms
+scamp.connect!([293788, "Monitoring"])
+```
 
 In the room/user conditions and say/play commands you can use the name or ID of a user or room, eg:
 
-    :conditions => {:room => "some string"}
-    :conditions => {:room => 123456}
+``` ruby
+:conditions => {:room => "some string"}
+:conditions => {:room => 123456}
 
-    :conditions => {:user => "some string"}
-    :conditions => {:user => 123456}
+:conditions => {:user => "some string"}
+:conditions => {:user => 123456}
 
-    say "#{user} said something in room #{room}", 237872
-    say "#{user} said something in room #{room}", "System Administration"
+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 :ignore\_self => true in the initialisation options:
 
-    scamp = Scamp.new(:api_key => "YOUR API KEY", :subdomain => "yoursubdomain", :ignore_self => true)
+``` ruby
+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)
+``` ruby
+scamp = Scamp.new(:api_key => "YOUR API KEY", :subdomain => "yoursubdomain", :first_match_only => true)
+```
 
 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:
 
-    scamp = Scamp.new(:api_key => "YOUR API KEY", :subdomain => "yoursubdomain", :required_prefix => 'Bot: ')
+``` ruby
+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
+	* Allow multiple values for conditions, eg: :conditions => {:user => ["Some User", "Some Other User"]}
 
 ## How to contribute
 
@@ -156,10 +218,11 @@ Here's the most direct way to get your work merged into the project:
 2. Clone down your fork
 3. Create a feature branch
 4. Add your feature + tests
-5. Make sure everything still passes by running the tests
-6. If necessary, rebase your commits into logical chunks, without errors
-7. Push the branch up
-8. Send a pull request for your branch
+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
 
 Take a look at the TODO list or known issues for some inspiration if you need it.
 
@@ -172,22 +235,4 @@ First class support, commits and pull requests, thanks guys!
 
 ## License
 
-Copyright (C) 2011 by Will Jessop
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.
+See LICENSE.md

data/lib/scamp/action.rb

@@ -60,7 +60,11 @@ class Scamp
     def say(msg, room_id_or_name = room_id)
       bot.say(msg, room_id_or_name)
     end
-    
+
+    def paste(msg, room_id_or_name = room_id)
+      bot.paste(msg, room_id_or_name)
+    end
+
     def play(sound, room_id_or_name = room_id)
       bot.play(sound, room_id_or_name)
     end

data/lib/scamp/matcher.rb

@@ -84,6 +84,13 @@ class Scamp
             return false unless bot.username_for(msg[:user_id]) == cond
           end
           bot.logger.error "Don't know how to deal with a match item of #{item}, cond #{cond}"
+        elsif cond.is_a? Array
+          case item
+          when :room, :rooms
+            return cond.select {|e| e.is_a? Integer }.include?(msg[{:room => :room_id}[item]]) ||
+                   cond.select {|e| e.is_a? String }.include?(bot.room_name_for(msg[:room_id]))
+          end
+          bot.logger.error "Don't know how to deal with a match item of #{item}, cond #{cond}"
         end
       end
       true

data/lib/scamp/messages.rb

@@ -4,7 +4,11 @@ class Scamp
     def say(message, room_id_or_name)
       send_message(room_id_or_name, message, "Textmessage")
     end
-    
+
+    def paste(message, room_id_or_name)
+      send_message(room_id_or_name, message, "PasteMessage")
+    end
+
     def play(sound, room_id_or_name)
       send_message(room_id_or_name, sound, "SoundMessage")
     end

data/lib/scamp/rooms.rb

@@ -4,10 +4,7 @@ class Scamp
     # 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
     

data/lib/scamp/version.rb

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

data/spec/lib/scamp_spec.rb

@@ -106,34 +106,69 @@ describe Scamp do
   describe "matching" do
     
     context "with conditions" do
-      it "should limit matches by room id" do
-        canary = mock
-        canary.expects(:lives).once
-        canary.expects(:bang).never
-        
-        bot = a Scamp
-        bot.behaviour do
-          match("a string", :conditions => {:room => 123}) {canary.lives}
-          match("a string", :conditions => {:room => 456}) {canary.bang}
+      context "for room" do
+
+        it "should limit matches by id" do
+          canary = mock
+          canary.expects(:lives).once
+          canary.expects(:bang).never
+          
+          bot = a Scamp
+          bot.behaviour do
+            match("a string", :conditions => {:room => 123}) {canary.lives}
+            match("a string", :conditions => {:room => 456}) {canary.bang}
+          end
+          
+          bot.send(:process_message, {:room_id => 123, :body => "a string"})
         end
-        
-        bot.send(:process_message, {:room_id => 123, :body => "a string"})
-      end
-      
-      it "should limit matches by room name" do
-        canary = mock
-        canary.expects(:lives).once
-        canary.expects(:bang).never
-        
-        bot = a Scamp
-        bot.behaviour do
-          match("a string", :conditions => {:room => "foo"}) {canary.lives}
-          match("a string", :conditions => {:room => "bar"}) {canary.bang}
+
+        it "should limit matches by array of IDs" do
+          canary = mock
+          canary.expects(:lives).once
+          canary.expects(:bang).never
+          
+          bot = a Scamp
+          bot.behaviour do
+            match("a string", :conditions => {:room => [123]}) {canary.lives}
+            match("a string", :conditions => {:room => [456]}) {canary.bang}
+          end
+          
+          bot.room_cache = @valid_room_cache_data
+
+          bot.send(:process_message, {:room_id => 123, :body => "a string"})
         end
-        
-        bot.room_cache = @valid_room_cache_data
-        
-        bot.send(:process_message, {:room_id => 123, :body => "a string"})
+
+        it "should limit matches by array in complex form" do
+          canary = mock
+          canary.expects(:lives).once
+          canary.expects(:bang).never
+
+          bot = a Scamp
+          bot.behaviour do
+           match("a string", :conditions => {:rooms => ["foo", 777]}) {canary.lives}
+           match("a string", :conditions => {:room => ["bar"]}) {canary.bang}
+          end
+
+          bot.room_cache = @valid_room_cache_data
+          bot.send(:process_message, {:room_id => 123, :body => "a string"})
+        end
+
+        it "should limit matches by name" do
+          canary = mock
+          canary.expects(:lives).once
+          canary.expects(:bang).never
+          
+          bot = a Scamp
+          bot.behaviour do
+            match("a string", :conditions => {:room => "foo"}) {canary.lives}
+            match("a string", :conditions => {:room => "bar"}) {canary.bang}
+          end
+          
+          bot.room_cache = @valid_room_cache_data
+          
+          bot.send(:process_message, {:room_id => 123, :body => "a string"})
+        end
+
       end
       
       it "should limit matches by user id" do
@@ -606,6 +641,7 @@ describe Scamp do
       before do
         @message_post_url = "https://#{@valid_params[:subdomain]}.campfirenow.com/room/123/speak.json"
       end
+
       it "should send a message" do
         mock_logger
         bot = a Scamp
@@ -618,7 +654,20 @@ describe Scamp do
         }
         logger_output.should =~ /DEBUG.*Posted message "Hi" to room 123/
       end
-      
+
+      it "should paste a message" do
+        mock_logger
+        bot = a Scamp
+
+        EM.run_block {
+          stub_request(:post, @message_post_url).
+            with(:headers => {'Authorization'=>[@valid_params[:api_key], 'X'], 'Content-Type' => 'application/json'}).
+            to_return(:status => 201, :body => Yajl::Encoder.encode(:room => @valid_room_cache_data[123]), :headers => {})
+          bot.send(:send_message, 123, "Hi", "PasteMessage")
+        }
+        logger_output.should =~ /DEBUG.*Posted message "Hi" to room 123/
+      end
+
       it "should handle HTTP errors fetching individual room data" do
         mock_logger
         bot = a Scamp

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: scamp
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-09-27 00:00:00.000000000Z
+date: 2011-10-03 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: eventmachine
-  requirement: &2152286680 !ruby/object:Gem::Requirement
+  requirement: &2156161720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 1.0.0.beta.4
   type: :runtime
   prerelease: false
-  version_requirements: *2152286680
+  version_requirements: *2156161720
 - !ruby/object:Gem::Dependency
   name: yajl-ruby
-  requirement: &2152286140 !ruby/object:Gem::Requirement
+  requirement: &2156160320 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 0.8.3
   type: :runtime
   prerelease: false
-  version_requirements: *2152286140
+  version_requirements: *2156160320
 - !ruby/object:Gem::Dependency
   name: em-http-request
-  requirement: &2152285600 !ruby/object:Gem::Requirement
+  requirement: &2156158160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: 1.0.0.beta.4
   type: :runtime
   prerelease: false
-  version_requirements: *2152285600
+  version_requirements: *2156158160
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2152285080 !ruby/object:Gem::Requirement
+  requirement: &2156156720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +54,10 @@ dependencies:
         version: 2.6.0
   type: :development
   prerelease: false
-  version_requirements: *2152285080
+  version_requirements: *2156156720
 - !ruby/object:Gem::Dependency
   name: mocha
-  requirement: &2152284560 !ruby/object:Gem::Requirement
+  requirement: &2156154880 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,10 +65,10 @@ dependencies:
         version: 0.10.0
   type: :development
   prerelease: false
-  version_requirements: *2152284560
+  version_requirements: *2156154880
 - !ruby/object:Gem::Dependency
   name: webmock
-  requirement: &2152284020 !ruby/object:Gem::Requirement
+  requirement: &2156151200 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -76,7 +76,7 @@ dependencies:
         version: 1.7.6
   type: :development
   prerelease: false
-  version_requirements: *2152284020
+  version_requirements: *2156151200
 description: Eventmachine based Campfire bot framework
 email:
 - will@willj.net
@@ -87,6 +87,7 @@ files:
 - .gitignore
 - .rspec
 - Gemfile
+- LICENSE.md
 - README.md
 - Rakefile
 - examples/bot.rb