codeinventory-github 0.1.9 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fcdbf327550dd781c0433fc01596d9199a56707b
-  data.tar.gz: 0f01483ec0a4d89d0558b6476b6111bff2b926f0
+  metadata.gz: 9294afff7d3f67ca26ad6f34910f2acf07385d10
+  data.tar.gz: 9d1383ba2fde285619fb8c466d3db5f96b87f7bd
 SHA512:
-  metadata.gz: 98cd2c92bd4b0ec24a6b3dc6c9a9d1e03d6ad4b8e592355542978cdd0512f25864bfa20de097825fee91287faf88de585efbdb8a69bb35f34ee127f9fcb709f0
-  data.tar.gz: 704f4e213ef25761a7f9fab7e098f3111b05315b8702d9dba7fccfa861360151b5a338aaffb4fd712c652a0cfb75ddf77a743be4256352f3920f20ca00dc62a2
+  metadata.gz: 784525c02eaebe5ccd88b865f9a46971835e4766e8e8c4a224db5b1957456c89bb50bf43fd700695123ba546d29af67c29ae705de438216655557245852dda0e
+  data.tar.gz: 6d87d54b5be798fa92765d4b9ecfa2f4800106a8faeb37ddb530331d3cbc4c0e3edcb519f87cea0d7d0d2b588c92a7bde1d1a3c14a51fa8298eb6b5647c8b9ed

data/README.md

@@ -47,7 +47,7 @@ require "codeinventory"
 require "codeinventory/github"
 
 auth = { access_token: "GITHUB_ACCESS_TOKEN" }
-github_source = CodeInventory::GitHub.new(auth, "GITHUB_ORG_NAME")
+github_source = CodeInventory::GitHub::Source.new(auth, "GITHUB_ORG_NAME")
 
 inventory = CodeInventory::Inventory.new(github_source)
 inventory.projects # Returns an array of projects in the GitHub org
@@ -59,7 +59,7 @@ The `codeinventory-github` plugin will then automatically harvest the given orga
 
 This gem uses the [Octokit](https://github.com/octokit/octokit.rb) GitHub client to interface with the GitHub API.
 
-For the `auth` parameter when instantiating `CodeInventory::GitHub`, provide any type of [authentication information that Octokit supports](https://github.com/octokit/octokit.rb#authentication). Examples: a basic login/password, [OAuth access token](https://developer.github.com/v3/oauth/), or application authentication.
+For the `auth` parameter when instantiating `CodeInventory::GitHub::Source`, provide any type of [authentication information that Octokit supports](https://github.com/octokit/octokit.rb#authentication). Examples: a basic login/password, [OAuth access token](https://developer.github.com/v3/oauth/), or application authentication.
 
 ### Using inventory files
 
@@ -133,7 +133,7 @@ overrides = {
     email: "me@example.com"
   }
 }
-github_source = CodeInventory::GitHub.new({ access_token: "GITHUB_ACCESS_TOKEN" }, "GITHUB_ORG_NAME", overrides: overrides)
+github_source = CodeInventory::GitHub::Source.new({ access_token: "GITHUB_ACCESS_TOKEN" }, "GITHUB_ORG_NAME", overrides: overrides)
 ```
 
 In this example, `codeinventory-github` will set the tags on all your projects to `my-tag-1` and `my-tag-2` also use the contact email you specified on all projects.
@@ -144,7 +144,7 @@ You can exclude any repository from scanning.
 
 ```ruby
 exclusions = ["not-a-real-product", "DontScanMe"]
-github_source = CodeInventory::GitHub.new({ access_token: "GITHUB_ACCESS_TOKEN" }, "GITHUB_ORG_NAME", exclude: exclusions)
+github_source = CodeInventory::GitHub::Source.new({ access_token: "GITHUB_ACCESS_TOKEN" }, "GITHUB_ORG_NAME", exclude: exclusions)
 ```
 
 In this example, `codeinventory-github` will ignore the repositories named `not-a-real-product` or `DontScanMe`.

data/lib/codeinventory/github.rb

@@ -1,175 +1,2 @@
-require "octokit"
-require "yaml"
-require "base64"
-
-module CodeInventory
-  class GitHub
-    VERSION = "0.1.9"
-    attr_accessor :org, :overrides, :exclude
-
-    def initialize(auth, org, overrides: {}, exclude: [])
-      Octokit.auto_paginate = true
-      @auth = auth
-      @org = org
-      @overrides = overrides
-      @exclude = exclude
-    end
-
-    def projects
-      repos = client.organization_repositories(@org)
-      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
-          yield repo_metadata if block_given?
-        end
-      end
-      projects
-    end
-
-    # Checks if the repo has an inventory file. If so, loads its metadata.
-    def inventory_file(repo)
-      metadata = {}
-      return metadata if repo[:size] == 0 # Empty repo
-      filenames = [ ".codeinventory.yml", "codeinventory.yml", ".codeinventory.json", "codeinventory.json"]
-      repo_contents = client.contents(repo[:full_name], path: "/")
-      inventory_file = repo_contents.select { |file| filenames.include? file[:name] }.first
-      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"
-          metadata = JSON.parse(raw_content)
-        end
-      end
-      metadata
-    end
-
-    # Provides a value for the name field.
-    # Order of precedence:
-    # 1. CodeInventory metadata file
-    # 2. GitHub repository name
-    def name(repo, inventory_file_metadata)
-      return inventory_file_metadata["name"] if inventory_file_metadata["name"]
-      repo[:name]
-    end
-
-    # Provides a value for the description field.
-    # Order of precedence:
-    # 1. List of overrides
-    # 2. CodeInventory metadata file
-    # 3. GitHub repository description
-    # 4. GitHub repository name
-    def description(repo, inventory_file_metadata)
-      return @overrides[:description] if @overrides[:description]
-      return inventory_file_metadata["description"] if inventory_file_metadata["description"]
-      return repo[:description] if repo[:description]
-      repo[:name]
-    end
-
-    # Provides a value for the license field.
-    # Order of precedence:
-    # 1. List of overrides
-    # 2. CodeInventory metadata file
-    # 3. LICENSE.md or LICENSE file in the repository
-    # 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.
-    # 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
-    end
-
-    # Provides a value for the governmentWideReuseProject 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
-    end
-
-    # Provides a value for the tags field.
-    # Order of precedence:
-    # 1. List of overrides
-    # 2. CodeInventory metadata file
-    # 3. A single tag consisting of the org name.
-    def tags(repo, inventory_file_metadata)
-      return @overrides[:tags] if @overrides[:tags]
-      return inventory_file_metadata["tags"] if inventory_file_metadata["tags"]
-      [repo[:owner][:login]]
-    end
-
-    # Provides a value for the contact.email field.
-    # Order of precedence:
-    # 1. List of overrides
-    # 2. CodeInventory metadata file
-    # 3. GitHub organization email
-    def contact_email(repo, inventory_file_metadata)
-      return @overrides[:contact][:email] if @overrides.dig(:contact, :email)
-      return inventory_file_metadata["contact"]["email"] if inventory_file_metadata.dig("contact", "email")
-      org = client.organization(@org)
-      org[:email]
-    end
-
-    # Provies a value for the repository 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"]
-      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
-      @client ||= Octokit::Client.new(@auth)
-    end
-  end
-end
+require "codeinventory/github/source"
+require "codeinventory/github/version"

data/lib/codeinventory/github/source.rb

@@ -0,0 +1,176 @@
+require "octokit"
+require "yaml"
+require "base64"
+
+module CodeInventory
+  module GitHub
+    class Source
+      attr_accessor :org, :overrides, :exclude
+
+      def initialize(auth, org, overrides: {}, exclude: [])
+        Octokit.auto_paginate = true
+        @auth = auth
+        @org = org
+        @overrides = overrides
+        @exclude = exclude
+      end
+
+      def projects
+        repos = client.organization_repositories(@org)
+        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
+            yield repo_metadata if block_given?
+          end
+        end
+        projects
+      end
+
+      # Checks if the repo has an inventory file. If so, loads its metadata.
+      def inventory_file(repo)
+        metadata = {}
+        return metadata if repo[:size] == 0 # Empty repo
+        filenames = [ ".codeinventory.yml", "codeinventory.yml", ".codeinventory.json", "codeinventory.json"]
+        repo_contents = client.contents(repo[:full_name], path: "/")
+        inventory_file = repo_contents.select { |file| filenames.include? file[:name] }.first
+        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"
+            metadata = JSON.parse(raw_content)
+          end
+        end
+        metadata
+      end
+
+      # Provides a value for the name field.
+      # Order of precedence:
+      # 1. CodeInventory metadata file
+      # 2. GitHub repository name
+      def name(repo, inventory_file_metadata)
+        return inventory_file_metadata["name"] if inventory_file_metadata["name"]
+        repo[:name]
+      end
+
+      # Provides a value for the description field.
+      # Order of precedence:
+      # 1. List of overrides
+      # 2. CodeInventory metadata file
+      # 3. GitHub repository description
+      # 4. GitHub repository name
+      def description(repo, inventory_file_metadata)
+        return @overrides[:description] if @overrides[:description]
+        return inventory_file_metadata["description"] if inventory_file_metadata["description"]
+        return repo[:description] if repo[:description]
+        repo[:name]
+      end
+
+      # Provides a value for the license field.
+      # Order of precedence:
+      # 1. List of overrides
+      # 2. CodeInventory metadata file
+      # 3. LICENSE.md or LICENSE file in the repository
+      # 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.
+      # 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
+      end
+
+      # Provides a value for the governmentWideReuseProject 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
+      end
+
+      # Provides a value for the tags field.
+      # Order of precedence:
+      # 1. List of overrides
+      # 2. CodeInventory metadata file
+      # 3. A single tag consisting of the org name.
+      def tags(repo, inventory_file_metadata)
+        return @overrides[:tags] if @overrides[:tags]
+        return inventory_file_metadata["tags"] if inventory_file_metadata["tags"]
+        [repo[:owner][:login]]
+      end
+
+      # Provides a value for the contact.email field.
+      # Order of precedence:
+      # 1. List of overrides
+      # 2. CodeInventory metadata file
+      # 3. GitHub organization email
+      def contact_email(repo, inventory_file_metadata)
+        return @overrides[:contact][:email] if @overrides.dig(:contact, :email)
+        return inventory_file_metadata["contact"]["email"] if inventory_file_metadata.dig("contact", "email")
+        org = client.organization(@org)
+        org[:email]
+      end
+
+      # Provies a value for the repository 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"]
+        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
+        @client ||= Octokit::Client.new(@auth)
+      end
+    end
+  end
+end

data/lib/codeinventory/github/version.rb

@@ -0,0 +1,5 @@
+module CodeInventory
+  module GitHub
+    VERSION = "0.2.0"
+  end
+end

data/lib/codeinventory_plugin.rb

@@ -5,11 +5,36 @@ require "codeinventory/github"
 module CodeInventory
   module CLI
     class App < Thor
-      desc "github GITHUB_ACCESS_TOKEN GITHUB_ORG [OPTIONS]", "Build an inventory from GitHub"
-      option :overrides, aliases: "-o", type: :hash, default: {}
-      option :exclude, aliases: "-e", type: :array, default: []
-      def github(access_token, org)
-        source = CodeInventory::GitHub.new({ access_token: access_token }, org, overrides: options[:overrides], exclude: options[:exclude])
+      desc "github GITHUB_ORG [OPTIONS]", "Build an inventory from GitHub"
+      option "access-token", aliases: "-a", type: :string, banner: "ACCESS_TOKEN"
+      option "client-credentials", aliases: "-c", type: :string, banner: "CLIENT_ID:CLIENT_SECRET"
+      option "login", aliases: "-l", type: :string, banner: "USERNAME:PASSWORD"
+      option "overrides", aliases: "-o", type: :hash, default: {}
+      option "exclude", aliases: "-e", type: :array, default: []
+      def github(org)
+        unless !options["access-token"].nil? ^ !options["client-credentials"].nil? ^ !options["login"].nil?
+          puts "One authentication method is required (-a, -c, or -l)"
+          exit 1
+        end
+        auth = {}
+        if !options["access-token"].nil?
+          auth = { access_token: options["access-token"] }
+        elsif !options["client-credentials"].nil?
+          values = options["client-credentials"].split(":")
+          unless values.count == 2
+            puts "You must provide client credentials in the format CLIENT_ID:CLIENT_SECRET"
+            exit 1
+          end
+          auth = { client_id: values[0], client_secret: values[1] }
+        elsif !options["login"].nil?
+          values = options["login"].split(":")
+          unless values.count == 2
+            puts "You must provide a login in the format USERNAME:PASSWORD"
+            exit 1
+          end
+          auth = { login: values[0], password: values[1] }
+        end
+        source = CodeInventory::GitHub::Source.new(auth, org, overrides: options[:overrides], exclude: options[:exclude])
         inventory = CodeInventory::Inventory.new(source)
         puts JSON.pretty_generate(inventory.projects)
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: codeinventory-github
 version: !ruby/object:Gem::Version
-  version: 0.1.9
+  version: 0.2.0
 platform: ruby
 authors:
 - Jeff Fredrickson
@@ -127,6 +127,8 @@ files:
 - bin/setup
 - codeinventory-github.gemspec
 - lib/codeinventory/github.rb
+- lib/codeinventory/github/source.rb
+- lib/codeinventory/github/version.rb
 - lib/codeinventory_plugin.rb
 homepage: https://github.com/GSA/codeinventory-github
 licenses: