codeinventory 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9d36a885396b768230bc4748b7b18dfcf6da7fb8
-  data.tar.gz: e178759f92968f5fa78c53fabf508a87debbca35
+  metadata.gz: 992cc66fc416b27e661d1aa3519a5bb2530bb06a
+  data.tar.gz: 500dbda2306c83785d09b89ce7ad63ef07eba0f1
 SHA512:
-  metadata.gz: 66f579ac72173b3d8e2a79ffc664b9b982930a2a6f903d5daf7ed60c0cbd7e2d71d4339c58d257a4861946d8ccc255167d2da6d87f72583a7eb63ded95101d40
-  data.tar.gz: 7878947ca4b20cc8d99ba5596eedae88b2932688289b4578fa1cdebae15a65b6becae9d369b4656d51d8edf49e43896c8a1ae8ce9d434f11279f1f4aa349e53f
+  metadata.gz: a1ee75116c0d295503b0b7db4411b9e3c2e3796ea7d188b19ff5c2f01771898a2989f0c924446f464afe1641aa160523a9b2d75ece4a6e1360bdb09523f7136f
+  data.tar.gz: f88d4b3e63b10e470fdef237521fbb186e35768369e10794268de2b514177a638198bde82bf894906913d8621dc90b7fe40285140d5b9794c83b9799a3b43809

data/README.md

@@ -6,9 +6,8 @@ The `codeinventory` gem is a tool to harvest project metadata from an agency's r
 
 * JSON files
 * CSV files
-* GitHub
 
-More sources can be added.
+More sources can be added via plugins.
 
 ## Installation
 
@@ -28,20 +27,72 @@ Or install it yourself as:
 
 ## Usage
 
+Basically:
+
 ```ruby
-json_source = CodeInventory::Source::JSONFile.new(File.new("some_projects.json"))
-csv_source = CodeInventory::Source::CSVFile.new(File.new("more_projects.csv"))
-github_source = CodeInventory::Source::GitHub.new(access_token: "GITHUB_ACCESS_TOKEN", org: "github_org_name")
+json_source = CodeInventory::JSONFile.new(File.new("some_projects.json"))
+csv_source = CodeInventory::CSVFile.new(File.new("more_projects.csv"))
+
+inventory = CodeInventory::Inventory.new(json_source, csv_source)
+inventory.projects # Returns an array of all projects in the JSON and CSV files
+```
+
+### JSON Source
+
+When using `CodeInventory::JSONFile`, the source file is expected to be a JSON file in the following format:
+
+```json
+[
+  {
+    "name": "Product One",
+    "description": "An awesome product.",
+    "license": "http://www.usa.gov/publicdomain/label/1.0/",
+    "openSourceProject": 1,
+    "governmentWideReuseProject": 1,
+    "tags": [
+      "usa"
+    ],
+    "contact": {
+      "email": "example@example.com"
+    }
+  },
+  {
+    "name": "Product Two",
+    "description": "Another awesome product.",
+    "license": "http://www.usa.gov/publicdomain/label/1.0/",
+    "openSourceProject": 0,
+    "governmentWideReuseProject": 0,
+    "tags": [
+      "national-security",
+      "top-secret"
+    ],
+    "contact": {
+      "email": "example@example.com"
+    }
+  }
+]
+
+```
+
+See the [Code.gov documentation](https://code.gov/#/policy-guide/docs/compliance/inventory-code) for specifics on required fields and value types.
+
+### CSV Source
 
-inventory = CodeInventory::Inventory.new(json_source, csv_source, github_source)
-inventory.projects # Returns an array of all projects
+When using `CodeInventory::CSVFile`, the source file is expected to be a CSV file in the following format:
+
+```csv
+name,description,license,openSourceProject,governmentWideReuseProject,tags,contact.email
+Product One,An awesome product.,http://www.usa.gov/publicdomain/label/1.0/,1,1,usa,example@example.com
+Product Two,Another awesome product.,http://www.usa.gov/publicdomain/label/1.0/,0,0,"national-security,top-secret",example@example.com
 ```
 
+See the [Code.gov documentation](https://code.gov/#/policy-guide/docs/compliance/inventory-code) for specifics on required fields and value types.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in [`version.rb`](/lib/codeinventory/version.rb), and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 ## Contributing
 

data/codeinventory.gemspec

@@ -28,4 +28,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "pry", "~> 0.10"
 
   spec.add_runtime_dependency "octokit", "~> 4.6"
+  spec.add_runtime_dependency "thor", "~> 0.19"
 end

data/exe/codeinv

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require "codeinventory/cli"
+
+CodeInventory::CLI::App.start(ARGV)

data/lib/codeinventory/cli/app.rb

@@ -0,0 +1,35 @@
+require "codeinventory"
+require "thor"
+require "pathname"
+
+module CodeInventory
+  module CLI
+    class App < Thor
+      desc "csv FILENAME", "Build an inventory from a CSV file"
+      def csv(filename)
+        file = Pathname.new(filename)
+        unless File.exist? file
+          puts "No such file: #{file}"
+          exit 1
+        end
+        source = CodeInventory::CSVFile.new(file)
+        inventory = CodeInventory::Inventory.new(source)
+        projects = inventory.projects
+        puts JSON.pretty_generate(projects)
+      end
+
+      desc "json FILENAME", "Build an inventory from a JSON file"
+      def json(filename)
+        file = Pathname.new(filename)
+        unless File.exist? file
+          puts "No such file: #{file}"
+          exit 1
+        end
+        source = CodeInventory::JSONFile.new(file)
+        inventory = CodeInventory::Inventory.new(source)
+        projects = inventory.projects
+        puts JSON.pretty_generate(projects)
+      end
+    end
+  end
+end

data/lib/codeinventory/cli.rb

@@ -0,0 +1 @@
+require "codeinventory/cli/app"

data/lib/codeinventory/csv_file.rb

@@ -0,0 +1,51 @@
+require "csv"
+
+module CodeInventory
+  class CSVFile
+    attr_reader :csv
+
+    def initialize(csv_file)
+      @csv = CSV.read(csv_file, { headers: true, converters: [ :integer ] })
+      validate_headers
+    end
+
+    def projects
+      @csv.collect do |row|
+        csv_data = row.to_hash
+        csv_data.inject({}) do |memo, pair|
+          csv_header, csv_value = pair
+          case
+          when csv_header == "tags"
+            new_pair = { "tags" => csv_value.split(",").collect { |tag| tag.strip } }
+          when csv_header.include?(".")
+            new_pair = dotted_to_nested(csv_header, csv_value)
+          else
+            new_pair = { csv_header => csv_value }
+          end
+          memo.merge(new_pair)
+        end
+      end
+    end
+
+    private
+
+    # Convert a dotted notation header and a value to a nested hash
+    # e.g., "contact.email" header with value "me@example.com" becomes
+    # { "contact" => { "email" => "me@example.com" } }
+    def dotted_to_nested(path, value)
+      path.split(".").reverse.inject(value) do |hash, element|
+        { element => hash }
+      end
+    end
+
+    def validate_headers
+      required_headers = [ "name", "description", "license", "openSourceProject", "governmentWideReuseProject", "tags", "contact.email" ]
+      required_headers.each do |required|
+        raise FileFormatError unless @csv.headers.include? required
+      end
+    end
+  end
+
+  class FileFormatError < StandardError
+  end
+end

data/lib/codeinventory/json_file.rb

@@ -0,0 +1,11 @@
+require "json"
+
+module CodeInventory
+  class JSONFile
+    attr_accessor :projects
+
+    def initialize(json_file)
+      @projects = JSON.load(json_file)
+    end
+  end
+end

data/lib/codeinventory/version.rb

@@ -1,3 +1,3 @@
 module CodeInventory
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/lib/codeinventory.rb

@@ -1,8 +1,5 @@
 require "codeinventory/version"
 require "codeinventory/inventory"
-require "codeinventory/source/json_file"
-require "codeinventory/source/csv_file"
-require "codeinventory/source/github"
-
-module CodeInventory
-end
+require "codeinventory/cli"
+require "codeinventory/json_file"
+require "codeinventory/csv_file"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: codeinventory
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Jeff Fredrickson
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-11-15 00:00:00.000000000 Z
+date: 2017-01-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -94,11 +94,26 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4.6'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
 description: Harvests project metadata from an agency's repositories to build a code
   inventory. This helps agencies comply with the Federal Source Code Policy.
 email:
 - jeffrey.fredrickson@gsa.gov
-executables: []
+executables:
+- codeinv
 extensions: []
 extra_rdoc_files: []
 files:
@@ -112,11 +127,13 @@ files:
 - bin/console
 - bin/setup
 - codeinventory.gemspec
+- exe/codeinv
 - lib/codeinventory.rb
+- lib/codeinventory/cli.rb
+- lib/codeinventory/cli/app.rb
+- lib/codeinventory/csv_file.rb
 - lib/codeinventory/inventory.rb
-- lib/codeinventory/source/csv_file.rb
-- lib/codeinventory/source/github.rb
-- lib/codeinventory/source/json_file.rb
+- lib/codeinventory/json_file.rb
 - lib/codeinventory/version.rb
 homepage: https://github.com/GSA/codeinventory
 licenses:

data/lib/codeinventory/source/csv_file.rb

@@ -1,50 +0,0 @@
-require "csv"
-
-module CodeInventory
-  module Source
-    class CSVFile
-      attr_reader :csv
-
-      def initialize(csv_file)
-        @csv = CSV.read(csv_file, { headers: true, converters: [ :integer ] })
-        validate_headers
-      end
-
-      def projects
-        @csv.collect do |row|
-          csv_data = row.to_hash
-          csv_data.inject({}) do |memo, pair|
-            csv_header, csv_value = pair
-            case
-            when csv_header == "tags"
-              new_pair = { "tags" => csv_value.split(",").collect { |tag| tag.strip } }
-            when csv_header.include?(".")
-              new_pair = dotted_to_nested(csv_header, csv_value)
-            else
-              new_pair = { csv_header => csv_value }
-            end
-            memo.merge(new_pair)
-          end
-        end
-      end
-
-      private
-
-      def dotted_to_nested(path, value)
-        path.split(".").reverse.inject(value) do |hash, element|
-          { element => hash }
-        end
-      end
-
-      def validate_headers
-        required_headers = [ "name", "description", "license", "openSourceProject", "governmentWideReuseProject", "tags", "contact.email" ]
-        required_headers.each do |required|
-          raise FileFormatError unless @csv.headers.include? required
-        end
-      end
-    end
-
-    class FileFormatError < StandardError
-    end
-  end
-end

data/lib/codeinventory/source/github.rb

@@ -1,47 +0,0 @@
-require "octokit"
-require "yaml"
-require "base64"
-
-module CodeInventory
-  module Source
-    class GitHub
-      attr_accessor :org
-
-      def initialize(access_token:, org:)
-        Octokit.auto_paginate = true
-        @access_token = access_token
-        @org = org
-      end
-
-      def projects
-        repos = client.organization_repositories(@org)
-        projects = []
-        repos.each do |repo|
-          begin
-            contents_metadata = client.contents(repo[:full_name], path: ".codeinventory.yml")
-            type = :yaml
-            raw_content = Base64.decode64(contents_metadata[:content])
-          rescue Octokit::NotFound
-            begin
-              contents_metadata = client.contents(repo[:full_name], path: ".codeinventory.json")
-              type = :json
-              raw_content = Base64.decode64(contents_metadata[:content])
-            rescue Octokit::NotFound
-              # Ignore repositories that don't have a CodeInventory metadata file
-            end
-          end
-          if type == :yaml
-            projects << YAML.load(raw_content).to_hash
-          elsif type == :json
-            projects << JSON.parse(raw_content)
-          end
-        end
-        projects
-      end
-
-      def client
-        @client ||= Octokit::Client.new(access_token: @access_token)
-      end
-    end
-  end
-end

data/lib/codeinventory/source/json_file.rb

@@ -1,13 +0,0 @@
-require "json"
-
-module CodeInventory
-  module Source
-    class JSONFile
-      attr_accessor :projects
-
-      def initialize(json_file)
-        @projects = JSON.load(json_file)
-      end
-    end
-  end
-end