stomp_publisher 0.9.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1a06c015c42df9acf3aa489fd8f83185eaba3fd4
+  data.tar.gz: 125c8db2ccba8513d3d8fe390357f65349756dc0
+SHA512:
+  metadata.gz: 25c6767732759e8e8b6896047b9c159aa45b82c6b9fc22f9f540285e36ff169868424f7b453d722ed2b169d7ee1154136c3aacf23fcc9e606b1ccf9ad26a24e7
+  data.tar.gz: d8a71e807a0767a1fe939869fc1ac4d7d18fe9ef43db3ef402b7b8614ae456e53fe3d309a4639f0fbff2efc4df1cc19e0ab329f593b0fb40d6a81b95189ecc2e

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in stomp_publisher.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Brian Abreu
+
+MIT License
+
+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,43 @@
+# StompPublisher
+
+This is a simple library to synchronously publish STOMP messages. It is designed to be as simple as possible and only supports publishing. It uses non-blocking socket operations to reliably timeout without using hackish thread timeouts.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'stomp_publisher'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install stomp_publisher
+
+## Usage
+
+```ruby
+require 'stomp_publisher'
+publisher = StompPublisher.new(
+  host: "localhost",
+  port: 61613,
+  login: "guest",
+  passcode: "guest",
+  vhost: "/",
+  connect_timeout: 0.5,
+  read_timeout: 0.25,
+  write_timeout: 0.25
+)
+receipt_id = publisher.publish("myqueue", '{ "hello": "world" }', :"content-type" => "application/json")
+publisher.publish("myqueue", "hello", :"custom-header" => "world", :"receipt_id" => "my custom STOMP receipt")
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/stomp_publisher/connection_error.rb

@@ -0,0 +1,10 @@
+class StompPublisher
+  class ConnectionError < Exception
+    attr_accessor :frame
+
+    def initialize(msg, frame)
+      super(msg)
+      self.frame = frame
+    end
+  end
+end

data/lib/stomp_publisher/frame.rb

@@ -0,0 +1,67 @@
+class StompPublisher
+  class Frame
+    class InvalidFrame < Exception
+    end
+
+    COMMANDS = %w(
+      SEND
+      SUBSCRIBE
+      UNSUBSCRIBE
+      BEGIN
+      COMMIT
+      ABORT
+      ACK
+      NACK
+      DISCONNECT
+      CONNECT
+      STOMP
+      CONNECTED
+      MESSAGE
+      RECEIPT
+      ERROR
+    )
+
+    attr_accessor :command, :header, :body
+
+    def self.parse(frame)
+      command = COMMANDS.detect { |cmd| frame =~ /^(#{cmd}\r?\n)/ } or
+          raise InvalidFrame.new("invalid or missing command")
+      header_start_ndx = $1.length + 1
+
+      header_separator_ndx = frame.index(/(\r?\n\r?\n)/) or
+          raise InvalidFrame.new("missing headers")
+      body_start_ndx = header_separator_ndx + $1.length
+
+      body_terminator_ndx = frame.rindex(/\0(\r?\n)*/) or
+          raise InvalidFrame.new("missing end of body")
+
+      header = Header.parse(frame[(command.length + 1)..(header_separator_ndx - 1)])
+      body = frame[body_start_ndx..(body_terminator_ndx - 1)]
+
+      if (content_length = header["content-length"])
+        content_length = Integer(content_length) or
+            raise InvalidFrame("invalid content-length")
+
+        body.bytesize == content_length or
+            raise InvalidFrame("content-length was #{body.bytesize}, expected: #{content_length}")
+      end
+
+      Frame.new(command, header, body)
+    end
+
+    def initialize(command, header, body = "")
+      self.command = command
+      self.header = header
+      self.body = body
+    end
+
+    def body=(body)
+      @body = body
+      self.header['content-length'] = body.to_s.bytesize
+    end
+
+    def to_s
+      "#{command}\n#{header}\n\n#{body}\0"
+    end
+  end
+end

data/lib/stomp_publisher/header.rb

@@ -0,0 +1,40 @@
+require 'net/http'
+
+class StompPublisher
+  class Header
+    include Net::HTTPHeader
+
+    ESCAPES = {
+      "\\" => "\\\\",
+      "\r" => "\\r",
+      "\n" => "\\n",
+      ":"  => "\\c",
+    }
+
+    def self.parse(header_text)
+      header = self.new
+      header_text.each_line do |line|
+        header.add_field(*line.chomp.split(":", 2))
+      end
+      header
+    end
+
+    def initialize(headers = {})
+      initialize_http_header(headers)
+    end
+
+    def to_s
+      each_name.flat_map do |key|
+        get_fields(key).map { |value| "#{encode(key)}:#{encode(value)}" }
+      end * "\n"
+    end
+
+    def encode(value)
+      ESCAPES.inject(value.to_s) { |value, (from, to)| value.gsub(from, to) }
+    end
+
+    def decode(value)
+      ESCAPES.inject(value.to_s) { |value, (from, to)| value.gsub(to, from) }
+    end
+  end
+end

data/lib/stomp_publisher/version.rb

@@ -0,0 +1,3 @@
+class StompPublisher
+  VERSION = "0.9.0"
+end

data/lib/stomp_publisher.rb

@@ -0,0 +1,70 @@
+require 'stomp_publisher/frame'
+require 'stomp_publisher/header'
+require 'stomp_publisher/connection_error'
+
+require 'tcp_timeout'
+require 'securerandom'
+
+class StompPublisher
+  FRAME_READ_SIZE = 8192
+  MAX_FRAME_SIZE = 65536
+
+  def initialize(host: "localhost", port: 61613, login: nil, passcode: nil, vhost: host, **socket_args)
+    @host = host
+    @port = port
+    @login = login or raise ArgumentError.new("missing argument login")
+    @passcode = passcode or raise ArgumentError.new("missing argument passcode")
+    @vhost = vhost
+    @socket_args = socket_args
+  end
+
+  def publish(queue, message, **properties)
+    socket = TCPTimeout::TCPSocket.new(@host, @port, **@socket_args)
+    connect(socket, @login, @passcode, @vhost)
+    send(socket, message, properties.merge(destination: "/queue/#{queue}"))
+  end
+
+  protected
+    def connect(socket, login, passcode, vhost)
+      header = Header.new(
+        login: login,
+        passcode: passcode,
+        host: vhost,
+        "accept-version" => "1.2"
+      )
+      frame = Frame.new("CONNECT", header)
+      socket.write(frame.to_s)
+
+      response_frame = read_frame(socket)
+      if (response_frame.command != "CONNECTED")
+        raise ConnectionError.new("Failed to login: #{response_frame.body}", response_frame)
+      end
+    end
+
+    def send(socket, message, receipt_id: SecureRandom.hex(16), **properties)
+      frame = Frame.new("SEND", Header.new(properties.merge(receipt: receipt_id)), message)
+      socket.write(frame.to_s)
+
+      response_frame = read_frame(socket)
+      if (response_frame.command != "RECEIPT")
+        raise ConnectionError.new("Did not receive expected receipt", response_frame)
+      elsif ((response_receipt = response_frame.header["receipt-id"]) != receipt_id)
+        raise ConnectionError.new("Received unexpected receipt id: #{response_receipt}", response_frame)
+      end
+
+      receipt_id
+    end
+
+    def read_frame(socket)
+      response = ""
+      begin
+        response << socket.readpartial(FRAME_READ_SIZE)
+        if (response.bytesize > MAX_FRAME_SIZE)
+          raise ConnectionError.new("Frame was larger than the max size of #{MAX_FRAME_SIZE}", nil)
+        end
+        Frame.parse(response)
+      rescue Frame::InvalidFrame
+        retry
+      end
+    end
+end

data/stomp_publisher.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'stomp_publisher/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "stomp_publisher"
+  spec.version       = StompPublisher::VERSION
+  spec.authors       = ["Brian Abreu"]
+  spec.email         = ["brian@nutsonline.com"]
+  spec.description   = %q{A simple library for publishing messages via the STOMP protocol}
+  spec.summary       = spec.description
+  spec.homepage      = "https://github.com/nuts/ruby-stomp-publisher"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "tcp_timeout"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: stomp_publisher
+version: !ruby/object:Gem::Version
+  version: 0.9.0
+platform: ruby
+authors:
+- Brian Abreu
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: tcp_timeout
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A simple library for publishing messages via the STOMP protocol
+email:
+- brian@nutsonline.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/stomp_publisher.rb
+- lib/stomp_publisher/connection_error.rb
+- lib/stomp_publisher/frame.rb
+- lib/stomp_publisher/header.rb
+- lib/stomp_publisher/version.rb
+- stomp_publisher.gemspec
+homepage: https://github.com/nuts/ruby-stomp-publisher
+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.0.2
+signing_key: 
+specification_version: 4
+summary: A simple library for publishing messages via the STOMP protocol
+test_files: []