rflow-components-amqp 1.1.1 → 1.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 49fbe0cc1e4c8dbbbacfc9dc469b710b4309b453
-  data.tar.gz: 8df93faee9c848a277287b179ef29422c1e83792
+  metadata.gz: 414abeef9741db55a09645e77f089bf0b6dc03ce
+  data.tar.gz: d089580659a2a37706f19e76ae819b916775692d
 SHA512:
-  metadata.gz: b0312a5ad446b23425fc44b2c74005efb1a3abbf052446a93680128e357345930b508b21933eee69c008a84429b7597e8802ca3bf565f75a0637adec1cce4d0d
-  data.tar.gz: b31ce6f7a5c3805fec5b0d7f04921cf5611c9ac1c84bf4667699f0cb39ebcd30267c2126d13184f377e0a7ccc72051bdbf40cdb07f297e4712f5fc445c30f1f3
+  metadata.gz: 148d61bc35cdd305f879ed0ae0b1a3d80196eed52e29122bfa9c787c1d8a5d43474789bdcf519581fe97a11ca7c22a260838c8bb3fd73e6036905b3076c2076b
+  data.tar.gz: 1c06feb76f1141a22d434dfbeaaee9ac3a7664cdcd56043a0eba7cd627a48726687c1237c19f4c1f75d660d338fa81e342d1c12507c6d17ef9c0ee931fd160a1

data/.gitignore

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

data/.yardopts

@@ -0,0 +1 @@
+--output ./doc --main README.md --files schema/*.avsc lib/**/*.rb - README.md LICENSE

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/amqp.rb

@@ -1,12 +1,17 @@
 require 'rflow/components/amqp/extensions'
 require 'rflow/components/amqp/subscriber'
 
+# RFlow classes.
 class RFlow
+  # RFlow component classes.
   module Components
+    # AMQP RFlow component classes.
     module AMQP
       # Load the schemas
+      # @!visibility private
       SCHEMA_DIRECTORY = ::File.expand_path(::File.join(::File.dirname(__FILE__), '..', '..', '..', 'schema'))
 
+      # @!visibility private
       SCHEMA_FILES = {
         'amqp_message.avsc'  => 'RFlow::Message::Data::AMQP::Message',
       }

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

@@ -1,8 +1,11 @@
 class RFlow
   module Components
     module AMQP
+      # @!visibility private
       module Extensions
+        # @!visibility private
         module AMQPMessageExtension
+          # @!visibility private
           def self.extended(base_data)
             base_data.data_object ||= {'header' => {}, 'payload' => ''}
           end

data/lib/rflow/components/amqp/subscriber.rb

@@ -4,18 +4,82 @@ require 'rflow'
 require 'time'
 
 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
+  #       # AMQP messages.
+  #       module AMQP
+  #         # RFlow format defined for AMQP messages which can be emitted by
+  #         # {RFlow::Components::AMQP::Subscriber}. Of course the real class
+  #         # is {RFlow::Message} with type +RFlow::Message::Data::AMQP::Message+.
+  #         class Message
+  #           # @!attribute header
+  #           #   The header of the message.
+  #           #   @return [String]
+  #
+  #           # @!attribute payload
+  #           #   The payload of the message.
+  #           #   @return [String]
+  #
+  #           # Just here to force Yard to create documentation.
+  #           # @!visibility private
+  #           def initialize; end
+  #         end
+  #       end
+  #     end
+  #   end
+
+  # Components.
   module Components
     module AMQP
+      # Component that subscribes to an AMQP topic and issues +RFlow::Message+s
+      # of type {RFlow::Message::Data::AMQP::Message} and +RFlow::Message::Data::Raw+
+      # when it receives messages on the AMQP topic.
+      #
       # By default will use an exclusive, non-durable, auto-deleting,
       # randomly named queue for subscribing to topic messages with an
-      # empty-string pattern
+      # empty-string pattern.
+      #
+      # Accepts config parameters:
+      # - +server+ - server address
+      # - +port+ - server port
+      # - +username+ - server username
+      # - +password+ - server password
+      # - +vhost+ - vhost
+      # - +reconnect_interval+ - how long to wait when disconnected before reconnecting
+      # - +queue_name+ - AMQP topic name to monitor
+      # - +queue_passive+ - +queue_passive+ parameter to AMQP
+      # - +queue_durable+ - +queue_durable+ parameter to AMQP
+      # - +queue_exclusive+ - +queue_exclusive+ parameter to AMQP
+      # - +queue_auto_delete+ - +queue_auto_delete+ parameter to AMQP
+      # - +binding_pattern+ - AMQP routing key
       class Subscriber < RFlow::Component
+        # @!attribute [r] amqp_port
+        #   Outputs +RFlow::Message+s of type {RFlow::Message::Data::AMQP::Message}
+        #   when receiving an AMQP message.
+        #
+        #   @return [RFlow::Component::OutputPort]
         output_port :amqp_port
+
+        # @!attribute [r] raw_port
+        #   Outputs +RFlow::Message+s of type +RFlow::Message::Data::Raw+
+        #   when receiving an AMQP message. Messages contain just the bytes.
+        #
+        #   @return [RFlow::Component::OutputPort]
         output_port :raw_port
+
+        # @!attribute [r] log_port
+        #   Outputs +RFlow::Message+s of type {RFlow::Message:Data::Log} if there
+        #   are problems with the AMQP subscriber..
+        #   @return [RFlow::Component::OutputPort]
         output_port :log_port
 
+        # @!visibility private
         attr_accessor :config, :queue_config
 
+        # Default config.
         DEFAULT_CONFIG = {
           'server' => '127.0.0.1',
           'port' => 5672,
@@ -33,6 +97,8 @@ class RFlow
           'binding_pattern' => '',
         }
 
+        # RFlow-called method at startup.
+        # @return [void]
         def configure!(config)
           @config = DEFAULT_CONFIG.merge config
           @config['port'] = @config['port'].to_i
@@ -51,6 +117,8 @@ class RFlow
           end
         end
 
+        # RFlow-called method at startup.
+        # @return [void]
         def run!
           ::AMQP.connect(:host => @config['server'], :port => @config['port'], :vhost => @config['vhost'],
                          :username => @config['username'], :password => @config['password']) do |conn|
@@ -100,6 +168,7 @@ class RFlow
           end
         end
 
+        # @!visibility private
         def to_boolean(string)
           case string
           when /^true$/i, '1', true; true

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

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

data/rflow-components-amqp.gemspec

@@ -28,4 +28,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-amqp
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.1.2
 platform: ruby
 authors:
 - Michael L. Artz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-11 00:00:00.000000000 Z
+date: 2017-10-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rflow
@@ -100,6 +100,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: AMQP publisher and subscriber component for the RFlow FBP framework.  Also
   includes the necessary AMQP::Message message type
 email:
@@ -113,6 +127,7 @@ files:
 - ".ruby-gemset"
 - ".ruby-version"
 - ".travis.yml"
+- ".yardopts"
 - Gemfile
 - LICENSE
 - README.md