ehsso 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 4b9f42d709131a3559722cc3301702af74de6e11
-  data.tar.gz: 0c4397591c3bbd65225c310105e5a82935be1f1f
+SHA256:
+  metadata.gz: 683f903f1ea816c48a57b9eda4d13dcf404f0df8b59201b3f96ecba20d1edc4d
+  data.tar.gz: 91902a4685398e35c4bb8eeed376c3d198e1e624115373bb308912d4cdb9fe8f
 SHA512:
-  metadata.gz: 5583feb1942472c6e5269be1093272994e0c7712b4c42b35c757404965e252a766179d490950ed64a301e217bbf3409d05a71ce68c020035b00290fc7bffc9dd
-  data.tar.gz: d6cfffba5063f2b3b59f54442ec65eef9389b27dceba8dd2f5a6877afb87c63265957c31f81284e7a82409b97ccb7386f65d6b8ae3f0c330fa80071f9f532fd2
+  metadata.gz: 5a500f497f559da02ed4108bd46d73ab2cb99c4aa83f19e9cd2564299e66ec777a60bb69b7cb610b462b7573199d70d3b7213dd8a068e2cefde6b2df14506988
+  data.tar.gz: 957687c29349f36dd75c09596b6ae092516b7e2cb36058c058f3ee68392ca91addf601b475d415fd6c1078cf144935f450165bd51430fc6a7e817b77154f8c28

data/.github/dependabot.yml

@@ -0,0 +1,9 @@
+version: 2
+updates:
+  - package-ecosystem: "bundler"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+      day: "saturday"
+      time: "04:00"
+      timezone: "Europe/Zurich"

data/.github/workflows/cd.yml

@@ -0,0 +1,33 @@
+name: cd
+
+on:
+  workflow_dispatch:
+
+jobs:
+
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout current code
+      uses: actions/checkout@v3
+
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: '3.1'
+        bundler: latest
+        bundler-cache: true
+        cache-version: 1
+
+    - name: Push to Rubygems
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      run: |
+        git config --global user.email "thomas.steiner@ikey.ch"
+        git config --global user.name "thomis"
+        mkdir ~/.gem
+        echo -e "---\n:rubygems_api_key: ${{ secrets.RUBYGEMS_API_KEY }}" > ~/.gem/credentials
+        chmod 600 ~/.gem/credentials
+        bundle exec rake release
+        rm ~/.gem/credentials

data/.github/workflows/ci.yml

@@ -0,0 +1,52 @@
+name: ci
+
+on:
+  push:
+    branches:
+      - "*"
+
+  pull_request:
+    branches:
+      - "*"
+
+  schedule:
+  - cron: 0 2 * * 1,3,5,6
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    env:
+      CC_TEST_REPORTER_ID: ${{ secrets.CC_TEST_REPORTER_ID }}
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: [ '3.2', '3.1', '3.0', '2.7', '2.6']
+
+    name: Ruby ${{ matrix.ruby }}
+    steps:
+    - uses: actions/checkout@v3
+
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        bundler: latest
+        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
+      run: |
+        bundle exec rake
+
+    - name: Code Climate publish test coverage
+      run: |
+        ./cc-test-reporter after-build

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 # Changelog of ehsso
 
+## 0.4.0 / 2022-11-20
+
+* Upgrade gem dependencies
+* Add ci support for ruby 3.2
+* Switch to GitHub actions incl. workflow to push relase to rubygems
+* Use of standard style guide, linter and formatter
+* Check test coverage
+* Use of Dependabot
+* Remove support for ruby 2.5 and 2.6
+
 ## 0.3.0 / 2019-02-20
 
 * Upgrade dependencies: bundler 2.0, rspec 3.8, rake 12.3, typhoeus 1.3.1

data/Gemfile

@@ -1,4 +1,4 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
 # Specify your gem's dependencies in ehsso.gemspec
 gemspec

data/README.md

@@ -1,11 +1,22 @@
 [![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)
-[![Build Status](https://travis-ci.org/thomis/ehsso.svg?branch=master)](https://travis-ci.org/thomis/ehsso)
+[![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)
 
 # ehsso
 
 Company specific Single Sign On for Rails applications.
 
+## Supported Ruby Versions
+
+Currently supported and tested ruby versions are:
+
+- 3.2
+- 3.1
+- 3.0
+- 2.7
+- 2.6
+
 ## Installation
 
 Simply add ehsso to your Gemfile and bundle it up.

data/Rakefile

@@ -1,6 +1,9 @@
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
+require "standard/rake"
 
-RSpec::Core::RakeTask.new(:spec)
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.verbose = false
+end
 
-task :default => :spec
+task default: [:spec, :standard]

data/ehsso.gemspec

@@ -1,31 +1,31 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'ehsso/version'
+require "ehsso/version"
 
 Gem::Specification.new do |spec|
-  spec.name          = "ehsso"
-  spec.version       = Ehsso::VERSION
-  spec.date          = "2017-06-14"
-  spec.authors       = ["Thomas Steiner"]
-  spec.email         = ["thomas.steiner@ikey.ch"]
+  spec.name = "ehsso"
+  spec.version = Ehsso::VERSION
+  spec.authors = ["Thomas Steiner"]
+  spec.email = ["thomas.steiner@ikey.ch"]
 
-  spec.summary       = %q{EH Single Sign On}
-  spec.description   = %q{EH Single Sign On}
-  spec.homepage      = "http://github.com/thomis/ehsso"
-  spec.license       = "MIT"
+  spec.summary = "EH Single Sign On"
+  spec.description = "EH Single Sign On"
+  spec.homepage = "http://github.com/thomis/ehsso"
+  spec.license = "MIT"
 
-  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 2.0"
-  spec.add_development_dependency "rake", "~> 12.3"
-  spec.add_development_dependency "rspec", "~> 3.8"
-  spec.add_development_dependency "rails", "~> 5.1"
+  spec.add_development_dependency "bundler", "~> 2.3"
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "rspec", "~> 3.12"
+  spec.add_development_dependency "rails", "~> 6.1.6.1"
+  spec.add_development_dependency "standard", "~> 1.18"
+  spec.add_development_dependency "simplecov", "~> 0.21"
 
   spec.add_runtime_dependency("typhoeus", "~> 1.3")
 end

data/lib/ehsso/configuration.rb

@@ -1,13 +1,12 @@
 module Ehsso
-
   class Configuration
     attr_accessor :module_key
     attr_accessor :base_url
     attr_accessor :username_and_password
 
     def initialize
-      @module_key            = ''
-      @base_url              = ''
+      @module_key = ""
+      @base_url = ""
       @username_and_password = nil
     end
   end
@@ -20,5 +19,4 @@ module Ehsso
     self.configuration ||= Configuration.new
     yield(configuration)
   end
-
 end

data/lib/ehsso/engine.rb

@@ -1,5 +1,5 @@
-require 'rails/engine'
-require 'typhoeus'
+require "rails/engine"
+require "typhoeus"
 
 module Ehsso
   class Engine < ::Rails::Engine

data/lib/ehsso/person.rb

@@ -1,7 +1,5 @@
 module Ehsso
-
   class Person
-
     attr_accessor :id
     attr_accessor :reference
     attr_accessor :first_name
@@ -13,17 +11,17 @@ module Ehsso
 
     attr_accessor :last_error_message
 
-    def initialize(args={})
-      @id               = args[:id]
-      @reference        = args[:reference]
-      @first_name       = args[:first_name]
-      @last_name        = args[:last_name]
-      @email            = args[:email]
+    def initialize(args = {})
+      @id = args[:id]
+      @reference = args[:reference]
+      @first_name = args[:first_name]
+      @last_name = args[:last_name]
+      @email = args[:email]
 
       # for this purpose we deal with only one module
-      @module_key       = args[:module_key]
-      @module_name      = args[:module_name]
-      @roles            = args[:roles].is_a?(Array) ? args[:roles] : []
+      @module_key = args[:module_key]
+      @module_name = args[:module_name]
+      @roles = args[:roles].is_a?(Array) ? args[:roles] : []
     end
 
     def valid?
@@ -32,54 +30,58 @@ module Ehsso
 
     # you can use methods like guest?, user?, operator?, administrator? etc.
     def method_missing(method)
-      raise "Method [#{method}] not defined or allowed" unless method[-1] == '?'
+      raise "Method [#{method}] not defined or allowed" unless method[-1] == "?"
       @roles.include?(method[0..-2].upcase)
     end
 
+    def respond_to_missing?(method)
+      true if method[-1] == "?"
+    end
+
     def full_name
-      return nil if self.last_name.nil? && self.first_name.nil?
-      [self.last_name, self.first_name].compact.join(" ")
+      return nil if last_name.nil? && first_name.nil?
+      [last_name, first_name].compact.join(" ")
     end
 
-    def self.parse_from_request_header(header={})
-      person = Ehsso::Person.new()
+    def self.parse_from_request_header(header = {})
+      person = Ehsso::Person.new
 
       # reference (mandatory)
-      if header['HTTP_NIBR521'].nil? || header['HTTP_NIBR521'].size == 0
+      if header["HTTP_NIBR521"].nil? || header["HTTP_NIBR521"].size == 0
         person.last_error_message = "Unable to extract HTTP_NIBR* porperties from request header"
         return person
       end
 
-      person.reference = header['HTTP_NIBR521'].downcase
+      person.reference = header["HTTP_NIBR521"].downcase
 
       [
-        [:first_name=, 'HTTP_NIBRFIRST'],
-        [:last_name=, 'HTTP_NIBRLAST'],
-        [:email=, 'HTTP_NIBREMAIL']
+        [:first_name=, "HTTP_NIBRFIRST"],
+        [:last_name=, "HTTP_NIBRLAST"],
+        [:email=, "HTTP_NIBREMAIL"]
       ].each do |method, key|
         person.send(method, header[key]) if header[key] && header[key].strip.size > 0
       end
 
-      return person
+      person
     rescue => e
       person.last_error_message = e.to_s
-      return person
+      person
     end
 
     def fetch
-      handle_service_call(action: 'people.modules.roles')
+      handle_service_call(action: "people.modules.roles")
     end
 
     def fetch_or_create
-      handle_service_call(action: 'people_with_guest_registration_if_missing.modules.roles')
+      handle_service_call(action: "people_with_guest_registration_if_missing.modules.roles")
     end
 
     private
 
-    def payload(args={})
+    def payload(args = {})
       {
-        type: 'request',
-        action: args[:action] || 'people.modules.roles',
+        type: "request",
+        action: args[:action] || "people.modules.roles",
         request: [
           {
             reference: @reference,
@@ -96,8 +98,8 @@ module Ehsso
       }
     end
 
-    def handle_service_call(args={})
-      url = [Ehsso.configuration.base_url, 'people'].join('/')
+    def handle_service_call(args = {})
+      url = [Ehsso.configuration.base_url, "people"].join("/")
       userpwd = Ehsso.configuration.username_and_password
 
       # allows to mock class for rspec
@@ -112,17 +114,17 @@ module Ehsso
         begin
           data = JSON.parse(response.body)
 
-          item = data['response'][0]
-          @id = item['id']
-          @reference = item['reference']
-          @first_name = item['first_name']
-          @last_name = item['last_name']
-          @email = item['email']
-
-          modul = item['modules'][0]
-          @module_key = modul['reference']
-          @module_name = modul['name']
-          @roles = modul['roles']
+          item = data["response"][0]
+          @id = item["id"]
+          @reference = item["reference"]
+          @first_name = item["first_name"]
+          @last_name = item["last_name"]
+          @email = item["email"]
+
+          modul = item["modules"][0]
+          @module_key = modul["reference"]
+          @module_name = modul["name"]
+          @roles = modul["roles"]
           @last_error_message = nil
         rescue
           @last_error_message = "Unable to parse service response data"
@@ -132,13 +134,11 @@ module Ehsso
         begin
           # try to parse the body to get valid error message
           data = JSON.parse(response.body)
-          @last_error_message = data['response_message']
+          @last_error_message = data["response_message"]
         rescue
           @last_error_message = "#{response.request.url}: [#{response.code}] #{response.return_message}"
         end
       end
     end
-
   end
-
 end

data/lib/ehsso/version.rb

@@ -1,3 +1,3 @@
 module Ehsso
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

data/lib/ehsso.rb

@@ -1,9 +1,9 @@
-require 'json'
+require "json"
 
-require 'ehsso/version'
-require 'ehsso/configuration'
-require 'ehsso/engine'
-require 'ehsso/person'
+require "ehsso/version"
+require "ehsso/configuration"
+require "ehsso/engine"
+require "ehsso/person"
 
 module Ehsso
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ehsso
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Thomas Steiner
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-06-14 00:00:00.000000000 Z
+date: 2022-11-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,56 +16,84 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2.3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.3'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.3'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.8'
+        version: '3.12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.8'
+        version: '3.12'
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.1'
+        version: 6.1.6.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.1'
+        version: 6.1.6.1
+- !ruby/object:Gem::Dependency
+  name: standard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.18'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.18'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.21'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.21'
 - !ruby/object:Gem::Dependency
   name: typhoeus
   requirement: !ruby/object:Gem::Requirement
@@ -87,9 +115,11 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/dependabot.yml"
+- ".github/workflows/cd.yml"
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - README.md
@@ -119,8 +149,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 3.3.7
 signing_key: 
 specification_version: 4
 summary: EH Single Sign On

data/.travis.yml

@@ -1,15 +0,0 @@
-language: ruby
-os:
-  - linux
-  - osx
-osx_image: xcode9.1
-rvm:
-  - 2.6.1
-  - 2.6.0
-  - 2.5.3
-  - 2.5.0
-  - 2.4.2
-  - 2.4.1
-  - 2.3.1
-before_install:
-  - gem install bundler --version '~> 2.0.1'