krakow 0.3.4 → 0.3.6

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6c4b142c9d4c137f48a3f4c863185346d6111e37
+  data.tar.gz: 56732c8b17e13d4e9d0b77880ac6658642e8cac6
+SHA512:
+  metadata.gz: c8eff9207bbb250463f617befeb032f3a609744d0341f44d797dae80d0eb934ee27a630e7472d0ac6c08ed41b5c5c8cad5fc832dae26cd932a9d0e80909b1bd0
+  data.tar.gz: 8cb47618a5ba19cf26b3194c9a983f7b4e399ea387d8fd0258b0eb2361f39313c1b8e04c10c14d412ac9c32e310d53bd7d5051a3f7741b16fa8187f915399e96

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## v0.3.6
+* Allow `:options` key within `Producer` to set low level connection settings
+* Make snappy an optional dependency
+* Add initial support for authentication
+* Update allowed types for optional notifier
+
 ## v0.3.4
 * Explicitly require version file (#11 and #12)
 

data/README.md

@@ -159,6 +159,11 @@ consumer = Krakow::Consumer.new(
 )
 ```
 
+*NOTE*: snappy support requires the snappy
+gem and is not provided by default, so you
+will need to ensure it is installed either
+on the system, or within the bundle.
+
 ### I need Deflate compression!
 
 OK!

data/krakow.gemspec

@@ -13,7 +13,6 @@ Gem::Specification.new do |s|
   s.add_dependency 'celluloid-io'
   s.add_dependency 'http'
   s.add_dependency 'multi_json'
-  s.add_dependency 'snappy'
   s.add_dependency 'digest-crc'
   s.files = Dir['lib/**/*'] + %w(krakow.gemspec README.md CHANGELOG.md CONTRIBUTING.md LICENSE)
   s.extra_rdoc_files = %w(CHANGELOG.md CONTRIBUTING.md LICENSE)

data/lib/krakow/command/auth.rb

@@ -0,0 +1,36 @@
+require 'krakow'
+
+module Krakow
+  class Command
+    # Publish single message
+    class Auth < Command
+
+      # @!group Attributes
+
+      # @!macro [attach] attribute
+      #   @!method $1
+      #     @return [$2] the $1 $0
+      #   @!method $1?
+      #     @return [TrueClass, FalseClass] truthiness of the $1 $0
+      attribute :secret, String, :required => true
+
+      # @!endgroup
+
+      def to_line
+        scrt = secret.to_s
+        [name, "\n", scrt.length, scrt].pack('a*a*a*a*l>a*')
+      end
+
+      class << self
+        def ok
+          %w(OK)
+        end
+
+        def error
+          %w(E_AUTH_FAILED E_UNAUTHORIZED)
+        end
+      end
+
+    end
+  end
+end

data/lib/krakow/connection.rb

@@ -33,14 +33,15 @@ module Krakow
       :deflate_level,
       :max_deflate_level,
       :snappy,
-      :sample_rate
+      :sample_rate,
+      :auth_required
     ]
 
     # List of features that may not be enabled together
     EXCLUSIVE_FEATURES = [[:snappy, :deflate]]
 
     # List of features that may be enabled by the client
-    ENABLEABLE_FEATURES = [:tls_v1, :snappy, :deflate]
+    ENABLEABLE_FEATURES = [:tls_v1, :snappy, :deflate, :auth_required]
 
     finalizer :goodbye_my_love!
 
@@ -66,7 +67,7 @@ module Krakow
     attribute :queue, Queue, :default => ->{ Queue.new }
     attribute :callbacks, Hash, :default => ->{ Hash.new }
     attribute :responses, Queue, :default => ->{ Queue.new }
-    attribute :notifier, Celluloid::Actor
+    attribute :notifier, [Celluloid::Signals, Celluloid::Condition, Celluloid::Actor]
     attribute :features, Hash, :default => ->{ Hash.new }
     attribute :response_wait, Numeric, :default => 1.0
     attribute :response_interval, Numeric, :default => 0.03
@@ -343,6 +344,21 @@ module Krakow
       true
     end
 
+    # Send authentication request for connection
+    #
+    # @return [TrueClass]
+    def auth_required
+      info 'Authentication required for this connection'
+      if(feature_args[:auth])
+        transmit(Command::Auth.new(:secret => feature_args[:auth]))
+        response = receive
+        true
+      else
+        error 'No authentication information provided for connection!'
+        abort 'Authentication failure. No authentication secret provided'
+      end
+    end
+
     # Enable snappy feature on underlying socket
     #
     # @return [TrueClass]

data/lib/krakow/connection_features/snappy_frames.rb

@@ -1,4 +1,9 @@
-require 'snappy'
+begin
+  require 'snappy'
+rescue LoadError
+  $stderr.puts 'ERROR: Failed to locate `snappy` gem. Install `snappy` gem into system or bundle.'
+  raise
+end
 require 'digest/crc'
 require 'krakow'
 

data/lib/krakow/consumer.rb

@@ -31,7 +31,7 @@ module Krakow
     attribute :backoff_interval, Numeric
     attribute :discovery_interval, Numeric, :default => 30
     attribute :discovery_jitter, Numeric, :default => 10.0
-    attribute :notifier, Celluloid::Actor
+    attribute :notifier, [Celluloid::Signals, Celluloid::Condition, Celluloid::Actor]
     attribute :connection_options, Hash, :default => ->{ Hash.new }
 
     # @!endgroup

data/lib/krakow/producer.rb

@@ -36,7 +36,7 @@ module Krakow
 
     def initialize(args={})
       super
-      arguments[:connection_options] = {:features => {}, :config => {}}.merge(
+      arguments[:connection_options] = {:features => {}, :config => {}, :options => {}}.merge(
         arguments.fetch(:connection_options, {})
       )
       connect
@@ -48,12 +48,17 @@ module Krakow
     def connect
       info "Establishing connection to: #{host}:#{port}"
       begin
-        @connection = Connection.new(
-          :host => host,
-          :port => port,
-          :features => connection_options[:features],
-          :features_args => connection_options[:config]
-        )
+        con_args = connection_options[:options].dup.tap do |args|
+          args[:host] = host
+          args[:port] = port
+          if(connection_options[:features])
+            args[:features] = connection_options[:features]
+          end
+          if(connection_options[:config])
+            args[:features_args] = connection_options[:config]
+          end
+        end
+        @connection = Connection.new(con_args)
         connection.init!
         self.link connection
         info "Connection established: #{connection}"

data/lib/krakow/version.rb

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

metadata

@@ -1,94 +1,69 @@
 --- !ruby/object:Gem::Specification
 name: krakow
 version: !ruby/object:Gem::Version
-  version: 0.3.4
-  prerelease: 
+  version: 0.3.6
 platform: ruby
 authors:
 - Chris Roberts
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-16 00:00:00.000000000 Z
+date: 2014-12-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: celluloid-io
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: http
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: multi_json
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: snappy
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: digest-crc
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: NSQ ruby library
@@ -100,67 +75,67 @@ extra_rdoc_files:
 - CONTRIBUTING.md
 - LICENSE
 files:
+- CHANGELOG.md
+- CONTRIBUTING.md
+- LICENSE
+- README.md
+- krakow.gemspec
 - lib/krakow.rb
-- lib/krakow/consumer.rb
-- lib/krakow/frame_type.rb
 - lib/krakow/command.rb
-- lib/krakow/version.rb
-- lib/krakow/distribution.rb
-- lib/krakow/utils/lazy.rb
-- lib/krakow/utils/logging.rb
-- lib/krakow/producer.rb
-- lib/krakow/producer/http.rb
-- lib/krakow/distribution/default.rb
-- lib/krakow/frame_type/response.rb
-- lib/krakow/frame_type/error.rb
-- lib/krakow/frame_type/message.rb
-- lib/krakow/command/pub.rb
+- lib/krakow/command/auth.rb
 - lib/krakow/command/cls.rb
-- lib/krakow/command/touch.rb
 - lib/krakow/command/fin.rb
 - lib/krakow/command/identify.rb
-- lib/krakow/command/req.rb
-- lib/krakow/command/nop.rb
 - lib/krakow/command/mpub.rb
-- lib/krakow/command/sub.rb
+- lib/krakow/command/nop.rb
+- lib/krakow/command/pub.rb
 - lib/krakow/command/rdy.rb
+- lib/krakow/command/req.rb
+- lib/krakow/command/sub.rb
+- lib/krakow/command/touch.rb
 - lib/krakow/connection.rb
-- lib/krakow/exceptions.rb
-- lib/krakow/utils.rb
-- lib/krakow/discovery.rb
 - lib/krakow/connection_features.rb
-- lib/krakow/connection_features/ssl.rb
-- lib/krakow/connection_features/snappy_frames.rb
 - lib/krakow/connection_features/deflate.rb
-- krakow.gemspec
-- README.md
-- CHANGELOG.md
-- CONTRIBUTING.md
-- LICENSE
+- lib/krakow/connection_features/snappy_frames.rb
+- lib/krakow/connection_features/ssl.rb
+- lib/krakow/consumer.rb
+- lib/krakow/discovery.rb
+- lib/krakow/distribution.rb
+- lib/krakow/distribution/default.rb
+- lib/krakow/exceptions.rb
+- lib/krakow/frame_type.rb
+- lib/krakow/frame_type/error.rb
+- lib/krakow/frame_type/message.rb
+- lib/krakow/frame_type/response.rb
+- lib/krakow/producer.rb
+- lib/krakow/producer/http.rb
+- lib/krakow/utils.rb
+- lib/krakow/utils/lazy.rb
+- lib/krakow/utils/logging.rb
+- lib/krakow/version.rb
 homepage: http://github.com/chrisroberts/krakow
 licenses:
 - Apache 2.0
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 2.2.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: NSQ library
 test_files: []
 has_rdoc: