Move owner_metadata to an Owner class and add specs (#159)

Merge pull request 159

Author: parkr

lib/jekyll-github-metadata.rb

@@ -17,6 +17,7 @@ module GitHubMetadata
     autoload :Client,           "jekyll-github-metadata/client"
     autoload :EditLinkTag,      "jekyll-github-metadata/edit-link-tag"
     autoload :MetadataDrop,     "jekyll-github-metadata/metadata_drop"
+    autoload :Owner,            "jekyll-github-metadata/owner"
     autoload :Pages,            "jekyll-github-metadata/pages"
     autoload :Repository,       "jekyll-github-metadata/repository"
     autoload :RepositoryFinder, "jekyll-github-metadata/repository_finder"

lib/jekyll-github-metadata/owner.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module GitHubMetadata
+    class Owner
+      extend Forwardable
+
+      # Defines an instance method that delegates to a hash's key
+      #
+      # hash   - a symbol representing the instance method to delegate to. The
+      #          instance method should return a hash or respond to #[]
+      # key    - the key to call within the hash
+      # method - (optional) the instance method the key should be aliased to.
+      #          If not specified, defaults to the hash key
+      #
+      # Returns a symbol representing the instance method
+      def self.def_hash_delegators(hash, *methods)
+        content_methods.concat(methods)
+        methods.each do |method|
+          define_method(method) do
+            send(hash)[method.to_s]
+          end
+        end
+      end
+
+      def self.content_methods
+        @content_methods ||= []
+      end
+
+      # List of whitelisted keys.
+      def_hash_delegators :owner_info,
+                          :avatar_url,
+                          :bio,
+                          :blog,
+                          :collaborators,
+                          :company,
+                          :created_at,
+                          :description,
+                          :email,
+                          :followers,
+                          :following,
+                          :has_organization_projects,
+                          :has_repository_projects,
+                          :hireable,
+                          :html_url,
+                          :id,
+                          :is_verified,
+                          :location,
+                          :login,
+                          :name,
+                          :node_id,
+                          :public_gists,
+                          :public_gists,
+                          :public_repos,
+                          :public_repos,
+                          :type,
+                          :updated_at
+
+      attr_reader :owner_login
+
+      def initialize(owner_login)
+        @owner_login = owner_login
+      end
+
+      def to_s
+        require "json"
+        JSON.pretty_generate to_h
+      end
+      alias_method :to_str, :to_s
+
+      def to_h
+        self.class.content_methods.each_with_object({}) { |method, hash| hash[method] = public_send(method) }
+      end
+
+      private
+
+      def owner_info
+        @owner_info ||= begin
+          Value.new(
+            proc do |c|
+              (c.organization(owner_login) || c.user(owner_login) || {}).to_h
+            end
+          ).render || {}
+        end
+      end
+    end
+  end
+end

lib/jekyll-github-metadata/repository.rb

@@ -62,63 +62,8 @@ def repo_pages_info_opts
         end
       end
 
-      # Whitelisted keys for Organizations and Users
-      WHITELISTED_ORGANIZATION_KEYS = Set.new([
-        :login,
-        :id,
-        :node_id,
-        :url,
-        :avatar_url,
-        :description,
-        :name,
-        :company,
-        :blog,
-        :location,
-        :email,
-        :is_verified,
-        :has_organization_projects,
-        :has_repository_projects,
-        :public_repos,
-        :public_gists,
-        :followers,
-        :following,
-        :html_url,
-        :created_at,
-        :type,
-        :collaborators,
-      ])
-
-      WHITELISTED_USER_KEYS = Set.new([
-        :login,
-        :id,
-        :node_id,
-        :avatar_url,
-        :html_url,
-        :type,
-        :site_admin,
-        :name,
-        :company,
-        :blog,
-        :location,
-        :bio,
-        :public_repos,
-        :public_gists,
-        :followers,
-        :following,
-        :hireable,
-        :created_at,
-        :updated_at,
-      ])
-
       def owner_metadata
-        memoize_value :@owner_metadata, Value.new(proc { |c|
-          org = c.organization(owner)
-          if org
-            org.to_h.select { |k, _| WHITELISTED_ORGANIZATION_KEYS.include? k }
-          else
-            c.user(owner).to_h.select { |k, _| WHITELISTED_USER_KEYS.include? k }
-          end
-        })
+        @owner_metadata ||= Jekyll::GitHubMetadata::Owner.new(owner)
       end
 
       def owner_url

lib/jekyll-github-metadata/sanitizer.rb

@@ -21,7 +21,7 @@ def sanitize(resource)
         case resource
         when Array
           resource.map { |item| sanitize(item) }
-        when Numeric
+        when Numeric, Time
           resource
         when FalseClass
           false

spec/owner_spec.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+RSpec.describe(Jekyll::GitHubMetadata::Owner) do
+  subject { described_class.new(login) }
+  before(:each) do
+    ENV["JEKYLL_GITHUB_TOKEN"] = "allthespecs"
+  end
+
+  context "is an ORG" do
+    let(:login) { "jekyll" }
+    let!(:stub) do
+      stub_api("/orgs/#{login}", "org")
+    end
+
+    EXPECTED_ATTRIBUTES_ORG = {
+      :login                     => "jekyll",
+      :id                        => 3_083_652,
+      :node_id                   => "MDEyOk9yZ2FuaXphdGlvbjMwODM2NTI=",
+      :avatar_url                => "https://avatars0.githubusercontent.com/u/3083652?v=4",
+      :description               => "Jekyll is a blog-aware, static site generator in Ruby.",
+      :name                      => "Jekyll",
+      :company                   => nil,
+      :blog                      => "https://jekyllrb.com",
+      :location                  => nil,
+      :email                     => "",
+      :is_verified               => true,
+      :has_organization_projects => true,
+      :has_repository_projects   => true,
+      :public_repos              => 50,
+      :public_gists              => 0,
+      :followers                 => 0,
+      :following                 => 0,
+      :html_url                  => "https://github.com/jekyll",
+      :created_at                => Time.parse("2012-12-19 19:37:35 UTC"),
+      :updated_at                => Time.parse("2019-01-27 15:27:32 UTC"),
+      :type                      => "Organization",
+    }.freeze
+
+    EXPECTED_ATTRIBUTES_ORG.each do |attribute, expected_value|
+      it "fetches #{attribute}" do
+        expect(subject.public_send(attribute)).to eq(expected_value)
+      end
+    end
+
+    it "blocks denied attributes" do
+      expect(subject).not_to respond_to(:repos_url)
+    end
+  end
+
+  context "is a USER" do
+    let(:login) { "jekyllbot" }
+    let!(:stub) do
+      stub_api_404("/orgs/#{login}")
+      stub_api("/users/#{login}", "user")
+    end
+
+    EXPECTED_ATTRIBUTES_USER = {
+      :login        => "jekyllbot",
+      :id           => 6_166_343,
+      :node_id      => "MDQ6VXNlcjYxNjYzNDM=",
+      :avatar_url   => "https://avatars0.githubusercontent.com/u/6166343?v=4",
+      :type         => "User",
+      :name         => "jekyllbot",
+      :company      => nil,
+      :blog         => "https://github.com/parkr/auto-reply",
+      :location     => nil,
+      :email        => nil,
+      :hireable     => nil,
+      :bio          => "I help make working with @jekyll fun and easy.",
+      :public_repos => 2,
+      :public_gists => 0,
+      :followers    => 68,
+      :following    => 0,
+      :created_at   => Time.parse("2013-12-12 02:49:00 UTC"),
+      :updated_at   => Time.parse("2017-12-05 21:23:41 UTC"),
+    }.freeze
+
+    EXPECTED_ATTRIBUTES_USER.each do |attribute, expected_value|
+      it "fetches #{attribute}" do
+        expect(subject.public_send(attribute)).to eq(expected_value)
+      end
+    end
+
+    it "blocks denied attributes" do
+      expect(subject).not_to respond_to(:site_admin)
+      expect(subject).not_to respond_to(:repos_url)
+    end
+  end
+end

spec/spec_helpers/integration_helper.rb

@@ -15,7 +15,7 @@ def expected_values
       "build_revision"       => %r![a-f0-9]{40}!,
       "project_title"        => "github-metadata",
       "project_tagline"      => ":octocat: `site.github`",
-      "owner"                => Regexp.new('"login"=>"jekyll", "id"=>3083652'),
+      "owner"                => Regexp.new('"html_url": "https://github.com/jekyll",\s+"id": 3083652'),
       "owner_name"           => "jekyll",
       "owner_url"            => "https://github.com/jekyll",
       "owner_gravatar_url"   => "https://github.com/jekyll.png",

spec/spec_helpers/web_mock_helper.rb

@@ -26,6 +26,16 @@ def stub_api(path, filename, req_headers = {})
       )
   end
 
+  def stub_api_404(path, req_headers = {})
+    WebMock.disable_net_connect!
+    stub_request(:get, url(path))
+      .with(:headers => request_headers.merge(req_headers))
+      .to_return(
+        :status  => 404,
+        :headers => RESPONSE_HEADERS
+      )
+  end
+
   def expect_api_call(path)
     expect(WebMock).to have_requested(:get, url(path))
       .with(:headers => request_headers).once

spec/webmock/api_get_org.json

@@ -1 +1,30 @@
-{"login":"jekyll","id":3083652,"url":"https://api.github.com/orgs/jekyll","repos_url":"https://api.github.com/orgs/jekyll/repos","events_url":"https://api.github.com/orgs/jekyll/events","hooks_url":"https://api.github.com/orgs/jekyll/hooks","issues_url":"https://api.github.com/orgs/jekyll/issues","members_url":"https://api.github.com/orgs/jekyll/members{/member}","public_members_url":"https://api.github.com/orgs/jekyll/public_members{/member}","avatar_url":"https://avatars.githubusercontent.com/u/3083652?v=3","description":"Jekyll is a blog-aware, static site generator in Ruby.","name":"Jekyll","company":null,"blog":"http://jekyllrb.com","location":"","email":"","public_repos":43,"public_gists":0,"followers":0,"following":0,"html_url":"https://github.com/jekyll","created_at":"2012-12-19T19:37:35Z","updated_at":"2016-01-26T20:22:17Z","type":"Organization","total_private_repos":3,"owned_private_repos":3,"private_gists":0,"disk_usage":110870,"collaborators":0,"billing_email":"tom+jekyll@github.com","plan":{"name":"bronze","space":976562499,"private_repos":10}}
+{
+  "login": "jekyll",
+  "id": 3083652,
+  "node_id": "MDEyOk9yZ2FuaXphdGlvbjMwODM2NTI=",
+  "url": "https://api.github.com/orgs/jekyll",
+  "repos_url": "https://api.github.com/orgs/jekyll/repos",
+  "events_url": "https://api.github.com/orgs/jekyll/events",
+  "hooks_url": "https://api.github.com/orgs/jekyll/hooks",
+  "issues_url": "https://api.github.com/orgs/jekyll/issues",
+  "members_url": "https://api.github.com/orgs/jekyll/members{/member}",
+  "public_members_url": "https://api.github.com/orgs/jekyll/public_members{/member}",
+  "avatar_url": "https://avatars0.githubusercontent.com/u/3083652?v=4",
+  "description": "Jekyll is a blog-aware, static site generator in Ruby.",
+  "name": "Jekyll",
+  "company": null,
+  "blog": "https://jekyllrb.com",
+  "location": null,
+  "email": "",
+  "is_verified": true,
+  "has_organization_projects": true,
+  "has_repository_projects": true,
+  "public_repos": 50,
+  "public_gists": 0,
+  "followers": 0,
+  "following": 0,
+  "html_url": "https://github.com/jekyll",
+  "created_at": "2012-12-19T19:37:35Z",
+  "updated_at": "2019-01-27T15:27:32Z",
+  "type": "Organization"
+}

spec/webmock/api_get_user.json

@@ -1,7 +1,8 @@
 {
   "login": "jekyllbot",
   "id": 6166343,
-  "avatar_url": "https://avatars.githubusercontent.com/u/6166343?v=3",
+  "node_id": "MDQ6VXNlcjYxNjYzNDM=",
+  "avatar_url": "https://avatars0.githubusercontent.com/u/6166343?v=4",
   "gravatar_id": "",
   "url": "https://api.github.com/users/jekyllbot",
   "html_url": "https://github.com/jekyllbot",
@@ -25,8 +26,8 @@
   "bio": "I help make working with @jekyll fun and easy.",
   "public_repos": 2,
   "public_gists": 0,
-  "followers": 31,
+  "followers": 68,
   "following": 0,
   "created_at": "2013-12-12T02:49:00Z",
-  "updated_at": "2016-09-23T18:14:57Z"
+  "updated_at": "2017-12-05T21:23:41Z"
 }