bullet_train-integrations 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 16735ab9ebdc283b4d51ce3c48e3f9d8e4bdc1a948830a169d219dc5ceae43ad
+  data.tar.gz: 05ea064e531b662ca8bfc40ebd3666c587cc0c72a3760a1f26fd0132c27739e2
+SHA512:
+  metadata.gz: 6e096a839a8c54573c3f9b55af8cea1416a7691eeb71547f2c4432297e1e6c7b6212f2c0889de41c67c804eb433b511c38cd809f522a37363b16b6ba8238d0d2
+  data.tar.gz: bfe3ad11d10c9ae465f95568fbe0e6e0ca505bd84dd9065c50402dba7942e0894e1cc44f5e7df8154aaec9fcdd6b80b68923a9322759dcdde282eca6cdd93b4a

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2022 Andrew Culver
+
+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,28 @@
+# BulletTrain::Integrations
+Short description and motivation.
+
+## Usage
+How to use my plugin.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem "bullet_train-integrations"
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install bullet_train-integrations
+```
+
+## Contributing
+Contribution directions go here.
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/setup"
+
+APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
+load "rails/tasks/engine.rake"
+
+load "rails/tasks/statistics.rake"
+
+require "bundler/gem_tasks"

data/app/controllers/concerns/account/oauth/omniauth_callbacks/controller_base.rb

@@ -0,0 +1,152 @@
+module Account::Oauth::OmniauthCallbacks::ControllerBase
+  extend ActiveSupport::Concern
+
+  def team_id_from_env
+    request.env.dig("omniauth.params", "team_id")&.to_i
+  end
+
+  def failure
+    flash[:danger] = "Failed to sign in"
+    redirect_to root_path
+  end
+
+  def callback(class_name, team_id)
+    oauth_account_class = "Oauth::#{class_name}Account".constantize
+    # oauth_accounts_collection = "oauth_#{class_name.underscore}_accounts".to_sym
+    oauth_accounts_attribute = "oauth_#{class_name.underscore}_account".to_sym
+    integrations_installations_class = "::Integrations::#{class_name}Installation".constantize
+    integrations_installations_collection = "integrations_#{class_name.underscore}_installations".to_sym
+
+    auth = request.env["omniauth.auth"]
+
+    # if the user didn't click "authorize" on the providers confirmation page, just show them an error.
+    if params[:denied]
+      message = t("omniauth.team.denied", provider: t(auth.provider))
+
+      # redirect them to either the integrations page or the registration page.
+      path = if team_id
+        [:account, team, integrations_installations_collection]
+      elsif current_user
+        [:account, current_user]
+      else
+        new_user_registration_path
+      end
+
+      redirect_to path, notice: message
+    end
+
+    # first, keep a record of the oauth account.
+    # this belongs to the system, and sometimes becomes associated with a user.
+    begin
+      oauth_account = oauth_account_class.find_or_create_by(uid: auth.uid)
+      oauth_account.update_from_oauth(auth)
+    rescue PG::UniqueViolation
+      retry
+    end
+
+    # if they're trying to use this account to add an integration to a team.
+    if team_id
+
+      # they must be signed in.
+      authenticate_user!
+
+      unless (team = current_user.teams.find_by(id: team_id))
+        raise "user is adding an integration to a team they don't belong to?"
+      end
+
+      # now we check whether they're able to install new integrations for this team.
+      if can? :create, integrations_installations_class.new(:team => team, oauth_accounts_attribute => oauth_account)
+
+        # if the oauth account is already present for the team ..
+        if team.send(integrations_installations_collection).find_by(oauth_accounts_attribute => oauth_account)
+          message = t("omniauth.team.already_present", provider: t(auth.provider))
+
+        else
+          # otherwise, create a new integration for this team.
+          team.send(integrations_installations_collection).create(:name => oauth_account.name, oauth_accounts_attribute => oauth_account)
+          message = t("omniauth.team.connected", provider: t(auth.provider))
+
+        end
+
+      else
+
+        # if they don't have access to add integrations to the team, show them an error.
+        message = t("omniauth.team.not_allowed", provider: t(auth.provider))
+
+      end
+
+      # in all of these situations, we take them back to the team's oauth accounts index page for this provider.
+      redirect_to [:account, team, integrations_installations_collection], notice: message
+
+    # if they're already signed in, they're trying to add it to their account.
+    elsif current_user
+
+      # if the account is already connected to a user, we can't connect it again.
+      # this would potentially lock someone else out of their account.
+      if oauth_account.user
+        message_key = oauth_account.user == current_user ? "omniauth.user.reconnected" : "omniauth.user.already_registered"
+        redirect_to edit_account_user_path(current_user), notice: t(message_key, provider: t(auth.provider))
+      else
+        oauth_account.update(user: current_user)
+        redirect_to edit_account_user_path(current_user), notice: t("omniauth.user.connected", provider: t(auth.provider))
+      end
+
+    # if they're not trying to add it to a team, they're trying to sign in or sign up.
+    # if they're already associated with a user record, just sign them in.
+    elsif oauth_account.user
+
+      sign_in oauth_account.user
+      handle_outstanding_invitation
+      redirect_to account_dashboard_path
+
+    # if they're not associated with a user and they're allowed to sign up.
+    elsif show_sign_up_options?
+
+      # we're going to try to create a new user account.
+      # if the oauth provider gave us an email address, use that, otherwise use a
+      # temporary email placeholder. (we'll never show the temporary to the user.)
+      # this has to be a "real" email address so we don't trip up any email validators.
+      # however, this is secure because even if someone controlled `bullettrain.co`,
+      # they would never be able to guess the hex code to reset the password.
+      # even that is a rare edge case, because we force people to update this in onboarding.
+      email = auth.info.email.present? ? auth.info.email : "noreply+#{SecureRandom.hex}@bullettrain.co"
+
+      # if the user already exists with the email address on the account ..
+      if User.find_by(email: email)
+
+        # we can't sign them in, because they haven't added the oauth account to
+        # their account yet for sign in. there is a potential security loophole
+        # here if you allow them to do this at worst, and at best you're
+        # depending on the security of the oauth provider to have verified the
+        # email address on the account.
+        redirect_to new_user_session_path(user: {email: email}, email_exists: true), notice: "Sorry, there is already a user registered with the email address #{email}, but this #{t(auth.provider)} account isn't configured for login with that account. Please sign in using your password and then add this account."
+
+      else
+
+        # if the user doesn't exist in the database yet, great!
+        # let's create it and sign them in.
+        password = Devise.friendly_token[0, 20]
+        user = User.create(email: email, password: password, password_confirmation: password)
+
+        oauth_account.update(user: user)
+
+        sign_in user
+        handle_outstanding_invitation
+
+        # if the user doesn't have a team at this point, create one.
+        unless user.teams.any?
+          user.create_default_team
+
+          # if a user is signing up for the first time *and* creating their own team,
+          # this is a ux shortcut that makes sense: automatically install their oauth account as an integration.
+          user.teams.first.send(integrations_installations_collection).create(:name => oauth_account.name, oauth_accounts_attribute => oauth_account)
+        end
+
+        redirect_to account_dashboard_path
+      end
+
+    else
+      redirect_to new_user_session_path, notice: t("omniauth.user.account_not_found", provider: t(auth.provider))
+    end
+  end
+end

data/config/routes.rb

@@ -0,0 +1,2 @@
+Rails.application.routes.draw do
+end

data/lib/bullet_train/integrations/engine.rb

@@ -0,0 +1,6 @@
+module BulletTrain
+  module Integrations
+    class Engine < ::Rails::Engine
+    end
+  end
+end

data/lib/bullet_train/integrations/version.rb

@@ -0,0 +1,5 @@
+module BulletTrain
+  module Integrations
+    VERSION = "1.0.0"
+  end
+end

data/lib/bullet_train/integrations.rb

@@ -0,0 +1,8 @@
+require "bullet_train/integrations/version"
+require "bullet_train/integrations/engine"
+
+module BulletTrain
+  module Integrations
+    # Your code goes here...
+  end
+end

data/lib/tasks/bullet_train/integrations_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :bullet_train_integrations do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification
+name: bullet_train-integrations
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Andrew Culver
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-03-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+description: Bullet Train Integrations
+email:
+- andrew.culver@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/config/bullet_train_integrations_manifest.js
+- app/controllers/concerns/account/oauth/omniauth_callbacks/controller_base.rb
+- config/routes.rb
+- lib/bullet_train/integrations.rb
+- lib/bullet_train/integrations/engine.rb
+- lib/bullet_train/integrations/version.rb
+- lib/tasks/bullet_train/integrations_tasks.rake
+homepage: https://github.com/bullet-train-co/bullet_train-integrations
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/bullet-train-co/bullet_train-integrations
+  source_code_uri: https://github.com/bullet-train-co/bullet_train-integrations
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.22
+signing_key:
+specification_version: 4
+summary: Bullet Train Integrations
+test_files: []