omniauth-nitro-id 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d4d3e8c274665be7c83f34c25dbf04aa079f54192cbd30a59ef4b6243020d33d
+  data.tar.gz: 964db9c5a01dd33f16cc8491b9aeaac22dd980fd09d25ee737953824b2fbcc21
+SHA512:
+  metadata.gz: b16e8610dd2aeea20d1cdbe80088d7fd95898863987ccab37d2ffaa4efbdc59c21d9443e4e341b3c58a58d55bf19e33160b1c072e54f766250d114d5fda60794
+  data.tar.gz: 25a285b3e002a2dcbc096cc7c9c9ecfc45fdc6ef59c06acf923705676c06320f390dc8c82f0780b4b3b700bf23d3878fc866e9b610644901501f287f12783e2f

data/.github/CODEOWNERS

@@ -0,0 +1 @@
+* @powerhome/s-h-i-e-l-d

data/.github/workflows/ci.yml

@@ -0,0 +1,34 @@
+name: CI
+
+on: push
+
+jobs:
+  test:
+    name: Tests
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby:
+          - "2.7.4"
+          - "3.1.2"
+    steps:
+    - uses: actions/checkout@v3
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        bundler-cache: true
+    - name: Run tests
+      run: bundle exec rake spec
+  lint:
+    name: Lint Ruby
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 3.1.2
+    - name: Bundle
+      run: bundle
+    - name: Run Rubocop
+      run: bundle exec rubocop

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.DS_store
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/examples.txt
+/spec/reports/
+/tmp/
+.bundle

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,11 @@
+require:
+  - rubocop-powerhome
+
+Rails:
+  Enabled: false
+
+Gemspec/RequireMFA:
+  Enabled: false
+
+Naming/FileName:
+  Enabled: false

data/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gemspec

data/Guardfile

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+guard "rspec" do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
+  watch("spec/spec_helper.rb")  { "spec" }
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+
+The MIT License (MIT)
+
+Copyright Power Home Remodeling Group, LLC
+
+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/Rakefile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rubocop/rake_task"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new(:rubocop)
+
+task default: %i[spec rubocop]

data/bin/console

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "omniauth-nitro-id"
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install

data/docs/README.md

@@ -0,0 +1,34 @@
+# omniauth-nitro-id
+
+OmniAuth strategy for NitroID. To use it, you will need an OAuth2 Client ID and Secret. For more information, see the [NitroID user guide.](https://github.com/powerhome/nitro-id/blob/main/docs/user-guide.md)
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'omniauth-nitro-id'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install omniauth-nitro-id
+
+## Supported Ruby Versions
+
+`omniauth-nitro-id` supports 2.7.4 and 3.1.2
+
+## Usage
+
+Example configuration
+```ruby
+config.omniauth :nitro_id, {
+  client_options: {
+      identifier: "CLIENT_ID",
+      secret: "SECRET",
+  }
+}
+```
+
+Check out Power's [example Rails app](https://github.com/powerhome/example-rails-app) for details on how to use this gem with Devise.

data/lib/omniauth/nitro_id/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module OmniAuth
+  module NitroId
+    VERSION = "0.1.1"
+  end
+end

data/lib/omniauth/nitro_id.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require "omniauth/nitro_id/version"
+require "omniauth/strategies/nitro_id"

data/lib/omniauth/strategies/nitro_id.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require "omniauth_openid_connect"
+
+module OmniAuth
+  module Strategies
+    class NitroId < OmniAuth::Strategies::OpenIDConnect
+      DEFAULT_STRATEGY_NAME = "nitro_id"
+      DEFAULT_ISSUER = "https://id.powerhrg.com/"
+      DEFAULT_HOST = "id.powerhrg.com"
+
+      option :name, DEFAULT_STRATEGY_NAME
+      option :discovery, true
+      option :issuer, DEFAULT_ISSUER
+      option :client_options, host: DEFAULT_HOST
+    end
+  end
+end

data/lib/omniauth-nitro-id.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require "omniauth/nitro_id"

data/mkdocs.yml

@@ -0,0 +1,6 @@
+site_name: OmniAuth NitroID
+site_description: OmniAuth NitroID Documentation
+nav:
+  - "Home": "README.md"
+plugins:
+  - techdocs-core

data/omniauth-nitro-id.gemspec

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require File.expand_path("lib/omniauth/nitro_id/version", __dir__)
+
+Gem::Specification.new do |spec|
+  spec.name          = "omniauth-nitro-id"
+  spec.version       = OmniAuth::NitroId::VERSION
+  spec.authors       = ["Stephen Greer"]
+  spec.email         = ["stephen.greer@powerhrg.com"]
+  spec.summary       = "NitroID Strategy for OmniAuth."
+  spec.description   = "NitroID Strategy for OmniAuth."
+  spec.homepage      = "https://github.com/powerhome/omniauth-nitro-id"
+  spec.license       = "MIT"
+  spec.required_ruby_version = ">= 2.7.0"
+
+  spec.files         = `git ls-files`.split("\n")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "omniauth_openid_connect", "~> 0.4.0"
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "guard-rspec"
+  spec.add_development_dependency "net-smtp"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "rake", "13.0.6"
+  spec.add_development_dependency "rspec", "3.11.0"
+  spec.add_development_dependency "rubocop", "1.31.1"
+  spec.add_development_dependency "rubocop-powerhome", ">= 0.4.1"
+end

data/portal.yml

@@ -0,0 +1,12 @@
+apiVersion: backstage.io/v1alpha1
+kind: Component
+metadata:
+  name: omniauth-nitro-id
+  title: OmniAuth NitroID
+  description: NitroID OmniAuth Strategy
+  annotations:
+    backstage.io/techdocs-ref: dir:.
+spec:
+  type: library
+  owner: shield
+  lifecycle: production

data/renovate.json

@@ -0,0 +1,8 @@
+{
+  "extends": ["config:base", "group:allNonMajor"],
+  "lockFileMaintenance": {
+    "enabled": true
+  },
+  "labels": ["dependencies"],
+  "timezone": "America/New_York"
+}

data/spec/omniauth/strategies/nitro_id_spec.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+describe OmniAuth::Strategies::NitroId do
+  let(:access_token) { instance_double("AccessToken", :options => {}, :[] => "user") }
+  let(:custom_client) do
+    OmniAuth::Strategies::NitroId.new(:test_app,
+                                      issuer: "https://example-host.com/",
+                                      discovery: false,
+                                      client_options: {
+                                        host: "example-host.com",
+                                      })
+  end
+
+  subject do
+    OmniAuth::Strategies::NitroId.new({})
+  end
+
+  before(:each) do
+    allow(subject).to receive(:access_token).and_return(access_token)
+  end
+
+  context "options" do
+    it "should have correct name" do
+      expect(subject.options.name).to eq "nitro_id"
+    end
+
+    it "should have correct host" do
+      expect(subject.options.client_options.host).to eq "id.powerhrg.com"
+    end
+
+    it "should have correct issuer" do
+      expect(subject.options.issuer).to eq "https://id.powerhrg.com/"
+    end
+
+    it "should have the correct discovery setting" do
+      expect(subject.options.discovery).to eq true
+    end
+
+    describe "should be overrideable" do
+      it "for host" do
+        expect(custom_client.options.client_options.host).to eq "example-host.com"
+      end
+
+      it "for issuer" do
+        expect(custom_client.options.issuer).to eq "https://example-host.com/"
+      end
+
+      it "for discovery" do
+        expect(custom_client.options.discovery).to eq false
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require "rspec"
+require "omniauth"
+require "omniauth-nitro-id"
+
+RSpec.configure do |config|
+  config.extend OmniAuth::Test::StrategyMacros, type: :strategy
+end

metadata

@@ -0,0 +1,193 @@
+--- !ruby/object:Gem::Specification
+name: omniauth-nitro-id
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Stephen Greer
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-07-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: omniauth_openid_connect
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: guard-rspec
+  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: net-smtp
+  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: pry
+  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: 13.0.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 13.0.6
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.11.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.11.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.31.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.31.1
+- !ruby/object:Gem::Dependency
+  name: rubocop-powerhome
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.4.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.4.1
+description: NitroID Strategy for OmniAuth.
+email:
+- stephen.greer@powerhrg.com
+executables:
+- console
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/CODEOWNERS"
+- ".github/workflows/ci.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- Rakefile
+- bin/console
+- bin/setup
+- docs/README.md
+- lib/omniauth-nitro-id.rb
+- lib/omniauth/nitro_id.rb
+- lib/omniauth/nitro_id/version.rb
+- lib/omniauth/strategies/nitro_id.rb
+- mkdocs.yml
+- omniauth-nitro-id.gemspec
+- portal.yml
+- renovate.json
+- spec/omniauth/strategies/nitro_id_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/powerhome/omniauth-nitro-id
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: NitroID Strategy for OmniAuth.
+test_files: []