garage-jwt 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d2f84ca42c260e1f8b86567cab7ccf79e5c25358
-  data.tar.gz: 79637ad570d302e411fe5ea58f6a29df910211cb
+  metadata.gz: 13f07bcd332497e28c698ec45ca57eaa618adc9b
+  data.tar.gz: 03c719dd6486dda32b4c2250c4c356b4be52c121
 SHA512:
-  metadata.gz: d9489f57ec2759f93140a82e13e1da6e122d43e61be4d20aaa9ab239f42b7040833c479168eefab73a1152c1e7f3e3367eabba6f4ed1e63cb1a8d9b3b93dd54a
-  data.tar.gz: daac7867ea8900bd68d7f685ba4dcb9a55b09df1af5579ffabd5601a677bc947ca406ead6ac0976276faa751ce855aa919ef3dd12e01e58dd9ab656ee1414ba8
+  metadata.gz: 5f0772388dba8a69db7e8685bfd356fe16b71f259149f420f6c61c36603257dad03cc81933c1b3e96d91f8fd9d2f8b5c073d7c67026bf779adb45791e38efe64
+  data.tar.gz: df7feb68b2521bce23fa86b8b0fbe85b5ade73b6a8c9922b9a724d6b84278d09492007afba69d73e520002733c52ac63a463f190999a39be2b71b7d028134fd2

data/README.md

@@ -2,8 +2,11 @@
 [![Build Status](https://travis-ci.org/izumin5210/garage-jwt.svg?branch=master)](https://travis-ci.org/izumin5210/garage-jwt)
 [![Test Coverage](https://codeclimate.com/github/izumin5210/garage-jwt/badges/coverage.svg)](https://codeclimate.com/github/izumin5210/garage-jwt/coverage)
 [![Code Climate](https://codeclimate.com/github/izumin5210/garage-jwt/badges/gpa.svg)](https://codeclimate.com/github/izumin5210/garage-jwt)
+[![Dependency Status](https://gemnasium.com/badges/github.com/izumin5210/garage-jwt.svg)](https://gemnasium.com/github.com/izumin5210/garage-jwt)
+[![Gem Version](https://badge.fury.io/rb/garage-jwt.svg)](https://badge.fury.io/rb/garage-jwt)
+[![MIT License](http://img.shields.io/badge/license-MIT-blue.svg?style=flat)](https://izumin.mit-license.org/2016)
 
-Garage extension to use JWT as authentication strategy.
+[Garage](https://github.com/cookpad/garage) extension to use JWT as authentication strategy.
 
 
 ## Installation
@@ -57,16 +60,19 @@ The following cryptographic signing algorithms are available:
 
 
 ### Generate token
+You can encode token with the following method:
 
 ```ruby
-Garage::Jwt::Utils.encode(
-  resource_owner_id: user.di,
+Garage::Jwt.encode_token(
+  resource_owner_id: user.id,
   application_id: 128,
   scope: "read write",
   expired_at: Time.zone.now + 15.minutes
 )
 ```
 
+Or if you use `Garage::ControllerHelper`, you can use `encode_token` method.
+
 
 ## Development
 

data/lib/garage/jwt.rb

@@ -7,3 +7,9 @@ require "garage/jwt/config"
 require "garage/jwt/error"
 require "garage/jwt/utils"
 require "garage/strategy/jwt"
+
+module Garage
+  module Jwt
+    extend Utils
+  end
+end

data/lib/garage/jwt/config.rb

@@ -17,23 +17,32 @@ module Garage
           block.call(@config)
         end
 
-        def valid?
-          @config.algorithm.present? &&
-            @config.algorithm.is_a?(Garage::Jwt::Algorithm) &&
-            (
-              (!@config.algorithm.need_common_key? || @config.common_key.present?) &&
-              (!@config.algorithm.need_public_key? || @config.public_key.present?) &&
-              (!@config.algorithm.need_private_key? || @config.private_key.present?)
-            )
+        def build
+          validate!
+          @config
         end
 
-        def build
-          if valid?
-            @config
-          else
-            fail Garage::Jwt::InitializeError
+        private
+
+        def validate!
+          unless valid_algorithm?
+            fail Garage::Jwt::InitializeError.new("Invalid algorithm")
+          end
+          unless valid_keys?
+            fail Garage::Jwt::InitializeError.new("Invalid keys")
           end
         end
+
+        def valid_algorithm?
+          @config.algorithm.present? &&
+            @config.algorithm.is_a?(Garage::Jwt::Algorithm)
+        end
+
+        def valid_keys?
+          (!@config.algorithm.need_common_key? || @config.common_key.present?) &&
+            (!@config.algorithm.need_public_key? || @config.public_key.present?) &&
+            (!@config.algorithm.need_private_key? || @config.private_key.present?)
+        end
       end
     end
   end

data/lib/garage/jwt/utils.rb

@@ -1,60 +1,58 @@
 module Garage
   module Jwt
     module Utils
-      class << self
-        def encode(resource_owner_id:, application_id:, expired_at:, scope:)
-          payload = {
-            sub: resource_owner_id,
-            aud: application_id,
-            exp: expired_at.to_i,
-            scope: (scope.is_a?(Array) ? scope.join(" ") : scope)
-          }
-          JWT.encode(payload, private_key, algorithm.type)
-        end
-
-        def decode(token, token_type)
-          payload, _ = JWT.decode(token, public_key, verify?, decoding_options)
-          { token: token,
-            token_type: token_type,
-            scope: payload["scope"],
-            application_id: payload["aud"],
-            resource_owner_id: payload["sub"],
-            expired_at: payload["exp"],
-            revoked_at: nil
-          }
-        rescue JWT::DecodeError => e
-          nil
-        end
-
-        private
-
-        def configuration
-          Garage::Jwt.configuration
-        end
-
-        def algorithm
-          configuration.algorithm
-        end
-
-        def public_key
-          algorithm.need_public_key? ? configuration.public_key : common_key
-        end
-
-        def private_key
-          algorithm.need_public_key? ? configuration.private_key : common_key
-        end
-
-        def common_key
-          algorithm.need_common_key? ? configuration.common_key : nil
-        end
-
-        def decoding_options
-          { algorithm: algorithm.type, verify_expiration: false }
-        end
-
-        def verify?
-          !algorithm.none?
-        end
+      def encode_token(resource_owner_id:, application_id:, expired_at:, scope:)
+        payload = {
+          sub: resource_owner_id,
+          aud: application_id,
+          exp: expired_at.to_i,
+          scope: (scope.is_a?(Array) ? scope.join(" ") : scope)
+        }
+        JWT.encode(payload, private_key, algorithm.type)
+      end
+
+      def decode_token(token, token_type)
+        payload, _ = JWT.decode(token, public_key, verify?, decoding_options)
+        { token: token,
+          token_type: token_type,
+          scope: payload["scope"],
+          application_id: payload["aud"],
+          resource_owner_id: payload["sub"],
+          expired_at: payload["exp"],
+          revoked_at: nil
+        }
+      rescue JWT::DecodeError => e
+        nil
+      end
+
+      private
+
+      def configuration
+        Garage::Jwt.configuration
+      end
+
+      def algorithm
+        configuration.algorithm
+      end
+
+      def public_key
+        algorithm.need_public_key? ? configuration.public_key : common_key
+      end
+
+      def private_key
+        algorithm.need_public_key? ? configuration.private_key : common_key
+      end
+
+      def common_key
+        algorithm.need_common_key? ? configuration.common_key : nil
+      end
+
+      def decoding_options
+        { algorithm: algorithm.type, verify_expiration: false }
+      end
+
+      def verify?
+        !algorithm.none?
       end
     end
   end

data/lib/garage/jwt/version.rb

@@ -1,5 +1,5 @@
 module Garage
   module Jwt
-    VERSION = "0.1.0"
+    VERSION = "0.2.0"
   end
 end

data/lib/garage/strategy/jwt.rb

@@ -2,6 +2,8 @@ module Garage
   module Strategy
     module Jwt
       extend ActiveSupport::Concern
+      include Garage::Jwt::Utils
+
       included do
         before_action :verify_auth, if: -> (_) { verify_permission? }
       end
@@ -15,7 +17,7 @@ module Garage
           @access_token
         else
           token_type, token = request.authorization.try { |h| h.split(/\s+/) }
-          decoded_token = Garage::Jwt::Utils.decode(token, token_type)
+          decoded_token = decode_token(token, token_type)
           if decoded_token.present?
             @access_token = Garage::Strategy::AccessToken.new(decoded_token)
           else

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: garage-jwt
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - izumin5210