add-to-org 3.0.1 → 3.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 95d00b99b3102b0f8ff7ac6060e294cd43cf0160
-  data.tar.gz: 7ca4573c5288b5da29d255a117e02323b0baf4b9
+SHA256:
+  metadata.gz: d6e1d519910bd9dae03bcb2c8cea47fcebb6fb188c48d7103dfec6e1a40df664
+  data.tar.gz: 5ef8eb34932716326573c30beb922c55b2549bf5cb2d0ce2cd273ddd8ef409b1
 SHA512:
-  metadata.gz: 20d4348d9c16cf275cc1e6f81624ad045ec47b70c350bcaa30720e85c0baa0347020fed3abc489da849228f0023df49b971fe7bff952351c8d8c8295076faece
-  data.tar.gz: 1006dd88963ab9ac61d91b422d2c4c5296bf6d261dad051b5390280cdaeb56888e6b14a7379b9d7b211a34b725c7acd2010843db3bb81c0da879417b72e43279
+  metadata.gz: 336633b4e2062a6e8de5411bf38ae7cab6b085a626b7af679f83a880d5781d3713933df4bf5434d2b3f09b532dafe177364f88e02274fd2c8657540acfa7b983
+  data.tar.gz: 4b41e21b69c44f9109b47ba0408dc6ff63400d481bbc5738be4a035c35a0597a1e41d0d2045942749dba06fcf769d8e01561a6908a7b0009666f8e0cff6ce5b6

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/.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/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

@@ -9,7 +9,5 @@
   "moduleType": [],
   "license": "MIT",
   "private": true,
-  "dependencies": {
-    "bootstrap": "~3.3.6"
-  }
+  "dependencies": {}
 }

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

@@ -1,10 +1,11 @@
+# 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 { |email| email.verified }
+      emails = client.emails accept: 'application/vnd.github.v3'
+      emails.select(&:verified)
     end
 
     def valid?
@@ -15,12 +16,12 @@ module AddToOrg
 
     # user client
     def client
-      @client ||= Octokit::Client.new :access_token => github_user.token
+      @client ||= Octokit::Client.new access_token: github_user.token
     end
 
     # org admin client
     def sudo_client
-      @sudo_client ||= Octokit::Client.new :access_token => ENV['GITHUB_TOKEN']
+      @sudo_client ||= Octokit::Client.new access_token: ENV['GITHUB_TOKEN']
     end
 
     # true if user is already a member of the org

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

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

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

@@ -2,22 +2,11 @@
 <html lang="en">
   <head>
     <meta charset="utf-8">
-    <meta http-equiv="X-UA-Compatible" content="IE=edge">
-    <meta name="viewport" content="width=device-width, initial-scale=1">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
     <title>Join <%= ENV['GITHUB_ORG_ID'] %></title>
-
-    <link rel="stylesheet" href="/vendor/bootstrap/dist/css/bootstrap.min.css">
-    <link rel="stylesheet" href="/vendor/bootstrap/dist/css/bootstrap-theme.min.css">
     <style>
       body { text-align: center; padding-top: 100px; }
     </style>
-
-    <!-- HTML5 shim and Respond.js for IE8 support of HTML5 elements and media queries -->
-    <!-- WARNING: Respond.js doesn't work if you view the page via file:// -->
-    <!--[if lt IE 9]>
-      <script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js"></script>
-      <script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
-    <![endif]-->
   </head>
   <body>
     <div class="container">

data/lib/add-to-org.rb

@@ -1,16 +1,17 @@
+# frozen_string_literal: true
+
 require 'octokit'
 require 'sinatra_auth_github'
 require 'dotenv'
 require_relative 'add-to-org/helpers'
 
 module AddToOrg
-
   def self.root
-    File.expand_path "./add-to-org", File.dirname(__FILE__)
+    File.expand_path './add-to-org', File.dirname(__FILE__)
   end
 
   def self.views_dir
-    @views_dir ||= File.expand_path "views", AddToOrg.root
+    @views_dir ||= File.expand_path 'views', AddToOrg.root
   end
 
   def self.views_dir=(dir)
@@ -18,7 +19,7 @@ module AddToOrg
   end
 
   def self.public_dir
-    @public_dir ||= File.expand_path "public", AddToOrg.root
+    @public_dir ||= File.expand_path 'public', AddToOrg.root
   end
 
   def self.public_dir=(dir)
@@ -34,28 +35,27 @@ module AddToOrg
   end
 
   def self.validator
-    @validator ||= Proc.new { raise "You must define a custom validator to determine eligibility" }
+    @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, Proc.new { AddToOrg.views_dir }
-    set :root,  Proc.new { AddToOrg.root }
-    set :public_folder, Proc.new { AddToOrg.public_dir }
+    set :views, proc { AddToOrg.views_dir }
+    set :root,  proc { AddToOrg.root }
+    set :public_folder, proc { AddToOrg.public_dir }
 
     # require ssl
     configure :production do
@@ -65,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
@@ -84,14 +84,13 @@ 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

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,85 +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
+  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")
+    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
+  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")
+      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.send(: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.send(: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.send(: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.send(: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.send(: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
-    stub_request(:get, "https://api.github.com/user/emails").
-      to_return(:status => 200, :body => fixture("emails.json"), :headers => { 'Content-Type'=>'application/json' })
+  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"
+    error = 'You must define a custom validator to determine eligibility'
     expect { @helper.valid? }.to raise_error(error)
   end
 end