jekyll-auth 1.0.2 → 2.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 9d94cc333de503a6fbdb201f1ed9b31cff858cb5
-  data.tar.gz: bfcedea76e84e2134f0bdf187bed35f30d8e99b0
+SHA256:
+  metadata.gz: 25f71431fe3e6a87766f5fe1d2ed3250991afb1c751025088e6740466466dec8
+  data.tar.gz: 3f110e0d1d75eaf3921c7fd10e87c33ee3b2fc6126439a29e570abfb5cb0f89d
 SHA512:
-  metadata.gz: ab4b0d18dfd9ee56ab8e3781990ff90decf4bb580e20f67379cf889cb836168e9a86ce1e2f495c0bc77e4417e61d21bdfaa5a95cf4f6152f464f6e43402bc0e3
-  data.tar.gz: 3d444b873b5918a678d31acbbb18c7944cb825c9f765ad28038ce36d5b0dcc2983dd0f9261c78fba87a67c19f83eb221389ba1445d6c7d6fd1f20731c587b502
+  metadata.gz: 7b7876e78ea89e16ac9a7d49127c27d4bcc37e4397c1d14aa16c746144d9ce90cb5756bc894282fffbb383ae70bcfbcb8550755075352b51786d598c0f5cbe12
+  data.tar.gz: a57c1176f2c27257905503c278a670a14256963a471f67475dc09fc97f0a4739ded211be927a36a889f9ed4f0d2e288a5088600cfd87e9684ec55d4a1421b4a7

data/.github/CODEOWNERS

@@ -0,0 +1,3 @@
+# Require @benbalter's :+1: for changes to the .github repo-config files
+# mainly due to https://github.com/probot/settings privilege escalation
+.github/* @benbalter

data/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,28 @@
+---
+name: Bug report
+about: Create a report to help us improve
+
+---
+
+### Describe the bug
+
+A clear and concise description of what the bug is.
+
+### Steps to reproduce the behavior
+
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+### Expected behavior
+
+A clear and concise description of what you expected to happen.
+
+### Screenshots
+
+If applicable, add screenshots to help explain your problem.
+
+### Additional context
+
+Add any other context about the problem here.

data/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,21 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+
+---
+
+### Is your feature request related to a problem? Please describe the problem you're trying to solve.
+
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+### Describe the solution you'd like
+
+A clear and concise description of what you want to happen.
+
+### Describe alternatives you've considered
+
+A clear and concise description of any alternative solutions or features you've considered.
+
+### Additional context
+
+Add any other context or screenshots about the feature request here.

data/.github/config.yml

@@ -0,0 +1,23 @@
+# Behaviorbot config. See https://github.com/behaviorbot/ for more information.
+# Note: Please Don't edit this file directly.
+# Edit https://github.com/benbalter/shared-community-files instead.
+
+# Configuration for update-docs - https://github.com/behaviorbot/update-docs
+updateDocsComment: "Thanks for the pull request! If you are making any changes to the user-facing functionality, please be sure to update the documentation in the `README` or `docs/` folder alongside your change. :heart:"
+
+# Configuration for request-info - https://github.com/behaviorbot/request-info
+requestInfoReplyComment: Thanks for this. Do you mind providing a bit more information about what problem you're trying to solve?
+requestInfoLabelToAdd: more-information-needed
+
+# Configuration for new-issue-welcome - https://github.com/behaviorbot/new-issue-welcome
+#newIssueWelcomeComment: >
+#  Welcome!
+
+# Configuration for new-pr-welcome - https://github.com/behaviorbot/new-pr-welcome
+newPRWelcomeComment: Welcome! Congrats on your first pull request to Jekyll Auth. If you haven't already, please be sure to check out [the contributing guidelines](https://github.com/benbalter/jekyll-auth/blob/master/docs/CONTRIBUTING.md).
+
+# Configuration for first-pr-merge - https://github.com/behaviorbot/first-pr-merge
+firstPRMergeComment: "Congrats on getting your first pull request to Jekyll Auth merged! Without amazing humans like you submitting pull requests, we couldn’t run this project. You rock! :tada:<br /><br />If you're interested in tackling another bug or feature, take a look at [the open issues](https://github.com/benbalter/jekyll-auth/issues), especially those [labeled `help wanted`](https://github.com/benbalter/jekyll-auth/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22)."
+
+# Bug workaround
+contact_links: []

data/.github/funding.yml

@@ -0,0 +1 @@
+patreon: benbalter

data/.github/no-response.yml

@@ -0,0 +1,15 @@
+# Configuration for probot-no-response - https://github.com/probot/no-response
+# Note: Please Don't edit this file directly.
+# Edit https://github.com/benbalter/shared-community-files instead.
+
+# Number of days of inactivity before an Issue is closed for lack of response
+daysUntilClose: 14
+# Label requiring a response
+responseRequiredLabel: more-information-needed
+# Comment to post when closing an Issue for lack of response. Set to `false` to disable
+closeComment: >
+  This issue has been automatically closed because there has been no response
+  to our request for more information from the original author. With only the
+  information that is currently in the issue, we don't have enough information
+  to take action. Please reach out if you have or find the answers we need so
+  that we can investigate further.

data/.github/release-drafter.yml

@@ -0,0 +1,4 @@
+template: |
+  ## What's Changed
+
+  $CHANGES

data/.github/settings.yml

@@ -0,0 +1,33 @@
+# Repository settings set via https://github.com/probot/settings
+# Note: Please Don't edit this file directly.
+# Edit https://github.com/benbalter/shared-community-files instead.
+
+repository:
+  has_issues: true
+  has_wiki: false
+  has_projects: false
+  has_downloads: false
+
+labels:
+  - name: help wanted
+    oldname: help-wanted
+    color: 0e8a16
+  - name: more-information-needed
+    color: d93f0b
+  - name: bug
+    color: b60205
+  - name: feature
+    color: 1d76db
+  - name: good first issue
+    color: "5319e7"
+
+# Not currently implemented by probot/settings, but manually implemented in script/deploy
+branch_protection:
+  restrictions: null
+  enforce_admins: false
+  required_status_checks:
+    strict: true
+    contexts:
+      - "continuous-integration/travis-ci"
+  required_pull_request_reviews:
+    require_code_owner_reviews: true

data/.github/stale.yml

@@ -0,0 +1,29 @@
+# Configuration for probot-stale - https://github.com/probot/stale
+# Note: Please Don't edit this file directly.
+# Edit https://github.com/benbalter/shared-community-files instead.
+
+# Number of days of inactivity before an Issue or Pull Request becomes stale
+daysUntilStale: 60
+
+# Number of days of inactivity before a stale Issue or Pull Request is closed
+daysUntilClose: 7
+
+# Issues or Pull Requests with these labels will never be considered stale
+exemptLabels:
+  - pinned
+  - security
+
+# Label to use when marking as stale
+staleLabel: wontfix
+
+# Comment to post when marking as stale. Set to `false` to disable
+markComment: >
+  This issue has been automatically marked as stale because it has not had
+  recent activity. It will be closed if no further activity occurs. Thank you
+  for your contributions.
+
+# Comment to post when closing a stale Issue or Pull Request. Set to `false` to disable
+closeComment: false
+
+# Limit to only `issues` or `pulls`
+# only: issues

data/.rubocop.yml

@@ -0,0 +1,28 @@
+require: rubocop-jekyll
+inherit_gem:
+  rubocop-jekyll: .rubocop.yml
+
+Style/Documentation:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Layout/LineLength:
+  Enabled: false
+
+Naming/FileName:
+  Enabled: false
+
+Metrics/BlockLength:
+  Enabled: false
+
+Style/DoubleNegation:
+  Enabled: false
+
+AllCops:
+  Exclude:
+    - vendor/**/*
+
+Jekyll/NoPutsAllowed:
+  Enabled: false

data/.travis.yml

@@ -1,4 +1,8 @@
 language: ruby
+rvm:
+  - 3.0
+  - 2.7
+  - 2.6
 script: "./script/cibuild"
 
 before_script:
@@ -12,4 +16,4 @@ env:
   global:
     - GITHUB_CLIENT_ID=FOO
     - GITHUB_CLIENT_SECRET=BAR
-    - GITHUB_ORG_ID="balter-test-org"
+    - GITHUB_ORG_NAME="balter-test-org"

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source "https://rubygems.org"
 
 gemspec

data/Rakefile

@@ -1,8 +1,10 @@
-require 'rubygems/package_task'
-require 'rubygems/specification'
-require 'bundler'
-require 'fileutils'
-require 'dotenv'
+# frozen_string_literal: true
+
+require "rubygems/package_task"
+require "rubygems/specification"
+require "bundler"
+require "fileutils"
+require "dotenv"
 
 task :default => [:spec]
 
@@ -12,9 +14,9 @@ task :site do
   `bundle exec jekyll-auth`
 end
 
-require 'rspec/core/rake_task'
+require "rspec/core/rake_task"
 desc "Run specs"
 RSpec::Core::RakeTask.new do |t|
-  t.pattern = 'spec/**/*_spec.rb'
+  t.pattern = "spec/**/*_spec.rb"
   t.rspec_opts = ["--order", "rand", "--color"]
 end

data/bin/jekyll-auth

@@ -1,26 +1,24 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
+
 # Command-line interface for jekyll-auth
 
-require 'mercenary'
-require 'jekyll-auth'
-require 'open3'
-require 'jekyll-auth'
+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?
-        puts "Looks like we've made some changes, you may want to do a git commit and git push sometime soon".yellow
-      end
+      puts "Looks like we've made some changes, you may want to do a git commit and git push sometime soon".yellow if JekyllAuth::Commands.changed?
 
       puts "Setup complete. Run `jekyll-auth` to view the authenticated site."
     end
@@ -30,30 +28,29 @@ 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
         exit 1
       end
 
-      org = options["org"] || ENV["GITHUB_ORG_ID"]
+      org = options["org"] || ENV["GITHUB_ORG_NAME"]
       team = options["team"]
 
       if org.nil? || team.nil?
@@ -62,9 +59,9 @@ Mercenary.program("jekyll-auth") do |p|
         exit 1
       end
 
-      team_id = JekyllAuth::Comands.team_id(org, team)
+      team_id = JekyllAuth::Commands.team_id(org, team)
 
-      if found
+      if team_id
         puts "The team ID for `@#{org}/#{team}` is `#{team_id}`".green
       else
         puts "Couldn't find the `@#{org}/#{team}` team.".red
@@ -75,12 +72,14 @@ 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_ID=[org id] (or GITHUB_TEAM_ID)".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
         exit 1
       end
@@ -88,24 +87,25 @@ 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
 
   p.command(:setup) do |c|
     c.syntax "setup"
     c.description "Configure Heroku for use with your Jekyll Auth site"
-    c.option "client_id", "--client_id", "Your oauth app client id"
-    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_id", "--org_id", "An organization to authenticate against"
-    c.action do |args, options|
-
+    c.option "client_id", "--client_id <ID>", "Your oauth app client id"
+    c.option "client_secret", "--client_secret <SECRET>", "Your oauth app client secret"
+    c.option "team_id", "--team_id <ID>", "The team to authenticate against"
+    c.option "org_name", "--org_name <NAME>", "An organization to authenticate against"
+    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..."
+        puts "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"
       end
 

data/docs/CODE_OF_CONDUCT.md

@@ -0,0 +1,46 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at ben@balter.com. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/