macaroons 0.6.3 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 08d3a8b767a9be462228f92c22fa97db3be91a0b
-  data.tar.gz: c217878cbaae5c4e36f9ba4bcb1fcd22a3594832
+  metadata.gz: 12077081feaaf8fc5433f0ad4b46dfbc37d740fc
+  data.tar.gz: eb5b5f1d3028790cebd36e218233cf0d5c4df5c3
 SHA512:
-  metadata.gz: b620e558ca340937d4b5dd59c3cff42049c2bc45f014e86b27e90de1fea67630c23584153037c9e1f10ce4de317bbf61136e4a599fac6a45142299db3c81ae5a
-  data.tar.gz: 7ed1c8c1dd7d5e38d48ce82c68f8645a72d520f881e57b1e09737adf6415a5841fcfd22f71d4ca240df97c1e72789f079e478eefa37dca96cb9f63c98dbb1b63
+  metadata.gz: b6e419caf63482deeda7157835841f35d5dcdf7a1f7ade2e668a760801ee1615ebb4b140987a7305d5387161a7264448095ab459532cf4b2f26e7b095149d31f
+  data.tar.gz: 3f107670dd47a75d3ec007d7263b4536ee439e80f91c95a0b99a6c84689679bc174e6ffc10037335bd153ffa71301262a5f7fd5f9ce5e2bef2dd6cc49ad8380f

data/README.md

@@ -3,7 +3,7 @@
 [![Coverage Status](https://img.shields.io/coveralls/localmed/ruby-macaroons.svg)](https://coveralls.io/r/localmed/ruby-macaroons?branch=master)
 [![Gem Version](https://badge.fury.io/rb/macaroons.svg)](http://badge.fury.io/rb/macaroons)
 
-This is a Ruby implementation of Macaroons. It is still under active development but is in a useable state - please report any bugs in the issue tracker.
+This is a Ruby implementation of macaroons. The implementation is stable but should be considered temporary, pending any standardization attempts around macaroons.
 
 ## What is a Macaroon? 
 Macaroons, like cookies, are a form of bearer credential. Unlike opaque tokens, macaroons embed *caveats* that define specific authorization requirements for the *target service*, the service that issued the root macaroon and which is capable of verifying the integrity of macaroons it recieves. 
@@ -14,54 +14,42 @@ Simple examples are outlined below. For more in-depth examples check out the [fu
 
 ## Installing
 
-Macaroons requires a sodium library like libsodium or tweetnacl to be installed on the host system.
+The macaroon implementation is pure Ruby, but relies on [rbnacl-libsodium](https://github.com/cryptosphere/rbnacl-libsodium) to provide strong cryptographic primitives.
 
-To install [libsodium](https://github.com/jedisct1/libsodium):
+Install with: 
 
-For OS X users, libsodium is available via homebrew and can be installed with:
-
-    brew install libsodium
-
-For other systems, please see the [libsodium documentation](http://doc.libsodium.org/).
-
-### Macaroons gem
-
-Once you have libsodium installed, add this line to your application's Gemfile:
-
-    gem 'macaroons'
-
-And then execute:
-
-    $ bundle
-
-Or install it manually:
-
-    $ gem install macaroons
+```
+gem install macaroons
+```
 
-Inside of your Ruby program:
+And then import it into your Ruby program:
 
-    require 'macaroons'
+```ruby
+require 'macaroons'
+```
 
 ## Quickstart
 
-    key => Very secret key used to sign the macaroon
-    identifier => An identifier, to remind you which key was used to sign the macaroon
-    location => The location at which the macaroon is created
+```ruby
+key => Very secret key used to sign the macaroon
+identifier => An identifier, to remind you which key was used to sign the macaroon
+location => The location at which the macaroon is created
 
-    # Construct a Macaroon.
-    m = Macaroon.new(key: key, identifier: identifier, location: 'http://foo.com')
+# Construct a Macaroon.
+m = Macaroon.new(key: key, identifier: identifier, location: 'http://foo.com')
 
-    # Add first party caveat
-    m.add_first_party_caveat('caveat_1')
+# Add first party caveat
+m.add_first_party_caveat('caveat_1')
 
-    # List all first party caveats
-    m.first_party_caveats
+# List all first party caveats
+m.first_party_caveats
 
-    # Add third party caveat
-    m.add_third_party_caveat('caveat_key', 'caveat_id', 'http://foo.com')
+# Add third party caveat
+m.add_third_party_caveat('caveat_key', 'caveat_id', 'http://foo.com')
 
-    # List all third party caveats
-    m.third_party_caveats
+# List all third party caveats
+m.third_party_caveats
+```
 
 ## Example with first- and third-party caveats
 
@@ -118,4 +106,4 @@ PyMacaroons, libmacaroons, and Ruby-Macaroons all use the same underlying crypto
 - [Mozilla Macaroon Tech Talk](https://air.mozilla.org/macaroons-cookies-with-contextual-caveats-for-decentralized-authorization-in-the-cloud/)
 - [libmacaroons](https://github.com/rescrv/libmacaroons)
 - [PyMacaroons](https://github.com/ecordell/pymacaroons)
-- [libnacl](https://github.com/saltstack/libnacl)
+- [rbnacl-libsodium](https://github.com/cryptosphere/rbnacl-libsodium) 

data/lib/macaroons/raw_macaroon.rb

@@ -1,6 +1,6 @@
 require 'base64'
 
-require 'rbnacl'
+require 'rbnacl/libsodium'
 
 require 'macaroons/caveat'
 require 'macaroons/utils'

data/lib/macaroons/verifier.rb

@@ -1,4 +1,4 @@
-require 'rbnacl'
+require 'rbnacl/libsodium'
 
 require 'macaroons/errors'
 

data/lib/macaroons/version.rb

@@ -1,3 +1,3 @@
 module Macaroons
-  VERSION = '0.6.3'
+  VERSION = '0.7.0'
 end

data/macaroons.gemspec

@@ -17,7 +17,8 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
   spec.required_ruby_version = "~> 2.0"
   spec.add_dependency "multi_json", "~> 1.10.1"
-  spec.add_dependency "rbnacl", "~> 3.1.2"
+  spec.add_dependency "rbnacl", "~> 3.2"
+  spec.add_dependency "rbnacl-libsodium", "~> 1.0"
 
   spec.add_development_dependency "bundler", "> 1.3"
   spec.add_development_dependency "rake"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: macaroons
 version: !ruby/object:Gem::Version
-  version: 0.6.3
+  version: 0.7.0
 platform: ruby
 authors:
 - Evan Cordell
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-15 00:00:00.000000000 Z
+date: 2015-12-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -32,14 +32,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.1.2
+        version: '3.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.1.2
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: rbnacl-libsodium
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement