codeinventory-github 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d651e57af5487d45ca2a94a294744db0478b534d
-  data.tar.gz: 82a01ed9bcb7f32d1df81fb81c8178b14fcb0497
+  metadata.gz: 4adb87edfb54ee9c5f57ffd5c6ce26ccf6d45c5f
+  data.tar.gz: 933c2da647c7ce18b46f19b64002f422a157e65a
 SHA512:
-  metadata.gz: 261895fe5b3fdd30ff84687caaa3734f3b45dd1aeea9eca98100a0a444aef323aaa0ceb77fcd1b0167a426a459df8cdae2abb814508cc0021fabb2010499e2ea
-  data.tar.gz: 3ad1c942e9bd523c1b73d5cf35b8059153eef3e97b88c62ecb8f64d3e14d549e03084a0bd74987347e0b7c41f147829458afac95edb560eff433c4c32ee45f53
+  metadata.gz: 6e4a5c71fe105acb609f3809066ade8d38543b4ce7b14bb8483e3fb53963ae530c0149a38d2c9a66400c03707f9b808db29731a1e3902ed43b7e4a1b4fc1a087
+  data.tar.gz: b75771c365399b238ea77d6c6bad20bb3a181c22f2b24ae59b8ede6dba3505d727c77b11a46de812bb7ca1c448c6e9b44db714ff83fbced2e6e05fc2ff82172d

data/README.md

@@ -8,16 +8,16 @@ The `codeinventory-github` gem is a [CodeInventory](https://github.com/GSA/codei
 * GitHub metadata
 * Manually specified overrides
 
-This tool currently supports the following code.json fields:
+This tool currently supports the following code.json fields, based on Code.gov metadata 2.0.0:
 
 * name
 * description
-* license
-* openSourceProject
-* governmentWideReuseProject
+* permissions > licenses
+* permissions > usageType
+* permissions > exemptionTexzt
 * tags
 * contact > email
-* repository
+* repositoryURL
 * organization
 
 Most of these are fields required by [Code.gov](https://code.gov/). The plan is to gradually add in the rest of the optional fields.
@@ -70,14 +70,16 @@ If you want more fine-grained control over project metadata beyond what is in th
 ```yaml
 name: Product One
 description: An awesome product.
-license: http://www.usa.gov/publicdomain/label/1.0/
-openSourceProject: 1
-governmentWideReuseProject: 1
+permissions:
+  licenses:
+    - URL: http://www.usa.gov/publicdomain/label/1.0/
+      name: PD
+  usageType: openSource
 tags:
   - usa
 contact:
   email: example@example.com
-repository: https://github.com/octocat/Spoon-Knife
+repositoryURL: https://github.com/octocat/Spoon-Knife
 organization: ABC Bureau
 ```
 
@@ -87,16 +89,19 @@ organization: ABC Bureau
 {
   "name": "Product One",
   "description": "An awesome product.",
-  "license": "http://www.usa.gov/publicdomain/label/1.0/",
-  "openSourceProject": 1,
-  "governmentWideReuseProject": 1,
+  "permissions": {
+    "licenses": [
+      { "URL": "http://www.usa.gov/publicdomain/label/1.0/", name: "PD" }
+    ],
+    "usageType": "openSource"
+  }
   "tags": [
     "usa"
   ],
   "contact": {
     "email": "example@example.com"
   },
-  "repository": "https://github.com/octocat/Spoon-Knife",
+  "repositoryURL": "https://github.com/octocat/Spoon-Knife",
   "organization": "ABC Bureau"
 }
 ```
@@ -144,11 +149,11 @@ If the metadata file does not exist or does not contain a field, and there are n
 
 * name - GitHub repository name
 * description - GitHub repository description
-* license - GitHub repository license
-* openSourceProject - `true` if the repository is public, `false` if it is private
+* permissions > license - GitHub repository license
+* permissions > usageType - `openSource` if the repository is public, `governmentWideReuse` if it is private 
 * tags - GitHub repository topics
 * contact > email - GitHub organization email address
-* repository - GitHub repository URL
+* repositoryURL - GitHub repository URL
 
 If you already specify any of the above items in your GitHub repository, there is no need to specify them in a metadata file.
 

data/lib/codeinventory/github/source.rb

@@ -16,51 +16,56 @@ module CodeInventory
       end
 
       def project(repo_name)
-        headers = { accept: "application/vnd.github.mercy-preview+json" } # for GitHub topics preview
+        # mercy = GitHub topics preview
+        # drax = GitHub license preview
+        headers = {
+          accept: [ "application/vnd.github.mercy-preview+json", "application/vnd.github.drax-preview+json" ]
+        }
         repo = client.repository(repo_name, headers)
         inventory_file_metadata = inventory_file(repo)
         unless inventory_file_metadata.dig("codeinventory", "exclude")
-          repo_metadata = {}
-          repo_metadata["name"] = name(repo, inventory_file_metadata)
-          repo_metadata["description"] = description(repo, inventory_file_metadata)
-          repo_metadata["license"] = license(repo, inventory_file_metadata)
-          repo_metadata["openSourceProject"] = open_source_project(repo, inventory_file_metadata)
-          repo_metadata["governmentWideReuseProject"] = government_wide_reuse_project(repo, inventory_file_metadata)
-          repo_metadata["tags"] = tags(repo, inventory_file_metadata)
-          repo_metadata["contact"] = { "email" => contact_email(repo, inventory_file_metadata) }
-          repo_metadata["repository"] = repository(repo, inventory_file_metadata)
-          organization = organization(repo, inventory_file_metadata)
-          repo_metadata["organization"] = organization(repo, inventory_file_metadata) unless organization.nil?
-          repo_metadata
+          build_metadata(repo, inventory_file_metadata)
         end
       end
 
       def projects
-        headers = { accept: "application/vnd.github.mercy-preview+json" } # for GitHub topics preview
+        # mercy = GitHub topics preview
+        # drax = GitHub license preview
+        headers = {
+          accept: [ "application/vnd.github.mercy-preview+json", "application/vnd.github.drax-preview+json" ]
+        }
         repos = client.organization_repositories(@org, headers)
         repos.delete_if { |repo| exclude.include? repo[:name] }
         projects = []
         repos.each do |repo|
           inventory_file_metadata = inventory_file(repo)
           unless inventory_file_metadata.dig("codeinventory", "exclude")
-            repo_metadata = {}
-            repo_metadata["name"] = name(repo, inventory_file_metadata)
-            repo_metadata["description"] = description(repo, inventory_file_metadata)
-            repo_metadata["license"] = license(repo, inventory_file_metadata)
-            repo_metadata["openSourceProject"] = open_source_project(repo, inventory_file_metadata)
-            repo_metadata["governmentWideReuseProject"] = government_wide_reuse_project(repo, inventory_file_metadata)
-            repo_metadata["tags"] = tags(repo, inventory_file_metadata)
-            repo_metadata["contact"] = { "email" => contact_email(repo, inventory_file_metadata) }
-            repo_metadata["repository"] = repository(repo, inventory_file_metadata)
-            organization = organization(repo, inventory_file_metadata)
-            repo_metadata["organization"] = organization(repo, inventory_file_metadata) unless organization.nil?
-            projects << repo_metadata
+            projects << build_metadata(repo, inventory_file_metadata)
             yield repo_metadata if block_given?
           end
         end
         projects
       end
 
+      def build_metadata(repo, inventory_file_metadata)
+        repo_metadata = {}
+        repo_metadata["name"] = name(repo, inventory_file_metadata)
+        repo_metadata["description"] = description(repo, inventory_file_metadata)
+        usage_type = usage_type(repo, inventory_file_metadata)
+        repo_metadata["permissions"] = {
+          "licenses" => licenses(repo, inventory_file_metadata),
+          "usageType" => usage_type,
+          "exemptionText" => exemption_text(repo, inventory_file_metadata)
+        }
+        repo_metadata["tags"] = tags(repo, inventory_file_metadata)
+        repo_metadata["contact"] = { "email" => contact_email(repo, inventory_file_metadata) }
+        repo_metadata["repositoryURL"] = repository(repo, inventory_file_metadata)
+        repo_metadata["laborHours"] = labor_hours(repo, inventory_file_metadata)
+        organization = organization(repo, inventory_file_metadata)
+        repo_metadata["organization"] = organization unless organization.nil?
+        repo_metadata
+      end
+
       # Checks if the repo has an inventory file. If so, loads its metadata.
       def inventory_file(repo)
         metadata = {}
@@ -104,44 +109,43 @@ module CodeInventory
         repo[:name]
       end
 
-      # Provides a value for the license field.
+      # Provides a value for the permissions.licenses field.
       # Order of precedence:
       # 1. List of overrides
       # 2. CodeInventory metadata file
-      # 3. LICENSE.md or LICENSE file in the repository
+      # 3. GitHub repository license
       # 4. nil
-      def license(repo, inventory_file_metadata)
-        return @overrides[:license] if @overrides[:license]
-        return inventory_file_metadata["license"] if inventory_file_metadata["license"]
-        # Need to set header to quiet warning about using a GitHub preview feature
-        headers = { accept: "application/vnd.github.drax-preview+json" }
-        begin
-          license_meta = client.repository_license_contents(repo[:full_name], headers)
-          license = license_meta[:html_url]
-        rescue Octokit::NotFound ; end
-        license
-      end
-
-      # Provides a value for the openSourceProject field.
+      def licenses(repo, inventory_file_metadata)
+        return @overrides[:permissions][:licenses] if @overrides.dig(:permissions, :licenses)
+        return inventory_file_metadata["permissions"]["licenses"] if inventory_file_metadata.dig("permissions", "licenses")
+        require 'pp'
+        if repo[:license] && repo[:license][:url] && repo[:license][:spdx_id]
+          return [ { "URL": repo[:license][:url], "name": repo[:license][:spdx_id] } ]
+        end
+        nil
+      end
+
+      # Provides a value for the permissions.usageType field.
       # Order of precedence:
       # 1. List of overrides
       # 2. CodeInventory metadata file
-      # 3. GitHub repository public/private status (public=1; private=0)
-      def open_source_project(repo, inventory_file_metadata)
-        return @overrides[:openSourceProject] if @overrides[:openSourceProject]
-        return inventory_file_metadata["openSourceProject"] if inventory_file_metadata["openSourceProject"]
-        repo[:private] ? 0 : 1
+      # 3. GitHub repository public/private status (public=openSource; private=governmentWideReuse)
+      #    Note: exempt* values must be set either in overrides or the metadata file.
+      def usage_type(repo, inventory_file_metadata)
+        return @overrides[:permissions][:usageType] if @overrides.dig(:permissions, :usageType)
+        return inventory_file_metadata["permissions"]["usageType"] if inventory_file_metadata.dig("permissions", "usageType")
+        repo[:private] ? "governmentWideReuse" : "openSource"
       end
 
-      # Provides a value for the governmentWideReuseProject field.
+      # Provides a value for the permissions.exemptionText field.
       # Order of precedence:
       # 1. List of overrides
       # 2. CodeInventory metadata file
-      # 3. 1 (assume government-wide reuse)
-      def government_wide_reuse_project(repo, inventory_file_metadata)
-        return @overrides[:governmentWideReuseProject] if @overrides[:governmentWideReuseProject]
-        return inventory_file_metadata["governmentWideReuseProject"] if inventory_file_metadata["governmentWideReuseProject"]
-        1
+      # 3. nil
+      def exemption_text(repo, inventory_file_metadata)
+        return @overrides[:permissions][:exemptionText] if @overrides.dig(:permissions, :exemptionText)
+        return inventory_file_metadata["permissions"]["exemptionText"] if inventory_file_metadata.dig("permissions", "exemptionText")
+        nil
       end
 
       # Provides a value for the tags field.
@@ -169,17 +173,28 @@ module CodeInventory
         org[:email]
       end
 
-      # Provies a value for the repository field.
+      # Provies a value for the repositoryURL field.
       # Order of precedence:
       # 1. List of overrides
       # 2. CodeInventory metadata file
       # 3. If repo is public, GitHub repository URL, otherwise nil
       def repository(repo, inventory_file_metadata)
-        return @overrides[:repository] if @overrides[:repository]
-        return inventory_file_metadata["repository"] if inventory_file_metadata["repository"]
+        return @overrides[:repositoryURL] if @overrides[:repositoryURL]
+        return inventory_file_metadata["repositoryURL"] if inventory_file_metadata["repositoryURL"]
         repo[:private] ? nil : repo[:html_url]
       end
 
+      # Provies a value for the laborHours field.
+      # Order of precedence:
+      # 1. List of overrides
+      # 2. CodeInventory metadata file
+      # 3. 0
+      def labor_hours(repo, inventory_file_metadata)
+        return @overrides[:laborHours] if @overrides[:laborHours]
+        return inventory_file_metadata["laborHours"] if inventory_file_metadata["laborHours"]
+        0
+      end
+
       # Provies a value for the organization field (optional).
       # Order of precedence:
       # 1. List of overrides

data/lib/codeinventory/github/version.rb

@@ -1,5 +1,5 @@
 module CodeInventory
   module GitHub
-    VERSION = "0.3.1"
+    VERSION = "0.4.0"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: codeinventory-github
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Jeff Fredrickson