has_jwt_token 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3889be0fdd07a34e02b65d48948ab746f26482698767ac83ba8c680bd13272cf
-  data.tar.gz: d528aa140d822a2c73c3263d8e7d950cff7e84e6203bb2b48a22f3be654d07f5
+  metadata.gz: 1bd6891ae551f486aecfa6de00f54b1318bd0383c7a19db1d590a371181f1db2
+  data.tar.gz: f1855497a20c4f4713bf58ae2d79480973342ef86fe71d641102888cfbac41db
 SHA512:
-  metadata.gz: c8e1d855921667fe5b374c0b74666ea4fbbe66471f7d59ddef9b40f82a7bd7f1f11d9c01f403ce72e10389c8217a1752044688b71e926984745bb7338444f7a4
-  data.tar.gz: 6f0f3801e6cceac529f238dc316a4876791e13a0e2b1c7a6d29bae1fc33a95a19336eaa94e3f90d4044ceaa586c03c53b44531787986fac2ea86a17687ae213d
+  metadata.gz: d0ec13c04d6175004eca4dfb51e9f19f620fa022c09c1322b883fcf6e47b49473972a0a82bf27ed8c7c583fdd7d67fb8afe3c57020ffed555edf8b7f1e0464b5
+  data.tar.gz: ad1c861ab14616785139c30025097e4665d4d2f172914b30b617d67bc7ef758e5fc94f7b62f906df8dfa76c245256858fd4ec0cd00c19529793f6b5cffd33395

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    has_jwt_token (0.1.0)
+    has_jwt_token (0.2.0)
       bcrypt
       jwt
       rails (>= 5.0, < 7.0)

data/README.md

@@ -31,7 +31,10 @@ class User
 
   has_jwt_token do |jwt|
     jwt.algorithm 'HS256'
-    jwt.payload_attribute :name
+    jwt.payload :name # model attribute #name
+    jwt.payload :custom_proc_class_method, -> { dummy_class_method }
+    jwt.payload :custom_proc_istance_method, ->(model) { model.dummy_instance_method }
+    jwt.payload :custom_plain_value, 321
     jwt.secret 'secret'
 
     jwt.expiration_time -> { Time.now.to_i + 60 }
@@ -43,8 +46,17 @@ class User
     jwt.subject :dummy_app
   end
 end
+
+user = User.last
+
+user.authenicate(password) # => user with @token
+user.auhtenticate_with_jwt(token) # => user with @token
 ```
 
+## Roadmap
+* Add blacklisted tokens managment
+* Remove Rails depedency
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/has_jwt_token/has_jwt_model_configuration.rb

@@ -4,10 +4,12 @@ require 'has_jwt_token/jwt_configuration'
 
 module HasJwtToken
   module HasJwtModelConfiguration
-    def has_jwt_token
-      @has_jwt_token ||= JwtConfiguration.new(self)
+    def has_jwt_token(model = nil)
+      @has_jwt_token ||= JwtConfiguration.new
       yield(@has_jwt_token) if block_given?
-      @has_jwt_token
+      @has_jwt_token.tap do |config|
+        config.model = model if model
+      end
     end
   end
 end

data/lib/has_jwt_token/jwt_configuration.rb

@@ -12,13 +12,12 @@ module HasJwtToken
       subject: :sub
     }.freeze
 
-    attr_accessor :defined_claims
-    attr_reader :model
-    attr_writer :payload_attribute
+    attr_accessor :model
+    attr_reader :defined_claims
 
-    def initialize(model)
-      @model = model
-      @payload_attribute = []
+    def initialize
+      @payload = {}
+      @header = {}
       @defined_claims = []
     end
 
@@ -28,29 +27,55 @@ module HasJwtToken
       @algorithm = value
     end
 
-    def payload_attribute(value = nil)
-      return @payload_attribute unless value
+    def secret(value = nil)
+      return @secret unless value
 
-      payload_attribute << value
+      @secret = value
     end
 
-    CLAIMS.each do |claim_name, _|
+    CLAIMS.each_key do |claim_name|
       define_method(claim_name) do |value = nil|
-        if value
-          defined_claims << claim_name unless defined_claims.include?(claim_name)
-          instance_variable_set("@#{claim_name}".to_sym, value)
-          return value
+        unless value
+          claim_value = instance_variable_get("@#{claim_name}".to_sym)
+          return claim_value.is_a?(Proc) ? claim_value.call : claim_value
         end
 
-        claim_value = instance_variable_get("@#{claim_name}".to_sym)
-        claim_value.is_a?(Proc) ? claim_value.call : claim_value
+        @defined_claims |= [claim_name]
+        instance_variable_set("@#{claim_name}".to_sym, value)
       end
     end
 
-    def secret(value = nil)
-      return @secret unless value
+    def model_payload
+      @payload.transform_values do |val|
+        next val if !val.is_a?(Proc) || !model
 
-      @secret = value
+        begin
+          val.call(model)
+        rescue ArgumentError
+          val.call
+        end
+      end
+    end
+
+    def payload(name = nil, value = nil)
+      @payload[name] = value || ->(model) { model.respond_to?(name) && model.public_send(name) } if name
+    end
+
+    def claims_payload
+      defined_claims.each_with_object({}) do |claim_name, memo|
+        claim_key = CLAIMS[claim_name]
+        memo[claim_key] = public_send(claim_name)
+      end
+    end
+
+    def header(name = nil, value = nil)
+      @header[name] = value if name
+    end
+
+    def header_fields
+      @header.transform_values do |val|
+        val.is_a?(Proc) ? val.call : val
+      end
     end
   end
 end

data/lib/has_jwt_token/jwt_proxy.rb

@@ -4,16 +4,17 @@ require 'jwt'
 
 module HasJwtToken
   class JwtProxy
-    attr_reader :algorithm, :payload, :secret
+    attr_reader :algorithm, :payload, :secret, :header_fields
 
-    def initialize(algorithm: nil, payload: nil, secret: nil)
+    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)
+      JWT.encode(payload, secret, algorithm, header_fields)
     end
 
     def decode(token)

data/lib/has_jwt_token/jwt_tokenable.rb

@@ -4,8 +4,7 @@ require 'has_jwt_token/jwt_proxy'
 
 module HasJwtToken
   module JwtTokenable
-    delegate :algorithm, :secret, :payload_attribute,
-             :defined_claims, to: :has_jwt_token
+    delegate :algorithm, :secret, :claims_payload, :header_fields, to: :has_jwt_token
 
     def encode
       with_jwt_configuration(&:encode)
@@ -19,27 +18,14 @@ module HasJwtToken
       with_jwt_configuration { |jwt| jwt.decode!(token) }
     end
 
-    private
-
     def has_jwt_token
-      self.class.has_jwt_token
-    end
-
-    def payload
-      @payload ||= model_payload.merge(claims_payload)
+      self.class.has_jwt_token(self)
     end
 
-    def model_payload
-      payload_attribute.each_with_object({}) do |attribute, memo|
-        memo[attribute] = public_send(attribute)
-      end
-    end
+    private
 
-    def claims_payload
-      defined_claims.each_with_object({}) do |claim_name, memo|
-        claim_key = HasJwtToken::JwtConfiguration::CLAIMS[claim_name]
-        memo[claim_key] = has_jwt_token.public_send(claim_name)
-      end
+    def payload
+      @payload ||= has_jwt_token.model_payload.merge(claims_payload)
     end
 
     def with_jwt_configuration
@@ -50,7 +36,8 @@ module HasJwtToken
       @jwt_proxy ||= JwtProxy.new(
         algorithm: algorithm,
         payload: payload,
-        secret: secret
+        secret: secret,
+        header_fields: header_fields
       )
     end
   end

data/lib/has_jwt_token/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: has_jwt_token
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Jokūbas Pučinskas
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-10-25 00:00:00.000000000 Z
+date: 2020-10-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bcrypt