gris-middleware-json_web_token_decoder 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 59ad23037d6881c9aa162369342e9624ef1e3783
+  data.tar.gz: 72e40c5ff01b282948241f3be31caf885bd49c54
+SHA512:
+  metadata.gz: 3b08ebe0410503f25c03769415274f2596c8d6dc83b2278683c5f32c48aa342657e75799057b11676407e636da9d6bac3e8c6f46241c1b886c85a9bff936d286
+  data.tar.gz: 5ed4efbecd1f567f50b9ebac464fa2dacb4f615b5bd5a3a23bb301cc764c4c2ac7f650ce62e9f6b59d3c08cf2525a30ab5e55ce33645222887d4796f996d30be

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--profile
+--format documentation

data/.rubocop.yml

@@ -0,0 +1 @@
+inherit_from: .rubocop_todo.yml

data/.rubocop_todo.yml

@@ -0,0 +1,13 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2015-08-20 12:02:49 -0400 using RuboCop version 0.33.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 2
+Style/Documentation:
+  Exclude:
+    - 'lib/gris/middleware/json_web_token_decoder.rb'
+    - 'lib/gris/middleware/json_web_token_decoder/version.rb'

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2015 Dylan Fareed
+
+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

@@ -0,0 +1,62 @@
+# Gris::Middleware::JsonWebTokenDecoder
+
+The cleverly named [Gris::Middleware::JsonWebTokenDecoder](https://github.com/dylanfareed/gris-middleware-json_web_token_decoder) is a simple middleware for decoding [JWT](http://jwt.io) token headers in your [Gris](https://github.com/artsy/gris) app's Grape endpoints.
+
+It uses the Ruby [jwt](https://github.com/jwt/ruby-jwt) gem to do the heavy lifting.
+
+Gris::Middleware::JsonWebTokenDecoder is alpha software and only presently supports HS256.
+
+---
+
+### Installation
+
+Gris::Middleware::JsonWebTokenDecoder is [available as a gem on rubygems](https://rubygems.org/gems/gris-middleware-json_web_token_decoder), to install it run:
+
+```
+gem install gris-middleware-json_web_token_decoder
+```
+
+Otherwise, if your project uses [Bundler](http://bundler.io/), add gris-middleware-decoder to your Gemfile:
+
+```
+gem 'gris-middleware-json_web_token_decoder'
+```
+
+And run:
+
+```
+$ bundle install
+```
+
+---
+
+### Usage
+
+Set a value for `hmac_secret` in your Gris config/secrets.yml file.
+
+```
+default: &default
+  service_name: smithson
+  hmac_secret: <%= ENV['HMAC_SECRET'] || 'https://www.youtube.com/watch?v=F5bAa6gFvLs' %>
+  base_url: <%= ENV['BASE_URL'] || 'http://localhost:9292' %>
+
+development:
+  <<: *default
+
+test:
+  <<: *default
+
+production:
+  <<: *default
+```
+
+Add the middleware to your endpoint:
+
+```ruby
+class ApplicationEndpoint < Grape::API
+  use Gris::Middleware::JsonWebTokenDecoder
+```
+
+For requests that include HTTP_AUTHORIZATION headers in the format of "Bearer: ENCODED_TOKEN", Gris::Middleware::JsonWebTokenDecoder will return a `GRIS_JWT_PAYLOAD` along with the `@env`.
+
+You can choose how to make use of this in your applications.

data/Rakefile

@@ -0,0 +1,15 @@
+# encoding: utf-8
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RSpec::Core::RakeTask.new
+
+desc 'Run RuboCop'
+RuboCop::RakeTask.new(:rubocop) do |task|
+  task.fail_on_error = true
+  task.options = %w(-D --auto-correct)
+end
+
+task default: [:rubocop, :spec]

data/gris-middleware-json_web_token_decoder.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'gris/middleware/json_web_token_decoder/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'gris-middleware-json_web_token_decoder'
+  spec.version       = Gris::Middleware::JsonWebTokenDecoder::VERSION
+  spec.authors       = ['Dylan Fareed']
+  spec.email         = ['email@dylanfareed.com']
+  spec.summary       = 'Simple middleware for decoding JWT tokens in Gris apps.'
+  spec.description   = 'Simple middleware for decoding JWT tokens in Gris apps.'
+  spec.homepage      = 'https://github.com/dylanfareed/gris-middleware-json_web_token_decoder'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'gris'
+  spec.add_dependency 'jwt'
+
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'byebug'
+end

data/lib/gris/middleware/json_web_token_decoder.rb

@@ -0,0 +1,25 @@
+require 'gris'
+require 'gris/middleware/json_web_token_decoder/version'
+
+module Gris
+  class Middleware
+    class JsonWebTokenDecoder
+      def initialize(app)
+        @app = app
+      end
+
+      def call(env)
+        if env['HTTP_AUTHORIZATION']
+          token = parse_header env['HTTP_AUTHORIZATION']
+          decoded_token = JWT.decode token, Gris.secrets.hmac_secret
+          env['GRIS_JWT_PAYLOAD'] = decoded_token
+        end
+        @app.call env
+      end
+
+      def parse_header(header)
+        header.split(' ').last
+      end
+    end
+  end
+end

data/lib/gris/middleware/json_web_token_decoder/version.rb

@@ -0,0 +1,7 @@
+module Gris
+  class Middleware
+    class JsonWebTokenDecoder
+      VERSION = '0.0.1'
+    end
+  end
+end

data/spec/lib/gris/middleware/json_web_token_decoder_spec.rb

@@ -0,0 +1,39 @@
+require 'spec_helper'
+
+describe Gris::Middleware::JsonWebTokenDecoder do
+  let(:hmac_secret) { 'https://www.youtube.com/watch?v=F5bAa6gFvLs' }
+  subject { described_class.new(app) }
+
+  let(:token) do
+    JWT.encode payload_data, hmac_secret, 'HS256'
+  end
+
+  let(:payload_data) do
+    {
+      'carl' => 'So its a code breaker?',
+      'marty' => 'No its the code breaker.'
+    }
+  end
+
+  let(:app) { ->(env) { [200, env, env] } }
+
+  context 'with HTTP_AUTHORIZATION header' do
+    before do
+      Gris.secrets.hmac_secret = hmac_secret
+    end
+
+    it "decodes token and sets env['GRIS_JWT_PAYLOAD']" do
+      status, _, env = subject.call('HTTP_AUTHORIZATION' => "Bearer: #{token}")
+      expect(env['GRIS_JWT_PAYLOAD'].first).to eql payload_data
+      expect(status).to eq(200)
+    end
+  end
+
+  context 'without HTTP_AUTHORIZATION header' do
+    it "does not set env['GRIS_JWT_PAYLOAD']" do
+      status, _, env = subject.call({})
+      expect(env['GRIS_JWT_PAYLOAD']).to be_nil
+      expect(status).to eq(200)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+require 'byebug'
+require 'gris/middleware/json_web_token_decoder'
+require 'jwt'

metadata

@@ -0,0 +1,157 @@
+--- !ruby/object:Gem::Specification
+name: gris-middleware-json_web_token_decoder
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Dylan Fareed
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-08-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: gris
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: jwt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Simple middleware for decoding JWT tokens in Gris apps.
+email:
+- email@dylanfareed.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
+- Gemfile
+- MIT-LICENSE
+- README.md
+- Rakefile
+- gris-middleware-json_web_token_decoder.gemspec
+- lib/gris/middleware/json_web_token_decoder.rb
+- lib/gris/middleware/json_web_token_decoder/version.rb
+- spec/lib/gris/middleware/json_web_token_decoder_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/dylanfareed/gris-middleware-json_web_token_decoder
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: Simple middleware for decoding JWT tokens in Gris apps.
+test_files:
+- spec/lib/gris/middleware/json_web_token_decoder_spec.rb
+- spec/spec_helper.rb