matic-jwt 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: f88e0cc34d161d9751975676c7fa9c8ecd45b65d
-  data.tar.gz: 5b2da54d406108ee2f51c3d7dba5d3fcd86cbfb6
+SHA256:
+  metadata.gz: 820d5ea52ea13265f15f8edae701cbec3a838798dbba576c4275d0330beaf4c1
+  data.tar.gz: 795cfc00feafc232d476237f236ea3e27667139a2174b667b946d2b37d610ce8
 SHA512:
-  metadata.gz: 7fdbb2de618b9713c34018414856361d001a7ce845dc54e7fd634d6f6ece1331f9fb8f0388b59767f6f2f1d9cc68871670648ecfb515263dfabf36fb17bcf0c7
-  data.tar.gz: 045777ff294f6413630d6c4a1f092d733ac55b43abfcbd4b8283d1ffc36f737cc2c87af8803a62226fb457ff4c4e61940f10b3a4cc99a980458d2a4aa1980d0e
+  metadata.gz: 3e00adc27b5821276bf43776e172b81fa994055ddeba1f2e1125ef79f484dbfbabfbf892de83b93f1cd35a6df44dacef312a1244afea1c26b8ed3d6fcd2850c5
+  data.tar.gz: 3ba9b91334a883353f1ea82e5d8e2d7b505a95d16aa0630d418703922ae8d7812d2593cda326f28cfd44cebd1077596ee8e60e3f31446af496164a7c6b0af955

data/.github/workflows/main.yml

@@ -0,0 +1,68 @@
+name: ci
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    branches:
+      - master
+  release:
+    types: [published]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby: [ '2.5.x', '2.6.x' ]
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v1
+      - name: Cache dependencies
+        uses: actions/cache@v1
+        with:
+          path: vendor/bundle
+          key: ${{ runner.OS }}-ruby-${{ matrix.ruby }}
+          restore-keys: ${{ runner.OS }}-
+
+      - name: Set up Ruby
+        uses: actions/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+      - name: Set up Bundler
+        run: gem install bundler:1.14.5
+      - name: Set up Dependencies
+        run: bundle install --path vendor/bundle
+      - name: Run specs
+        run: bundle exec rspec
+
+  release:
+    runs-on: ubuntu-latest
+    needs: build
+    if: github.event_name == 'release' && github.event.action == 'published'
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v1
+
+      - name: Set up Ruby
+        uses: actions/setup-ruby@v1
+        with:
+          ruby-version: 2.6.x
+      - name: Set up Bundler
+        run: gem install bundler:1.17.3
+      - name: Set up credentials
+        run: |
+          mkdir -p $HOME/.gem
+          touch $HOME/.gem/credentials
+          chmod 0600 $HOME/.gem/credentials
+          printf -- "---\n:rubygems_api_key: ${{secrets.RUBYGEMS_AUTH_TOKEN}}\n" > $HOME/.gem/credentials
+
+      - name: Get version
+        run: echo "${GITHUB_REF/refs\/tags\//}" > release.tag
+      - name: Set version
+        run: sed -i "s/0.0.0/$(<release.tag)/g" */**/version.rb
+
+      - name: Build gem
+        run: gem build *.gemspec
+      - name: Push gem
+        run: gem push *.gem

data/Gemfile.lock

@@ -1,24 +1,24 @@
 PATH
   remote: .
   specs:
-    matic-jwt (1.0.1)
+    matic-jwt (0.0.0)
       activesupport
       jwt
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (5.1.4)
+    activesupport (5.2.4.1)
       concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (~> 0.7)
+      i18n (>= 0.7, < 2)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
-    concurrent-ruby (1.0.5)
+    concurrent-ruby (1.1.5)
     diff-lcs (1.3)
-    i18n (0.9.1)
+    i18n (1.8.2)
       concurrent-ruby (~> 1.0)
-    jwt (2.1.0)
-    minitest (5.10.3)
+    jwt (2.2.1)
+    minitest (5.14.0)
     rake (10.5.0)
     rspec (3.7.0)
       rspec-core (~> 3.7.0)
@@ -34,7 +34,7 @@ GEM
       rspec-support (~> 3.7.0)
     rspec-support (3.7.0)
     thread_safe (0.3.6)
-    tzinfo (1.2.4)
+    tzinfo (1.2.6)
       thread_safe (~> 0.1)
 
 PLATFORMS
@@ -47,4 +47,4 @@ DEPENDENCIES
   rspec (~> 3.0)
 
 BUNDLED WITH
-   1.16.0
+   1.17.3

data/README.md

@@ -1,8 +1,6 @@
 # Matic::Jwt
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/matic/jwt`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+Matic's implementation of JWT authentication.
 
 ## Installation
 
@@ -22,7 +20,30 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+####With Grape
+
+Use ```:jwt_auth``` strategy and provide secret.
+```ruby
+   auth :jwt_auth, {
+      secret: -> (client_name) { ::ApiClient.find_by!(name: client_name).secret }
+   }
+```
+If you need to get any data from authentication payload use ::MaticJWT::Grape::Helper.
+```ruby
+    module ApiHelper
+       include ::MaticJWT::Grape::Helper
+        
+        def current_client
+          @current_client ||= ::ApiClient.find_by!(name: client_name)
+        end
+    
+        private
+    
+        def client_name
+          auth_payload['client_name']
+        end
+    end 
+```
 
 ## Development
 

data/lib/matic-jwt.rb

@@ -5,6 +5,12 @@ require 'matic-jwt/authenticator'
 require 'matic-jwt/generator'
 require 'matic-jwt/version'
 
+if Gem::Specification.find_all_by_name('grape').present?
+  require 'matic-jwt/grape/helper'
+  require 'matic-jwt/grape/middleware/request'
+  require 'matic-jwt/grape/middleware/auth'
+end
+
 module MaticJWT
   ALGORITHM = 'HS256'.freeze
   EXPIRATION = 1.minute

data/lib/matic-jwt/authenticator.rb

@@ -13,6 +13,10 @@ module MaticJWT
       JWT.decode(@token, secret, true, algorithm: ALGORITHM)
     end
 
+    def payload
+      JWT.decode(@token, nil, false)
+    end
+
     private
 
     def extract_token(header)
@@ -21,10 +25,6 @@ module MaticJWT
       token
     end
 
-    def payload
-      JWT.decode(@token, nil, false)
-    end
-
     def validate_header_presence!(token)
       raise(JWT::DecodeError, 'Authorization token is incorrect') unless token&.present?
     end

data/lib/matic-jwt/grape/helper.rb

@@ -0,0 +1,9 @@
+module MaticJWT
+  module Grape
+    module Helper
+      def auth_payload
+        env['auth_payload']
+      end
+    end
+  end
+end

data/lib/matic-jwt/grape/middleware/auth.rb

@@ -0,0 +1,53 @@
+module MaticJWT
+  module Grape
+    module Middleware
+      class Auth
+        def initialize(app, options)
+          @app = app
+          @secret_reader = options[:secret]
+        end
+
+        def call(env)
+          @env = env
+
+          validate_request
+          decode_payload
+          authenticate!
+          continue!
+        end
+
+        private
+
+        def validate_request
+          raise JWT::VerificationError, 'Authorization token is invalid' unless request.valid?
+        end
+
+        def decode_payload
+          @env['auth_payload'] = jwt_authenticator.payload&.first
+        end
+
+        def authenticate!
+          jwt_authenticator.authenticate_with_secret!(secret)
+        end
+
+        def continue!
+          @app.call(@env)
+        end
+
+        def jwt_authenticator
+          ::MaticJWT::Authenticator.new(request.auth_token)
+        end
+
+        def secret
+          @secret_reader.call(jwt_authenticator.client_name)
+        end
+
+        def request
+          @request ||= ::MaticJWT::Grape::Middleware::Request.new(@env)
+        end
+      end
+    end
+  end
+end
+
+Grape::Middleware::Auth::Strategies.add(:jwt_auth, ::MaticJWT::Grape::Middleware::Auth, ->(options) { [options] })

data/lib/matic-jwt/grape/middleware/request.rb

@@ -0,0 +1,27 @@
+module MaticJWT
+  module Grape
+    module Middleware
+      class Request
+        AUTHORIZATION_KEYS = %w[HTTP_AUTHORIZATION X-HTTP_AUTHORIZATION X_HTTP_AUTHORIZATION].freeze
+
+        def initialize(env)
+          @env = env
+        end
+
+        def valid?
+          !@env[auth_key].nil?
+        end
+
+        def auth_token
+          @env[auth_key]
+        end
+
+        private
+
+        def auth_key
+          @authorization_key ||= AUTHORIZATION_KEYS.detect { |key| @env.key?(key) }
+        end
+      end
+    end
+  end
+end

data/lib/matic-jwt/version.rb

@@ -1,3 +1,3 @@
 module MaticJWT
-  VERSION = '1.0.1'
+  VERSION = '1.1.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: matic-jwt
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Yurii Danyliak
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-12-22 00:00:00.000000000 Z
+date: 2020-02-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jwt
@@ -88,8 +88,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/main.yml"
 - ".gitignore"
-- ".travis.yml"
 - Gemfile
 - Gemfile.lock
 - LICENSE
@@ -100,6 +100,9 @@ files:
 - lib/matic-jwt.rb
 - lib/matic-jwt/authenticator.rb
 - lib/matic-jwt/generator.rb
+- lib/matic-jwt/grape/helper.rb
+- lib/matic-jwt/grape/middleware/auth.rb
+- lib/matic-jwt/grape/middleware/request.rb
 - lib/matic-jwt/version.rb
 - matic-jwt.gemspec
 homepage: https://github.com/matic-insurance/matic-jwt-wrapper
@@ -121,8 +124,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Matic's JWT implementation

data/.travis.yml

@@ -1,5 +0,0 @@
-language: ruby
-rvm:
-  - 2.3.4
-script:
-  - bundle exec rspec