marvin 0.8.0.0 → 0.8.0.1

data/bin/marvin

@@ -3,8 +3,9 @@ require 'rubygems'
 require File.join(File.dirname(__FILE__), "..", "lib", "marvin")
 
 Marvin::Application.processing(ARGV) do |a|
-  
-  a.banner = "Marvin v#{Marvin::VERSION} - An IRC Library for Ruby"
+  version = Marvin.version
+  version << "p#{Marvin::VERSION[3]}" if Marvin::VERSION[3] != 0
+  a.banner = "Marvin v#{version} - An IRC Library for Ruby"
   
   a.generator!
   

data/lib/marvin.rb

@@ -5,19 +5,14 @@ require 'perennial'
 module Marvin
   include Perennial
   
-  VERSION = [0, 8, 0, 0]
+  VERSION = [0, 8, 0, 1]
   
-  # Misc.
-  #autoload :Util,             'marvin/util'
   # Client
-  #autoload :AbstractClient,   'marvin/abstract_client'
-  #autoload :IRC,              'marvin/irc'
   autoload :TestClient,       'marvin/test_client'
   # Console of DOOM.
   autoload :Console,          'marvin/console'
   # Distributed
   autoload :Distributed,      'marvin/distributed'
-  autoload :Status,           'marvin/status'
   # Handler
   autoload :Base,             'marvin/base'
   autoload :CommandHandler,   'marvin/command_handler'
@@ -25,7 +20,6 @@ module Marvin
   autoload :CoreCommands,     'marvin/core_commands'
   autoload :MiddleMan,        'marvin/middle_man'
   # These should be namespaced under IRC
-  #autoload :AbstractParser,   'marvin/abstract_parser'
   autoload :Parsers,          'marvin/parsers'
   
   

data/lib/marvin/abstract_client.rb

@@ -57,10 +57,7 @@ module Marvin
     end
     
     def process_development
-      if @@development
-        Marvin::Reloading.reload!
-        setup_handlers
-      end
+      Marvin::Reloading.reload! if @@development
     end
     
     def dispatch(*args)

data/lib/marvin/base.rb

@@ -76,9 +76,11 @@ module Marvin
           before = dispatcher.handlers
           register!(dispatcher)
           after = dispatcher.handlers
-          (after - before).each { |h| h.handle(:reloaded, {}) }
+          (after - before).each do |h|
+            h.client = dispatcher
+            h.handle(:reloaded, {})
+          end
         end
-        
       end
     
     end

data/lib/marvin/command_handler.rb

@@ -8,7 +8,6 @@ module Marvin
     
     @@exposed_method_mapping = Hash.new { |h,k| h[k] = [] }
     @@method_descriptions    = Hash.new { |h,k| h[k] = {} }
-    @@registered_classes     = Set.new
     
     class << self
       
@@ -48,6 +47,12 @@ module Marvin
         "#{command_prefix}#{method}"
       end
       
+      def reloading!
+        super
+        @@exposed_method_mapping.delete(self)
+        @@method_descriptions.delete(self)
+      end
+      
     end
     
     on_event :incoming_message, :check_for_commands

data/lib/marvin/distributed/client.rb

@@ -26,13 +26,22 @@ module Marvin
           @host_with_port
         end
         
-        def method_missing(name, *args)
+        def method_missing(name, *args, &blk)
           logger.debug "Proxying #{name}(#{args.inspect[1..-2]}) to #{@host_with_port}"
+          cb = nil
+          if blk.present?
+            cb = proc do |_, options|
+              if options.is_a?(Hash) 
+                value = options.delete("return-value")
+                blk.call(value)
+              end
+            end
+          end
           @connection.send_message(:action, {
             "action"      => name.to_s,
             "arguments"   => args,
             "client-host" => @host_with_port
-          })
+          }, &cb)
         end
         
       end
@@ -43,6 +52,7 @@ module Marvin
         register_handler_method :authentication_failed
         register_handler_method :authenticated
         register_handler_method :unauthorized
+        register_handler_method :welcome
         
         cattr_accessor :stopping
         self.stopping = false
@@ -60,20 +70,13 @@ module Marvin
         def post_init
           super
           logger.info "Connected to distributed server"
-          if should_use_tls?
-            logger.info "Attempting to initialize tls"
-            start_tls
-          else
-            process_authentication
-          end
         end
         
-        def ssl_handshake_completed
-          logger.info "tls handshake completed"
-          process_authentication if should_use_tls?
+        def post_connect
+          logger.info "Connection started; processing authentication"
+          process_authentication
         end
         
-        
         def unbind
           if self.stopping
             logger.info "Stopping distributed client"
@@ -91,6 +94,15 @@ module Marvin
           end
         end
         
+        def handle_welcome(options = {})
+          if should_use_ssl? && !ssl_enabled?
+            request_ssl!
+          else
+            @connected = true
+            post_connect
+          end
+        end
+        
         def handle_event(options = {})
           event       = options["event-name"]
           client_host = options["client-host"]
@@ -142,34 +154,9 @@ module Marvin
           end
         end
         
-        protected
-        
-        def options_for_callback(blk)
-          return {} if blk.blank?
-          cb_id = "callback-#{seld.object_id}-#{Time.now.to_f}"
-          count = 0
-          count += 1 while @callbacks.has_key?(Digest::SHA256.hexdigest("#{cb_id}-#{count}"))
-          final_id = Digest::SHA256.hexdigest("#{cb_id}-#{count}")
-          @callbacks[final_id] = blk
-          {"callback-id" => final_id}
-        end
-
-        def process_callback(hash)
-          if hash.is_a?(Hash) && hash.has_key?("callback-id")
-            callback = @callbacks.delete(hash["callback-id"])
-            callback.call(self, hash)
-          end
-        end
-
-        def host_with_port
-          @host_with_port ||= begin
-            port, ip = Socket.unpack_sockaddr_in(get_peername)
-            "#{ip}:#{port}"
-          end
-        end
-
-        def should_use_tls?
-          @using_tls ||= configuration.encrypted?
+        def request_ssl!
+          logger.info "Requesting SSL for Distributed Client"
+          send_message(:enable_ssl) unless ssl_enabled?
         end
 
       end

data/lib/marvin/distributed/handler.rb

@@ -2,7 +2,6 @@ module Marvin
   module Distributed
     class Handler < Marvin::Base
       
-      
       EVENT_WHITELIST = [:incoming_message, :incoming_action]
       QUEUE_PROCESSING_SPACING = 3
       

data/lib/marvin/distributed/protocol.rb

@@ -32,11 +32,19 @@ module Marvin
         send_data "#{payload}\n"
       end
       
+      def send_message_reply(name, arguments = {})
+        arguments["callback-id"] = @callback_id if @callback_id.present?
+        send_message(name, arguments)
+      end
+      
       def handle_response(response)
-        logger.debug "Handling response in distributed protocol (response => #{response.inspect})"
+        logger.debug "Handling response in distributed protocol (response: #{response.inspect})"
         return unless response.is_a?(Hash) && response.has_key?("message")
         options = response["options"] || {}
+        @callback_id = response.delete("callback-id")
+        process_callback(options)
         process_response_message(response["message"], options)
+        @callback_id = nil
       end
       
       def host_with_port
@@ -46,11 +54,52 @@ module Marvin
         end
       end
       
+      def handle_enable_ssl(opts = {})
+        send_message_reply(:enabled_ssl)
+        enable_ssl
+      end
+      
+      def handle_enabled_ssl(opts = {})
+        enable_ssl
+      end
+      
+      def handle_noop(opts = {})
+        # DO NOTHING.
+        logger.debug "no-op"
+      end
+      
+      # After the connection is made and / or ssl is enabled.
+      def post_connect
+      end
+      
+      def ssl_handshake_completed
+        logger.debug "SSL Handshake completed"
+        if !connected?
+          @connected = true
+          post_connect
+        end
+      end
+      
       protected
       
+      def should_use_ssl?
+        @should_use_ssl ||= configuration.ssl?
+      end
+      
+      def ssl_enabled?
+        instance_variable_defined?(:@ssl_enabled) && @ssl_enabled
+      end
+      
+      def enable_ssl
+        return if ssl_enabled?
+        logger.debug "Enabling SSL"
+        start_tls
+        @ssl_enabled = true
+      end
+      
       def options_for_callback(blk)
         return {} if blk.blank?
-        cb_id = "callback-#{seld.object_id}-#{Time.now.to_f}"
+        cb_id = "callback-#{self.object_id}-#{Time.now.to_f}"
         count = 0
         count += 1 while @callbacks.has_key?(Digest::SHA256.hexdigest("#{cb_id}-#{count}"))
         final_id = Digest::SHA256.hexdigest("#{cb_id}-#{count}")
@@ -63,7 +112,7 @@ module Marvin
         @callbacks ||= {}
         if hash.is_a?(Hash) && hash.has_key?("callback-id")
           callback = @callbacks.delete(hash["callback-id"])
-          callback.call(self, hash)
+          callback.call(self, hash) if callback.present?
         end
       end
       
@@ -83,6 +132,15 @@ module Marvin
         self.handler_methods[name] = method
       end
       
+      # Default Handlers
+      register_handler_method :enable_ssl
+      register_handler_method :enabled_ssl
+      register_handler_method :noop
+      
+      def connected?
+        instance_variable_defined?(:@connected) && @connected
+      end
+      
     end
   end
 end

data/lib/marvin/distributed/server.rb

@@ -16,7 +16,7 @@ module Marvin
       self.free_connections = []
       self.action_whitelist = [:nick, :pong, :action, :msg, :quit, :part, :join, :command]
       
-      attr_accessor :processing, :configuration, :using_tls
+      attr_accessor :processing, :configuration
       
       def initialize(*args)
         @configuration = args.last.is_a?(Marvin::Nash) ? args.pop : Marvin::nash.new
@@ -24,18 +24,20 @@ module Marvin
       end
       
       def post_init
-        super
         @callbacks = {}
         logger.info "Got distributed client connection with #{self.host_with_port}"
-        if should_use_tls?
-          start_tls
+        if should_use_ssl?
+          handle_enable_ssl
         else
-          complete_processing
+          @connected = true
+          post_connect
         end
       end
       
-      def ssl_handshake_completed
-        complete_processing if should_use_tls?
+      def post_connect
+        logger.debug "Remote client available, welcoming"
+        send_message(:welcome)
+        complete_processing
       end
       
       def unbind
@@ -84,14 +86,17 @@ module Marvin
       def handle_action(options = {})
         return if fails_auth!
         logger.debug "Handling action from on #{self.host_with_port}"
-        server    = lookup_client_for(options["client-host"])
+        target    = lookup_client_for(options["client-host"])
         action    = options["action"]
         arguments = [*options["arguments"]]
-        return if server.blank? || action.blank?
+        return if target.blank? || action.blank?
         begin
           a = action.to_sym
-          if self.action_whitelist.include?(a)
-            server.send(a, *arguments) if server.respond_to?(a)
+          if self.action_whitelist.include?(a) && target.respond_to?(a)
+            res = target.send(a, *arguments)
+            if @callback_id.present? && res.respond_to?(:to_json)
+              send_message_reply(:noop, {"return-value" => res.to_json})
+            end
           else
             logger.warn "Client attempted invalid action #{a.inspect}"
           end
@@ -123,10 +128,6 @@ module Marvin
         @authenticated ||= false
       end
       
-      def should_use_tls?
-        @using_tls ||= configuration.encrypted?
-      end
-      
       def fails_auth!
         if requires_auth?
           logger.debug "Authentication missing for distributed client"

data/lib/marvin/irc/client.rb

@@ -103,8 +103,10 @@ module Marvin::IRC
           EventMachine.kqueue
           EventMachine.epoll
           EventMachine.run do
-            connections.each_pair do |server, configuration|
-              connect(configuration.merge(:server => server.to_s))
+            unless connections.data == false
+              connections.each_pair do |server, configuration|
+                connect(configuration.merge(:server => server.to_s))
+              end
             end
             Marvin::Distributed::Server.start if Marvin::Distributed::Handler.registered?
             @@stopped = false

data/lib/marvin/logging_handler.rb

@@ -21,20 +21,23 @@ module Marvin
       end
     end
     
-    on_event :client_connected do
-      @server = self.client.host_with_port
-      @nick   = self.client.nickname
-      setup_logging
-    end
+    on_event :client_connected, :presetup_logging
+    on_event :client_connected, :setup_logging
+    on_event :reloaded, :presetup_logging
+    on_event :reloaded, :setup_logging
 
-    on_event :client_disconnected do
-      teardown_logging
-    end
+    on_event :client_disconnected, :teardown_logging
+    on_event :reloaded, :teardown_logging
     
     on_event :outgoing_nick do
       @nick = options.new_nick
     end
     
+    def presetup_logging
+      @server = self.client.host_with_port
+      @nick   = self.client.nickname
+    end
+    
     # Called when the client connects, over ride it to
     # do any of your specific setup.
     def setup_logging

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: marvin
 version: !ruby/object:Gem::Version 
-  version: 0.8.0.0
+  version: 0.8.0.1
 platform: ruby
 authors: 
 - Darcy Laycock
@@ -10,27 +10,27 @@ bindir: bin
 cert_chain: []
 
 date: 2009-09-25 00:00:00 +08:00
-default_executable: 
+default_executable: marvin
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: Sutto-perennial
+  name: perennial
   type: :runtime
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 0.2.4.6
+        version: 1.0.0.0
     version: 
 - !ruby/object:Gem::Dependency 
-  name: eventmachine-eventmachine
+  name: eventmachine
   type: :runtime
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 0.12.9
+        version: 0.12.8
     version: 
 - !ruby/object:Gem::Dependency 
   name: json
@@ -42,10 +42,16 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: "0"
     version: 
-description: 
+description: |-
+  Marvin is a library (also usable in framework / application form) that
+  makes it simple and fast to build applications around IRC. With an emphasis
+  on making common tasks (e.g. replies, bots using method call style syntax
+  and the like) easy, whilst still making it possible to do more complex thing
+  (1 connection, N worker processes, Multiple servers, etc) it aims to make
+  working with IRC in an evented fashion fun and easy for all rubyists.
 email: sutto@sutto.net
-executables: []
-
+executables: 
+- marvin
 extensions: []
 
 extra_rdoc_files: []
@@ -131,6 +137,6 @@ rubyforge_project:
 rubygems_version: 1.3.2
 signing_key: 
 specification_version: 3
-summary: Evented IRC Library of Doom
+summary: Evented IRC Library for Ruby, built on EventMachine and Perennial.
 test_files: []