about_yml 0.0.2 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4d6255781f217e0439c558a8d73937e6157d1886
-  data.tar.gz: 7b6074d5d16a6716efe0cb339f6c7bbde8e6f069
+  metadata.gz: a2c2f42bfc38bfad01b3f282ef2369d7becef08b
+  data.tar.gz: 9ff0b51442aeedc72b016d97b2f3a5672e1cb7a2
 SHA512:
-  metadata.gz: f468c80bdce1059710776da06a0a442fe927ddc9d4a823ef10dd717d75247869e73af8d746bbead8f542b231d8309313065ca6f5eb43a26f1dd08d2bdb74e578
-  data.tar.gz: 611821f5b743e6cc6ab971eb34b5b3d3349013628eef6ea88b582e1bed6203edcc704f94905918ffe8feaf44bd9f4fc85ee847ce0ab77afc1289a9a5642fc178
+  metadata.gz: f523e392c10f5e6fa4a94877655205568a29baf0c44e39f74b9baf2088b0bccc704e59b5c98676b1bceac552902eef06ab9dcb0724ac07b2aae52a81a30d5bac
+  data.tar.gz: ce220e63ea4465715f8790009e091e91ef21b19de51cc9ea4037386fb57ccbe93cbfddc2aba52d4c5a8c6ff464a2d49c14b91a8cf7f66a3902946fba7014a9eb

data/bin/about_yml_scrape

@@ -6,7 +6,7 @@ require 'safe_yaml'
 
 USAGE = <<END_USAGE
 Usage: #{$PROGRAM_NAME} github_org [github_token] [missing_outfile] \
-[raw_abouts_file]
+[errors_outfile] [raw_abouts_file] 
 
 Scrapes the .about.yml files from an organization's GitHub repositories and
 writes their contents to standard output as YAML, categorized by visibility
@@ -21,6 +21,8 @@ where:
                      defaults to $HOME/.github_token
   missing_outfile  (optional) path to a file that will contain a list of repos
                      that do not have .about.yml files
+  errors_outfile   (optional) path to a file that will contain a list of repos
+                     with unparsable .about.yml files, and the offending lines
   raw_abouts_file  (optional) if the file exists, the program will read
                      .about.yml data from it rather than scraping GitHub;
                      otherwise, the unprocessed .about.yml data scraped from
@@ -32,7 +34,7 @@ def usage(exitstatus = 0)
   exit exitstatus
 end
 
-github_org, github_token, missing_outfile, raw_abouts_file = ARGV
+github_org, github_token, missing_outfile, errors_outfile, raw_abouts_file = ARGV
 github_token ||= File.join(ENV['HOME'], '.github_token')
 usage 1 unless github_org && File.exist?(github_token)
 
@@ -45,6 +47,9 @@ else
   if missing_outfile
     File.write missing_outfile, fetch_results['missing'].to_yaml
   end
+  if errors_outfile
+    File.write errors_outfile, fetch_results['errors'].to_yaml
+  end
 end
 
 puts(%w(public private).each_with_object({}) do |scope, full_yml|

data/lib/about_yml/about.rb

@@ -45,7 +45,7 @@ module AboutYml
     rescue StandardError => err
       $stderr.puts('Error while parsing .about.yml for ' \
         "#{repo.full_name}:\n #{err}")
-      result['errors'] << repo.full_name
+      result['errors'] << {repo.full_name => err.message} 
     end
     private_class_method :collect_repository_data
 

data/lib/about_yml/schema.json

@@ -28,18 +28,19 @@
         },
         "stage": {
             "type": "string",
-            "enum": ["discovery", "alpha", "beta", "live"],
+            "enum": ["discovery", "alpha", "beta", "live", "sunset", "transfer", "end"],
             "description": "Maturity stage of the project"
         },
-        "status": {
-            "type": "string",
-            "enum": ["active", "deprecated"],
-            "description": "Whether or not the project is actively maintained"
-        },
         "description": {
             "type": "string",
             "description": "Description of the project"
         },
+        "tags": {
+            "type": "array",
+            "description": "Tags that describe the project or aspects of the project",
+            "items": {"type": "string"},
+            "uniqueItems": true
+        },
         "testable": {
             "type": "boolean",
             "default": false,
@@ -59,6 +60,14 @@
             "items": {"type": "string"},
             "uniqueItems": true
         },
+        "users": {
+            "type": "array",
+            "description": "Organizations or individuals who have adopted the project for their own use",
+            "items": {
+                "$ref": "#/definitions/user"
+            },
+            "uniqueItems": true
+        },
         "milestones": {
             "type": "array",
             "description": "Brief descriptions of significant project developments",
@@ -111,11 +120,9 @@
         },
         "contact": {
             "type": "array",
-            "description": "Email addresses of points-of-contact",
+            "description": "URIs for points-of-contact",
             "items": {
-              "type": "string",
-              "description": "Email address",
-              "format": "uri"
+                "$ref": "#/definitions/contact"
             },
             "uniqueItems": true
         }
@@ -142,6 +149,20 @@
                 }
             }
         },
+        "user": {
+            "type": "object",
+            "description": "Organizations or individuals who have adopted the project for their own use",
+            "properties": {
+                "id": {
+                    "type": "string",
+                    "description": "The name of the organization or individual"
+                },
+                "url": {
+                    "type": "string",
+                    "description": "A URL to the user's version of the project"
+                }
+            }
+        },
         "service": {
             "type": "object",
             "description": "Service used to provide project status",
@@ -195,6 +216,21 @@
                     "description": "Anchor text for the link"
                 }
             }
+        },
+        "contact": {
+            "type": "object",
+            "description": "Link to a project contact",
+            "properties": {
+                "url": {
+                    "type": "string",
+                    "description": "URI for the link to ",
+                    "format": "uri"
+                },
+                "text": {
+                    "type": "string",
+                    "description": "Anchor text for the link"
+                }
+            }
         }
     }
 }

data/lib/about_yml/version.rb

@@ -1,5 +1,5 @@
 # @author Mike Bland (michael.bland@gsa.gov)
 
 module AboutYml
-  VERSION = '0.0.2'
+  VERSION = '0.0.4'
 end

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: about_yml
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.4
 platform: ruby
 authors:
 - Mike Bland
+- Alison Rowland
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-04 00:00:00.000000000 Z
+date: 2015-10-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: safe_yaml
@@ -142,6 +143,7 @@ description: The .about.yml mechanism allows an project to publish and maintain
   systems.
 email:
 - michael.bland@gsa.gov
+- alisonrowland@gmail.com
 executables:
 - about_yml_generate
 - about_yml_scrape