codeinventory 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9d36a885396b768230bc4748b7b18dfcf6da7fb8
+  data.tar.gz: e178759f92968f5fa78c53fabf508a87debbca35
+SHA512:
+  metadata.gz: 66f579ac72173b3d8e2a79ffc664b9b982930a2a6f903d5daf7ed60c0cbd7e2d71d4339c58d257a4861946d8ccc255167d2da6d87f72583a7eb63ded95101d40
+  data.tar.gz: 7878947ca4b20cc8d99ba5596eedae88b2932688289b4578fa1cdebae15a65b6becae9d369b4656d51d8edf49e43896c8a1ae8ce9d434f11279f1f4aa349e53f

data/.codeinventory.yml

@@ -0,0 +1,9 @@
+name: CodeInventory
+description: A Ruby gem that harvests project metadata from an agency's repositories.
+license: https://github.com/GSA/codeinventory/blob/master/LICENSE.md
+openSourceProject: 1
+governmentWideReuseProject: 1
+tags:
+  - code.gov
+contact:
+  email: jeffrey.fredrickson@gsa.gov

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.gem

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.13.2

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in codeinventory.gemspec
+gemspec

data/LICENSE.md

@@ -0,0 +1,3 @@
+# License
+
+As a work of the United States Government, this project is in the public domain within the United States.

data/README.md

@@ -0,0 +1,48 @@
+# CodeInventory: The People's Code
+
+*_This is an experimental gem that is currently in an alpha stage. The features and interface are unstable and may change at any time._*
+
+The `codeinventory` gem is a tool to harvest project metadata from an agency's repositories. The harvested metadata can be used to produce a [code.json](https://code.gov/#/policy-guide/docs/compliance/inventory-code) file for [Code.gov](https://code.gov/). The gem includes the ability to pull project metadata from these sources:
+
+* JSON files
+* CSV files
+* GitHub
+
+More sources can be added.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'codeinventory'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install codeinventory
+
+## Usage
+
+```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")
+
+inventory = CodeInventory::Inventory.new(json_source, csv_source, github_source)
+inventory.projects # Returns an array of all projects
+```
+
+## 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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/GSA/codeinventory.

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "spec"
+  t.libs << "lib"
+  t.test_files = FileList['spec/**/*_spec.rb']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "codeinventory"
+
+# 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.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+require "pry"
+Pry.start
+
+# require "irb"
+# IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/codeinventory.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'codeinventory/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "codeinventory"
+  spec.version       = CodeInventory::VERSION
+  spec.authors       = ["Jeff Fredrickson"]
+  spec.email         = ["jeffrey.fredrickson@gsa.gov"]
+
+  spec.summary       = %q{Harvests project metadata from an agency's repositories to build a code inventory.}
+  spec.description   = %q{Harvests project metadata from an agency's repositories to build a code inventory. This helps agencies comply with the Federal Source Code Policy.}
+  spec.homepage      = "https://github.com/GSA/codeinventory"
+  spec.license       = "CC0-1.0"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "webmock", "~> 2.1"
+  spec.add_development_dependency "pry", "~> 0.10"
+
+  spec.add_runtime_dependency "octokit", "~> 4.6"
+end

data/lib/codeinventory.rb

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

data/lib/codeinventory/inventory.rb

@@ -0,0 +1,13 @@
+module CodeInventory
+  class Inventory
+    attr_accessor :sources
+
+    def initialize(*sources)
+      @sources = [sources].flatten
+    end
+
+    def projects
+      @sources.collect { |source| source.projects }.flatten
+    end
+  end
+end

data/lib/codeinventory/source/csv_file.rb

@@ -0,0 +1,50 @@
+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

@@ -0,0 +1,47 @@
+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

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

data/lib/codeinventory/version.rb

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

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification
+name: codeinventory
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jeff Fredrickson
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-11-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: octokit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.6'
+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: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".codeinventory.yml"
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- codeinventory.gemspec
+- lib/codeinventory.rb
+- lib/codeinventory/inventory.rb
+- lib/codeinventory/source/csv_file.rb
+- lib/codeinventory/source/github.rb
+- lib/codeinventory/source/json_file.rb
+- lib/codeinventory/version.rb
+homepage: https://github.com/GSA/codeinventory
+licenses:
+- CC0-1.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Harvests project metadata from an agency's repositories to build a code inventory.
+test_files: []