2019-10-10 00:32:54 +00:00
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
2019-09-25 01:19:25 +00:00
- [X] pigeon status
2019-09-22 02:31:01 +00:00
- [X] pigeon blob set
2019-09-22 11:00:19 +00:00
- [X] pigeon blob get
2019-09-23 01:07:14 +00:00
- [X] pigeon peer add
- [X] pigeon peer remove
- [X] pigeon peer block
2019-09-25 01:31:32 +00:00
- [X] pigeon peer all
2020-03-07 15:38:34 +00:00
- [X] 100% coverage
2020-03-14 03:02:45 +00:00
- [X] Convert `".sig.ed25519"` literals to constants
2020-03-14 03:17:56 +00:00
- [X] Rename numerous "pigeon message ..." commands to "pigeon draft ..."
2020-03-14 03:41:31 +00:00
- [X] pigeon draft create
- [X] pigeon draft append
- [X] pigeon draft current
- [X] pigeon draft save
2020-03-15 16:51:13 +00:00
- [X] pigeon bundle create
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.
2020-03-15 18:50:00 +00:00
- [X] pigeon message find
- [X] pigeon message find-all for local feed.
2020-03-31 12:30:44 +00:00
- [X] pigeon bundle consume (We are minimally feature complete at this point)
- [X] Fix the diagram in the spec document
2020-04-02 12:32:21 +00:00
- [X] Validate inputs for `Draft#[]=` .
- [X] Put all the [HEADER, string, FOOTER].join("") nonsense into Pigeon::Helpers
2020-04-02 12:58:57 +00:00
- [X] Use raw SHA256 hashes for blob multihashes, not hex.
- [X] Change all the `{40,90}` values in ::Lexer to real length values
2020-04-03 09:41:03 +00:00
- [ ] Is it possible signature verification is failing beecause a CR is being prepended to the front?
2020-04-02 12:58:57 +00:00
- [ ] Rename (RemoteIdentity|LocalIdentity)#public_key to #multihash for consistency with other types.
2020-03-18 12:32:40 +00:00
- [ ] Rename `message find` to `message read` , since other finders return a multihash.
2020-04-02 12:58:57 +00:00
- [ ] Don't allow carriage return in `kind` or `string` keys. Write a test for this.
2020-03-17 13:40:09 +00:00
- [ ] Create regexes in ::Lexer using strings and Regexp.new() for cleaner regexes.
2020-04-02 12:58:57 +00:00
- [ ] Ensure all disks writes perform verification!
- [ ] Implement pigeon message find-all for peer feed. I will need to add index for `author => message_count`
2020-03-15 18:50:00 +00:00
- [ ] refactor `Bundle.create` to use `message find-all` .
2020-03-15 18:12:26 +00:00
- [ ] add parsers and validators for all CLI inputs
2020-03-14 03:41:31 +00:00
- [ ] Remove all `.current` "singletons" / hacks
2020-04-02 12:32:21 +00:00
- [ ] Reduce whole darn repo into single module to aide portability. Maybe a second `::Support` module is OK.
2019-09-23 01:09:04 +00:00
- [ ] 100% documentation
2020-04-02 12:32:21 +00:00
- [ ] 100% test coverage
- [ ] Update the bundles.md document once `bundle consume` works.
- [ ] Use URNs instead of multihash?
- [ ] Add `.pigeon` file extensions
2019-10-12 19:43:27 +00:00
- [ ] Update spec to look [like this ](https://gist.github.com/RickCarlino/3ff4178db4a75fd135832c403cd313d4 )
2020-03-14 03:02:45 +00:00
- [ ] Add Lipmaa links like the Bamboo folks do.
2020-03-08 16:18:05 +00:00
- [ ] Publish a RubyGem
2020-03-14 03:02:45 +00:00
- [ ] Performance benchmarks
- [ ] Performance tuning (DO THIS LAST!)
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?
