team_api 0.0.10 → 0.0.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7eea87de342e4012fb94967e8eab63740c879d4e
-  data.tar.gz: 57088f7ff058759e77607ac23709c472d4e37053
+  metadata.gz: f31b401ffc417fa83d0ee449df251344d5a335ad
+  data.tar.gz: fa3955bd6883d49800ec50d351e778d41766a65d
 SHA512:
-  metadata.gz: a356708d7b61188ba49b0ad3434cbc092df5ee8f0e19f1bfc8d10e14ad73fe25c8dd4150b8c19a37b39ce0f982ed30e86eed5513b18f5070f1fc702c845ccd97
-  data.tar.gz: 30692609d6d3f5b4aa837e492ee87f11933ddcff7808459a9ed97015eb51a39dc5fbe5a71109f6db8fded6f5330f478010f6d14f54259a36c199953768008754
+  metadata.gz: 0154afdd77ec5af1a0aafef5109aa1fa5b618828842023f678166af63fce7d9e1225cea371a4b4b34853249ff28967ca5c49268fcf5062f919dfff3cf150ec95
+  data.tar.gz: a032bcbcdd2b2682aeb4107779084377ead02f3641751155ae906f04fe13d14add0957134b5f6efa6b391259ee1616e14e154c9241dddc04e54e73e96cc37ef5

data/lib/team_api/api.rb

@@ -17,6 +17,7 @@ module TeamApi
       impl = ApiImpl.new site, BASEURL
       generate_collection_endpoints impl
       generate_tag_category_endpoints impl
+      impl.generate_schema_endpoint team_api_schema_location
       impl.generate_snippets_endpoints
       impl.generate_error_endpoint
       IndexPage.create site, impl.index_endpoints
@@ -58,5 +59,16 @@ module TeamApi
     end
 
     private_class_method :generate_tag_category_endpoints
+
+    def self.team_api_schema_location
+      about_yml = Gem::Specification.find_by_name 'about_yml'
+      if about_yml.nil?
+        nil
+      else
+        "#{about_yml.gem_dir}/lib/about_yml/schema.json"
+      end
+    end
+
+    private_class_method :team_api_schema_location
   end
 end

data/lib/team_api/api_impl.rb

@@ -1,6 +1,7 @@
 require_relative 'endpoint'
 require_relative 'api_impl_snippet_helpers'
 require_relative 'api_impl_error_helpers'
+require 'json'
 
 module TeamApi
   class ApiImpl
@@ -32,6 +33,15 @@ module TeamApi
       }
     end
 
+    def generate_schema_endpoint(schema_file_location)
+      return if schema_file_location.nil? || schema_file_location.empty?
+      file = File.read schema_file_location
+      items = JSON.parse file
+      generate_index_endpoint('schemas', 'Schemas',
+        'Schema used to parse .about.yml files',
+        items)
+    end
+
     def generate_tag_category_endpoint(category)
       canonicalized = Canonicalizer.canonicalize(category)
       generate_index_endpoint(canonicalized, category,

data/lib/team_api/canonicalizer.rb

@@ -19,7 +19,7 @@ module TeamApi
     # Returns a canonicalized, URL-friendly substitute for an arbitrary string.
     # +s+:: string to canonicalize
     def self.canonicalize(s)
-      s.downcase.gsub(/\s+/, '-')
+      s.downcase.gsub(/\s+/, '-') unless s.nil?
     end
 
     def self.team_xrefs(team, usernames)

data/lib/team_api/joiner.rb

@@ -16,7 +16,7 @@ module TeamApi
     # +site+:: Jekyll site data object
     def self.join_data(site)
       impl = JoinerImpl.new site
-      site.data.merge! impl.collection_data
+      impl.restructure_team_data!
       impl.init_team_data site.data['team']
       impl.promote_or_remove_data
       impl.join_project_data
@@ -37,6 +37,7 @@ module TeamApi
     def create_indexes
       team_by_email
       team_by_github
+      team_by_deprecated_name
     end
 
     # Returns an index of team member usernames keyed by email address.
@@ -49,6 +50,11 @@ module TeamApi
       @team_by_github ||= team_index_by_field 'github'
     end
 
+    # Returns an index of team member usernames keyed by deprecated names.
+    def team_by_deprecated_name
+      @team_by_deprecated_name ||= team_index_by_field 'deprecated_name'
+    end
+
     # Returns an index of team member usernames keyed by a particular field.
     def team_index_by_field(field)
       team_members.map do |member|
@@ -67,16 +73,17 @@ module TeamApi
     end
 
     def team_member_key_by_type(ref)
-      (ref.is_a? String) ? ref : (ref['id'] || ref['email'] || ref['github'])
+      (ref.is_a? String) ? ref : (ref['id'] || ref['email'] || ref['github'] || ref['deprecated_name'])
     end
 
     def team_member_key(ref)
       key = team_member_key_by_type(ref).downcase
-      team_by_email[key] || team_by_github[key] || key
+      team_by_email[key] || team_by_github[key] || team_by_deprecated_name[key] || key
     end
 
     def team_member_from_reference(reference)
       key = team_member_key reference
+
       if team['private']
         team[key] || team['private'][key]
       else
@@ -101,37 +108,22 @@ module TeamApi
       @public_mode = site.config['public']
     end
 
+    # Jekyll seems to be removing non-alpha characters from the team member
+    # names, causing the TeamIndexer to not be able to find any team member
+    # matches. This changes all of the team member keys back to what we expect.
+    def restructure_team_data!
+      if !site.data['team'].nil? && site.data['team'].respond_to?(:keys)
+        site.data['team'].keys.each do |key|
+          site.data['team'][site.data['team'][key]['name']] = site.data['team'].delete(key)
+        end
+      end
+    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
-        result = (groups[:public] || {})
-        result.merge!('private' => groups[:private]) if groups[:private]
-        [data_class, result] unless result.empty?
-      end.compact.to_h
-    end
-
-    def groups(collection)
-      collection.docs
-        .select { |doc| doc.data['published'] != false }
-        .group_by { |doc| doc_visibility doc }
-        .map { |group, docs| [group, docs_data(docs)] }
-        .to_h
-    end
-
-    def doc_visibility(doc)
-      parent = File.basename File.dirname(doc.cleaned_relative_path)
-      (parent == 'private') ? :private : :public
-    end
-
-    def docs_data(docs)
-      docs.map { |doc| [doc.basename_without_ext, doc.data] }.to_h
-    end
-
     def promote_or_remove_data
       private_data_method = public_mode ? :remove_data : :promote_data
       HashJoiner.send private_data_method, data, 'private'
@@ -162,6 +154,7 @@ module TeamApi
 
     def get_canonical_reference(reference, errors)
       member = team_indexer.team_member_from_reference reference
+
       if member.nil?
         errors << 'Unknown Team Member: ' +
           team_indexer.team_member_key(reference)

data/lib/team_api/team_member_schema.json

@@ -0,0 +1,86 @@
+{
+  "team": {
+    "title": "team - [team.member].yml files",
+    "description": "Team member metadata",
+    "$schema": "http://json-schema.org/draft-04/hyper-schema",
+    "type": "object",
+    "properties": {
+      "name": {
+        "type": "string",
+        "description": "Unique name for the team member. Must match the file basename."
+      },
+      "deprecated_name": {
+        "type": "string",
+        "description": "Previous value for the `name` field (and the previous file name)"
+      },
+      "full_name": {
+        "type": "string",
+        "description": "Full proper name of the team member"
+      },
+      "first_name": {
+        "type": "string",
+        "description": "Team member's first name"
+      },
+      "last_name": {
+        "type": "string",
+        "description": "Team member's last name"
+      },
+      "github": {
+        "type": "string",
+        "description": "Team member's GitHub username"
+      },
+      "email": {
+        "type": "string",
+        "description": "Team member's email address"
+      },
+      "location": {
+        "type": "string",
+        "description": "Team member's location. Should match a value from the /locations endpoint."
+      },
+      "slack": {
+        "type": "string",
+        "description": "Team member's Slack username"
+      },
+      "resume": {
+        "type": "string",
+        "description": "URL for the team member's resume"
+      },
+      "okrs": {
+        "type": "string",
+        "description": "URL for the team member's OKRs"
+      },
+      "start_date": {
+        "type": "date",
+        "description": "Date on which team member started. Should be in ISO 8601 format (YYYY-MM-DD)"
+      },
+      "end_date": {
+        "type": "date",
+        "description": "Date on which team member left or is expected to leave. Should be in ISO 8601 format (YYYY-MM-DD)"
+      },
+      "skills": {
+        "type": "array",
+        "description": "Skills the team member can contribute to projects",
+        "items": {
+          "type": "string"
+        },
+        "uniqueItems": true
+      },
+      "interests": {
+        "type": "array",
+        "description": "Brief descriptions of team member's interests",
+        "items": {
+          "type": "string"
+        },
+        "uniqueItems": true
+      },
+    },
+    "required": [
+      "name",
+      "full_name",
+      "first_name",
+      "last_name",
+      "email",
+      "location"
+    ]
+  }
+}

data/lib/team_api/version.rb

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

metadata

@@ -1,14 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: team_api
 version: !ruby/object:Gem::Version
-  version: 0.0.10
+  version: 0.0.12
 platform: ruby
 authors:
 - Mike Bland
+- Amanda Robinson
+- Carlo Costino
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-06 00:00:00.000000000 Z
+date: 2016-02-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -196,6 +198,8 @@ description: Compiles information about team members, projects, etc. and exposes
   via a JSON API.
 email:
 - michael.bland@gsa.gov
+- amanda.robinson@gsa.gov
+- carlo.costino@gsa.gov
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -224,6 +228,7 @@ files:
 - lib/team_api/snippets.rb
 - lib/team_api/tag_canonicalizer.rb
 - lib/team_api/tag_categories.yml
+- lib/team_api/team_member_schema.json
 - lib/team_api/version.rb
 homepage: https://github.com/18F/team_api
 licenses:
@@ -245,7 +250,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Compiles team information and publishes it as a JSON API