decode_this 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 90dca39ac2ebd159e00e009f2701e0d07a9edb78
-  data.tar.gz: fb4fa59ce7bf405fa56329e86494a45f391d68ca
+  metadata.gz: a402dd6e09333fe90e81f7389710c76dde358f21
+  data.tar.gz: 8e87ea52fe43b899f8bf348313bb0f041d01442c
 SHA512:
-  metadata.gz: cb2f2c1264b8aa3b4a51d9b2a2359ad24357d161b783417ee09afbc116efdfabf3cb2fd2f3a836fe795d210daa1acf63cd261c3cd84a83d3cfd1c1d0504b751e
-  data.tar.gz: 11c9b17f0537329792a860f4b7328aed97dce3f57786b1eef03ec5ba0af8a99e5c92bbce817900ae0a92fa2ada9d85879b68565fcc9737d2ec96388c9195513a
+  metadata.gz: '005134392d22ddb00b5f206a367d9c6f3ea1fd433ae0c38a9a493e28352e427f58f40f5dacea49da9ec562a123d02250cb8215620c7395875cd790443dc76fd9'
+  data.tar.gz: 79dd5599461321a3c3b59c9afecd9ac5394201dacc9489def6ad6503e002e19b9183da228cf0ee35cc04fc486193d0f2f9f478aff58542b37012d8558c23960c

data/.gitignore

@@ -7,3 +7,4 @@
 /pkg/
 /spec/reports/
 /tmp/
+coverage

data/.travis.yml

@@ -1,5 +1,19 @@
-sudo: false
+env:
+  global:
+    - CC_TEST_REPORTER_ID=caf8d649c1f1517bab58f7cbaa98600465446c8d210093e20a5e819b0066eca4
+notifications:
+  - false
+
 language: ruby
+sudo: required
 rvm:
   - 2.2.5
-before_install: gem install bundler
+
+before_script:
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+  - chmod +x ./cc-test-reporter
+  - ./cc-test-reporter before-build
+script:
+  - bundle exec rspec
+after_script:
+  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT

data/Gemfile

@@ -2,3 +2,12 @@
 source 'https://rubygems.org'
 
 gemspec
+
+group :test do
+  gem 'simplecov', require: false
+  gem 'simplecov-console', require: false
+end
+
+group :development, :test do
+  gem 'pry-byebug'
+end

data/Readme.md

@@ -1,6 +1,7 @@
 # DecodeThis
 
 [![Build Status](https://travis-ci.org/myxaluch/decode_this.svg?branch=master)](https://travis-ci.org/myxaluch/decode_this)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/182d13aea55106ba87a4/test_coverage)](https://codeclimate.com/github/myxaluch/decode_this)
 
 Simple decoder JWT token by given key
 
@@ -26,7 +27,8 @@ Configuration file scheme:
 ```
 test:
   algorithm: 'RS256'
-  path: 'paht/to/keys'
+  authorization_scheme: 'Bearer'
+  key_path: 'paht/to/keys'
 ```
 
 ```ruby
@@ -34,9 +36,16 @@ payload = {
   'field1' => 'foo',
   'field2' => 'bar'
 }
-jwt_token = JWT.encode(payload, private_token, true, algorithm: algorithm)
+jwt_token = JWT.encode(payload, private_key, true, algorithm: algorithm)
 ...
-decoded_token = DecodeThis.decode(jwt_token, config_file: '/path/to/config.yml', env: :my_env, logger: logger)
+header_value = request.env['HTTP_AUTHENTICATION'] // "Bearer fgjsgkjsfslfjg.."
+decoded_token = DecodeThis::Decoder.call(
+  header_value,
+  config_file: '/path/to/config.yml',
+  env: :my_env,
+  logger: logger
+)
+
 token['field1'] = 'foo'
 token['field2'] = 'bar'
 ```

data/lib/decode_this/decoder.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+require 'decode_this/safe_decoding'
+require 'openssl'
+require 'jwt'
+require 'huyettings'
+
+module DecodeThis
+  class Decoder
+    attr_reader :header_value, :config_file, :env, :logger
+
+    def initialize(header_value, config_file:, env:, logger: nil)
+      @header_value = header_value
+      @config_file = config_file
+      @env = env
+      @logger = logger
+    end
+
+    def call
+      safe_decode { JWT.decode(token, public_key, true, algorithm: algorithm).first }
+    end
+
+    private
+
+    def config
+      @config ||= Huyettings.new(config_file, env)
+    end
+
+    def algorithm
+      config.algorithm
+    end
+
+    def token
+      return unless header_value
+
+      token = header_value.match(/^#{config.authorization_scheme} (.+)/)
+      token[1] if token
+    end
+
+    def public_key
+      private_key.public_key
+    end
+
+    def safe_decode(&block)
+      DecodeThis::SafeDecoding.call(logger, &block)
+    end
+
+    def private_key
+      OpenSSL::PKey::RSA.new(pem)
+    end
+
+    def pem
+      keys_absolute_path = File.expand_path(config.key_path)
+
+      if !File.readable?(keys_absolute_path)
+        raise DecodeThis::KeyFileNotFoundError.new("Cannot found file in #{config.key_path}")
+      end
+
+      File.read(config.key_path)
+    end
+  end
+end

data/lib/decode_this/safe_decoding.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+module DecodeThis
+  KeyFileNotFoundError = Class.new(RuntimeError)
+  DecodeError = Class.new(RuntimeError)
+
+  class SafeDecoding
+    def self.call(logger = nil, &block)
+      block.call
+
+    rescue JWT::ExpiredSignature => err
+      handle_and_log_error(
+        DecodeThis::DecodeError,
+        "Expired token #{err.class} - #{err.message}",
+        logger
+      )
+    rescue JWT::VerificationError => err
+      handle_and_log_error(
+        DecodeThis::DecodeError,
+        "Can't verify token #{err.class} - #{err.message}",
+        logger
+      )
+    rescue JWT::DecodeError => err
+      handle_and_log_error(
+        DecodeThis::DecodeError,
+        "Can't decode token '#{jwt_token}' #{err.class} - #{err.message}",
+        logger
+      )
+    rescue DecodeThis::KeyFileNotFoundError => err
+      handle_and_log_error(
+        DecodeThis::KeyFileNotFoundError,
+        err.message,
+        logger
+      )
+    end
+
+    def self.handle_and_log_error(raising_error, message, logger = nil)
+      logger.warn(message) if logger
+
+      raise raising_error.new(message)
+    end
+  end
+end

data/lib/decode_this/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
-class DecodeThis
-  VERSION = '0.1.3'
+module DecodeThis
+  VERSION = '0.1.4'
 end

data/lib/decode_this.rb

@@ -1,58 +1,3 @@
 # frozen_string_literal: true
 require 'decode_this/version'
-require 'huyettings'
-require 'openssl'
-require 'jwt'
-
-class DecodeThis
-  ConfigFileNotFoundError = Class.new(RuntimeError)
-  DecodeError = Class.new(RuntimeError)
-
-  attr_reader :token, :config_file, :env, :logger
-
-  def initialize(token, config_file:, env:, logger: nil)
-    @token = token
-    @config_file = config_file
-    @env = env
-    @logger = logger
-  end
-
-  def decode
-    JWT.decode(token, public_key, true, algorithm: algorithm).first
-
-  rescue JWT::ExpiredSignature => err
-    logger.warn("Expired JWT token #{err.class} - #{err.message}") if logger
-    raise DecodeError
-  rescue JWT::VerificationError => err
-    logger.warn("Can't verify JWT token #{err.class} - #{err.message}") if logger
-    raise DecodeError
-  rescue JWT::DecodeError => err
-    logger.warn("Can't decode JWT token '#{jwt_token}' #{err.class} - #{err.message}") if logger
-    raise DecodeError
-  end
-
-  private
-
-  def jwt_config
-    @jwt_config ||= Huyettings.new(config_file, env)
-  end
-
-  def algorithm
-    jwt_config.algorithm
-  end
-
-  def public_key
-    private_key.public_key
-  end
-
-  def private_key
-    OpenSSL::PKey::RSA.new(pem)
-  end
-
-  def pem
-    keys_absolute_path = File.expand_path(jwt_config.path)
-
-    raise ConfigFileNotFoundError.new("Cannot found file in #{jwt_config.path}") unless File.readable?(keys_absolute_path)
-    File.read(jwt_config.path)
-  end
-end
+require 'decode_this/decoder'

data/spec/decode_this/decoder_spec.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+require 'spec_helper'
+
+RSpec.describe DecodeThis::Decoder do
+  let(:config_path) { File.expand_path('spec/fixtures/config.yml') }
+  let(:payload) { { field: 'foobar' } }
+  let(:header_value) { encode(payload) }
+  let(:logger) { Logger.new(STDOUT) }
+
+  subject(:decoded_token) do
+    described_class.new(header_value, config_file: config_path, env: :test, logger: logger).call
+  end
+
+  it 'decodes given token correctly' do
+    payload.keys.each do |key|
+      expect(decoded_token[key.to_s]).to eq(payload[key])
+    end
+  end
+
+  context 'when check correct error raising' do
+    context 'when raise error when config file not present' do
+      let(:config_path) { 'spec/fixtures/nonexistent_config.yml' }
+
+      it 'raises ConfigFileNotFoundError' do
+        expect(logger).to receive(:warn).and_call_original
+        expect { decoded_token }.to raise_error { DecodeThis::KeyFileNotFoundError }
+      end
+    end
+
+    context 'when raise error when token is expired' do
+      let(:payload) { { field: 'foobar', exp: -1 } }
+
+      it 'raises DecodeError' do
+        expect(logger).to receive(:warn).and_call_original
+        expect { decoded_token }.to raise_error { DecodeThis::DecodeError }
+      end
+    end
+
+    context 'when raise error when try to decode by another key' do
+      let(:config_path) { File.expand_path('spec/fixtures/another_config.yml') }
+
+      it 'raises DecodeError' do
+        expect(logger).to receive(:warn).and_call_original
+        expect { decoded_token }.to raise_error { DecodeThis::DecodeError }
+      end
+    end
+  end
+end

data/spec/fixtures/another_config.yml

@@ -0,0 +1,4 @@
+test:
+  algorithm: 'RS256'
+  authorization_scheme: 'Bearer'
+  key_path: './spec/fixtures/another_unsecured.pem'

data/spec/fixtures/another_unsecured.pem

@@ -0,0 +1,13 @@
+-----BEGIN RSA PRIVATE KEY-----
+MIICXAIBAAKBgQCqGKukO1De7zhZj6+H0qtjTkVxwTCpvKe4eCZ0FPqri0cb2JZfXJ/DgYSF6vUp
+wmJG8wVQZKjeGcjDOL5UlsuusFncCzWBQ7RKNUSesmQRMSGkVb1/3j+skZ6UtW+5u09lHNsj6tQ5
+1s1SPrCBkedbNf0Tp0GbMJDyR4e9T04ZZwIDAQABAoGAFijko56+qGyN8M0RVyaRAXz++xTqHBLh
+3tx4VgMtrQ+WEgCjhoTwo23KMBAuJGSYnRmoBZM3lMfTKevIkAidPExvYCdm5dYq3XToLkkLv5L2
+pIIVOFMDG+KESnAFV7l2c+cnzRMW0+b6f8mR1CJzZuxVLL6Q02fvLi55/mbSYxECQQDeAw6fiIQX
+GukBI4eMZZt4nscy2o12KyYner3VpoeE+Np2q+Z3pvAMd/aNzQ/W9WaI+NRfcxUJrmfPwIGm63il
+AkEAxCL5HQb2bQr4ByorcMWm/hEP2MZzROV73yF41hPsRC9m66KrheO9HPTJuo3/9s5p+sqGxOlF
+L0NDt4SkosjgGwJAFklyR1uZ/wPJjj611cdBcztlPdqoxssQGnh85BzCj/u3WqBpE2vjvyyvyI5k
+X6zk7S0ljKtt2jny2+00VsBerQJBAJGC1Mg5Oydo5NwD6BiROrPxGo2bpTbu/fhrT8ebHkTz2epl
+U9VQQSQzY1oZMVX8i1m5WUTLPz2yLJIBQVdXqhMCQBGoiuSoSjafUhV7i1cEGpb88h5NBYZzWXGZ
+37sJ5QsW+sJyoNde3xH8vdXhzU7eT82D6X/scw9RZz+/6rCJ4p0=
+-----END RSA PRIVATE KEY-----

data/spec/fixtures/config.yml

@@ -1,3 +1,4 @@
 test:
   algorithm: 'RS256'
-  path: './spec/fixtures/unsecured.pem'
+  authorization_scheme: 'Bearer'
+  key_path: './spec/fixtures/unsecured.pem'

data/spec/fixtures/nonexistent_config.yml

@@ -0,0 +1,4 @@
+test:
+  algorithm: 'RS256'
+  authorization_scheme: 'Bearer'
+  key_path: './spec/fixtures/notexistent.pem'

data/spec/simplecov_helper.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+require 'simplecov'
+require 'simplecov-console'
+
+SimpleCov.formatters = [
+  SimpleCov::Formatter::HTMLFormatter,
+  SimpleCov::Formatter::Console
+]
+SimpleCov.start

data/spec/spec_helper.rb

@@ -1,9 +1,11 @@
 # frozen_string_literal: true
+require_relative 'simplecov_helper'
 require 'bundler/setup'
+require 'logger'
 require 'decode_this'
 
 def encode(payload)
   config = Huyettings.new(File.expand_path('spec/fixtures/config.yml'), :test)
-  private_key = OpenSSL::PKey::RSA.new(File.read(config.path))
-  JWT.encode(payload, private_key, config.algorithm)
+  private_key = OpenSSL::PKey::RSA.new(File.read(config.key_path))
+  "#{config.authorization_scheme} " + JWT.encode(payload, private_key, config.algorithm)
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: decode_this
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Sasha Kotov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-07 00:00:00.000000000 Z
+date: 2018-03-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jwt
@@ -94,10 +94,16 @@ files:
 - Readme.md
 - decode_this.gemspec
 - lib/decode_this.rb
+- lib/decode_this/decoder.rb
+- lib/decode_this/safe_decoding.rb
 - lib/decode_this/version.rb
-- spec/decode_this_spec.rb
+- spec/decode_this/decoder_spec.rb
+- spec/fixtures/another_config.yml
+- spec/fixtures/another_unsecured.pem
 - spec/fixtures/config.yml
+- spec/fixtures/nonexistent_config.yml
 - spec/fixtures/unsecured.pem
+- spec/simplecov_helper.rb
 - spec/spec_helper.rb
 homepage: 
 licenses: []
@@ -123,7 +129,11 @@ signing_key:
 specification_version: 4
 summary: Decode token. This token
 test_files:
-- spec/decode_this_spec.rb
+- spec/decode_this/decoder_spec.rb
+- spec/fixtures/another_config.yml
+- spec/fixtures/another_unsecured.pem
 - spec/fixtures/config.yml
+- spec/fixtures/nonexistent_config.yml
 - spec/fixtures/unsecured.pem
+- spec/simplecov_helper.rb
 - spec/spec_helper.rb

data/spec/decode_this_spec.rb

@@ -1,16 +0,0 @@
-# frozen_string_literal: true
-require 'spec_helper'
-
-RSpec.describe DecodeThis do
-  let(:config_path) { File.expand_path('spec/fixtures/config.yml') }
-  let(:payload) { { field: 'foobar' } }
-  let(:token) { encode(payload) }
-
-  subject(:decoded_token) { described_class.new(token, config_file: config_path, env: :test).decode }
-
-  it 'decodes given token correctly' do
-    payload.keys.each do |key|
-      expect(decoded_token[key.to_s]).to eq(payload[key])
-    end
-  end
-end