jekyll-auth 2.1.0 → 2.1.3

data/docs/getting-started.md

@@ -0,0 +1,63 @@
+## Getting Started
+
+### Create a GitHub Application
+
+1. Navigate to [the GitHub app registration page](https://github.com/settings/applications/new)
+2. Give your app a name
+3. Tell GitHub the URL you want the app to eventually live at. If using a free Heroku account, this will be something like <http://my-site.herokuapp.com>
+4. Specify the callback URL; should be like this: <https://my-site.herokuapp.com/auth/github/callback>; note that this is **https**, not http.
+5. Hit Save, but leave the page open, you'll need some of the information in a moment
+
+Remember the 'my-site' part for later on when using `heroku create`. Also, my-site is often called 'app-name' in Heroku documentation.
+
+### Add Jekyll Auth to your site
+
+1. Within your new site repository or orphaned github [branch](https://help.github.com/articles/creating-project-pages-manually/) (the branch could be named anything except 'gh-pages' since this would then be public on GitHub!), add `gem 'jekyll-auth'` to your `Gemfile` or if you don't already have a `Gemfile`, create a file called `Gemfile` in the root of your site's repository with the following content:
+
+   ```ruby
+   source "https://rubygems.org"
+
+   gem 'jekyll-auth'
+   ```
+
+2. `cd` into your project's directory and run `bundle install`. If you get an error using `bundle install`, see Troubleshooting below.
+
+3. Run `bundle exec jekyll-auth new` which will copy the necessary files to set up the server
+
+
+### Setting up hosting with Heroku
+
+#### Automatically
+
+Run `bundle exec jekyll-auth setup --client_id XXX --client_secret XXX --org_name XXX`
+
+(or `--team_id XXX`)
+
+#### Manually
+
+1. You may need to add and commit the files generated by `jekyll-auth new` to Git before continuing
+2. Make sure you have [the Heroku toolbelt](https://toolbelt.heroku.com/) installed
+3. Run `heroku create my-site` from your site's directory; make sure my-site matches what you specified in the GitHub application registration above.
+4. `heroku config:set GITHUB_CLIENT_ID=XXX GITHUB_CLIENT_SECRET=XXX GITHUB_ORG_NAME=XXX` (or `GITHUB_TEAM_ID`)
+5. `git push heroku`, or if you are maintaining the site in an orphaned branch of your GitHub repo (say 'heroku-pages'), do `git push heroku heroku-pages:master`
+6. `heroku open` to open the site in your browser
+
+#### Find the Organization ID (needed to find Team ID)
+
+If you need to find an organization's ID, you can use the following cURL command:
+
+```
+curl https://api.github.com/orgs/{org_name}
+```
+
+#### Finding the Team ID
+
+If you need help finding a team's numeric ID, you can use the `jekyll-auth team_id` command.
+
+For example, to find the team ID for @jekyll/maintainers you'd run the command:
+
+```
+jekyll-auth team_id --org jekyll --team maintainers
+```
+
+You'll want to add a [personal access token](https://github.com/settings/tokens/new) to your `.env` file so that Jekyll-Auth can make the necessary API request, but the command will run you through the process if you do not provide this.

data/docs/running-locally.md

@@ -0,0 +1,24 @@
+## Running locally
+
+Want to run it locally?
+
+### Without authentication
+
+Just run `jekyll serve` as you would normally.
+
+### With authentication
+
+1. `export GITHUB_CLIENT_ID=[your github app client id]`
+2. `export GITHUB_CLIENT_SECRET=[your github app client secret]`
+3. `export GITHUB_ORG_NAME=[org name]` or `export GITHUB_TEAM_ID=[team id]` or `export GITHUB_TEAM_IDS=1234,5678`
+4. `jekyll-auth serve`
+
+*Pro-tip #1:* For sanity's sake, and to avoid problems with your callback URL, you may want to have two apps, one with a local Oauth callback, and one for production if you're going to be testing auth locally.
+
+*Pro-tip #2*: Jekyll Auth supports [dotenv](https://github.com/bkeepers/dotenv) out of the box. You can create a `.env` file in the root of site and add your configuration variables there. It's ignored by `.gitignore` if you use `jekyll-auth new`, but be sure not to accidentally commit your `.env` file. Here's what your `.env` file might look like:
+
+```
+GITHUB_CLIENT_SECRET=abcdefghijklmnopqrstuvwxyz0123456789
+GITHUB_CLIENT_ID=qwertyuiop0001
+GITHUB_TEAM_ID=12345
+```

data/docs/troubleshooting.md

@@ -0,0 +1,31 @@
+## Troubleshooting
+
+### `ERROR: YOUR SITE COULD NOT BE BUILT` During install, either locally or on Heroku.
+
+You likely need to add `exclude: [vendor]` to `_config.yml` in your branch's root directory (create the file if it does not exist already). If you still have problems on the *local* install, you may have better luck using `bundle install --deployment`, but be sure to add the resulting 'vendor' directory to .gitignore. For completeness, the full error may look something like this:
+
+
+```
+remote:        Configuration file: none
+remote:                     ERROR: YOUR SITE COULD NOT BE BUILT:
+remote:                            ------------------------------------
+remote:                            Invalid date '0000-00-00': Post '/vendor/bundle/ruby/2.0.0/gems/jekyll-2.5.3/lib/site_template/_posts/0000-00-00-welcome-to-jekyll.markdown.erb' does not have a valid date in the filename.
+```
+
+### Pushing to heroku
+
+If you are working from a new GitHub-cloned repo (where you have not run `heroku create`), you may also want to push to Heroku. Instead of adding the remote in the standard way with Git, do this:
+
+
+```
+heroku git:remote -a my-site
+```
+
+### Upgrading from Jekyll Auth < 0.1.0
+
+1. `cd` to your project directory
+2. `rm config.ru`
+3. `rm Procfile`
+4. Remove any Jekyll Auth specific requirements from your `Gemfile`
+5. Follow [the instructions above](https://github.com/benbalter/jekyll-auth#add-jekyll-auth-to-your-site) to get started
+6. When prompted, select "n" if Heroku is already set up

data/jekyll-auth.gemspec

@@ -1,33 +1,38 @@
-require './lib/jekyll_auth/version'
+# frozen_string_literal: true
+
+require "./lib/jekyll_auth/version"
 
 Gem::Specification.new do |s|
-  s.name                  = 'jekyll-auth'
+  s.name                  = "jekyll-auth"
   s.version               = JekyllAuth::VERSION
-  s.summary               = 'A simple way to use GitHub OAuth to serve a protected jekyll site to your GitHub organization'
-  s.description           = 'A simple way to use GitHub OAuth to serve a protected jekyll site to your GitHub organization.'
-  s.authors               = 'Ben Balter'
-  s.email                 = 'ben@balter.com'
-  s.homepage              = 'https://github.com/benbalter/jekyll-auth'
-  s.license               = 'MIT'
+  s.summary               = "A simple way to use GitHub OAuth to serve a protected jekyll site to your GitHub organization"
+  s.description           = "A simple way to use GitHub OAuth to serve a protected jekyll site to your GitHub organization."
+  s.authors               = "Ben Balter"
+  s.email                 = "ben@balter.com"
+  s.homepage              = "https://github.com/benbalter/jekyll-auth"
+  s.license               = "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.require_paths         = ["lib"]
 
-  s.add_dependency 'jekyll', '~> 3.0'
-  s.add_dependency 'sinatra-index', '~> 0.0'
-  s.add_dependency 'sinatra_auth_github', '~> 1.1'
-  s.add_dependency 'rack', '~> 1.6'
-  s.add_dependency 'dotenv', '~> 2.0'
-  s.add_dependency 'rake', '~> 10.3'
-  s.add_dependency 'rack-ssl-enforcer', '~> 0.2'
-  s.add_dependency 'mercenary', '~> 0.3'
-  s.add_dependency 'safe_yaml', '~> 1.0'
-  s.add_dependency 'colorator', '~> 1.0'
-  s.add_dependency 'activesupport', '~> 4.0'
-  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_development_dependency 'rubocop', '~> 0.35'
+  s.add_dependency "activesupport", ">= 5", "< 8"
+  s.add_dependency "colorator", "~> 1.0"
+  s.add_dependency "dotenv", "~> 2.0"
+  s.add_dependency "jekyll", "~> 4.0"
+  s.add_dependency "mercenary", "~> 0.3"
+  s.add_dependency "rack", ">= 1.6", "< 3.0"
+  s.add_dependency "rack-protection", ">= 1.5.5", "< 3.0"
+  s.add_dependency "rack-ssl-enforcer", "~> 0.2"
+  s.add_dependency "rake", "~> 13.0"
+  s.add_dependency "safe_yaml", "~> 1.0"
+  s.add_dependency "sinatra-index", "~> 0.0"
+  s.add_dependency "sinatra_auth_github", ">= 1.1", "< 3.0"
+  s.add_development_dependency "pry", "~> 0.10"
+  s.add_development_dependency "rack-test", "~> 2.0"
+  s.add_development_dependency "rspec", "~> 3.1"
+  s.add_development_dependency "rubocop", "~> 0.49", ">= 0.49.0"
+  s.add_development_dependency "rubocop-jekyll", "~> 0.11.0"
+  s.add_development_dependency "rubocop-performance", "~> 1.0"
+  s.add_development_dependency "webmock", "~> 2.3 "
 end

data/lib/jekyll-auth.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "sinatra-index"
 require "sinatra_auth_github"
 require "dotenv"
@@ -11,6 +13,7 @@ require_relative "jekyll_auth/auth_site"
 require_relative "jekyll_auth/jekyll_site"
 require_relative "jekyll_auth/config_error"
 require_relative "jekyll_auth/commands"
+require_relative "jekyll_auth/sinatra/auth/github"
 
 Dotenv.load
 

data/lib/jekyll_auth/auth_site.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class JekyllAuth
   class AuthSite < Sinatra::Base
     configure :production do

data/lib/jekyll_auth/commands.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class JekyllAuth
   class Commands
     FILES = %w(Rakefile config.ru .gitignore .env).freeze
@@ -13,13 +15,14 @@ class JekyllAuth
 
     def self.changed?
       !execute_command("git", "status", destination, "--porcelain").empty?
-    rescue
+    rescue StandardError
       false
     end
 
     def self.execute_command(*args)
       output, status = Open3.capture2e(*args)
       raise "Command `#{args.join(" ")}` failed: #{output}" unless status.exitstatus.zero?
+
       output
     end
 
@@ -50,6 +53,7 @@ class JekyllAuth
       execute_command "git", "init", destination
       FILES.each do |file|
         next if file == ".env"
+
         execute_command("git", "add", "--", "#{destination}/#{file}")
       end
     end

data/lib/jekyll_auth/config.rb

@@ -1,23 +1,30 @@
+# frozen_string_literal: true
+
 class JekyllAuth
   def self.config_file
     File.join(Dir.pwd, "_config.yml")
   end
 
+  def self.jekyll_config
+    @config ||= YAML.safe_load_file(config_file)
+  rescue StandardError
+    {}
+  end
+
   def self.config
-    @config ||= begin
-      config = YAML.safe_load_file(config_file)
-      config["jekyll_auth"] || {}
-    rescue
-      {}
-    end
+    jekyll_config.fetch("jekyll_auth", {})
+  end
+
+  def self.destination
+    jekyll_config.fetch("destination", File.expand_path("_site", Dir.pwd))
   end
 
   def self.whitelist
-    whitelist = JekyllAuth.config["whitelist"]
+    whitelist = config["whitelist"]
     Regexp.new(whitelist.join("|")) unless whitelist.nil?
   end
 
   def self.ssl?
-    !!JekyllAuth.config["ssl"]
+    !!config["ssl"]
   end
 end

data/lib/jekyll_auth/config_error.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class JekyllAuth
   class ConfigError < RuntimeError
     def message

data/lib/jekyll_auth/helpers.rb

@@ -1,7 +1,10 @@
+# frozen_string_literal: true
+
 class JekyllAuth
   module Helpers
     def whitelisted?
       return true if request.path_info == "/logout"
+
       !!(JekyllAuth.whitelist && JekyllAuth.whitelist.match(request.path_info))
     end
 

data/lib/jekyll_auth/jekyll_site.rb

@@ -1,12 +1,14 @@
+# frozen_string_literal: true
+
 class JekyllAuth
   class JekyllSite < Sinatra::Base
     register Sinatra::Index
-    set :public_folder, File.expand_path("_site", Dir.pwd)
+    set :public_folder, File.expand_path(JekyllAuth.destination, Dir.pwd)
     use_static_index "index.html"
 
     not_found do
       status 404
-      four_oh_four = File.expand_path("_site/404.html", Dir.pwd)
+      four_oh_four = File.expand_path(settings.public_folder + "/404.html", Dir.pwd)
       File.read(four_oh_four) if File.exist?(four_oh_four)
     end
   end

data/lib/jekyll_auth/sinatra/auth/github.rb

@@ -1,10 +1,14 @@
+# frozen_string_literal: true
+
 module Sinatra
   module Auth
     module Github
-      # Like the native github_team_authenticate! but accepts an array of team ids
-      def github_teams_authenticate!(teams)
-        authenticate!
-        halt([401, "Unauthorized User"]) unless teams.any? { |team_id| github_team_access?(team_id) }
+      module Helpers
+        # Like the native github_team_authenticate! but accepts an array of team ids
+        def github_teams_authenticate!(teams)
+          authenticate!
+          halt([401, "Unauthorized User"]) unless teams.any? { |team_id| github_team_access?(team_id) }
+        end
       end
     end
   end

data/lib/jekyll_auth/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class JekyllAuth
-  VERSION = "2.1.0".freeze
+  VERSION = "2.1.3"
 end

data/spec/jekyll_auth_auth_site_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "spec_helper"
 
 describe "logged in user" do

data/spec/jekyll_auth_bin_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "spec_helper"
 
 describe "bin" do

data/spec/jekyll_auth_commands_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "spec_helper"
 
 describe "commands" do

data/spec/jekyll_auth_helpers_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "spec_helper"
 
 describe "strategies" do

data/spec/jekyll_auth_jekyll_site_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "spec_helper"
 
 describe "jekyll site" do
@@ -31,7 +33,7 @@ describe "jekyll site" do
   it "serves the default 404" do
     get "/a-bad-path"
     expect(last_response.status).to eql(404)
-    expect(last_response.body).to eql("<h1>Not Found</h1>")
+    expect(last_response.body).to match(%r!Not ?Found!i)
   end
 
   it "serves a custom 404" do

data/spec/jekyll_auth_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "spec_helper"
 
 describe "JekyllAuth" do

data/spec/spec_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "bundler/setup"
 require "fileutils"
 
@@ -46,6 +48,7 @@ end
 def execute_bin(env, *args)
   output, status = Open3.capture2e(env, bin_path, *args)
   raise "Command `#{bin_path} #{args.join(" ")}` failed: #{output}" if status != 0
+
   output
 end
 

data/templates/.gitignore

@@ -1,3 +1,2 @@
 _site
 .env
-/Gemfile.lock

data/templates/Rakefile

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 # This file is auto-generated by Jekyll Auth
 # Feel free to add additional Rake tasks so long as
 # `rake assets:precompile` continues to generate the jekyll site
 
 namespace :assets do
   task :precompile do
-    sh 'bundle exec jekyll-auth build'
+    sh "bundle exec jekyll-auth build"
   end
 end

data/templates/config.ru

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 # This file is auto-generated by Jekyll Auth
 # It tells Heroku how to launch our site
 
-require 'jekyll-auth'
+require "jekyll-auth"
 run JekyllAuth.site