amq-protocol 0.0.1.pre

data/.gitignore

@@ -0,0 +1,4 @@
+/*.gem
+.rvmrc
+tmp
+*.pyc

data/.gitmodules

@@ -0,0 +1,3 @@
+[submodule "vendor/rabbitmq-codegen"]
+	path = vendor/rabbitmq-codegen
+	url = git://github.com/rabbitmq/rabbitmq-codegen.git

data/.rspec

@@ -0,0 +1,3 @@
+--colour
+--format
+progress

data/CHANGELOG

@@ -0,0 +1,3 @@
+= Version 0.0.1
+  * [FEATURE] Basic code generation.
+  * [FEATURE] Generate only methods which are actually required by the client.

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Jakub Šťastný aka Botanicus
+
+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.textile

@@ -0,0 +1,32 @@
+h1. About
+
+This is an AMQP parser for AMQP 0.9.1. It isn't an AMQP client, just the parser, so if you want to write your own AMQP client without digging into the protocol, this gem can help you with that.
+
+h1. Usage
+
+<pre>
+gem install amqp-parser
+</pre>
+
+Check the @examples@ directory for some examples.
+
+h1. Development
+
+<pre>
+git clone git://github.com/botanicus/amq-protocol.git --recursive
+</pre>
+
+Or, if you are on an older version of Git:
+
+<pre>
+git clone git://github.com/botanicus/amq-protocol.git
+git submodule update --init
+</pre>
+
+If you want to change some code, don't do so in @lib/amq/protocol.rb@, but in @protocol.rb.pytemplate@ which is a template file for @codegen.py@. You can re-generate the code by @./tasks.rb generate@.
+
+h1. Links
+
+* "RDoc.info API Docs":http://rdoc.info/github/botanicus/amq-protocol/master/frames
+* "Examples":https://github.com/botanicus/amq-protocol/tree/master/examples/
+* "Bug reporting":http://github.com/botanicus/amq-protocol/issues

data/TODO.todo

@@ -0,0 +1,3 @@
+- YARD documentation
+- benchmarks
+- optimisations (see puka)

data/amq-protocol.gemspec

@@ -0,0 +1,34 @@
+#!/usr/bin/env gem build
+# encoding: utf-8
+
+require "base64"
+
+Gem::Specification.new do |s|
+  s.name = "amq-protocol"
+  s.version = "0.0.1"
+  s.authors = ["Jakub Stastny"]
+  s.homepage = "http://github.com/botanicus/amq-protocol"
+  s.summary = "AMQP 0.9.1 encoder & decoder."
+  s.description = "This is an AMQP encoder & decoder for AMQP 0.9.1. It isn't an AMQP client, just the parser, so if you want to write your own AMQP client without digging into the protocol, this gem can help you with that."
+  s.cert_chain = nil
+  s.email = Base64.decode64("c3Rhc3RueUAxMDFpZGVhcy5jeg==\n")
+  s.has_rdoc = true
+
+  # files
+  s.files = `git ls-files`.split("\n")
+  s.require_paths = ["lib"]
+
+  # Ruby version
+  s.required_ruby_version = ::Gem::Requirement.new("~> 1.9")
+
+  begin
+    require "changelog"
+  rescue LoadError
+    warn "You have to have changelog gem installed for post install message"
+  else
+    s.post_install_message = CHANGELOG.new.version_changes
+  end
+
+  # RubyForge
+  s.rubyforge_project = "amq-protocol"
+end

data/amq-protocol.pre.gemspec

@@ -0,0 +1,6 @@
+#!/usr/bin/env gem build
+# encoding: utf-8
+
+eval(File.read("amq-protocol.gemspec")).tap do |specification|
+  specification.version = "#{specification.version}.pre"
+end

data/amqp_0.9.1_changes.json

@@ -0,0 +1 @@
+{"tx": {"select-ok": ["client"], "rollback": ["server"], "commit": ["server"], "rollback-ok": ["client"], "select": ["server"], "commit-ok": ["client"]}, "exchange": {"delete-ok": ["client"], "declare-ok": ["client"], "declare": ["server"], "delete": ["server"], "bind": ["server"], "bind-ok": ["client"], "unbind": ["server"], "unbind-ok": ["client"]}, "queue": {"unbind": ["server"], "unbind-ok": ["client"], "purge-ok": ["client"], "bind": ["server"], "purge": ["server"], "declare-ok": ["client"], "delete-ok": ["client"], "delete": ["server"], "declare": ["server"], "bind-ok": ["client"]}, "connection": {"secure": ["client"], "secure-ok": ["server"], "open-ok": ["client"], "close-ok": ["client", "server"], "start": ["client"], "tune": ["client"], "start-ok": ["server"], "close": ["client", "server"], "open": ["server"], "tune-ok": ["server"]}, "basic": {"qos": ["server"], "consume": ["server"], "reject": ["server"], "get": ["server"], "ack": ["server"], "get-ok": ["client"], "consume-ok": ["client"], "deliver": ["client"], "recover-ok": ["client"], "publish": ["server"], "cancel": ["server"], "recover-async": ["server"], "get-empty": ["client"], "qos-ok": ["client"], "return": ["client"], "recover": ["server"], "cancel-ok": ["client"]}, "channel": {"flow-ok": ["server", "client"], "flow": ["server", "client"], "open-ok": ["client"], "close-ok": ["client", "server"], "close": ["client", "server"], "open": ["server"]}}

data/benchmark.rb

@@ -0,0 +1,24 @@
+#!/usr/bin/env ruby
+# encoding: binary
+
+begin
+  require "amq/spec"
+rescue LoadError
+  abort "You have to install the amqp gem in order to run the benchmark against its AMQP encoder/decoder."
+end
+
+require "benchmark"
+
+Benchmark.bmbm do |bm|
+  bm.report("Raw binary") do
+    # TODO
+  end
+
+  bm.report("AMQP Gem") do
+    # TODO
+  end
+
+  bm.report("AMQ Protocol Gem") do
+    # TODO
+  end
+end

data/codegen.py

@@ -0,0 +1,121 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+
+import os, sys, re
+
+sys.path.append(os.path.join("vendor", "rabbitmq-codegen"))
+
+from amqp_codegen import *
+try:
+    from mako.template import Template
+except ImportError:
+    print "Mako isn't installed. Run easy_install mako."
+    sys.exit(1)
+
+# main class
+class AmqpSpecObject(AmqpSpec):
+    IGNORED_CLASSES = ["access", "tx"]
+    IGNORED_FIELDS = {
+        'ticket': 0,
+        'nowait': 0,
+        'capabilities': '',
+        'insist' : 0,
+        'out_of_band': '',
+        'known_hosts': '',
+    }
+
+    def __init__(self, path):
+        AmqpSpec.__init__(self, path)
+
+        def extend_field(field):
+            field.ruby_name = re.sub("[- ]", "_", field.name)
+            field.type = self.resolveDomain(field.domain)
+            field.banned = bool(field.name in self.__class__.IGNORED_FIELDS)
+
+        for klass in self.classes:
+            klass.banned = bool(klass.name in self.__class__.IGNORED_CLASSES)
+
+            for field in klass.fields:
+                extend_field(field)
+
+            for method in klass.methods:
+                for field in method.arguments:
+                    extend_field(field)
+
+        self.classes = filter(lambda klass: not klass.banned, self.classes)
+
+# I know, I'm a bad, bad boy, but come on guys,
+# monkey-patching is just handy for this case.
+# Oh hell, why Python doesn't have at least
+# anonymous functions? This looks so ugly.
+original_init = AmqpEntity.__init__
+def new_init(self, arg):
+    original_init(self, arg)
+    constant_name = ""
+    for chunk in self.name.split("-"):
+        constant_name += chunk.capitalize()
+    self.constant_name = constant_name
+AmqpEntity.__init__ = new_init
+
+# method.accepted_by("server")
+# method.accepted_by("client", "server")
+accepted_by_update = json.loads(file("amqp_0.9.1_changes.json").read())
+
+def accepted_by(self, *receivers):
+    def get_accepted_by(self):
+        try:
+            return accepted_by_update[self.klass.name][self.name]
+        except KeyError:
+            return ["server", "client"]
+
+    actual_receivers = get_accepted_by(self)
+    return all(map(lambda receiver: receiver in actual_receivers, receivers))
+
+AmqpMethod.accepted_by = accepted_by
+
+def convert_to_ruby(field):
+    name = re.sub("-", "_", field.name) # TODO: use ruby_name
+    if field.defaultvalue == None:
+        return "%s = nil" % (name,)
+    elif field.defaultvalue == False:
+        return "%s = false" % (name,)
+    elif field.defaultvalue == True:
+        return "%s = true" % (name,)
+    else:
+        return "%s = %r" % (name, field.defaultvalue)
+
+def params(self):
+    buffer = []
+    for f in self.arguments:
+        buffer.append(convert_to_ruby(f))
+    if self.hasContent:
+        buffer.append("user_headers = nil")
+        buffer.append("payload = \"\"")
+        buffer.append("frame_size = nil")
+    return buffer
+
+AmqpMethod.params = params
+
+def args(self):
+    return map(lambda item: item.split(" ")[0], self.params())
+
+AmqpMethod.args = args
+
+def binary(self):
+    method_id = self.klass.index << 16 | self.index
+    return "0x%08X # %i, %i, %i" % (method_id, self.klass.index, self.index, method_id)
+
+AmqpMethod.binary = binary
+
+# helpers
+def render(path, **context):
+    file = open(path)
+    template = Template(file.read())
+    return template.render(**context)
+
+def main(json_spec_path):
+    spec = AmqpSpecObject(json_spec_path)
+    print render("protocol.rb.pytemplate", spec = spec)
+
+if __name__ == "__main__":
+    do_main_dict({"spec": main})

data/codegen_helpers.py

@@ -0,0 +1,113 @@
+# -*- coding: utf-8 -*-
+
+def genSingleEncode(spec, cValue, unresolved_domain):
+    buffer = []
+    type = spec.resolveDomain(unresolved_domain)
+    if type == 'shortstr':
+        buffer.append("pieces << %s.bytesize.chr" % (cValue,))
+        buffer.append("pieces << %s" % (cValue,))
+    elif type == 'longstr':
+        buffer.append("pieces << [%s.bytesize].pack('N')" % (cValue,))
+        buffer.append("pieces << %s" % (cValue,))
+    elif type == 'octet':
+        buffer.append("pieces << [%s].pack('B')" % (cValue,))
+    elif type == 'short':
+        buffer.append("pieces << [%s].pack('n')" % (cValue,))
+    elif type == 'long':
+        buffer.append("pieces << [%s].pack('N')" % (cValue,))
+    elif type == 'longlong':
+        buffer.append("pieces << [%s].pack('>Q')" % (cValue,))
+    elif type == 'timestamp':
+        buffer.append("pieces << [%s].pack('>Q')" % (cValue,))
+    elif type == 'bit':
+        raise "Can't encode bit in genSingleEncode"
+    elif type == 'table':
+        buffer.append("pieces << AMQ::Protocol::Table.encode(%s)" % (cValue,))
+    else:
+        raise "Illegal domain in genSingleEncode", type
+
+    return buffer
+
+def genSingleDecode(spec, cLvalue, unresolved_domain):
+    type = spec.resolveDomain(unresolved_domain)
+    buffer = []
+    if type == 'shortstr':
+        buffer.append("length = data[offset..(offset + 1)].unpack('N')[0]")
+        buffer.append("offset += 1")
+        buffer.append("%s = data[offset..(offset + length)]" % (cLvalue,))
+        buffer.append("offset += length")
+    elif type == 'longstr':
+        buffer.append("length = data[offset..(offset + 4)].unpack('N').first")
+        buffer.append("offset += 4")
+        buffer.append("%s = data[offset..(offset + length)]" % (cLvalue,))
+        buffer.append("offset += length")
+    elif type == 'octet':
+        buffer.append("%s = data[offset...(offset + 1)].unpack('c').first" % (cLvalue,))
+        buffer.append("offset += 1")
+    elif type == 'short':
+        buffer.append("%s = data[offset..(offset + 2)].unpack('n').first" % (cLvalue,))
+        buffer.append("offset += 2")
+    elif type == 'long':
+        buffer.append("%s = data[offset..(offset + 4)].unpack('N').first" % (cLvalue,))
+        buffer.append("offset += 4")
+    elif type == 'longlong':
+        buffer.append("%s = data[offset..(offset + 8)].unpack('N2').first" % (cLvalue,))
+        buffer.append("offset += 8")
+    elif type == 'timestamp':
+        buffer.append("%s = data[offset..(offset + 8)].unpack('N2').first" % (cLvalue,))
+        buffer.append("offset += 8")
+    elif type == 'bit':
+        raise "Can't decode bit in genSingleDecode"
+    elif type == 'table':
+        buffer.append("table_length = Table.length(data[offset..(offset + 4)])")
+        buffer.append("%s = Table.decode(data[offset..table_length])" % (cLvalue,))
+    else:
+        raise "Illegal domain in genSingleDecode", type
+
+    return buffer
+
+def genEncodeMethodDefinition(spec, m):
+    def finishBits():
+        if bit_index is not None:
+            return "pieces << [bit_buffer].pack('B')"
+
+    bit_index = None
+    buffer = []
+
+    for f in m.arguments:
+        if spec.resolveDomain(f.domain) == 'bit':
+            if bit_index is None:
+                bit_index = 0
+                buffer.append("bit_buffer = 0")
+            if bit_index >= 8:
+                finishBits()
+                buffer.append("bit_buffer = 0")
+                bit_index = 0
+            buffer.append("bit_buffer = bit_buffer | (1 << %d) if %s" % (bit_index, f.ruby_name))
+            bit_index = bit_index + 1
+        else:
+            finishBits()
+            bit_index = None
+            buffer += genSingleEncode(spec, f.ruby_name, f.domain)
+
+    finishBits()
+    return buffer
+
+def genDecodeMethodDefinition(spec, m):
+    buffer = []
+    bitindex = None
+    for f in m.arguments:
+        if spec.resolveDomain(f.domain) == 'bit':
+            if bitindex is None:
+                bitindex = 0
+            if bitindex >= 8:
+                bitindex = 0
+            if bitindex == 0:
+                buffer.append("bit_buffer = data[offset..(offset + 1)].unpack('c').first")
+                buffer.append("offset += 1")
+                buffer.append("%s = (bit_buffer & (1 << %d)) != 0" % (f.ruby_name, bitindex))
+            bitindex = bitindex + 1
+        else:
+            bitindex = None
+            buffer += genSingleDecode(spec, f.ruby_name, f.domain)
+    return buffer

data/examples/00_manual_test.rb

@@ -0,0 +1,60 @@
+# encoding: binary
+
+require "socket"
+require_relative "../lib/amq/protocol.rb"
+
+include AMQ::Protocol
+
+socket = Socket.new(Socket::AF_INET, Socket::SOCK_STREAM, 0)
+sockaddr = Socket.pack_sockaddr_in((ARGV.first || 5672).to_i, "127.0.0.1") # NOTE: this doesn't work with "localhost", I don't know why.
+
+begin
+  socket.connect(sockaddr)
+rescue Errno::ECONNREFUSED
+  abort "Don't forget to start an AMQP broker first!"
+end
+
+# helpers
+MethodFrame.encode(:method, 0, Connection::TuneOk.encode(0, 131072, 0))
+
+def socket.encode(klass, *args)
+  STDERR.puts "#{klass}.encode(#{args.inspect[1..-2]})"
+  klass.encode(*args).tap do |result|
+    STDERR.puts "=> #{result.inspect}"
+    STDERR.puts "MethodFrame.encode(:method, 0, #{result.inspect})"
+    STDERR.puts "=> #{MethodFrame.encode(:method, 0, result).inspect}\n\n"
+    self.write(MethodFrame.encode(:method, 0, result))
+  end
+end
+
+def socket.decode
+  frame = MethodFrame.decode(self)
+  STDERR.puts "MethodFrame.decode(#{self.inspect})"
+  STDERR.puts "=> #{frame.inspect}\n\n"
+end
+
+# AMQP preamble
+puts "Sending AMQP preamble (#{AMQ::Protocol::PREAMBLE.inspect})\n\n"
+socket.write AMQ::Protocol::PREAMBLE
+
+# Start/Start-Ok
+socket.decode
+socket.encode Connection::StartOk, {client: "AMQ Protocol"}, "PLAIN", "guest\0guest\0", "en_GB"
+
+# Tune/Tune-Ok
+socket.decode
+socket.encode Connection::TuneOk, 0, 131072, 0
+
+# Close
+# socket.encode Connection::Close
+# socket.decode
+
+socket.close
+
+__END__
+[CLIENT] conn#4 ch#0 -> {#method<connection.start-ok>(client-properties={product=AMQP, information=http://github.com/tmm1/amqp, platform=Ruby/EventMachine, version=0.6.7},mechanism=AMQPLAIN,response=LOGINSguesPASSWORDSguest,locale=en_US),null,""}
+[SERVER] conn#4 ch#0 <- {#method<connection.start>(version-major=8,version-minor=0,server properties={product=RabbitMQ, information=Licensed under the MPL.  See http://www.rabbitmq.com/, platform=Erlang/OTP, copyright=Copyright (C) 2007-2010 LShift Ltd., Cohesive Financial Technologies LLC., and Rabbit Technologies Ltd., version=2.1.0},mechanisms=PLAIN AMQPLAIN,locales=en_US),null,""}
+[SERVER] conn#4 ch#0 <- {#method<connection.tune>(channel-max=0,frame-max=131072,heartbeat=0),null,""}
+[CLIENT] conn#4 ch#0 -> {#method<connection.tune-ok>(channel-max=0,frame-max=131072,heartbeat=0),null,""}
+[CLIENT] conn#4 ch#0 -> {#method<connection.open>(virtual-host=/,capabilities=,insist=false),null,""}
+[SERVER] conn#4 ch#0 <- {#method<connection.open-ok>(known-hosts=),null,""}