fantasy-irc 0.1.0

data/LICENSE.md

@@ -0,0 +1,23 @@
+Copyright (c) 2013 Jens Becker
+
+MIT License
+
+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.md

@@ -0,0 +1,30 @@
+# fantasy-irc
+
+A modular, event-driven IRC client gem for Ruby with plugin support
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'fantasy-irc'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install fantasy-irc
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+

data/docs/PLUGINS.md

@@ -0,0 +1,11 @@
+PLUGINS
+=======
+
+Available Plugins
+-----------------
+
+*   corecommands
+    'Provides the ollowing commands:'
+    *   !date
+    *   !ping
+    *   !host

data/docs/example.rb

@@ -0,0 +1,37 @@
+#!/usr/bin/env ruby
+require 'fantasy-irc'
+
+# new connection
+bot = Fantasy::IRC.new
+
+# load some plugins
+bot.plugins.load 'corecommands'
+
+# log in once we are connected
+connected = Proc.new do
+	bot.login :nickname => "example", :username => "example", :realname => "GECOS field"
+end
+bot.events.by_name('connected').register &connected
+
+# join a room and say hi
+loggedin = Proc.new do
+	%w{#lobby}.each do |r|
+		room = bot.rooms.new(r).join.say "ohai"
+	end
+end
+bot.events.by_name('loggedin').register &loggedin
+
+# we also want to greet users that are joining the room
+user_joined = Proc.new do |room, user|
+	room.say("Hey, #{user.name}!")
+end
+bot.events.by_name('user_joined').register &user_joined
+
+# and monitor everything they say
+channel_message = Proc.new do |room, user, text|
+	puts "!! #{user.name} said in room #{room.name}: #{text}"
+end
+bot.events.by_name('channel_message').register &channel_message
+
+bot.connect :server => "irc.example.com", :ssl => true, :port => 6697
+bot.run

data/fantasy-irc.gemspec

@@ -0,0 +1,15 @@
+Gem::Specification.new do |s|
+  s.authors           = ["Jens Becker"]
+  s.email             = ["v2px@v2px.de"]
+  s.description       = "A modular, event-driven IRC client/bot gem for Ruby with plugin support"
+  s.summary           = "A modular, event-driven IRC client/bot gem for Ruby with plugin support"
+  s.homepage          = "https://github.com/v2px/fantasy-irc"
+
+  s.files             = `git ls-files`.split("\n")
+  s.name              = "fantasy-irc"
+  s.require_paths     = ['lib']
+  s.version           = "0.1.0"
+
+  s.rubyforge_project = s.name
+  s.add_runtime_dependency "array-unique", "~> 1.1.1"
+end

data/lib/fantasy-irc.rb

@@ -0,0 +1,5 @@
+require "fantasy-irc/irc"
+require "fantasy-irc/events"
+require "fantasy-irc/plugins"
+require "fantasy-irc/rooms"
+require "fantasy-irc/users"

data/lib/fantasy-irc/events.rb

@@ -0,0 +1,64 @@
+require 'securerandom'
+
+module Fantasy
+    module Event
+        class Factory
+            def initialize
+                puts "Initializing new Event::Factory #{self}"
+                @data, @data[:events] = Hash.new, Hash.new
+            end
+
+            def create name
+                name.downcase!
+
+                if not @data[:events][name].nil? then
+                    return @data[:events][name]
+                    # TODO: log warning
+                end
+
+                @data[:events][name] = Event.new(name)
+            end
+
+            def by_name name
+                name.downcase!
+
+                if not @data[:events][name] then
+                    raise "Tried to access unknown event \"#{name}\" in Event::Factory \"#{self}\""
+                end
+
+                @data[:events][name]
+            end
+        end
+
+        class Event
+            attr_reader :name
+
+            def initialize(name)
+                puts "New Event with name #{name}"
+                @name = name
+                @data = Hash.new
+            end
+
+            def register(&callback)
+                uuid = SecureRandom.uuid()
+
+                if @data[:callbacks].nil? then
+                    @data[:callbacks] = Hash.new
+                end
+
+                @data[:callbacks][uuid] = callback
+                puts "#{self}: registered callback #{callback} with uuid #{uuid}."
+            end
+
+            def call(args=nil)
+                if @data[:callbacks].nil? or @data[:callbacks].empty? then
+                    return
+                end
+
+                @data[:callbacks].each { |uuid, proc|
+                    proc.call(args)
+                }
+            end
+        end
+    end
+end

data/lib/fantasy-irc/irc.rb

@@ -0,0 +1,202 @@
+require 'socket' # TCPSocket
+require 'openssl'
+require 'array-unique'
+
+#require "fantasy-irc/rooms"
+#require "fantasy-irc/users"
+#require "fantasy-irc/events"
+#require "fantasy-irc/plugins"
+
+module Fantasy
+    class IRC
+        attr_reader :events, :rooms, :users, :plugins
+        attr_reader :started, :session, :loggedin, :connected
+
+        def initialize options={}
+            $bot = self
+            @data = Hash.new
+            @started = Time.now.to_i
+            @running = 0
+            @loggedin = 0
+            @connected = 0
+            @prefix = options[:prefix] || '!'
+
+            @events = Event::Factory.new
+            @rooms = Room::Factory.new self
+            @users = User::Factory.new self
+            @plugins = Plugins.new
+
+            %w{tick loggedin connected user_joined channel_message}.each do |e|
+                @events.create(e)
+            end
+        end
+
+        def login data
+            if not data[:nickname] and data[:username] then
+                data[:nickname] = data[:username]
+            end
+            if not data[:username] and data[:nickname] then
+                data[:username] = data[:nickname]
+            end
+            if not data[:realname] then
+                data[:realname] = "https://bitbucket.org/v2px/fantasy-irc"
+            end
+
+            if not data[:nickname] then
+                raise "you need to specify :nickname and/or :username on login"
+            end
+
+            if data[:password] then
+                self.send("PASS #{data[:password]}")
+            end
+
+            self.send("USER #{data[:username]} fantasy fantasy :#{data[:realname]}")
+            self.send("NICK #{data[:nickname]}")
+        end
+
+        def send(s)
+            # Send a message to the server
+            if not @connected then
+                raise "not connected to a server!"
+            end
+            puts "<-- #{s}"
+            @data[:socket].puts "#{s}\n"
+        end
+
+        def connect data
+            if not data[:server] then
+                raise "you need to specify :server on connect"
+            end
+            if not data[:ssl] then
+                data[:ssl] = false
+            end
+            if not data[:port] then
+                data[:port] = data[:ssl] ? 6697 : 6667
+            end
+
+            # Connect to the chat server
+            @data[:socket] = @data[:realsocket] = TCPSocket.open(data[:server], data[:port])
+
+            if !!data[:ssl] then
+                @data[:socket] = OpenSSL::SSL::SSLSocket.new(@data[:realsocket])
+                @data[:socket].connect
+            end
+
+            @connected = Time.now.to_i
+            self.events.by_name('connected').call
+        end
+
+        def cleanup
+            puts "[!][Cleanup] Closing socket."
+            @data[:socket].close()
+        end
+
+        def parse(s)
+            s.chomp!
+
+            if (s[0,4] == "PING") then
+                tok = s.split(' ', 2)
+                self.send "PONG #{tok[1]}"
+
+            elsif (s[0,1] == ":") then
+                # Server stuff
+                tok = s.split(' ', 4)
+
+                if (tok[1] == "001") then
+                    # loggedin
+                    @loggedin = Time.now.to_i
+                    # ignore ourself
+                    self.users.create(tok[2]).ignore!
+                    self.events.by_name('loggedin').call
+
+                elsif (tok[1] == "JOIN") then
+                    # user joined
+                    room = self.rooms.by_name(tok[2][1,tok[2].length])
+                    user = self.users.create(tok[0][1,tok[0].length])
+
+                    # add user to room and room to user
+                    room.users << user
+                    user.rooms << room
+
+                    return if user.ignored?
+
+                    self.events.by_name('user_joined').call([room, user])
+
+                elsif (tok[1] == "PRIVMSG") then
+                    #                        tok = s.split(' ', 4)
+
+                    # channel or private message
+                    if (tok[2][0,1] == "#") then
+                        # channel message
+                        room = self.rooms.by_name(tok[2])
+                        user = self.users.create(tok[0][1,tok[0].length])
+
+                        # add user to room and room to user
+                        room.users << user
+                        user.rooms << room
+
+                        return if user.ignored?
+
+                        text = tok[3][1,tok[3].length]
+                        self.events.by_name('channel_message').call([room, user, text])
+
+                        if text[0] == @prefix then
+                            command, args = text.split(' ', 2)
+                            self.plugins.command(command[1,command.length], {:room => room, :user => user}, args)
+                        end
+                    end
+
+                else
+                    # puts "[!] UNKNOWN PROTOCOL PART: #{s}"
+                end
+            else
+
+                puts "[!] UNKNOWN PROTOCOL PART: #{s}"
+            end
+        end
+
+        def run
+            if @running.nonzero? then
+                return false
+            end
+
+            @running = Time.now.to_i
+            last_tick = @running
+            last_ping = @running
+            last_session_ping = @running
+
+            loop do
+                time_now = Time.now
+
+                # tick every second
+                if time_now.to_i > last_tick then
+                    self.events.by_name('tick').call(time_now)
+                    last_tick = time_now.to_i
+                end
+
+                # chatserver ping, every 5 minutes
+                if @connected.nonzero? and time_now.to_i-300 >= last_ping then
+                    self.send("PING :"+time_now.to_f.to_s)
+                    last_ping = time_now.to_i
+                end
+
+                # connection
+                if @connected.nonzero? then
+                    ready = select([@data[:socket]], nil, nil, 0.1)
+                    next if !ready
+                    for s in ready[0]
+                        if s == @data[:socket] then
+                            return if @data[:socket].eof # XXX?
+                            s = @data[:socket].gets
+                            puts "--> #{s}"
+                            self.parse(s)
+                        end
+                    end
+                else # no connection, less cpu usage
+                    sleep(0.5)
+                end
+
+            end
+        end
+    end
+end

data/lib/fantasy-irc/plugins.rb

@@ -0,0 +1,61 @@
+module Fantasy
+    class Plugins
+        attr_reader :plugins
+
+        def initialize
+            @plugins = {}
+        end
+
+        def add plugin
+            @plugins[plugin.name] = plugin
+            puts "#{plugin.name} = #{plugin}"
+        end
+
+        def load name
+            Kernel::load "plugins/#{name}.rb"
+        end
+
+        def command command, data, args
+            if not args.nil? then
+                args = args.split(' ')
+            end
+            @plugins.values.each do |plugin|
+                puts "#{plugin}"
+                plugin.handle! command, data, args
+            end
+        end
+    end
+end
+
+class Plugin
+    attr_reader :name
+
+    def initialize name
+        @name = name
+        @handlers = {}
+    end
+
+    def handle pattern, &block
+        @handlers[pattern] = block
+    end
+
+    def handles? command
+        @handlers.keys.each do |pattern|
+            if command.match pattern then
+                return true
+            end
+        end
+
+        return false
+    end
+
+    def handle! command, data, args=[]
+        puts "trying to handle #{command} with #{data} and #{args}"
+        @handlers.each do |pattern, block|
+            if command.match(pattern) then
+                puts "#{block} handles #{command}"
+                break block.call data, args
+            end
+        end
+    end
+end

data/lib/fantasy-irc/rooms.rb

@@ -0,0 +1,79 @@
+#require "fantasy-irc/connection"
+
+module Fantasy
+    module Room
+        class Factory
+            def initialize connection
+                puts "Initializing new Room::Factory #{self} with connection #{connection}"
+                @data, @data[:rooms] = Hash.new, Hash.new
+                @connection = connection
+            end
+
+            def new name
+                name.downcase!
+
+                if not @data[:rooms][name].nil? then
+                    raise "We already know the room #{name}"
+                end
+
+                @data[:rooms][name] = Room.new(name, @connection)
+            end
+
+            alias :create :new
+
+            def by_name name
+                name.downcase!
+
+                if not @data[:rooms][name] then
+                    raise "Tried to access unknown room \"#{name}\" in Room::Factory \"#{self}\""
+                end
+
+                @data[:rooms][name]
+            end
+        end
+
+        class Room
+            attr_reader :name, :users
+
+            def initialize name, connection
+                if not connection.respond_to?(:send) then
+                    raise "Connection class needs to be able to respond to :send"
+                end
+
+                puts "New Room #{self.object_id} with name #{name}"
+                @name = name
+                @joined = false
+                @connection = connection
+                @users = Array::Unique.new
+            end
+
+            def join
+                if @joined == true then
+                    raise "Already joined room #{@name}."
+                end
+
+                @connection.send("JOIN "+@name)
+                @joined = true	# TODO: maybe we should set that if we get the
+                # correct reply. this is for testing only! XXX
+                return self
+            end
+
+            def joined?
+                !!@joined
+            end
+
+            def say message
+                if @joined == false then
+                    raise "Tried to talk to a room (#{name}) we're not in."
+                end
+
+                @connection.send('PRIVMSG '+@name+' :'+message)
+                return self
+            end
+
+            def to_s
+                "#{@name}"
+            end
+        end
+    end
+end

data/lib/fantasy-irc/users.rb

@@ -0,0 +1,80 @@
+module Fantasy
+    module User
+        class Factory
+            def initialize connection
+                puts "Initializing new User::Factory #{self} with connection #{connection}"
+                @data, @data[:users] = Hash.new, Hash.new
+                @connection = connection
+            end
+
+            def new name
+                name = name.split(/!/, 2)[0] # remove mask
+                name_lc = name.downcase
+
+                if not @data[:users][name_lc].nil? then
+                    return @data[:users][name_lc]
+                    # TODO: log! not raise
+                    # raise "We already know the user #{name}"
+                end
+
+                @data[:users][name_lc] = User.new(name, @connection)
+            end
+
+            alias :create :new
+
+            def by_name name
+                name.downcase!
+
+                if not @data[:users][name] then
+                    raise "Tried to access unknown user \"#{name}\" in User::Factory \"#{self}\""
+                end
+
+                @data[:users][name]
+            end
+        end
+
+        class User
+            attr_reader :name, :mask
+            attr_accessor :rooms
+
+            def initialize name, connection
+                if not connection.respond_to?(:send) then
+                    raise "Connection class needs to be able to respond to :send"
+                end
+
+                @name = name
+                puts "New User #{self.object_id} with name #{@name}"
+                @connection = connection
+                @rooms = Array::Unique.new
+            end
+
+            def say message
+                @connection.send('PRIVMSG '+@name+' :'+message)
+                return self
+            end
+
+            def login
+                self.name
+            end
+
+            # ===================
+            # Ignoring
+            def ignore!
+                @ignored = true
+            end
+
+            def unignore!
+                @ignored = false
+            end
+
+            def ignored?
+                !!@ignored
+            end
+            # ===================
+
+            def to_s
+                "#{@name}"
+            end
+        end
+    end
+end

data/lib/plugins/corecommands.rb

@@ -0,0 +1,53 @@
+plugin = Plugin.new "corecommands"
+
+plugin.handle(/^date$/i) do |data|
+    next data[:room].say Time.now.localtime.strftime "%a, %d %b %Y %T %z"
+end
+
+plugin.handle(/^ping$/i) do |data, args|
+    if args.empty? then
+        next data[:room].say "ping needs more arguments"
+    end
+
+    if args[0].match(/[^a-z0-9\.-]/i) then
+        next data[:room].say "invalid characters in argument"
+    end
+
+    Thread.new do
+        ping = `/bin/ping -w 3 -c 1 -- #{args[0]} 2>&1`
+
+        if ping.match /unknown host (.+)/ then
+            data[:room].say "unknown host #{$1}"
+        elsif ping.match /^(64 bytes.+)/ then
+            data[:room].say "#{$1}"
+        elsif ping.match /0 received/m then
+            data[:room].say "no reply :-("
+        else
+            data[:room].say "bogus hostname"
+        end
+
+        next
+    end
+end
+
+plugin.handle(/^host$/i) do |data, args|
+    if args.empty? then
+        next data[:room].say "host needs more arguments"
+    end
+
+    if args[0].match(/^a-z0-9\.-/i) then
+        next data[:room].say "invalid characters in argument"
+    end
+
+    Thread.new do
+        host = `/usr/bin/host #{args[0]} 2>&1`
+        lines = host.split(/\n/)
+        lines.take(3).each do |line|
+            data[:room].say line
+        end
+
+        next
+    end
+end
+
+$bot.plugins.add(plugin)

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification
+name: fantasy-irc
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Jens Becker
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: array-unique
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.1
+description: A modular, event-driven IRC client/bot gem for Ruby with plugin support
+email:
+- v2px@v2px.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.md
+- README.md
+- docs/PLUGINS.md
+- docs/example.rb
+- fantasy-irc.gemspec
+- lib/fantasy-irc.rb
+- lib/fantasy-irc/events.rb
+- lib/fantasy-irc/irc.rb
+- lib/fantasy-irc/plugins.rb
+- lib/fantasy-irc/rooms.rb
+- lib/fantasy-irc/users.rb
+- lib/plugins/corecommands.rb
+homepage: https://github.com/v2px/fantasy-irc
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: fantasy-irc
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: A modular, event-driven IRC client/bot gem for Ruby with plugin support
+test_files: []