ff-tbl-macros 2.0.1 → 2.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 85cfc86c605d10943cd0b90f68a3bcbc6665e7d66895862352c899d6b9b9a78d
-  data.tar.gz: 47b25e98f0cea82e20cce41539796456dac69f54c4b80d1cc8b84e4c82da3524
+  metadata.gz: 9ab61cc8e2b7d908e6f9c1cb1dc102ab14c250f77f85a319d07b9870a186c04c
+  data.tar.gz: 612b7db20cb5f8e808a86f1c00597b0f056865ea64239dee7c144c98ac5504ff
 SHA512:
-  metadata.gz: 248ba8ec756b1198b3fb1e190a86fe4490fa6490beb55a9dddfc4b6765b1ecb717273e4dab262134badcabd8f861b2862e0200270df800eb6f0a00a4667b2050
-  data.tar.gz: 17e08c9ac95a49da3d73b7889b4e01a4766042b622691a3247a27a3d84cbaf7e66fceb530e95b5e20482e0469d0f56acf1b861164bf29f78745f2f3b01135a52
+  metadata.gz: a37dbde0076242c7e11766234dedbc866abd58ac62a0e3a01160df5796ce97e35ade8cb8f357898bcc019c0c565da562377ead9c7a66406043f523c718b12de4
+  data.tar.gz: 9bf6cedb38df7e2fbb31bac449b5b8e91216b37b779372542ba1adde055563d60bbd7c81716777382babdadd0162c501a17bf3a9370a7541951eab1ac39f7ab1

data/CHANGELOG.md

@@ -1,8 +1,11 @@
 # Changelog
 
 ## [Unreleased]
+
+## [2.0.2] - 2019-06-20
 ### Added
-- add gem [rubocop-performance](https://github.com/rubocop-hq/rubocop-performance) to satisfy future Rubocop deprecations.
+- Add gem [rubocop-performance](https://github.com/rubocop-hq/rubocop-performance) to satisfy future Rubocop deprecations.
+- Add new Auth Macros, SignOutAllScopes and ExpireSessionData
 
 ## [2.0.1] - 2019-05-16
 ### Fixed
@@ -32,7 +35,7 @@
 - Add missing documentation
 
 ### Changed
-- Use rubygems version insted GitHub one
+- Use rubygems version instead GitHub one
 
 ### Added
 - Add Travis setup

data/README.md

@@ -65,6 +65,8 @@ There are several types of macros organized in namespaces.
 - `Macros::Auth::Authenticate`
 - `Macros::Auth::SignIn`
 - `Macros::Auth::SignOut`
+- `Macros::Auth::SignOutAllScopes`
+- `Macros::Auth::ExpireSessionData`
 
 ### Contract Macros
 

data/lib/macros/auth.rb

@@ -5,5 +5,7 @@ module Macros
     register :authenticate
     register :sign_in
     register :sign_out
+    register :sign_out_all_scopes
+    register :expire_session_data
   end
 end

data/lib/macros/auth/expire_session_data.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Macros
+  class Auth
+    # Expire session data
+    # Macro is used in other Devise' related macros because of the bug
+    # https://github.com/plataformatec/devise/blob/master/lib/devise/controllers/sign_in_out.rb#L108
+    #
+    # @example
+    #   step Macros::Auth::ExpireSessionData()
+    #
+    class ExpireSessionData < Macros::Base
+      # @return [Macros::Auth::ExpireSessionData] step macro instance
+      def initialize; end
+
+      # @param ctx [Trailblazer::Skill] tbl context hash
+      def call(ctx, **)
+        session = ctx[:warden].session_serializer.session
+
+        session.empty?
+        session.keys.grep(/^devise\./).each { |k| session.delete(k) }
+      end
+    end
+  end
+end

data/lib/macros/auth/sign_out_all_scopes.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Macros
+  class Auth
+    # Sign out users of all scopes
+    #
+    # @example
+    #   step Macros::Auth::SignOutAllScopes()
+    #
+    # @example specify scopes to skip sign out from
+    #   step Macros::Auth::SignOutAllScopes(except: [:admin])
+    class SignOutAllScopes < Macros::Base
+      # @return [Macros::Auth::SignOutAllScopes] step macro instance
+      # @param expect [Array] list of scopes to skip sign out
+      def initialize(except: [])
+        @except = except.is_a?(Array) ? except : [except]
+      end
+
+      # Performs a step by sign out users
+      # @param ctx [Trailblazer::Skill] tbl context hash
+      def call(ctx, **)
+        warden = ctx[:warden]
+
+        if @except.empty?
+          warden.logout
+        else
+          (Devise.mappings.keys - @except).each do |scope|
+            warden.logout(scope) if warden.authenticated?(scope: scope)
+          end
+        end
+
+        Macros::Auth::ExpireSessionData.new.call(ctx)
+        warden.clear_strategies_cache!
+        warden.lock!
+      end
+    end
+  end
+end

data/lib/macros/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Macros
-  VERSION = '2.0.1'
+  VERSION = '2.0.2'
 end

data/spec/lib/auth/expire_session_data_spec.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+RSpec.describe Macros::Auth::ExpireSessionData do
+  include Warden::Test::Mock
+
+  subject(:step) { described_class.new }
+  let(:ctx) { { warden: warden } }
+  let(:session) { warden.session_serializer.session }
+
+  before do
+    warden.session_serializer.session[:lorem] = :ipsum
+    warden.session_serializer.session['devise.lorem'] = :ipsum
+  end
+
+  it 'expects to clear devise related data from session' do
+    step.call(ctx)
+
+    expect(session[:lorem]).to eql :ipsum
+    expect(session['devise.lorem']).to be nil
+  end
+end

data/spec/lib/auth/sign_out_all_scopes_spec.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+RSpec.describe Macros::Auth::SignOutAllScopes do
+  include Warden::Test::Mock
+
+  subject(:step) { described_class.new(params) }
+  let(:params) { {} }
+
+  let(:user) { mock_model('User') }
+  let(:foo_user) { mock_model('FooUser') }
+  let(:admin) { mock_model('Admin') }
+
+  let(:ctx) { { warden: warden } }
+
+  before do
+    devise = class_double('Devise').as_stubbed_const
+    allow(devise).to receive_message_chain(:mappings, :keys).and_return([:user, :foo_user, :admin])
+
+    warden.set_user(foo_user, scope: :foo_user)
+    warden.set_user(admin, scope: :admin)
+  end
+
+  it 'expects to sign out all users' do
+    step.call(ctx)
+
+    expect(warden.authenticated?(:user)).to be false
+    expect(warden.authenticated?(:foo_user)).to be false
+    expect(warden.authenticated?(:admin)).to be false
+  end
+
+  context 'except param passed' do
+    let(:params) { { except: :admin } }
+
+    it 'expects to sign out all users except admin' do
+      step.call(ctx)
+
+      expect(warden.authenticated?(:user)).to be false
+      expect(warden.authenticated?(:foo_user)).to be false
+      expect(warden.authenticated?(:admin)).to be true
+    end
+  end
+end

data/spec/lib/auth_spec.rb

@@ -12,4 +12,12 @@ RSpec.describe Macros::Auth do
   describe '#SignOut()' do
     it { expect(described_class::SignOut()).to be_a described_class::SignOut }
   end
+
+  describe '#SignOutAllScopes()' do
+    it { expect(described_class::SignOutAllScopes()).to be_a described_class::SignOutAllScopes }
+  end
+
+  describe '#ExpireSessionData()' do
+    it { expect(described_class::ExpireSessionData()).to be_a described_class::ExpireSessionData }
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ff-tbl-macros
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.0.2
 platform: ruby
 authors:
 - Artur Szwed, Claudio Perez Gamayo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-16 00:00:00.000000000 Z
+date: 2019-06-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -70,8 +70,10 @@ files:
 - lib/ff-tbl-macros.rb
 - lib/macros/auth.rb
 - lib/macros/auth/authenticate.rb
+- lib/macros/auth/expire_session_data.rb
 - lib/macros/auth/sign_in.rb
 - lib/macros/auth/sign_out.rb
+- lib/macros/auth/sign_out_all_scopes.rb
 - lib/macros/base.rb
 - lib/macros/contract.rb
 - lib/macros/contract/extract_params.rb
@@ -95,7 +97,9 @@ files:
 - lib/macros/verify_params/date.rb
 - lib/macros/version.rb
 - spec/lib/auth/authenticate_spec.rb
+- spec/lib/auth/expire_session_data_spec.rb
 - spec/lib/auth/sign_in_spec.rb
+- spec/lib/auth/sign_out_all_scopes_spec.rb
 - spec/lib/auth/sign_out_spec.rb
 - spec/lib/auth_spec.rb
 - spec/lib/contract/extract_params_spec.rb
@@ -145,7 +149,9 @@ specification_version: 4
 summary: Trailblazer shared macros
 test_files:
 - spec/lib/auth/authenticate_spec.rb
+- spec/lib/auth/expire_session_data_spec.rb
 - spec/lib/auth/sign_in_spec.rb
+- spec/lib/auth/sign_out_all_scopes_spec.rb
 - spec/lib/auth/sign_out_spec.rb
 - spec/lib/auth_spec.rb
 - spec/lib/contract/extract_params_spec.rb