omniauth-web3id 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ce2c648ad78e065bd5be10922b1fa290ee14f696e9e125268bc303c3913cf710
+  data.tar.gz: 97a727a5b97740a41992c12e2a985510b6691a11c5e9c8c24aa93b1c18cfeb29
+SHA512:
+  metadata.gz: fcc06f54cbfaac73a6cb9779e3929ae7e9c405b23ef4332fab29da493d5f4785a053c79c2be2eeb4a49f25ed70e3376917f35b222e395353c04fcec1f23b92af
+  data.tar.gz: c5dd9628289bcf766aa956a01a8968ef60dbc62c959cb313c91d0cf74907a71c030c6477d9e314c2c6f8c4ae6a836098ff51c90ae27d9082fe8aaaa040924c51

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,17 @@
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 2.6
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120
+
+Metrics/BlockLength:
+  Max: 150

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2022-07-30
+
+- Initial release

data/Gemfile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in omniauth-web3id.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+
+gem "rubocop", "~> 1.21"
+gem "rubocop-rake"
+gem "rubocop-rspec"

data/Gemfile.lock

@@ -0,0 +1,101 @@
+PATH
+  remote: .
+  specs:
+    omniauth-web3id (0.1.0)
+      omniauth
+      omniauth-oauth2
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    coderay (1.1.3)
+    diff-lcs (1.5.0)
+    faraday (2.4.0)
+      faraday-net_http (~> 2.0)
+      ruby2_keywords (>= 0.0.4)
+    faraday-net_http (2.1.0)
+    hashie (5.0.0)
+    json (2.6.2)
+    jwt (2.4.1)
+    method_source (1.0.0)
+    multi_xml (0.6.0)
+    oauth2 (2.0.6)
+      faraday (>= 0.17.3, < 3.0)
+      jwt (>= 1.0, < 3.0)
+      multi_xml (~> 0.5)
+      rack (>= 1.2, < 3)
+      rash_alt (>= 0.4, < 1)
+      version_gem (~> 1.1)
+    omniauth (2.1.0)
+      hashie (>= 3.4.6)
+      rack (>= 2.2.3)
+      rack-protection
+    omniauth-oauth2 (1.8.0)
+      oauth2 (>= 1.4, < 3)
+      omniauth (~> 2.0)
+    parallel (1.22.1)
+    parser (3.1.2.0)
+      ast (~> 2.4.1)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rack (2.2.4)
+    rack-protection (2.2.2)
+      rack
+    rainbow (3.1.1)
+    rake (13.0.6)
+    rash_alt (0.4.12)
+      hashie (>= 3.4)
+    regexp_parser (2.5.0)
+    rexml (3.2.5)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
+    rubocop (1.32.0)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.1.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.19.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.19.1)
+      parser (>= 3.1.1.0)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
+    rubocop-rspec (2.12.1)
+      rubocop (~> 1.31)
+    ruby-progressbar (1.11.0)
+    ruby2_keywords (0.0.5)
+    unicode-display_width (2.2.0)
+    version_gem (1.1.0)
+
+PLATFORMS
+  arm64-darwin-21
+  x86_64-linux
+
+DEPENDENCIES
+  bundler (>= 1.6)
+  omniauth-web3id!
+  pry (>= 0.10.3)
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop (~> 1.21)
+  rubocop-rake
+  rubocop-rspec
+
+BUNDLED WITH
+   2.3.7

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Robin Bortlik
+
+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,49 @@
+# OmniAuth::Web3ID
+
+Web3ID OAuth2 Strategy for OmniAuth.
+
+### What is web3id?
+
+- please refer to [official website](https://www.dock.io/web3id)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'omniauth-web3id'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install omniauth-web3id
+
+## Usage
+
+- Generate your `key/secret` by following [oauth2 setup instructions](https://github.com/docknetwork/auth-server/blob/master/docs/oauth2_setup.md).
+
+- Add omniauth builder middleware to your ruby app
+
+```ruby
+Rails.application.config.middleware.use OmniAuth::Builder do
+  provider :web3id, ENV['WEB3ID_KEY'], ENV['WEB3ID_SECRET']
+end
+```
+
+## Devise integration
+
+- Please refer to [example rails application](https://github.com/robinbortlik/web3id-rails)
+
+## Showcase
+
+
+https://user-images.githubusercontent.com/228502/184993116-945f2cb3-70d3-4902-b7ac-81c23e5892ac.mov
+
+
+## Final note
+
+This gem was heavily inspired by [omniauth-microsoft-office365](https://github.com/murbanski/omniauth-microsoft-office365) gem. Thank you guys for your hard work.

data/Rakefile

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

data/lib/omniauth/strategies/web3id.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require "omniauth-oauth2"
+
+module OmniAuth
+  module Strategies
+    # Web3ID authentication strategy.
+    class Web3ID < OmniAuth::Strategies::OAuth2
+      option :name, :web3id
+
+      DEFAULT_SCOPE = "public email"
+
+      option :client_options, {
+        site: "https://auth.dock.io",
+        authorize_url: "/oauth2/authorize?response_type=code",
+        token_url: "/oauth2/token",
+        profile_url: "/oauth2/userinfo"
+      }
+      option :authorize_params, { grant_type: "authorization_code", scope: DEFAULT_SCOPE }
+      option :authorize_options, %w[scope]
+      option :provider_ignores_state, true
+
+      uid { raw_info_did }
+
+      info do
+        {
+          did: raw_info_did,
+          email: raw_info["email"],
+          name: raw_info["name"]
+        }
+      end
+
+      extra do
+        {
+          "raw_info" => raw_info
+        }
+      end
+
+      def raw_info_did
+        raw_info["id"] || raw_info["user_id"]
+      end
+
+      def raw_info
+        @raw_info ||= access_token.get(client.options[:profile_url]).parsed
+      end
+
+      def callback_url
+        options[:redirect_uri] || (full_host + script_name + callback_path)
+      end
+    end
+  end
+end

data/lib/omniauth/web3id/version.rb

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

data/lib/omniauth/web3id.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require_relative "web3id/version"
+require_relative "strategies/web3id"

data/omniauth-web3id.gemspec

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require_relative "lib/omniauth/web3id/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "omniauth-web3id"
+  spec.version = OmniAuth::Web3ID::VERSION
+  spec.authors = ["Robin Bortlik"]
+  spec.email = ["robinbortlik@gmail.com"]
+
+  spec.summary = "OmniAuth extension for WEB3ID authentication"
+  spec.homepage = "https://github.com/robinbortlik/OmniAuth-web3id"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org/"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/robinbortlik/omniauth-web3id"
+  spec.metadata["changelog_uri"] = "https://github.com/robinbortlik/omniauth-web3id/CHANGELOG.md"
+
+  # 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 == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "omniauth"
+  spec.add_runtime_dependency "omniauth-oauth2"
+
+  spec.add_development_dependency "bundler", ">= 1.6"
+  spec.add_development_dependency "pry", ">= 0.10.3"
+  spec.add_development_dependency "rake", ">= 11.1.2"
+  spec.add_development_dependency "rspec", ">= 3.4.0"
+  spec.metadata["rubygems_mfa_required"] = "true"
+end

data/sig/omniauth/web3id.rbs

@@ -0,0 +1,6 @@
+module OmniAuth
+  module Web3ID
+    VERSION: String
+    # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+  end
+end

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification
+name: omniauth-web3id
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Robin Bortlik
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-08-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: omniauth
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: omniauth-oauth2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.10.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.10.3
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 11.1.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 11.1.2
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.4.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.4.0
+description:
+email:
+- robinbortlik@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/omniauth/strategies/web3id.rb
+- lib/omniauth/web3id.rb
+- lib/omniauth/web3id/version.rb
+- omniauth-web3id.gemspec
+- sig/omniauth/web3id.rbs
+homepage: https://github.com/robinbortlik/OmniAuth-web3id
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org/
+  homepage_uri: https://github.com/robinbortlik/OmniAuth-web3id
+  source_code_uri: https://github.com/robinbortlik/omniauth-web3id
+  changelog_uri: https://github.com/robinbortlik/omniauth-web3id/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.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: OmniAuth extension for WEB3ID authentication
+test_files: []