Pigeon-Ruby/README.md

![](logo.png)

# 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

 - [X] pigeon identity new
 - [X] pigeon identity show
 - [X] pigeon status
 - [X] pigeon blob set
 - [X] pigeon blob get
 - [X] pigeon peer add
 - [X] pigeon peer remove
 - [X] pigeon peer block
 - [X] pigeon peer all
 - [X] 100% coverage
 - [X] Convert `".sig.ed25519"` literals to constants
 - [X] Rename numerous "pigeon message ..." commands to "pigeon draft ..."
 - [X] pigeon draft create
 - [X] pigeon draft append
 - [X] pigeon draft current
 - [X] pigeon draft save
 - [X] pigeon bundle create
 - [X] Use JSON.stringify() for string keys (instead of `inspect`)
 - [X] Move literals into `Pigeon` module as constants, again.
 - [ ] pigeon message find
 - [ ] pigeon message find-all (then refactor ::Bundle.create to use it!)
 - [ ] pigeon bundle consume
 - [ ] add parsers and validators for all CLI inputs
 - [ ] Ensure all disks writes perform verification!
 - [ ] Remove all `.current` "singletons" / hacks
 - [ ] 100% documentation
 - [ ] Validate inputs for `Draft#[]=`.
 - [ ] Update spec to look [like this](https://gist.github.com/RickCarlino/3ff4178db4a75fd135832c403cd313d4)
 - [ ] Reduce whole darn repo into single module to aide portability. Maybe a second `::Support` module is OK.
 - [ ] 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?
Add logo 2019-10-10 00:32:54 +00:00			`![](logo.png)`

Coo... coo... 2019-09-22 02:30:03 +00:00			`# 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`

			`- [X] pigeon identity new`
			`- [X] pigeon identity show`
Cleanup and test scripts. TODO: Why does blocking not delete previous peers? 2019-09-25 01:19:25 +00:00			`- [X] pigeon status`
Update README 2019-09-22 02:31:01 +00:00			`- [X] pigeon blob set`
`blob get` 2019-09-22 11:00:19 +00:00			`- [X] pigeon blob get`
Finish most `peer` commands. NEXT: peer all 2019-09-23 01:07:14 +00:00			`- [X] pigeon peer add`
			`- [X] pigeon peer remove`
			`- [X] pigeon peer block`
Fix bug in block/remove 2019-09-25 01:31:32 +00:00			`- [X] pigeon peer all`
:tada: 100% coverage. NEXT: Verify message chain creation via tests. Currently, it is not working correctly. Take a look at scratchpad.sh. The `prev:` values are wrong. It is probably as simple as updating local indexes when Pigeon::Storage#save_message is called. Re run the indexes at that time. Or heck, add a map/reduce ability? 2020-03-07 15:38:34 +00:00			`- [X] 100% coverage`
Convert `".sig.ed25519"` literals to constants. Update README. 2020-03-14 03:02:45 +00:00			- [X] Convert `".sig.ed25519"` literals to constants
Convert "message..." commands to "draft..." commands 2020-03-14 03:17:56 +00:00			`- [X] Rename numerous "pigeon message ..." commands to "pigeon draft ..."`
TODO: pigeon bundle create 2020-03-14 03:41:31 +00:00			`- [X] pigeon draft create`
			`- [X] pigeon draft append`
			`- [X] pigeon draft current`
			`- [X] pigeon draft save`
We have BUNDLE CREATION :tada: :tada: :tada: 2020-03-15 16:51:13 +00:00			`- [X] pigeon bundle create`
Constantize literals for portability and DRYness 2020-03-15 17:50:57 +00:00			- [X] Use JSON.stringify() for string keys (instead of `inspect`)
			- [X] Move literals into `Pigeon` module as constants, again.
TODO: pigeon bundle create 2020-03-14 03:41:31 +00:00			`- [ ] pigeon message find`
Formatting updates 2020-03-15 18:12:26 +00:00			`- [ ] pigeon message find-all (then refactor ::Bundle.create to use it!)`
			`- [ ] pigeon bundle consume`
			`- [ ] add parsers and validators for all CLI inputs`
			`- [ ] Ensure all disks writes perform verification!`
TODO: pigeon bundle create 2020-03-14 03:41:31 +00:00			- [ ] Remove all `.current` "singletons" / hacks
Markdown formatting 2019-09-23 01:09:04 +00:00			`- [ ] 100% documentation`
Minor cleanup of ::KeyPair 2020-03-12 12:34:22 +00:00			- [ ] Validate inputs for `Draft#[]=`.
Update spec, begin message implementation 2019-10-12 19:43:27 +00:00			`- [ ] Update spec to look [like this](https://gist.github.com/RickCarlino/3ff4178db4a75fd135832c403cd313d4)`
Formatting updates 2020-03-15 18:12:26 +00:00			- [ ] Reduce whole darn repo into single module to aide portability. Maybe a second `::Support` module is OK.
Convert `".sig.ed25519"` literals to constants. Update README. 2020-03-14 03:02:45 +00:00			`- [ ] Add Lipmaa links like the Bamboo folks do.`
DRY up storage initialization / reset code 2020-03-08 16:18:05 +00:00			`- [ ] Publish a RubyGem`
Convert `".sig.ed25519"` literals to constants. Update README. 2020-03-14 03:02:45 +00:00			`- [ ] Performance benchmarks`
			`- [ ] Performance tuning (DO THIS LAST!)`
DRY up storage initialization / reset code 2020-03-08 16:18:05 +00:00
			`# Idea Bin`
			`- [ ] Map/reduce plugin support for custom indices?`
			- [ ] Ability to add a blob in one swoop using File objects and `Message#[]=`, maybe?