otp-jwt 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 21a9ead6fc616488ac4b250bddf20522ed33d38b
-  data.tar.gz: d2f7ebaf6e27df53693ca7ce9cb733967ede96e7
+  metadata.gz: 60c24eb465beb6f3763ba51b96242e0018a6973b
+  data.tar.gz: a5f581873f0c75488517116de8af8082593f331e
 SHA512:
-  metadata.gz: d6b0faa09edf95831f1874200b28e87bf7da8d156f6f7af28940f28afe5e04b1ecb869d78278d88de2b4a6ae62ffb37dab31cea7110ae42d86f0497155e6f98e
-  data.tar.gz: 1983f079088fc8b7b3a222ec6df065483f84d3ca072f369284b643ee024271b20cc865f7aa39ddbf2d84eadb90cbc8120748b69e1624ac0c75556f04e8e4e64e
+  metadata.gz: f1d6aaee52a096a13c4b56e368ae46ec608bcb0af58c2bed476fe083877e332b9b4b0cf634d6c759618a8f8687a0fc86a1911053703076e961d8081fd9020843
+  data.tar.gz: 24e616a845a2a162498c2d1b58f147badebbc3e46006bc762fff7a58c56ce0ec23508aafa113442647644e47d9138210eb0bd4881d436e21754c75d311fac991

data/Gemfile.lock

@@ -3,7 +3,7 @@ PATH
   specs:
     otp-jwt (0.1.0)
       activesupport
-      jwt (~> 2.1)
+      jwt (~> 2.2.0.pre.beta.0)
       rotp (~> 4.1)
 
 GEM
@@ -67,7 +67,7 @@ GEM
       concurrent-ruby (~> 1.0)
     jaro_winkler (1.5.2)
     json (2.2.0)
-    jwt (2.1.0)
+    jwt (2.2.0.pre.beta.0)
     loofah (2.2.3)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
@@ -184,7 +184,7 @@ DEPENDENCIES
   bundler
   ffaker
   otp-jwt!
-  rails (~> 5)
+  rails
   rspec-rails
   rubocop-performance
   rubocop-rails_config

data/README.md

@@ -27,7 +27,7 @@ The available features include:
  * Flexible models support for
    [counter based OTP](https://github.com/mdp/rotp#counter-based-otps)
  * Flexible JWT token generation helpers for models and arbitrary data
- * Pluggable authentication based on the OTP and JWT
+ * Pluggable authentication flow using the OTP and JWT
  * Pluggable OTP mailer
  * Pluggable OTP SMS background processing job
 
@@ -62,6 +62,7 @@ Or install it yourself as:
  * [JWT for Active Record models](#jwt-for-active-record-models)
  * [JWT authorization](#jwt-authorization)
  * [JWT authentication](#jwt-authentication)
+ * [JWT Tokens](#jwt-tokens)
 
 ---
 
@@ -119,6 +120,17 @@ class User < ActiveRecord::Base
 end
 ```
 
+To customize the mailer subject, address and template, update the defaults:
+
+```ruby
+require 'otp/mailer'
+
+OTP::Mailer.default subject: 'Your App magic password 🗝️'
+OTP::Mailer.default from: ENV['DEFAUL_MAILER_FROM']
+# Tell mailer to use the template from app/views/otp/mailer/otp.html.erb
+OTP::Mailer.prepend_view_path(Rails.root.join('app', 'views'))
+```
+
 #### SMS delivery support
 
 You can use the built-in job to deliver the OTP via SMS, just require it and
@@ -130,8 +142,14 @@ require 'otp/sms_otp_job'
 class User < ActiveRecord::Base
   include OTP::ActiveRecord
 
+  SMS_TEMPLATE = '%{otp} is your APP magic password 🗝️'
+
   def sms_otp
-    OTP::SMSOTPJob.perform_later(phone_number, otp) if phone_number.present?
+    OTP::SMSOTPJob.perform_later(
+      phone_number,
+      otp,
+      SMS_TEMPLATE # <-- Optional text message template.
+    ) if phone_number.present?
   end
 end
 ```
@@ -238,6 +256,22 @@ The OTP delivery is handled by the `User#deliver_otp` method
 and can be customized. By default it will call the `sms_otp` method and
 if nothing is returned, it will proceed with the `email_otp` method.
 
+### JWT Tokens
+
+To help sign any sort of data, a lightweight JWT Token wrapper is provided.
+
+Signing a payload will follow the pre-defined settings like the lifetime and
+the encryption key. Decoding a token will validate any claims as well. Finally
+there's a safe wrapper to help you with the JWT specific exceptions handling.
+
+```ruby
+require 'otp/jwt/token'
+
+token = OTP::JWT::Token.sign(sub: 'my subject')
+OTP::JWT::Token.decode(token) == {'sub' => 'my subject'}
+OTP::JWT::Token.decode('bad token') == nil
+```
+
 ## Development
 
 After checking out the repo, run `bundle` to install dependencies.

data/lib/otp/jwt/token.rb

@@ -7,15 +7,6 @@ module OTP
     module Token
       include ActiveSupport::Configurable
 
-      # Resolves possible JWT exception classes
-      #
-      # Can be removed once #255 is merged.
-      # See: https://github.com/jwt/ruby-jwt/pull/255
-      JWT_EXCEPTIONS = ::JWT.constants.map do |cname|
-        klass = ::JWT.const_get(cname)
-        klass if klass.is_a?(Class) && klass <= StandardError
-      end.compact
-
       # The signature key used to sign the tokens.
       config_accessor :jwt_signature_key, instance_accessor: false
       # The signature key algorithm, defaults to HS256.
@@ -29,9 +20,12 @@ module OTP
       # @param claims [Hash], extra claims to be encoded into the token.
       #
       # @return [String], a JWT token
-      def self.sign(payload, claims = {})
-        payload = payload.merge(claims)
-        claims[:exp] ||= self.jwt_lifetime if self.jwt_lifetime.present?
+      def self.sign(payload)
+        payload = payload.dup.as_json
+
+        if payload['exp'].blank? && self.jwt_lifetime.to_i > 0
+          payload['exp'] = Time.now.to_i + self.jwt_lifetime
+        end
 
         ::JWT.encode(payload, self.jwt_signature_key, self.jwt_algorithm)
       end
@@ -39,15 +33,11 @@ module OTP
       # Verifies and returns decoded token data upon success
       #
       # @param token [String], token to be decoded.
-      # @param options [Hash], extra options to be used during verification.
+      # @param opts [Hash], extra options to be used during verification.
       #
       # @return [Hash], JWT token payload
-      def self.verify(token, options = {})
-        lifetime = self.jwt_lifetime
-        opts = {}.merge(options)
-        opts[:verify_expiration] ||= lifetime if lifetime.present?
-
-        ::JWT.decode(token.to_s, self.jwt_signature_key, true, opts)
+      def self.verify(token, opts = nil)
+        ::JWT.decode(token.to_s, self.jwt_signature_key, true, opts || {})
       end
 
       # Decodes a valid token into [Hash]
@@ -55,14 +45,17 @@ module OTP
       # Requires a block, yields JWT data. Will catch any JWT exception.
       #
       # @param token [String], token to be decoded.
-      # @param options [Hash], extra options to be used during verification.
+      # @param opts [Hash], extra options to be used during verification.
       # @return [Hash] upon success
-      def self.decode(token, options = nil)
-        return unless block_given?
-        verified, _ = self.verify(token, options || {})
-
-        yield verified
-      rescue *JWT_EXCEPTIONS
+      def self.decode(token, opts = nil)
+        verified, _ = self.verify(token, opts)
+
+        if block_given?
+          yield verified
+        else
+          verified
+        end
+      rescue ::JWT::EncodeError, ::JWT::DecodeError
       end
     end
   end

data/lib/otp/jwt/version.rb

@@ -1,5 +1,5 @@
 module OTP
   module JWT
-    VERSION = '0.1.0'
+    VERSION = '0.2.0'
   end
 end

data/lib/otp/{sms_otp_job.rb → sms_job.rb}

@@ -7,7 +7,7 @@ end
 
 module OTP
   # Uses the AWS SNS API to send the OTP SMS message.
-  class SMSOTPJob < ActiveJob::Base
+  class SMSJob < ActiveJob::Base
     # A generic template for the message body.
     TEMPLATE = '%{otp} is your magic password 🗝️'
     # Indicates if the messaging is disabled. Handy for testing purposes.

data/otp-jwt.gemspec

@@ -20,7 +20,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_dependency 'activesupport'
-  spec.add_dependency 'jwt', '~> 2.1'
+  spec.add_dependency 'jwt', '~> 2.2.0.pre.beta.0'
   spec.add_dependency 'rotp', '~> 4.1'
 
   spec.add_development_dependency 'bundler'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: otp-jwt
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Stas Suscov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-03-31 00:00:00.000000000 Z
+date: 2019-04-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: 2.2.0.pre.beta.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: 2.2.0.pre.beta.0
 - !ruby/object:Gem::Dependency
   name: rotp
   requirement: !ruby/object:Gem::Requirement
@@ -218,7 +218,7 @@ files:
 - lib/otp/jwt/version.rb
 - lib/otp/mailer.rb
 - lib/otp/mailer/otp.text.erb
-- lib/otp/sms_otp_job.rb
+- lib/otp/sms_job.rb
 - otp-jwt.gemspec
 homepage: https://github.com/stas/otp-jwt
 licenses: