add-to-org 2.2.0 → 3.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 351c099fc7771a5adc6fd806223371fe4d5ab588
-  data.tar.gz: 5616531e6f75f524d8e7af3ca68ea2a34d95c664
+SHA256:
+  metadata.gz: d6e1d519910bd9dae03bcb2c8cea47fcebb6fb188c48d7103dfec6e1a40df664
+  data.tar.gz: 5ef8eb34932716326573c30beb922c55b2549bf5cb2d0ce2cd273ddd8ef409b1
 SHA512:
-  metadata.gz: 96fe29f18f7ca1e94e0c27e24c5fa8096b7ca7d6abc85531cff9ed759c0e12d8c848d1b3e08975ff1245b0b9882d1dfa634f63cb90ea03bdbe8de616d8152209
-  data.tar.gz: 5bb857c019684da4da650e9160f556b3df7ad35aa6796b96d2baf81ff707a086dd5b8c0c3232737cf7c01ca5106ed1f263593ad82479a8b0a12a4fd79f013bbe
+  metadata.gz: 336633b4e2062a6e8de5411bf38ae7cab6b085a626b7af679f83a880d5781d3713933df4bf5434d2b3f09b532dafe177364f88e02274fd2c8657540acfa7b983
+  data.tar.gz: 4b41e21b69c44f9109b47ba0408dc6ff63400d481bbc5738be4a035c35a0597a1e41d0d2045942749dba06fcf769d8e01561a6908a7b0009666f8e0cff6ce5b6

data/.bowerrc

@@ -0,0 +1,3 @@
+{
+  "directory": "lib/add-to-org/public/vendor"
+}

data/.github/workflows/ci.yml

@@ -0,0 +1,24 @@
+name: CI
+
+on:
+  push:
+    branches: [master]
+  pull_request:
+    branches: [master]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 3.0
+          bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+
+      - name: Run tests
+        run: script/cibuild

data/.gitignore

@@ -2,3 +2,10 @@
 .bundle
 *.gem
 Gemfile.lock
+/lib/add-to-org/public/vendor/jquery
+/lib/add-to-org/public/vendor/bootstrap/grunt
+/lib/add-to-org/public/vendor/bootstrap/js
+/lib/add-to-org/public/vendor/bootstrap/less
+/lib/add-to-org/public/vendor/bootstrap/nuget
+/lib/add-to-org/public/vendor/bootstrap/*.md
+/lib/add-to-org/public/vendor/bootstrap/*.js

data/.rubocop.yml

@@ -0,0 +1,8 @@
+inherit_from: .rubocop_todo.yml
+
+require:
+  - rubocop-performance
+  - rubocop-rspec
+
+AllCops:
+  NewCops: enable

data/.rubocop_todo.yml

@@ -0,0 +1,100 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2021-10-07 20:24:39 UTC using RuboCop version 1.22.1.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+# Configuration parameters: Include.
+# Include: **/*.gemspec
+Gemspec/RequiredRubyVersion:
+  Exclude:
+    - 'add-to-org.gemspec'
+
+# Offense count: 3
+# Configuration parameters: IgnoredMethods.
+Lint/AmbiguousBlockAssociation:
+  Exclude:
+    - 'lib/add-to-org.rb'
+
+# Offense count: 1
+# Configuration parameters: AllowedMethods.
+# AllowedMethods: enums
+Lint/ConstantDefinitionInBlock:
+  Exclude:
+    - 'spec/add-to-org-helpers_spec.rb'
+
+# Offense count: 4
+# Configuration parameters: CountComments, CountAsOne, ExcludedMethods, IgnoredMethods.
+# IgnoredMethods: refine
+Metrics/BlockLength:
+  Max: 88
+
+# Offense count: 1
+Naming/AccessorMethodName:
+  Exclude:
+    - 'lib/add-to-org.rb'
+
+# Offense count: 3
+# Configuration parameters: ExpectMatchingDefinition, CheckDefinitionPathHierarchy, Regex, IgnoreExecutableScripts, AllowedAcronyms.
+# AllowedAcronyms: CLI, DSL, ACL, API, ASCII, CPU, CSS, DNS, EOF, GUID, HTML, HTTP, HTTPS, ID, IP, JSON, LHS, QPS, RAM, RHS, RPC, SLA, SMTP, SQL, SSH, TCP, TLS, TTL, UDP, UI, UID, UUID, URI, URL, UTF8, VM, XML, XMPP, XSRF, XSS
+Naming/FileName:
+  Exclude:
+    - 'lib/add-to-org.rb'
+    - 'spec/add-to-org-helpers_spec.rb'
+    - 'spec/add-to-org_spec.rb'
+
+# Offense count: 3
+# Configuration parameters: IgnoredMetadata.
+RSpec/DescribeClass:
+  Exclude:
+    - '**/spec/features/**/*'
+    - '**/spec/requests/**/*'
+    - '**/spec/routing/**/*'
+    - '**/spec/system/**/*'
+    - '**/spec/views/**/*'
+    - 'spec/add-to-org_spec.rb'
+
+# Offense count: 6
+# Configuration parameters: CountAsOne.
+RSpec/ExampleLength:
+  Max: 16
+
+# Offense count: 14
+# Configuration parameters: AssignmentOnly.
+RSpec/InstanceVariable:
+  Exclude:
+    - 'spec/add-to-org-helpers_spec.rb'
+    - 'spec/add-to-org_spec.rb'
+
+# Offense count: 1
+RSpec/LeakyConstantDeclaration:
+  Exclude:
+    - 'spec/add-to-org-helpers_spec.rb'
+
+# Offense count: 1
+RSpec/MultipleDescribes:
+  Exclude:
+    - 'spec/add-to-org_spec.rb'
+
+# Offense count: 9
+RSpec/MultipleExpectations:
+  Max: 6
+
+# Offense count: 3
+# Configuration parameters: AllowedConstants.
+Style/Documentation:
+  Exclude:
+    - 'spec/**/*'
+    - 'test/**/*'
+    - 'lib/add-to-org.rb'
+    - 'lib/add-to-org/helpers.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
+# URISchemes: http, https
+Layout/LineLength:
+  Max: 124

data/Gemfile

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

data/README.md

@@ -10,10 +10,35 @@ Once set up, simply swap out your app's domain for any GitHub URL. E.g., `github
 
 ## Setup
 
-1. Create [an oauth app](github.com/settings/applications/new)
-2. Create a personal access token for a user with admin rights to the organization
+*Pro-tip: for a quickstart on how to set up the app, see the [add-to-org demo app](https://github.com/benbalter/add-to-org-demo).*
+
+### Credentials
+
+You'll need a few different credentials for things to work:
+
+#### A bot account
+
+You'll need a dedicated "bot" account to add users to the organization:
+
+1. [Create a bot account](https://github.com/signup) (a standard GitHub account not used by a human) that has *admin* rights to your organization.
+2. [Create a personal access token](https://github.com/settings/tokens/new) for that user, with `admin:org` scope.
+
+#### An OAuth application
+
+You'll also need to create an OAUth application to validate users:
+
+1. Create an OAauth application *within your organization* via `https://github.com/organizations/[YOUR-ORGANIZATION-NAME]/settings/applications/new`
+2. The homepage URL should be the URL to your production instance.
+3. You can leave the callback URL blank. The default is fine.
+
+## Developing locally and deploying
+
+*Pro-tip: for a quickstart on how to set up the app, see the [add-to-org demo app](https://github.com/benbalter/add-to-org-demo)*
+
+1. Create [an oauth app](github.com/settings/applications/new) (see above)
+2. Create a personal access token for a user with admin rights to the organization (see above)
 3. Add `gem 'add-to-org' to your project's Gemfile
-4. Add the following to a `config.ru` file:
+4. Add the following to your project's `config.ru` file:
 
 ```ruby
 require 'add-to-org'
@@ -31,40 +56,58 @@ The following environmental values should be set:
 * `GITHUB_TOKEN` - A personal access token for a user with admin rights to the organization
 * `CONTACT_EMAIL` - Point of contact to point users to if something goes wrong
 
-You'll also need to monkey patch a validation method to determine if a user should be added, e.g.:
+### Customizing the validator
+
+For Add to Org to work, you'll also need to define a custom validator. You can do this in your `configu.ru`, or in a separate file included into `config.ru`. Here's an example of a validator that confirms the user has a verified `@github.com` email address:
 
 ```ruby
 require 'add-to-org'
 
-module AddToOrg
-  class App < Sinatra::Base
-    def valid?
-      verified_emails.any? { |email| email[:email] =~ /@github\.com$/}
-    end
-  end
+AddToOrg.set_validator do |github_user, verified_emails, client|
+  verified_emails.any? { |email| email[:email] =~ /@github\.com\z/ }
 end
+
+run AddToOrg::App
 ```
 
-## Customizing Views
+If you prefer, you can also pass the validator as a proc (or lambda):
+
+```ruby
+AddToOrg.validator = proc { |github_user, verified_emails, client|
+  verified_emails.any? { |email| email[:email] =~ /@github\.com\z/ }
+}
+```
 
-There are three views, `success`, `forbidden`, and `error`. They're pretty boring by default, so you may want to swap them out for something a bit my snazzy. There are two ways to do that:
+The validator will receive three  arguments to help you validate the user meets your criteria:
+
+* `github_user` - the Warden user, which will contain information like username, company, and human-readable name
+* `verified_emails` - an array of the user's verified emails
+* `client` - An [Octokit.rb](https://github.com/octokit/octokit.rb) client, preset with the user's OAuth token.
+
+The validator should return `true` if you'd like the current user added to the organization, or `false` if you'd like the user's request to be denied.
+
+### Customizing Views
+
+There are three views, `success`, `forbidden`, and `error`. They're pretty boring by default, so you may want to swap them out for something a bit my snazzy. If you had a views directory along side your `config.ru`, you can do so like this in your `config.ru` file:
 
 ```ruby
-module AddToOrg
-  class App < Sinatra::Base
-    set :views, "path/to/your/views"
-  end
-end
+require 'add-to-org'
+
+AddToOrgs.views_dir = File.expand_path("./views", File.dirname(__FILE__))
+
+run AddToOrg::App
 ```
 
-or by overwriting the `success`, `forbidden`, and `error` methods entirely:
+These are just sinatra `.erb` views. Take a look at [the default views](https://github.com/benbalter/add-to-org/tree/master/lib/add-to-org/views) for an example.
+
+### Customizing static assets
+
+You can also do the same with `AddToOrg.public_dir` for serving static assets (AddToOrg comes bundled with Bootstrap by default).
 
 ```ruby
-module AddToOrg
-  class App < Sinatra::Base
-    def success(locals={})
-      halt erb :some_template, :locals => locals
-    end
-  end
-end
+require 'add-to-org'
+
+AddToOrgs.public_dir = File.expand_path("./public", File.dirname(__FILE__))
+
+run AddToOrg::App
 ```

data/Rakefile

@@ -1,12 +1,14 @@
+# frozen_string_literal: true
+
 require 'rubygems/package_task'
 require 'rubygems/specification'
 require 'bundler'
 
-task :default => [:spec]
+task default: [:spec]
 
 require 'rspec/core/rake_task'
-desc "Run specs"
+desc 'Run specs'
 RSpec::Core::RakeTask.new do |t|
   t.pattern = 'spec/**/*_spec.rb'
-  t.rspec_opts = ["--order", "rand", "--color"]
+  t.rspec_opts = ['--order', 'rand', '--color']
 end

data/add-to-org.gemspec

@@ -1,29 +1,32 @@
-require File.expand_path('../lib/add-to-org/version', __FILE__)
+# frozen_string_literal: true
+
+require File.expand_path('lib/add-to-org/version', __dir__)
 
 Gem::Specification.new do |s|
-  s.name = "add-to-org"
-  s.summary = "A simple Oauth App to automatically add users to an organization"
-  s.description = "A simple Oauth App to automatically add users to an organization."
+  s.name = 'add-to-org'
+  s.summary = 'A simple Oauth App to automatically add users to an organization'
+  s.description = 'A simple Oauth App to automatically add users to an organization.'
   s.version = AddToOrg::VERSION
-  s.authors = ["Ben Balter"]
-  s.email = "ben.balter@github.com"
-  s.homepage = "https://github.com/benbalter/add-to-org"
-  s.licenses = ["MIT"]
+  s.authors = ['Ben Balter']
+  s.email = 'ben.balter@github.com'
+  s.homepage = 'https://github.com/benbalter/add-to-org'
+  s.licenses = ['MIT']
 
   s.files                 = `git ls-files`.split("\n")
   s.test_files            = `git ls-files -- {test,spec,features}/*`.split("\n")
-  s.executables           = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
-  s.require_paths         = ["lib"]
+  s.executables           = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
+  s.require_paths         = ['lib']
 
-  s.require_paths = ["lib"]
-  s.add_dependency "warden-github", "~> 1.1"
-  s.add_dependency "sinatra_auth_github", "~> 1.1"
-  s.add_dependency "octokit", "~> 4.0"
-  s.add_dependency "rack-ssl-enforcer", "~> 0.2"
-  s.add_dependency "dotenv", "~> 2.0"
-  s.add_dependency "rake", "~> 10.3"
-  s.add_development_dependency "rspec", "~> 3.1"
-  s.add_development_dependency "rack-test", "~> 0.6"
-  s.add_development_dependency "webmock", "~> 1.2 "
-  s.add_development_dependency "pry", "~> 0.10"
+  s.add_dependency 'dotenv', '~> 2.0'
+  s.add_dependency 'octokit', '~> 4.0'
+  s.add_dependency 'rack-ssl-enforcer', '~> 0.2'
+  s.add_dependency 'rake'
+  s.add_dependency 'sinatra_auth_github', '~> 2.0'
+  s.add_development_dependency 'pry'
+  s.add_development_dependency 'rack-test'
+  s.add_development_dependency 'rspec', '~> 3.1'
+  s.add_development_dependency 'rubocop'
+  s.add_development_dependency 'rubocop-performance'
+  s.add_development_dependency 'rubocop-rspec'
+  s.add_development_dependency 'webmock'
 end

data/bower.json

@@ -0,0 +1,13 @@
+{
+  "name": "add-to-org",
+  "homepage": "https://github.com/benbalter/add-to-org",
+  "authors": [
+    "Ben Balter <ben.balter@github.com>"
+  ],
+  "description": "A simple Oauth App to automatically add users to an organization",
+  "main": "script/server",
+  "moduleType": [],
+  "license": "MIT",
+  "private": true,
+  "dependencies": {}
+}

data/lib/add-to-org/helpers.rb

@@ -1,20 +1,27 @@
+# frozen_string_literal: true
+
 module AddToOrg
   module Helpers
+    # query api for the user's verified emails
+    def verified_emails
+      emails = client.emails accept: 'application/vnd.github.v3'
+      emails.select(&:verified)
+    end
+
+    def valid?
+      AddToOrg.validator.call(github_user, verified_emails, client)
+    end
+
+    private
 
     # user client
     def client
-      @client ||= Octokit::Client.new :access_token => github_user.token
+      @client ||= Octokit::Client.new access_token: github_user.token
     end
 
-    # new org admin client
+    # org admin client
     def sudo_client
-      @sudo_client ||= Octokit::Client.new :access_token => ENV['GITHUB_TOKEN']
-    end
-
-    # query api for the user's verified emails
-    def verified_emails
-      emails = client.emails :accept => 'application/vnd.github.v3'
-      emails.select { |email| email.verified }
+      @sudo_client ||= Octokit::Client.new access_token: ENV['GITHUB_TOKEN']
     end
 
     # true if user is already a member of the org
@@ -22,10 +29,6 @@ module AddToOrg
       client.organization_member? org_id, github_user.login
     end
 
-    def valid?
-      raise "You must define a custom valid? method to determine eligibility"
-    end
-
     def team_id
       ENV['GITHUB_TEAM_ID']
     end

data/lib/add-to-org/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module AddToOrg
-  VERSION = "2.2.0"
+  VERSION = '3.0.3'
 end

data/lib/add-to-org/views/error.erb

@@ -1,12 +1,5 @@
-<html>
-  <head>
-    <style>
-      body { padding: 20px; }
-    </style>
-  </head>
-  <body>
-    <h1>Ruh roh</h1>
-    <p>Looks like something went wrong.</p>
-    <p>Please contact <a href="mailto:<%= ENV['CONTACT_EMAIL'] %>"><%= ENV['CONTACT_EMAIL'] %></a>.</p>
-  </body>
-</html>
+<h1>Ruh roh</h1>
+
+<p>Looks like something went wrong.</p>
+
+<p>Please contact <a href="mailto:<%= ENV['CONTACT_EMAIL'] %>"><%= ENV['CONTACT_EMAIL'] %></a>.</p>

data/lib/add-to-org/views/forbidden.erb

@@ -1,12 +1,5 @@
-<html>
-  <head>
-    <style>
-      body { padding: 20px; }
-    </style>
-  </head>
-  <body>
-    <h1>Sorry Charlie</h1>
-    <p>We're unable to verify your eligibility at this time.</p>
-    <p>Please contact <a href="mailto:<%= ENV['CONTACT_EMAIL'] %>"><%= ENV['CONTACT_EMAIL'] %></a> if you believe this is in error.</p>
-  </body>
-</html>
+<h1>Sorry Charlie</h1>
+
+<p>We're unable to verify your eligibility at this time.</p>
+
+<p>Please contact <a href="mailto:<%= ENV['CONTACT_EMAIL'] %>"><%= ENV['CONTACT_EMAIL'] %></a> if you believe this is in error.</p>

data/lib/add-to-org/views/layout.erb

@@ -0,0 +1,16 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="utf-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <title>Join <%= ENV['GITHUB_ORG_ID'] %></title>
+    <style>
+      body { text-align: center; padding-top: 100px; }
+    </style>
+  </head>
+  <body>
+    <div class="container">
+      <%= yield %>
+    </div>
+  </body>
+</html>

data/lib/add-to-org/views/success.erb

@@ -1,12 +1,5 @@
-<html>
-  <head>
-    <style>
-      body { padding: 20px; }
-    </style>
-  </head>
-  <body>
-    <h1>You're all set</h1>
-    <p class="lead">You simply need to <a href="https://github.com/orgs/<%= @org_id %>/invitation?return_to=<%= ERB::Util.html_escape(redirect) %>">confirm your invitation to join the organization</a> on GitHub.</p>
-    <p>Once confirmed, you will have access to <a href="<%= ERB::Util.html_escape(redirect) %>"><%= ERB::Util.html_escape(redirect) %></a>, the requested URL.</h1>
-  </body>
-</html>
+<h1>You're all set</h1>
+
+<p class="lead">You simply need to <a href="https://github.com/orgs/<%= org_id %>/invitation?return_to=<%= ERB::Util.html_escape(redirect) %>">confirm your invitation to join the organization</a> on GitHub.</p>
+
+<p>Once confirmed, you will have access to <a href="<%= ERB::Util.html_escape(redirect) %>"><%= ERB::Util.html_escape(redirect) %></a>, the requested URL.</h1>

data/lib/add-to-org.rb

@@ -1,28 +1,61 @@
+# frozen_string_literal: true
+
 require 'octokit'
 require 'sinatra_auth_github'
 require 'dotenv'
 require_relative 'add-to-org/helpers'
 
-Dotenv.load
-
 module AddToOrg
-  class App < Sinatra::Base
+  def self.root
+    File.expand_path './add-to-org', File.dirname(__FILE__)
+  end
+
+  def self.views_dir
+    @views_dir ||= File.expand_path 'views', AddToOrg.root
+  end
 
+  def self.views_dir=(dir)
+    @views_dir = dir
+  end
+
+  def self.public_dir
+    @public_dir ||= File.expand_path 'public', AddToOrg.root
+  end
+
+  def self.public_dir=(dir)
+    @public_dir = dir
+  end
+
+  def self.validator=(validator)
+    @validator = validator
+  end
+
+  def self.set_validator(&block)
+    @validator = block
+  end
+
+  def self.validator
+    @validator ||= proc { raise 'You must define a custom validator to determine eligibility' }
+  end
+
+  class App < Sinatra::Base
     include AddToOrg::Helpers
 
     set :github_options, {
-      :scopes => "read:org,user:email"
+      scopes: 'read:org,user:email'
     }
 
     use Rack::Session::Cookie, {
-      :http_only => true,
-      :secret => ENV['SESSION_SECRET'] || SecureRandom.hex
+      http_only: true,
+      secret: ENV['SESSION_SECRET'] || SecureRandom.hex
     }
 
     ENV['WARDEN_GITHUB_VERIFIER_SECRET'] ||= SecureRandom.hex
     register Sinatra::Auth::Github
 
-    set :views, File.expand_path("add-to-org/views", File.dirname(__FILE__))
+    set :views, proc { AddToOrg.views_dir }
+    set :root,  proc { AddToOrg.root }
+    set :public_folder, proc { AddToOrg.public_dir }
 
     # require ssl
     configure :production do
@@ -32,12 +65,12 @@ module AddToOrg
 
     # dat auth
     before do
-      session[:return_to] = request.url #store requested URL for post-auth redirect
+      session[:return_to] = request.url # store requested URL for post-auth redirect
       authenticate!
     end
 
-    def success(locals={})
-      halt erb :success, :locals => locals
+    def success(locals = {})
+      halt erb :success, locals: locals
     end
 
     def forbidden
@@ -51,17 +84,18 @@ module AddToOrg
     end
 
     # request a GitHub (authenticated) URL
-    get "/*" do
-
+    get '/*' do
       path = request.path || "/#{team_id}"
       halt redirect "https://github.com#{path}", 302 if member?
       forbidden unless valid?
 
       if add
-        success({ :redirect => "https://github.com#{path}", :org_id => org_id })
+        success({ redirect: "https://github.com#{path}", org_id: org_id })
       else
         error
       end
     end
   end
 end
+
+Dotenv.load unless AddToOrg::App.production?

data/script/cibuild

@@ -4,4 +4,5 @@
 set -e
 
 bundle exec rake spec
+bundle exec rubocop
 bundle exec gem build add-to-org.gemspec

data/spec/add-to-org-helpers_spec.rb

@@ -1,80 +1,88 @@
-require "spec_helper"
+# frozen_string_literal: true
 
-describe "AddToOrgHelpers" do
+require 'spec_helper'
 
+describe 'AddToOrgHelpers' do
   class TestHelper
     include AddToOrg::Helpers
 
     def github_user
-      User.make({"login" => "benbaltertest"}, "asdf1234")
+      User.make({ 'login' => 'benbaltertest' }, 'asdf1234')
     end
 
-    def initialize(path=nil)
+    def initialize(path = nil)
       @path = path
     end
 
     def request
-      Rack::Request.new("PATH_INFO" => @path)
+      Rack::Request.new('PATH_INFO' => @path)
     end
   end
 
-  before(:each) do
+  before do
     @helper = TestHelper.new
   end
 
-  it "initializes the client" do
-    expect(@helper.client.class).to eql(Octokit::Client)
-    expect(@helper.client.instance_variable_get("@access_token")).to eql("asdf1234")
+  it 'initializes the client' do
+    expect(@helper.send(:client).class).to eql(Octokit::Client)
+    expect(@helper.send(:client).instance_variable_get('@access_token')).to eql('asdf1234')
   end
 
-  it "initializes the sudo client" do
-    with_env "GITHUB_TOKEN", "SUDO_TOKEN" do
-      expect(@helper.sudo_client.class).to eql(Octokit::Client)
-      expect(@helper.sudo_client.instance_variable_get("@access_token")).to eql("SUDO_TOKEN")
+  it 'initializes the sudo client' do
+    with_env 'GITHUB_TOKEN', 'SUDO_TOKEN' do
+      expect(@helper.send(:sudo_client).class).to eql(Octokit::Client)
+      expect(@helper.send(:sudo_client).instance_variable_get('@access_token')).to eql('SUDO_TOKEN')
     end
   end
 
-  it "retrieves a users verified emails" do
-    stub_request(:get, "https://api.github.com/user/emails").
-    to_return(:status => 200, :body => fixture("emails.json"), :headers => { 'Content-Type'=>'application/json' })
-    expect(@helper.verified_emails.count).to eql(1)
-    expect(@helper.verified_emails.first[:email]).to eql("octocat@github.com")
+  it 'retrieves a users verified emails' do
+    stub_request(:get, 'https://api.github.com/user/emails')
+      .to_return(status: 200, body: fixture('emails.json'), headers: { 'Content-Type' => 'application/json' })
+    expect(@helper.verified_emails.count).to be(1)
+    expect(@helper.verified_emails.first[:email]).to eql('octocat@github.com')
   end
 
-  it "retrieves the org id" do
-    with_env "GITHUB_ORG_ID", "some_org" do
-      expect(@helper.org_id).to eql("some_org")
+  it 'retrieves the org id' do
+    with_env 'GITHUB_ORG_ID', 'some_org' do
+      expect(@helper.send(:org_id)).to eql('some_org')
     end
   end
 
-  it "retrieves the team id" do
-    with_env "GITHUB_TEAM_ID", "1234" do
-      expect(@helper.team_id).to eql("1234")
+  it 'retrieves the team id' do
+    with_env 'GITHUB_TEAM_ID', '1234' do
+      expect(@helper.send(:team_id)).to eql('1234')
     end
   end
 
-  it "knows if a user is an org member" do
-    with_env "GITHUB_ORG_ID", "some_org" do
-      stub_request(:get, "https://api.github.com/orgs/some_org/members/benbaltertest").
-      to_return(:status => 204)
-      expect(@helper.member?).to eql(true)
+  it 'knows if a user is an org member' do
+    with_env 'GITHUB_ORG_ID', 'some_org' do
+      stub_request(:get, 'https://api.github.com/orgs/some_org/members/benbaltertest')
+        .to_return(status: 204)
+      expect(@helper.send(:member?)).to be(true)
 
-      stub_request(:get, "https://api.github.com/orgs/some_org/members/benbaltertest").
-      to_return(:status => 404)
-      expect(@helper.member?).to eql(false)
+      stub_request(:get, 'https://api.github.com/orgs/some_org/members/benbaltertest')
+        .to_return(status: 404)
+      expect(@helper.send(:member?)).to be(false)
     end
   end
 
-  it "knows how to add a mebmer to an org" do
-    with_env "GITHUB_ORG_ID", "some_org" do
-      stub = stub_request(:put, "https://api.github.com/teams/memberships/benbaltertest").
-      to_return(:status => 204)
-      @helper.add
-      expect(stub).to have_been_requested
+  it 'knows how to add a member to an org' do
+    with_env 'GITHUB_ORG_ID', 'some_org' do
+      with_env 'GITHUB_TEAM_ID', '1234' do
+        stub = stub_request(:put, 'https://api.github.com/teams/1234/memberships/benbaltertest')
+               .to_return(status: 204)
+        @helper.send(:add)
+        expect(stub).to have_been_requested
+      end
     end
   end
 
-  it "throws an error if valid? is not defined" do
-    expect { @helper.valid? }.to raise_error("You must define a custom valid? method to determine eligibility")
+  it 'throws an error if valid? is not defined' do
+    stub_request(:get, 'https://api.github.com/user/emails')
+      .to_return(status: 200, body: fixture('emails.json'), headers: { 'Content-Type' => 'application/json' })
+
+    AddToOrg.validator = nil
+    error = 'You must define a custom validator to determine eligibility'
+    expect { @helper.valid? }.to raise_error(error)
   end
 end

data/spec/add-to-org_spec.rb

@@ -1,32 +1,38 @@
-require "spec_helper"
+# frozen_string_literal: true
 
-describe "logged out user" do
+require 'spec_helper'
 
+describe 'config' do
+  %i[views_dir public_dir validator].each do |var|
+    after do
+      AddToOrg.send("#{var}=", nil)
+    end
+
+    it "accepts #{var}" do
+      expected = SecureRandom.hex
+      AddToOrg.send("#{var}=", expected)
+      expect(AddToOrg.send(var)).to eql(expected)
+    end
+  end
+end
+
+describe 'logged out user' do
   include Rack::Test::Methods
 
   def app
     AddToOrg::App
   end
 
-  it "asks you to log in" do
-    get "/"
-    expect(last_response.status).to eql(302)
+  it 'asks you to log in' do
+    get '/'
+    expect(last_response.status).to be(302)
     expect(last_response.headers['Location']).to match(%r{^https://github\.com/login/oauth/authorize})
   end
 end
 
-describe "logged in user" do
-
+describe 'logged in user' do
   include Rack::Test::Methods
 
-  module AddToOrg
-    class App < Sinatra::Base
-      def valid?
-        verified_emails.any? { |email| email[:email] =~ /@github\.com$/}
-      end
-    end
-  end
-
   def app
     AddToOrg::App
   end
@@ -36,71 +42,98 @@ describe "logged in user" do
     login_as @user
   end
 
-  it "redirects if the user is a member" do
-    with_env "GITHUB_ORG_ID", "some_org" do
-      stub_request(:get, "https://api.github.com/orgs/some_org/members/benbaltertest").
-      to_return(:status => 204)
-      get "/"
-      expect(last_response.status).to eql(302)
-      expect(last_response.headers['Location']).to eql("https://github.com/")
-
-      get "/foo"
-      expect(last_response.status).to eql(302)
-      expect(last_response.headers['Location']).to eql("https://github.com/foo")
-
-      get "/foo/bar"
-      expect(last_response.status).to eql(302)
-      expect(last_response.headers['Location']).to eql("https://github.com/foo/bar")
+  it 'redirects if the user is a member' do
+    with_env 'GITHUB_ORG_ID', 'some_org' do
+      stub_request(:get, 'https://api.github.com/orgs/some_org/members/benbaltertest')
+        .to_return(status: 204)
+      get '/'
+      expect(last_response.status).to be(302)
+      expect(last_response.headers['Location']).to eql('https://github.com/')
+
+      get '/foo'
+      expect(last_response.status).to be(302)
+      expect(last_response.headers['Location']).to eql('https://github.com/foo')
+
+      get '/foo/bar'
+      expect(last_response.status).to be(302)
+      expect(last_response.headers['Location']).to eql('https://github.com/foo/bar')
     end
   end
 
-  it "denies acccess to invalid users" do
-    with_env "GITHUB_ORG_ID", "some_org" do
-      stub_request(:get, "https://api.github.com/orgs/some_org/members/benbaltertest").
-      to_return(:status => 404)
-
-      stub_request(:get, "https://api.github.com/user/emails").
-      to_return(:status => 200, :body => fixture("invalid_emails.json"), :headers => { 'Content-Type'=>'application/json' })
-
-      get "/"
-      expect(last_response.status).to eql(403)
-      expect(last_response.body).to match(/We're unable to verify your eligibility at this time/)
-    end
-  end
+  %i[proc block lambda].each do |method|
+    describe "with validator passed as a #{method}" do
+      before do
+        case method
+        when :block
+          AddToOrg.set_validator do |_github_user, verified_emails, _client|
+            verified_emails.any? { |email| email[:email] =~ /@github\.com$/ }
+          end
+        when :proc
+          AddToOrg.validator = proc { |_github_user, verified_emails, _client|
+            verified_emails.any? { |email| email[:email] =~ /@github\.com$/ }
+          }
+        when :lambda
+          AddToOrg.validator = lambda { |_github_user, verified_emails, _client|
+            verified_emails.any? { |email| email[:email] =~ /@github\.com$/ }
+          }
+        end
+      end
 
-  it "tries to add valid users" do
-    with_env "GITHUB_ORG_ID", "some_org" do
-      stub_request(:get, "https://api.github.com/orgs/some_org/members/benbaltertest").
-      to_return(:status => 404)
+      it 'denies acccess to invalid users' do
+        with_env 'GITHUB_ORG_ID', 'some_org' do
+          stub_request(:get, 'https://api.github.com/orgs/some_org/members/benbaltertest')
+            .to_return(status: 404)
 
-      stub_request(:get, "https://api.github.com/user/emails").
-      to_return(:status => 200, :body => fixture("emails.json"), :headers => { 'Content-Type'=>'application/json' })
+          stub_request(:get, 'https://api.github.com/user/emails')
+            .to_return(status: 200, body: fixture('invalid_emails.json'), headers: { 'Content-Type' => 'application/json' })
 
-      stub = stub_request(:put, "https://api.github.com/teams/memberships/benbaltertest").
-      to_return(:status => 204)
+          get '/'
+          expect(last_response.status).to be(403)
+          expect(last_response.body).to match(/We're unable to verify your eligibility at this time/)
+        end
+      end
 
-      get "/"
-      expect(stub).to have_been_requested
-      expect(last_response.status).to eql(200)
-      expect(last_response.body).to match(/confirm your invitation to join the organization/)
-    end
-  end
+      it 'tries to add valid users' do
+        with_env 'GITHUB_ORG_ID', 'some_org' do
+          with_env 'GITHUB_TEAM_ID', '1234' do
+            stub_request(:get, 'https://api.github.com/orgs/some_org/members/benbaltertest')
+              .to_return(status: 404)
+
+            stub_request(:get, 'https://api.github.com/user/emails')
+              .to_return(status: 200, body: fixture('emails.json'), headers: { 'Content-Type' => 'application/json' })
+
+            stub = stub_request(:put, 'https://api.github.com/teams/1234/memberships/benbaltertest')
+                   .to_return(status: 204)
+
+            get '/foo'
+            expect(stub).to have_been_requested
+            expect(last_response.status).to be(200)
+            expect(last_response.body).to match(/confirm your invitation to join the organization/)
+            expect(last_response.body).to match(%r{https://github.com/orgs/some_org/invitation})
+            expect(last_response.body).to match(%r{\?return_to=https://github.com/foo})
+          end
+        end
+      end
 
-  it "includes the requested URL" do
-    with_env "GITHUB_ORG_ID", "some_org" do
-      stub_request(:get, "https://api.github.com/orgs/some_org/members/benbaltertest").
-      to_return(:status => 404)
+      it 'includes the requested URL' do
+        with_env 'GITHUB_ORG_ID', 'some_org' do
+          with_env 'GITHUB_TEAM_ID', '1234' do
+            stub_request(:get, 'https://api.github.com/orgs/some_org/members/benbaltertest')
+              .to_return(status: 404)
 
-      stub_request(:get, "https://api.github.com/user/emails").
-      to_return(:status => 200, :body => fixture("emails.json"), :headers => { 'Content-Type'=>'application/json' })
+            stub_request(:get, 'https://api.github.com/user/emails')
+              .to_return(status: 200, body: fixture('emails.json'), headers: { 'Content-Type' => 'application/json' })
 
-      stub = stub_request(:put, "https://api.github.com/teams/memberships/benbaltertest").
-      to_return(:status => 204)
+            stub = stub_request(:put, 'https://api.github.com/teams/1234/memberships/benbaltertest')
+                   .to_return(status: 204)
 
-      get "/foo/bar"
-      expect(stub).to have_been_requested
-      expect(last_response.status).to eql(200)
-      expect(last_response.body).to match(Regexp.new('<a href="https://github.com/foo/bar">https://github.com/foo/bar</a>'))
+            get '/foo/bar'
+            expect(stub).to have_been_requested
+            expect(last_response.status).to be(200)
+            expect(last_response.body).to match(Regexp.new('<a href="https://github.com/foo/bar">https://github.com/foo/bar</a>'))
+          end
+        end
+      end
     end
   end
 end

data/spec/spec_helper.rb

@@ -1,15 +1,20 @@
-require "bundler/setup"
+# frozen_string_literal: true
+
+require 'bundler/setup'
 require 'fileutils'
+require 'securerandom'
 
 ENV['RACK_ENV'] = 'test'
-$:.push File.join(File.dirname(__FILE__), '..', 'lib')
+ENV['GITHUB_CLIENT_ID'] = 'CLIENT_ID'
+ENV['GITHUB_CLIENT_SECRET'] = 'CLIENT_SECRET'
+$LOAD_PATH.push File.join(File.dirname(__FILE__), '..', 'lib')
 
 require 'rack/test'
 require 'sinatra/auth/github'
 require 'sinatra/auth/github/test/test_helper'
 require 'webmock/rspec'
 
-require_relative "../lib/add-to-org"
+require_relative '../lib/add-to-org'
 WebMock.disable_net_connect!
 
 RSpec.configure do |config|
@@ -24,7 +29,6 @@ def fixture(fixture)
   File.open(fixture_path(fixture)).read
 end
 
-
 def with_env(key, value)
   old_env = ENV[key]
   ENV[key] = value
@@ -33,16 +37,16 @@ def with_env(key, value)
 end
 
 class User < Warden::GitHub::User
-  def self.make(attrs = {}, token=nil)
+  def self.make(attrs = {}, token = nil)
     default_attrs = {
-      'login'   => "test_user",
-      'name'    => "Test User",
-      'email'   => "test@example.com",
-      'company' => "GitHub",
-      'gravatar_id' => 'a'*32,
-      'avatar_url'  => 'https://a249.e.akamai.net/assets.github.com/images/gravatars/gravatar-140.png?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-user-420.png'
+      'login' => 'test_user',
+      'name' => 'Test User',
+      'email' => 'test@example.com',
+      'company' => 'GitHub',
+      'gravatar_id' => 'a' * 32,
+      'avatar_url' => 'https://a249.e.akamai.net/assets.github.com/images/gravatars/gravatar-140.png?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-user-420.png'
     }
     default_attrs.merge! attrs
-    User.new(default_attrs,token)
+    User.new(default_attrs, token)
   end
 end

metadata

@@ -1,73 +1,73 @@
 --- !ruby/object:Gem::Specification
 name: add-to-org
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 3.0.3
 platform: ruby
 authors:
 - Ben Balter
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2015-10-16 00:00:00.000000000 Z
+date: 2021-10-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: warden-github
+  name: dotenv
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
-  name: sinatra_auth_github
+  name: octokit
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '4.0'
 - !ruby/object:Gem::Dependency
-  name: octokit
+  name: rack-ssl-enforcer
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '0.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '0.2'
 - !ruby/object:Gem::Dependency
-  name: rack-ssl-enforcer
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: dotenv
+  name: sinatra_auth_github
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
@@ -81,19 +81,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '2.0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.3'
-  type: :runtime
+        version: '0'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  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: '10.3'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -109,66 +123,85 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.1'
 - !ruby/object:Gem::Dependency
-  name: rack-test
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: webmock
+  name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  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.10'
+        version: '0'
 description: A simple Oauth App to automatically add users to an organization.
 email: ben.balter@github.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".bowerrc"
+- ".github/workflows/ci.yml"
 - ".gitignore"
-- ".ruby-version"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
 - ".travis.yml"
 - Gemfile
 - LICENSE.md
 - README.md
 - Rakefile
 - add-to-org.gemspec
+- bower.json
 - lib/add-to-org.rb
 - lib/add-to-org/helpers.rb
 - lib/add-to-org/version.rb
 - lib/add-to-org/views/error.erb
 - lib/add-to-org/views/forbidden.erb
+- lib/add-to-org/views/layout.erb
 - lib/add-to-org/views/success.erb
 - script/bootstrap
 - script/cibuild
@@ -183,7 +216,7 @@ homepage: https://github.com/benbalter/add-to-org
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -198,9 +231,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.8
-signing_key: 
+rubygems_version: 3.2.28
+signing_key:
 specification_version: 4
 summary: A simple Oauth App to automatically add users to an organization
 test_files:

data/.ruby-version

@@ -1 +0,0 @@
-2.2.3