Pulse 1.1.0

data/library/pulse/channel.rb

@@ -0,0 +1,27 @@
+# encoding: utf-8
+
+module Pulse
+  class Channel
+    attr_accessor :name, :users
+
+    def initialize name, client, users = []
+      @name, @client, @users = name, client, users
+
+      users.each { |user| user.channel = self }
+    end
+
+    def say message
+      @client.say self, message
+    end
+
+    def user name; @users.find { |user| user.name == name } end
+    def user? name; not user(name).nil? end
+
+    def to_s; @name end
+    def to_yaml opts = {}; @name.to_yaml opts end
+
+    def inspect
+      %{#<#{self.class.name} @name=#{@name.inspect} @users=#{@users.inspect}}
+    end
+  end
+end

data/library/pulse/client.rb

@@ -0,0 +1,97 @@
+# encoding: utf-8
+
+require 'pulse/handling'
+
+module Pulse
+  class Client
+    include Handling
+
+    attr_accessor :scripts
+
+    def initialize options
+      @scripts       = []
+      @channels      = {}
+      @settings      = Settings.new options
+      @callbacks     = {}
+      @connection    = Connection.new self, @settings
+      @conversations = {}
+
+      load_scripts
+    end
+
+    def connect
+      trap 2 do
+        unload_scripts
+        transmit :QUIT, "I was interrupted" 
+      end
+      @connection.establish
+    end
+
+    def got_command command
+      name = :"got_#{command.name.downcase}"
+      puts "<< #{command}"
+
+      if respond_to? name
+        __send__ name, command
+      end
+    end
+
+    def connection_established connection
+      puts "Connection has been established."
+
+      transmit :NICK, @settings.nickname
+      transmit :USER, @settings.username, ?*, ?*, @settings.realname
+    end
+
+    def connection_terminated connection
+      puts "The connection was terminated."
+    end
+
+    def say recipient, line
+      transmit :PRIVMSG, recipient.to_s, line
+    end
+
+    def load_scripts
+      @settings.scripts.each do |path|
+        @scripts.<< Script.new path, self
+      end
+    end
+
+    def unload_scripts
+      @scripts.each &:unload!
+    end
+
+    def each_user name
+      @channels.values.select { |c| c.user? name }.each do |channel|
+        yield channel.user name
+      end
+    end
+
+  private
+
+    def emit name, *args
+      @callbacks[name].each do |callback|
+        callback.call *args
+      end if @callbacks[name]
+
+
+      begin
+        @scripts.each do |script|
+          if script.respond_to? name
+            script.__send__ name, *args
+          end
+        end
+      rescue
+        puts "Script error #$!"
+      end
+    end
+
+    def catch name, &block
+      (@callbacks[name] ||= []) << block
+    end
+
+    def transmit name, *args
+      @connection.transmit name, *args
+    end
+  end
+end

data/library/pulse/command.rb

@@ -0,0 +1,50 @@
+# encoding: utf-8
+
+require 'ostruct'
+
+module Pulse
+  class Command
+    attr_accessor :name, :params, :prefix
+
+    Pattern = /^(?:[:@]([^\s]+) )?([^\s]+)(?: ((?:[^:\s][^\s]* ?)*))?(?: ?:(.*))?$/
+    
+    def self.parse data
+      match = data.strip.match Pattern
+      prefix, name, args, extra = match.captures
+      params = extra ? args.split << extra : args.split
+
+      new(name, params).tap do |this|
+        this.prefix = prefix
+      end
+    end
+
+    def initialize name, params = []
+      @name, @params = name, params
+    end
+
+    def [] index; @params[index] end
+
+    def sender
+      return @sender if @sender
+
+      if prefix =~ /^(\S+)!(\S+)@(\S+)$/
+        @sender = OpenStruct.new nickname: $1, username: $2, hostname: $3
+      else
+        @sender = prefix
+      end
+    end 
+
+    def to_s
+      String.new.tap do |line|
+        line << "#{prefix} " if prefix
+        line << name.to_s
+
+        params.each_with_index do |param, index|
+          line << ' '
+          line << ?: if index == params.length - 1 and param =~ /[ :]/
+          line << param.to_s
+        end
+      end
+    end
+  end
+end

data/library/pulse/connection.rb

@@ -0,0 +1,28 @@
+# encoding: utf-8
+
+module Pulse
+  class Connection
+    def initialize delegate, settings
+      @delegate = delegate
+      @settings = settings
+      @queue    = Queue.new
+    end
+
+    def establish
+      TCPSocket.open @settings.hostname, @settings.port do |socket|
+        Thread.start socket, &@queue.method(:process)
+        @delegate.connection_established self
+
+        until socket.eof?
+          @delegate.got_command Command.parse socket.gets
+        end
+      end
+
+      @delegate.connection_terminated self
+    end
+
+    def transmit name, *arguments
+      Command.new(name, arguments).tap { |this| @queue << this }
+    end
+  end
+end

data/library/pulse/conversation.rb

@@ -0,0 +1,30 @@
+# encoding: utf-8
+
+module Pulse
+  class Conversation
+    attr_accessor :id, :recipient
+
+    def initialize recipient, client = nil
+      @id, @recipient, @client = random_id, recipient, client
+    end
+
+    def say message
+      @client.say @recipient.name, message
+    end
+
+    def name; @recipient.name end
+
+    def inspect
+      %{#<#{self.class.name} @recipient=#{@recipient}>}
+    end
+
+  private
+    def random_id
+      chars = 'abcdefghijklmnopqrstu0123456789'
+
+      String.new.tap do |result|
+        6.times { result << chars[rand chars.length] }
+      end.to_sym
+    end
+  end
+end

data/library/pulse/enhancements.rb

@@ -0,0 +1,5 @@
+# encoding: utf-8
+
+class String
+  alias_method :starts_with?, :start_with?
+end

data/library/pulse/handling.rb

@@ -0,0 +1,87 @@
+# encoding: utf-8
+
+module Pulse
+  class Client
+    module Handling
+
+  protected 
+      # End of MOTD
+      def got_end_of_motd command
+        emit :connection_ready, @connection
+      end
+
+      # The /NAMES list
+      def got_353 command
+        users = command[3].split.map &User.method(:new)
+
+        if channel = @channels[command[2]]
+          users.each &channel.users.method(:<<)
+          users.each { |user| user.channel = channel }
+        else
+          @channels[command[2]] ||= Channel.new(command[2], self, users)
+        end
+        p users, command[3]
+      end
+
+      # The IRCd is checking whether or not we're still alive
+      # PING :1285409133
+      # PONG :1285409133
+      def got_ping command
+        transmit :PONG, command[0]
+      end
+
+      # Someone has changed their nickname
+      # mk!mk@maero.dk NICK mk_
+      def got_nick command
+        each_user command.sender.nickname do |user|
+          emit :rename, user, command[0]
+          user.name = command[0]
+        end
+      end
+
+      # Someone has sent a message, it can be both a private message and
+      # a channel message
+      # mk!mk@maero.dk PRIVMSG #maero :tp: kod
+      def got_privmsg command
+        name, message = command.params
+
+        if channel = @channels[name]
+          user = channel.user command.sender.nickname
+          user.synchronize command.sender
+          emit :message, user, channel, message
+        else
+          user = User.new command.sender.nickname
+
+          (@conversations[command.sender.nickname] ||= Conversation.new user, self).tap do |conversation|
+            user.channel = conversation
+            emit :conversation, user, conversation, message
+          end
+        end
+      end
+
+
+      # Someone has entered a channel.
+      def got_join command
+        if channel = @channels[command[0]]
+          user = User.new command.sender.nickname
+          user.channel = channel
+          user.synchronize command.sender
+          channel.users << user
+          emit :user_joined, user, channel
+        end
+      end
+
+      # Someone has left a channel.
+      def got_part command
+        if channel = @channels[command[0]]
+          user = channel.user command.sender.nickname
+          channel.users.delete user
+          emit :user_left, user, channel
+        end
+      end
+
+      alias_method :got_422, :got_end_of_motd
+      alias_method :got_376, :got_end_of_motd
+    end
+  end
+end

data/library/pulse/queue.rb

@@ -0,0 +1,28 @@
+# encoding: utf-8
+
+module Pulse
+  class Queue
+    def initialize
+      @queue = []
+    end
+
+    def process socket
+      @socket ||= socket
+      @thread = Thread.current
+
+      while @thread.alive?
+        if command = @queue.shift
+          puts ">> #{command}"
+          @socket.write "#{command}\n"
+        else
+          Thread.stop
+        end
+      end
+    end
+
+    def << command
+      @queue << command
+      @thread.run if @thread
+    end
+  end
+end

data/library/pulse/script/cache.rb

@@ -0,0 +1,50 @@
+# encoding: utf-8
+
+module Pulse
+  class Script
+    class Cache
+      def initialize script
+        @script = script
+        @containers = {}
+      end
+
+      def save
+        create_directory
+
+        File.open path, ?w do |file|
+          YAML.dump @containers, file
+        end
+
+        puts "Dumping cache for script #{@script.inspect} to #{path} …"
+      end
+
+      def load
+        if yaml = YAML.load_file(path)
+          @containers = yaml
+
+          puts "Imported cache from #{path} …"
+        end
+      rescue
+
+        puts "The cache is corrupt. Removing."
+        File.unlink path
+      end
+
+      def containers; @containers.keys end
+      def clear sure = false; @containers.clear if sure end
+
+      def [] key; @containers[key] ||= {} end
+      def []= key, value; @containers[key] ||= value end
+
+    private
+
+      def create_directory
+        Dir.mkdir File.dirname path unless File.directory? File.dirname path
+      end
+
+      def path
+        "#{File.dirname File.expand_path $0}/cache/#{@script.name}.yml"
+      end
+    end
+  end
+end

data/library/pulse/script.rb

@@ -0,0 +1,50 @@
+# encoding: utf-8
+
+module Pulse
+  class Script < Module
+
+    attr_accessor :name, :author, :version
+
+    def initialize path, client
+      @path, @client = path, client
+      @loaded = false
+
+      evaluate_script
+      cache.load if has_cache?
+      __send__ :loaded if respond_to? :loaded
+    end
+
+    def Script name, version = [1, 0, 0], author = nil, &block
+      @name, @version, @author = name, version, author
+      instance_eval &block
+    end
+
+    def loaded?; @loaded == true end
+
+    def unload!
+      cache.save if @cache
+      @client.scripts.delete self
+      __send__ :unloaded if respond_to? :unloaded
+    end
+
+    def to_yaml opts = {}; @name.to_yaml opts end
+
+    def inspect
+      %{#<#{self.class.name} @name=#{@name.inspect} @version=#{@version.inspect} @author=#{@author.inspect}}
+    end
+
+    def has_cache?
+      File.exists? "#{File.expand_path File.dirname $0}/cache/#@name.yml"
+    end
+
+  private
+
+    def evaluate_script
+      @loaded = true if module_eval File.read(@path), File.basename(@path), 0
+    rescue
+      puts "Parse error: #{$!.message}"
+    end
+
+    def cache; @cache ||= Cache.new self end
+  end
+end

data/library/pulse/settings.rb

@@ -0,0 +1,30 @@
+# encoding: utf-8
+
+module Pulse
+  class Settings < Hash
+    class Error < StandardError; end
+
+    attr_accessor :nickname, :username, :realname, :hostname, :password
+
+    def initialize options = {}
+      @options = options
+
+      @nickname = options[:nickname] or raise Error, 'No nickname given'
+      @username = options[:username] || @nickname
+      @realname = options[:realname] || @username
+      @hostname = options[:hostname] or raise Error, 'No hostname given'
+
+      @script_path = options[:path] || File.expand_path(File.dirname $0) + '/scripts'
+    end
+
+    def port; @options[:port] or secure ? 6697 : 6667 end
+    def secure?; @options[:secure] == true end
+    def password?; not @options[:password].nil? end
+
+    def scripts
+      Dir.glob "#@script_path/*.rb"
+    end
+
+    def method_missing name, *args; @options[name] end
+  end
+end

data/library/pulse/user.rb

@@ -0,0 +1,22 @@
+# encoding: utf-8
+
+module Pulse
+  class User
+    attr_accessor :name, :user, :host, :channel
+
+    def initialize name
+      @name = name.sub /^\W/, ''
+    end
+
+    def synchronize sender
+      @name, @user, @host = sender.nickname, sender.username, sender.hostname
+    end
+
+    def to_s; @name end
+    def to_yaml opts = {}; @name.to_yaml opts end
+
+    def inspect
+      %{#<#{self.class.name} @name=#{@name.inspect} @channel=#{@channel.name.inspect}>}
+    end
+  end
+end

data/library/pulse.rb

@@ -0,0 +1,33 @@
+# encoding: utf-8
+
+require 'yaml'
+require 'socket'
+require 'pulse/user'
+require 'pulse/queue'
+require 'pulse/client'
+require 'pulse/script'
+require 'pulse/channel'
+require 'pulse/command'
+require 'pulse/settings'
+require 'pulse/connection'
+require 'pulse/enhancements'
+require 'pulse/conversation'
+require 'pulse/script/cache'
+
+Thread.abort_on_exception = true
+
+module Pulse
+  class << Version = [1,1]
+    def to_s; join ?. end
+  end
+
+  class << self
+    def connect options, &block
+      puts "=> Pulse #{Pulse::Version}"
+
+      Client.new(options).tap do |client|
+        client.instance_eval &block
+      end.connect
+    end
+  end
+end

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification 
+name: Pulse
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 1
+  - 1
+  - 0
+  version: 1.1.0
+platform: ruby
+authors: 
+- Mikkel Kroman
+autorequire: 
+bindir: executables
+cert_chain: []
+
+date: 2010-11-25 00:00:00 +01:00
+default_executable: 
+dependencies: []
+
+description: 
+email: mk@maero.dk
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- library/pulse/client.rb
+- library/pulse/handling.rb
+- library/pulse/connection.rb
+- library/pulse/script.rb
+- library/pulse/queue.rb
+- library/pulse/command.rb
+- library/pulse/settings.rb
+- library/pulse/script/cache.rb
+- library/pulse/user.rb
+- library/pulse/conversation.rb
+- library/pulse/channel.rb
+- library/pulse/enhancements.rb
+- library/pulse.rb
+has_rdoc: true
+homepage: 
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- library
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 1
+      - 9
+      - 1
+      version: 1.9.1
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Extensible IRC library
+test_files: []
+