publishing_platform_sso 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e2cddff2f7bae3316381a36ba7fe8ff3c85fbc0564974da9a027236b53a10231
-  data.tar.gz: 6236ee9276d13f4e9f8dc0db85afff77076d76eaa1bc1c71cf95c0f8e8962085
+  metadata.gz: 5db45f6cf6588fdd48c90f970d1e93c510d9657c95af940a059aa6880f510113
+  data.tar.gz: 6d970b25d32bb7be21c6b7cb4ccc03567672c29770bfdb5e7f71f257d8998f6f
 SHA512:
-  metadata.gz: a3e4e2ffb09f72ecb477f756ac9f3e9bdcf632d1e96aab548f896c70aacbd0cd8ca770ce416c4e9835a3d36b70150f3e3fd430904453aadbb625350d295adf39
-  data.tar.gz: 4340d211877b42360641492bd1f20e9fa96c94896284f6e345e7074c1032876e4e8d4105d7acef77a18bd0a4c50fe885fce765f4172497c32b3ed10e4269740f
+  metadata.gz: 75829509bfa165316a74e556d67b0494fb9aa7baf9fbeee633d0499cd5cc65f56ccb39884e855faf3c801a97806bda1286afe58127a4247f8517c7f673607291
+  data.tar.gz: cf00b01c3c82f6a0f1306d702dac5ff468c6652042991320928029f509b492a1e7b71ee2f27602af69a2f027bc1bee802375b6ad536f255f98a58eaaccd9e15d

data/README.md

@@ -151,6 +151,26 @@ end
 
 The mock bearer token will then ensure that the dummy api user has the required permission.
 
+### Testing in your application
+
+If your app is using `rspec`, there is a [shared examples spec](/lib/publishing_platform_sso/lint/user_spec.rb) compatible with `PublishingPlatform::SSO::User`:
+
+```ruby
+require 'publishing_platform_sso/lint/user_spec'
+
+describe User do
+  it_behaves_like "a publishing_platform_sso user class"
+end
+```
+
+### Running the test suite
+
+Run the tests with:
+
+```
+bundle exec rake
+```
+
 ## Licence
 
 [MIT License](LICENSE)

data/Rakefile

@@ -2,7 +2,9 @@
 
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
+require "rubocop/rake_task"
 
 RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new
 
-task default: :spec
+task default: %i[rubocop spec]

data/lib/omniauth/strategies/publishing_platform.rb

@@ -5,7 +5,7 @@ class OmniAuth::Strategies::PublishingPlatform < OmniAuth::Strategies::OAuth2
   option :name, "publishing_platform"
   option :pkce, true
 
-  uid { user["uid"] }  
+  uid { user["uid"] }
 
   info do
     {

data/lib/publishing_platform_sso/lint/user_spec.rb

@@ -0,0 +1,74 @@
+RSpec.shared_examples "a publishing_platform_sso user class" do
+  subject { described_class.new(uid: "12345") }
+
+  it "implements #where" do
+    expect(described_class).to respond_to(:where)
+
+    result = described_class.where(uid: "123")
+    expect(result).to respond_to(:first)
+  end
+
+  it "implements #update_attribute" do
+    expect(subject).to respond_to(:update_attribute)
+
+    subject.update_attribute(:disabled, true)
+    expect(subject).to be_disabled
+  end
+
+  it "implements #update!" do
+    subject.update!(email: "ab@c.com")
+    expect(subject.email).to eq("ab@c.com")
+  end
+
+  it "implements #create!" do
+    expect(described_class).to respond_to(:create!)
+  end
+
+  describe "#has_all_permissions?" do
+    it "is false when there are no permissions" do
+      subject.update!(permissions: nil)
+      required_permissions = %w[signin]
+      expect(subject.has_all_permissions?(required_permissions)).to be_falsy
+    end
+
+    it "is false when it does not have all required permissions" do
+      subject.update!(permissions: %w[signin])
+      required_permissions = %w[signin not_granted_permission_one not_granted_permission_two]
+      expect(subject.has_all_permissions?(required_permissions)).to be false
+    end
+
+    it "is true when it has all required permissions" do
+      subject.update!(permissions: %w[signin internal_app])
+      required_permissions = %w[signin internal_app]
+      expect(subject.has_all_permissions?(required_permissions)).to be true
+    end
+  end
+
+  specify "the User class and PublishingPlatform::SSO::User mixin work together" do
+    auth_hash = {
+      "uid" => "12345",
+      "info" => {
+        "name" => "Joe Smith",
+        "email" => "joe.smith@example.com",
+      },
+      "extra" => {
+        "user" => {
+          "disabled" => false,
+          "permissions" => %w[signin],
+          "organisation_slug" => "digital-services",
+          "organisation_content_id" => "af07d5a5-df63-4ddc-9383-6a666845ebe9",
+        },
+      },
+    }
+
+    user = described_class.find_for_oauth(auth_hash)
+    expect(user).to be_an_instance_of(described_class)
+    expect(user.uid).to eq("12345")
+    expect(user.name).to eq("Joe Smith")
+    expect(user.email).to eq("joe.smith@example.com")
+    expect(user).not_to be_disabled
+    expect(user.permissions).to eq(%w[signin])
+    expect(user.organisation_slug).to eq("digital-services")
+    expect(user.organisation_content_id).to eq("af07d5a5-df63-4ddc-9383-6a666845ebe9")
+  end
+end

data/lib/publishing_platform_sso/version.rb

@@ -2,6 +2,6 @@
 
 module PublishingPlatform
   module SSO
-    VERSION = "0.3.1"
+    VERSION = "0.4.0"
   end
 end

data/lib/publishing_platform_sso/warden_config.rb

@@ -66,7 +66,7 @@ Warden::Strategies.add(:mock_publishing_platform_sso) do
     logger.warn("Authenticating with mock_publishing_platform_sso strategy")
 
     test_user = PublishingPlatform::SSO.test_user
-    test_user ||= PublishingPlatform::SSO::Config.user_klass.first
+    test_user ||= ENV["PUBLISHING_PLATFORM_SSO_MOCK_INVALID"].present? ? nil : PublishingPlatform::SSO::Config.user_klass.first
     if test_user
       # Brute force ensure test user has correct perms to signin
       unless test_user.has_permission?("signin")
@@ -74,6 +74,8 @@ Warden::Strategies.add(:mock_publishing_platform_sso) do
         test_user.update_attribute(:permissions, permissions << "signin")
       end
       success!(test_user)
+    elsif Rails.env.test? && ENV["PUBLISHING_PLATFORM_SSO_MOCK_INVALID"].present?
+      fail!(:invalid)
     else
       raise "publishing_platform_sso running in mock mode and no test user found. Normally we'd load the first user in the database. Create a user in the database."
     end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: publishing_platform_sso
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Publishing Platform
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-06-03 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: publishing_platform_location
@@ -108,6 +107,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.0.1
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: combustion
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
 - !ruby/object:Gem::Dependency
   name: publishing_platform_rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -122,8 +149,63 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  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'
 description: Client for Publishing Platform's OAuth 2-based SSO.
-email: 
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -144,15 +226,14 @@ files:
 - lib/publishing_platform_sso/controller_methods.rb
 - lib/publishing_platform_sso/errors.rb
 - lib/publishing_platform_sso/failure_app.rb
+- lib/publishing_platform_sso/lint/user_spec.rb
 - lib/publishing_platform_sso/railtie.rb
 - lib/publishing_platform_sso/user.rb
 - lib/publishing_platform_sso/version.rb
 - lib/publishing_platform_sso/warden_config.rb
-homepage: 
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -160,15 +241,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.0'
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
-signing_key: 
+rubygems_version: 3.6.7
 specification_version: 4
 summary: Client for Publishing Platform's OAuth 2-based SSO.
 test_files: []