omniauth-hack_club 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0cbbbdc010e75678bda5162bc0223bf55a2384eaefcffc230b73f24125623ebd
+  data.tar.gz: f4d93e173317b81ad812f7591ef423265f1f2da61e85b8c36bf68fcf4a76a54d
+SHA512:
+  metadata.gz: bec4d86d1d031c177631ab120042f4dd5af837179fe3f5eedff76a52dd0e53550055f9cc3a07d073e8642be7cb9ef38bff80ded659d1b6bdb6fd763464a5d059
+  data.tar.gz: 7397d9351b503df2a694772359ab8a85dea68a52e53c50a6e55684a9625931601a31e52b6dbd35c03c8b9e504725e1dc92426d6c673c36849879fee833cb7689

data/CHANGELOG.md

@@ -0,0 +1,6 @@
+# Changelog
+
+## 1.0.0 (2024-12-15)
+
+- Initial release
+

data/LICENSE.md

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Hack Club
+
+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,93 @@
+# omniauth-hack_club
+
+An OmniAuth strategy for authenticating with [Hack Club Auth](https://auth.hackclub.com).
+
+## Installation
+
+Add to your Gemfile:
+
+```ruby
+gem "omniauth-hack_club"
+```
+
+Then run `bundle install`.
+
+## Usage
+
+1. Create an OAuth application at [auth.hackclub.com/developer/apps](https://auth.hackclub.com/developer/apps)
+2. Configure the strategy in your application:
+
+### Rails
+
+```ruby
+# config/initializers/omniauth.rb
+Rails.application.config.middleware.use OmniAuth::Builder do
+  provider :hack_club, ENV["HACKCLUB_CLIENT_ID"], ENV["HACKCLUB_CLIENT_SECRET"],
+    scope: "openid email name slack_id verification_status"
+end
+```
+
+### Sinatra
+
+```ruby
+use OmniAuth::Builder do
+  provider :hack_club, ENV["HACKCLUB_CLIENT_ID"], ENV["HACKCLUB_CLIENT_SECRET"],
+    scope: "openid email name slack_id verification_status"
+end
+```
+
+### Staging Environment
+
+To use the staging instance at `hca.dinosaurbbq.org`:
+
+```ruby
+provider :hack_club, ENV["HACKCLUB_CLIENT_ID"], ENV["HACKCLUB_CLIENT_SECRET"],
+  scope: "openid email name",
+  staging: true
+```
+
+## Available Scopes
+
+Community apps can request the following scopes:
+
+| Scope | Description |
+|-------|-------------|
+| `openid` | Enable OpenID Connect authentication |
+| `profile` | Name and profile information (OIDC) |
+| `email` | Access to email address |
+| `name` | Access to first and last name |
+| `slack_id` | Access to Slack ID |
+| `verification_status` | Verification status and YSWS eligibility |
+
+## Auth Hash
+
+The auth hash available in `request.env["omniauth.auth"]` will contain:
+
+```ruby
+{
+  provider: "hack_club",
+  uid: "ident!abc123",
+  info: {
+    email: "user@example.com",
+    name: "Ada Lovelace",
+    first_name: "Ada",
+    last_name: "Lovelace",
+    slack_id: "U12345678",
+    verification_status: "verified"
+  },
+  credentials: {
+    token: "idntk.skdfjlsdfjsldf",
+    expires_at: 1234567890,
+    expires: true
+  },
+  extra: {
+    raw_info: {
+      # Full response from /api/v1/me
+    }
+  }
+}
+```
+
+## License
+
+MIT License. See [LICENSE.md](LICENSE.md).

data/lib/omniauth/strategies/hack_club.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+require 'omniauth-oauth2'
+
+module OmniAuth
+  module Strategies
+    class HackClub < OmniAuth::Strategies::OAuth2
+      PRODUCTION_SITE = 'https://auth.hackclub.com'
+      STAGING_SITE = 'https://hca.dinosaurbbq.org'
+
+      option :name, 'hack_club'
+      option :staging, false
+      option :scope, 'email'
+
+      option :client_options, {
+        site: PRODUCTION_SITE,
+        authorize_url: '/oauth/authorize',
+        token_url: '/oauth/token'
+      }
+
+      option :authorize_options, %i[scope]
+
+      def client
+        options.client_options[:site] = options.staging ? STAGING_SITE : PRODUCTION_SITE
+        super
+      end
+
+      uid { identity['id'] }
+
+      info do
+        {
+          email: identity['primary_email'],
+          name: identity['name'],
+          first_name: identity['first_name'],
+          last_name: identity['last_name'],
+          slack_id: identity['slack_id'],
+          verification_status: identity['verification_status']
+        }.compact
+      end
+
+      extra do
+        {
+          raw_info: raw_info,
+          scopes: raw_info['scopes']
+        }
+      end
+
+      def raw_info
+        @raw_info ||= access_token.get('/api/v1/me').parsed
+      end
+
+      def identity
+        raw_info['identity'] || {}
+      end
+
+      def callback_url
+        full_host + callback_path
+      end
+    end
+  end
+end

data/lib/omniauth-hack_club/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module OmniAuth
+  module HackClub
+    VERSION = '1.0.1'
+  end
+end

data/lib/omniauth-hack_club.rb

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

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification
+name: omniauth-hack_club
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Nora
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: omniauth-oauth2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+description: An OmniAuth strategy for authenticating with Hack Club Auth using OAuth2.
+email:
+- auth@hackclub.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.md
+- README.md
+- lib/omniauth-hack_club.rb
+- lib/omniauth-hack_club/version.rb
+- lib/omniauth/strategies/hack_club.rb
+homepage: https://github.com/24c02/omniauth-hack_club
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/24c02/omniauth-hack_club
+  source_code_uri: https://github.com/24c02/omniauth-hack_club
+  changelog_uri: https://github.com/24c02/omniauth-hack_club/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+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.6.7
+specification_version: 4
+summary: OmniAuth strategy for Hack Club Auth
+test_files: []