solidus_jwt 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0f3f9ec2c12488185b2ee9bff66409693f0d92ab52bde2adb67cc47df182a82a
-  data.tar.gz: a77951e23f7d2352c5a2dde5a2742997f38bfb8e07ac31f1ae4f8be7b6bfc12c
+  metadata.gz: 5069a0d35cb2f777cae543265907fdd284e8e42ccb0e86c8bc4775e17beb6a88
+  data.tar.gz: 1019df1fc49a245eb54d5b64e1f52956a405c4f4f1003a043d65d81b871d672a
 SHA512:
-  metadata.gz: '058c6e5d8bcc54fa1b623b68ab46848f9e9ffb6feee2e97f048c1047ed6a5c11ce78990aef67b6432d051471e718c09ef00b30717b0419edd88d95cbf0ca8412'
-  data.tar.gz: 95993510aecd67280bc85dc283798edae88d9c8388c1997190f8420d2ea4351d6e88273d7f5236449df52ff035e276725c924a5a835144c10dc458146bbe6bb3
+  metadata.gz: b042053167cadec496c99b501b12ada4a3090ea7163afa15718a768b9b01ab822ff8a6f139ffd8c93377525d26b0c83917acb19944ad485b161dd5162a14f1bf
+  data.tar.gz: c8266151ccbd5d50042c289e1ccd2993854dc305e364576489d08a38ab0a0b42166a93a1ac454aac438f306cb46785055cca600003c50bbdf1f8eadd288e72fa

data/.gem_release.yml

@@ -1,5 +1,5 @@
 bump:
   recurse: false
   file: 'lib/solidus_jwt/version.rb'
-  message: Bump SolidusJwt to %{version}
-  branch: true
+  message: Bump SolidusDemo1 to %{version}
+  tag: true

data/.rubocop.yml

@@ -6,26 +6,9 @@ AllCops:
     - sandbox/**/*
     - spec/dummy/**/*
 
-Style/FrozenStringLiteralComment:
-  Enabled: false
-
-Naming/PredicateName:
-  Exclude:
-    - app/decorators/solidus_kits/spree/stock/availability_validator_decorator.rb
-
 Metrics/LineLength:
   Enabled: false
 
-Rails/SkipsModelValidations:
-  Exclude:
-    - 'spec/**/*'
-
-RSpec/BeforeAfterAll:
-  Enabled: false
-
-RSpec/ContextWording:
-  Enabled: false
-
 RSpec/MultipleExpectations:
   Enabled: false
 

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 git_source(:github) { |repo| "https://github.com/#{repo}.git" }
 

data/README.md

@@ -111,6 +111,19 @@ You can now use the `access_token` to authentication with the
 [Solidus API](https://github.com/solidusio/solidus/tree/master/api) in place
 of the `spree_api_key`.
 
+#### Matching token to a user
+
+By default, the token matches a user using the `Spree::User.for_jwt` method. This methods
+Finds a user by id using the subject claim of the token. If you want to customize how the
+subject claim is interpreted you can override this method
+
+```ruby
+def self.for_jwt(sub)
+  # find_by(id: sub)
+  find_by(my_external_id: sub)
+end
+```
+
 ### Obtain a refresh token
 
 To refresh your access token, instead of re-authenticating you can send

data/app/decorators/{solidus_jwt → controllers/solidus_jwt}/spree/api/base_controller_decorator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SolidusJwt
   module Spree
     module Api
@@ -16,7 +18,7 @@ module SolidusJwt
           return super if json_web_token.blank?
 
           # rubocop:disable Naming/MemoizedInstanceVariableName
-          @current_api_user ||= ::Spree.user_class.find_by(id: json_web_token['id'])
+          @current_api_user ||= ::Spree.user_class.for_jwt(json_web_token['sub'] || json_web_token['id'])
           # rubocop:enable Naming/MemoizedInstanceVariableName
         end
 

data/app/decorators/{solidus_jwt → models/solidus_jwt}/spree/user_decorator.rb

@@ -1,10 +1,32 @@
+# frozen_string_literal: true
+
 module SolidusJwt
   module Spree
     module UserDecorator
       def self.prepended(base)
+        base.extend ClassMethods
         base.has_many :auth_tokens, class_name: 'SolidusJwt::Token'
       end
 
+      module ClassMethods
+        ##
+        # Find user based on subject claim in
+        # our json web token
+        # @see https://tools.ietf.org/html/rfc7519#section-4.1.2
+        #
+        # @example get user token
+        #   payload = SolidusJwt.decode(token).first
+        #   user = Spree::User.for_jwt(payload['sub'])
+        #
+        # @param sub [string] The subject claim of jwt
+        # @return [Spree.user_class, NilClass] If a match is found, returns the user,
+        #   otherwise, returns nil
+        #
+        def for_jwt(sub)
+          find_by(id: sub)
+        end
+      end
+
       ##
       # Generate a json web token
       # @see https://github.com/jwt/ruby-jwt

data/app/models/solidus_jwt/base_record.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SolidusJwt
   base_class = defined?(::ApplicationRecord) ? ::ApplicationRecord : ActiveRecord::Base
 

data/app/models/solidus_jwt/token.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SolidusJwt
   class Token < BaseRecord
     attr_readonly :token

data/bin/r

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+warn %{
+DEPRECATION: bin/r has been replaced by bin/rails-engine, please use that
+command instead.
+}.strip
+
+exec "#{__dir__}/rails-engine"

data/bin/rails

@@ -1,18 +1,8 @@
 #!/usr/bin/env ruby
-
 # frozen_string_literal: true
 
-app_root = 'sandbox'
-
-unless File.exist? "#{app_root}/bin/rails"
-  warn 'Creating the sandbox app...'
-  Dir.chdir "#{__dir__}/.." do
-    system "#{__dir__}/sandbox" or begin # rubocop:disable Style/AndOr
-      warn 'Automatic creation of the sandbox app failed'
-      exit 1
-    end
-  end
+if %w[g generate].include? ARGV.first
+  exec "#{__dir__}/rails-engine", *ARGV
+else
+  exec "#{__dir__}/rails-sandbox", *ARGV
 end
-
-Dir.chdir app_root
-exec 'bin/rails', *ARGV

data/bin/rails-engine

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# This command will automatically be run when you run "rails" with Rails gems
+# installed from the root of your application.
+
+ENGINE_ROOT = File.expand_path('..', __dir__)
+ENGINE_PATH = File.expand_path('../lib/solidus_jwt/engine', __dir__)
+
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../Gemfile', __dir__)
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+
+require 'rails/all'
+require 'rails/engine/commands'

data/bin/rails-sandbox

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+app_root = 'sandbox'
+
+unless File.exist? "#{app_root}/bin/rails"
+  warn 'Creating the sandbox app...'
+  Dir.chdir "#{__dir__}/.." do
+    system "#{__dir__}/sandbox" or begin # rubocop:disable Style/AndOr
+      warn 'Automatic creation of the sandbox app failed'
+      exit 1
+    end
+  end
+end
+
+Dir.chdir app_root
+exec 'bin/rails', *ARGV

data/bin/rake

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rake", "rake")

data/bin/sandbox

@@ -53,7 +53,9 @@ gem 'solidus', github: 'solidusio/solidus', branch: '$BRANCH'
 gem 'solidus_auth_devise', '>= 2.1.0'
 gem 'rails-i18n'
 gem 'solidus_i18n'
+
 gem '$extension_name', path: '..'
+
 group :test, :development do
   platforms :mri do
     gem 'pry-byebug'
@@ -69,6 +71,7 @@ unbundled bundle exec rails generate spree:install \
   --auto-accept \
   --user_class=Spree::User \
   --enforce_available_locales=true \
+  --with-authentication=false \
   $@
 
 unbundled bundle exec rails generate solidus:auth:install
@@ -78,4 +81,4 @@ echo "🚀 Sandbox app successfully created for $extension_name!"
 echo "🚀 Using $RAILSDB and Solidus $BRANCH"
 echo "🚀 Use 'export DB=[postgres|mysql|sqlite]' to control the DB adapter"
 echo "🚀 Use 'export SOLIDUS_BRANCH=<BRANCH-NAME>' to control the Solidus version"
-echo "🚀 This app is intended for test purposes."
+echo "🚀 This app is intended for test purposes."

data/bin/sandbox_rails

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+warn %{
+DEPRECATION: bin/sandbox_rails has been replaced by bin/rails-sandbox, please
+use that command instead.
+}.strip
+
+exec "#{__dir__}/rails-engine"

data/config/routes.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 Spree::Core::Engine.routes.draw do
   # Add your extension routes here
   post 'oauth/token', to: 'api/oauths#token'

data/db/migrate/20190222220038_create_solidus_jwt_tokens.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class CreateSolidusJwtTokens < ActiveRecord::Migration[5.2]
   def change
     create_table :solidus_jwt_tokens do |t|

data/db/migrate/20191212083655_add_foreign_key_to_users_table.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class AddForeignKeyToUsersTable < ActiveRecord::Migration[5.2]
   def change
     add_foreign_key :solidus_jwt_tokens, Spree.user_class.table_name, column: :user_id, on_delete: :cascade

data/{app/controllers → lib/controllers/api}/spree/api/oauths_controller.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Spree
   module Api
     class OauthsController < BaseController

data/lib/generators/solidus_jwt/install/install_generator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SolidusJwt
   module Generators
     class InstallGenerator < Rails::Generators::Base

data/lib/solidus_jwt.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'jwt'
 
 require 'solidus_core'

data/lib/solidus_jwt/concerns/decodeable.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SolidusJwt
   module Decodeable
     ##

data/lib/solidus_jwt/concerns/encodeable.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SolidusJwt
   module Encodeable
     ##

data/lib/solidus_jwt/config.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'solidus_jwt/preferences'
 
 SolidusJwt::Config = SolidusJwt::Preferences.new

data/lib/solidus_jwt/devise_strategies/base.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SolidusJwt
   module DeviseStrategies
     class Base < Devise::Strategies::Authenticatable

data/lib/solidus_jwt/devise_strategies/password.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SolidusJwt
   module DeviseStrategies
     class Password < Base

data/lib/solidus_jwt/devise_strategies/refresh_token.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SolidusJwt
   module DeviseStrategies
     class RefreshToken < Base

data/lib/solidus_jwt/distributor/devise.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SolidusJwt
   module Distributor
     module Devise

data/lib/solidus_jwt/engine.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 require 'spree/core'
 
 module SolidusJwt
   class Engine < Rails::Engine
-    include SolidusSupport::EngineExtensions::Decorators
+    include SolidusSupport::EngineExtensions
 
     isolate_namespace ::Spree
 

data/lib/solidus_jwt/factories.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 FactoryBot.define do
   # Define your Spree extensions Factories within this file to enable applications, and other extensions to use and override them.
   #

data/lib/solidus_jwt/preferences.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spree/preferences/configuration'
 
 module SolidusJwt

data/lib/solidus_jwt/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SolidusJwt
-  VERSION = '1.1.0'
+  VERSION = '1.2.0'
 end

data/solidus_jwt.gemspec

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'lib/solidus_jwt/version'
 
 Gem::Specification.new do |s|
@@ -29,7 +31,7 @@ Gem::Specification.new do |s|
   s.add_dependency 'jwt'
   s.add_dependency 'solidus_auth_devise'
   s.add_dependency 'solidus_core', ['>= 2.0.0', '< 3']
-  s.add_dependency 'solidus_support', '~> 0.4.0'
+  s.add_dependency 'solidus_support', '~> 0.5.0'
 
   s.add_development_dependency 'byebug'
   s.add_development_dependency 'solidus_dev_support'

data/spec/lib/solidus_jwt/config_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 RSpec.describe SolidusJwt::Config do

data/spec/lib/solidus_jwt/devise_strategies/password_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 require 'spree/testing_support/factories/user_factory'
 

data/spec/lib/solidus_jwt/devise_strategies/refresh_token_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 require 'spree/testing_support/factories/user_factory'
 

data/spec/lib/solidus_jwt/preferences_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 RSpec.describe SolidusJwt::Preferences do

data/spec/lib/solidus_jwt_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 RSpec.describe SolidusJwt do

data/spec/models/solidus_jwt/token_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 RSpec.describe SolidusJwt::Token, type: :model do

data/spec/requests/spree/api/json_web_tokens_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 require 'spree/testing_support/factories/user_factory'
 
@@ -46,11 +48,11 @@ RSpec.describe 'SolidusJwt Authentication', type: :request do
   end
 
   context 'when spree api key is not allowed' do
-    before(:all) do
+    before do
       SolidusJwt::Config.allow_spree_api_key = false
     end
 
-    after(:all) do
+    after do
       SolidusJwt::Config.allow_spree_api_key = true
     end
 

data/spec/requests/spree/api/oauths_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 require 'spree/testing_support/factories/user_factory'
 

data/spec/spec_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Configure Rails Environment
 ENV['RAILS_ENV'] = 'test'
 

data/spec/support/shared_examples/decodeable_examples.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 RSpec.shared_examples 'Decodeable Examples' do
   describe 'decode' do
     let(:token) do

data/spec/support/shared_examples/encodeable_examples.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 RSpec.shared_examples 'Encodeable Examples' do
   describe 'encode' do
     let(:payload) { { user_id: 1 } }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: solidus_jwt
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Taylor Scott
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-03-16 00:00:00.000000000 Z
+date: 2020-06-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jwt
@@ -64,14 +64,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.4.0
+        version: 0.5.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.4.0
+        version: 0.5.0
 - !ruby/object:Gem::Dependency
   name: byebug
   requirement: !ruby/object:Gem::Requirement
@@ -120,19 +120,24 @@ files:
 - README.md
 - Rakefile
 - _config.yml
-- app/controllers/spree/api/oauths_controller.rb
-- app/decorators/solidus_jwt/spree/api/base_controller_decorator.rb
-- app/decorators/solidus_jwt/spree/user_decorator.rb
+- app/decorators/controllers/solidus_jwt/spree/api/base_controller_decorator.rb
+- app/decorators/models/solidus_jwt/spree/user_decorator.rb
 - app/models/solidus_jwt/base_record.rb
 - app/models/solidus_jwt/token.rb
 - bin/console
+- bin/r
 - bin/rails
+- bin/rails-engine
+- bin/rails-sandbox
+- bin/rake
 - bin/sandbox
+- bin/sandbox_rails
 - bin/setup
 - config/locales/en.yml
 - config/routes.rb
 - db/migrate/20190222220038_create_solidus_jwt_tokens.rb
 - db/migrate/20191212083655_add_foreign_key_to_users_table.rb
+- lib/controllers/api/spree/api/oauths_controller.rb
 - lib/generators/solidus_jwt/install/install_generator.rb
 - lib/solidus_jwt.rb
 - lib/solidus_jwt/concerns/decodeable.rb