codeinventory-github 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c44f83f0f75fe961775c818fbfab9619e2cff06b
-  data.tar.gz: d382f89f51c4352e459dee4973b4586dd9463a1d
+  metadata.gz: aa475a83abe7e0ed44fad39563325a277320f750
+  data.tar.gz: 6387ea4038456551087003decfb0019bcf85b958
 SHA512:
-  metadata.gz: 4a65202527e863c5ba035c37a3fe882db75499b29332a78d3975f9d08717bf2be6aabdc51fd9e393f5282303b1967ec45442ebe4d2b1924a7b013fbc8b875f92
-  data.tar.gz: 6cd71f3db07c98ca99f051434fe5d1bea2ea4a0846344dc6ccf767a9e3a0aacc060d5ce569a69a727415491072c564584a4afb971e05df24fd62dae693be051e
+  metadata.gz: c672c99f8c9f63856029014dfcb7f7328813fb1599ae8c11dd8d4967f3aaa89aa2c2ad556fdab87c3303fbf1693cf7d42448edae075aa0ec6e7ae73ddc863caf
+  data.tar.gz: 6c872903b1d5efdebe851c6a0f3cc8fb773b30a36c0552371b95ffdad87fa239dce7f664dbd52a2c5c8f0ca70b3c168fe776088492db040ac8215438ff4b36ab

data/README.md

@@ -46,15 +46,20 @@ Basically:
 require "codeinventory"
 require "codeinventory/github"
 
-github_source = CodeInventory::GitHub.new(access_token: "GITHUB_ACCESS_TOKEN", org: "github_org_name")
+auth = { access_token: "GITHUB_ACCESS_TOKEN" }
+github_source = CodeInventory::GitHub.new(auth, "GITHUB_ORG_NAME")
 
 inventory = CodeInventory::Inventory.new(github_source)
 inventory.projects # Returns an array of projects in the GitHub org
 ```
 
-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/)").
+The `codeinventory-github` plugin will then automatically harvest the given organization's repository metadata from GitHub metadata.
 
-The `codeinventory-github` plugin will then automatically harvest your project metadata from GitHub metadata.
+### Authentication
+
+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.
 
 ### Using inventory files
 
@@ -107,7 +112,7 @@ overrides = {
     email: "me@example.com"
   }
 }
-github_source = CodeInventory::GitHub.new(access_token: "GITHUB_ACCESS_TOKEN", org: "github_org_name", overrides: overrides)
+github_source = CodeInventory::GitHub.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.
@@ -118,7 +123,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", org: "github_org_name", exclude: exclusions)
+github_source = CodeInventory::GitHub.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

@@ -4,12 +4,12 @@ require "base64"
 
 module CodeInventory
   class GitHub
-    VERSION = "0.1.3"
+    VERSION = "0.1.4"
     attr_accessor :org, :overrides, :exclude
 
-    def initialize(access_token:, org:, overrides: {}, exclude: [])
+    def initialize(auth, org, overrides: {}, exclude: [])
       Octokit.auto_paginate = true
-      @access_token = access_token
+      @auth = auth
       @org = org
       @overrides = overrides
       @exclude = exclude
@@ -164,7 +164,7 @@ module CodeInventory
     end
 
     def client
-      @client ||= Octokit::Client.new(access_token: @access_token)
+      @client ||= Octokit::Client.new(@auth)
     end
   end
 end

metadata

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