Project

rbencode

0.0
Repository is archived
No commit activity in last 3 years
No release in over 3 years
A serializer for the Bit Torrent bencoding format
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

~> 0.5.1
~> 1.16
~> 5.0
~> 10.0
 Project Readme

Rbencode

A simple bencoding module, to encode and decode as specified in the BitTorrent Protocol Specification: BEP 3.

This project was mainly made as a simple task to implement while learning ruby.

Installation

Add this line to your application's Gemfile:

gem 'rbencode'

And then execute:

$ bundle

Or install it yourself as:

$ gem install rbencode

Usage

Rbencode.decode('3:foo') == 'foo'
Rbencode.encode('foo') == '3:foo'

See tests for more examples

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake test to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/ikornaselur/rbencode.

License

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