json_web_token 0.3.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 53e92d6fa2738b3d32a6cb7ab7d1a6ac0b4da985
-  data.tar.gz: 18518b039fe8009cb69d73f7a1bb0a7b1e49e520
+  metadata.gz: 1f2f2e9c05d1aa0624ecb4c80542779a4947440d
+  data.tar.gz: a743b29a91a80f888ef14cff51a31692e007955d
 SHA512:
-  metadata.gz: d871623ab5168a3749e59c0c8a249262136517899d3d875cb7401b99a7f80d33134245e5b66b51673327b3e6e90362a8a75d2ae6082d6f2060404363e7408911
-  data.tar.gz: 769622487b7bfc6df0013f4c977e39a17f1f0975328ecb26f7c7c1718e9c96bc66e170321c749beaabebd83c55061bfcdf90b7fa7d927322ffcf8b9032d342e0
+  metadata.gz: 33a0ad974222c5dc8773f9640f90e07e70b5afaa6986476341c6a2cbafd114e392810f33be973d85cc91c29e366fe7e6c1d2815870563310b648ef7dc29e8fc6
+  data.tar.gz: df28c9e985c1fd29e09cc13ae48c4b486b00f350f5d37cb92d876f9c0a3df152bba6c71432f5bd924d9a4e52c15c9d6501aa115e7040dc0d3568c590069faa13

data/.rspec

@@ -1,2 +1 @@
 --color
---require spec_helper

data/.travis.yml

@@ -1,7 +1,7 @@
 language: ruby
 rvm:
-  - 2.2.2
-  - 2.1.6
-  - 2.0.0
-# uncomment this line if your project needs to run something other than `rake`:
-script: bundle exec rspec spec
+  - 2.0.0-p648
+  - 2.1.10
+  - 2.2.5
+  - 2.3.1
+before_install: gem install bundler -v 1.13.2

data/CHANGELOG.md

@@ -1,51 +1,58 @@
 ## Changelog
 
+### v0.3.2 (2016-10-09)
+
+* Enhancements
+  * Modernized the dev environment
+  * Added a `Support for JWT Registered Claims` section to the README, along with a link to the companion `jwt_claims` gem
+  * Fixed the README examples by using working tokens
+
 ### v0.3.1 (2015-08-25)
 
-* bug fix
+* Bug fixes
   * README escaping removed
 
 ### v0.3.0 (2015-08-25)
 
-* backward incompatible changes
+* Backward incompatible changes
   * JsonWebToken, Jwt, and Jws #verify return values
 
 ### v0.2.2 (2015-08-06)
 
-* enhancements
+* Enhancements
   * RsaUtil to read keys from pem files
 
 ### v0.2.1 (2015-08-03)
 
-* enhancements
+* Enhancements
   * Rsa#validate\_message\_size
 
 ### v0.2.0 (2015-08-02)
 
-* backward incompatible changes
+* Backward incompatible changes
   * Top level API now #sign and #verify
 
 ### v0.1.2 (2015-08-02)
 
-* enhancements
+* Enhancements
   * Jws#verify returns false (rather than 'Invalid') unless the signature is verified
 
 ### v0.1.1 (2015-07-13)
 
-* bug fix
+* Bug fixes
   * #symbolize_keys spec failing on < ruby-2.2.0
 
 ### v0.1.0 (2015-07-12)
 
-* enhancements
+* Enhancements
   * support ECDSA algorithm
 
 ### v0.0.2 (2015-07-11)
 
-* enhancements
+* Enhancements
   * support RSASSA-PKCS-v1_5 algorithm
 
 ### v0.0.1 (2015-07-09)
 
-* initial
+* Initial
   * support HMAC algorithm

data/Gemfile

@@ -1,7 +1,4 @@
 source 'https://rubygems.org'
 
+# Specify your gem's dependencies in json_web_token.gemspec
 gemspec
-
-gem 'pry-byebug', '~> 3.1', require: false
-gem 'simplecov', '~> 0.10', require: false
-gem 'yard', '~> 0.8', require: false

data/LICENSE.md

@@ -0,0 +1,9 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Gary Fleshman
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -28,6 +28,16 @@ Token authentication of API requests to Rails via these prominent gems:
 
 Secure Cross-Origin Resource Sharing ([CORS][cors]) using the [rack-cors][rack-cors] gem
 
+### Support for JWT Registered Claims
+
+Support for the standard registered claims documented
+in [RFC 7519][rfc7519] can be found in the companion gem [jwt_claims](https://github.com/garyf/jwt_claims).
+
+`jwt_claims` is a wrapper around `json_web_token` and provides support
+for the full set of registered claims.
+
+[https://github.com/garyf/jwt_claims](https://github.com/garyf/jwt_claims)
+
 ## Usage
 
 ### JsonWebToken.sign(claims, options)
@@ -46,10 +56,11 @@ Example
 ```ruby
 require 'json_web_token'
 
-# sign with default algorithm, HMAC SHA256
+# Sign with the default algorithm, HMAC SHA256
 jwt = JsonWebToken.sign({foo: 'bar'}, key: 'gZH75aKtMN3Yj0iPS4hcgUuTwjAzZr9C')
+#=> "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJmb28iOiJiYXIifQ.vpaYTGkypBmxDi3KZYcvpqLx9xqhRD-DSXONGrUbf5Q"
 
-# sign with RSA SHA256 algorithm
+# Sign with RSA SHA256 algorithm
 opts = {
   alg: 'RSA256',
   key: < RSA private key >
@@ -57,7 +68,7 @@ opts = {
 
 jwt = JsonWebToken.sign({foo: 'bar'}, opts)
 
-# unsecured token (algorithm is 'none')
+# Create an unsecured token (algorithm is 'none')
 jwt = JsonWebToken.sign({foo: 'bar'}, alg: 'none')
 
 ```
@@ -80,10 +91,13 @@ Example
 ```ruby
 require 'json_web_token'
 
-secure_jwt_example = 'eyJ0eXAiOiJKV1QiLA0KICJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJqb2UiLA0KICJleHAiOjEzMDA4MTkzODAsDQogImh0dHA6Ly9leGFt.cGxlLmNvbS9pc19yb290Ijp0cnVlfQ.dBjftJeZ4CVP-mB92K27uhbUJU1p1r_wW1gFWFOEjXk'
+jwt = JsonWebToken.sign({foo: 'bar'}, key: 'gZH75aKtMN3Yj0iPS4hcgUuTwjAzZr9C')
+#=> "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJmb28iOiJiYXIifQ.vpaYTGkypBmxDi3KZYcvpqLx9xqhRD-DSXONGrUbf5Q"
 
-# verify with default algorithm, HMAC SHA256
-{ok: claims} = JsonWebToken.verify(secure_jwt_example, key: 'gZH75aKtMN3Yj0iPS4hcgUuTwjAzZr9C')
+# Verify with default algorithm, HMAC SHA256
+# Returns a hash of `{:ok, verified_claims}`
+JsonWebToken.verify(jwt, key: 'gZH75aKtMN3Yj0iPS4hcgUuTwjAzZr9C')
+#=> {:ok=>{:foo=>"bar"}}
 
 # verify with RSA SHA256 algorithm
 opts = {
@@ -93,12 +107,14 @@ opts = {
 
 {ok: claims} = JsonWebToken.verify(jwt, opts)
 
-# unsecured token (algorithm is 'none')
-unsecured_jwt_example = 'eyJ0eXAiOiJKV1QiLA0KICJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJqb2UiLA0KICJleHAiOjEzMDA4MTkzODAsDQogImh0dHA6Ly9leGFt.'
-
-{ok: claims} = JsonWebToken.verify(unsecured_jwt_example, alg: 'none')
+# Unsecured token (algorithm is 'none')
+jwt = JsonWebToken.sign({foo: 'bar'}, alg: 'none')
+#=> "eyJ0eXAiOiJKV1QiLCJhbGciOiJub25lIn0.eyJmb28iOiJiYXIifQ."
 
+JsonWebToken.verify(jwt, alg: 'none')
+#=> {:ok=>{:foo=>"bar"}}
 ```
+
 ### Supported encryption algorithms
 
 alg Param Value | Digital Signature or MAC Algorithm

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'yard'
+require 'wwtd/tasks'
+
+RSpec::Core::RakeTask.new(:spec)
+
+YARD::Rake::YardocTask.new
+
+task default: :spec

data/bin/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'json_web_token'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+require 'pry'
+Pry.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/json_web_token.gemspec

@@ -1,21 +1,36 @@
-# -*- encoding: utf-8 -*-
-$:.push File.expand_path("../lib", __FILE__)
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'json_web_token/version'
 
 Gem::Specification.new do |s|
-  s.author = 'Gary Fleshman'
-  s.email = 'gfleshman@newforge-tech.com'
-  s.files = `git ls-files`.split("\n")
-  s.homepage = 'https://github.com/garyf/json_web_token'
-  s.name = 'json_web_token'
+  s.name          = 'json_web_token'
+  s.version       = JsonWebToken::VERSION
+  s.authors       = ['Gary Fleshman']
+  s.email         = ['gfleshman@newforge-tech.com']
+
+  s.summary       = 'JSON Web Token (JWT) for Ruby'
+  s.description   = 'Ruby implementation of the JSON Web Token (JWT) standard, RFC 7519'
+  s.homepage      = 'https://github.com/garyf/json_web_token'
+  s.license       = 'MIT'
+
+  s.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+
+  s.require_paths = ['lib']
+
   s.platform = Gem::Platform::RUBY
-  s.summary = 'JSON Web Token (JWT) for Ruby'
-  s.version = JsonWebToken::VERSION
-  # recommended
-  s.license = 'MIT'
-  # optional
-  s.add_runtime_dependency 'json', '~> 1.8', '>= 1.8.3'
-  s.add_development_dependency 'rspec', '~> 3.3'
-  s.description = 'Ruby implementation of the JSON Web Token (JWT) standard, RFC 7519'
   s.required_ruby_version = '>= 2.0.0'
+
+  s.add_runtime_dependency 'json', '>= 1.8.3'
+
+  s.add_development_dependency 'bundler', '~> 1.13'
+  s.add_development_dependency 'rake', '~> 10.0'
+  s.add_development_dependency 'rspec', '~> 3.0'
+  s.add_development_dependency 'pry', '~> 0.10'
+  s.add_development_dependency 'pry-byebug', '~> 3.4'
+  s.add_development_dependency 'simplecov', '~> 0.12'
+  s.add_development_dependency 'yard', '~> 0.9'
+  s.add_development_dependency 'wwtd', '~> 1.3'
 end

data/lib/json_web_token/version.rb

@@ -1,3 +1,3 @@
 module JsonWebToken
-  VERSION = '0.3.1'
+  VERSION = '0.3.2'
 end

metadata

@@ -1,22 +1,19 @@
 --- !ruby/object:Gem::Specification
 name: json_web_token
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
 platform: ruby
 authors:
 - Gary Fleshman
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-25 00:00:00.000000000 Z
+date: 2016-10-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.8'
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.8.3
@@ -24,28 +21,124 @@ dependencies:
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.8'
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.8.3
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.3'
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: wwtd
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.3'
+        version: '1.3'
 description: Ruby implementation of the JSON Web Token (JWT) standard, RFC 7519
-email: gfleshman@newforge-tech.com
+email:
+- gfleshman@newforge-tech.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -55,8 +148,11 @@ files:
 - ".travis.yml"
 - CHANGELOG.md
 - Gemfile
-- LICENSE
+- LICENSE.md
 - README.md
+- Rakefile
+- bin/console
+- bin/setup
 - json_web_token.gemspec
 - lib/json_web_token.rb
 - lib/json_web_token/algorithm/common.rb
@@ -71,23 +167,6 @@ files:
 - lib/json_web_token/jwt.rb
 - lib/json_web_token/util.rb
 - lib/json_web_token/version.rb
-- spec/fixtures/rsa/private_key.pem
-- spec/fixtures/rsa/private_key_weak.pem
-- spec/fixtures/rsa/public_key.pem
-- spec/fixtures/rsa/public_key_alt.pem
-- spec/json_web_token/algorithm/ecdsa_spec.rb
-- spec/json_web_token/algorithm/hmac_spec.rb
-- spec/json_web_token/algorithm/rsa_spec.rb
-- spec/json_web_token/format/asn1_spec.rb
-- spec/json_web_token/format/base64_url_spec.rb
-- spec/json_web_token/jwa_spec.rb
-- spec/json_web_token/jws_spec.rb
-- spec/json_web_token/jwt_spec.rb
-- spec/json_web_token/util_spec.rb
-- spec/json_web_token_spec.rb
-- spec/spec_helper.rb
-- spec/support/ecdsa_key.rb
-- spec/support/plausible_jwt.rb
 homepage: https://github.com/garyf/json_web_token
 licenses:
 - MIT
@@ -108,9 +187,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.6.7
 signing_key: 
 specification_version: 4
 summary: JSON Web Token (JWT) for Ruby
 test_files: []
-has_rdoc: