solidus_jwt 0.0.2 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 20a8812041640dfdc3cc4e17aa167507f99fd01b
-  data.tar.gz: 8005596f40d291047b2c940abd721b9bb57776b7
+SHA256:
+  metadata.gz: 0cf6dd72fda604868c1589819000a6d1607a8078fa642ce2a17cb071695b26f1
+  data.tar.gz: ca122c197a880c21398f6bcf28a2e8dd7709f90613e0fe41c4f24ea166802e09
 SHA512:
-  metadata.gz: c120947ba2b1adf7b57d0128bcc32c35ffd13758f91c52a705221b138e4851bb9e7f58841216a1e2edfe85b68096efdea495493b63003ebc9f8b234da20eaa33
-  data.tar.gz: ea576aff33c96f219989f760fdbaed27393a76270ed99090a091138fdf5856b0622e7bcb0f0e428688ff4756286011951166abe24bc9ff4a6233ab2b76c0da73
+  metadata.gz: c1a2929d69915b28aec1df8c2a4fa450191ae0c465c57e5b7992938a88c9fb6363ae71282930b4dcea644add482d54c3406eb471a93a0c74a520ad8e11e9e98e
+  data.tar.gz: b7938c410ed7e14bc8098aa7314490beaff2bfc29b86249c72c9a2411f48b3a2b71441b6c17a159fff864caaf1923e348ba5b01c5acfcc570be3c60c1e75a571

data/README.md

@@ -1,6 +1,9 @@
 SolidusJwt
 ==========
 
+[![CircleCI](https://circleci.com/gh/skukx/solidus_jwt.svg?style=svg)](https://circleci.com/gh/skukx/solidus_jwt)
+[![Gem Version](https://badge.fury.io/rb/solidus_jwt.svg)](https://badge.fury.io/rb/solidus_jwt)
+
 This gem gives [Solidus](https://github.com/solidusio/solidus) stores the ability to authenticate API requests with
 JSON Web Tokens.
 
@@ -64,10 +67,20 @@ end
 
 user = Spree::User.new email: 'email@example.com', id: 1
 token = user.generate_jwt_token(expires_in: 1.hour.to_i) # Expiration is time in seconds
-# eyJhbGciOiJIUzI1NiJ9.eyJleHAiOjE1NDA1MzIzNjcsImlhdCI6IjIwMTgtMTAtMjYgMDQ6Mzk6MjcgVVRDIiwiaWQiOjEsImVtYWlsIjoiZW1haWxAZXhhbXBsZS5jb20ifQ.LWqf_cfsMwB995AqN9wj5IseJqEZYaIHHIhf8Ej7WIc
+# eyJhbGciOiJIUzI1NiJ9.eyJpZCI6MSwiZW1haWwiOiJlbWFpbEBleGFtcGxlLmNvbSIsInN1YiI6MSwiZXhwIjoxNTcyNTg2NTA3LCJpYXQiOjE1NzI1ODI5MDcsImlzcyI6InNvbGlkdXMifQ.UEmPLClCmOii_5-Qa6fB_ToGavIJYY6PAyfhARitMwI
 
 SolidusJwt.decode(token)
-# [{"exp"=>1540532367, "iat"=>"2018-10-26 04:39:27 UTC", "id"=>1, "email"=>"email@example.com"}, {"alg"=>"HS256"}]
+# [
+#   {
+#     "id"=>1, 
+#     "email"=>"email@example.com", 
+#     "sub"=>1, 
+#     "exp"=>1572586507, 
+#     "iat"=>1572582907, 
+#     "iss"=>"solidus"
+#   },
+#   {"alg"=>"HS256"}
+# ]
 ```
 
 ### Distributing a Token Using 'solidus_auth_devise':

data/app/controllers/spree/api/base_controller/json_web_tokens.rb

@@ -1,7 +1,13 @@
+##
+# Prepend for Spree::Api::BaseController methods
+#
 module Spree::Api::BaseController::JsonWebTokens
   def load_user
     return super unless json_web_token.present?
+
+    # rubocop:disable Naming/MemoizedInstanceVariableName
     @current_api_user ||= Spree.user_class.find_by(id: json_web_token['id'])
+    # rubocop:enable Naming/MemoizedInstanceVariableName
   end
 
   def json_web_token
@@ -10,10 +16,7 @@ module Spree::Api::BaseController::JsonWebTokens
     # Allow spree to try and authenticate if we still allow it. Otherwise
     # raise an error
     return if SolidusJwt::Config.allow_spree_api_key
-    raise
-  end
 
-  def invalid_jwt_format?
-    api_key.split('.').size != 3
+    raise
   end
 end

data/app/controllers/spree/api/base_controller_decorator.rb

@@ -1,7 +1,17 @@
-Spree::Api::BaseController.class_eval do
-  prepend Spree::Api::BaseController::JsonWebTokens
+module Spree
+  module Api
+    module BaseControllerDecorator
+      extend ActiveSupport::Concern
 
-  rescue_from JWT::DecodeError do
-    render "spree/api/errors/invalid_api_key", status: 401
+      included do
+        prepend Spree::Api::BaseController::JsonWebTokens
+
+        rescue_from JWT::DecodeError do
+          render "spree/api/errors/invalid_api_key", status: 401
+        end
+      end
+
+      Spree::Api::BaseController.include self
+    end
   end
 end

data/app/models/spree/user_decorator.rb

@@ -1,16 +1,30 @@
-Spree.user_class.class_eval do
-  ##
-  # Generate a json web token
-  # @see https://github.com/jwt/ruby-jwt
-  # @return [String]
-  #
-  def generate_jwt_token(expires_in: nil)
-    SolidusJwt.encode(payload: as_jwt_payload, expires_in: expires_in)
-  end
+module Spree
+  module UserDecorator
+    ##
+    # Generate a json web token
+    # @see https://github.com/jwt/ruby-jwt
+    # @return [String]
+    #
+    def generate_jwt(expires_in: nil)
+      SolidusJwt.encode(payload: as_jwt_payload, expires_in: expires_in)
+    end
+    alias generate_jwt_token generate_jwt
+
+    ##
+    # Serializes user attributes to hash and applies
+    # the sub jwt claim.
+    #
+    # @return [Hash] The payload for json web token
+    #
+    def as_jwt_payload
+      options = SolidusJwt::Config.jwt_options
+      claims = { sub: id }
 
-  private
+      as_json(options)
+        .merge(claims)
+        .as_json
+    end
 
-  def as_jwt_payload
-    as_json(only: %i[email id])
+    Spree.user_class.prepend self
   end
 end

data/lib/solidus_jwt/concerns/decodeable.rb

@@ -9,7 +9,7 @@ module SolidusJwt
     #
     def decode(token)
       JWT.decode(token, SolidusJwt::Config.jwt_secret, true,
-        algorithm: SolidusJwt::Config.jwt_algorithm)
+                 algorithm: SolidusJwt::Config.jwt_algorithm)
     end
   end
 end

data/lib/solidus_jwt/concerns/encodeable.rb

@@ -10,15 +10,17 @@ module SolidusJwt
     # @return [String]
     #
     def encode(payload:, expires_in: nil)
-      # @see https://github.com/jwt/ruby-jwt#support-for-reserved-claim-names
+      jwt_payload = payload.dup.with_indifferent_access
+
       current_time = Time.current.to_i
-      extras = {}
-      extras['exp'] = current_time + expires_in if expires_in.present?
-      extras['iat'] = current_time
 
-      payload = extras.merge(payload).as_json
-      JWT.encode(payload, SolidusJwt::Config.jwt_secret,
-        SolidusJwt::Config.jwt_algorithm)
+      # @see https://github.com/jwt/ruby-jwt#support-for-reserved-claim-names
+      jwt_payload[:exp] ||= current_time + expires_in if expires_in.present?
+      jwt_payload[:iat] ||= current_time
+      jwt_payload[:iss] ||= 'solidus'
+
+      JWT.encode(jwt_payload, SolidusJwt::Config.jwt_secret,
+                 SolidusJwt::Config.jwt_algorithm)
     end
   end
 end

data/lib/solidus_jwt/engine.rb

@@ -10,7 +10,9 @@ module SolidusJwt
     end
 
     def self.activate
-      Dir.glob(File.join(File.dirname(__FILE__), '../../app/**/*_decorator*.rb')) do |c|
+      decorator_pattern = File.join(__dir__, '../../app/**/*_decorator*.rb')
+
+      Dir.glob(decorator_pattern) do |c|
         Rails.configuration.cache_classes ? require(c) : load(c)
       end
     end

data/lib/solidus_jwt/version.rb

@@ -1,7 +1,7 @@
 module SolidusJwt
   MAJOR = 0
-  MINOR = 0
-  PATCH = 2
+  MINOR = 1
+  PATCH = 0
   PRERELEASE = nil
 
   def self.version

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: solidus_jwt
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors:
 - Taylor Scott
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-06-18 00:00:00.000000000 Z
+date: 2019-11-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: solidus_core
@@ -107,7 +107,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: poltergeist
+  name: coffee-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -121,7 +121,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: coffee-rails
+  name: database_cleaner
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -135,7 +135,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: sass-rails
+  name: factory_bot
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -149,7 +149,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: database_cleaner
+  name: ffaker
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -163,7 +163,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: factory_bot
+  name: gem-release
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -177,7 +177,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: ffaker
+  name: poltergeist
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -218,6 +218,48 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sass-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: selenium-webdriver
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -236,16 +278,16 @@ dependencies:
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.3.6
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.3.6
+        version: '0'
 description: Add Json Web Tokens to Solidus API
 email: t.skukx@gmail.com
 executables: []
@@ -293,8 +335,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Add Json Web Tokens to Solidus API