scamp 0.0.1 → 0.0.2

data/.gitignore

@@ -1,2 +1,3 @@
 .rvmrc
+Gemfile.lock
 pkg/

data/.rspec

@@ -0,0 +1 @@
+--color

data/README.md

@@ -14,11 +14,11 @@ Ruby >= 1.9.2 (At least for the named captures)
 
 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'
+    require 'scamp'
 
-    scamp = Scamp.new(:api_key => "YOUR API KEY")
+    scamp = Scamp.new(:api_key => "YOUR API KEY", :subdomain => "yoursubdomain")
     
-    Scamp.behaviour do
+    scamp.behaviour do
       # 
       # Simple matching based on regex or string:
       # 
@@ -69,8 +69,24 @@ Matchers are tested in order and all that satisfy the match and conditions will
         say "#{user} said something in channel #{channel}", "System Administration"
       end
       
-      # Connect and join some channels
-      scamp.connect!([293788, "Monitoring"])
+      # 
+      # 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 channels
+    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:
 
@@ -87,15 +103,16 @@ In the channel/user conditions you can use the name, regex or ID of a user or ch
 
 ## TODO
 
-* Write the tests
+* Write more tests
 * Allow multiple values for conditions, eg: :conditions => {:channel => [/someregex/, "Some channel"]}
-* Remove debugging output
-* Add support for a logger
+* Add paste/play support
+* Add option to stop bot responding to itself
 
 ## Known issues
 
-* Bot doesn't detect that it's been kicked out of a channel and recommect
+* 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
 
 ## How to contribute
 
@@ -132,4 +149,4 @@ 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.
+THE SOFTWARE.

data/Rakefile

@@ -1 +1,13 @@
 require 'bundler/gem_tasks'
+
+begin
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new(:spec)
+rescue LoadError => e
+  task "spec" do
+    puts "RSpec not loaded - make sure it's installed and you're using bundle exec"
+    exit 1
+  end
+end
+
+task :default => :spec

data/examples/bot.rb

@@ -2,11 +2,11 @@
 
 $:.unshift File.join(File.dirname(__FILE__), '../lib')
 
-require 'Scamp'
+require 'scamp'
 
-scamp = Scamp.new(:api_key => "YOUR API KEY")
+scamp = Scamp.new(:api_key => "YOUR API KEY", :subdomain => "37s")
 
-Scamp.behaviour do
+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
@@ -73,4 +73,4 @@ Scamp.behaviour do
 end
 
 # FIXME: this does if the channel doesn't exist. Need a better error.
-scamp.connect!([293788, "Monitoring"])
+scamp.connect!([293788, "Monitoring"])

data/lib/scamp/action.rb

@@ -9,7 +9,7 @@
 class Scamp
   class Action
     
-    attr :matches, :bot
+    attr_accessor :matches, :bot
     
     def initialize(bot, action, message)
       @bot = bot
@@ -24,12 +24,11 @@ class Scamp
         self.class.send :define_method, name_s do
           match[name_s]
         end
-      end
+      end if match.respond_to?(:names) # 1.8 doesn't support named captures
     end
     
     def channel
-      puts "Need the real channel name at #{__FILE__}:#{__LINE__}"
-      @message[:room_id]
+      bot.channel_name_for @message[:room_id]
     end
     
     def user
@@ -50,8 +49,12 @@ class Scamp
     
     private
     
+    def command_list
+      bot.command_list
+    end
+    
     def say(msg, channel_id_or_name = channel)
       bot.say(msg, channel_id_or_name)
     end
   end
-end
+end

data/lib/scamp/channels.rb

@@ -7,10 +7,10 @@ class Scamp
     
     #  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 say(message, channel)
-      url = "https://37s.campfirenow.com/room/#{channel_id(channel)}/speak.json"
+      url = "https://#{subdomain}.campfirenow.com/room/#{channel_id(channel)}/speak.json"
       http = EventMachine::HttpRequest.new(url).post :head => {'Content-Type' => 'application/json', 'authorization' => [api_key, 'X']}, :body => Yajl::Encoder.encode({:message => {:body => message, :type => "Textmessage"}})
       
-      http.errback { STDERR.puts "Error speaking: '#{message}' to #{channel_id(channel)}" }
+      http.errback { logger.error "Error speaking: '#{message}' to #{channel_id(channel)}" }
     end
     
     def paste(text, channel)
@@ -20,10 +20,11 @@ class Scamp
     end
     
     def join(channel_id)
-      url = "https://37s.campfirenow.com/room/#{channel_id}/join.json"
+      logger.info "Joining channel #{channel_id}"
+      url = "https://#{subdomain}.campfirenow.com/room/#{channel_id}/join.json"
       http = EventMachine::HttpRequest.new(url).post :head => {'Content-Type' => 'application/json', 'authorization' => [api_key, 'X']}
       
-      http.errback { STDERR.puts "Error joining channel: #{channel_id}" }
+      http.errback { logger.error "Error joining channel: #{channel_id}" }
       http.callback {
         yield if block_given?
       }
@@ -52,9 +53,9 @@ class Scamp
     end
     
     def populate_channel_list
-      url = "https://37s.campfirenow.com/rooms.json"
+      url = "https://#{subdomain}.campfirenow.com/rooms.json"
       http = EventMachine::HttpRequest.new(url).get :head => {'authorization' => [api_key, 'X']}
-      http.errback { puts http.status }
+      http.errback { logger.error "Error populating the channel list: #{http.status.inspect}" }
       http.callback {
         new_channels = {}
         Yajl::Parser.parse(http.response)['rooms'].each do |c|
@@ -69,12 +70,12 @@ class Scamp
     end
 
     def fetch_channel_data(channel_id)
-      STDERR.puts "Fetching channel data for #{channel_id}"
-      url = "https://37s.campfirenow.com/room/#{channel_id}.json"
+      logger.debug "Fetching channel data for #{channel_id}"
+      url = "https://#{subdomain}.campfirenow.com/room/#{channel_id}.json"
       http = EventMachine::HttpRequest.new(url).get :head => {'authorization' => [api_key, 'X']}
-      http.errback { STDERR.puts "Couldn't get data for channel #{channel_id} at url #{url}" }
+      http.errback { logger.error "Couldn't get data for channel #{channel_id} at url #{url}" }
       http.callback {
-        puts "Fetched channel data for #{channel_id}"
+        logger.debug "Fetched channel data for #{channel_id}"
         room = Yajl::Parser.parse(http.response)['room']
         channel_cache[room["id"]] = room
         room['users'].each do |u|
@@ -83,19 +84,28 @@ class Scamp
       }
     end
     
+    def join_and_stream(id)
+      join(id) do
+        logger.info "Joined channel #{id} successfully"
+        fetch_channel_data(id)
+        stream(id)
+      end
+    end
+    
     def stream(channel_id)
       json_parser = Yajl::Parser.new :symbolize_keys => true
       json_parser.on_parse_complete = method(:process_message)
       
       url = "https://streaming.campfirenow.com/room/#{channel_id}/live.json"
       http = EventMachine::HttpRequest.new(url).get :head => {'authorization' => [api_key, 'X']}
-      http.errback { STDERR.puts "Couldn't stream channel #{channel_id} at url #{url}" }
+      http.errback { logger.error "Couldn't stream channel #{channel_id} at url #{url}" }
+      http.callback { logger.error "Disconnected from #{url}" }
       http.stream {|chunk| json_parser << chunk }
     end
 
     def channel_id_from_channel_name(channel_name)
-      puts "Looking for channel id for #{channel_name}"
+      logger.debug "Looking for channel id for #{channel_name}"
       channels[channel_name]["id"]
     end
   end
-end #class
+end

data/lib/scamp/connection.rb

@@ -7,15 +7,11 @@ class Scamp
         # Ideally populate_channel_list would block, but I can't see an easy way to do this, so a hacky callback it is.
         populate_channel_list do
           channels_to_join.map{|c| channel_id(c) }.each do |id|
-            puts "Joining channel #{id}"
-            join(id) do
-              fetch_channel_data(id)
-              stream(id)
-            end
+            join_and_stream(id)
           end
         end
       end
     end
       
-  end #module
-end #class
+  end
+end

data/lib/scamp/matcher.rb

@@ -31,7 +31,7 @@ class Scamp
       elsif trigger.is_a? Regexp
         return trigger.match message_text
       else
-        STDERR.puts "Don't know what to do with #{trigger.inspect} at #{__FILE__}:#{__LINE__}"
+        bot.logger.warn "Don't know what to do with #{trigger.inspect} at #{__FILE__}:#{__LINE__}"
       end
       false
     end
@@ -43,7 +43,8 @@ class Scamp
     end
     
     def conditions_satisfied_by(msg)
-      # STDERR.puts "Need to take into account nick, channel and regexps at #{__FILE__}:#{__LINE__}"
+      # bot.logger.warn "Need to take into account nick, channel and regexps at #{__FILE__}:#{__LINE__}"
+      bot.logger.info "Checking message against #{conditions.inspect}"
       
       # nick
       # channel name
@@ -55,10 +56,10 @@ class Scamp
       # item will be :nick or :channel
       # cond is the regex, int or string value.
       conditions.each do |item, cond|
-        STDERR.puts "Checking #{item} against #{cond}"
-        puts "msg is #{msg.inspect}"
+        bot.logger.debug "Checking #{item} against #{cond}"
+        bot.logger.debug "msg is #{msg.inspect}"
         if cond.is_a? Integer
-          # puts "item is #{msg[{:channel => :room_id, :user => :user_id}[item]]}"
+          # 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
         elsif cond.is_a? String
           case item
@@ -67,7 +68,7 @@ class Scamp
           when :user
             return false unless bot.username_for(msg[:user_id]) == cond
           end
-          STDERR.puts "Don't know how to deal with a match item of #{item}, cond #{cond}"
+          bot.logger.error "Don't know how to deal with a match item of #{item}, cond #{cond}"
         elsif cond.is_a? Regexp
           return false
           return false unless msg[item].match(cond)
@@ -76,4 +77,4 @@ class Scamp
       true
     end
   end
-end
+end

data/lib/scamp/users.rb

@@ -22,23 +22,20 @@ class Scamp
     private
     
     def fetch_data_for(user_id)
-      url = "https://37s.campfirenow.com/users/#{user_id}.json"
+      url = "https://#{subdomain}.campfirenow.com/users/#{user_id}.json"
       http = EventMachine::HttpRequest.new(url).get(:head => {'authorization' => [api_key, 'X'], "Content-Type" => "application/json"})
-      puts http.inspect
+      logger.debug http.inspect
       http.callback do
-        STDERR.puts "Got the data for #{user_id}"
+        logger.debug "Got the data for #{user_id}"
         update_user_cache_with(user_id, Yajl::Parser.parse(http.response)['user'])
       end
       http.errback do
-        STDERR.puts "Couldn't fetch user data for #{user_id} with url #{url}"
-        STDERR.puts http.response_header.status
-        STDERR.puts http.response_header.inspect
-        STDERR.puts http.response.inspect
+        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}"
       end
     end
     
     def update_user_cache_with(user_id, data)
-      STDERR.puts "Updated user cache for #{data['name']}"
+      logger.debug "Updated user cache for #{data['name']}"
       user_cache[user_id] = data
     end
   end

data/lib/scamp/version.rb

@@ -1,3 +1,3 @@
-module Scamp
-  VERSION = "0.0.1"
+class Scamp
+  VERSION = "0.0.2"
 end

data/lib/scamp.rb

@@ -1,6 +1,7 @@
 require 'eventmachine'
 require 'em-http-request'
 require 'yajl'
+require "logger"
 
 require "scamp/version"
 require 'scamp/connection'
@@ -13,15 +14,23 @@ class Scamp
   include Connection
   include Channels
   include Users
-  
-  attr_accessor :channels, :user_cache, :channel_cache
-  attr :matchers, :api_key
+
+  attr_accessor :channels, :user_cache, :channel_cache, :matchers, :api_key, :subdomain, :logger, :verbose, :first_match_only
 
   def initialize(options = {})
     options ||= {}
     raise ArgumentError, "You must pass an API key" unless options[:api_key]
-    
-    @api_key = options[:api_key]
+    raise ArgumentError, "You must pass a subdomain" unless options[:subdomain]
+
+    options.each do |k,v|
+      s = "#{k}="
+      if respond_to?(s)
+        send(s, v)
+      else
+        logger.warn "Scamp initialized with #{k.inspect} => #{v.inspect} but NO UNDERSTAND!"
+      end
+    end
+
     @channels = {}
     @user_cache = {}
     @channel_cache = {}
@@ -33,19 +42,43 @@ class Scamp
   end
   
   def connect!(channel_list)
+    logger.info "Starting up"
     connect(api_key, channel_list)
   end
   
+  def command_list
+    matchers.map{|m| [m.trigger, m.conditions] }
+  end
+
+  def logger
+    unless @logger
+      @logger = Logger.new(STDOUT)
+      @logger.level = (verbose ? Logger::DEBUG : Logger::INFO)
+    end
+    @logger
+  end
+
+  def verbose
+    @verbose = false if @verbose == nil
+    @verbose
+  end
+
+  def first_match_only
+    @first_match_only = false if @first_match_only == nil
+    @first_match_only
+  end
+
   private
-  
+
   def match trigger, params={}, &block
     params ||= {}
     matchers << Matcher.new(self, {:trigger => trigger, :action => block, :conditions => params[:conditions]})
   end
   
   def process_message(msg)
+    logger.debug "Received message #{msg.inspect}"
     matchers.each do |matcher|
-      matcher.attempt(msg)
+      break if first_match_only & matcher.attempt(msg)
     end
   end
 end

data/scamp.gemspec

@@ -19,4 +19,6 @@ Gem::Specification.new do |s|
   s.add_dependency('eventmachine', '~> 0.12.10')
   s.add_dependency('yajl-ruby', '~> 0.8.3')
   s.add_dependency('em-http-request', '~> 0.3.0')
+
+  s.add_development_dependency "rspec", "~> 2.6.0"
 end

data/spec/lib/scamp_spec.rb

@@ -0,0 +1,112 @@
+require "spec_helper"
+
+describe Scamp do
+  before do
+    @valid_params = {:api_key => "6124d98749365e3db2c9e5b27ca04db6", :subdomain => "oxygen"}
+  end
+
+  describe "#initialize" do
+    it "should work with valid params" do
+      a(Scamp).should be_a(Scamp)
+    end
+    it "should warn if given an option it doesn't know" do
+      mock_logger
+
+      a(Scamp, :fred => "estaire").should be_a(Scamp)
+
+      logger_output.should =~ /WARN.*Scamp initialized with :fred => "estaire" but NO UNDERSTAND!/
+    end
+  end
+
+  describe "#verbose" do
+    it "should default to false" do
+      a(Scamp).verbose.should be_false
+    end
+    it "should be overridable at initialization" do
+      a(Scamp, :verbose => true).verbose.should be_true
+    end
+  end
+
+  describe "#logger" do
+    context "default logger" do
+      before { @bot = a Scamp }
+      it { @bot.logger.should be_a(Logger) }
+      it { @bot.logger.level.should be == Logger::INFO }
+    end
+    context "default logger in verbose mode" do
+      before { @bot = a Scamp, :verbose => true }
+      it { @bot.logger.level.should be == Logger::DEBUG }
+    end
+    context "overriding default" do
+      before do
+        @custom_logger = Logger.new("/dev/null")
+        @bot = a Scamp, :logger => @custom_logger
+      end
+      it { @bot.logger.should be == @custom_logger }
+    end
+  end
+
+  describe "#first_match_only" do
+    it "should default to false" do
+      a(Scamp).first_match_only.should be_false
+    end
+    it "should be settable" do
+      a(Scamp, :first_match_only => true).first_match_only.should be_true
+    end
+  end
+
+  describe "private methods" do
+
+    describe "#process_message" do
+      before do
+        @bot = a Scamp
+        $attempts = 0 # Yes, I hate it too. Works though.
+        @message = {:body => "my message here"}
+
+        @bot.behaviour do
+          2.times { match(/.*/) { $attempts += 1 } }
+        end
+      end
+      after { $attempts = nil }
+      context "with first_match_only not set" do
+        before { @bot.first_match_only.should be_false }
+        it "should process all matchers which attempt the message" do
+          @bot.send(:process_message, @message)
+          $attempts.should be == 2
+        end
+      end
+      context "with first_match_only set" do
+        before do
+          @bot.first_match_only = true
+          @bot.first_match_only.should be_true
+        end
+        it "should only process the first matcher which attempts the message" do
+          @bot.send(:process_message, @message)
+          $attempts.should be == 1
+        end
+      end
+    end
+
+
+  end
+
+  def a klass, params={}
+    params ||= {}
+    params = @valid_params.merge(params) if klass == Scamp
+    klass.new(params)
+  end
+
+  # Urg
+  def mock_logger
+    @logger_string = StringIO.new
+    @fake_logger = Logger.new(@logger_string)
+    Scamp.any_instance.should_receive(:logger).and_return(@fake_logger)
+  end
+
+  # Bleurgh
+  def logger_output
+    str = @logger_string.dup
+    str.rewind
+    str.read
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require File.expand_path("../lib/scamp", File.dirname(__FILE__))

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: scamp
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,12 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-09-12 00:00:00.000000000 +01:00
-default_executable: 
+date: 2011-09-17 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: eventmachine
-  requirement: &2165823060 !ruby/object:Gem::Requirement
+  requirement: &70244078916620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -22,10 +21,10 @@ dependencies:
         version: 0.12.10
   type: :runtime
   prerelease: false
-  version_requirements: *2165823060
+  version_requirements: *70244078916620
 - !ruby/object:Gem::Dependency
   name: yajl-ruby
-  requirement: &2165822560 !ruby/object:Gem::Requirement
+  requirement: &70244078916120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -33,10 +32,10 @@ dependencies:
         version: 0.8.3
   type: :runtime
   prerelease: false
-  version_requirements: *2165822560
+  version_requirements: *70244078916120
 - !ruby/object:Gem::Dependency
   name: em-http-request
-  requirement: &2165822100 !ruby/object:Gem::Requirement
+  requirement: &70244078915660 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -44,7 +43,18 @@ dependencies:
         version: 0.3.0
   type: :runtime
   prerelease: false
-  version_requirements: *2165822100
+  version_requirements: *70244078915660
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70244078915200 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.6.0
+  type: :development
+  prerelease: false
+  version_requirements: *70244078915200
 description: Eventmachine based Campfire bot framework
 email:
 - will@willj.net
@@ -53,6 +63,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .rspec
 - Gemfile
 - README.md
 - Rakefile
@@ -65,7 +76,8 @@ files:
 - lib/scamp/users.rb
 - lib/scamp/version.rb
 - scamp.gemspec
-has_rdoc: true
+- spec/lib/scamp_spec.rb
+- spec/spec_helper.rb
 homepage: ''
 licenses: []
 post_install_message: 
@@ -86,8 +98,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.6.2
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Eventmachine based Campfire bot framework
-test_files: []
+test_files:
+- spec/lib/scamp_spec.rb
+- spec/spec_helper.rb