Merge pull request #30 from jekyll/up-to-speed

Bring this gem up-to-date with latest GitHub Pages metadata

README.md

@@ -18,6 +18,7 @@ gem 'jekyll-github-metadata'
 Then go ahead and run `bundle install`. Once you've done that, add your repo & the gem to your `_config.yml`:
 
 ```yaml
+# or use PAGES_REPO_NWO in the env
 repository: me/super-cool-project
 gems: ['jekyll-github-metadata']
 ```
@@ -48,13 +49,28 @@ We use [Octokit](https://github.com/octokit/octokit.rb) to make the appropriate
 $ OCTOKIT_ACCESS_TOKEN=123abc [bundle exec] jekyll serve
 ```
 
+## Overrides
+
+- `PAGES_REPO_NWO` – overrides `site.repository` as the repo name with owner to fetch (e.g. `jekyll/github-metadata`)
+
+Some `site.github` values can be overridden by environment variables.
+
+- `JEKYLL_BUILD_REVISION` – the `site.github.build_revision`, git SHA of the source site being built. (default: `git rev-parse HEAD`)
+- `PAGES_ENV` – the `site.github.pages_env` (default: `dotcom`)
+- `PAGES_API_URL` – the `site.github.api_url` (default: `https://api/github.com`)
+- `PAGES_HELP_URL` – the `site.github.help_url` (default: `https://help.github.com`)
+- `PAGES_GITHUB_HOSTNAME` – the `site.github.hostname` (default: `https://github.com`)
+- `PAGES_PAGES_HOSTNAME` – the `site.github.pages_hostname` (default: `github.io`)
+
 ## Configuration
 
 Working with `jekyll-github-metadata` and GitHub Enterprise? No sweat. You can configure which API endpoints this plugin will hit to fetch data.
 
+- `SSL` – if "true", sets a number of endpoints to use `https://`, default: `"false"`
 - `OCTOKIT_API_ENDPOINT` – the full hostname and protocol for the api, default: `https://api.github.com`
 - `OCTOKIT_WEB_ENDPOINT` – the full hostname and protocol for the website, default: `https://github.com`
 - `PAGES_PAGES_HOSTNAME` – the full hostname from where GitHub Pages sites are served, default: `github.io`.
+- `NO_NETRC` – set if you don't want the fallback to `~/.netrc`
 
 ## License
 

lib/jekyll-github-metadata.rb

@@ -1,7 +1,10 @@
+require 'jekyll'
 require 'octokit'
 
 module Jekyll
   module GitHubMetadata
+    NoRepositoryError = Class.new(Jekyll::Errors::FatalException)
+
     autoload :Client,     'jekyll-github-metadata/client'
     autoload :Pages,      'jekyll-github-metadata/pages'
     autoload :Repository, 'jekyll-github-metadata/repository'
@@ -56,8 +59,10 @@ def init!
         # Environment-Specific
         register_value('environment', proc { environment })
         register_value('hostname', proc { Pages.github_hostname })
+        register_value('pages_env', proc { Pages.env })
         register_value('pages_hostname', proc { Pages.pages_hostname })
         register_value('api_url', proc { Pages.api_url })
+        register_value('help_url', proc { Pages.help_url })
 
         register_value('versions', proc {
           begin
@@ -68,8 +73,12 @@ def init!
 
         # The Juicy Stuff
         register_value('public_repositories',  proc { |c,r| c.list_repos(r.owner, "type" => "public") })
-        register_value('organization_members', proc { |c,r| c.organization_public_members(r.owner) if r.organization_repository? })
-        register_value('build_revision',       proc { `git rev-parse HEAD`.strip })
+        register_value('organization_members', proc { |c,r|
+          c.organization_public_members(r.owner) if r.organization_repository?
+        })
+        register_value('build_revision',       proc {
+          ENV['JEKYLL_BUILD_REVISION'] || `git rev-parse HEAD`.strip
+        })
         register_value('project_title',        proc { |_,r| r.name })
         register_value('project_tagline',      proc { |_,r| r.tagline })
         register_value('owner_name',           proc { |_,r| r.owner })

lib/jekyll-github-metadata/ghp_metadata_generator.rb

@@ -5,7 +5,7 @@ module GitHubMetadata
     class GHPMetadataGenerator < Jekyll::Generator
       def generate(site)
         Jekyll.logger.debug "Generator:", "Calling GHPMetadataGenerator"
-        GitHubMetadata.repository = GitHubMetadata::Repository.new(site.config.fetch('repository'))
+        GitHubMetadata.repository = GitHubMetadata::Repository.new(nwo(site))
         GitHubMetadata.init!
         site.config['github'] =
           case site.config['github']
@@ -17,6 +17,15 @@ def generate(site)
             site.config['github']
           end
       end
+
+      def nwo(site)
+        ENV['PAGES_REPO_NWO'] || \
+          site.config['repository'] || \
+          proc {
+            raise GitHubMetadata::NoRepositoryError, "No repo name found. "
+              "Specify using PAGES_REPO_NWO or 'repository' in your configuration."
+          }.call
+      end
     end
   end
 end

lib/jekyll-github-metadata/pages.rb

@@ -2,23 +2,48 @@ module Jekyll
   module GitHubMetadata
     class Pages
       class << self
+        DEFAULTS = {
+          'PAGES_ENV'             => 'dotcom'.freeze,
+          'PAGES_API_URL'         => 'https://api.github.com'.freeze,
+          'PAGES_HELP_URL'        => 'https://help.github.com'.freeze,
+          'PAGES_GITHUB_HOSTNAME' => 'https://github.com'.freeze,
+          'PAGES_PAGES_HOSTNAME'  => 'github.io'.freeze,
+          'SSL'                   => 'false'.freeze
+        }.freeze
+
+        def ssl?
+          env_var('SSL').eql? 'true'
+        end
+
+        def scheme
+          ssl? ? "https" : "http"
+        end
+
         def env
-          ENV.fetch('PAGES_ENV', 'dotcom')
+          env_var 'PAGES_ENV'
         end
 
         def api_url
-          trim_last_slash(ENV['PAGES_API_URL'] || Octokit.api_endpoint || 'https://api.github.com')
+          trim_last_slash env_var('PAGES_API_URL', Octokit.api_endpoint)
+        end
+
+        def help_url
+          trim_last_slash env_var('PAGES_HELP_URL')
         end
 
         def github_hostname
-          trim_last_slash(ENV['PAGES_GITHUB_HOSTNAME'] || Octokit.web_endpoint || 'https://github.com')
+          trim_last_slash env_var('PAGES_GITHUB_HOSTNAME', Octokit.web_endpoint)
         end
 
         def pages_hostname
-          trim_last_slash(ENV.fetch('PAGES_PAGES_HOSTNAME', 'github.io'))
+          trim_last_slash env_var('PAGES_PAGES_HOSTNAME')
         end
 
         private
+        def env_var(key, intermediate_default = nil)
+          !ENV[key].to_s.empty? ? ENV[key] : (intermediate_default || DEFAULTS[key])
+        end
+
         def trim_last_slash(url)
           if url[-1] == "/"
             url[0..-2]

lib/jekyll-github-metadata/repository.rb

@@ -101,9 +101,9 @@ def user_page_domains
 
       def pages_url
         if cname || primary?
-          "http://#{domain}"
+          "#{Pages.scheme}://#{domain}"
         else
-          File.join("http://#{domain}", name, "")
+          URI.join("#{Pages.scheme}://#{domain}", "#{name}/")
         end
       end
 

spec/ghp_metadata_generator_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+
+RSpec.describe(Jekyll::GitHubMetadata::GHPMetadataGenerator) do
+  let(:overrides) { {"repository" => "jekyll/another-repo"} }
+  let(:config) { Jekyll::Configuration::DEFAULTS.merge(overrides) }
+  let(:site) { Jekyll::Site.new config }
+  subject { described_class.new(site.config) }
+
+  context "with no repository set" do
+    before(:each) do
+      site.config.delete('repository')
+      ENV['PAGES_REPO_NWO'] = nil
+    end
+
+    it "raises a NoRepositoryError" do
+      expect(-> {
+        subject.nwo(site)
+      }).to raise_error(Jekyll::GitHubMetadata::NoRepositoryError)
+    end
+  end
+
+  context "with PAGES_REPO_NWO and site.repository set" do
+    before(:each) { ENV['PAGES_REPO_NWO'] = "jekyll/some-repo" }
+
+    it "uses the value from PAGES_REPO_NWO" do
+      expect(subject.nwo(site)).to eql("jekyll/some-repo")
+    end
+  end
+
+  context "with only site.repository set" do
+    before(:each) { ENV['PAGES_REPO_NWO'] = nil }
+
+    it "uses the value from site.repository" do
+      expect(subject.nwo(site)).to eql("jekyll/another-repo")
+    end
+  end
+end

spec/github_metadata_spec.rb

@@ -4,7 +4,7 @@
   let(:key_value_pair) { %w{some_key some_value} }
 
   before(:each) do
-    described_class.clear_values!
+    described_class.reset!
   end
 
   it 'allows you to register values' do

spec/integration_spec.rb

@@ -9,35 +9,52 @@ def dest_dir(*files)
     DEST_DIR.join(*files)
   end
 
-  before(:all) do
+  class ApiStub
+    attr_reader :path, :file
+    attr_accessor :stub
+
+    def initialize(path, file)
+      @path = path
+      @file = file
+    end
+  end
+
+  API_STUBS = {
+    "/users/jekyll/repos?per_page=100&type=public"         => "owner_repos",
+    "/repos/jekyll/github-metadata"                        => "repo",
+    "/orgs/jekyll"                                         => "org",
+    "/orgs/jekyll/public_members?per_page=100"             => "org_members",
+    "/repos/jekyll/github-metadata/pages"                  => "repo_pages",
+    "/repos/jekyll/github-metadata/releases?per_page=100"  => "repo_releases",
+    "/repos/jekyll/github-metadata/contributors?per_page=100" => "repo_contributors"
+  }.map { |path, file| ApiStub.new(path, file) }
+
+  before(:each) do
     # Reset some stuffs
     ENV['NO_NETRC'] = "true"
     ENV['JEYKLL_GITHUB_TOKEN'] = "1234abc"
+    ENV['PAGES_REPO_NWO'] = 'jekyll/github-metadata'
+    Jekyll::GitHubMetadata.reset!
 
     # Stub Requests
-    stub_api "/users/jekyll/repos?per_page=100&type=public",        "owner_repos"
-    stub_api "/repos/jekyll/github-metadata",                       "repo"
-    stub_api "/repos/jekyll/github-metadata/releases?per_page=100", "repo_releases"
-    stub_api "/orgs/jekyll",                                        "org"
-    stub_api "/orgs/jekyll/public_members?per_page=100",            "org_members"
-    stub_api "/repos/jekyll/github-metadata/pages",                 "repo_pages"
-    stub_api "/repos/jekyll/github-metadata/contributors?per_page=100", "repo_contributors"
+    API_STUBS.each { |stub| stub.stub = stub_api(stub.path, stub.file) }
 
     # Run Jekyll
     Jekyll.logger.log_level = :error
     Jekyll::Commands::Build.process({
       "source" => SOURCE_DIR.to_s,
       "destination" => DEST_DIR.to_s,
-      "gems" => %w{jekyll-github-metadata},
-      "repository" => "jekyll/github-metadata"
+      "gems" => %w{jekyll-github-metadata}
     })
   end
   subject { SafeYAML::load(dest_dir("rendered.txt").read) }
 
   {
     "environment"          => "development",
     "hostname"             => "https://github.com",
+    "pages_env"            => "dotcom",
     "pages_hostname"       => "github.io",
+    "help_url"             => "https://help.github.com",
     "api_url"              => "https://api.github.com",
     "versions"             => proc {
       begin
@@ -82,4 +99,10 @@ def dest_dir(*files)
     end
   end
 
+  it "calls all the stubs" do
+    API_STUBS.each do |stub|
+      expect(stub.stub).to have_been_requested
+    end
+  end
+
 end

spec/spec_helper.rb

@@ -5,28 +5,45 @@
 SPEC_DIR = Pathname.new(File.expand_path("../", __FILE__))
 
 module WebMockHelper
+  REQUEST_HEADERS = {
+    'Accept'          => 'application/vnd.github.v3+json',
+    'Accept-Encoding' => 'gzip;q=1.0,deflate;q=0.6,identity;q=0.3',
+    'Content-Type'    => 'application/json',
+    'User-Agent'      => "Octokit Ruby Gem #{Octokit::VERSION}"
+  }.freeze
+  RESPONSE_HEADERS = {
+    'Transfer-Encoding'   => 'chunked',
+    'Content-Type'        => 'application/json; charset=utf-8',
+    'Vary'                => 'Accept-Encoding',
+    'Content-Encoding'    => 'gzip',
+    'X-GitHub-Media-Type' => 'github.v3; format=json'
+  }.freeze
+
   def stub_api(path, filename)
     WebMock.disable_net_connect!
-    stub_request(:get, "https://api.github.com#{path}").
-      with(:headers => {
-        'Accept'          => 'application/vnd.github.v3+json',
-        'Accept-Encoding' => 'gzip;q=1.0,deflate;q=0.6,identity;q=0.3',
-        'Content-Type'    => 'application/json',
-        'User-Agent'      => "Octokit Ruby Gem #{Octokit::VERSION}"
-      }).
+    stub_request(:get, url(path)).
+      with(:headers => REQUEST_HEADERS).
       to_return(
-        :status => 200,
-        :headers => {
-          'Transfer-Encoding'   => 'chunked',
-          'Content-Type'        => 'application/json; charset=utf-8',
-          'Vary'                => 'Accept-Encoding',
-          'Content-Encoding'    => 'gzip',
-          'X-GitHub-Media-Type' => 'github.v3; format=json'
-        },
-        :body   => SPEC_DIR.
-                  join("webmock/api_get_#{filename}.json").read
+        :status  => 200,
+        :headers => RESPONSE_HEADERS,
+        :body    => webmock_data(filename)
       )
   end
+
+  def expect_api_call(path)
+    expect(WebMock).to have_requested(:get, url(path)).
+      with(:headers => REQUEST_HEADERS).once
+  end
+
+  private
+  def url(path)
+    "#{Jekyll::GitHubMetadata::Pages.api_url}#{path}"
+  end
+
+  def webmock_data(filename)
+    @webmock_data ||= {}
+    @webmock_data[filename] ||= SPEC_DIR.join("webmock/api_get_#{filename}.json").read
+  end
 end
 
 RSpec.configure do |config|
@@ -38,13 +55,6 @@ def stub_api(path, filename)
     mocks.verify_partial_doubles = true
   end
 
-  # These two settings work together to allow you to limit a spec run
-  # to individual examples or groups you care about by tagging them with
-  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
-  # get run.
-  config.filter_run :focus
-  config.run_all_when_everything_filtered = true
-
   # Limits the available syntax to the non-monkey patched syntax that is recommended.
   # For more details, see:
   #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax