jekyll-auth 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b2bc3f1b5a01a023ce6a06707d67be186171eb2c
-  data.tar.gz: 944440d4dc8586bb5ce652bfcae1d98135169411
+  metadata.gz: 5252fb3ba4db62cb22f5f9949f54a2e0612ed060
+  data.tar.gz: ae51f402692073b5b79942f62af6885533bf41fc
 SHA512:
-  metadata.gz: 035f53918722a1a28072452343193a39269dab8785e0592965cce0b24c099119fd2518c2f4fce6de27225d19254b20484c8aa337a181e4da85313ef7f33b6ba7
-  data.tar.gz: 975a8e9ffb1a8c64aa6d2ba2fd30bdfe29dc9dcdf73ade840f5e882ac9f519b0a135e561438245ccb8bad7b9ebb4558e92c429a34c223ff15421921373657269
+  metadata.gz: c85daf40909c0eca989d2c468fd68edc67d4fea09b197f64dd06194f9bfb6a045849e8766720427ba683023b80ba58e154de8d9952c2a65cd3054640e13291d8
+  data.tar.gz: 1409e332aca6db366fa2dc1c4c8a00aea75e5dbd38f78800b21eb78f4c71ffe64d94790f8b5903758c427ba7de188db89bd2f8b1898f9c0165989d3f423e57c3

data/.rubocop.yml

@@ -0,0 +1,20 @@
+inherit_gem:
+  jekyll: .rubocop.yml
+
+Style/Documentation:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/LineLength:
+  Enabled: false
+
+Style/FileName:
+  Enabled: false
+  
+Metrics/BlockLength:
+  Enabled: false
+
+Style/DoubleNegation:
+  Enabled: false

data/Gemfile

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

data/README.md

@@ -23,21 +23,21 @@ But what if you only want to share that site with a select number of people? Bef
 
 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.
+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 documenation.
+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:
+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"
+   ```ruby
+   source "https://rubygems.org"
 
-  gem 'jekyll-auth'
-  ```
+   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. 
 
@@ -55,20 +55,20 @@ Run `bundle exec jekyll-auth setup --client_id XXX --client_secret XXX --org_nam
 
 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 Githup application registration above.
+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`
+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)
+#### 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:
+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
+#### Finding the Team ID
 
 If you need help finding a team's numeric ID, you can use the `jekyll-auth team_id` command.
 
@@ -78,13 +78,13 @@ 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 dont.
+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.
 
 ## Configuration
 
 ### Whitelisting
 
-Don't want to require authentication for every part of your site? Fine! Add a whitelist to your Jekyll's *_config.yml_* file:
+Don't want to require authentication for every part of your site? Fine! Add a whitelist to your Jekyll's **config.yml** file:
 
 ```yaml
 jekyll_auth:
@@ -94,7 +94,7 @@ jekyll_auth:
 
 `jekyll_auth.whitelist` takes an array of regular expressions as strings. The default auth behavior checks (and blocks) against root (`/`). Any path defined in the whitelist won't require authentication on your site.
 
-What if you want to go the other way, and unauthenticate the entire site _except_ for certain portions? You can define some regex magic for that:
+What if you want to go the other way, and unauthenticate the entire site *except* for certain portions? You can define some regex magic for that:
 
 ```yaml
 jekyll_auth:
@@ -123,7 +123,7 @@ Want to run it locally?
 
 ### Without authentication
 
-Just run `jekyll serve` as you would normally
+Just run `jekyll serve` as you would normally.
 
 ### With authentication
 
@@ -132,7 +132,7 @@ Just run `jekyll serve` as you would normally
 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 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 #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:
 
@@ -146,11 +146,11 @@ GITHUB_TEAM_ID=12345
 
 Every time you push to Heroku, we take advantage of the fact that Heroku automatically runs the `rake assets:precompile` command (normally used for Rails sites) to build our Jekyll site and store it statically, just like GitHub pages would.
 
-Anytime a request comes in for a page, we run it through [Sinatra](http://www.sinatrarb.com/) (using the `_site` folder as the static file folder, just as `public` would be normally), and authenticate it using [sinatra_auth_github](https://github.com/atmos/sinatra_auth_github).
+Anytime a request comes in for a page, we run it through [Sinatra](http://www.sinatrarb.com/) (using the `_site` folder as the static file folder, just as `public` would be normally), and authenticate it using [sinatra\_auth\_github](https://github.com/atmos/sinatra_auth_github).
 
 If they're in the org, they get the page. Otherwise, all they ever get is [the bouncer](http://octodex.github.com/bouncer/).
 
-## Upgrading from Jekyll Auth < 0.1.0
+## Upgrading from Jekyll Auth &lt; 0.1.0
 
 1. `cd` to your project directory
 2. `rm config.ru`
@@ -163,6 +163,7 @@ If they're in the org, they get the page. Otherwise, all they ever get is [the b
 
 * **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:
@@ -170,10 +171,9 @@ 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. You do not add the remote in the standard way using git, but instead do this: 
+* **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 
 ```
-
-

data/Rakefile

@@ -4,17 +4,17 @@ require 'bundler'
 require 'fileutils'
 require 'dotenv'
 
-task :default => [:spec]
+task default: [:spec]
 
 task :site do
   Dotenv.load
-  FileUtils.chdir "templates"
+  FileUtils.chdir 'templates'
   `bundle exec jekyll-auth`
 end
 
 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/bin/jekyll-auth

@@ -1,20 +1,19 @@
 #!/usr/bin/env ruby
 # Command-line interface for jekyll-auth
 
-require 'mercenary'
-require 'jekyll-auth'
-require 'open3'
+require "mercenary"
+require "jekyll-auth"
+require "open3"
 
 Mercenary.program("jekyll-auth") do |p|
-  p.version     JekyllAuth::VERSION
+  p.version JekyllAuth::VERSION
   p.description "A simple way to use Github OAuth to serve a protected jekyll site to your GitHub organization"
-  p.syntax      'jekyll-auth <subcommand> options'
+  p.syntax "jekyll-auth <subcommand> options"
 
   p.command(:new) do |c|
-    c.syntax 'new'
+    c.syntax "new"
     c.description "Initialize an existing Jekyll site as a Jekyll Auth site"
-    c.action do |args, options|
-
+    c.action do |_args, _options|
       JekyllAuth::Commands.copy_templates
 
       if JekyllAuth::Commands.changed?
@@ -29,23 +28,22 @@ Mercenary.program("jekyll-auth") do |p|
   # Called by Rake task, to allow the gem
   # to add functionality here in the future
   p.command(:build) do |c|
-    c.syntax 'build'
+    c.syntax "build"
     c.description "Build the Jekyll site"
-    c.action do |args, options|
-      require 'jekyll'
+    c.action do |_args, options|
+      require "jekyll"
       Jekyll::Commands::Build.process(options)
     end
   end
 
   p.command(:team_id) do |c|
-    c.syntax 'team_id --org <ORG> --team <TEAM>'
+    c.syntax "team_id --org <ORG> --team <TEAM>"
     c.description "Retrieve a team's ID"
-    c.option 'org', '--org <ORG>', 'The GitHub Organization, e.g., "jekyll"'
-    c.option 'team', '--team <TEAM>', 'The team name, e.g., "maintainers"'
-
-    c.action do |args, options|
+    c.option "org", "--org <ORG>", 'The GitHub Organization, e.g., "jekyll"'
+    c.option "team", "--team <TEAM>", 'The team name, e.g., "maintainers"'
 
-      if !JekyllAuth::Commands.env_var_set? "GITHUB_TOKEN"
+    c.action do |_args, options|
+      unless JekyllAuth::Commands.env_var_set? "GITHUB_TOKEN"
         puts "You'll need to go to https://github.com/settings/tokens/new and create a personal access token".red
         puts "Once you've got the token, prefix the jekyll-auth command with GITHUB_TOKEN=[YOUR TOKEN]".red
         puts "You can also add it to a `.env` file in this directory".red
@@ -74,10 +72,12 @@ Mercenary.program("jekyll-auth") do |p|
   p.command(:serve) do |c|
     c.syntax "serve"
     c.description "Run Jekyll Auth site locally"
-    c.action do |args, options|
+    c.option "host", "--host <HOST>", "Listen at the given hostname, e.g., 127.0.0.1"
+    c.option "port", "--port <PORT>", "Listen on the given port, e.g., 4000"
 
+    c.action do |_args, options|
       # Ensure environmental variables are set
-      unless ["GITHUB_CLIENT_ID", "GITHUB_CLIENT_SECRET"].all? { |v| JekyllAuth::Commands.env_var_set?(v) }
+      unless %w(GITHUB_CLIENT_ID GITHUB_CLIENT_SECRET).all? { |v| JekyllAuth::Commands.env_var_set?(v) }
         puts "Whoops. Looks like you forgot to tell Jekyll Auth about your app".red
         puts "Be sure to run export GITHUB_CLIENT_ID=[client id], export GITHUB_CLIENT_SECRET=[client secret], and export GITHUB_ORG_NAME=[org name] (or GITHUB_TEAM_ID)".red
         puts "See the readme for more information on where to find these".red
@@ -87,10 +87,12 @@ Mercenary.program("jekyll-auth") do |p|
       # build site
       p.go ["build"]
 
+      host = options["host"] || "0.0.0.0"
+      port = options["port"] || "4000"
+
       puts "Spinning up the server with authentication. Use CTRL-C to stop."
       puts "To preview the site without authentication, use the `jekyll serve` command"
-      JekyllAuth::Commands.execute_command "bundle", "exec", "rackup", "-p", "4000"
-
+      JekyllAuth::Commands.execute_command "bundle", "exec", "rackup", "-o", host, "-p", port
     end
   end
 
@@ -101,8 +103,7 @@ Mercenary.program("jekyll-auth") do |p|
     c.option "client_secret", "--client_secret", "Your oauth app client secret"
     c.option "team_id", "--team_id", "The team to authenticate against"
     c.option "org_name", "--org_name", "An organization to authenticate against"
-    c.action do |args, options|
-
+    c.action do |_args, options|
       if find_executable("heroku").nil?
         say "Looks like we're missing the Heroku client. Let's see if we can't install it..."
         JekyllAuth::Commands.execute_command "wget", "-qO-", "https://toolbelt.heroku.com/install.sh", "|", "sh"

data/jekyll-auth.gemspec

@@ -1,31 +1,33 @@
 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.executables           = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
+  s.require_paths         = ['lib']
 
-  s.add_dependency "jekyll", ">= 2.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", "~> 0.1"
-  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 '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'
 end

data/lib/jekyll-auth.rb

@@ -1,16 +1,16 @@
-require 'sinatra-index'
-require 'sinatra_auth_github'
-require 'dotenv'
-require 'safe_yaml'
-require 'colorator'
-require 'mkmf'
-require_relative 'jekyll_auth/version'
-require_relative 'jekyll_auth/helpers'
-require_relative 'jekyll_auth/config'
-require_relative 'jekyll_auth/auth_site'
-require_relative 'jekyll_auth/jekyll_site'
-require_relative 'jekyll_auth/config_error'
-require_relative 'jekyll_auth/commands'
+require "sinatra-index"
+require "sinatra_auth_github"
+require "dotenv"
+require "safe_yaml"
+require "colorator"
+require "mkmf"
+require_relative "jekyll_auth/version"
+require_relative "jekyll_auth/helpers"
+require_relative "jekyll_auth/config"
+require_relative "jekyll_auth/auth_site"
+require_relative "jekyll_auth/jekyll_site"
+require_relative "jekyll_auth/config_error"
+require_relative "jekyll_auth/commands"
 
 Dotenv.load
 

data/lib/jekyll_auth/auth_site.rb

@@ -1,21 +1,16 @@
 class JekyllAuth
   class AuthSite < Sinatra::Base
-
     configure :production do
-      require 'rack-ssl-enforcer'
+      require "rack-ssl-enforcer"
       use Rack::SslEnforcer if JekyllAuth.ssl?
     end
 
-    use Rack::Session::Cookie, {
-      :http_only => true,
-      :secret    => ENV['SESSION_SECRET'] || SecureRandom.hex
-    }
+    use Rack::Session::Cookie,       :http_only => true,
+                                     :secret    => ENV["SESSION_SECRET"] || SecureRandom.hex
 
-    set :github_options, {
-      :scopes    => 'read:org'
-    }
+    set :github_options, :scopes => "read:org"
 
-    ENV['WARDEN_GITHUB_VERIFIER_SECRET'] ||= SecureRandom.hex
+    ENV["WARDEN_GITHUB_VERIFIER_SECRET"] ||= SecureRandom.hex
     register Sinatra::Auth::Github
 
     use Rack::Logger
@@ -29,19 +24,19 @@ class JekyllAuth
 
       case authentication_strategy
       when :team
-        github_team_authenticate! ENV['GITHUB_TEAM_ID']
+        github_team_authenticate! ENV["GITHUB_TEAM_ID"]
       when :teams
-        github_teams_authenticate! ENV['GITHUB_TEAM_IDS'].split(",")
+        github_teams_authenticate! ENV["GITHUB_TEAM_IDS"].split(",")
       when :org
-        github_organization_authenticate! ENV['GITHUB_ORG_NAME']
+        github_organization_authenticate! ENV["GITHUB_ORG_NAME"]
       else
         raise JekyllAuth::ConfigError
       end
     end
 
-    get '/logout' do
+    get "/logout" do
       logout!
-      redirect '/'
+      redirect "/"
     end
   end
 end

data/lib/jekyll_auth/commands.rb

@@ -1,11 +1,10 @@
 class JekyllAuth
   class Commands
-
-    FILES = %w{Rakefile config.ru .gitignore .env}
-    VARS  = %w{client_id client_secret team_id org_name}
+    FILES = %w(Rakefile config.ru .gitignore .env).freeze
+    VARS  = %w(client_id client_secret team_id org_name).freeze
 
     def self.source
-      @source ||= File.expand_path( "../../templates", File.dirname(__FILE__) )
+      @source ||= File.expand_path("../../templates", File.dirname(__FILE__))
     end
 
     def self.destination
@@ -13,14 +12,14 @@ class JekyllAuth
     end
 
     def self.changed?
-      execute_command("git", "status", destination, "--porcelain").length != 0
+      !execute_command("git", "status", destination, "--porcelain").empty?
     rescue
       false
     end
 
     def self.execute_command(*args)
       output, status = Open3.capture2e(*args)
-      raise "Command `#{args.join(" ")}` failed: #{output}" if status != 0
+      raise "Command `#{args.join(" ")}` failed: #{output}" unless status.exitstatus.zero?
       output
     end
 
@@ -44,7 +43,7 @@ class JekyllAuth
     end
 
     def self.env_var_set?(var)
-      !(ENV[var].to_s.blank?)
+      !ENV[var].to_s.blank?
     end
 
     def self.init_repo
@@ -61,7 +60,7 @@ class JekyllAuth
 
     def self.heroku_remote_set?
       remotes = execute_command "git", "remote", "-v"
-      !!(remotes =~ /^heroku\s/)
+      !!(remotes =~ %r!^heroku\s!)
     end
 
     def self.configure_heroku(options)

data/lib/jekyll_auth/config.rb

@@ -13,11 +13,11 @@ class JekyllAuth
   end
 
   def self.whitelist
-    whitelist = JekyllAuth::config["whitelist"]
+    whitelist = JekyllAuth.config["whitelist"]
     Regexp.new(whitelist.join("|")) unless whitelist.nil?
   end
 
   def self.ssl?
-    !!JekyllAuth::config["ssl"]
+    !!JekyllAuth.config["ssl"]
   end
 end

data/lib/jekyll_auth/config_error.rb

@@ -1,6 +1,5 @@
 class JekyllAuth
-  class ConfigError < SecurityError
-
+  class ConfigError < RuntimeError
     def message
       "Jekyll Auth is refusing to serve your site because your oauth credentials are not properly configured."
     end

data/lib/jekyll_auth/helpers.rb

@@ -6,11 +6,11 @@ class JekyllAuth
     end
 
     def authentication_strategy
-      if !ENV['GITHUB_TEAM_ID'].to_s.blank?
+      if !ENV["GITHUB_TEAM_ID"].to_s.blank?
         :team
-      elsif !ENV['GITHUB_TEAM_IDS'].to_s.blank?
+      elsif !ENV["GITHUB_TEAM_IDS"].to_s.blank?
         :teams
-      elsif !ENV['GITHUB_ORG_NAME'].to_s.blank?
+      elsif !ENV["GITHUB_ORG_NAME"].to_s.blank?
         :org
       end
     end

data/lib/jekyll_auth/jekyll_site.rb

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

data/lib/jekyll_auth/version.rb

@@ -1,3 +1,3 @@
 class JekyllAuth
-  VERSION = '2.0.0'
+  VERSION = "2.1.0".freeze
 end

data/script/cibuild

@@ -3,6 +3,11 @@
 
 set -e
 
+export GITHUB_CLIENT_ID=FOO
+export GITHUB_CLIENT_SECRET=BAR
+export GITHUB_ORG_NAME="balter-test-org"
+
 bundle exec rake spec
+bundle exec rubocop
 bundle exec gem build jekyll-auth.gemspec
 bundle exec jekyll-auth --version

data/spec/jekyll_auth_auth_site_spec.rb

@@ -9,34 +9,32 @@ describe "logged in user" do
 
   before(:each) do
     setup_tmp_dir
-    @user = make_user('login' => 'benbaltertest')
+    @user = make_user("login" => "benbaltertest")
     login_as @user
 
-    ENV['GITHUB_ORG_NAME'] = "balter-test-org"
-    
-    stub_request(:get, "https://api.github.com/orgs/#{ENV["GITHUB_ORG_NAME"]}/members/benbaltertest").
-    to_return(:status => 200)
+    ENV["GITHUB_ORG_NAME"] = "balter-test-org"
+
+    stub_request(:get, "https://api.github.com/orgs/#{ENV["GITHUB_ORG_NAME"]}/members/benbaltertest")
+      .to_return(:status => 200)
   end
 
   it "shows the securocat when github returns an oauth error" do
     get "/auth/github/callback?error=redirect_uri_mismatch"
-    expect(last_response.body).to match(%r{securocat\.png})
+    expect(last_response.body).to match(%r!securocat\.png!)
   end
 
   it "logs the user out" do
     get "/logout"
     expect(last_response.status).to eql(302)
-    expect(last_response.headers['Location']).to eql("http://example.org/")
+    expect(last_response.headers["Location"]).to eql("http://example.org/")
 
     get "/"
     expect(last_response.status).to eql(302)
-    expect(last_response.headers['Location']).to match(%r{^https://github\.com/login/oauth/authorize})
+    expect(last_response.headers["Location"]).to match(%r!^https://github\.com/login/oauth/authorize!)
   end
-
 end
 
 describe "logged out user" do
-
   include Rack::Test::Methods
 
   def app
@@ -44,33 +42,33 @@ describe "logged out user" do
   end
 
   before do
-    ENV['GITHUB_ORG_NAME'] = "balter-test-org"
+    ENV["GITHUB_ORG_NAME"] = "balter-test-org"
   end
 
   it "doesn't let you view indexes" do
     get "/"
     expect(last_response.status).to eql(302)
-    expect(last_response.headers['Location']).to match(%r{^https://github\.com/login/oauth/authorize})
+    expect(last_response.headers["Location"]).to match(%r!^https://github\.com/login/oauth/authorize!)
 
     get "/some_dir"
     expect(last_response.status).to eql(302)
-    expect(last_response.headers['Location']).to match(%r{^https://github\.com/login/oauth/authorize})
+    expect(last_response.headers["Location"]).to match(%r!^https://github\.com/login/oauth/authorize!)
   end
 
   it "doesn't let you view files" do
     get "/index.html"
     expect(last_response.status).to eql(302)
-    expect(last_response.headers['Location']).to match(%r{^https://github\.com/login/oauth/authorize})
+    expect(last_response.headers["Location"]).to match(%r!^https://github\.com/login/oauth/authorize!)
 
     get "/some_dir/index.html"
     expect(last_response.status).to eql(302)
-    expect(last_response.headers['Location']).to match(%r{^https://github\.com/login/oauth/authorize})
+    expect(last_response.headers["Location"]).to match(%r!^https://github\.com/login/oauth/authorize!)
   end
 
   it "refuses to serve the site without an authentication strategy" do
     ENV["GITHUB_ORG_NAME"] = nil
     ENV["GITHUB_TEAM_ID"] = nil
     ENV["GITHUB_TEAMS_ID"] = nil
-    expect{get "/"}.to raise_error(JekyllAuth::ConfigError)
+    expect { get "/" }.to raise_error(JekyllAuth::ConfigError)
   end
 end

data/spec/jekyll_auth_bin_spec.rb

@@ -6,23 +6,22 @@ describe "bin" do
   end
 
   it "spits out the help do" do
-    env = { "GITHUB_TOKEN" => nil}
+    env = { "GITHUB_TOKEN" => nil }
     output = execute_bin(env, "--help")
-    expect(output).to match(%r{A simple way to use Github OAuth to serve a protected jekyll site to your GitHub organization})
+    expect(output).to match(%r!A simple way to use Github OAuth to serve a protected jekyll site to your GitHub organization!)
   end
 
   describe "team id" do
-
     it "errors if no token is given" do
-      env = { "GITHUB_TOKEN" => nil}
-      expect{execute_bin(env, "team_id", "--org", "balter-test-org", "--team", "1")}.to raise_error(RuntimeError).
-      with_message(/prefix the jekyll-auth command with GITHUB_TOKEN/)
+      env = { "GITHUB_TOKEN" => nil }
+      expect { execute_bin(env, "team_id", "--org", "balter-test-org", "--team", "1") }.to raise_error(RuntimeError)
+        .with_message(%r!prefix the jekyll-auth command with GITHUB_TOKEN!)
     end
 
     it "errors if no team_id or org_name is given" do
-      env = { "GITHUB_TOKEN" => "1234"}
-      expect{execute_bin(env, "team_id")}.to raise_error(RuntimeError).
-      with_message(/An org name and team ID are required/)
+      env = { "GITHUB_TOKEN" => "1234" }
+      expect { execute_bin(env, "team_id") }.to raise_error(RuntimeError)
+        .with_message(%r!An org name and team ID are required!)
     end
   end
 
@@ -30,7 +29,7 @@ describe "bin" do
     `git init`
     `git add .`
     `git commit -m 'initial commit'`
-    execute_bin({"RACK_ENV" => "TEST"}, "new")
+    execute_bin({ "RACK_ENV" => "TEST" }, "new")
     expect(File).to exist("#{tmp_dir}/config.ru")
     expect(File).to exist("#{tmp_dir}/Rakefile")
     expect(File).to exist("#{tmp_dir}/.gitignore")

data/spec/jekyll_auth_commands_spec.rb

@@ -1,7 +1,6 @@
 require "spec_helper"
 
 describe "commands" do
-
   before do
     setup_tmp_dir
   end
@@ -16,12 +15,12 @@ describe "commands" do
   end
 
   it "should execute a command" do
-    expect(JekyllAuth::Commands.execute_command("ls")).to match(/index\.html/)
+    expect(JekyllAuth::Commands.execute_command("ls")).to match(%r!index\.html!)
   end
 
   it "should retrieve a team's ID" do
-    stub_request(:get, "https://api.github.com/orgs/batler-test-org/teams?per_page=100").
-    to_return(:status => 204, :body => [{:slug => "test-team", :id => 1}])
+    stub_request(:get, "https://api.github.com/orgs/batler-test-org/teams?per_page=100")
+      .to_return(:status => 204, :body => [{ :slug => "test-team", :id => 1 }])
     expect(JekyllAuth::Commands.team_id("batler-test-org", "test-team")).to eql(1)
   end
 
@@ -71,6 +70,6 @@ describe "commands" do
     `git add foo.md`
     JekyllAuth::Commands.initial_commit
     output = JekyllAuth::Commands.execute_command "git", "log"
-    expect(output).to match(/\[Jekyll Auth\] Initial setup/)
+    expect(output).to match(%r!\[Jekyll Auth\] Initial setup!)
   end
 end

data/spec/jekyll_auth_helpers_spec.rb

@@ -1,11 +1,10 @@
 require "spec_helper"
 
 describe "strategies" do
-
   class TestHelper
     include JekyllAuth::Helpers
 
-    def initialize(path=nil)
+    def initialize(path = nil)
       @path = path
     end
 

data/spec/jekyll_auth_jekyll_site_spec.rb

@@ -40,5 +40,4 @@ describe "jekyll site" do
     expect(last_response.status).to eql(404)
     expect(last_response.body).to eql("My custom 404")
   end
-
 end

data/spec/jekyll_auth_spec.rb

@@ -1,10 +1,9 @@
 require "spec_helper"
 
 describe "JekyllAuth" do
-
   before(:each) do
     setup_tmp_dir
-    JekyllAuth.instance_variable_set("@config",nil)
+    JekyllAuth.instance_variable_set("@config", nil)
   end
 
   it "should know the config file path" do
@@ -23,7 +22,7 @@ describe "JekyllAuth" do
 
   it "should return the config hash if the config files contains jekyll_auth" do
     File.write(JekyllAuth.config_file, "jekyll_auth:\n  ssl: true\n  whitelist:\n   - drafts?\n")
-    expect(JekyllAuth.config).to eql({"ssl"=>true, "whitelist"=>["drafts?"]})
+    expect(JekyllAuth.config).to eql("ssl" => true, "whitelist" => ["drafts?"])
   end
 
   it "should disable ssl by default" do
@@ -42,6 +41,6 @@ describe "JekyllAuth" do
 
   it "should parse the whitelist" do
     File.write(JekyllAuth.config_file, "jekyll_auth:\n  whitelist:\n   - drafts?\n")
-    expect(JekyllAuth.whitelist).to eql(/drafts?/)
+    expect(JekyllAuth.whitelist).to eql(%r!drafts?!)
   end
 end

data/spec/spec_helper.rb

@@ -1,15 +1,15 @@
 require "bundler/setup"
-require 'fileutils'
+require "fileutils"
 
-ENV['RACK_ENV'] = 'test'
-$:.push File.join(File.dirname(__FILE__), '..', 'lib')
+ENV["RACK_ENV"] = "test"
+$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 'dotenv'
-require 'open3'
+require "rack/test"
+require "sinatra/auth/github"
+require "sinatra/auth/github/test/test_helper"
+require "webmock/rspec"
+require "dotenv"
+require "open3"
 
 def base_dir
   File.expand_path "../", File.dirname(__FILE__)
@@ -50,6 +50,8 @@ def execute_bin(env, *args)
 end
 
 Dotenv.load
+ENV["GITHUB_CLIENT_ID"] ||= "IGNORE"
+ENV["GITHUB_CLIENT_SECRET"] ||= "IGNORE"
 setup_tmp_dir
 
 require_relative "../lib/jekyll-auth"

data/templates/Rakefile

@@ -4,6 +4,6 @@
 
 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,5 @@
 # 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

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-auth
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Ben Balter
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-11 00:00:00.000000000 Z
+date: 2016-10-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: sinatra-index
   requirement: !ruby/object:Gem::Requirement
@@ -142,14 +142,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -206,6 +220,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.35'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.35'
 description: A simple way to use GitHub OAuth to serve a protected jekyll site to
   your GitHub organization.
 email: ben@balter.com
@@ -215,6 +243,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rubocop.yml"
 - ".travis.yml"
 - Gemfile
 - README.md
@@ -268,7 +297,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.0
+rubygems_version: 2.6.7
 signing_key: 
 specification_version: 4
 summary: A simple way to use GitHub OAuth to serve a protected jekyll site to your
@@ -281,4 +310,3 @@ test_files:
 - spec/jekyll_auth_jekyll_site_spec.rb
 - spec/jekyll_auth_spec.rb
 - spec/spec_helper.rb
-has_rdoc: