codeinventory-github 0.1.1 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 19dae8a55610afeed89a5575c736660b2a21345f
-  data.tar.gz: 29bba4eaaf69703b92a7d013e8b54de7907f9980
+  metadata.gz: c44f83f0f75fe961775c818fbfab9619e2cff06b
+  data.tar.gz: d382f89f51c4352e459dee4973b4586dd9463a1d
 SHA512:
-  metadata.gz: cc84d36b7e0b11382a27a6543ba801823ae22de8484f0946604e4ce95f4deafffdccc8f53b50eac3672e8d5a1e8ebcb5a13200b76dc0351a7f1d9aba3cc20ce9
-  data.tar.gz: 6c7dabbc11ec19c81c6394f2ea2d7d37163180f4164c8b9871364e5b11aff04344b58cc871cc57e16cb4e1006d6a0ee3c11ee1904faba93f9f8d5364c19a14ed
+  metadata.gz: 4a65202527e863c5ba035c37a3fe882db75499b29332a78d3975f9d08717bf2be6aabdc51fd9e393f5282303b1967ec45442ebe4d2b1924a7b013fbc8b875f92
+  data.tar.gz: 6cd71f3db07c98ca99f051434fe5d1bea2ea4a0846344dc6ccf767a9e3a0aacc060d5ce569a69a727415491072c564584a4afb971e05df24fd62dae693be051e

data/README.md

@@ -8,6 +8,20 @@ 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:
+
+* name
+* description
+* license
+* openSourceProject
+* governmentWideReuseProject
+* tags
+* contact > email
+* repository
+* 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.
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -58,6 +72,8 @@ tags:
   - usa
 contact:
   email: example@example.com
+repository: https://github.com/octocat/Spoon-Knife
+organization: ABC Bureau
 ```
 
 #### JSON Format (.codeinventory.json)
@@ -74,7 +90,9 @@ contact:
   ],
   "contact": {
     "email": "example@example.com"
-  }
+  },
+  "repository": "https://github.com/octocat/Spoon-Knife",
+  "organization": "ABC Bureau"
 }
 ```
 

data/bin/console

@@ -2,7 +2,7 @@
 
 require "bundler/setup"
 require "codeinventory"
-require "codeinventory-github"
+require "codeinventory/github"
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.

data/lib/codeinventory/github.rb

@@ -4,7 +4,7 @@ require "base64"
 
 module CodeInventory
   class GitHub
-    VERSION = "0.1.1"
+    VERSION = "0.1.3"
     attr_accessor :org, :overrides, :exclude
 
     def initialize(access_token:, org:, overrides: {}, exclude: [])
@@ -30,6 +30,8 @@ module CodeInventory
         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
       end
       projects
@@ -43,6 +45,8 @@ module CodeInventory
       unless inventory_file.nil?
         file_content = client.contents(repo[:full_name], path: inventory_file[:path])
         raw_content = Base64.decode64(file_content[:content])
+        # Remove UTF-8 BOM if there is one; it throws off JSON.parse
+        raw_content.sub!("\xEF\xBB\xBF".force_encoding("ASCII-8BIT"), "")
         if inventory_file[:name].end_with? ".yml"
           metadata = YAML.load(raw_content).to_hash
         elsif inventory_file[:name].end_with? ".json"
@@ -141,11 +145,22 @@ module CodeInventory
     # Order of precedence:
     # 1. List of overrides
     # 2. CodeInventory metadata file
-    # 3. GitHub repository URL
+    # 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"]
-      repo[:html_url]
+      repo[:private] ? nil : repo[:html_url]
+    end
+
+    # Provies a value for the organization field (optional).
+    # Order of precedence:
+    # 1. List of overrides
+    # 2. CodeInventory metadata file
+    # 3. No organization field
+    def organization(repo, inventory_file_metadata)
+      return @overrides[:organization] if @overrides[:organization]
+      return inventory_file_metadata["organization"] if inventory_file_metadata["organization"]
+      nil
     end
 
     def client

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: codeinventory-github
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.3
 platform: ruby
 authors:
 - Jeff Fredrickson
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-12-29 00:00:00.000000000 Z
+date: 2017-01-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler