jekyll-auth 1.0.2 → 2.1.2

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,6 +1,7 @@
-class JekyllAuth
-  class ConfigError < SecurityError
+# frozen_string_literal: true
 
+class JekyllAuth
+  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

@@ -1,16 +1,19 @@
+# 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
 
     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_ID'].to_s.blank?
+      elsif !ENV["GITHUB_ORG_NAME"].to_s.blank?
         :org
       end
     end

data/lib/jekyll_auth/jekyll_site.rb

@@ -1,14 +1,15 @@
+# frozen_string_literal: true
+
 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(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)
-      File.read(four_oh_four) if File.exists?(four_oh_four)
+      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
 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 = '1.0.2'
+  VERSION = "2.1.2"
 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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "spec_helper"
 
 describe "logged in user" do
@@ -9,34 +11,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_ID'] = "balter-test-org"
-    
-    stub_request(:get, "https://api.github.com/orgs/#{ENV["GITHUB_ORG_ID"]}/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 +44,33 @@ describe "logged out user" do
   end
 
   before do
-    ENV['GITHUB_ORG_ID'] = "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_ID"] = nil
+    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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "spec_helper"
 
 describe "bin" do
@@ -6,23 +8,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_id 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/)
+    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(%r!An org name and team ID are required!)
     end
   end
 
@@ -30,7 +31,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,8 @@
+# frozen_string_literal: true
+
 require "spec_helper"
 
 describe "commands" do
-
   before do
     setup_tmp_dir
   end
@@ -16,12 +17,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 +72,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,12 @@
+# frozen_string_literal: true
+
 require "spec_helper"
 
 describe "strategies" do
-
   class TestHelper
     include JekyllAuth::Helpers
 
-    def initialize(path=nil)
+    def initialize(path = nil)
       @path = path
     end
 
@@ -17,7 +18,7 @@ describe "strategies" do
   before(:each) do
     JekyllAuth.instance_variable_set("@config", nil)
     @helper = TestHelper.new
-    ENV["GITHUB_ORG_ID"] = nil
+    ENV["GITHUB_ORG_NAME"] = nil
     ENV["GITHUB_TEAM_ID"] = nil
     ENV["GITHUB_TEAMS_ID"] = nil
   end
@@ -27,7 +28,7 @@ describe "strategies" do
   end
 
   it "should detect the org strategy" do
-    with_env("GITHUB_ORG_ID", "some_org") do
+    with_env("GITHUB_ORG_NAME", "some_org") do
       expect(@helper.authentication_strategy).to eql(:org)
     end
   end

data/spec/jekyll_auth_jekyll_site_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "spec_helper"
 
 describe "jekyll site" do
@@ -40,5 +42,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,11 @@
+# frozen_string_literal: true
+
 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 +24,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 +43,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,17 @@
+# frozen_string_literal: true
+
 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__)
@@ -46,10 +48,13 @@ 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
 
 Dotenv.load
+ENV["GITHUB_CLIENT_ID"] ||= "IGNORE"
+ENV["GITHUB_CLIENT_SECRET"] ||= "IGNORE"
 setup_tmp_dir
 
 require_relative "../lib/jekyll-auth"

data/templates/.gitignore

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

data/templates/Rakefile

@@ -1,3 +1,5 @@
+# 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

data/templates/config.ru

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # This file is auto-generated by Jekyll Auth
 # It tells Heroku how to launch our site