jekyll-auth 0.6.1 → 1.0.0

data/spec/jekyll_auth_commands_spec.rb

@@ -0,0 +1,76 @@
+require "spec_helper"
+
+describe "commands" do
+
+  before do
+    setup_tmp_dir
+  end
+
+  it "should find the template directory" do
+    expect(File.directory?(JekyllAuth::Commands.source)).to eql(true)
+    expect(File).to exist("#{JekyllAuth::Commands.source}/config.ru")
+  end
+
+  it "should know the destination directory" do
+    expect(JekyllAuth::Commands.destination).to eql(tmp_dir)
+  end
+
+  it "should execute a command" do
+    expect(JekyllAuth::Commands.execute_command("ls")).to match(/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}])
+    expect(JekyllAuth::Commands.team_id("batler-test-org", "test-team")).to eql(1)
+  end
+
+  it "should copy the template files" do
+    expect(File).to_not exist("#{tmp_dir}/config.ru")
+    JekyllAuth::Commands.copy_templates
+    expect(File).to exist("#{tmp_dir}/config.ru")
+    expect(File).to exist("#{tmp_dir}/Rakefile")
+    expect(File).to exist("#{tmp_dir}/.gitignore")
+  end
+
+  it "should know when a directory's changed" do
+    `git init`
+    `git add .`
+    `git commit -m 'initial commit'`
+    expect(JekyllAuth::Commands.changed?).to eql(false)
+    `touch config.ru`
+    expect(JekyllAuth::Commands.changed?).to eql(true)
+  end
+
+  it "knows when env vars are set" do
+    var = "SOME_ENV_VAR"
+
+    ENV.delete(var)
+    expect(JekyllAuth::Commands.env_var_set?(var)).to eql(false)
+
+    ENV[var] = "bar"
+    expect(JekyllAuth::Commands.env_var_set?(var)).to eql(true)
+
+    ENV[var] = ""
+    expect(JekyllAuth::Commands.env_var_set?(var)).to eql(false)
+
+    ENV[var] = nil
+    expect(JekyllAuth::Commands.env_var_set?(var)).to eql(false)
+  end
+
+  it "knows when there's a heroku remote" do
+    `git init`
+    expect(JekyllAuth::Commands.heroku_remote_set?).to eql(false)
+    `git remote add heroku https://example.com`
+    expect(JekyllAuth::Commands.heroku_remote_set?).to eql(true)
+  end
+
+  it "should make an initial commit" do
+    `git init`
+    `touch foo.md`
+    `git add foo.md`
+    JekyllAuth::Commands.initial_commit
+    output = JekyllAuth::Commands.execute_command "git", "log"
+    expect(output).to match(/\[Jekyll Auth\] Initial setup/)
+  end
+end

data/spec/jekyll_auth_helpers_spec.rb

@@ -0,0 +1,62 @@
+require "spec_helper"
+
+describe "strategies" do
+
+  class TestHelper
+    include JekyllAuth::Helpers
+
+    def initialize(path=nil)
+      @path = path
+    end
+
+    def request
+      Rack::Request.new("PATH_INFO" => @path)
+    end
+  end
+
+  before(:each) do
+    JekyllAuth.instance_variable_set("@config", nil)
+    @helper = TestHelper.new
+    ENV["GITHUB_ORG_ID"] = nil
+    ENV["GITHUB_TEAM_ID"] = nil
+    ENV["GITHUB_TEAMS_ID"] = nil
+  end
+
+  it "should return nil if no ID is set" do
+    expect(@helper.authentication_strategy).to eql(nil)
+  end
+
+  it "should detect the org strategy" do
+    with_env("GITHUB_ORG_ID", "some_org") do
+      expect(@helper.authentication_strategy).to eql(:org)
+    end
+  end
+
+  it "should detect the team strategy" do
+    with_env("GITHUB_TEAM_ID", "1234") do
+      expect(@helper.authentication_strategy).to eql(:team)
+    end
+  end
+
+  it "should detect the teams strategy" do
+    with_env("GITHUB_TEAM_IDS", "1234,5678") do
+      expect(@helper.authentication_strategy).to eql(:teams)
+    end
+  end
+
+  it "should know if a path is whitelisted" do
+    File.write(JekyllAuth.config_file, "jekyll_auth:\n  whitelist:\n   - drafts?\n")
+
+    helper = TestHelper.new("/foo")
+    expect(helper.whitelisted?).to eql(false)
+
+    helper = TestHelper.new("/draft")
+    expect(helper.whitelisted?).to eql(true)
+  end
+
+  it "should not err out if there is no whitelist" do
+    helper = TestHelper.new("/drafts")
+    JekyllAuth.instance_variable_set("@config", {})
+    expect(helper.whitelisted?).to eql(false)
+  end
+end

data/spec/jekyll_auth_jekyll_site_spec.rb

@@ -0,0 +1,44 @@
+require "spec_helper"
+
+describe "jekyll site" do
+  include Rack::Test::Methods
+
+  def app
+    JekyllAuth::JekyllSite
+  end
+
+  before do
+    setup_tmp_dir
+    File.write File.expand_path("_config.yml", tmp_dir), "foo: bar"
+    `bundle exec jekyll build`
+  end
+
+  it "serves the index" do
+    get "/"
+    expect(last_response.body).to eql("My awesome site")
+  end
+
+  it "serves a page" do
+    get "/index.html"
+    expect(last_response.body).to eql("My awesome site")
+  end
+
+  it "serves a directory index" do
+    get "/some_dir"
+    expect(last_response.body).to eql("My awesome directory")
+  end
+
+  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>")
+  end
+
+  it "serves a custom 404" do
+    File.write File.expand_path("_site/404.html", tmp_dir), "My custom 404"
+    get "/a-bad-path"
+    expect(last_response.status).to eql(404)
+    expect(last_response.body).to eql("My custom 404")
+  end
+
+end

data/spec/jekyll_auth_spec.rb

@@ -0,0 +1,47 @@
+require "spec_helper"
+
+describe "JekyllAuth" do
+
+  before(:each) do
+    setup_tmp_dir
+    JekyllAuth.instance_variable_set("@config",nil)
+  end
+
+  it "should know the config file path" do
+    expected = File.expand_path "tmp/_config.yml", base_dir
+    expect(JekyllAuth.config_file).to eql(expected)
+  end
+
+  it "should return a null hash if no config file exists" do
+    expect(JekyllAuth.config).to eql({})
+  end
+
+  it "should return a null hash if config file doesn't contain jekyll_auth" do
+    File.write(JekyllAuth.config_file, "foo: bar\n")
+    expect(JekyllAuth.config).to eql({})
+  end
+
+  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?"]})
+  end
+
+  it "should disable ssl by default" do
+    expect(JekyllAuth.ssl?).to eql(false)
+  end
+
+  it "should know when ssl is requested" do
+    File.write(JekyllAuth.config_file, "jekyll_auth:\n  ssl:true\n")
+    expect(JekyllAuth.ssl?).to eql(true)
+  end
+
+  it "should know when ssl is disabled" do
+    File.write(JekyllAuth.config_file, "jekyll_auth:\n  ssl:false\n")
+    expect(JekyllAuth.ssl?).to eql(true)
+  end
+
+  it "should parse the whitelist" do
+    File.write(JekyllAuth.config_file, "jekyll_auth:\n  whitelist:\n   - drafts?\n")
+    expect(JekyllAuth.whitelist).to eql(/drafts?/)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,60 @@
+require "bundler/setup"
+require 'fileutils'
+
+ENV['RACK_ENV'] = 'test'
+$:.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'
+
+def base_dir
+  File.expand_path "../", File.dirname(__FILE__)
+end
+
+def tmp_dir
+  File.expand_path "tmp", base_dir
+end
+
+def bin_path
+  File.expand_path "./bin/jekyll-auth", base_dir
+end
+
+def tear_down_tmp_dir
+  FileUtils.rm_rf tmp_dir
+end
+
+def setup_tmp_dir
+  tear_down_tmp_dir
+  FileUtils.mkdir tmp_dir
+  File.write File.expand_path("index.html", tmp_dir), "My awesome site"
+  FileUtils.mkdir "#{tmp_dir}/some_dir"
+  File.write File.expand_path("some_dir/index.html", tmp_dir), "My awesome directory"
+  Dir.chdir tmp_dir
+end
+
+def with_env(key, value)
+  old_env = ENV[key]
+  ENV[key] = value
+  yield
+  ENV[key] = old_env
+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
+setup_tmp_dir
+
+require_relative "../lib/jekyll-auth"
+WebMock.disable_net_connect!
+
+RSpec.configure do |config|
+  config.include(Sinatra::Auth::Github::Test::Helper)
+end

data/templates/.gitignore

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

data/templates/Rakefile

@@ -0,0 +1,9 @@
+# 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"
+  end
+end

data/templates/index.html

@@ -0,0 +1,19 @@
+<html>
+  <head>
+    <title>It Worked!</title>
+    <style>
+      img { 
+        width: 500;
+      }
+      body {
+        text-align: center;
+        font-size: 1.5em;
+      }
+    </style>
+  </head>
+  <body>
+    <h1>Great Scott, it Worked!</h1>
+    <img src="http://octodex.github.com/images/doctocat-brown.jpg"/>
+    <p><em>Hint:</em> If you're seeing this page, that means you're authenticated</p>
+  </body>
+</html>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-auth
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Ben Balter
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-14 00:00:00.000000000 Z
+date: 2015-01-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -53,75 +53,75 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.1'
 - !ruby/object:Gem::Dependency
-  name: commander
+  name: rack
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '4.1'
+        version: 1.5.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '4.1'
+        version: 1.5.2
 - !ruby/object:Gem::Dependency
-  name: git
+  name: dotenv
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: dotenv
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.11'
+        version: '10.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.11'
+        version: '10.3'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: rack-ssl-enforcer
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.3'
+        version: '0.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.3'
+        version: '0.2'
 - !ruby/object:Gem::Dependency
-  name: rack-ssl-enforcer
+  name: mercenary
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: '0.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: '0.3'
 - !ruby/object:Gem::Dependency
   name: safe_yaml
   requirement: !ruby/object:Gem::Requirement
@@ -136,6 +136,76 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: colorator
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
 description: A simple way to use Github Oauth to serve a protected jekyll site to
   your GitHub organization.
 email: ben@balter.com
@@ -145,14 +215,38 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".travis.yml"
+- Gemfile
+- README.md
 - Rakefile
 - bin/jekyll-auth
-- config.ru
+- jekyll-auth.gemspec
 - lib/jekyll-auth.rb
-- lib/jekyll-auth/auth-site.rb
-- lib/jekyll-auth/config.rb
-- lib/jekyll-auth/jekyll-site.rb
-- lib/jekyll-auth/version.rb
+- lib/jekyll_auth/auth_site.rb
+- lib/jekyll_auth/commands.rb
+- lib/jekyll_auth/config_error.rb
+- lib/jekyll_auth/helpers.rb
+- lib/jekyll_auth/jekyll_site.rb
+- lib/jekyll_auth/sinatra/auth/github.rb
+- lib/jekyll_auth/version.rb
+- script/bootstrap
+- script/cibuild
+- script/console
+- script/release
+- script/server
+- script/setup
+- spec/jekyll_auth_auth_site_spec.rb
+- spec/jekyll_auth_bin_spec.rb
+- spec/jekyll_auth_commands_spec.rb
+- spec/jekyll_auth_helpers_spec.rb
+- spec/jekyll_auth_jekyll_site_spec.rb
+- spec/jekyll_auth_spec.rb
+- spec/spec_helper.rb
+- templates/.env
+- templates/.gitignore
+- templates/Rakefile
+- templates/config.ru
+- templates/index.html
 homepage: https://github.com/benbalter/jekyll-auth
 licenses:
 - MIT
@@ -178,4 +272,11 @@ signing_key:
 specification_version: 4
 summary: A simple way to use Github OAuth to serve a protected jekyll site to your
   GitHub organization
-test_files: []
+test_files:
+- spec/jekyll_auth_auth_site_spec.rb
+- spec/jekyll_auth_bin_spec.rb
+- spec/jekyll_auth_commands_spec.rb
+- spec/jekyll_auth_helpers_spec.rb
+- spec/jekyll_auth_jekyll_site_spec.rb
+- spec/jekyll_auth_spec.rb
+- spec/spec_helper.rb