ehsso 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 41a37f933645055e84881979530752a6fc00b703d9c49fd440f6471b4ffc8d89
-  data.tar.gz: b09678a91ac6753146a50b228a2347ff0195d0c7119cb397c08316f14c23af7c
+  metadata.gz: d41ec655415b6806e4294ff6e28d4b4a178b9dd88aca2662cf8dfdb7382e5324
+  data.tar.gz: e659665ea07cd9e34ef5390222f874265fe964fd58dc45cd3416c4134dd25791
 SHA512:
-  metadata.gz: 48973213082810d48cf6493c914b85f116267c0ac5fad19ce7bbd60ac8313897b26bdf47077b8b98d2822d09b945d88be98c30cede1e992e07bbbda913ff61eb
-  data.tar.gz: eaf2856c0cea6a238e32c164bf32cdc3cf18067086b5cf1c5b1ad502c20d53749a3c59f62da8327e8e3043e732431ceb761442ec6b5d3687e2d04f5051b5e564
+  metadata.gz: 31ef14c4188888bbfb01fa4dd73469a16346703f554eb59f365deacc047204b1eb73e15f1a2a20ce3ad7e828610278bcfab62dde61c9fec8573655c4e5966205
+  data.tar.gz: 4fe87a8e2fb5a05db5dbc456910a31d483d49208e56f5f5f0f83221b3fa4dad1fc01ebe630fb7593899ab41350ac796b5e6467803251a609e4e9a4974c5f46ac

data/.github/workflows/{ci.yml → 01_test.yml}

@@ -1,4 +1,4 @@
-name: ci
+name: 01 - Test
 
 on:
   push:
@@ -16,18 +16,16 @@ on:
   workflow_dispatch:
 
 jobs:
-  build:
+  test:
     runs-on: ubuntu-latest
-    env:
-      CC_TEST_REPORTER_ID: ${{ secrets.CC_TEST_REPORTER_ID }}
     strategy:
       fail-fast: false
       matrix:
-        ruby: [ '3.4', '3.3', '3.2', '3.1']
+        ruby: [ '3.4', '3.3', '3.2']
 
     name: Ruby ${{ matrix.ruby }}
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v5
 
     - name: Set up Ruby
       uses: ruby/setup-ruby@v1
@@ -37,16 +35,6 @@ jobs:
         bundler-cache: true
         cache-version: 1
 
-    - name: Code Climate setup test reporter
-      run: |
-        curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
-        chmod +x ./cc-test-reporter
-        ./cc-test-reporter before-build
-
-    - name: Run default task
+    - name: Run tests
       run: |
         bundle exec rake
-
-    - name: Code Climate publish test coverage
-      run: |
-        ./cc-test-reporter after-build

data/.github/workflows/{cd.yml → 02_release.yml}

@@ -1,16 +1,15 @@
-name: cd
+name: 02 - Release
 
 on:
   workflow_dispatch:
 
 jobs:
-
-  build:
+  release:
     runs-on: ubuntu-latest
 
     steps:
     - name: Checkout current code
-      uses: actions/checkout@v4
+      uses: actions/checkout@v5
 
     - name: Set up Ruby
       uses: ruby/setup-ruby@v1
@@ -20,7 +19,7 @@ jobs:
         bundler-cache: true
         cache-version: 1
 
-    - name: Push to Rubygems
+    - name: Release to RubyGems
       env:
         GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
       run: |
@@ -30,4 +29,4 @@ jobs:
         echo -e "---\n:rubygems_api_key: ${{ secrets.RUBYGEMS_API_KEY }}" > ~/.gem/credentials
         chmod 600 ~/.gem/credentials
         bundle exec rake release
-        rm ~/.gem/credentials
+        rm ~/.gem/credentials

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog of ehsso
 
+## 0.6.0 / 2025-08-20
+
+* Upgrade gem dependencies
+
 ## 0.5.0 / 2025-01-22
 
 * Upgrade gem dependencies

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 ikey.ch
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -1,21 +1,31 @@
 [![Gem Version](https://badge.fury.io/rb/ehsso.svg)](https://badge.fury.io/rb/ehsso)
-[![Maintainability](https://api.codeclimate.com/v1/badges/baea493e227c446ffe49/maintainability)](https://codeclimate.com/github/thomis/ehsso/maintainability)
-[![Test Coverage](https://api.codeclimate.com/v1/badges/baea493e227c446ffe49/test_coverage)](https://codeclimate.com/github/thomis/ehsso/test_coverage)
-[![ci](https://github.com/thomis/ehsso/actions/workflows/ci.yml/badge.svg)](https://github.com/thomis/ehsso/actions/workflows/ci.yml)
+[![01 - Test](https://github.com/thomis/ehsso/actions/workflows/01_test.yml/badge.svg)](https://github.com/thomis/ehsso/actions/workflows/01_test.yml)
+[![02 - Release](https://github.com/thomis/ehsso/actions/workflows/02_release.yml/badge.svg)](https://github.com/thomis/ehsso/actions/workflows/02_release.yml)
 
 # ehsso
 
-Company specific Single Sign On for Rails applications.
+A Rails authorization gem that integrates with company-specific Single Sign-On (SSO) infrastructure. It extracts user identity from HTTP request headers and queries a configured authorization service to retrieve user roles for your application.
+
+## How it works
+
+1. **Identity Extraction**: Reads user information from specific HTTP headers injected by your SSO infrastructure
+2. **Authorization Query**: Sends the user identity along with your application's module key to a central authorization service
+3. **Role Management**: Receives and manages user roles specific to your application/module
+4. **Access Control**: Provides simple role-checking methods for implementing authorization logic in your Rails app
+
+This gem handles the authorization aspect of SSO - determining what an already authenticated user is allowed to do in your specific application based on their assigned roles.
 
 ## Supported Ruby Versions
 
 Currently supported and tested ruby versions are:
 
-- 3.2
-- 3.1
-- 3.0
-- 2.7
-- 2.6
+- 3.4 (EOL 31 Mar 2028)
+- 3.3 (EOL 31 Mar 2027)
+- 3.2 (EOL 31 Mar 2026)
+
+Ruby versions not tested anymore:
+
+- 3.1 (EOL 31 Mar 2025)
 
 ## Installation
 
@@ -34,7 +44,7 @@ Ehsso.configure do |config|
   # Application reference
   config.module_key = 'my_module_key'
 
-  # Service Endpoint
+  # Authorization service endpoint with HTTP Basic Auth
   config.base_url   = 'http://{host}:{port}'
   config.username_and_password = 'username:password'
 end
@@ -42,8 +52,130 @@ end
 
 ## Usage
 
-to do....
+The authorization service typically returns roles like:
+- **ADMINISTRATOR** - Full system access
+- **OPERATOR** - Manage and modify resources  
+- **USER** - Standard access, read-only
+- **GUEST** - Limited access, pending approval
+
+Note: The actual roles returned depend on your authorization service configuration. The gem dynamically handles any role names returned by the service.
+
+### Basic Controller Integration
+
+```ruby
+class ApplicationController < ActionController::Base
+  before_action :authorize_user
+
+  private
+
+  def authorize_user
+    @current_user = Ehsso::Person.parse_from_request_header(request.headers)
+    
+    if @current_user.valid?
+      @current_user.fetch  # Retrieve roles from authorization service
+      
+      unless @current_user.valid?
+        render plain: 'Authorization service unavailable', status: :service_unavailable
+      end
+    else
+      render plain: 'Unauthorized', status: :unauthorized
+    end
+  end
+  
+  def current_user
+    @current_user
+  end
+end
+```
+
+### Role-Based Access Control
+
+```ruby
+class AdminController < ApplicationController
+  before_action :require_admin
+
+  def dashboard
+    # Administrator-only content
+  end
+
+  private
+
+  def require_admin
+    unless @current_user.administrator?
+      render plain: 'Access denied', status: :forbidden
+    end
+  end
+end
+
+class ResourcesController < ApplicationController
+  def index
+    # All authenticated users can view (even guests)
+    @resources = Resource.all
+  end
+
+  def show
+    # Users, operators, and administrators can view details
+    if @current_user.user? || @current_user.operator? || @current_user.administrator?
+      @resource = Resource.find(params[:id])
+    else
+      render plain: 'Guest access limited', status: :forbidden
+    end
+  end
+
+  def edit
+    # Operators and administrators can edit
+    if @current_user.operator? || @current_user.administrator?
+      @resource = Resource.find(params[:id])
+    else
+      render plain: 'Access denied', status: :forbidden
+    end
+  end
+
+  def destroy
+    # Only administrators can delete
+    if @current_user.administrator?
+      @resource = Resource.find(params[:id])
+      @resource.destroy
+      redirect_to resources_path
+    else
+      render plain: 'Access denied - Administrator only', status: :forbidden
+    end
+  end
+end
+```
+
+### Auto-Registration for New Users
+
+```ruby
+class ApplicationController < ActionController::Base
+  before_action :authorize_or_register_user
+
+  private
+
+  def authorize_or_register_user
+    @current_user = Ehsso::Person.parse_from_request_header(request.headers)
+    
+    if @current_user.valid?
+      # This will create user with 'GUEST' role if they don't exist yet
+      @current_user.fetch_or_create
+      
+      if @current_user.guest?
+        redirect_to pending_approval_path
+      elsif @current_user.user? || @current_user.operator? || @current_user.administrator?
+        # User has been granted proper access
+        return true
+      end
+    else
+      render plain: 'Missing SSO headers', status: :unauthorized
+    end
+  end
+end
+```
 
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/thomis/ehsso.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/ehsso.gemspec

@@ -30,6 +30,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "simplecov", "~> 0.21"
 
   spec.add_runtime_dependency("typhoeus", "~> 1.3")
-  spec.add_runtime_dependency("logger", "~> 1.6.5")
-  spec.add_runtime_dependency("bigdecimal", "~> 3.1.9")
+  spec.add_runtime_dependency("logger", "~> 1.7")
+  spec.add_runtime_dependency("bigdecimal", "~> 3.2")
 end

data/lib/ehsso/version.rb

@@ -1,3 +1,3 @@
 module Ehsso
-  VERSION = "0.5.0"
+  VERSION = "0.6.0"
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: ehsso
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Thomas Steiner
 bindir: exe
 cert_chain: []
-date: 2025-01-22 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -113,28 +113,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.6.5
+        version: '1.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.6.5
+        version: '1.7'
 - !ruby/object:Gem::Dependency
   name: bigdecimal
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.1.9
+        version: '3.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.1.9
+        version: '3.2'
 description: EH Single Sign On
 email:
 - thomas.steiner@ikey.ch
@@ -143,12 +143,13 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".github/dependabot.yml"
-- ".github/workflows/cd.yml"
-- ".github/workflows/ci.yml"
+- ".github/workflows/01_test.yml"
+- ".github/workflows/02_release.yml"
 - ".gitignore"
 - ".rspec"
 - CHANGELOG.md
 - Gemfile
+- LICENSE
 - README.md
 - Rakefile
 - ehsso.gemspec
@@ -175,7 +176,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.2
+rubygems_version: 3.6.9
 specification_version: 4
 summary: EH Single Sign On
 test_files: []