codeinventory-github 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 14db941ce2b924355eaffb6c538731d1da65990b
+  data.tar.gz: 51069e1abc8f558d31839501a933c9ce3850928a
+SHA512:
+  metadata.gz: b490bf919711a73cf0c4a3c6c7f014efe96f6c6628a158138e5dd8e3e55ee6a17e0e114afb1e67ba16bae604bda35c488606c0cfe146c5ebfec59a13f4fa4cc4
+  data.tar.gz: 043d08d40d9d9eed3a5382bc5ae354f10541a25231a3b72dd8f0e799659215c3e5f988a654434c2edeb55a9d179a09dae2cad83d25861c32624800cd9ef3bfa8

data/.codeinventory.yml

@@ -0,0 +1,9 @@
+name: CodeInventory GitHub
+description: A plugin for the CodeInventory gem that harvests project metadata from YAML or JSON files in GitHub repositories.
+license: https://github.com/GSA/codeinventory-github/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-github.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,79 @@
+# CodeInventory GitHub
+
+*_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-github` gem is a [CodeInventory](https://github.com/GSA/codeinventory) plugin. This plugin allows CodeInventory to gather metadata from `.codeinventory.yml` or `.codeinventory.json` files in GitHub repositories.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'codeinventory-github'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install codeinventory-github
+
+## Usage
+
+Basically:
+
+```ruby
+require "codeinventory"
+require "codeinventory-github"
+
+github_source = CodeInventory::GitHub.new(access_token: "GITHUB_ACCESS_TOKEN", org: "github_org_name")
+
+inventory = CodeInventory::Inventory.new(github_source)
+inventory.projects # Returns an array of all projects in the GitHub org that have metadata
+```
+
+When using `CodeInventory::GitHub`, provide a [GitHub access token](https://developer.github.com/v3/oauth/) and the GitHub organization name (e.g., "[GSA](https://github.com/GSA/)"). Each repository within the organization that needs to be included in the project listing should have a `.codeinventory.yml` or `.codeinventory.json` file in the repository's root directory.
+
+#### YAML Format (.codeinventory.yml)
+
+```yaml
+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
+```
+
+#### JSON Format (.codeinventory.json)
+
+```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"
+  }
+}
+```
+
+## 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 [`github.rb`](/lib/codeinventory/github.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-github.

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,15 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "codeinventory"
+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.
+
+# (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-github.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'codeinventory/github'
+
+Gem::Specification.new do |spec|
+  spec.name          = "codeinventory-github"
+  spec.version       = CodeInventory::GitHub::VERSION
+  spec.authors       = ["Jeff Fredrickson"]
+  spec.email         = ["jeffrey.fredrickson@gsa.gov"]
+
+  spec.summary       = %q{Harvests project metadata from YAML or JSON files in GitHub repositories.}
+  spec.description   = %q{A plugin for the CodeInventory gem that harvests project metadata from YAML or JSON files in GitHub repositories.}
+  spec.homepage      = "https://github.com/GSA/codeinventory-github"
+  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 "codeinventory", "~> 0.1.0"
+  spec.add_runtime_dependency "octokit", "~> 4.6"
+end

data/lib/codeinventory/github.rb

@@ -0,0 +1,46 @@
+require "octokit"
+require "yaml"
+require "base64"
+
+module CodeInventory
+  class GitHub
+    VERSION = "0.1.0"
+    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

metadata

@@ -0,0 +1,154 @@
+--- !ruby/object:Gem::Specification
+name: codeinventory-github
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jeff Fredrickson
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-12-06 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: codeinventory
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+- !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: A plugin for the CodeInventory gem that harvests project metadata from
+  YAML or JSON files in GitHub repositories.
+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-github.gemspec
+- lib/codeinventory/github.rb
+homepage: https://github.com/GSA/codeinventory-github
+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 YAML or JSON files in GitHub repositories.
+test_files: []