rflow-components-irc 0.0.1 → 0.0.2

data/.travis.yml

@@ -0,0 +1,21 @@
+language: ruby
+
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0
+
+before_install:
+  - sudo apt-get install libtool autoconf automake uuid-dev build-essential
+  - wget http://download.zeromq.org/zeromq-3.2.4.tar.gz && tar zxvf zeromq-3.2.4.tar.gz && cd zeromq-3.2.4 && ./configure && make && sudo make install && cd ..
+# Only has 4.0.4, need 3.2 version due to old em-zeromq
+#  - sudo add-apt-repository -y ppa:chris-lea/zeromq
+#  - sudo apt-get update
+#  - sudo apt-get install libzmq3 libzmq3-dev
+
+script: bundle exec rspec spec
+
+notifications:
+  hipchat:
+    rooms:
+      secure: nDBFcCoDdZPJ3YmJajpTPCvYjmHgmVi5jmXhXa1vbCvSNSNk4qOSQgSh53hZHBm7OeZOgjcih9ZnUwmzTCHxnJAzH6jX7gGH3nBYEzsINPWZ9E9P3P3Vmf/MQAh1BiK1Twpop7aCECxfHyRP7N3MHLFomGqkmIKPspwrrkQ6hpM=

data/LICENSE

@@ -0,0 +1,190 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2014 RedJack LLC
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,51 @@
+# RFlow-Components-IRC
+
+[![Build Status](https://travis-ci.org/redjack/rflow-components-irc.png?branch=master)](https://travis-ci.org/redjack/rflow-components-irc)
+
+A gem containing IRC-specific components and data types for RFlow
+(https://github.com/redjack/rflow).
+
+## Data Types
+
+* `RFlow::Message::Data::IRC::Message` - a IRC message data type
+
+## Client
+
+The IRC client component uses the underlying EventMachine LineText2
+protocol connection to connect to an IRC server (as defined by its
+configuration), accept RFlow messages to be sent to the sever on its
+`to_server` port, and send RFlow messages from the IRC sever out its
+`from_server` port.
+
+The component utilizes RFlow's message provenance to allow for
+discriminating between multiple IRC client components, so components
+that process IRC messages *must copy the provenance from the
+from-message to the to-message.*
+
+### Configuration
+
+* '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
+
+## License
+
+   Copyright 2014 RedJack LLC
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/Rakefile

@@ -9,7 +9,7 @@ RSpec::Core::RakeTask.new(:spec) do |t|
 end
 
 Rake::RDocTask.new do |rd|
-  rd.main = "README"
-  rd.rdoc_files.include("README", "lib/**/*.rb")
+  rd.main = "README.md"
+  rd.rdoc_files.include("README.md", "lib/**/*.rb")
   rd.rdoc_dir = File.join('doc', 'html')
 end

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

@@ -6,6 +6,9 @@ class RFlow
   module Components
     module IRC
 
+      # Assumes a single connection, meaning that it can choose to be
+      # 'promiscuous' and not limit its sending to only those messages
+      # derived from one of its own
       class Client < RFlow::Component
         input_port :to_server
         output_port :from_server
@@ -25,6 +28,7 @@ class RFlow
           'oper_password' => nil,
           'nickserv_password' => nil,
           'reconnect_interval' => 2,
+          'promiscuous' => true,
         }
 
         def configure!(config)
@@ -44,19 +48,26 @@ class RFlow
           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
+          if config['promiscuous']
+            RFlow.logger.debug "Received an IRC::Message message, sending to client connection"
+            client_connection.send_irc_message message
+          else
+            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.  TODO:
+            # check for correctness/
+            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}, sending message to associated client connection"
+                client_connection.send_irc_message message
+              end
             end
           end
         end
@@ -70,8 +81,6 @@ class RFlow
         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
 
@@ -101,7 +110,7 @@ class RFlow
             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)
+            prefix, cmd, params = IRC.parse_irc_line(line)
 
             # Now have an optional prefix, required cmd, and optional
             # param array
@@ -144,26 +153,8 @@ class RFlow
           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
 
@@ -174,13 +165,6 @@ class RFlow
           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 = ''
@@ -188,7 +172,6 @@ class RFlow
               line << ":#{prefix} "
             end
 
-
             line << cmd.upcase
 
             last_arg = args.pop
@@ -205,12 +188,8 @@ class RFlow
             send_irc_line line
           end
 
-
         end
-
       end
-
     end
   end
 end
-

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

@@ -7,7 +7,7 @@ class RFlow
 
         module IRCMessageExtension
           def self.extended(base_data)
-            base_data.data_object ||= {'prefix' => nil, 'command' => 'PRIVMSG', 'parameters' => []}
+            base_data.data_object ||= {'timestamp' => Time.now.xmlschema, 'prefix' => nil, 'command' => 'PRIVMSG', 'parameters' => []}
           end
 
           # Default accessors
@@ -15,10 +15,31 @@ class RFlow
             define_method name do |*args|
               data_object[name]
             end
+
             define_method :"#{name}=" do |*args|
               data_object[name] = args.first
             end
           end
+
+          # Timestamp Accessors.  Note, the precision of the
+          # XMLTimestamp is set to 9 digits, meaning that the time you
+          # put in might be slightly different from the time you read
+          # out.
+          ['timestamp'].each do |name|
+            define_method name do |*args|
+              data_object[name] ? Time.xmlschema(data_object[name]) : nil
+            end
+
+            define_method :"#{name}=" do |*args|
+              if args.first.is_a? Time
+                data_object[name] = args.first.xmlschema(9)
+              else
+                data_object[name] = args.first
+              end
+            end
+          end
+
+
         end
 
       end

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

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

data/lib/rflow/components/irc.rb

@@ -20,6 +20,39 @@ class RFlow
       RFlow::Configuration.add_available_data_extension('RFlow::Message::Data::IRC::Message',
                                                         RFlow::Components::IRC::Extensions::IRCMessageExtension)
 
+
+      # Some useful IRC parsing methods
+
+      IRC_LINE_REGEX = /^(?::(\S+) )?(\S+)(?: (.+))?$/
+      IRC_PREFIX_REGEX = /^([^!]+)(?:!([^@]+))?(?:@(.*)+)?$/
+
+      def self.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 if trailing_param
+
+        [prefix, cmd, params]
+      end
+
+      def self.parse_irc_prefix(prefix)
+        match = IRC_PREFIX_REGEX.match(prefix)
+        unless match
+          RFlow.logger.error "Error parsing IRC prefix '#{prefix}'"
+          return
+        end
+
+        # nick/server, user, host
+        match[1..3]
+      end
+
     end
   end
 end

data/rflow-components-irc.gemspec

@@ -9,6 +9,7 @@ Gem::Specification.new do |s|
   s.required_ruby_version = '>= 1.9'
   s.authors     = ["Michael L. Artz"]
   s.email       = ["michael.artz@redjack.com"]
+  s.license     = "Apache-2.0"
   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}

data/schema/irc_message.avsc

@@ -4,11 +4,7 @@
     "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": "timestamp",    "type": "string"},
         {"name": "prefix",       "type": ["string", "null"]},
         {"name": "command",      "type": "string"},
         {"name": "parameters",   "type": {"type": "array", "items": ["bytes", "null"]}}

data/spec/schema_spec.rb

@@ -7,6 +7,7 @@ describe 'RFlow::Message::Data::IRC::Message Avro Schema' do
 
   it "should encode and decode an object" do
     irc_message = {
+      'timestamp' => Time.now.xmlschema,
       #      'prefix'     => nil,
       'command'    => 'PRIVMSG',
       'parameters' => ['yo yo yo'],
@@ -24,4 +25,3 @@ describe 'RFlow::Message::Data::IRC::Message Avro Schema' do
 
   end
 end
-

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rflow-components-irc
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-17 00:00:00.000000000 Z
+date: 2014-03-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rflow
@@ -68,7 +68,10 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .travis.yml
 - Gemfile
+- LICENSE
+- README.md
 - Rakefile
 - lib/rflow-components-irc.rb
 - lib/rflow/components/irc.rb
@@ -81,7 +84,8 @@ files:
 - spec/schema_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/redjack/rflow-components-irc
-licenses: []
+licenses:
+- Apache-2.0
 post_install_message: 
 rdoc_options: []
 require_paths: