Project

vox-etf

0.0
No commit activity in last 3 years
No release in over 3 years
ETF decoding/encoding for vox.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

~> 12.3.3
~> 3.9.0
~> 0.90.0
~> 1.43.2
 Project Readme

Vox::ETF

Installation

Add this line to your application's Gemfile:

gem 'vox-etf'

And then execute:

$ bundle install

Or install it yourself as:

$ gem install vox-etf

Usage

To use the encoder/decoder independently use the respective #encode and #decode methods.

    require 'vox/etf'

    p Vox::ETF.decode("\x83l\x00\x00\x00\x03a\x01a\x02a\x03j")
    # => [1, 2, 3]

    p Vox::ETF.encode({foo: "bar"})
    # => "\x83t\x00\x00\x00\x01w\x03foom\x00\x00\x00\x03bar"

To use with the Vox gateway, add this gem to your Gemfile and provide :etf as the encoding option to Vox::Gateway::Client#initialize.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/swarley/vox-etf. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the Vox::Etf project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.