team_api 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e3fb8c4056fcd894efd6bd23346464f4c0dc10a0
-  data.tar.gz: 298e7a962163aaca1700df46beb0ea7daec31872
+  metadata.gz: 95ed3978aeeee3c3d06b646286221dc312863242
+  data.tar.gz: f3c70c2f94311e235e4376fabcf50bf888c43e8a
 SHA512:
-  metadata.gz: 3930284caaee9313aef44bdf898383aa36f1cd391f87fe7c8dbc8ec0afa5148bba4821322d76219597a6e177a6a3bc4ab46a26714a7d01828db9a198753575f6
-  data.tar.gz: 9b7b67b223d5d740673df0667b4699c6f77cde21ab7e25dae84c48a8d67baecb90837bcb8558da21aa1a64aa8a7dcaf51348b09b1b65a037b4c51a9c187153c5
+  metadata.gz: 01bcaf3b059028430dad48e6b8703da39d3694d8c0c6856addb6931671fbd14c75e2e3088ded448c3f14c537fb47107de47d05ee3d950088397b9f031e37cd9c
+  data.tar.gz: 5240cfd63440904c7a79817c5b385a2414730843f7254c6626a5ba0aed40cb309080ac23bb3092dcd0c6c5acdf4d3dc939c4d8311927c619f6f7521186e9dd29

data/CONTRIBUTING.md

@@ -1,10 +1,40 @@
 ## Welcome!
 
-We're so glad you're thinking about contributing to an 18F open source project! If you're unsure or afraid of anything, just ask or submit the issue or pull request anyways. The worst that can happen is that you'll be politely asked to change something. We appreciate any sort of contribution, and don't want a wall of rules to get in the way of that.
+### Code of conduct
 
-Before contributing, we encourage you to read our CONTRIBUTING policy (you are here), our LICENSE, and our README, all of which should be in this repository. If you have any questions, or want to read more about our underlying policies, you can consult the 18F Open Source Policy GitHub repository at https://github.com/18f/open-source-policy, or just shoot us an email/official government letterhead note to [18f@gsa.gov](mailto:18f@gsa.gov).
+We aspire to create a welcoming environment for collaboration on this project.
+To that end, we follow the [18F Code of
+Conduct](https://github.com/18F/code-of-conduct/blob/master/code-of-conduct.md)
+and ask that all contributors do the same.
 
-## Public domain
+### Getting started
+
+We're so glad you're thinking about contributing to an 18F open source project!
+If you're unsure or afraid of anything, just ask or submit the issue or pull
+request anyways. The worst that can happen is that you'll be politely asked to
+change something. We appreciate any sort of contribution, and don't want a wall
+of rules to get in the way of that.
+
+Before contributing, we encourage you to read our CONTRIBUTING policy (you are
+here), our [LICENSE](LICENSE.md), and our [README](REAMDE.md). If you have any
+questions, or want to read more about our underlying policies, you can consult
+the [18F Open Source Policy GitHub
+repository](https://github.com/18f/open-source-policy), or just shoot us an
+email/official government letterhead note to [18f@gsa.gov](mailto:18f@gsa.gov).
+
+### Submitting a pull request
+
+1. Fork the repository or create a branch if you are part of the 18F Team on
+   GitHub
+2. Implement your feature or bug fix (and add test coverage if applicable)
+3. Run the tests (`$ ./go test`) to make sure nothing is broken
+4. Add, commit, and push your changes
+5. [Submit a pull
+   request](https://help.github.com/articles/using-pull-requests/)
+6. Another contributor will merge your pull request into master when it is deemed
+   ready
+
+### Public domain
 
 This project is in the public domain within the United States, and
 copyright and related rights in the work worldwide are waived through

data/lib/team_api/api.rb

@@ -1,53 +1,12 @@
-# @author Mike Bland (michael.bland@gsa.gov)
-
 require_relative 'canonicalizer'
+require_relative 'api_impl'
 require_relative 'config'
+require_relative 'index_page'
 require 'jekyll'
 require 'json'
 require 'safe_yaml'
 
 module TeamApi
-  class IndexPage < ::Jekyll::Page
-    private_class_method :new
-
-    def initialize(site)
-      @site = site
-      @base = site.source
-      @dir = Api::BASEURL
-      @name = 'index.html'
-      @data = {}
-    end
-
-    def self.create(site, index_endpoints)
-      index_page = new site
-      index_page.process index_page.name
-      layout = site.config['api_index_layout']
-      fail '`api_index_layout:` not defined in _config.yml' unless layout
-      index_page.read_yaml File.join(site.source, '_layouts'), layout
-      index_page.data['endpoints'] = index_endpoints
-      site.pages << index_page
-    end
-  end
-
-  class Endpoint < ::Jekyll::Page
-    private_class_method :new
-
-    def initialize(site, endpoint_path)
-      @site = site
-      @base = site.source
-      @dir = endpoint_path
-      @name = 'api.json'
-      @data = {}
-    end
-
-    def self.create(site, endpoint_path, data)
-      endpoint = new site, endpoint_path
-      endpoint.process endpoint.name
-      endpoint.content = data.to_json
-      site.pages << endpoint
-    end
-  end
-
   # Functions for generating JSON objects as part of an API
   class Api
     BASEURL = 'api'
@@ -59,6 +18,7 @@ module TeamApi
       generate_collection_endpoints impl
       generate_tag_category_endpoints impl
       impl.generate_snippets_endpoints
+      impl.generate_error_endpoint
       IndexPage.create site, impl.index_endpoints
     end
 
@@ -87,6 +47,7 @@ module TeamApi
         impl.generate_item_endpoints endpoint_info['collection']
       end
     end
+
     private_class_method :generate_collection_endpoints
 
     def self.generate_tag_category_endpoints(impl)
@@ -95,123 +56,7 @@ module TeamApi
         impl.generate_item_endpoints Canonicalizer.canonicalize(tag_category)
       end
     end
-    private_class_method :generate_tag_category_endpoints
-  end
-
-  module ApiImplSnippetHelpers
-    private
-
-    def snippet_dates
-      @snippet_dates ||= (data['snippets'] || {}).keys.sort.reverse
-    end
-
-    def snippets
-      @snippets ||= snippet_dates.map { |t| [t, data['snippets'][t]] }.to_h
-    end
-
-    def snippets_by_user
-      @snippets_by_user ||= snippets
-        .flat_map { |date, batch| batch.map { |snippet| [date, snippet] } }
-        .group_by { |_date, snippet| snippet['name'] }
-        .map { |name, mapping| [name, mapping.to_h] }
-        .to_h
-    end
-
-    def snippets_summary
-      @snippet_summary ||= {
-        'latest' => snippet_dates.first,
-        'all' => snippet_dates,
-        'users' => Canonicalizer.team_xrefs(
-          data['team'], snippets_by_user.keys),
-      }
-    end
-
-    def generate_latest_snippet_endpoint
-      return if snippets.empty?
-      latest = snippets.first
-      endpoint = 'snippets/latest'
-      Endpoint.create(site, "#{baseurl}/#{endpoint}",
-        { 'datestamp' => latest[0] }.merge(envelop(endpoint, latest[1])))
-    end
-
-    def generate_snippets_by_date_endpoints
-      snippets.each do |timestamp, batch|
-        endpoint = "snippets/#{timestamp}"
-        Endpoint.create site, "#{baseurl}/#{endpoint}", envelop(endpoint, batch)
-      end
-    end
-
-    def generate_snippets_by_user_endpoints
-      snippets_by_user.each do |name, batch|
-        Endpoint.create site, "#{baseurl}/snippets/#{name}", batch
-        Endpoint.create(
-          site, "#{baseurl}/snippets/#{name}/latest", [batch.first].to_h)
-      end
-    end
-
-    def generate_snippets_index_summary_endpoint
-      generate_index_endpoint(
-        'snippets', 'Snippets', 'Summary of all available snippets',
-        snippets_summary) unless snippets.empty?
-    end
-  end
-
-  class ApiImpl
-    attr_accessor :site, :data, :index_endpoints, :baseurl
-    include ApiImplSnippetHelpers
-
-    def initialize(site, baseurl)
-      @site = site
-      @data = site.data
-      @index_endpoints = []
-      @baseurl = baseurl
-    end
-
-    def self_link(endpoint)
-      File.join site.config['url'], baseurl, endpoint
-    end
 
-    def envelop(endpoint, items)
-      return if items.nil? || items.empty?
-      { 'self' => self_link(endpoint), 'results' => items }
-    end
-
-    def generate_index_endpoint(endpoint, title, description, items)
-      return if items.nil? || items.empty?
-      Endpoint.create site, "#{baseurl}/#{endpoint}", items
-      index_endpoints << {
-        'endpoint' => endpoint, 'title' => title, 'description' => description
-      }
-    end
-
-    def generate_tag_category_endpoint(category)
-      canonicalized = Canonicalizer.canonicalize(category)
-      generate_index_endpoint(canonicalized, category,
-        "Index of team members by #{category.downcase}",
-        envelop(canonicalized, (data[canonicalized] || {}).values))
-    end
-
-    def generate_index_endpoint_for_collection(endpoint_info)
-      collection = endpoint_info['collection']
-      generate_index_endpoint(
-        endpoint_info['collection'], endpoint_info['title'],
-        endpoint_info['description'],
-        envelop(collection, (data[collection] || {}).values))
-    end
-
-    def generate_item_endpoints(collection_name)
-      (data[collection_name] || {}).each do |identifier, value|
-        identifier = Canonicalizer.canonicalize(identifier)
-        url = "#{baseurl}/#{collection_name}/#{identifier}"
-        Endpoint.create site, url, value
-      end
-    end
-
-    def generate_snippets_endpoints
-      generate_latest_snippet_endpoint
-      generate_snippets_by_date_endpoints
-      generate_snippets_by_user_endpoints
-      generate_snippets_index_summary_endpoint
-    end
+    private_class_method :generate_tag_category_endpoints
   end
 end

data/lib/team_api/api_impl.rb

@@ -0,0 +1,70 @@
+require_relative 'endpoint'
+require_relative 'api_impl_snippet_helpers'
+require_relative 'api_impl_error_helpers'
+
+module TeamApi
+  class ApiImpl
+    attr_accessor :site, :data, :index_endpoints, :baseurl
+    include ApiImplSnippetHelpers
+    include ApiImplErrorHelpers
+
+    def initialize(site, baseurl)
+      @site = site
+      @data = site.data
+      @index_endpoints = []
+      @baseurl = baseurl
+    end
+
+    def self_link(endpoint)
+      File.join site.config['url'], baseurl, endpoint
+    end
+
+    def envelop(endpoint, items)
+      return if items.nil? || items.empty?
+      { 'self' => self_link(endpoint), 'results' => items }
+    end
+
+    def generate_index_endpoint(endpoint, title, description, items)
+      return if items.nil? || items.empty?
+      Endpoint.create site, "#{baseurl}/#{endpoint}", items
+      index_endpoints << {
+        'endpoint' => endpoint, 'title' => title, 'description' => description
+      }
+    end
+
+    def generate_tag_category_endpoint(category)
+      canonicalized = Canonicalizer.canonicalize(category)
+      generate_index_endpoint(canonicalized, category,
+        "Index of team members by #{category.downcase}",
+        envelop(canonicalized, (data[canonicalized] || {}).values))
+    end
+
+    def generate_index_endpoint_for_collection(endpoint_info)
+      collection = endpoint_info['collection']
+      generate_index_endpoint(
+        endpoint_info['collection'], endpoint_info['title'],
+        endpoint_info['description'],
+        envelop(collection, (data[collection] || {}).values))
+    end
+
+    def generate_item_endpoints(collection_name)
+      (data[collection_name] || {}).each do |identifier, value|
+        identifier = Canonicalizer.canonicalize(identifier)
+        url = "#{baseurl}/#{collection_name}/#{identifier}"
+        Endpoint.create site, url, value
+      end
+    end
+
+    def generate_snippets_endpoints
+      generate_latest_snippet_endpoint
+      generate_snippets_by_date_endpoints
+      generate_snippets_by_user_endpoints
+      generate_snippets_index_summary_endpoint
+    end
+
+    def generate_error_endpoint
+      generate_errors_endpoint
+      generate_errors_index_summary_endpoint
+    end
+  end
+end

data/lib/team_api/api_impl_error_helpers.rb

@@ -0,0 +1,34 @@
+module TeamApi
+  module ApiImplErrorHelpers
+    private
+
+    def errors
+      @errors ||= (data['errors'] || {})
+    end
+
+    def missing
+      @missing ||= (data['missing'] || {})
+    end
+
+    def error_summary
+      @error_summary ||= {
+        'errors' => errors,
+        'missing' => missing,
+      }
+    end
+
+    def generate_errors_endpoint
+      return if errors.empty? && missing.empty?
+      endpoint = 'errors'
+      Endpoint.create(site, "#{baseurl}/#{endpoint}", error_summary)
+    end
+
+    def generate_errors_index_summary_endpoint
+      return if errors.empty? && missing.empty?
+      generate_index_endpoint(
+        'errors', 'Errors', '.about.yml parsing errors and ' \
+        'repos missing a .about.yml file.',
+        error_summary)
+    end
+  end
+end

data/lib/team_api/api_impl_snippet_helpers.rb

@@ -0,0 +1,59 @@
+module TeamApi
+  module ApiImplSnippetHelpers
+    private
+
+    def snippet_dates
+      @snippet_dates ||= (data['snippets'] || {}).keys.sort.reverse
+    end
+
+    def snippets
+      @snippets ||= snippet_dates.map { |t| [t, data['snippets'][t]] }.to_h
+    end
+
+    def snippets_by_user
+      @snippets_by_user ||= snippets
+        .flat_map { |date, batch| batch.map { |snippet| [date, snippet] } }
+        .group_by { |_date, snippet| snippet['name'] }
+        .map { |name, mapping| [name, mapping.to_h] }
+        .to_h
+    end
+
+    def snippets_summary
+      @snippet_summary ||= {
+        'latest' => snippet_dates.first,
+        'all' => snippet_dates,
+        'users' => Canonicalizer.team_xrefs(
+          data['team'], snippets_by_user.keys),
+      }
+    end
+
+    def generate_latest_snippet_endpoint
+      return if snippets.empty?
+      latest = snippets.first
+      endpoint = 'snippets/latest'
+      Endpoint.create(site, "#{baseurl}/#{endpoint}",
+        { 'datestamp' => latest[0] }.merge(envelop(endpoint, latest[1])))
+    end
+
+    def generate_snippets_by_date_endpoints
+      snippets.each do |timestamp, batch|
+        endpoint = "snippets/#{timestamp}"
+        Endpoint.create site, "#{baseurl}/#{endpoint}", envelop(endpoint, batch)
+      end
+    end
+
+    def generate_snippets_by_user_endpoints
+      snippets_by_user.each do |name, batch|
+        Endpoint.create site, "#{baseurl}/snippets/#{name}", batch
+        Endpoint.create(
+          site, "#{baseurl}/snippets/#{name}/latest", [batch.first].to_h)
+      end
+    end
+
+    def generate_snippets_index_summary_endpoint
+      generate_index_endpoint(
+        'snippets', 'Snippets', 'Summary of all available snippets',
+        snippets_summary) unless snippets.empty?
+    end
+  end
+end

data/lib/team_api/endpoint.rb

@@ -0,0 +1,22 @@
+require 'jekyll'
+
+module TeamApi
+  class Endpoint < ::Jekyll::Page
+    private_class_method :new
+
+    def initialize(site, endpoint_path)
+      @site = site
+      @base = site.source
+      @dir = endpoint_path
+      @name = 'api.json'
+      @data = {}
+    end
+
+    def self.create(site, endpoint_path, data)
+      endpoint = new site, endpoint_path
+      endpoint.process endpoint.name
+      endpoint.content = data.to_json
+      site.pages << endpoint
+    end
+  end
+end

data/lib/team_api/index_page.rb

@@ -0,0 +1,23 @@
+module TeamApi
+  class IndexPage < ::Jekyll::Page
+    private_class_method :new
+
+    def initialize(site)
+      @site = site
+      @base = site.source
+      @dir = Api::BASEURL
+      @name = 'index.html'
+      @data = {}
+    end
+
+    def self.create(site, index_endpoints)
+      index_page = new site
+      index_page.process index_page.name
+      layout = site.config['api_index_layout']
+      fail '`api_index_layout:` not defined in _config.yml' unless layout
+      index_page.read_yaml File.join(site.source, '_layouts'), layout
+      index_page.data['endpoints'] = index_endpoints
+      site.pages << index_page
+    end
+  end
+end

data/lib/team_api/joiner.rb

@@ -4,9 +4,6 @@ require_relative 'api'
 require 'hash-joiner'
 
 module TeamApi
-  class UnknownTeamMemberReferenceError < StandardError
-  end
-
   class UnknownSnippetUsernameError < StandardError
   end
 
@@ -20,17 +17,68 @@ module TeamApi
     def self.join_data(site)
       impl = JoinerImpl.new site
       site.data.merge! impl.collection_data
-      impl.create_indexes
       impl.promote_or_remove_data
+      impl.init_team_data site.data['team']
       impl.join_project_data
       Api.add_self_links site
       impl.join_snippet_data
     end
   end
 
+  class TeamIndexer
+    def initialize(data)
+      @team = data
+    end
+
+    def team
+      @team || {}
+    end
+
+    def create_indexes
+      team_by_email
+      team_by_github
+    end
+
+    # Returns an index of team member usernames keyed by email address.
+    def team_by_email
+      @team_by_email ||= team_index_by_field 'email'
+    end
+
+    # Returns an index of team member usernames keyed by email address.
+    def team_by_github
+      @team_by_github ||= team_index_by_field 'github'
+    end
+
+    # Returns an index of team member usernames keyed by a particular field.
+    def team_index_by_field(field)
+      team_members.map do |member|
+        value = member[field]
+        value = member['private'][field] if value.nil? && member['private']
+        [value, member['name']] unless value.nil?
+      end.compact.to_h
+    end
+
+    # Returns the list of team members, with site.data['team']['private']
+    # members included.
+    def team_members
+      @team_members ||= team.map { |key, value| value unless key == 'private' }
+        .compact
+        .concat((team['private'] || {}).values)
+    end
+
+    def team_member_key(ref)
+      (ref.is_a? String) ? ref : (ref['id'] || ref['email'] || ref['github'])
+    end
+
+    def team_member_from_reference(reference)
+      key = team_member_key reference
+      team[key] || team[team_by_email[key] || team_by_github[key]]
+    end
+  end
+
   # Implements Joiner operations.
   class JoinerImpl
-    attr_reader :site, :data, :public_mode
+    attr_reader :site, :data, :public_mode, :team_indexer
 
     # +site+:: Jekyll site data object
     def initialize(site)
@@ -39,6 +87,11 @@ module TeamApi
       @public_mode = site.config['public']
     end
 
+    def init_team_data(data)
+      @team_indexer = TeamIndexer.new data
+      team_indexer.create_indexes
+    end
+
     def collection_data
       @collection_data ||= site.collections.map do |data_class, collection|
         groups = groups collection
@@ -75,43 +128,17 @@ module TeamApi
       # convention takes hold, hopefully.
       projects = (data['projects'] ||= {})
       projects.delete_if { |_, p| p['status'] == 'Hold' } if @public_mode
-      projects.values.each { |p| join_team_list p['team'] }
-    end
-
-    def team
-      data['team'] ||= {}
-    end
-
-    def create_indexes
-      team_by_email
-      team_by_github
-    end
-
-    # Returns an index of team member usernames keyed by email address.
-    def team_by_email
-      @team_by_email ||= team_index_by_field 'email'
-    end
-
-    # Returns an index of team member usernames keyed by email address.
-    def team_by_github
-      @team_by_github ||= team_index_by_field 'github'
+      projects.values.each do |p|
+        errors = p['errors'] || []
+        join_team_list p['team'], errors
+        store_project_errors p, errors unless errors.empty?
+      end
     end
 
-    # Returns an index of team member usernames keyed by a particular field.
-    def team_index_by_field(field)
-      team_members.map do |member|
-        value = member[field]
-        value = member['private'][field] if value.nil? && member['private']
-        [value, member['name']] unless value.nil?
-      end.compact.to_h
-    end
-
-    # Returns the list of team members, with site.data['team']['private']
-    # members included.
-    def team_members
-      @team_members ||= team.map { |key, value| value unless key == 'private' }
-        .compact
-        .concat((team['private'] || {}).values)
+    def store_project_errors(project, errors)
+      project['errors'] = errors
+      name = project['github'][0] || project['name']
+      data['errors'][name] |= errors unless data['errors'].nil?
     end
 
     # Replaces each member of team_list with a key into the team hash.
@@ -121,21 +148,17 @@ module TeamApi
     # - Strings that are GitHub usernames
     # - Hashes that contain an 'email' property
     # - Hashes that contain a 'github' property
-    def join_team_list(team_list)
+    def join_team_list(team_list, errors)
       (team_list || []).map! do |reference|
-        member = team_member_from_reference reference
+        member = team_indexer.team_member_from_reference reference
         if member.nil?
-          fail UnknownTeamMemberReferenceError, reference unless public_mode
+          errors << 'Unknown Team Member: ' +
+            team_indexer.team_member_key(reference)
+          nil
         else
           member['name']
         end
-      end.compact
-    end
-
-    def team_member_from_reference(reference)
-      key = (reference.instance_of? String) ? reference : (
-        reference['id'] || reference['email'] || reference['github'])
-      team[key] || team[team_by_email[key] || team_by_github[key]]
+      end.compact! || []
     end
 
     SNIPPET_JOIN_FIELDS = %w(name full_name first_name last_name self)
@@ -155,7 +178,7 @@ module TeamApi
 
     def join_snippet(snippet)
       username = snippet['username']
-      member = team[username] || team[team_by_email[username]]
+      member = team_indexer.team_member_from_reference username
 
       if member.nil?
         fail UnknownSnippetUsernameError, username unless public_mode

data/lib/team_api/version.rb

@@ -1,5 +1,5 @@
 # @author Mike Bland (michael.bland@gsa.gov)
 
 module TeamApi
-  VERSION = '0.0.5'
+  VERSION = '0.0.6'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: team_api
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Mike Bland
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-01 00:00:00.000000000 Z
+date: 2015-10-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -206,14 +206,19 @@ files:
 - lib/team_api.rb
 - lib/team_api/README.md
 - lib/team_api/api.rb
+- lib/team_api/api_impl.rb
+- lib/team_api/api_impl_error_helpers.rb
+- lib/team_api/api_impl_snippet_helpers.rb
 - lib/team_api/canonicalizer.rb
 - lib/team_api/collection_canonicalizer.rb
 - lib/team_api/config.rb
 - lib/team_api/cross_reference_data.rb
 - lib/team_api/cross_referencer.rb
+- lib/team_api/endpoint.rb
 - lib/team_api/endpoints.yml
 - lib/team_api/front_matter.rb
 - lib/team_api/generator.rb
+- lib/team_api/index_page.rb
 - lib/team_api/joiner.rb
 - lib/team_api/name_canonicalizer.rb
 - lib/team_api/snippets.rb