botfly 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,22 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+log
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Ryan Neufeld
+
+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.rdoc

@@ -0,0 +1,17 @@
+= botfly
+
+Description goes here.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Ryan Neufeld. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,46 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "botfly"
+    gem.summary = %Q{A quick and easy DSL for generating Jabber bots}
+    gem.description = %Q{Botfly is a Jabber Bot framework that lets you write Jabber bots in a modern DSL that just makes sense. Enjoy, while it's still fresh and VERY ALPHA.}
+    gem.email = "ryan@ryanneufeld.ca"
+    gem.homepage = "http://github.com/rkneufeld/botfly"
+    gem.authors = ["Ryan Neufeld"]
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    gem.add_dependency "xmpp4r", ">= 0.5"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "botfly #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/botfly.gemspec

@@ -0,0 +1,69 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{botfly}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Ryan Neufeld"]
+  s.date = %q{2010-03-13}
+  s.description = %q{Botfly is a Jabber Bot framework that lets you write Jabber bots in a modern DSL that just makes sense. Enjoy, while it's still fresh and VERY ALPHA.}
+  s.email = %q{ryan@ryanneufeld.ca}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "botfly.gemspec",
+     "example.rb",
+     "lib/botfly.rb",
+     "lib/botfly/bot.rb",
+     "lib/botfly/matcher.rb",
+     "lib/botfly/matcher/body_matcher.rb",
+     "lib/botfly/matcher/matcher.rb",
+     "lib/botfly/matcher/nick_matcher.rb",
+     "lib/botfly/matcher/subject_matcher.rb",
+     "lib/botfly/responder.rb",
+     "lib/botfly/responder/message_responder.rb",
+     "lib/botfly/responder/presence_responder.rb",
+     "lib/botfly/responder/responder.rb",
+     "spec/botfly_spec.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/rkneufeld/botfly}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{A quick and easy DSL for generating Jabber bots}
+  s.test_files = [
+    "spec/botfly_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_runtime_dependency(%q<xmpp4r>, [">= 0.5"])
+    else
+      s.add_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_dependency(%q<xmpp4r>, [">= 0.5"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 1.2.9"])
+    s.add_dependency(%q<xmpp4r>, [">= 0.5"])
+  end
+end
+

data/example.rb

@@ -0,0 +1,24 @@
+require 'rubygems'
+require 'botfly'
+
+require 'yaml'
+
+config = YAML::load(ARGF.read) if ARGF
+puts config.inspect
+
+Jabber::debug = true
+
+bot = Botfly.login(config["jid"],config["pass"]) do
+  on(:message).body(/^exit$/) { reply "Goodbye!"; quit }
+  on(:message).nick(/rkneufeld/) do
+    Botfly.logger.info("Callback called")
+    @count ||= 0
+    @count += 1
+    reply("That's the #{@count}th message I've received.")
+  end
+
+  on(:presence) { puts self }
+  connect
+end
+Thread.stop
+loop{}

data/lib/botfly.rb

@@ -0,0 +1,24 @@
+require 'rubygems'
+
+require 'xmpp4r'
+require 'xmpp4r/muc'
+
+require 'botfly/responder'
+require 'botfly/bot'
+require 'botfly/matcher'
+
+require 'logger'
+
+module Botfly
+  def Botfly.logger
+    @logger = Logger.new(@logfile)
+    return @logger
+  end
+  def Botfly.login(jid,pass,logfile=STDOUT,&block)
+    @logfile = logfile
+    Botfly.logger.info("BOTFLY: #login")
+    bot = Botfly::Bot.new(jid,pass)
+    bot.instance_eval(&block)
+    return bot # At this point doesn't get returned, as the thread is stopped
+  end
+end

data/lib/botfly/bot.rb

@@ -0,0 +1,73 @@
+require 'rubygems'
+
+module Botfly
+  class Bot
+    attr_reader :responders, :client
+    def initialize(jid,pass)
+      Botfly.logger.info("  BOT: Bot#new")
+      @password = pass
+      @jid = Jabber::JID.new(jid)
+      @client = Jabber::Client.new(@jid)
+      @responders = {}
+      @main_thread = Thread.current
+    end
+    
+    def connect
+      Botfly.logger.info("  BOT: Connecting to #{@jid}...")
+      @client.connect
+      @client.auth(@password)
+      Botfly.logger.info("  BOT: Connected")
+      register_for_xmpp_callbacks
+      @client.send(Jabber::Presence.new.set_status("Carrier has arrived"))
+      #Thread.stop
+    end
+    
+    def on(type, &block)
+      Botfly.logger.info("  BOT: Bot#on")
+      klass = Botfly.const_get(type.to_s.capitalize + "Responder")
+      (@responders[type] ||= []) << responder = klass.new(@client, self, &block)
+      Botfly.logger.info("  BOT: #{type.to_s.capitalize}Responder added to responder chain")
+      return responder
+    end
+      
+    def quit
+      @client.close
+      @main_thread.continue
+    end
+      
+  private
+
+    def register_for_xmpp_callbacks
+      Botfly.logger.info("  BOT: Registering for callbacks with client")
+#     @client.add_update_callback {|presence| respond_to(:update, :presence => presence) }
+#     @client.add_subscription_request_callback {|item, pres| } # requires Roster helper
+      @client.add_message_callback do |message| 
+        Botfly.logger.debug("    CB: Got Message") 
+        respond_to(:message, :message => message)
+      end
+      @client.add_presence_callback do |old_presence,new_presence| 
+        Botfly.logger.debug("    CB: Got Presence")
+        respond_to(:presence, :old => old_presence, :new => new_presence)
+      end
+
+    end
+    
+    def respond_to(callback_type, params)
+      Botfly.logger.info("  BOT: Responding to callback of type: #{callback_type}")
+      responders = params[:muc] ? @muc_responders[params[:muc]] : @responders
+      responders[callback_type].each {|r| r.callback_with params} if responders[callback_type]
+    end
+    
+#    def register_for_muc_callbacks(client)
+#      params = {:muc => client}
+##      client.on_join {|time,nick| respond_to(:join, params.merge!(:time=>time,:nick=>nick))}
+#      client.on_leave {|time,nick| respond_to(:leave, params.merge!(:time=>time,:nick=>nick))}
+#      client.on_message {|time,nick,text| respond_to(:message, params.merge!(:time=>time,:nick=>nick,:text=>text))}
+#      client.on_private_message {|time,nick,text| respond_to(:private_message,    params.merge!(:time=>time,:nick=>nick,:text=>text))}
+#      client.on_room_message {|time,text| respond_to(:room_message, params.merge!(:time => time, :text => text))}
+#      client.on_self_leave {|time| respond_to(:self_leave, params.merge!(:time => time)) }
+#      client.on_subject {|time,nick,subject| respond_to(:subject, params.merge!(:time => time, :nick => nickname, :subject => subject))}
+#    end    
+        
+  end
+end

data/lib/botfly/matcher.rb

@@ -0,0 +1,5 @@
+require 'botfly/matcher/matcher'
+# TODO: Scope the matchers by responder
+require 'botfly/matcher/nick_matcher'
+require 'botfly/matcher/body_matcher'
+require 'botfly/matcher/subject_matcher'

data/lib/botfly/matcher/body_matcher.rb

@@ -0,0 +1,13 @@
+require 'botfly/matcher'
+
+# Msg: body, chat_state, subject, type (:chat, :error, :groupchat, :headline, :normal)
+module Botfly
+  class BodyMatcher < Matcher
+    def match(params)
+      msg = params[:message]
+      Botfly.logger.debug "      MCH: Matching #{@condition.inspect} against #{msg.body.inspect}"
+      Botfly.logger.debug "        RESULT: #{(msg.body =~ @condition).inspect}"
+      return msg.body =~ @condition
+    end
+  end
+end

data/lib/botfly/matcher/matcher.rb

@@ -0,0 +1,11 @@
+module Botfly
+  class Matcher
+    def initialize(condition)
+      Botfly.logger.info("      MCH: Creating Matcher")
+      @condition = condition
+    end
+    def match(params)
+      raise "AbstractMethodError: You must implement match in a concrete subclass"
+    end
+  end
+end

data/lib/botfly/matcher/nick_matcher.rb

@@ -0,0 +1,13 @@
+require 'botfly/matcher'
+
+# Msg: body, chat_state, subject, type (:chat, :error, :groupchat, :headline, :normal)
+module Botfly
+  class NickMatcher < Matcher
+    def match(params)
+      msg = params[:message]
+      Botfly.logger.debug "      MCH: Matching #{@condition.inspect} against #{msg.from.inspect}"
+      Botfly.logger.debug "        RESULT: #{(msg.from.node =~ @condition).inspect}"
+      return msg.from.node =~ @condition
+    end
+  end
+end

data/lib/botfly/matcher/subject_matcher.rb

@@ -0,0 +1,13 @@
+require 'botfly/matcher'
+
+# Msg: body, chat_state, subject, type (:chat, :error, :groupchat, :headline, :normal), from, to
+module Botfly
+  class SubjectMatcher < Matcher
+    def match(params)
+      msg = params[:message]
+      Botfly.logger.debug "      MCH: Matching #{@condition.inspect} against #{msg.subject.inspect}"
+      Botfly.logger.debug "        RESULT: #{(msg.subject =~ @condition).inspect}"
+      return msg.subject.node =~ @condition
+    end
+  end
+end

data/lib/botfly/responder.rb

@@ -0,0 +1,3 @@
+require 'botfly/responder/responder'
+require 'botfly/responder/message_responder'
+require 'botfly/responder/presence_responder'

data/lib/botfly/responder/message_responder.rb

@@ -0,0 +1,23 @@
+require 'forwardable'
+module Botfly
+  class MessageResponder < Responder    
+    extend Forwardable
+    def setup_instance_variables(params)
+      Botfly.logger.debug("    RSP: MessageResponder setting up instance variables")
+      @message = params[:message]
+      @body = @message.body
+      @chat_state = @message.chat_state
+      @subject = @message.subject
+      @type = @message.type
+      @from = @message.from
+      @to = @message.to
+    end
+    
+    def reply(text)
+      Botfly.logger.debug("    RSP: MessageResponder#reply called")
+      msg = Jabber::Message.new(@from, text)
+      msg.type = :chat
+      @client.send(msg)
+    end
+  end
+end

data/lib/botfly/responder/presence_responder.rb

@@ -0,0 +1,7 @@
+module Botfly
+  class PresenceResponder < Responder
+    def setup_instance_variables(params)
+      Botfly.logger.debug("    RSP: #{self.class} setting up instance variables")
+    end
+  end
+end

data/lib/botfly/responder/responder.rb

@@ -0,0 +1,59 @@
+module Botfly
+  class Responder
+    attr_reader :callback, :callback_type
+    
+    def initialize(client,bot,&block)
+      Botfly.logger.info("    RSP: #{self.class.to_s}#new")
+      @matcher_chain = []
+      @bot = bot
+      @client = client
+      @callback = block if block_given?
+    end
+    
+    def method_missing(method,condition,&block)
+      Botfly.logger.info("    RSP: Responder##{method}(#{condition.inspect})")
+      
+      add_matcher(method,condition)
+      
+      if block_given?
+        Botfly.logger.info("    RSP: Callback recorded: #{block.inspect}")
+        @callback = block 
+      end
+      
+      return self
+    end
+    
+    def callback_with(params)
+      Botfly.logger.debug("    RSP: Launching callback with params: #{params.inspect}")
+
+      setup_instance_variables(params)
+      if @matcher_chain.all? {|matcher| matcher.match(params) }
+        Botfly.logger.debug("      RSP: All matchers passed")
+        cb = @callback # Ruby makes it difficult to apply & to an instance variable
+        instance_eval &cb
+      end
+    end
+
+    def quit
+      @bot.quit
+    end
+    # TODO: add other @client actions as delegates    
+
+  private
+    def add_matcher(method, condition)
+      klass = Botfly.const_get(method.to_s.capitalize + "Matcher")
+      @matcher_chain << klass.new(condition)
+      
+      Botfly.logger.debug("    RSP: Adding to matcher chain: #{@matcher_chain.inspect}")
+    end
+    
+    # TODO: Check callback is in acceptable list - MUC subclass can override this list
+    def register_with_bot(callback_type)
+      raise "AbstractMethodError: You must implement this method in a concrete subclass"
+    end      
+
+    def setup_instance_variables(params)
+      raise "AbstractMethodError: You must implement this method in a concrete subclass"
+    end
+  end
+end

data/spec/botfly_spec.rb

@@ -0,0 +1,7 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "Botfly" do
+  it "fails" do
+    fail "hey buddy, you should probably rename this file and start specing for real"
+  end
+end

data/spec/spec.opts

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

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'botfly'
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|
+  
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification 
+name: botfly
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Ryan Neufeld
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-03-13 00:00:00 -06:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.9
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: xmpp4r
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0.5"
+    version: 
+description: Botfly is a Jabber Bot framework that lets you write Jabber bots in a modern DSL that just makes sense. Enjoy, while it's still fresh and VERY ALPHA.
+email: ryan@ryanneufeld.ca
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- botfly.gemspec
+- example.rb
+- lib/botfly.rb
+- lib/botfly/bot.rb
+- lib/botfly/matcher.rb
+- lib/botfly/matcher/body_matcher.rb
+- lib/botfly/matcher/matcher.rb
+- lib/botfly/matcher/nick_matcher.rb
+- lib/botfly/matcher/subject_matcher.rb
+- lib/botfly/responder.rb
+- lib/botfly/responder/message_responder.rb
+- lib/botfly/responder/presence_responder.rb
+- lib/botfly/responder/responder.rb
+- spec/botfly_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/rkneufeld/botfly
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: A quick and easy DSL for generating Jabber bots
+test_files: 
+- spec/botfly_spec.rb
+- spec/spec_helper.rb