nsqrb 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7690040858da3ff628ff511b8ae5e80aed8d9f6a
+  data.tar.gz: 5320e73575c124f494826c42437ddb6b74b955c1
+SHA512:
+  metadata.gz: 40ba74403f991222d4b76aad50cfeecbe9995fe7ce78d3d5164104ff732e4330530471217b9f61537217ddd6e2c8af720a0b95f3255d86433e74e751c82f8d54
+  data.tar.gz: a9e062affdf6dc3fb540442b5bd568ab683ea4cf9fdfc70e5c8ec7b1177164b9a6f937b4ec9315b0961c8391b1711f889f4536b03fc3046a10c771f76a61ae12

data/.gitignore

@@ -0,0 +1,34 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/Gemfile

@@ -0,0 +1,2 @@
+source "http://rubygems.com"
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Mikhail Salosin
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,4 @@
+nsqrb
+=====
+
+Basic NSQ ruby client library

data/lib/nsqrb/command/cls.rb

@@ -0,0 +1,14 @@
+module Nsqrb
+  class Command::Cls < Command
+
+    private
+
+      def success_codes
+        %w(CLOSE_WAIT)
+      end
+
+      def failure_codes
+        %w(E_INVALID)
+      end
+  end
+end

data/lib/nsqrb/command/fin.rb

@@ -0,0 +1,15 @@
+module Nsqrb
+  class Command::Fin < Command
+
+    private
+
+      def failure_codes
+        %w(E_INVALID E_FIN_FAILED)
+      end
+
+      def params
+        [:message_id]
+      end
+
+  end
+end

data/lib/nsqrb/command/identify.rb

@@ -0,0 +1,30 @@
+module Nsqrb
+  class Command::Identify < Command
+
+    def to_line
+      filtered = params.inject({}) do |hash, key|
+        hash[key] = @args[key] if @args[key].nil?
+        hash
+      end
+      payload = MultiJson.dump(filtered)
+      [name, "\n", payload.length, payload].pack('a*a*l>a*')
+    end
+
+    private
+
+      def success_codes
+        %w(OK)
+      end
+
+      def failure_codes
+        %w(E_INVALID E_BAD_BODY)
+      end
+
+      def params
+        [
+          :short_id, :long_id, :feature_negotiation, :heartbeat_interval, :output_buffer_size,
+          :output_buffer_timeout, :tls_v1, :snappy, :deflate, :deflate_level, :sample_rate
+        ]
+      end
+  end
+end

data/lib/nsqrb/command/nop.rb

@@ -0,0 +1,4 @@
+module Nsqrb
+  class Command::Nop < Command
+  end
+end

data/lib/nsqrb/command/pub.rb

@@ -0,0 +1,23 @@
+module Nsqrb
+  class Command::Pub < Command
+
+    def to_line
+      msg = @args[:message].to_s
+      [name, ' ', @args[:topic_name], "\n", msg.length, msg].pack('a*a*a*a*l>a*')
+    end
+
+    private
+
+      def success_codes
+        %w(OK)
+      end
+
+      def failure_codes
+        %w(E_INVALID E_BAD_TOPIC E_BAD_MESSAGE E_PUB_FAILED)
+      end
+
+      def params
+        [:topic_name, :message]
+      end
+  end
+end

data/lib/nsqrb/command/rdy.rb

@@ -0,0 +1,15 @@
+module Nsqrb
+  class Command::Rdy < Command
+
+    private
+
+      def failure_codes
+        %w(E_INVALID)
+      end
+
+      def params
+        [:count]
+      end
+
+  end
+end

data/lib/nsqrb/command/req.rb

@@ -0,0 +1,15 @@
+module Nsqrb
+  class Command::Req < Command
+
+    private
+
+      def failure_codes
+        %w(E_INVALID E_REQ_FAILED)
+      end
+
+      def params
+        [:message_id, :timeout]
+      end
+
+  end
+end

data/lib/nsqrb/command/sub.rb

@@ -0,0 +1,19 @@
+module Nsqrb
+  class Command::Sub < Command
+
+    private
+
+      def success_codes
+        %w(OK)
+      end
+
+      def failure_codes
+        %(E_INVALID E_BAD_TOPIC E_BAD_CHANNEL)
+      end
+
+      def params
+        [:topic_name, :channel_name]
+      end
+
+  end
+end

data/lib/nsqrb/command/touch.rb

@@ -0,0 +1,14 @@
+module Nsqrb
+  class Command::Touch < Command
+
+    private
+
+      def params
+        [:message_id]
+      end
+
+      def failure_codes
+        %w(E_INVALID E_TOUCH_FAILED)
+      end
+  end
+end

data/lib/nsqrb/command.rb

@@ -0,0 +1,50 @@
+module Nsqrb
+  class Command
+
+    def initialize(args = {})
+      @args = args
+    end
+
+    def to_line
+      "#{command}\n"
+    end
+
+    # Is response OK
+    def ok?(response)
+      response = response.content if response.is_a?(FrameType)
+      self.class.ok.include?(response)
+    end
+
+    # Is response ERROR
+    def error?(response)
+      response = response.content if response.is_a?(FrameType)
+      self.class.error.include?(response)
+    end
+
+    private
+
+      def command
+        values.unshift(name).join(' ')
+      end
+
+      def success_codes
+        []
+      end
+
+      def failure_codes
+        []
+      end
+
+      def params
+        []
+      end
+
+      def values
+        params.map { |param| @args[param] }
+      end
+
+      def name
+        self.class.name.split('::').last.upcase
+      end
+  end
+end

data/lib/nsqrb/consumer.rb

@@ -0,0 +1,81 @@
+module Nsqrb
+  class Consumer
+    attr_reader :options, :messages, :errors, :responses
+
+    TCP_BUFFER = 64.kilobytes
+    PROTOCOL_VERSION = "v2"
+
+    def initialize(options = {})
+      @options = options
+      @messages = []
+      @errors = []
+      @responses = []
+      @parser = Parser.new
+    end
+
+    def receive
+      begin
+        buffer = @socket.recv(TCP_BUFFER)
+        @parser.add(buffer)
+        frames = @parser.parse
+        frames.each { |frame| handle(frame) }
+      rescue => e
+        close!
+        raise e
+      end
+    end
+
+    def confirm(message)
+      @socket.write Command::Fin.new(message_id: message.id).to_line
+    end
+
+    def requeue(message, timeout = 0)
+      @socket.write Command::Req.new(message_id: message.id, timeout: timeout).to_line
+    end
+
+    def touch(message)
+      @socket.write Command::Touch.new(message_id: message.id).to_line
+    end
+
+    def close!
+      return if @socket.nil? || @socket.closed?
+      @socket.write Command::Cls.new.to_line
+      @socket.close
+      @socket = nil
+    end
+
+    def connect!
+      close! if @socket && !@socket.closed?
+      @socket = TCPSocket.open(options[:host], options[:port])
+      @socket.write PROTOCOL_VERSION.rjust(4).upcase
+      @socket.write Command::Identify.new(identify_defaults.merge(options[:features] || {})).to_line
+      @socket.write Command::Sub.new(topic_name: options[:topic], channel_name: options[:channel]).to_line
+      @socket.write Command::Rdy.new(count: 1).to_line
+      puts 'Ready to receive!'
+    end
+
+    private
+
+      def identify_defaults
+        return @identify_defaults if @identify_defaults
+        @identify_defaults = {
+          short_id: Socket.gethostname,
+          long_id: Socket.gethostbyname(Socket.gethostname).flatten.compact.first,
+          user_agent: "nsqrb/#{Nsqrb::VERSION}",
+          feature_negotiation: true
+        }
+      end
+
+      def handle(frame)
+        if(frame.is_a?(Frame::Response) && frame.content == '_heartbeat_')
+          @socket.write Command::Nop.new.to_line
+        elsif frame.is_a?(Frame::Message)
+          @messages << frame
+        elsif frame.is_a?(Frame::Response)
+          @responses << frame
+        elsif frame.is_a?(Frame::Error)
+          @errors << frame
+        end
+      end
+  end
+end

data/lib/nsqrb/frame/error.rb

@@ -0,0 +1,9 @@
+module Nsqrb
+  class Frame::Error < Frame
+
+    def initialize(frame)
+      super(content: frame[:data])
+    end
+
+  end
+end

data/lib/nsqrb/frame/message.rb

@@ -0,0 +1,10 @@
+module Nsqrb
+  class Frame::Message < Frame
+
+    def initialize(frame)
+      unpacked = frame[:data].unpack("Q>s>a16a#{frame[:size]}")
+      super(Hash[*([:timestamp, :attempts, :id, :content].zip(unpacked).flatten)])
+    end
+
+  end
+end

data/lib/nsqrb/frame/response.rb

@@ -0,0 +1,9 @@
+module Nsqrb
+  class Frame::Response < Frame
+
+    def initialize(frame)
+      super(content: frame[:data])
+    end
+
+  end
+end

data/lib/nsqrb/frame.rb

@@ -0,0 +1,4 @@
+module Nsqrb
+  class Frame < OpenStruct
+  end
+end

data/lib/nsqrb/parser.rb

@@ -0,0 +1,47 @@
+module Nsqrb
+  class Parser
+
+    # Frame types
+    FRAME_TYPES = {
+      0 => Frame::Response,
+      1 => Frame::Error,
+      2 => Frame::Message
+    }
+
+    FRAME_TYPE_SIZE = 4
+    INFO_SIZE = 8
+
+    def initialize
+      @buffer = []
+    end
+
+    def add(bytes)
+      bytes = bytes.split('') if bytes.is_a?(String)
+      @buffer += bytes
+    end
+
+    # Parse all frames from current buffer
+    # @return Array [Frame]
+    def parse
+      frames = []
+      loop do
+        break if @buffer.length < INFO_SIZE
+        size, type = @buffer[0, INFO_SIZE].join.unpack('l>l>')
+        frame = { size: size - FRAME_TYPE_SIZE, type: type.to_i }
+
+        break if @buffer.length < frame[:size] + INFO_SIZE
+        frame[:data] = @buffer[INFO_SIZE, frame[:size]].join
+        frames << build_frame(frame)
+        @buffer.shift(INFO_SIZE + frame[:size])
+      end
+      frames
+    end
+
+    private
+
+      def build_frame(frame)
+        raise "Unknown frame type: #{frame[:type]}" unless FRAME_TYPES.has_key?(frame[:type])
+        FRAME_TYPES[frame[:type]].new frame
+      end
+  end
+end

data/lib/nsqrb/producer.rb

@@ -0,0 +1,14 @@
+module Nsqrb
+  class Producer
+    def initialize(host, port, topic)
+      @http = ::Net::HTTP.new(host, port)
+      @topic = topic
+    end
+
+    def post!(obj)
+      res = @http.post("/pub?topic=" + @topic, obj.to_json)
+      return if res.code == "200"
+      res.error!
+    end
+  end
+end

data/lib/nsqrb/version.rb

@@ -0,0 +1,3 @@
+module Nsqrb
+  VERSION = "0.0.1"
+end

data/lib/nsqrb.rb

@@ -0,0 +1,16 @@
+# encoding: utf-8
+
+require 'nsqrb'
+require 'nsqrb/command'
+require 'nsqrb/frame'
+require 'nsqrb/frame/error'
+require 'nsqrb/frame/response'
+require 'nsqrb/frame/message'
+require 'nsqrb/parser'
+require 'nsqrb/consumer'
+require 'nsqrb/producer'
+
+Dir[File.dirname(__FILE__) + '/nsqrb/command/*.rb'].each {|file| require file }
+
+module Nsqrb
+end

data/nsqrb.gemspec

@@ -0,0 +1,13 @@
+require File.expand_path('../lib/nsqrb/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name        = 'nsqrb'
+  gem.version     = Nsqrb::VERSION
+  gem.description = gem.summary = "Basic ruby NSQ (http://nsq.io) client library"
+  gem.authors     = ["Mikhail Salosin"]
+  gem.email       = 'mikhail@salosin.me'
+  gem.files       = `git ls-files`.split("\n")
+  gem.test_files  = `git ls-files -- test/*`.split("\n")
+  gem.homepage    = 'http://rubygems.org/gems/nsqrb'
+  gem.license     = 'MIT'
+end

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification
+name: nsqrb
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Mikhail Salosin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-09 00:00:00.000000000 Z
+dependencies: []
+description: Basic ruby NSQ (http://nsq.io) client library
+email: mikhail@salosin.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- lib/nsqrb.rb
+- lib/nsqrb/command.rb
+- lib/nsqrb/command/cls.rb
+- lib/nsqrb/command/fin.rb
+- lib/nsqrb/command/identify.rb
+- lib/nsqrb/command/nop.rb
+- lib/nsqrb/command/pub.rb
+- lib/nsqrb/command/rdy.rb
+- lib/nsqrb/command/req.rb
+- lib/nsqrb/command/sub.rb
+- lib/nsqrb/command/touch.rb
+- lib/nsqrb/consumer.rb
+- lib/nsqrb/frame.rb
+- lib/nsqrb/frame/error.rb
+- lib/nsqrb/frame/message.rb
+- lib/nsqrb/frame/response.rb
+- lib/nsqrb/parser.rb
+- lib/nsqrb/producer.rb
+- lib/nsqrb/version.rb
+- nsqrb.gemspec
+homepage: http://rubygems.org/gems/nsqrb
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Basic ruby NSQ (http://nsq.io) client library
+test_files: []