PigeonProtocolConsortium/Pigeon-Ruby
PigeonProtocolConsortium
/
Pigeon-Ruby
3
1
Fork 0
Code Issues Pull Requests Releases 1 Wiki Activity
62 Commits 1 Branch 1 Tag 875 KiB
Ruby 94.7%
Shell 5.3%
Go to file
Netscape Navigator c27db9ae71 TODO: Verify accuracy of signature chain. 
Also todo:
 * Use URL safe base64 for blob multihash?
 * Replicate/verify signatures of SSB messages for backwards compat.
 		2020-03-09 08:56:45 -05:00
dist TODO: Verify accuracy of signature chain. 2020-03-09 08:56:45 -05:00
spec TODO: Verify accuracy of signature chain. 2020-03-09 08:56:45 -05:00
views Remove superfluous whitespace. Add scratchpad* to ignore. 2020-03-09 08:07:55 -05:00
.gitignore TODO: Verify accuracy of signature chain. 2020-03-09 08:56:45 -05:00
.rspec Coo... coo... 2019-09-21 21:30:03 -05:00
Gemfile === BEGIN FILESYSTEM REMOVAL === 2019-11-26 19:46:50 -06:00
Gemfile.lock === BEGIN FILESYSTEM REMOVAL === 2019-11-26 19:46:50 -06:00
README.md DRY up storage initialization / reset code 2020-03-08 11:18:05 -05:00
TODO.md Update spec, begin message implementation 2019-10-12 14:43:27 -05:00
logo.png Add logo 2019-10-09 19:32:54 -05:00
pigeon-cli 🎉 100% coverage. NEXT: Verify message chain creation via tests. 2020-03-07 09:56:03 -06:00
scratchpad.jpg Cleanup and test scripts. TODO: Why does blocking not delete previous peers? 2019-09-24 20:19:25 -05:00
scratchpad.md (99.44% coverage) TODO: Need to reset current draft when a draft is signed/committed to the log 2020-03-06 08:42:19 -06:00
scratchpad.sh 🎉 100% coverage. NEXT: Verify message chain creation via tests. 2020-03-07 09:56:03 -06:00
scratchpad2.rb TODO: Verify accuracy of signature chain. 2020-03-09 08:56:45 -05:00

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
  • 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
  • Performance benchmarks
  • Performance tuning (DO THIS LAST!)
  • Update spec to look like this
  • 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?