rflow-components-irc 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

data/Rakefile

@@ -0,0 +1,15 @@
+require 'bundler'
+require 'rspec/core/rake_task'
+require 'rdoc/task'
+Bundler::GemHelper.install_tasks
+
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.verbose = true
+  t.rspec_opts = '--tty --color'
+end
+
+Rake::RDocTask.new do |rd|
+  rd.main = "README"
+  rd.rdoc_files.include("README", "lib/**/*.rb")
+  rd.rdoc_dir = File.join('doc', 'html')
+end

data/lib/rflow/components/irc/client.rb

@@ -0,0 +1,216 @@
+require 'eventmachine'
+
+require 'rflow'
+
+class RFlow
+  module Components
+    module IRC
+
+      class Client < RFlow::Component
+        input_port :to_server
+        output_port :from_server
+
+        attr_accessor :config
+        attr_accessor :client_connection
+
+        attr_accessor :server, :port
+
+        DEFAULT_CONFIG = {
+          'server' => '127.0.0.1',
+          'port' => 6667,
+          'server_password' => nil,
+          'nickname' => 'rflow',
+          'username' => 'rflow',
+          'oper_user' => nil,
+          'oper_password' => nil,
+          'nickserv_password' => nil,
+          'reconnect_interval' => 2,
+        }
+
+        def configure!(config)
+          @config = DEFAULT_CONFIG.merge config
+
+          @config['port'] = @config['port'].to_i
+          @config['reconnect_interval'] = @config['reconnect_interval'].to_i
+          # TODO: More config sanitization
+
+          @server = @config['server']
+          @port = @config['port'].to_i
+        end
+
+        def run!
+          @client_connection = EM.connect(@server, @port, Connection) do |conn|
+            conn.client = self
+          end
+        end
+
+        def process_message(input_port, input_port_key, connection, message)
+          RFlow.logger.debug "Received a message"
+          return unless message.data_type_name == 'RFlow::Message::Data::IRC::Message'
+
+          RFlow.logger.debug "Received an IRC::Message message, determining if its mine"
+          my_events = message.provenance.find_all {|processing_event| processing_event.component_instance_uuid == instance_uuid}
+          RFlow.logger.debug "Found #{my_events.size} processing events from me"
+          # Attempt to send the data to each context match
+          my_events.each do |processing_event|
+            RFlow.logger.debug "Inspecting context #{client_connection.signature.to_s} == #{processing_event.context.to_s}"
+            if client_connection.signature.to_s == processing_event.context.to_s
+              RFlow.logger.debug "Found connection for #{processing_event.context}"
+              client_connection.send_irc_message message
+            end
+          end
+        end
+
+        def shutdown!
+        end
+
+        def cleanup!
+        end
+
+        class Connection < EventMachine::Connection
+          include EventMachine::Protocols::LineText2
+
+          IRC_LINE_REGEX = /^(?::(\S+) )?(\S+)(?: (.+))?$/
+
+          attr_accessor :client
+          attr_reader :client_ip, :client_port, :server_ip, :server_port
+
+          def post_init
+            @client_port, @client_ip = Socket.unpack_sockaddr_in(get_peername) rescue ["?", "?.?.?.?"]
+            @server_port, @server_ip = Socket.unpack_sockaddr_in(get_sockname) rescue ["?", "?.?.?.?"]
+            RFlow.logger.debug "Connection from #{@client_ip}:#{@client_port} to #{@server_ip}:#{@server_port}"
+            super
+          end
+
+
+          def connection_completed
+            @reconnecting = false
+            @connected = true
+
+            RFlow.logger.info("Connected to IRC server #{client.config['server']}:#{client.config['port']}")
+
+            command "PASS", [client.config['server_password']] unless client.config['server_password'].nil?
+            command "NICK", [client.config['nickname']]
+            command "USER", [client.config['username'], client.config['username'], client.config['username'], client.config['username']]
+            command "NickServ IDENTIFY", [client.config['nickname'], client.config['nickserv_password']] unless client.config['nickserv_password'].nil?
+            command "OPER", [client.config['oper_user'] || client.config['nickname'], client.config['oper_password']] unless client.config['oper_password'].nil?
+          end
+
+
+          def receive_line(line)
+            RFlow.logger.debug("IRCClient#receive_line: #{line}")
+            processing_event = RFlow::Message::ProcessingEvent.new(client.instance_uuid, Time.now.utc)
+
+            prefix, cmd, params = parse_irc_line(line)
+
+            # Now have an optional prefix, required cmd, and optional
+            # param array
+
+            case cmd
+            when /PING/
+              command('PONG', params)
+            else
+              # create an IRC message here and send it along
+              RFlow.logger.debug("Sending IRC message '#{line}', signature '#{signature.class}:#{signature}', '#{signature.to_s.class}:#{signature.to_s}'")
+              irc_message = RFlow::Message.new('RFlow::Message::Data::IRC::Message')
+
+              irc_message.data.prefix = prefix
+              irc_message.data.command = cmd
+              irc_message.data.parameters = params
+
+              processing_event.context = signature.to_s
+              processing_event.completed_at = Time.now.utc
+              irc_message.provenance << processing_event
+
+              client.from_server.send_message irc_message
+            end
+          end
+
+
+          def unbind(reason=nil)
+            if @connected or @reconnecting
+              RFlow.logger.error("Disconnected from IRC server #{client.config['server']}:#{client.config['port']} due to '#{reason}', reconnecting ...")
+              EM.add_timer(client.config['reconnect_interval']) do
+                RFlow.logger.error "Attempting reconnect to IRC server #{client.config['server']}:#{client.config['port']}"
+                reconnect(client.config['server'], client.config['port'])
+              end
+              @connected = false
+              @reconnecting = true
+            else
+              error_message = "Unable to connect to IRC server #{client.config['server']}:#{client.config['port']} due to '#{reason}'"
+              RFlow.logger.error error_message
+              raise RuntimeError, error_message
+            end
+          end
+
+
+          def parse_irc_line(line)
+            match = IRC_LINE_REGEX.match(line)
+            unless match
+              RFlow.logger.error "Error parsing IRC line '#{line}'"
+              return
+            end
+
+            prefix, cmd, param_string = match[1..3]
+
+            param_string, trailing_param = param_string.split(' :', 1)
+            params = param_string.split(' ')
+            params << trailing_param
+
+            [prefix, cmd, params]
+          end
+
+
+          def send_irc_message(irc_message)
+            RFlow.logger.debug "Sending an IRC message to #{client_ip}:#{client_port}"
+
+            command irc_message.data.command, irc_message.data.parameters, irc_message.data.prefix
+          end
+
+
+          def send_irc_line(line)
+            RFlow.logger.debug "Sending line '#{line}'"
+            send_data "#{line}\r\n"
+          end
+
+
+          def privmsg(nick, msg)
+            msg.split("\n").each do |msg_line|
+              command("PRIVMSG #{nick} :#{msg_line}")
+            end
+          end
+
+
+          def command(cmd, args=[], prefix=nil)
+            RFlow.logger.debug("command: '#{cmd}' with args ['#{args.join("', '")}'] and prefix '#{prefix}'")
+            line = ''
+            if prefix
+              line << ":#{prefix} "
+            end
+
+
+            line << cmd.upcase
+
+            last_arg = args.pop
+            unless args.empty?
+              line << " #{args.join ' '}"
+            end
+
+            if last_arg =~ /\s/
+              line << ' :' << last_arg
+            else
+              line << ' ' << last_arg
+            end
+
+            send_irc_line line
+          end
+
+
+        end
+
+      end
+
+    end
+  end
+end
+

data/lib/rflow/components/irc/extensions.rb

@@ -0,0 +1,27 @@
+class RFlow
+  module Components
+    module IRC
+
+      # The set of extensions to add capability to IRC data types
+      module Extensions
+
+        module IRCMessageExtension
+          def self.extended(base_data)
+            base_data.data_object ||= {'prefix' => nil, 'command' => 'PRIVMSG', 'parameters' => []}
+          end
+
+          # Default accessors
+          ['prefix', 'command', 'parameters'].each do |name|
+            define_method name do |*args|
+              data_object[name]
+            end
+            define_method :"#{name}=" do |*args|
+              data_object[name] = args.first
+            end
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/rflow/components/irc/version.rb

@@ -0,0 +1,7 @@
+class RFlow
+  module Components
+    module IRC
+      VERSION = "0.0.1"
+    end
+  end
+end

data/lib/rflow/components/irc.rb

@@ -0,0 +1,25 @@
+require 'rflow/components/irc/extensions'
+require 'rflow/components/irc/client'
+
+class RFlow
+  module Components
+    module IRC
+      # Load the schemas
+      SCHEMA_DIRECTORY = ::File.expand_path(::File.join(::File.dirname(__FILE__), '..', '..', '..', 'schema'))
+
+      SCHEMA_FILES = {
+        'irc_message.avsc'  => 'RFlow::Message::Data::IRC::Message',
+      }
+
+      SCHEMA_FILES.each do |file_name, data_type_name|
+        schema_string = ::File.read(::File.join(SCHEMA_DIRECTORY, file_name))
+        RFlow::Configuration.add_available_data_type data_type_name, 'avro', schema_string
+      end
+
+      # Load the data extensions
+      RFlow::Configuration.add_available_data_extension('RFlow::Message::Data::IRC::Message',
+                                                        RFlow::Components::IRC::Extensions::IRCMessageExtension)
+
+    end
+  end
+end

data/lib/rflow-components-irc.rb

@@ -0,0 +1,3 @@
+require 'rflow'
+require 'rflow/components/irc'
+

data/rflow-components-irc.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "rflow/components/irc/version"
+
+Gem::Specification.new do |s|
+  s.name        = "rflow-components-irc"
+  s.version     = RFlow::Components::IRC::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.required_ruby_version = '>= 1.9'
+  s.authors     = ["Michael L. Artz"]
+  s.email       = ["michael.artz@redjack.com"]
+  s.homepage    = "https://github.com/redjack/rflow-components-irc"
+  s.summary     = %q{IRC client and server components for the RFlow FBP framework}
+  s.description = %q{IRC client and server components for the RFlow FBP framework.  Also includes the necessary message types}
+
+  s.rubyforge_project = "rflow-components-irc"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency 'rflow', '~> 0.0.1'
+
+  s.add_development_dependency 'rspec', '~> 2.5.0'
+  s.add_development_dependency 'rake', '~> 0.8.7'
+end

data/schema/irc_message.avsc

@@ -0,0 +1,16 @@
+{
+    "type": "record",
+    "name": "Message",
+    "namespace": "org.rflow.message.data.irc",
+    "aliases": [],
+    "fields": [
+        {"name": "client_ip",    "type": ["string", "null"]},
+        {"name": "client_port",  "type": ["int", "null"]},
+        {"name": "server_ip",    "type": ["string", "null"]},
+        {"name": "server_port",  "type": ["int", "null"]},
+
+        {"name": "prefix",       "type": ["string", "null"]},
+        {"name": "command",      "type": "string"},
+        {"name": "parameters",   "type": {"type": "array", "items": ["bytes", "null"]}}
+    ]
+}

data/spec/extensions_spec.rb

@@ -0,0 +1,47 @@
+require 'spec_helper.rb'
+
+# describe RFlow::Components::File::Extensions::FileExtension do
+#   before(:each) do
+#     @schema_string = RFlow::Configuration.available_data_types['RFlow::Message::Data::File']['avro']
+#   end
+#
+#   it "should add the extension to RFlow::Configuration" do
+#     RFlow::Configuration.available_data_extensions['RFlow::Message::Data::File'].should include(described_class)
+#   end
+#
+#   it "should set the defaults" do
+#     file = RFlow::Message.new('RFlow::Message::Data::File')
+#
+#     file.data.path.should == '/'
+#     file.data.size.should == 0
+#     file.data.content.should == ''
+#     file.data.creation_timestamp.should == nil
+#     file.data.modification_timestamp.should == nil
+#     file.data.accessed_timestamp.should == nil
+#   end
+#
+#   it "should correctly use integers or strings for size field" do
+#     file = RFlow::Message.new('RFlow::Message::Data::File')
+#
+#     file.data.size.should == 0
+#     file.data.size = 10
+#     file.data.size.should == 10
+#     file.data.size = '20'
+#     file.data.size == 20
+#   end
+#
+#   it "should correctly use Time or xmlschema strings for timestamp fields" do
+#     file = RFlow::Message.new('RFlow::Message::Data::File')
+#
+#     file.data.creation_timestamp.should == nil
+#     now = Time.now
+#
+#     file.data.creation_timestamp = now
+#     file.data.creation_timestamp.should == Time.xmlschema(now.xmlschema(9))
+#
+#     file.data.creation_timestamp = now.xmlschema
+#     file.data.creation_timestamp.should == Time.xmlschema(now.xmlschema)
+#   end
+#
+#
+# end

data/spec/schema_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper.rb'
+
+describe 'RFlow::Message::Data::IRC::Message Avro Schema' do
+  before(:each) do
+    @schema_string = RFlow::Configuration.available_data_types['RFlow::Message::Data::IRC::Message']['avro']
+  end
+
+  it "should encode and decode an object" do
+    irc_message = {
+      #      'prefix'     => nil,
+      'command'    => 'PRIVMSG',
+      'parameters' => ['yo yo yo'],
+    }
+
+    expect {encode_avro(@schema_string, irc_message)}.to_not raise_error
+    avro_encoded_irc_message = encode_avro(@schema_string, irc_message)
+
+    expect {decode_avro(@schema_string, avro_encoded_irc_message)}.to_not raise_error
+    decoded_irc_message = decode_avro(@schema_string, avro_encoded_irc_message)
+
+    decoded_irc_message['prefix'].should == irc_message['prefix']
+    decoded_irc_message['command'].should == irc_message['command']
+    decoded_irc_message['parameters'].should == irc_message['parameters']
+
+  end
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,19 @@
+require File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib', 'rflow-components-irc'))
+
+require 'logger'
+
+def decode_avro(schema_string, serialized_object)
+  schema = Avro::Schema.parse(schema_string)
+  serialized_object.force_encoding 'BINARY'
+  sio = StringIO.new(serialized_object)
+  Avro::IO::DatumReader.new(schema, schema).read Avro::IO::BinaryDecoder.new(sio)
+end
+
+def encode_avro(schema_string, object)
+  encoded_string = ''
+  encoded_string.force_encoding 'BINARY'
+  schema = Avro::Schema.parse(schema_string)
+  sio = StringIO.new(encoded_string)
+  Avro::IO::DatumWriter.new(schema).write object, Avro::IO::BinaryEncoder.new(sio)
+  encoded_string
+end

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: rflow-components-irc
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Michael L. Artz
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rflow
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.0.1
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.5.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.7
+description: IRC client and server components for the RFlow FBP framework.  Also includes
+  the necessary message types
+email:
+- michael.artz@redjack.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Rakefile
+- lib/rflow-components-irc.rb
+- lib/rflow/components/irc.rb
+- lib/rflow/components/irc/client.rb
+- lib/rflow/components/irc/extensions.rb
+- lib/rflow/components/irc/version.rb
+- rflow-components-irc.gemspec
+- schema/irc_message.avsc
+- spec/extensions_spec.rb
+- spec/schema_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/redjack/rflow-components-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: '1.9'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: rflow-components-irc
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: IRC client and server components for the RFlow FBP framework
+test_files:
+- spec/extensions_spec.rb
+- spec/schema_spec.rb
+- spec/spec_helper.rb