krakow 0.2.2 → 0.3.0

data/lib/krakow/producer.rb

@@ -1,9 +1,16 @@
+require 'krakow'
+
 module Krakow
+
+  # TCP based producer
   class Producer
 
     autoload :Http, 'krakow/producer/http'
 
     include Utils::Lazy
+    # @!parse include Utils::Lazy::InstanceMethods
+    # @!parse extend Utils::Lazy::ClassMethods
+
     include Celluloid
 
     trap_exit  :connection_failure
@@ -11,50 +18,79 @@ module Krakow
 
     attr_reader :connection
 
+    # @!group Attributes
+
+    # @!macro [attach] attribute
+    #   @!method $1
+    #     @return [$2] the $1 $0
+    #   @!method $1?
+    #     @return [TrueClass, FalseClass] truthiness of the $1 $0
+    attribute :host, String, :required => true
+    attribute :port, [String, Integer], :required => true
+    attribute :topic, String, :required => true
+    attribute :reconnect_retries, Integer, :default => 10
+    attribute :reconnect_interval, Integer, :default => 5
+    attribute :connection_options, Hash, :default => ->{ Hash.new }
+
+    # @!endgroup
+
     def initialize(args={})
       super
-      required! :host, :port, :topic
-      optional :reconnect_retries, :reconnect_interval, :connection_features
-      arguments[:reconnect_retries] ||= 10
-      arguments[:reconnect_interval] = 5
-      arguments[:connection_features] ||= {}
+      arguments[:connection_options] = {:features => {}, :config => {}}.merge(
+        arguments.fetch(:connection_options, {})
+      )
       connect
     end
 
     # Establish connection to configured `host` and `port`
+    #
+    # @return nil
     def connect
       info "Establishing connection to: #{host}:#{port}"
       begin
         @connection = Connection.new(
           :host => host,
           :port => port,
-          :features => connection_features
+          :features => connection_options[:features],
+          :features_args => connection_options[:config]
         )
-        self.link connection
         connection.init!
+        self.link connection
         info "Connection established: #{connection}"
+        nil
       rescue => e
         abort e
       end
     end
 
+    # @return [String] stringify object
     def to_s
       "<#{self.class.name}:#{object_id} {#{host}:#{port}} T:#{topic}>"
     end
 
-    # Return if connected
+    # @return [TrueClass, FalseClass] currently connected to server
     def connected?
-      connection && connection.alive?
+      !!(connection && connection.alive? && connection.connected?)
     end
 
     # Process connection failure and attempt reconnection
+    #
+    # @return [TrueClass]
     def connection_failure(*args)
-      warn "Connection has failed to #{host}:#{port}"
-      debug "Sleeping for reconnect interval of #{reconnect_interval} seconds"
-      sleep reconnect_interval
-      connect
+      @connection = nil
+      begin
+        warn "Connection failure detected for #{host}:#{port}"
+        connect
+      rescue => e
+        warn "Failed to establish connection to #{host}:#{port}. Pausing #{reconnect_interval} before retry"
+        sleep reconnect_interval
+        connect
+      end
+      true
     end
 
+    # Instance destructor
+    # @return nil
     def goodbye_my_love!
       debug 'Tearing down producer'
       if(connection && connection.alive?)
@@ -62,12 +98,19 @@ module Krakow
       end
       @connection = nil
       info 'Producer torn down'
+      nil
     end
 
-    # message:: Message to send
-    # Write message
+    # Write message to server
+    #
+    # @param message [String] message to write
+    # @return [Krakow::FrameType::Error,nil]
+    # @raise [Krakow::Error::ConnectionUnavailable]
     def write(*message)
-      if(connection.alive?)
+      if(message.empty?)
+        abort ArgumentError.new 'Expecting one or more messages to send. None provided.'
+      end
+      if(connection && connection.alive?)
         if(message.size > 1)
           debug 'Multiple message publish'
           connection.transmit(
@@ -86,7 +129,7 @@ module Krakow
           )
         end
       else
-        abort Error.new 'Remote connection is unavailable!'
+        abort Error::ConnectionUnavailable.new 'Remote connection is unavailable!'
       end
     end
 

data/lib/krakow/utils/lazy.rb

@@ -1,64 +1,123 @@
+require 'krakow'
+
 module Krakow
   module Utils
+    # Adds functionality to facilitate laziness
     module Lazy
 
       include Utils::Logging
 
-      attr_reader :arguments
+      # Instance methods for laziness
+      module InstanceMethods
+
+        # @return [Hash] argument hash
+        attr_reader :arguments
 
-      def initialize(args={})
-        @arguments = {}.tap do |hash|
-          args.each do |k,v|
-            hash[k.to_sym] = v
+        # Create new instance
+        #
+        # @param args [Hash]
+        # @return [Object]
+        def initialize(args={})
+          @arguments = {}.tap do |hash|
+            self.class.attributes.each do |name, options|
+              val = args[name]
+              if(options[:required] && !args.has_key?(name))
+                raise ArgumentError.new("Missing required option: `#{name}`")
+              end
+              if(val && options[:type] && !(valid = [options[:type]].flatten.compact).detect{|k| val.is_a?(k)})
+                raise TypeError.new("Invalid type for option `#{name}` (#{val} <#{val.class}>). Valid - #{valid.map(&:to_s).join(',')}")
+              end
+              if(val.nil? && options[:default] && !args.has_key?(name))
+                val = options[:default].respond_to?(:call) ? options[:default].call : options[:default]
+              end
+              hash[name] = val
+            end
           end
         end
+        alias_method :super_init, :initialize
+
+        # @return [String]
+        def to_s
+          "<#{self.class.name}:#{object_id}>"
+        end
+
+        # @return [String]
+        def inspect
+          "<#{self.class.name}:#{object_id} [#{arguments.inspect}]>"
+        end
+
       end
 
-      # args:: list of required keys
-      # Check that required keys exist in `arguments` hash. Raise
-      # error if not found
-      def required!(*args)
-        args.each do |key|
-          key = key.to_sym
-          unless(arguments.has_key?(key))
-            raise ArgumentError.new "Missing required option `#{key}`!"
+      # Class methods for laziness
+      module ClassMethods
+
+        # Add new attributes to class
+        #
+        # @param name [String]
+        # @param type [Class, Array<Class>]
+        # @param options [Hash]
+        # @option options [true, false] :required must be provided on initialization
+        # @option options [Object, Proc] :default default value
+        # @return [nil]
+        def attribute(name, type, options={})
+          name = name.to_sym
+          attributes[name] = {:type => type}.merge(options)
+          define_method(name) do
+            arguments[name.to_sym]
           end
-          define_singleton_method(key) do
-            arguments[key]
+          define_method("#{name}?") do
+            !!arguments[name.to_sym]
           end
-          if(key.match(/\w$/))
-            define_singleton_method("#{key}?".to_sym) do
-              !!arguments[key]
-            end
+          nil
+        end
+
+        # Return attributes
+        #
+        # @param args [Symbol] :required or :optional
+        # @return [Array<Hash>]
+        def attributes(*args)
+          @attributes ||= {}
+          if(args.include?(:required))
+            Hash[@attributes.find_all{|k,v| v[:required]}]
+          elsif(args.include?(:optional))
+            Hash[@attributes.find_all{|k,v| !v[:required]}]
+          else
+            @attributes
           end
         end
+
+        # Directly set attribute hash
+        #
+        # @param attrs [Hash]
+        # @return [TrueClass]
+        # @todo need deep dup here
+        def set_attributes(attrs)
+          @attributes = attrs.dup
+          true
+        end
+
       end
 
-      # args:: list of required keys
-      # Optional keys for arguments
-      def optional(*args)
-        args.each do |key|
-          key = key.to_sym
-          unless(arguments.has_key?(key))
-            arguments[key] = nil
-          end
-          define_singleton_method(key) do
-            arguments[key]
-          end
-          if(key.match(/\w$/))
-            define_singleton_method("#{key}?".to_sym) do
-              !!arguments[key]
+      class << self
+
+        # Injects laziness into class
+        #
+        # @param klass [Class]
+        def included(klass)
+          klass.class_eval do
+            include InstanceMethods
+            extend ClassMethods
+
+            class << self
+
+              def inherited(klass)
+                klass.set_attributes(self.attributes)
+              end
+
             end
           end
         end
-      end
-
-      def to_s
-        "<#{self.class.name}:#{object_id}>"
-      end
 
-      def inspect
-        "<#{self.class.name}:#{object_id} [#{arguments.inspect}]>"
       end
 
     end

data/lib/krakow/utils/logging.rb

@@ -1,5 +1,8 @@
+require 'krakow'
+
 module Krakow
   module Utils
+    # Logging helpers
     module Logging
 
       # Define base logging types
@@ -10,16 +13,24 @@ module Krakow
       end
 
       # Log message
+      #
+      # @param args [Array, nil]
+      # @return [Logger, nil]
       def log(*args)
         if(args.empty?)
           Celluloid::Logger
         else
           severity, string = args
           Celluloid::Logger.send(severity.to_sym, "#{self}: #{string}")
+          nil
         end
       end
 
       class << self
+        # Set the logging output level
+        #
+        # @param level [Integer]
+        # @return [Integer, nil]
         def level=(level)
           if(Celluloid.logger.class == Logger)
             Celluloid.logger.level = Logger.const_get(level.to_s.upcase.to_sym)

data/lib/krakow/utils.rb

@@ -1,4 +1,7 @@
+require 'krakow'
+
 module Krakow
+  # Helper utilities
   module Utils
     autoload :Lazy, 'krakow/utils/lazy'
     autoload :Logging, 'krakow/utils/logging'

data/lib/krakow/version.rb

@@ -1,5 +1,7 @@
 module Krakow
+  # Custom version
   class Version < Gem::Version
   end
-  VERSION = Version.new('0.2.2')
+  # Current version
+  VERSION = Version.new('0.3.0')
 end

data/lib/krakow.rb

@@ -1,6 +1,7 @@
 require 'celluloid/autostart'
 require 'multi_json'
 
+# NSQ client and producer library
 module Krakow
 
   autoload :Command, 'krakow/command'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: krakow
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-08 00:00:00.000000000 Z
+date: 2014-05-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: celluloid-io
@@ -95,7 +95,10 @@ description: NSQ ruby library
 email: code@chrisroberts.org
 executables: []
 extensions: []
-extra_rdoc_files: []
+extra_rdoc_files:
+- CHANGELOG.md
+- CONTRIBUTING.md
+- LICENSE
 files:
 - lib/krakow.rb
 - lib/krakow/consumer.rb
@@ -129,17 +132,14 @@ files:
 - lib/krakow/connection_features/ssl.rb
 - lib/krakow/connection_features/snappy_frames.rb
 - lib/krakow/connection_features/deflate.rb
-- test/spec.rb
-- test/specs/consumer.rb
-- test/specs/producer.rb
-- test/specs/http_producer.rb
-- Gemfile
-- README.md
 - krakow.gemspec
+- README.md
 - CHANGELOG.md
-- Gemfile.lock
+- CONTRIBUTING.md
+- LICENSE
 homepage: http://github.com/chrisroberts/krakow
-licenses: []
+licenses:
+- Apache 2.0
 post_install_message: 
 rdoc_options: []
 require_paths:

data/Gemfile

@@ -1,5 +0,0 @@
-source 'https://rubygems.org'
-
-gem 'minitest'
-
-gemspec

data/Gemfile.lock

@@ -1,34 +0,0 @@
-PATH
-  remote: .
-  specs:
-    krakow (0.1.3)
-      celluloid-io
-      digest-crc
-      http
-      multi_json
-      snappy
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    celluloid (0.15.2)
-      timers (~> 1.1.0)
-    celluloid-io (0.15.0)
-      celluloid (>= 0.15.0)
-      nio4r (>= 0.5.0)
-    digest-crc (0.4.0)
-    http (0.5.0)
-      http_parser.rb
-    http_parser.rb (0.6.0)
-    minitest (5.0.8)
-    multi_json (1.8.4)
-    nio4r (1.0.0)
-    snappy (0.0.10)
-    timers (1.1.0)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  krakow!
-  minitest

data/test/spec.rb

@@ -1,81 +0,0 @@
-require 'krakow'
-require 'minitest/autorun'
-
-module Krakow
-  class Test
-    class << self
-
-      def method_missing(*args)
-        name = method = args.first.to_s
-        if(name.end_with?('?'))
-          name = name.tr('?', '')
-        end
-        val = ENV[name.upcase] || ENV[name]
-        if(method.end_with?('?'))
-          !!val
-        else
-          val
-        end
-      end
-
-      def _topic
-        'krakow-test'
-      end
-
-      def _scrub_topic!
-        _http_producer.delete_topic
-      end
-
-      def _http_producer
-        @http_producer ||= Krakow::Producer::Http.new(
-          :endpoint => 'http://127.0.0.1:4151',
-          :topic => _topic
-        )
-      end
-
-      def _producer(args={})
-        Krakow::Producer.new(
-          {
-            :host => Krakow::Test.nsq_producer_host || '127.0.0.1',
-            :port => Krakow::Test.nsq_producer_port || 4150,
-            :topic => 'krakow-test'
-          }.merge(args)
-        )
-      end
-
-      def _consumer(args={})
-        Krakow::Consumer.new(
-          {
-            :nslookupd => Krakow::Test.nsq_lookupd || 'http://127.0.0.1:4161',
-            :topic => 'krakow-test',
-            :channel => 'default',
-            :discovery_interval => 0.5,
-            :max_in_flight => 20
-          }.merge(args)
-        )
-      end
-
-    end
-  end
-end
-
-MiniTest::Spec.before do
-  Celluloid.boot
-  Krakow::Test._scrub_topic!
-  @consumer = Krakow::Test._consumer
-  @producer = Krakow::Test._producer
-end
-
-MiniTest::Spec.after do
-  @consumer.terminate if @consumer && @consumer.alive?
-  @producer.terminate if @producer && @producer.alive?
-  Krakow::Test._scrub_topic!
-end
-
-unless(Krakow::Test.debug?)
-  Celluloid.logger.level = 3
-end
-
-Dir.glob(File.join(File.dirname(__FILE__), 'specs', '*.rb')).each do |path|
-  require File.expand_path(path)
-end

data/test/specs/consumer.rb

@@ -1,49 +0,0 @@
-describe Krakow do
-
-  describe Krakow::Consumer do
-
-    it 'should not have any connections' do
-      @consumer.connections.size.must_equal 0
-    end
-    it 'should have an empty queue' do
-      @consumer.queue.size.must_equal 0
-    end
-
-    describe 'with active producer' do
-
-      before do
-        @producer.write('msg1', 'msg2', 'msg3')
-        @inital_wait ||= sleep(0.8) # allow setup (topic creation, discovery, etc)
-      end
-
-      it 'should have one connection' do
-        @consumer.connections.size.must_equal 1
-      end
-      it 'should have three messages queued' do
-        @consumer.queue.size.must_equal 3
-      end
-      it 'should properly confirm messages' do
-        3.times do
-          msg = @consumer.queue.pop
-          @consumer.confirm(msg).must_equal true
-        end
-        sleep(0.5) # pause to let everything settle
-        @consumer.queue.must_be :empty?
-      end
-      it 'should properly requeue messages' do
-        2.times do
-          @consumer.confirm(@consumer.queue.pop)
-        end
-        @consumer.queue.size.must_equal 1
-        original_msg = @consumer.queue.pop
-        @consumer.queue.must_be :empty?
-        @consumer.requeue(original_msg).must_equal true
-        sleep(0.2)
-        @consumer.queue.size.must_equal 1
-        req_msg = @consumer.queue.pop
-        req_msg.message_id.must_equal original_msg.message_id
-      end
-
-    end
-  end
-end