Bump version, minor renames, comments, and docs

Signed-off-by: Silas Davis <[email protected]>

Author: Silas Davis

CHANGELOG.md

@@ -1,4 +1,22 @@
 # [Monax Hoard](https://github.com/monax/hoard) Changelog
+## [Unreleased]
+
+
+## [3.0.0] - 2019-02-26
+### Changed
+- [PROTO] Renamed symmetric grant SecretID to PublicID
+- [PROTO] Renamed openpgp grant ID to PrivateID
+
+### Fixed
+- [GRANTS] Throw an exception if symmetric secret for ID cannot be found
+
+### Added
+- [NODEJS] Added integration tests including test for symmetric secrets
+- [GRANTS] Added openpgp grants example
+- [CLI] Added ability to configure secrets on command line with hoard config <config> --secret
+- 
+
+
 ## [2.0.0] - 2019-02-21
 ### Changed
 - [PROTO] Upper case field names in protobuf
@@ -67,6 +85,8 @@ This is the first Hoard open source release and includes:
 	- Hoar-Daemon hoard
 	- Hoar-Control hoarctl CLI
 
+[Unreleased]: https://github.com/monax/hoard/compare/v3.0.0...HEAD
+[3.0.0]: https://github.com/monax/hoard/compare/v2.0.0...v3.0.0
 [2.0.0]: https://github.com/monax/hoard/compare/v1.1.5...v2.0.0
 [1.1.5]: https://github.com/monax/hoard/compare/v1.1.4...v1.1.5
 [1.1.4]: https://github.com/monax/hoard/compare/v1.1.3...v1.1.4

NOTES.md

@@ -1,14 +1,13 @@
 ### Changed
-- [PROTO] Upper case field names in protobuf
-- [PROTO] Used gogoproto for types
-- [STORE] Go-cloud project for s3 store backend
-- [STORE] Minimized IPFS configuration
+- [PROTO] Renamed symmetric grant SecretID to PublicID
+- [PROTO] Renamed openpgp grant ID to PrivateID
+
+### Fixed
+- [GRANTS] Throw an exception if symmetric secret for ID cannot be found
 
 ### Added
-- [STORE] Initial support for Azure backend thanks to go-cloud
-- [GRANTS] Interface and GRPC service
-- [GRANTS] Symmetric AES-GCM-based grants
-- [GRANTS] Asymmetric OpenPGP support
-- [GRANTS] Go-client (hoarctl) tooling
-- [NODEJS] Support for using the grant service + examples
-- [STORE] IPFS integration test
+- [NODEJS] Added integration tests including test for symmetric secrets
+- [GRANTS] Added openpgp grants example
+- [CLI] Added ability to configure secrets on command line with hoard config <config> --secret
+- 
+

hoard-js/examples.js

@@ -52,14 +52,14 @@ const example = async function (plaintextIn) {
 
         // A plaintext grant allows us to reference the reference without
         // encryption for ease of later retrieval
-        let grantIn = {
+        let plaintextAndGrantSpec = {
             Plaintext: plaintextIn,
             GrantSpec: {
                 Plaintext: {}
             }
         };
 
-        grant = await hoard.putseal(grantIn);
+        grant = await hoard.putseal(plaintextAndGrantSpec);
         console.log(hoard.base64ify(grant));
 
         // We can get the plaintext back by `unsealget`ing the grant
@@ -68,7 +68,7 @@ const example = async function (plaintextIn) {
 
         // A symmetric grant allows us to encrypt the reference
         // through secrets configured on the hoard daemon
-        grantIn = {
+        plaintextAndGrantSpec = {
             Plaintext: plaintextIn,
             GrantSpec: {
                 Symmetric: {
@@ -77,7 +77,7 @@ const example = async function (plaintextIn) {
             }
         };
 
-        grant = await hoard.putseal(grantIn);
+        grant = await hoard.putseal(plaintextAndGrantSpec);
 
         // Convert to string and back again
         grant = JSON.stringify(hoard.base64ify(grant));

hoard-js/test/grants.js

@@ -37,6 +37,7 @@ describe('Should be able to store plaintext under symmetric grant', function ()
             }
         }
         let hoard = new Hoard.Client('localhost:53431');
-        assert.rejects(() => hoard.putseal(plaintextAndGrantSpec), Error);
+        assert.rejects(() => hoard.putseal(plaintextAndGrantSpec), Error,
+            "should fail when PublicID id not known to Hoard");
     });
 });

project/history.go

@@ -29,7 +29,22 @@ func FullVersion() string {
 // To cut a new release add a release to the front of this slice then run the
 // release tagging script: ./scripts/tag_release.sh
 var History relic.ImmutableHistory = relic.NewHistory("Monax Hoard", "https://github.com/monax/hoard").
-	MustDeclareReleases(
+	MustDeclareReleases("",
+		``,
+		"3.0.0 - 2019-02-26",
+		`### Changed
+- [PROTO] Renamed symmetric grant SecretID to PublicID
+- [PROTO] Renamed openpgp grant ID to PrivateID
+
+### Fixed
+- [GRANTS] Throw an exception if symmetric secret for ID cannot be found
+
+### Added
+- [NODEJS] Added integration tests including test for symmetric secrets
+- [GRANTS] Added openpgp grants example
+- [CLI] Added ability to configure secrets on command line with hoard config <config> --secret
+- 
+`,
 		"2.0.0 - 2019-02-21",
 		`### Changed
 - [PROTO] Upper case field names in protobuf