feature/ github oauth integration #561

rsmithlal · 2024-06-11T23:02:35Z

Summary of Changes

This pull request adds GitHub OAuth Integration to the Community Engine, enabling users to sign in using their GitHub accounts. It also introduces a new PersonPlatformIntegration model to track external platform connections (starting with GitHub), along with supporting views, controllers, and tests.

Key Changes

1. OAuth Support for GitHub Sign-In

Added omniauth, omniauth-github, and omniauth-rails_csrf_protection gems.
Configured Devise to support omniauthable with GitHub as a provider.
Implemented a custom OmniauthCallbacksController to handle GitHub authentication flow.

2. New PersonPlatformIntegration Model

Tracks the link between a Person and external platforms like GitHub.
Stores provider details (e.g., uid, access_token, profile_url).
Supports token refresh and re-authentication when required.

3. GitHub API Client

Added a BetterTogether::Github class for interacting with GitHub’s API using app installation tokens.
This prepares the foundation for future GitHub-powered features (like repository management or commits tracking).

4. New CRUD Interface for Managing Integrations

Admin views to list, view, edit, and delete platform integrations.
Fully scaffolded PersonPlatformIntegrationsController with views.
Supports direct management via web UI.

5. Updated User Model

User is now omniauthable, with a has_many :person_platform_integrations association.
Adds logic to map an OAuth auth hash into a user account, including automatic person creation if needed.

6. Migration and Database Changes

New better_together_person_platform_integrations table.
Supports storing token data, provider metadata, and raw auth hashes for auditing.

7. Gem and Dependency Updates

Added required gems to the gemspec and Gemfile.
Bumped redis, rubocop, and aws-sdk versions as part of routine updates.

Affected Files

37 files changed
854 additions, 27 deletions
New files include controllers, models, views, helpers, factories, specs, and migrations for the new integration system.

Why These Changes?

This is part of ongoing work to improve developer experience and make it easier for contributors to link their Community Engine accounts to external platforms. The GitHub integration lays the groundwork for:

Linking contributions (like commits and issues) to platform users.
Supporting future features such as GitHub-backed content imports, repository links, and contribution tracking.
Enabling flexible future authentication via additional OAuth providers (Google, Facebook, LinkedIn).

Testing

Basic feature specs added for the PersonPlatformIntegrationsController.
Manual flow tested locally: GitHub login, linking existing accounts, creating new accounts, and managing linked platforms.
Integration works with Devise confirmation, ensuring new users must confirm their email after signing up via GitHub.

Migration Required

✅ Run bin/rails db:migrate to apply the new better_together_person_platform_integrations table.

app/controllers/better_together/omniauth_callbacks_controller.rb

use BetterTogether controller

app/controllers/better_together/omniauth_callbacks_controller.rb

Prevent visibility of the feature before it's ready

app/controllers/better_together/omniauth_callbacks_controller.rb

Allows for linking OAuth authorizations to Person and Platform records

app/controllers/better_together/omniauth_callbacks_controller.rb

Signed-off-by: Robert Smith <[email protected]>

Copilot

Pull Request Overview

This PR integrates GitHub OAuth into Community Engine and scaffolds new CRUD interfaces and tests for PersonPlatformIntegration and Seed models.

Adds empty view specs for seeds and authorizations to improve test coverage.
Introduces PersonPlatformIntegrationController with matching views and routes.
Implements model logic in PersonPlatformIntegration for handling tokens, but contains a minor bug.
Updates helper documentation and corrects a small typo.

Reviewed Changes

Copilot reviewed 82 out of 86 changed files in this pull request and generated no comments.

Show a summary per file

File	Description
spec/views/better_together/seeds/show.html.erb_spec.rb	Empty test stub—needs render and assertions
spec/views/better_together/person_platform_integrations/show.html.erb_spec.rb	Empty test stub—needs render and assertions
app/controllers/better_together/person_platform_integrations_controller.rb	Incorrect instance variable used in `create` action
app/models/better_together/person_platform_integration.rb	Class method references undefined variable in `attributes_from_omniauth`
app/helpers/better_together/person_platform_integrations_helper.rb	Spelling typo in module documentation

Comments suppressed due to low confidence (11)

spec/views/better_together/seeds/show.html.erb_spec.rb:11

Implement the render call and add expectations (e.g., expect(rendered).to match(...)) so this view spec actually verifies the output.

    # render

spec/views/better_together/seeds/new.html.erb_spec.rb:11

Uncomment and use render plus assert_select assertions to verify the form elements are present.

    # render

spec/views/better_together/seeds/index.html.erb_spec.rb:14

Add render and assertions (e.g., assert_select) to verify each seed is rendered in the list.

    # render

spec/views/better_together/seeds/edit.html.erb_spec.rb:15

Use render and assert_select to confirm the edit form targets the correct path and fields.

    # render

spec/views/better_together/person_platform_integrations/show.html.erb_spec.rb:11

Call render and then assert that the key attributes (provider, uid, etc.) actually appear in the output.

    # render

spec/views/better_together/person_platform_integrations/new.html.erb_spec.rb:11

Uncomment and implement the assert_select blocks after render to validate the new integration form fields.

    # render

spec/views/better_together/person_platform_integrations/index.html.erb_spec.rb:11

Add a render call and use assert_select to check that each integration is displayed correctly.

    # render

spec/views/better_together/person_platform_integrations/edit.html.erb_spec.rb:15

Include render and assert_select to ensure the edit form is rendered with correct action and input fields.

    # render

app/controllers/better_together/person_platform_integrations_controller.rb:27

The create action initializes @better_together_person_platform_integration but then calls @person_platform_integration.save. Rename the variable or call @better_together_person_platform_integration.save to avoid nil errors.

      @better_together_person_platform_integration = BetterTogether::PersonPlatformIntegration.new(person_platform_integration_params)

app/models/better_together/person_platform_integration.rb:82

attributes_from_omniauth is a class method and references person_platform_integration, which is undefined. Replace this check with if auth.persisted? or move it into an instance context.

      attributes[:profile_url] = auth.info.urls.first.last unless person_platform_integration.persisted?

app/helpers/better_together/person_platform_integrations_helper.rb:4

Fix typo: change conains to contains.

  # This module conains helper methods for PersonPLatformIntegrations

Signed-off-by: Robert Smith <[email protected]>

rsmithlal · 2025-08-07T15:31:35Z

app/assets/stylesheets/better_together/theme.scss

This needs to be removed

rsmithlal

needs a lot of cleanup to remove the commits from the other feature branches

rsmithlal · 2025-08-07T15:32:36Z

app/controllers/better_together/pages_controller.rb

  class PagesController < FriendlyResourceController # rubocop:todo Metrics/ClassLength
    before_action :set_page, only: %i[show edit update destroy]

+    skip_before_action :check_platform_setup, unless: -> { ::BetterTogether::Platform.where(host: true).any? }


Update check to use host scope instead of where query

rsmithlal · 2025-08-07T15:33:29Z

app/controllers/better_together/seeds_controller.rb

This needs to be removed or moved to seed branch

rsmithlal · 2025-08-07T15:33:46Z

app/helpers/better_together/form_helper.rb

    def locale_options_for_select(selected_locale = I18n.locale)
      options_for_select(
-        I18n.available_locales.map { |locale| [I18n.t("locales.#{locale}", locale:), locale] },
+        I18n.available_locales.map { |locale| [I18n.t("better_together.languages.#{locale}", locale:), locale] },


Check this key

rsmithlal · 2025-08-07T15:33:56Z

app/helpers/better_together/seeds_helper.rb

remove this

rsmithlal · 2025-08-07T15:34:11Z

app/helpers/better_together/translatable_fields_helper.rb

check these keys

rsmithlal · 2025-08-07T15:43:30Z

spec/views/better_together/seeds/index.html.erb_spec.rb

remove and/or move to seeds branch

rsmithlal · 2025-08-07T15:43:39Z

spec/views/better_together/seeds/new.html.erb_spec.rb

remove and/or move to seeds branch

rsmithlal · 2025-08-07T15:43:45Z

spec/views/better_together/seeds/show.html.erb_spec.rb

remove and/or move to seeds branch

rsmithlal · 2025-08-07T15:44:02Z

better_together.gemspec

  spec.add_dependency 'activerecord-postgis-adapter'
  spec.add_dependency 'active_storage_svg_sanitizer'
  spec.add_dependency 'active_storage_validations'
+  spec.add_dependency 'acts_as_tenant'


remove this change

rsmithlal · 2025-08-07T15:44:12Z

Gemfile.lock

      active_storage_validations
      activerecord-import
      activerecord-postgis-adapter
+      acts_as_tenant


app/controllers/better_together/seeds_controller.rb

+    # PATCH/PUT /seeds/1
+    def update
+      if @seed.update(seed_params)
+        redirect_to @seed, notice: 'Seed was successfully updated.', status: :see_other


app/views/better_together/person_platform_integrations/show.html.erb

@@ -0,0 +1,10 @@
+<p style="color: green"><%= notice %></p>
+
+<%= render @person_platform_integration %>


app/views/better_together/seeds/show.html.erb

@@ -0,0 +1,10 @@
+<p style="color: green"><%= notice %></p>
+
+<%= render @seed %>


WIP: test devise github oauth integration

d4828f5

rsmithlal self-assigned this Jun 11, 2024

rsmithlal added the enhancement New feature or request label Jun 11, 2024

github-advanced-security bot found potential problems Jun 11, 2024

View reviewed changes

app/controllers/better_together/omniauth_callbacks_controller.rb Fixed Show fixed Hide fixed

rsmithlal added 3 commits June 11, 2024 20:39

Update omniauth routes

7cc86e2

use BetterTogether controller

update github oauth action

fb4885b

WIP: github oauth

68ea4bf

github-advanced-security bot found potential problems Jun 12, 2024

View reviewed changes

app/controllers/better_together/omniauth_callbacks_controller.rb Fixed Show fixed Hide fixed

WIP: github oauth use correct user class reference

72a0030

github-advanced-security bot found potential problems Jun 12, 2024

View reviewed changes

app/controllers/better_together/omniauth_callbacks_controller.rb Fixed Show fixed Hide fixed

rsmithlal added 5 commits June 11, 2024 22:09

WIP: github oauth use correct user method to process auth env data

a1a9b0a

Only show oauth login links if param oauth_login=true

042249f

Prevent visibility of the feature before it's ready

adjustment for frozen arrays

b7f8af6

WIP: initial foundation to integrate GitHub API using Octokit gem

ed709f5

rubocop fixes

8f2f392

github-advanced-security bot found potential problems Jun 12, 2024

View reviewed changes

app/controllers/better_together/omniauth_callbacks_controller.rb Fixed Show fixed Hide fixed

rsmithlal added 4 commits June 12, 2024 09:54

WIP: Initial scaffolding of PersonPlatformIntegrations

163baea

Allows for linking OAuth authorizations to Person and Platform records

WIP: Flesh out PersonPlatformIntegration

56253fe

rubocop fixes

d0afb15

rubocop fixes

1ec7f73

github-advanced-security bot found potential problems Jun 12, 2024

View reviewed changes

app/controllers/better_together/omniauth_callbacks_controller.rb Fixed Show fixed Hide fixed

rsmithlal added 4 commits June 16, 2024 18:45

WIP: attempt to correctly sign_in the user after oauth

8bc4afa

Rubocop fixes

3bdbd69

Merge branch 'main' into feature/github-integration

72272b1

Signed-off-by: Robert Smith <[email protected]>

Merge branch 'main' into feature/github-integration

ba905b6

Signed-off-by: Robert Smith <[email protected]>

rsmithlal changed the base branch from main to dev March 1, 2025 04:47

Update Gemfile.lock

e9caf22

rsmithlal changed the base branch from dev to main March 1, 2025 14:43

rsmithlal added 2 commits March 1, 2025 11:15

Improved references to ::BetterTogether modules

4292d62

Improved success rate for generating page view urls

d2f638c

Add custom seed data config for BetterTogether::Wizard

b7c0c68

rsmithlal changed the title ~~WIP: test devise github oauth integration~~ feature/ github oauth integration Mar 7, 2025

Merge branch 'dev' into feature/github-integration

8ac0493

Signed-off-by: Robert Smith <[email protected]>

rsmithlal force-pushed the dev branch from b7c0c68 to d50870a Compare March 7, 2025 17:33

Merge branch 'dev' into feature/github-integration

eb7d6f9

Signed-off-by: Robert Smith <[email protected]>

rsmithlal changed the base branch from dev to main June 28, 2025 12:07

rsmithlal added 2 commits June 28, 2025 09:48

Merge branch 'main' into feature/github-integration

b7ef209

Signed-off-by: Robert Smith <[email protected]>

Merge branch 'main' into feature/github-integration

61181ef

rsmithlal requested a review from Copilot July 5, 2025 15:55

Copilot AI reviewed Jul 5, 2025

View reviewed changes

Merge branch 'main' into feature/github-integration

6a7b670

Signed-off-by: Robert Smith <[email protected]>

rsmithlal temporarily deployed to test August 7, 2025 15:30 — with GitHub Actions Inactive

rsmithlal had a problem deploying to test August 7, 2025 15:30 — with GitHub Actions Failure

rsmithlal commented Aug 7, 2025

View reviewed changes

app/assets/stylesheets/better_together/theme.scss

Copy link

Member Author

rsmithlal Aug 7, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This needs to be removed

rsmithlal commented Aug 7, 2025

View reviewed changes

rsmithlal added 2 commits August 23, 2025 21:50

Merge branch 'main' into feature/github-integration

6bdb807

Rubocop fixes

e623c52

rsmithlal temporarily deployed to test August 24, 2025 00:26 — with GitHub Actions Inactive

rsmithlal had a problem deploying to test August 24, 2025 00:26 — with GitHub Actions Failure

Rubocop fixes

0e1d92a

github-advanced-security bot found potential problems Aug 24, 2025

View reviewed changes

Rubocop fixes

10d44f0

rsmithlal temporarily deployed to test August 24, 2025 00:30 — with GitHub Actions Inactive

rsmithlal had a problem deploying to test August 24, 2025 00:30 — with GitHub Actions Failure

Refactor destroy? method placement in PersonBlockPolicy

81bd298

rsmithlal had a problem deploying to test August 24, 2025 18:47 — with GitHub Actions Failure

rsmithlal temporarily deployed to test August 24, 2025 18:47 — with GitHub Actions Inactive

		@@ -0,0 +1,10 @@
		<p style="color: green"><%= notice %></p>

		<%= render @person_platform_integration %>

		@@ -0,0 +1,10 @@
		<p style="color: green"><%= notice %></p>

		<%= render @seed %>

feature/ github oauth integration #561

Are you sure you want to change the base?

feature/ github oauth integration #561

Uh oh!

Conversation

rsmithlal commented Jun 11, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary of Changes

Key Changes

1. OAuth Support for GitHub Sign-In

2. New PersonPlatformIntegration Model

3. GitHub API Client

4. New CRUD Interface for Managing Integrations

5. Updated User Model

6. Migration and Database Changes

7. Gem and Dependency Updates

Affected Files

Why These Changes?

Testing

Migration Required

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Choose a reason for hiding this comment

Uh oh!

rsmithlal left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Check notice

Check notice

Check notice

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

rsmithlal commented Jun 11, 2024 •

edited

Loading