Pigeon-Ruby/README.md

Pigeon Ruby

A WIP pigeon protocol client.

How to Use

This is a pre-release skeleton project. There is no gem yet. The gem will be released after we are fully compliant with the spec and have high test coverage stats.

To get started, clone this repo and run ./pigeon-cli in place of pigeon.

Eg: pigeon identity show becomes ./pigeon-cli show.

Current Status

• pigeon identity new
• pigeon identity show
• pigeon status
• pigeon blob set
• pigeon blob get
• pigeon peer add
• pigeon peer remove
• pigeon peer block
• pigeon peer all
• 100% coverage
• Convert ".sig.ed25519" literals to constants
• Rename numerous "pigeon message ..." commands to "pigeon draft ..."
• pigeon draft create
• pigeon draft append
• pigeon draft current
• pigeon draft save
• pigeon bundle create
• Use JSON.stringify() for string keys (instead of inspect)
• pigeon bundle consume
• pigeon message find
• pigeon message find-all
• Perform message verification at time of disk write
• Remove all .current "singletons" / hacks
• 100% documentation
• add parsers and validators for all CLI inputs
• Validate inputs for Draft#[]=.
• Update spec to look like this
• Reduce whole darn repo into single module to aide portability
• Add Lipmaa links like the Bamboo folks do.
• Publish a RubyGem
• Performance benchmarks
• Performance tuning (DO THIS LAST!)

Idea Bin

• Map/reduce plugin support for custom indices?
• Ability to add a blob in one swoop using File objects and Message#[]=, maybe?