rflow-components-irc 1.1.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bfb79dc8f8a832d4326d97e85f9ed6fb259a4f94
-  data.tar.gz: ef0d7d05223440784d24303cea0e9d7a0a2bdc3c
+  metadata.gz: fa57ef5f0c5a9c8a4ccfd2ee5b01f9dc92032538
+  data.tar.gz: da9b89c383e3d7250efa503d54fffb8fce163291
 SHA512:
-  metadata.gz: 8d102cf9be927b2a4ebb5e24a3f2b80b1bc36683065b7bc41299f972beb0786c5daad999192250e39757fd112bb067bcb7660debc9093515e8cfdfa3c8893205
-  data.tar.gz: cf64251f82bcd83ae7088b097df4c90eb55f31c3b9597222ed8a392522143ba71d798997f607c02db7e18d7475618437975d540dd97e7cc5998605c3e265a793
+  metadata.gz: 4dc2b8b1f33c7f545b500d4446da9cf3bd38b5ac189d0c07de9c65327f0ecab8bab93ec8901aa1c2f43b371c28cd15e609f05e1b4627d7f4c017410531c52349
+  data.tar.gz: 6fec0785928ef447592cf1ced7e07c6bfb2457fb02cff455f32e762f8f3009ef36f6f45890e49bb6f9432fcfa943db3d69f808293f8278eff94051b6b39041bc

data/.gitignore

@@ -2,3 +2,5 @@
 .bundle
 Gemfile.lock
 pkg/*
+doc/
+.yardoc/

data/.ruby-version

@@ -1 +1 @@
-ruby-2.1.2
+ruby-2.3.1

data/Gemfile

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

data/Rakefile

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

data/lib/rflow/components/irc.rb

@@ -1,12 +1,17 @@
 require 'rflow/components/irc/extensions'
 require 'rflow/components/irc/client'
 
+# RFlow classes.
 class RFlow
+  # RFlow component classes.
   module Components
+    # IRC RFlow component classes.
     module IRC
       # Load the schemas
+      # @!visibility private
       SCHEMA_DIRECTORY = ::File.expand_path(::File.join(::File.dirname(__FILE__), '..', '..', '..', 'schema'))
 
+      # @!visibility private
       SCHEMA_FILES = {
         'irc_message.avsc'  => 'RFlow::Message::Data::IRC::Message',
       }
@@ -21,9 +26,12 @@ class RFlow
                                                         RFlow::Components::IRC::Extensions::IRCMessageExtension)
 
       # Some useful IRC parsing methods
+      # @!visibility private
       IRC_LINE_REGEX = /^(?::(\S+) )?(\S+)(?: (.+))?$/
+      # @!visibility private
       IRC_PREFIX_REGEX = /^([^!]+)(?:!([^@]+))?(?:@(.*)+)?$/
 
+      # @!visibility private
       def self.parse_irc_line(line)
         match = IRC_LINE_REGEX.match(line)
         unless match
@@ -40,6 +48,7 @@ class RFlow
         [prefix, cmd, params]
       end
 
+      # @!visibility private
       def self.parse_irc_prefix(prefix)
         match = IRC_PREFIX_REGEX.match(prefix)
         unless match

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

@@ -2,20 +2,85 @@ require 'eventmachine'
 require 'rflow'
 
 class RFlow
+  # @!parse
+  #   # Fake classes in this tree to document the actual message types.
+  #   class Message
+  #     # Fake classes in this tree to document the actual message types.
+  #     class Data
+  #       # IRC messages.
+  #       module IRC
+  #         # RFlow format defined for IRC messages which can be emitted by
+  #         # {RFlow::Components::IRC::Client}. Of course the real class
+  #         # is {RFlow::Message} with type +RFlow::Message::Data::IRC::Message+.
+  #         class Message
+  #           # @!attribute timestamp
+  #           #   The timestamp of the message. Accepts a +Time+ or +String+.
+  #           #   @return [String] in XML schema format
+  #           #
+  #           # @!attribute prefix
+  #           #   The message prefix.
+  #           #   @return [String]
+  #           #
+  #           # @!attribute command
+  #           #   The IRC command.
+  #           #   @return [String]
+  #           #
+  #           # @!attribute parameters
+  #           #   IRC parameters.
+  #           #   @return [String]
+  #           #
+  #           # Just here to force Yard to create documentation.
+  #           # @!visibility private
+  #           def initialize; end
+  #         end
+  #       end
+  #     end
+  #   end
+
   module Components
     module IRC
+      # Component that subscribes to an IRC channel and issues +RFlow::Message+s
+      # of type {RFlow::Message::Data::IRC::Message} when it receives messages.
+      #
       # 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
+      #
+      # Accepts config parameters:
+      # - +server+ - server address
+      # - +port+ - server port
+      # - +server_password+ - server password, not sent if nil
+      # - +nickname+ - IRC nickname
+      # - +username+ - server username
+      # - +oper_user+ - op username, defaults to nickname if nil
+      # - +oper_password+ - op password
+      # - +nickserv_password+ - nickserv password, not sent if nil
+      # - +reconnect_interval+ - reconnect interval in seconds
+      # - +promiscuous+ - true to listen to all messages; false to listen only to those with provenance linking to us
       class Client < RFlow::Component
+        # @!attribute [r] to_server
+        #   Expects +RFlow::Message+s of type {RFlow::Message::Data::IRC::Message}
+        #   to be sent along the IRC channel.
+        #
+        #   @return [RFlow::Component::InputPort]
         input_port :to_server
+        # @!attribute [r] from_server
+        #   Outputs +RFlow::Message+s of type {RFlow::Message::Data::IRC::Message}
+        #   when receiving an IRC message.
+        #
+        #   @return [RFlow::Component::OutputPort]
         output_port :from_server
+        # @!attribute [r] log_port
+        #   Outputs +RFlow::Message+s of type {RFlow::Message:Data::Log}
+        #   when there are log messages to be emitted, as with reconnection problems.
+        #
+        #   @return [RFlow::Component::OutputPort]
         output_port :log_port
 
-        attr_accessor :config
-        attr_accessor :client_connection
-        attr_accessor :server, :port
+        # @!visibility private
+        attr_accessor :config, :client_connection, :server, :port
 
+        # Default configuration.
         DEFAULT_CONFIG = {
           'server' => '127.0.0.1',
           'port' => 6667,
@@ -29,6 +94,8 @@ class RFlow
           'promiscuous' => true,
         }
 
+        # RFlow-called method at startup.
+        # @return [void]
         def configure!(config)
           @config = DEFAULT_CONFIG.merge config
 
@@ -40,6 +107,8 @@ class RFlow
           @port = @config['port'].to_i
         end
 
+        # RFlow-called method at startup.
+        # @return [void]
         def run!
           @client_connection = EM.connect(@server, @port, Connection) do |conn|
             conn.client = self
@@ -47,6 +116,8 @@ class RFlow
           end
         end
 
+        # RFlow-called method at message arrival.
+        # @return [void]
         def process_message(input_port, input_port_key, connection, message)
           RFlow.logger.debug { "#{name}: Received a message" }
           return unless message.data_type_name == 'RFlow::Message::Data::IRC::Message'
@@ -70,18 +141,23 @@ class RFlow
           end
         end
 
+        # @!visibility private
         class Connection < EventMachine::Connection
           include EventMachine::Protocols::LineText2
 
+          # @!visibility private
           attr_accessor :client
+          # @!visibility private
           attr_reader :client_ip, :client_port, :server_ip, :server_port
 
+          # @!visibility private
           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 ["?", "?.?.?.?"]
             super
           end
 
+          # @!visibility private
           def connection_completed
             @reconnecting = false
             @connected = true
@@ -95,6 +171,7 @@ class RFlow
             command "OPER", [client.config['oper_user'] || client.config['nickname'], client.config['oper_password']] unless client.config['oper_password'].nil?
           end
 
+          # @!visibility private
           def receive_line(line)
             RFlow.logger.debug { "#{client.name}: IRCClient#receive_line: #{line}" }
             prefix, cmd, params = IRC.parse_irc_line(line)
@@ -119,6 +196,7 @@ class RFlow
             end
           end
 
+          # @!visibility private
           def unbind(reason = nil)
             if @connected || @reconnecting
               RFlow.logger.error "#{client.name}: Disconnected from IRC server #{client.config['server']}:#{client.config['port']} due to '#{reason}', reconnecting ..."
@@ -140,16 +218,19 @@ class RFlow
             end
           end
 
+          # @!visibility private
           def send_irc_message(irc_message)
             RFlow.logger.debug { "#{client.name}: Sending an IRC message to #{client_ip}:#{client_port}" }
             command irc_message.data.command, irc_message.data.parameters, irc_message.data.prefix
           end
 
+          # @!visibility private
           def send_irc_line(line)
             RFlow.logger.debug { "#{client.name}: Sending line '#{line}'" }
             send_data "#{line}\r\n"
           end
 
+          # @!visibility private
           def command(cmd, args = [], prefix = nil)
             RFlow.logger.debug { "#{client.name}: command: '#{cmd}' with args ['#{args.join("', '")}'] and prefix '#{prefix}'" }
             line = ''

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

@@ -1,8 +1,11 @@
 class RFlow
   module Components
     module IRC
+      # @!visibility private
       module Extensions
+        # @!visibility private
         module IRCMessageExtension
+          # @!visibility private
           def self.extended(base_data)
             base_data.data_object ||= {'timestamp' => Time.now.xmlschema, 'prefix' => nil, 'command' => 'PRIVMSG', 'parameters' => []}
           end

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

@@ -1,7 +1,8 @@
 class RFlow
   module Components
     module IRC
-      VERSION = "1.1.0"
+      # The gem version.
+      VERSION = "1.1.1"
     end
   end
 end

data/rflow-components-irc.gemspec

@@ -26,4 +26,5 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'rspec', '~> 3.0'
   s.add_development_dependency 'rspec-collection_matchers', '~> 1.0'
   s.add_development_dependency 'rake', '>= 10.3'
+  s.add_development_dependency 'yard', '~> 0.9'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rflow-components-irc
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.1
 platform: ruby
 authors:
 - Michael L. Artz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-31 00:00:00.000000000 Z
+date: 2017-10-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rflow
@@ -72,6 +72,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '10.3'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
 description: IRC client and server components for the RFlow FBP framework.  Also includes
   the necessary message types
 email:
@@ -118,7 +132,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: rflow-components-irc
-rubygems_version: 2.2.2
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: IRC client and server components for the RFlow FBP framework