0.0
No commit activity in last 3 years
No release in over 3 years
A RPC using Anything But XML (RABX) message parser and emitter
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

~> 1.8
>= 0
~> 3.1

Runtime

~> 0.0
 Project Readme

RPC using Anything But XML (RABX) message parser and emitter

Gem Version Build Status Coverage Status Code Climate

The RABX specification is a Perl module by mySociety.

Usage

require 'rabx/message'

Dump a RABX message:

RABX::Message.dump('R', 'RPC.method', ['argument', 3])
# => "R1:0,10:RPC.method,L1:2,T8:argument,I1:3,"
RABX::Message.dump('S', {name: 'foo', email: 'foo@example.com'})
# => "S1:0,A1:2,T4:name,T3:foo,T5:email,T15:foo@example.com,"
RABX::Message.dump('E', 404, 'Not Found')
# => "E1:0,3:404,9:Not Found,N"

Load a RABX message:

message = RABX::Message.load("R1:0,10:RPC.method,L1:2,T8:argument,I1:3,")
message.type # "R"
message.method # "RPC.method"
message.arguments # ["argument", 3]

message = RABX::Message.load("S1:0,A1:2,T4:name,T3:foo,T5:email,T15:foo@example.com,")
message.type # "S"
message.value # {"name"=>"foo", "email"=>"foo@example.com"}

message = RABX::Message.load("E1:0,3:404,9:Not Found,N")
message.type # "E"
message.code # "404"
message.text # "Not Found"
message.extra # nil

See the documentation to see how to work with RABX::Message instances.

Notes

Generic RABX clients include:

mySociety has scripts to convert a Perl RABX server to a server-specific client in:

Copyright (c) 2014 James McKinney, released under the MIT license