has_jwt_token 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 445d49f22461e8ad189d361639f786cea6723f1e7126a8510e0089879e6c9272
-  data.tar.gz: '03580907964370e9611b4aff79526bf2f0ef2aa59e4c8728d8770d3e4448af45'
+  metadata.gz: 5f65ddcc420900fb05201c00e4746e04716fe0e68c56fdab6be0e0a1d3dba793
+  data.tar.gz: 863fd49dd42eb153bcb01b620b23c5d4296fe52f9b32c0ccd4d321259eb83025
 SHA512:
-  metadata.gz: a6d5ab98751e620b5f0f46b4283e127a9e7151e4d615d60bb194186d28cf24a36c426fe0612df17d7d40eee26f30e0a53904034694003d5184a83a669e5d67d7
-  data.tar.gz: d2d841bdb59c585d0bd52aa90b94b6d69d64ac309a1753431c954172b0996455290cef3411d2811ea59216a3184cea9de736d5eb92ad95fdec109b2696428b0d
+  metadata.gz: 736405aa694b3df816877239461d0c52f100518384a609013a6af183bfa23d2ad54c44d445049cc5a9cecac169697f90c85311abcd22c588a5aa514556409974
+  data.tar.gz: 55fe4be0b427574b5d54913684a71bb2452c1d8f071ad0a93f6841d69b0c60ec6f68a8b1a8977804fa809a1a63ff66bfbeaf5fcb0b7b61a649e840e3096dbc6f

data/.ruby-version

@@ -1 +1 @@
-2.7.1
+3.1.2

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    has_jwt_token (0.2.1)
+    has_jwt_token (0.3.0)
       bcrypt
       jwt
       rails (>= 5.0, < 7.0)
@@ -9,182 +9,184 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    actioncable (6.0.3.4)
-      actionpack (= 6.0.3.4)
+    actioncable (6.1.6)
+      actionpack (= 6.1.6)
+      activesupport (= 6.1.6)
       nio4r (~> 2.0)
       websocket-driver (>= 0.6.1)
-    actionmailbox (6.0.3.4)
-      actionpack (= 6.0.3.4)
-      activejob (= 6.0.3.4)
-      activerecord (= 6.0.3.4)
-      activestorage (= 6.0.3.4)
-      activesupport (= 6.0.3.4)
+    actionmailbox (6.1.6)
+      actionpack (= 6.1.6)
+      activejob (= 6.1.6)
+      activerecord (= 6.1.6)
+      activestorage (= 6.1.6)
+      activesupport (= 6.1.6)
       mail (>= 2.7.1)
-    actionmailer (6.0.3.4)
-      actionpack (= 6.0.3.4)
-      actionview (= 6.0.3.4)
-      activejob (= 6.0.3.4)
+    actionmailer (6.1.6)
+      actionpack (= 6.1.6)
+      actionview (= 6.1.6)
+      activejob (= 6.1.6)
+      activesupport (= 6.1.6)
       mail (~> 2.5, >= 2.5.4)
       rails-dom-testing (~> 2.0)
-    actionpack (6.0.3.4)
-      actionview (= 6.0.3.4)
-      activesupport (= 6.0.3.4)
-      rack (~> 2.0, >= 2.0.8)
+    actionpack (6.1.6)
+      actionview (= 6.1.6)
+      activesupport (= 6.1.6)
+      rack (~> 2.0, >= 2.0.9)
       rack-test (>= 0.6.3)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.2.0)
-    actiontext (6.0.3.4)
-      actionpack (= 6.0.3.4)
-      activerecord (= 6.0.3.4)
-      activestorage (= 6.0.3.4)
-      activesupport (= 6.0.3.4)
+    actiontext (6.1.6)
+      actionpack (= 6.1.6)
+      activerecord (= 6.1.6)
+      activestorage (= 6.1.6)
+      activesupport (= 6.1.6)
       nokogiri (>= 1.8.5)
-    actionview (6.0.3.4)
-      activesupport (= 6.0.3.4)
+    actionview (6.1.6)
+      activesupport (= 6.1.6)
       builder (~> 3.1)
       erubi (~> 1.4)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.1, >= 1.2.0)
-    activejob (6.0.3.4)
-      activesupport (= 6.0.3.4)
+    activejob (6.1.6)
+      activesupport (= 6.1.6)
       globalid (>= 0.3.6)
-    activemodel (6.0.3.4)
-      activesupport (= 6.0.3.4)
-    activerecord (6.0.3.4)
-      activemodel (= 6.0.3.4)
-      activesupport (= 6.0.3.4)
-    activestorage (6.0.3.4)
-      actionpack (= 6.0.3.4)
-      activejob (= 6.0.3.4)
-      activerecord (= 6.0.3.4)
-      marcel (~> 0.3.1)
-    activesupport (6.0.3.4)
+    activemodel (6.1.6)
+      activesupport (= 6.1.6)
+    activerecord (6.1.6)
+      activemodel (= 6.1.6)
+      activesupport (= 6.1.6)
+    activestorage (6.1.6)
+      actionpack (= 6.1.6)
+      activejob (= 6.1.6)
+      activerecord (= 6.1.6)
+      activesupport (= 6.1.6)
+      marcel (~> 1.0)
+      mini_mime (>= 1.1.0)
+    activesupport (6.1.6)
       concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-      zeitwerk (~> 2.2, >= 2.2.2)
-    ast (2.4.1)
-    bcrypt (3.1.16)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    ast (2.4.2)
+    bcrypt (3.1.17)
     builder (3.2.4)
     coderay (1.1.3)
-    concurrent-ruby (1.1.7)
+    concurrent-ruby (1.1.10)
     crass (1.0.6)
-    diff-lcs (1.4.4)
-    docile (1.3.2)
-    erubi (1.9.0)
-    factory_bot (6.1.0)
+    diff-lcs (1.5.0)
+    docile (1.4.0)
+    erubi (1.10.0)
+    factory_bot (6.2.1)
       activesupport (>= 5.0.0)
-    globalid (0.4.2)
-      activesupport (>= 4.2.0)
-    i18n (1.8.5)
+    globalid (1.0.0)
+      activesupport (>= 5.0)
+    i18n (1.10.0)
       concurrent-ruby (~> 1.0)
-    jwt (2.2.2)
-    loofah (2.7.0)
+    jwt (2.3.0)
+    loofah (2.18.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
     mail (2.7.1)
       mini_mime (>= 0.1.1)
-    marcel (0.3.3)
-      mimemagic (~> 0.3.2)
+    marcel (1.0.2)
     method_source (1.0.0)
-    mimemagic (0.3.5)
-    mini_mime (1.0.2)
-    mini_portile2 (2.4.0)
-    minitest (5.14.2)
-    nio4r (2.5.4)
-    nokogiri (1.10.10)
-      mini_portile2 (~> 2.4.0)
-    parallel (1.19.2)
-    parser (2.7.2.0)
+    mini_mime (1.1.2)
+    minitest (5.15.0)
+    nio4r (2.5.8)
+    nokogiri (1.13.6-x86_64-linux)
+      racc (~> 1.4)
+    parallel (1.22.1)
+    parser (3.1.2.0)
       ast (~> 2.4.1)
-    pry (0.13.1)
+    pry (0.14.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
+    racc (1.6.0)
     rack (2.2.3)
     rack-test (1.1.0)
       rack (>= 1.0, < 3)
-    rails (6.0.3.4)
-      actioncable (= 6.0.3.4)
-      actionmailbox (= 6.0.3.4)
-      actionmailer (= 6.0.3.4)
-      actionpack (= 6.0.3.4)
-      actiontext (= 6.0.3.4)
-      actionview (= 6.0.3.4)
-      activejob (= 6.0.3.4)
-      activemodel (= 6.0.3.4)
-      activerecord (= 6.0.3.4)
-      activestorage (= 6.0.3.4)
-      activesupport (= 6.0.3.4)
-      bundler (>= 1.3.0)
-      railties (= 6.0.3.4)
+    rails (6.1.6)
+      actioncable (= 6.1.6)
+      actionmailbox (= 6.1.6)
+      actionmailer (= 6.1.6)
+      actionpack (= 6.1.6)
+      actiontext (= 6.1.6)
+      actionview (= 6.1.6)
+      activejob (= 6.1.6)
+      activemodel (= 6.1.6)
+      activerecord (= 6.1.6)
+      activestorage (= 6.1.6)
+      activesupport (= 6.1.6)
+      bundler (>= 1.15.0)
+      railties (= 6.1.6)
       sprockets-rails (>= 2.0.0)
     rails-dom-testing (2.0.3)
       activesupport (>= 4.2.0)
       nokogiri (>= 1.6)
-    rails-html-sanitizer (1.3.0)
+    rails-html-sanitizer (1.4.2)
       loofah (~> 2.3)
-    railties (6.0.3.4)
-      actionpack (= 6.0.3.4)
-      activesupport (= 6.0.3.4)
+    railties (6.1.6)
+      actionpack (= 6.1.6)
+      activesupport (= 6.1.6)
       method_source
-      rake (>= 0.8.7)
-      thor (>= 0.20.3, < 2.0)
-    rainbow (3.0.0)
+      rake (>= 12.2)
+      thor (~> 1.0)
+    rainbow (3.1.1)
     rake (12.3.3)
-    regexp_parser (1.8.2)
-    rexml (3.2.4)
-    rspec (3.9.0)
-      rspec-core (~> 3.9.0)
-      rspec-expectations (~> 3.9.0)
-      rspec-mocks (~> 3.9.0)
-    rspec-core (3.9.3)
-      rspec-support (~> 3.9.3)
-    rspec-expectations (3.9.3)
+    regexp_parser (2.4.0)
+    rexml (3.2.5)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-mocks (3.9.1)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-support (3.9.4)
-    rubocop (0.93.1)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
+    rubocop (1.29.0)
       parallel (~> 1.10)
-      parser (>= 2.7.1.5)
+      parser (>= 3.1.0.0)
       rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8)
-      rexml
-      rubocop-ast (>= 0.6.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.17.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 2.0)
-    rubocop-ast (1.0.1)
-      parser (>= 2.7.1.5)
-    rubocop-performance (1.8.1)
-      rubocop (>= 0.87.0)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.17.0)
+      parser (>= 3.1.1.0)
+    rubocop-performance (1.13.3)
+      rubocop (>= 1.7.0, < 2.0)
       rubocop-ast (>= 0.4.0)
-    rubocop-rspec (1.44.1)
-      rubocop (~> 0.87)
-      rubocop-ast (>= 0.7.1)
-    ruby-progressbar (1.10.1)
-    simplecov (0.19.0)
+    rubocop-rspec (2.10.0)
+      rubocop (~> 1.19)
+    ruby-progressbar (1.11.0)
+    simplecov (0.21.2)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
     simplecov-html (0.12.3)
-    sprockets (4.0.2)
+    simplecov_json_formatter (0.1.4)
+    sprockets (4.0.3)
       concurrent-ruby (~> 1.0)
       rack (> 1, < 3)
-    sprockets-rails (3.2.2)
-      actionpack (>= 4.0)
-      activesupport (>= 4.0)
+    sprockets-rails (3.4.2)
+      actionpack (>= 5.2)
+      activesupport (>= 5.2)
       sprockets (>= 3.0.0)
-    thor (1.0.1)
-    thread_safe (0.3.6)
-    tzinfo (1.2.7)
-      thread_safe (~> 0.1)
-    unicode-display_width (1.7.0)
-    websocket-driver (0.7.3)
+    thor (1.2.1)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.1.0)
+    websocket-driver (0.7.5)
       websocket-extensions (>= 0.1.0)
     websocket-extensions (0.1.5)
-    zeitwerk (2.4.0)
+    zeitwerk (2.5.4)
 
 PLATFORMS
   ruby
@@ -201,4 +203,4 @@ DEPENDENCIES
   simplecov
 
 BUNDLED WITH
-   2.1.4
+   2.2.22

data/README.md

@@ -2,7 +2,7 @@
 
 HasJwtToken provides JWT authetication for models which are kean to use `has_secure_password` in Rails app and wants to use it to grant jwt tokens.
 
-This gem is build on top of [Ruby's JWT](https://github.com/jwt/ruby-jwt) gem and it implements `JWT.encode` and `JWT.decode` methods.
+This gem is build on top of [Ruby's JWT](https://github.com/jwt/ruby-jwt) gem and it implements `JWT.encode` and `JWT.decode` (with validation enabled) methods.
 
 ## Installation
 
@@ -53,7 +53,7 @@ end
 user = User.last
 
 user.authenicate(password) # => user with @token
-user.auhtenticate_with_jwt(token) # => user with @token
+User.find_with_jwt(token) # => user with @token
 ```
 
 ## Roadmap

data/lib/has_jwt_token/authenticatable.rb

@@ -1,22 +1,63 @@
 # frozen_string_literal: true
 
-module Authenticatable
-  def authenticate(password)
-    super(password).tap do |authenticated|
-      @token = authenticated && encode || nil
+require 'has_jwt_token/jwt_proxy'
+
+module HasJwtToken
+  module Authenticatable
+    module ClassMethods
+      def find_with_jwt(jwt_token)
+        payload = decode!(jwt_token)
+        find_by(authenticate_by => payload[authenticate_by])
+          &.tap { |model| model.token = model.encode }
+      rescue JWT::DecodeError
+        raise HasJwtToken::InvalidToken, 'Invalid token has been provided.'
+      end
+
+      private
+
+      def authenticate_by
+        @authenticate_by ||= begin
+          auth_by_attr = has_jwt_token.authenticate_by.to_s
+          return auth_by_attr if column_names.include?(auth_by_attr)
+
+          raise HasJwtToken::BadConfiguration, "#{auth_by_attr.inspect} must be one of model attributes."
+        end
+      end
+
+      def decode!(token)
+        HasJwtToken::JwtProxy.decode!(
+          token: token,
+          algorithm: has_jwt_token.algorithm,
+          secret: has_jwt_token.secret
+        )
+      end
     end
-  end
 
-  def authenticate_with_jwt(jwt_token)
-    authenticated = decode!(jwt_token)
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    def authenticate(password)
+      super(password).tap do |authenticated|
+        @token = authenticated && encode || nil
+      end
+    end
+
+    def encode
+      HasJwtToken::JwtProxy.encode(
+        algorithm: algorithm,
+        payload: model_payload.merge(claims_payload),
+        secret: secret,
+        header_fields: header_fields
+      )
+    end
+
+    private
+
+    delegate :algorithm, :secret, :model_payload, :claims_payload, :header_fields, to: :has_jwt_token
 
-    if authenticated
-      @token = encode
-      self
-    else
-      @token = nil
+    def has_jwt_token
+      @has_jwt_token ||= self.class.has_jwt_token(self)
     end
-  rescue JWT::DecodeError
-    nil
   end
 end

data/lib/has_jwt_token/errors.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module HasJwtToken
+  HasJwtTokenError = Class.new(StandardError)
+
+  class InvalidToken < HasJwtTokenError; end
+  class BadConfiguration < HasJwtTokenError; end
+end

data/lib/has_jwt_token/has_jwt_model_configuration.rb

@@ -7,9 +7,7 @@ module HasJwtToken
     def has_jwt_token(model = nil)
       @has_jwt_token ||= JwtConfiguration.new
       yield(@has_jwt_token) if block_given?
-      @has_jwt_token.tap do |config|
-        config.model = model if model
-      end
+      @has_jwt_token.tap { |jwt| jwt.model = model if model }
     end
   end
 end

data/lib/has_jwt_token/jwt_configuration.rb

@@ -2,6 +2,7 @@
 
 module HasJwtToken
   class JwtConfiguration
+    DEFAULT_AUTH_ATTRIBUTE = :id
     CLAIMS = {
       expiration_time: :exp,
       not_before_time: :nbf,
@@ -57,7 +58,8 @@ module HasJwtToken
       end
     end
 
-    def payload(name = nil, value = nil)
+    def payload(name = nil, value: nil, auth_by: false)
+      @authenticate_by = name if auth_by
       @payload[name] = value || ->(model) { model.respond_to?(name) && model.public_send(name) } if name
     end
 
@@ -77,5 +79,9 @@ module HasJwtToken
         val.is_a?(Proc) ? val.call : val
       end
     end
+
+    def authenticate_by
+      @authenticate_by || DEFAULT_AUTH_ATTRIBUTE
+    end
   end
 end

data/lib/has_jwt_token/jwt_proxy.rb

@@ -4,31 +4,14 @@ require 'jwt'
 
 module HasJwtToken
   class JwtProxy
-    attr_reader :algorithm, :payload, :secret, :header_fields
+    class << self
+      def encode(payload:, secret: '', algorithm: '', header_fields: {})
+        JWT.encode(payload, secret, algorithm, header_fields)
+      end
 
-    def initialize(algorithm: '', payload: {}, secret: '', header_fields: {})
-      @algorithm = algorithm
-      @payload = payload
-      @secret = secret
-      @header_fields = header_fields
-    end
-
-    def encode
-      JWT.encode(payload, secret, algorithm, header_fields)
-    end
-
-    def decode(token)
-      JWT.decode(token, secret, false, algorithm: algorithm)[0]
-    end
-
-    def decode!(token)
-      JWT.decode(token, secret, true, algorithm: algorithm)[0]
-    end
-
-    def valid?(token)
-      decode!(token) && true
-    rescue JWT::DecodeError
-      false
+      def decode!(token:, secret: '', algorithm: '')
+        JWT.decode(token, secret, true, algorithm: algorithm)[0]
+      end
     end
   end
 end

data/lib/has_jwt_token/model.rb

@@ -4,18 +4,16 @@ require 'active_model'
 require 'bcrypt'
 require 'has_jwt_token/authenticatable'
 require 'has_jwt_token/has_jwt_model_configuration'
-require 'has_jwt_token/jwt_tokenable'
 
 module HasJwtToken
   module Model
-    attr_reader :token
+    attr_accessor :token
 
     def self.included(base)
       base.include(ActiveModel::SecurePassword)
       base.has_secure_password
       base.include(Authenticatable)
       base.extend(HasJwtModelConfiguration)
-      base.include(JwtTokenable)
     end
   end
 end

data/lib/has_jwt_token/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module HasJwtToken
-  VERSION = '0.2.1'
+  VERSION = '0.3.0'
 end

data/lib/has_jwt_token.rb

@@ -2,4 +2,5 @@
 
 require 'active_support/core_ext/module/delegation'
 require 'has_jwt_token/version'
+require 'has_jwt_token/errors'
 require 'has_jwt_token/model'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: has_jwt_token
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Jokūbas Pučinskas
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-11-06 00:00:00.000000000 Z
+date: 2022-05-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bcrypt
@@ -167,10 +167,10 @@ files:
 - has_jwt_token.gemspec
 - lib/has_jwt_token.rb
 - lib/has_jwt_token/authenticatable.rb
+- lib/has_jwt_token/errors.rb
 - lib/has_jwt_token/has_jwt_model_configuration.rb
 - lib/has_jwt_token/jwt_configuration.rb
 - lib/has_jwt_token/jwt_proxy.rb
-- lib/has_jwt_token/jwt_tokenable.rb
 - lib/has_jwt_token/model.rb
 - lib/has_jwt_token/version.rb
 homepage: https://github.com/pucinsk/has_jwt_token
@@ -194,7 +194,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.3.7
 signing_key: 
 specification_version: 4
 summary: Fast running JWT implentation for Rails apps!

data/lib/has_jwt_token/jwt_tokenable.rb

@@ -1,44 +0,0 @@
-# frozen_string_literal: true
-
-require 'has_jwt_token/jwt_proxy'
-
-module HasJwtToken
-  module JwtTokenable
-    delegate :algorithm, :secret, :claims_payload, :header_fields, to: :has_jwt_token
-
-    def encode
-      with_jwt_configuration(&:encode)
-    end
-
-    def decode(token)
-      with_jwt_configuration { |jwt| jwt.decode(token) }
-    end
-
-    def decode!(token)
-      with_jwt_configuration { |jwt| jwt.decode!(token) }
-    end
-
-    def has_jwt_token
-      self.class.has_jwt_token(self)
-    end
-
-    private
-
-    def payload
-      @payload ||= has_jwt_token.model_payload.merge(claims_payload)
-    end
-
-    def with_jwt_configuration
-      yield(jwt_proxy)
-    end
-
-    def jwt_proxy
-      @jwt_proxy ||= JwtProxy.new(
-        algorithm: algorithm,
-        payload: payload,
-        secret: secret,
-        header_fields: header_fields
-      )
-    end
-  end
-end