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
 - [ ] Convert `".sig.ed25519"` literals to constants
 - [ ] Reduce whole darn repo into single module to aide portability
 - [ ] Remove all `.current` "singletons" / hacks
 - [ ] Rename numerous "pigeon message ..." commands to "pigeon draft ..."
 - [ ] pigeon bundle create
 - [ ] pigeon bundle consume
 - [ ] pigeon draft create
 - [ ] pigeon draft append
 - [ ] pigeon draft current
 - [ ] pigeon draft save
 - [ ] pigeon message find
 - [ ] pigeon message find-all
 - [ ] 100% documentation
 - [ ] add parsers and validators for all CLI inputs
 - [ ] Validate inputs for `Draft#[]=`.
 - [ ] Perform message verrification at time of disk write?
 - [ ] Performance benchmarks
 - [ ] Performance tuning (DO THIS LAST!)
 - [ ] Update spec to look [like this](https://gist.github.com/RickCarlino/3ff4178db4a75fd135832c403cd313d4)
 - [ ] Publish a RubyGem

# Idea Bin
 - [ ] Map/reduce plugin support for custom indices?
 - [ ] Add Lipmaa links like the Bamboo folks do.
 - [ ] 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`
test to verify message signatures 2020-03-13 12:39:44 +00:00			- [ ] Convert `".sig.ed25519"` literals to constants
			`- [ ] Reduce whole darn repo into single module to aide portability`
Minor cleanup of ::KeyPair 2020-03-12 12:34:22 +00:00			- [ ] Remove all `.current` "singletons" / hacks
: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			`- [ ] Rename numerous "pigeon message ..." commands to "pigeon draft ..."`
Markdown formatting 2019-09-23 01:09:04 +00:00			`- [ ] pigeon bundle create`
			`- [ ] pigeon bundle consume`
: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			`- [ ] pigeon draft create`
			`- [ ] pigeon draft append`
			`- [ ] pigeon draft current`
			`- [ ] pigeon draft save`
			`- [ ] pigeon message find`
			`- [ ] pigeon message find-all`
Markdown formatting 2019-09-23 01:09:04 +00:00			`- [ ] 100% documentation`
			`- [ ] add parsers and validators for all CLI inputs`
Minor cleanup of ::KeyPair 2020-03-12 12:34:22 +00:00			- [ ] Validate inputs for `Draft#[]=`.
Stability issues WIP. What's Next? * Update the protocol spec and push to Tildegit * Cleanup fix scratchpad.sh (currently crashes because ::Draft.current is unexpectedlyy nil) * Fix failing test (going to make ::Draft.current crash maybe) * Make blobs URLSafe b64?? 2020-03-13 12:48:37 +00:00			`- [ ] Perform message verrification at time of disk write?`
Fix bug in block/remove 2019-09-25 01:31:32 +00:00			`- [ ] Performance benchmarks`
			`- [ ] Performance tuning (DO THIS LAST!)`
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)`
DRY up storage initialization / reset code 2020-03-08 16:18:05 +00:00			`- [ ] Publish a RubyGem`

			`# Idea Bin`
			`- [ ] Map/reduce plugin support for custom indices?`
			`- [ ] Add Lipmaa links like the Bamboo folks do.`
			- [ ] Ability to add a blob in one swoop using File objects and `Message#[]=`, maybe?