Sutto-marvin 0.2.2 → 0.2.3

data/TUTORIAL.textile

@@ -0,0 +1,54 @@
+h1. A Quick Introduction to Marvin
+
+Welcome young one - in today's lesson we're going to learn
+how to build a simple IRC bot using "Marvin":http://github.com/Sutto/marvin.
+If you haven't built an IRC bot before, there is a great
+deal of things you can do - ranging from consuming content (e.g.
+analysing logs of IRC rooms, seeing who swears the most)
+as well as other things such as bridges between other
+protocols (twitter => irc bridges) and all sorts of fancy stuff.
+
+h3. What is this marvin thingy-majiggy?
+
+Marvin is an IRC Library / Framework (it can be used either way)
+built with an evented design on top of DRb, EventMachine and a bunch
+of other stuff for Ruby. it's currently got a fairly complete client
+and a very incomplete server implementation.
+
+h2. Step #1 - Getting Marvin
+
+There are currently two different ways to get marvin - via the
+GitHub gem sources or directly from the source.
+
+To install from the GitHub gem source, simply use:
+
+  sudo gem install Sutto-marvin -s http://gems.github.com
+  
+Alternatively, you can directly clone the repository. To do this, you'll need to run the
+following:
+
+  git clone git://github.com/Sutto/marvin.git
+  cd marvin
+  sudo ./script/install
+  
+Once that's done, not only will you now have a handy "marvin" gem which you
+can require but you will also have a handy executable of the same name which
+you can use.
+
+h2. Step #2 - Creating a Skeleton App
+
+By default, marvin currently uses a simple skeleton app (not unlike
+Ruby on Rails) as a starting point. To get started, you simply use
+the "marvin create" command with a path to / folder name (which must not
+yet exist) into which you wish to create the folder. For example, if I wanted
+to create a new irc bot called "BlorkBot", I could do the following:
+
+  marvin create BlorkBot
+  
+And a new directory with the basic structure called "BlorkBot" will be created
+under the current directory. To get started, you can then open your editor and
+browse the given folder. Of this generated structure, there are only two folders
+you need to worry about for the moment - config and handlers.
+
+h2. Step #3 - Basic configuration
+  

data/VERSION.yml

@@ -1,4 +1,4 @@
 --- 
-patch: 2
+patch: 3
 major: 0
 minor: 2

data/bin/marvin

@@ -32,6 +32,7 @@ class Marvin < Thor
       mkdir   source(@dest, "lib")
       say " => Copying files..."
       copy "config/setup.rb"
+      copy "config/boot.rb"
       copy "config/connections.yml.sample", "config/connections.yml"
       copy "config/settings.yml.sample",    "config/settings.yml"
       copy "handlers/hello_world.rb"
@@ -67,6 +68,13 @@ class Marvin < Thor
     start_script(:client)
   end
   
+  desc "server [PATH]", "starts a server instance from the given location"
+  method_options :verbose => :boolean, :daemon => :boolean, :level => :optional, :kill => :boolean
+  def server(path = ".")
+    @dest = File.expand_path(path)
+    start_script(:server)
+  end
+  
   desc "ring_server [PATH]", "starts a ring server from the given location"
   method_options :verbose => :boolean, :daemon => :boolean, :level => :optional, :kill => :boolean
   def ring_server(path = ".")

data/config/boot.rb

@@ -0,0 +1,14 @@
+# Load Marvin, do any initialization etc.
+# Note: this is called from inside scripts
+# or anywhere you want to start a base marvin
+# instance.
+
+require 'rubygems'
+
+MARVIN_ROOT = File.expand_path(File.join(File.dirname(__FILE__), ".."))
+
+# Check if a local copy of marvin exists, and set the load path if it does.
+$:.unshift(File.dirname(__FILE__) + "/../lib/") if File.exist?(File.dirname(__FILE__) + "/../lib/marvin.rb")
+
+# And Require Marvin.
+require 'marvin'

data/lib/marvin/command_handler.rb

@@ -41,7 +41,7 @@ module Marvin
       unless command_name.nil?
         logger.debug "Command Exists - processing"
         # Dispatch the command.
-        self.send(command_name, data.split(" ")) if self.respond_to?(command_name)
+        self.send(command_name, data.to_s.split(" ")) if self.respond_to?(command_name)
       end
     end
     

data/lib/marvin/distributed/dispatch_handler.rb

@@ -55,6 +55,7 @@ module Marvin
               logger.warn "Dispatch handler queue is currently holding #{size} items"
             end
           else
+            logger.debug "Writing #{@queued_messages.size} message to the ring server"
             @queued_messages.dup.each do |t|
               ring_server.write(t)
               @queued_messages.delete(t)

data/lib/marvin/irc/server.rb

@@ -7,33 +7,46 @@ module Marvin
       
       # Store each user
       UserStore = NamedStore.new(:nicks, :user) do
+        
+        def virtual?(nick)
+          self[nick].is_a?(Marvin::IRC::Server::VirtualUserConnection)
+        end
+        
+        def reclaim(nick)
+          if has_key?(nick) && virtual?(nick)
+            self[nick].reclaim!
+          end
+        end
+        
+        # Nick is not taken when 
         def nick_taken?(nick)
-          has_key?(nick)
+          has_key?(nick) && !virtual(nick)
         end
         
         def each_user_except(user)
-          self.each_user do |u|
-            yield u unless user == u 
-          end
+          self.each_user { |u| yield u unless user == u }
         end
       end
       
       # Store each channel
       ChannelStore = NamedStore.new(:names, :channel)
       
-      autoload :Channel,            'marvin/irc/server/channel'
+      autoload :RemoteInterface,       'marvin/irc/server/remote_interface'
+      autoload :Channel,               'marvin/irc/server/channel'
       # The actual network connection
-      autoload :BaseConnection,     'marvin/irc/server/base_connection'
+      autoload :BaseConnection,        'marvin/irc/server/base_connection'
       # An our implementations of protocol-specific stuff.
-      autoload :AbstractConnection, 'marvin/irc/server/abstract_connection'
-      autoload :UserConnection,     'marvin/irc/server/user_connection'
-      autoload :ServerConnection,   'marvin/irc/server/server_connection'
+      autoload :VirtualUserConnection, 'marvin/irc/server/virtual_user_connection'
+      autoload :AbstractConnection,    'marvin/irc/server/abstract_connection'
+      autoload :UserConnection,        'marvin/irc/server/user_connection'
+      autoload :ServerConnection,      'marvin/irc/server/server_connection'
       # Extensions for each part
-      autoload :User,               'marvin/irc/server/user'
+      autoload :User,                  'marvin/irc/server/user'
       
       # call start_server w/ the default options
       # and inside an EM::run block.
       def self.run
+        Marvin::IRC::Server::RemoteInterface.start
         EventMachine::run do
           Marvin::Logger.info "Starting server..."
           start_server :bind_addr => "0.0.0.0"
@@ -46,6 +59,7 @@ module Marvin
         opts[:host]       ||= self.host_name
         opts[:port]       ||= 6667
         EventMachine::start_server(opts[:bind_addr] || opts[:host], opts[:port], BaseConnection, opts)
+        Marvin::Logger.info "Server started"
       end
       
       def self.host_name

data/lib/marvin/irc/server/abstract_connection.rb

@@ -55,6 +55,11 @@ module Marvin::IRC::Server
       
     end
     
+    def dispatch(name, opts = {})
+      opts[:connection] ||= self
+      super
+    end
+    
     private
     
     def command(name, *args)

data/lib/marvin/irc/server/channel.rb

@@ -69,9 +69,13 @@ module Marvin::IRC::Server
       check_emptyness!
     end
     
-    def message(user, message)
-      @members.each { |m| m.notify :privmsg, @name, ":#{message}", :prefix => user.prefix unless user == m }
-      dispatch :outgoing_message, :target => self, :user => user, :message => message
+    def message(user, message, virtual = false)
+      @members.each do |m|
+        if virtual || user != m
+          m.notify(:privmsg, @name, ":#{message}", :prefix => user.prefix, :virtual => virtual)
+        end
+      end
+      dispatch :outgoing_message, :target => self, :user => user, :message => message, :virtual => virtual
     end
     
     def notice(user, message)

data/lib/marvin/irc/server/remote_interface.rb

@@ -0,0 +1,59 @@
+require 'drb'
+require 'rinda/ring'
+module Marvin
+  module IRC
+    module Server
+      
+      # Make sure that a proxy object is used vs. the real thing.
+      [Channel, AbstractConnection, User, NamedStore].each do |c|
+        c.class_eval { include DRbUndumped }
+      end
+      
+      # A DRb interface to post / receive messages from the
+      # a running server instance. Used for things such as
+      # posting status updated directly on the server.
+      class RemoteInterface
+        include DRbUndumped
+        
+        def self.start
+          DRb.start_service
+          instance = self.new # Create the new instance
+          begin
+            rs = Rinda::RingFinger.primary
+            renewer = Rinda::SimpleRenewer.new
+            tuple   = [:marvin_server, Marvin::Settings.distributed_namespace, instance]
+            Marvin::Logger.info "Publishing information about service to the tuplespace"
+            Marvin::Logger.debug "Pushing #{tuple.inspect} to #{rs.__drburi}"
+            rs.write(tuple, renewer)
+          rescue
+            Marvin::Logger.warn "No ring server found - remote interface not running"
+          end
+        end
+        
+        # Returns an array of all channels
+        def channels
+          Marvin::IRC::Server::ChannelStore.values
+        end
+        
+        # Returns the names of all channels
+        def channel_names
+          Marvin::IRC::Server::ChannelStore.keys
+        end
+        
+        # Returns the channel with the given name.
+        def channel(name)
+          Marvin::IRC::Server::ChannelStore[name]
+        end
+        
+        # Send an action from a user to a specific
+        # channel, using from nick as a facade.
+        def message(from_nick, target, contents)
+          u = (Marvin::IRC::Server::UserStore[from_nick.to_s.downcase] ||= VirtualUserConnection.new(from_nick))
+          Marvin::Logger.info "#{from_nick} (#{u.inspect}) messaging #{target}: #{contents}"
+          u.send_message(target, contents) unless u.blank?
+        end
+        
+      end
+    end
+  end
+end

data/lib/marvin/irc/server/user/handle_mixin.rb

@@ -15,11 +15,13 @@ module Marvin::IRC::Server::User::HandleMixin
     nick = opts[:new_nick]
     if !nick.blank? && !Marvin::IRC::Server::UserStore.nick_taken?(nick.downcase)
       if !(new_nick = @nick.nil?)
+        logger.info "Reclaiming nick (if taken)"
+        Marvin::IRC::Server::UserStore.reclaim(nick)
         logger.debug "Notifying all users of nick change: #{@nick} => #{nick}"
         # Get all users and let them now we've changed nick from @nick to nick
         users = [self]
         @channels.each do |c|
-          users += c.members.values
+          users += c.members
         end
         users.uniq.each { |u| u.notify :NICK, nick, :prefix => prefix }
         dispatch :outgoing_nick, :nick => @nick, :new_nick => nick
@@ -62,7 +64,7 @@ module Marvin::IRC::Server::User::HandleMixin
       end
       chan = (Marvin::IRC::Server::ChannelStore[channel.downcase] ||= Marvin::IRC::Server::Channel.new(channel))
       if chan.join(self)
-        rpl :TOPIC, channel, ":#{chan.topic.blank? ? "There is no topic" :  nchan.topic}"
+        rpl :TOPIC, channel, ":#{chan.topic.blank? ? "There is no topic" :  chan.topic}"
         rpl :NAMREPLY, "=", channel, ":#{chan.members.map { |m| m.nick }.join(" ")}"
         rpl :ENDOFNAMES, channel, ":End of /NAMES list."
         @channels << chan
@@ -123,7 +125,7 @@ module Marvin::IRC::Server::User::HandleMixin
     return if c.blank?
     if !@channels.include?(c)
       err :NOTONCHANNEL, opts[:target], ":Not a member of that channel"
-    elsif opts[:message].nil?
+    elsif opts[:topic].blank?
       t = c.topic
       if t.blank?
         rpl :NOTOPIC, c.name, ":No topic is set"
@@ -131,7 +133,7 @@ module Marvin::IRC::Server::User::HandleMixin
         rpl :TOPIC, c.name, ":#{t}"
       end
     else
-      c.topic self, opts[:message].strip
+      c.topic self, opts[:topic].strip
     end
   end
   

data/lib/marvin/irc/server/user_connection.rb

@@ -3,6 +3,7 @@ module Marvin::IRC::Server
     USER_MODES    = "aAbBcCdDeEfFGhHiIjkKlLmMnNopPQrRsStUvVwWxXyYzZ0123459*@"
     CHANNEL_MODES = "bcdefFhiIklmnoPqstv"
     CHANNEL       = /^[\&\#]+/
+    
     include User::HandleMixin
     
     attr_accessor :nick, :host, :user, :prefix, :password, :mode,
@@ -29,9 +30,15 @@ module Marvin::IRC::Server
     
     # Notification messages
     
-    def message(user, message)
-      notify :PRIVMSG, @nick, ":#{message}", :prefix => user.prefix
-      dispatch :outgoing_message, :user => user, :message => message, :target => self
+    def send_message(target, message)
+      t = target_from(target)
+      logger.debug "Sending #{t.inspect} #{message.inspect} from #{self.inspect}"
+      t.message(self, message) unless t.blank?
+    end
+    
+    def message(user, message, virtual = false)
+      notify :PRIVMSG, @nick, ":#{message}", :prefix => user.prefix, :virtual => virtual
+      dispatch :outgoing_message, :user => user, :message => message, :target => self, :virtual => virtual
     end
     
     def notice(user, message)
@@ -93,7 +100,7 @@ module Marvin::IRC::Server
     end
     
     def update_prefix!
-      @prefix = "#{@nick}!~#{@user}@#{peer_name}" if details_complete?
+      @prefix = "#{@nick}!n=#{@user}@#{peer_name}" if details_complete?
     end
     
     def details_complete?

data/lib/marvin/irc/server/virtual_user_connection.rb

@@ -0,0 +1,80 @@
+module Marvin::IRC::Server
+  class VirtualUserConnection
+    include Marvin::Dispatchable
+    
+    CHANNEL = /^[\&\#]+/
+    
+    attr_accessor :nick, :channels
+    
+    def initialize(nick)
+      self.nick     = nick
+      self.channels = []
+    end
+    
+    def prefix
+      "#{@nick}!n=rruser@relayrelay.com"
+    end
+    
+    def notify(*args)
+      Marvin::Logger.debug "Virtual User #{self.nick} got notify w/ #{args.inspect}"
+    end
+    
+    # Notify the remote handler we've received a message
+    def message(user, message, virtual = false)
+      dispatch :received_message, :user => user, :message => message, :target => self unless virtual
+    end
+    
+    def send_message(target, message)
+      t = target_from(target)
+      Marvin::Logger.debug "DRb Message from #{self.nick} to #{t.inspect}: #{message.inspect}"
+      if t.blank?
+        Marvin::Logger.debug "Target not found"
+        return nil
+      else
+        Marvin::Logger.debug "Sending message to #{t.inspect}"
+        return t.message(self, message, true)
+      end
+    end
+    
+    def reclaim!
+      self.channels.each { |c| c.part(self, "Reclaiming nick for virtual user...") }
+      Marvin::IRC::Server::UserStore.delete(self.nick.downcase)
+    end
+    
+    def join(channel)
+      return nil if channel !~ CHANNEL
+      chan = (Marvin::IRC::Server::ChannelStore[channel.downcase] ||= Marvin::IRC::Server::Channel.new(channel))
+      if chan.join(self)
+        @channels << channel
+        return chan
+      end
+    end
+    
+    class << self
+      
+      def claimed?(nick)
+        Marvin::IRC::Server::UserStore.virtual?(nick)
+      end
+      
+      def claim(nick)
+        unless Marvin::IRC::Server::UserStore[nick.downcase].blank?
+          return(Marvin::IRC::Server::UserStore[nick.downcase] ||= Marvin::IRC::Server::VirtualUserConnection.new(nick))
+        end
+      end
+      
+    end
+    
+    private
+    
+    def target_from(target)
+      if target =~ CHANNEL
+        c = Marvin::IRC::Server::ChannelStore[target.downcase]
+        c = join(target) if c.nil? || !c.member?(self)
+        return c
+      else
+        return Marvin::IRC::Server::UserStore[target.downcase] ||= Marvin::IRC::Server::VirtualUserConnection.new(target)
+      end
+    end
+    
+  end
+end

data/script/client

@@ -1,9 +1,3 @@
 #!/usr/bin/env ruby
-require 'rubygems'
-
-$:.unshift(File.dirname(__FILE__) + "/../lib/") if File.exist?(File.dirname(__FILE__) + "/../lib/marvin.rb")
-MARVIN_ROOT = File.join(File.dirname(__FILE__), "..")
-
-# And Require Marvin.
-require 'marvin'
+require File.join(File.dirname(__FILE__), "..", "config", "boot")
 Marvin::Loader.run! :client

data/script/distributed_client

@@ -1,9 +1,3 @@
 #!/usr/bin/env ruby
-require 'rubygems'
-
-$:.unshift(File.dirname(__FILE__) + "/../lib/") if File.exist?(File.dirname(__FILE__) + "/../lib/marvin.rb")
-MARVIN_ROOT = File.join(File.dirname(__FILE__), "..")
-
-# And Require Marvin.
-require 'marvin'
+require File.join(File.dirname(__FILE__), "..", "config", "boot")
 Marvin::Loader.run! :distributed_client

data/script/install

@@ -1,3 +1 @@
-gem uninstall marvin --quiet
-gem build marvin.gemspec
-gem install marvin-0.1.*.gem
+gem uninstall marvin --quiet && rake gemspec  && gem build marvin.gemspec && gem install marvin-*.gem

data/script/ring_server

@@ -1,12 +1,4 @@
 #!/usr/bin/env ruby
-require 'rubygems'
-#!/usr/bin/env ruby
-require 'rubygems'
-
-$:.unshift(File.dirname(__FILE__) + "/../lib/") if File.exist?(File.dirname(__FILE__) + "/../lib/marvin.rb")
-MARVIN_ROOT = File.join(File.dirname(__FILE__), "..")
-
-# And Require Marvin.
-require 'marvin'
+require File.join(File.dirname(__FILE__), "..", "config", "boot")
 Marvin::Loader.run! :ring_server
 

data/script/server

@@ -1,12 +1,4 @@
 #!/usr/bin/env ruby
-require 'rubygems'
-#!/usr/bin/env ruby
-require 'rubygems'
-
-$:.unshift(File.dirname(__FILE__) + "/../lib/") if File.exist?(File.dirname(__FILE__) + "/../lib/marvin.rb")
-MARVIN_ROOT = File.join(File.dirname(__FILE__), "..")
-
-# And Require Marvin.
-require 'marvin'
+require File.join(File.dirname(__FILE__), "..", "config", "boot")
 Marvin::Loader.run! :server
 

data/script/status

@@ -1,11 +1,3 @@
 #!/usr/bin/env ruby
-#!/usr/bin/env ruby
-require 'rubygems'
-
-$:.unshift(File.dirname(__FILE__) + "/../lib/") if File.exist?(File.dirname(__FILE__) + "/../lib/marvin.rb")
-MARVIN_ROOT = File.join(File.dirname(__FILE__), "..")
-
-# And Require Marvin.
-require 'marvin'
-
+require File.join(File.dirname(__FILE__), "..", "config", "boot")
 Marvin::Status.show!

data/test/parser_test.rb

@@ -6,6 +6,8 @@ require File.join(File.dirname(__FILE__), 'test_helper')
 # 3) The two different types of prefixes
 # 4) The Event class
 class ParserTest < Test::Unit::TestCase
+  
+  # The default parser
   @@parser = Marvin::Parsers::SimpleParser
   
   context "When parsing a LIST" do

data/test/util_test.rb

@@ -0,0 +1,57 @@
+require File.join(File.dirname(__FILE__), 'test_helper')
+
+class UtilTest < Test::Unit::TestCase
+  
+  context "Converting a string to a channel name" do
+    
+    should "not convert it if it starts with #" do
+      assert_equal "#offrails", Marvin::Util.channel_name("#offrails")
+    end
+    
+    should "append a # if not present" do
+      assert_equal "#offrails", Marvin::Util.channel_name("offrails")
+    end
+    
+    should "also be available as chan" do
+      assert_equal "#offrails", Marvin::Util.chan("#offrails")
+      assert_equal "#offrails", Marvin::Util.chan("offrails")
+    end
+    
+  end
+  
+  context "Parsing arguments" do
+    
+    should "parse 'a b c' as ['a', 'b', 'c']" do
+      assert_equal ['a', 'b', 'c'], Marvin::Util.arguments("a b c")
+    end
+    
+    should "parse 'a b :c d' as ['a', 'b', 'c d']" do
+      assert_equal ['a', 'b', 'c d'], Marvin::Util.arguments("a b :c d")
+    end
+    
+    should "parse 'a :b c :d e' as ['a', 'b c :d e']" do
+      assert_equal ['a', 'b c :d e'], Marvin::Util.arguments('a :b c :d e')
+    end
+    
+  end
+  
+  context "Preparing last parameters" do
+    
+    should "prepend a :" do
+      assert_equal ':zomg ninjas',  Marvin::Util.last_param('zomg ninjas')
+      assert_equal '::zomg ninjas', Marvin::Util.last_param(':zomg ninjas')
+    end
+    
+    should "strip the input" do
+      assert_equal ':zomg ninjas', Marvin::Util.last_param('   zomg ninjas ')
+    end
+    
+    should "be available as lp" do
+      assert_equal ':zomg ninjas',  Marvin::Util.lp('zomg ninjas')
+      assert_equal '::zomg ninjas', Marvin::Util.lp(':zomg ninjas')
+      assert_equal ':zomg ninjas',  Marvin::Util.lp('   zomg ninjas ')
+    end
+    
+  end
+  
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: Sutto-marvin
 version: !ruby/object:Gem::Version 
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors: 
 - Darcy Laycock
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-12-07 00:00:00 -08:00
+date: 2009-01-03 00:00:00 -08:00
 default_executable: marvin
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -58,6 +58,7 @@ extra_rdoc_files: []
 
 files: 
 - README.textile
+- TUTORIAL.textile
 - VERSION.yml
 - bin/marvin
 - lib/marvin
@@ -87,10 +88,12 @@ files:
 - lib/marvin/irc/server/base_connection.rb
 - lib/marvin/irc/server/channel.rb
 - lib/marvin/irc/server/named_store.rb
+- lib/marvin/irc/server/remote_interface.rb
 - lib/marvin/irc/server/user
 - lib/marvin/irc/server/user/handle_mixin.rb
 - lib/marvin/irc/server/user.rb
 - lib/marvin/irc/server/user_connection.rb
+- lib/marvin/irc/server/virtual_user_connection.rb
 - lib/marvin/irc/server.rb
 - lib/marvin/irc.rb
 - lib/marvin/loader.rb
@@ -116,6 +119,7 @@ files:
 - test/parser_comparison.rb
 - test/parser_test.rb
 - test/test_helper.rb
+- test/util_test.rb
 - spec/marvin
 - spec/marvin/abstract_client_test.rb
 - spec/spec_helper.rb
@@ -131,6 +135,7 @@ files:
 - handlers/logging_handler.rb
 - handlers/tweet_tweet.rb
 - config/setup.rb
+- config/boot.rb
 - config/settings.yml.sample
 - config/connections.yml.sample
 has_rdoc: false