publishing_platform_sso 0.3.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e2cddff2f7bae3316381a36ba7fe8ff3c85fbc0564974da9a027236b53a10231
-  data.tar.gz: 6236ee9276d13f4e9f8dc0db85afff77076d76eaa1bc1c71cf95c0f8e8962085
+  metadata.gz: c741003970d79722a409247f1c428b44bfd5244db7225767e8d3f3e484677fbd
+  data.tar.gz: e8f167de46211c415cf4639f10c69e187c93d5583cebda3f3d9a7efda993c426
 SHA512:
-  metadata.gz: a3e4e2ffb09f72ecb477f756ac9f3e9bdcf632d1e96aab548f896c70aacbd0cd8ca770ce416c4e9835a3d36b70150f3e3fd430904453aadbb625350d295adf39
-  data.tar.gz: 4340d211877b42360641492bd1f20e9fa96c94896284f6e345e7074c1032876e4e8d4105d7acef77a18bd0a4c50fe885fce765f4172497c32b3ed10e4269740f
+  metadata.gz: e608f5c9a129b8065e28a29c0e581fa27379ed721c148d54543294fa2f6469e77f77135bf9143f412e67521dbfb5cc3fed156a2761db79a28c8ef6158eca5e2c
+  data.tar.gz: 8649c2f184d8073799642ff5854008f6cee1a0a1fb8f44a49eb2b042caa9d69df4165e537ec2d9ebea250c00a368333fd85d41c8467d94fc5cb4f8e81611f7d2

data/README.md

@@ -151,6 +151,25 @@ 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.3.2"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: publishing_platform_sso
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
 platform: ruby
 authors:
 - Publishing Platform
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-06-03 00:00:00.000000000 Z
+date: 2024-11-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: publishing_platform_location
@@ -108,6 +108,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,6 +150,62 @@ 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: []
@@ -144,6 +228,7 @@ 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
@@ -160,14 +245,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
+rubygems_version: 3.5.23
 signing_key: 
 specification_version: 4
 summary: Client for Publishing Platform's OAuth 2-based SSO.