scamp 1.2.0 → 2.0.0.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5a8f622dff6a60fddd4050cde82ebe3708197d52
-  data.tar.gz: b5f6e9c1d1f0ecd3278b82cc9bea44bb69d1c045
+  metadata.gz: 68ec4dbee8f688bce6bc1b63ea69e53a4a343c0d
+  data.tar.gz: 46806e4a3ac13a4c961e09f32cef1354830185c7
 SHA512:
-  metadata.gz: ef395384dcb7efb1e37398a4fe0e480001688b2ccd74c2f654ac458a1dc06ff8feaf173e49b181458e8893c6c2e62bd145a3faa06b188a4e7a1cce41b3f90ac0
-  data.tar.gz: 299820bac823a24117d2d7ce4fb72494783e5e78c07358ab7e51a67062500ffdf3d546bf04f64b27704fccbe9e2d2bbfbf437beb38d393ed357ed8a71cb09cfa
+  metadata.gz: f8b6808337113e7ee703ee49536a297f053cb355a1200fb875f348335465f398dcc7f1ff7484b936b748695052bb7e101e9fd6ab54126635247c6f287caeac4c
+  data.tar.gz: 7e27db164920d26c8a75404b1c8c710e3addd3810022b06f847e1759cf4e047a298ab6cd69c0b6ad8525c32568f78e3818cfeca7bf60819fb36825db90bf165a

data/.gitignore

@@ -1,3 +1,8 @@
 .rvmrc
 Gemfile.lock
 pkg/
+coverage/
+.DS_Store
+bin
+.rbx
+.bundle

data/README.md

@@ -10,11 +10,11 @@ If you like or use Scamp I'd love to hear from you. Drop me at line at will at 3
 
 ## Requirements
 
-Ruby >= 1.9.2 (At least for the named captures)
+Ruby >= 1.9.2
 
 ## Installation
 
-`gem install scamp` or put `gem 'scamp'` in your Gemfile.
+`gem install scamp` or `gem 'scamp'` in your Gemfile.
 
 ## Usage and Examples
 
@@ -22,30 +22,34 @@ Ruby >= 1.9.2 (At least for the named captures)
 
 ``` ruby
 require 'scamp'
+require 'scamp-campfire-adapter'
 
-scamp = Scamp.new(:api_key => "YOUR API KEY", :subdomain => "yoursubdomain", :verbose => true)
+Scamp.new do |scamp|
+  scamp.adapter :campfire, Scamp::Campfire::Adapter, api_key: "YOUR API KEY",
+                                                   subdomain: "yoursubdomain",
+                                                       rooms: [293788]
 
-scamp.behaviour do
   # Simple matching based on regex or string:
-  match "ping" do
-    say "pong"
+  scamp.match "ping" do |room, msg|
+    room.say "pong"
   end
 end
-
-# Connect and join some rooms
-scamp.connect!([293788, "Monitoring"])
 ```
 
 ### Everyone wants an image search
 
 ``` ruby
 require 'scamp'
+require 'scamp-campfire-adapter'
+require 'em-http-request'
 require 'cgi'
 
-scamp = Scamp.new(:api_key => "YOUR API KEY", :subdomain => "yoursubdomain", :verbose => true)
+Scamp.new do |scamp|
+  scamp.adapter :campfire, Scamp::Campfire::Adapter, api_key: "YOUR API KEY",
+                                                   subdomain: "yoursubdomain",
+                                                       rooms: [293788]
 
-scamp.behaviour do
-  match /^artme (?<search>\w+)/ do
+  scamp.match /^artme (?<search>\w+)/ do |room, msg|
     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}" }
@@ -53,20 +57,16 @@ scamp.behaviour do
       if http.response_header.status == 200
         results = Yajl::Parser.parse(http.response)
         if results['responseData']['results'].size > 0
-          say results['responseData']['results'][0]['url']
+          room.say results['responseData']['results'][0]['url']
         else
-          say "No images matched #{search}"
+          room.say "No images matched #{search}"
         end
       else
-        # logger.warn "Couldn't get #{url}"
-        say "Couldn't get #{url}"
+        room.say "Couldn't get #{url}"
       end
     }
   end
 end
-
-# Connect and join some rooms
-scamp.connect!([293788, "Monitoring"])
 ```
 
 ### A more in-depth run through
@@ -77,139 +77,53 @@ Matchers are tested in order and all that satisfy the match and conditions will
 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.new do |scamp|
+  scamp.adapter :campfire, Scamp::Campfire::Adapter, api_key: "YOUR API KEY",
+                                                   subdomain: "yoursubdomain",
+                                                       rooms: [293788],
+                                                     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"
-    
-    # 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"
+  scamp.match /^repeat (\w+), (\w+)$/ do |room, msg|
+    room.say "You said #{matches[0]} and #{matches[1]}"
   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
+  scamp.match /^say (?<yousaid>.+)$/ do |room, msg|
+    room.say "You said #{msg.matches.yousaid}"
   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:
+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:
 
 ``` ruby
-:conditions => {:room => "some string"}
-:conditions => {:room => 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"
+Scamp.new :first_match_only => true do |scamp|
+end
 ```
 
-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:
+## Adapters
 
-``` ruby
-scamp = Scamp.new(:api_key => "YOUR API KEY", :subdomain => "yoursubdomain", :ignore_self => true)
-```
+### Adapter channels
 
-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:
+### Writing an adapter
 
-``` 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:
+## Plugins
 
-``` ruby
-scamp = Scamp.new(:api_key => "YOUR API KEY", :subdomain => "yoursubdomain", :required_prefix => 'Bot: ')
-```
+### Writing plugins
+
+* TODO
 
-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
 
+  * Get messages working back to adapters
 	* Allow multiple values for conditions, eg: :conditions => {:user => ["Some User", "Some Other User"]}
 
 ## How to contribute
@@ -230,7 +144,8 @@ Take a look at the TODO list or known issues for some inspiration if you need it
 
 ## Authors
 
-* Will Jessop (will@willj.net)
+* [Will Jessop](http://willj.net/)
+* [Adam Holt](http://adamholt.co.uk/)
 
 ## Thanks
 
@@ -238,8 +153,6 @@ First class support, commits and pull requests, thanks guys!
 
 * [Caius Durling](http://caius.name/)
 * Sudara Williams of [Ramen Music](http://ramenmusic.com)
-* [Dom Hodgson](http://www.thehodge.co.uk/) (for the name)
-* Pull requests: @mheffner
 
 ## License
 

data/examples/v2.rb

@@ -0,0 +1,39 @@
+$:.unshift File.join(File.dirname(__FILE__), '../lib')
+
+require 'scamp'
+require 'scamp/adapter'
+require 'scamp/message'
+require 'scamp/plugin'
+
+class PingPlugin < Scamp::Plugin
+  match /^ping/, :say_pong
+
+  def say_pong channel, msg
+    channel.say "pong"
+  end
+end
+
+class TestAdapter < Scamp::Adapter
+  class Context
+    def say msg
+      puts msg
+    end
+  end
+
+  def connect!
+    EventMachine::PeriodicTimer.new(@opts[:delay]) do
+      msg = Scamp::Message.new(self, :body => "ping")
+      context = TestAdapter::Context.new
+      push [context, msg]
+    end
+  end
+end
+
+Scamp.new do |bot|
+  bot.adapter :test, TestAdapter, :delay => 1
+  bot.adapter :another, TestAdapter, :delay => 5
+
+  bot.plugin PingPlugin, :on => [:test]
+
+  bot.connect!
+end

data/lib/scamp/adapter.rb

@@ -0,0 +1,47 @@
+class Scamp
+  class Adapter
+    attr_accessor :bot
+
+    def initialize(bot, opts={})
+      @bot = bot
+      @opts = opts
+    end
+
+    def matches_required_format?(msg)
+      return true unless msg
+      return true unless bot.required_format
+      if bot.required_format.is_a? String
+        msg.index(bot.required_format) == 0
+      elsif bot.required_format.is_a? Regexp
+        msg.match bot.required_format
+      else
+        raise ArgumentError, "You passed a :required_format that isn't a string or regexp, dont't know how to match it!"
+      end
+    end
+
+    def strip_prefix(msg)
+      # We only strip required prefxes if they are strings, and strip_prefix is set
+      return msg unless bot.required_format.is_a?(String) && bot.strip_prefix
+      msg.sub(bot.required_format, '').strip unless msg.nil?
+    end
+
+    def subscribe &block
+      channel.subscribe &block
+    end
+
+    def push(msg)
+      channel.push msg
+    end
+    alias_method :<<, :push
+
+    def connect!
+      raise NotImplementedError, "connect! must be implemented"
+    end
+
+    private
+
+    def channel
+      @channel ||= EM::Channel.new
+    end
+  end
+end

data/lib/scamp/matcher.rb

@@ -1,106 +1,30 @@
 class Scamp
   class Matcher
-    attr_accessor :conditions, :trigger, :action, :bot, :required_prefix
-    
+    attr_accessor :on, :conditions, :trigger, :action, :bot, :required_prefix
+
     def initialize(bot, params = {})
-      params ||= {}
       params[:conditions] ||= {}
+      params[:on] ||= bot.adapters.keys
+      raise ArgumentError, "matcher must have a trigger" unless params[:trigger]
+      raise ArgumentError, "matcher must have a action" unless params[:action]
       params.each { |k,v| send("#{k}=", v) }
       @bot = bot
     end
-    
-    def attempt(msg)
-      return false unless conditions_satisfied_by(msg)
-      match = triggered_by(msg[:body])
-      if match
-        if match.is_a? MatchData
-          run(msg, match)
-        else
-          run(msg)
-        end
+
+    def attempt(channel, context, msg)
+      if listening?(channel) && msg.matches?(trigger) && msg.valid?(conditions)
+        run(context, msg)
         return true
       end
-      false
-    end
-    
-    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
-        return trigger.match message_text
-      else
-        bot.logger.warn "Don't know what to do with #{trigger.inspect} at #{__FILE__}:#{__LINE__}"
-      end
-      false
+      return 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
-      action_run.run
+
+    def run(context, msg)
+      action.call(context, msg)
     end
-    
-    def conditions_satisfied_by(msg)
-      bot.logger.debug "Checking message against #{conditions.inspect}"
 
-      # 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[{: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 :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
-          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}"
-        elsif cond.is_a? Symbol
-          case item
-          when :type
-            return (cond == :text && msg[:type] == "TextMessage") ||
-              (cond == :paste && msg[:type] == "PasteMessage")
-          end
-          bot.logger.error "Don't know how to deal with a match item of #{item}, cond #{cond}"
-        end
-      end
-      true
+    def listening?(channel)
+      on.include?(channel)
     end
   end
 end

data/lib/scamp/matches.rb

@@ -0,0 +1,22 @@
+class Scamp
+  class Matches
+    include Enumerable
+
+    def initialize matches
+      @matches = matches
+      @matches.names.each do |name|
+        self.define_singleton_method name.to_sym do
+          matches[name.to_sym]
+        end
+      end
+    end
+
+    def [] index
+      @matches[1..-1][index]
+    end
+
+    def each
+      @matches[1..-1].each {|match| yield match }
+    end
+  end
+end

data/lib/scamp/message.rb

@@ -0,0 +1,39 @@
+require 'scamp/matches'
+
+class Scamp
+  class Message
+    attr_reader :adapter, :match
+
+    def initialize(adapter, args={})
+      @adapter = adapter
+      args.each do |arg,value|
+        self.define_singleton_method arg do
+          value
+        end
+      end
+    end
+
+    def valid? conditions
+      true
+    end
+
+    def matches? trigger
+      match? trigger, body
+    end
+
+    def matches
+      Scamp::Matches.new(match) if match
+    end
+
+    protected
+
+    def match?(trigger, message)
+      if trigger.is_a? String
+        return true if trigger == message
+      elsif trigger.is_a? Regexp
+        return true if (@match = trigger.match message)
+      end
+      return false
+    end
+  end
+end

data/lib/scamp/plugin.rb

@@ -0,0 +1,33 @@
+class Scamp
+  class Plugin
+    def self.matchers
+      @matchers ||= []
+    end
+
+    def self.match trigger, method
+      self.matchers << [trigger, method]
+    end
+
+    attr_reader :bot, :options
+
+    def initialize bot, opts={}
+      @bot = bot
+      @options = opts
+
+      attach_matchers
+    end
+
+    private
+      def matcher_options
+        {
+          :on => options[:on]
+        }
+      end
+
+      def attach_matchers
+        self.class.matchers.each do |trigger, method_name|
+          @bot.match trigger, matcher_options, &Proc.new(&method(method_name))
+        end
+      end
+  end
+end

data/lib/scamp/version.rb

@@ -1,3 +1,3 @@
 class Scamp
-  VERSION = "1.2.0"
+  VERSION = "2.0.0.pre"
 end