omniauth-ibmid 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 40e1380c599d8e9836448319861572d8afa5a43db54d8b36109f47d40e014a89
+  data.tar.gz: 425535704cab737039715d7c8ac35d62c37f60f61be4b3e8d85b21da1bd571c1
+SHA512:
+  metadata.gz: be15d2f555a969bc0ec677599202077a86f75764c0b64cef5248d3c28a3547adceb4cba548e5dcb0ee6bf64b32dc0841c1b537a8a32c35557c534d755d344ceb
+  data.tar.gz: 9f0730b3a94dbe5cc1c1d5c3b2ad10a1f4dbba1cefd5c95c577cf690479f8e29acf8191999ba4937d4840b49e41cb41a9f78d5451f734476200d5beecdf2d9a3

data/.editorconfig

@@ -0,0 +1,12 @@
+# EditorConfig is awesome: https://EditorConfig.org
+
+# top-most EditorConfig file
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true

data/.github/workflows/validate.yml

@@ -0,0 +1,32 @@
+name: validate
+
+on:
+  pull_request:
+    branches:
+      - master
+
+jobs:
+  style:
+    name: code style
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 2.7
+          bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+      - run: bundle exec rbprettier --check .
+
+  test:
+    name: test
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby: ["2.4", "2.5", "2.6", "2.7"]
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+      - run: bundle exec rake

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+Gemfile.lock
+*.gem
+
+# rspec failure tracking
+.rspec_status

data/.prettierignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/pkg/
+/spec/reports/
+/tmp/
+/vendor/
+Gemfile.lock

data/.prettierrc.yml

@@ -0,0 +1 @@
+rubySingleQuote: false

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,5 @@
+inherit_gem:
+  prettier: rubocop.yml
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) International Business Machines Corporation
+
+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

@@ -0,0 +1,23 @@
+# OmniAuth IBMid
+
+This is the OmniAuth stragegy for authenticaing to IBMid
+
+## Installation
+
+Add to your `Gemfile`:
+
+```ruby
+gem "omniauth-ibmid"
+```
+
+## Usage
+
+```ruby
+use OmniAuth::Builder do
+  provider :ibmid, ENV["IBMID_OIDC_CLIENT_ID"], ENV["IBMID_OIDC_CLIENT_SECRET"]
+end
+```
+
+## License
+
+[MIT License](./LICENSE).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "omniauth-ibmid"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/examples/sinatra/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+gem "sinatra", ">= 2.0"
+gem "omniauth", ">= 2.0"
+gem "omniauth-ibmid", path: "../../"

data/examples/sinatra/app.rb

@@ -0,0 +1,38 @@
+begin
+  require "sinatra"
+  require "securerandom"
+  require "omniauth"
+  require "omniauth-ibmid"
+rescue LoadError
+  require "rubygems"
+  require "securerandom"
+  require "sinatra"
+  require "omniauth"
+  require "omniauth-ibmid"
+end
+
+set sessions: true
+set :session_secret, ENV.fetch("SESSION_SECRET") { SecureRandom.hex(64) }
+
+use Rack::Session::Cookie
+use OmniAuth::Builder do
+  provider :ibmid, ENV["IBMID_OIDC_CLIENT_ID"], ENV["IBMID_OIDC_CLIENT_SECRET"]
+end
+
+get "/" do
+  <<-HTML
+  <form method='post' action='/auth/ibmid'>
+    <input type="hidden" name="authenticity_token" value='#{request.env["rack.session"]["csrf"]}'>
+    <button type='submit'>Sign in with IBMid</button>
+  </form>
+  HTML
+end
+
+get "/auth/:name/callback" do
+  auth = request.env["omniauth.auth"]
+  <<-HTML
+  <h1>You are logged in as #{auth["info"]["email"]}</h1>
+  <div>OmniAuth::AuthHash::InfoHash</div>
+  <span>#{auth["info"].to_json}</span>
+  HTML
+end

data/lib/omniauth-ibmid.rb

@@ -0,0 +1,2 @@
+require "omniauth-ibmid/version"
+require "omniauth/strategies/ibmid"

data/lib/omniauth-ibmid/version.rb

@@ -0,0 +1,5 @@
+module OmniAuth
+  module Ibmid
+    VERSION = "1.0.0"
+  end
+end

data/lib/omniauth/strategies/ibmid.rb

@@ -0,0 +1,49 @@
+require "omniauth-oauth2"
+
+module OmniAuth
+  module Strategies
+    class Ibmid < OmniAuth::Strategies::OAuth2
+      DEFAULT_SCOPE = "openid".freeze
+
+      option :name, "ibmid"
+      option :client_options,
+             {
+               site: "https://login.ibm.com",
+               authorize_url:
+                 "https://login.ibm.com/oidc/endpoint/default/authorize",
+               token_url: "https://login.ibm.com/oidc/endpoint/default/token",
+               user_info_url:
+                 "https://login.ibm.com/oidc/endpoint/default/userinfo",
+               response_type: "id_token"
+             }
+      option :scope, DEFAULT_SCOPE
+      option :provider_ignores_state, true
+
+      uid { raw_info["uniqueSecurityName"] }
+
+      info do
+        {
+          name: "#{raw_info["given_name"]} #{raw_info["family_name"]}",
+          first_name: raw_info["given_name"],
+          last_name: raw_info["family_name"],
+          email: raw_info["email"]
+        }
+      end
+
+      extra { { "raw_info" => raw_info } }
+
+      def client_options
+        options.fetch(:client_options)
+      end
+
+      def raw_info
+        @raw_info ||=
+          access_token.get(client_options.fetch(:user_info_url)).parsed
+      end
+
+      def callback_url
+        full_host + script_name + callback_path
+      end
+    end
+  end
+end

data/omniauth-ibmid.gemspec

@@ -0,0 +1,41 @@
+require_relative "lib/omniauth-ibmid/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "omniauth-ibmid"
+  spec.version = OmniAuth::Ibmid::VERSION
+  spec.authors = ["Michael Lin"]
+  spec.email = ["mlzc@hey.com"]
+
+  spec.summary = "IBMid strategy for OmniAuth"
+  spec.description = "IBMid strategy for OmniAuth"
+  spec.homepage = "https://github.com/ibm/omniauth-ibmid"
+  spec.license = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] =
+    "https://github.com/ibm-skills-network/omniauth-ibmid"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files =
+    Dir.chdir(File.expand_path(__dir__)) do
+      `git ls-files -z`.split("\x0").reject do |f|
+        f.match(%r{^(test|spec|features)/})
+      end
+    end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "omniauth", [">= 1.9", "< 3"]
+  spec.add_dependency "omniauth-oauth2", ">= 1.4"
+
+  spec.add_development_dependency "bundler", ">= 2.0"
+  spec.add_development_dependency "prettier", ">= 1.5.5"
+  spec.add_development_dependency "rack-test"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", ">= 3.0"
+  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "webmock"
+end

metadata

@@ -0,0 +1,196 @@
+--- !ruby/object:Gem::Specification
+name: omniauth-ibmid
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Michael Lin
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-04-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: omniauth
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.9'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.9'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: omniauth-oauth2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: prettier
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.5.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.5.5
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  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'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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'
+- !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: IBMid strategy for OmniAuth
+email:
+- mlzc@hey.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".editorconfig"
+- ".github/workflows/validate.yml"
+- ".gitignore"
+- ".prettierignore"
+- ".prettierrc.yml"
+- ".rspec"
+- ".rubocop.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- examples/sinatra/Gemfile
+- examples/sinatra/app.rb
+- lib/omniauth-ibmid.rb
+- lib/omniauth-ibmid/version.rb
+- lib/omniauth/strategies/ibmid.rb
+- omniauth-ibmid.gemspec
+homepage: https://github.com/ibm/omniauth-ibmid
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/ibm/omniauth-ibmid
+  source_code_uri: https://github.com/ibm-skills-network/omniauth-ibmid
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: IBMid strategy for OmniAuth
+test_files: []