PigeonProtocolConsortium/Pigeon-Ruby
PigeonProtocolConsortium
/
Pigeon-Ruby
3
1
Fork 0
Code Issues Pull Requests Releases 1 Wiki Activity
251 Commits 1 Branch 1 Tag 875 KiB
Ruby 94.7%
Shell 5.3%
Go to file
Netscape Navigator df09c37906 Update kitchen_sink.sh to use new format 2020-06-06 15:33:49 -05:00
.vscode Configuration is evil- lets not make it a public API. 2020-04-26 09:18:30 -05:00
bin Run rubocop 2020-04-25 10:11:25 -05:00
lib Fix problem with "string" keys. 2020-06-06 15:20:14 -05:00
spec Rename sigils, remove footers 2020-06-05 07:52:22 -05:00
.gitignore Minor updates 2020-05-06 07:32:09 -05:00
.map WIP. TODO: Make sure client is ingesting blobs in a bundle 2020-04-23 07:41:47 -05:00
.rspec Coo... coo... 2019-09-21 21:30:03 -05:00
Gemfile Run rubocop 2020-04-25 10:11:25 -05:00
Gemfile.lock Run rubocop 2020-04-25 10:11:25 -05:00
LICENSE Add license, gemspec 2020-04-18 11:12:54 -05:00
README.md Fix problem with "string" keys. 2020-06-06 15:20:14 -05:00
a.gif WIP. TODO: Make sure client is ingesting blobs in a bundle 2020-04-23 07:41:47 -05:00
b.gif WIP. TODO: Make sure client is ingesting blobs in a bundle 2020-04-23 07:41:47 -05:00
c.gif WIP. TODO: Make sure client is ingesting blobs in a bundle 2020-04-23 07:41:47 -05:00
db.pigeon 🎉 v0.1.0 - minimally feature complete 2020-04-22 08:44:12 -05:00
kitchen_sink.sh Update kitchen_sink.sh to use new format 2020-06-06 15:33:49 -05:00
logo.png Add logo 2019-10-09 19:32:54 -05:00
pigeon.gemspec Run rubocop 2020-04-25 10:11:25 -05:00
ruby_tutorial.md First draft of Ruby API docs 2020-04-30 08:41:42 -05:00
scratchpad.jpg Cleanup and test scripts. TODO: Why does blocking not delete previous peers? 2019-09-24 20:19:25 -05:00

README.md

Pigeon Ruby

A Pigeon Protocol client written in Ruby.

Email contact at vaporsoft.xyz to ask questions or get involved. Your feedback is solicited and appreciated. Seriously, send us an email! We look forward to hearing from you.

Features

  • CLI (docs via pigeon-cli help) and Ruby API available (docs here)
  • Minimal dependencies - only outside deps are thor (for CLI) and ed25519 (for signatures).
  • Thoroughly unit tested.

Caveats

  • Current windows support is unknown (and unlikely to work in current state). Please report bugs.
  • Not published to RubyGems yet (see installation instructions below)
  • Single threaded use is assumed. Built for a single user per OS process. Many design tradeoffs were made around that use case.
  • Bundling operations need performance tuning. Optimizations are planned and help is welcome.

Build From Source

We are not yet on Rubygems. The gem will be released after we are fully compliant with the spec.

In the meantime:

git clone https://tildegit.org/PigeonProtocolConsortium/pigeon_ruby.git
cd pigeon_ruby
gem build pigeon.gemspec
gem install pigeon-0.1.1.gem
pigeon-cli identity new # Should work. Raise issue if not.
pigeon-cli status
pigeon-cli help

Usage: CLI

See pigeon-cli help for documentation. See kitchen_sink.sh examples.

Usage: Ruby Lib

Docs available here

Current Status

  • CLI is wrapping FILE. and FEED. multihahshes in "string quotes". Why?
  • Update Dev docs in protocol spec to reflect changes to lipmaa header.
  • Update spec document CLI usage examples to reflect API changes in 2020.
  • 100% class / module documentation
  • Run a terminology extraction tool on the documentation and write a glossary of terms.
  • Publish to RubyGems

Optimizations

  • add parsers and validators for all CLI inputs
  • Make the switch to LevelDB, RocksDB, UNQLite or similar (currently using Ruby PStore).
  • Reduce whole darn repo into single module to aide portability. ::Helpers module is OK.
  • Update the bundles.md document once bundle consume works.
  • Performance benchmarks (Do this second to last!)
  • Performance tuning (Do this last!)

New Features / Road Map

  • Support partial verification via lipmaa property.
  • Add --since=/--until= args to bundle create for sending partial / "slice" bundles.
  • Interest and Disinterest Signalling for document routing: Create a $blob_status message to express have, want signalling. This can steer bundle creation and an eventual --for flag at bundle creation time to customize a bundle to a particular user.
  • Add a schema for $peer_status. Eg: block, unblock, follow, unfollow.

Idea Bin

  • Ability to add map/reduce plugins to support custom indices?

  • Ability to add a blob in one swoop using File objects and Message#[]=, maybe?

  • Bundling via Optar or Colorsafe

  • Ability to add map/reduce plugins to support custom indices?

  • Ability to add a blob in one swoop using File objects and Message#[]=, maybe?

  • Bundling via Optar or Colorsafe