sensu-plugins-github 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b2a98a86e37ca184e0c311ef0012973d34b659f2
-  data.tar.gz: 020580b54cdee2229aa93be4b00858d9393420bc
+  metadata.gz: bbd54573fea4cce2e2de2e8db098146ca6e17b6f
+  data.tar.gz: 4b61569c0e93d97e27bfc61ed9c24fac1244a88a
 SHA512:
-  metadata.gz: ebd13d377633b2b4b50bd75b45b9dab5a00baf37837d844d2d8fb657b41294003e4305615c855aed6dfc678ad97af5435104929dc1b8639e18d7a04a00d835fb
-  data.tar.gz: ea688c7065d0456b3d0236b269a421ee2eaca27b5fa846cd3bc6fea7aee6b5a1d6b137e179cdd7b8c3808af89c7a4df946ea293feec5992c559997ff471b7f7a
+  metadata.gz: 702750b75c43deb925c12214538a519f6c086f1291fea8a62127dc547e1a000e7282b054d7403435be4f0db43a41c04b4e7cb10454285530dbb54b98aa78759c
+  data.tar.gz: d7eb5ccec49aa290d31950de33426f171ac27c3818b8c9c7c7848c33d22bf25d7d22440b4af8439cd649314f651611a29ed3a2e16f4a5f39469791cd389e0dca

data/CHANGELOG.md

@@ -1,18 +1,18 @@
-#### 0.0.1.alpha.1
-* baseline release, code is identical to the community repo
-* yard doc coverage
+#Change Log
+This project adheres to [Semantic Versioning](http://semver.org/).
 
-#### 0.0.1
-* initial stable release
+This CHANGELOG follows the format listed at [Keep A Changelog](http://keepachangelog.com/)
 
-#### 0.0.2
-* add ability to read got token from file
+## Unreleased][unreleased]
 
-#### 0.0.3
+## [0.0.4] - 2015-06-02
+
+### Added
+- check-user-2fa.rb 
+    - Check to alert upon org users that do not have 2FA enabled
+### Fixed
+- added binstubs
+
+### Changed
+- removed cruft from /lib
 
-* add metadata to gems
-* pin all dev and runtime dependencies
-* add chef provisioner to Vagrantfile
-* fix rubocop issues
-* add new version module
-* add new version and bump tasks

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2015 devops@yieldbot.com
+Copyright (c) 2015 Sensu-Plugins
 
 MIT License
 

data/README.md

@@ -5,6 +5,7 @@
 [![Code Climate](https://codeclimate.com/github/sensu-plugins/sensu-plugins-github/badges/gpa.svg)](https://codeclimate.com/github/sensu-plugins/sensu-plugins-github)
 [![Test Coverage](https://codeclimate.com/github/sensu-plugins/sensu-plugins-github/badges/coverage.svg)](https://codeclimate.com/github/sensu-plugins/sensu-plugins-github)
 [![Dependency Status](https://gemnasium.com/sensu-plugins/sensu-plugins-github.svg)](https://gemnasium.com/sensu-plugins/sensu-plugins-github)
+[ ![Codeship Status for sensu-plugins/sensu-plugins-github](https://codeship.com/projects/107b69f0-cabf-0132-6fa6-22c60209e864/status?branch=master)](https://codeship.com/projects/75587)
 
 ## Functionality
 
@@ -21,39 +22,6 @@ Your github token must be placed in *~/.ssh/git_token*, you should not be entrin
 
 ## Installation
 
-Add the public key (if you haven’t already) as a trusted certificate
-
-```
-gem cert --add <(curl -Ls https://raw.githubusercontent.com/sensu-plugins/sensu-plugins.github.io/master/certs/sensu-plugins.pem)
-gem install sensu-plugins-github -P MediumSecurity
-```
-
-You can also download the key from /certs/ within each repository.
-
-#### Rubygems
-
-`gem install sensu-plugins-github`
-
-#### Bundler
-
-Add *sensu-plugins-github* to your Gemfile and run `bundle install` or `bundle update`
-
-#### Chef
-
-Using the Sensu **sensu_gem** LWRP
-```
-sensu_gem 'sensu-plugins-github' do
-  options('--prerelease')
-  version '0.0.1.alpha.1'
-end
-```
-
-Using the Chef **gem_package** resource
-```
-gem_package 'sensu-plugins-github' do
-  options('--prerelease')
-  version '0.0.1.alpha.1'
-end
-```
+[Installation and Setup](https://github.com/sensu-plugins/documentation/blob/master/user_docs/installation_instructions.md)
 
 ## Notes

data/bin/check-user-2fa.rb

@@ -0,0 +1,104 @@
+#! /usr/bin/env ruby
+#
+#   check-user-2fa.rb
+#
+# DESCRIPTION:
+#   Interacts with Github API to generate metrics about repo.
+#
+# OUTPUT:
+#
+# PLATFORMS:
+#   All
+#
+# DEPENDENCIES:
+#   gem: sensu-plugin
+#   gem: rest-client
+#   gem: json
+#
+# USAGE:
+#
+#
+# NOTES:
+#
+#
+# LICENSE:
+#   Copyright 2015 Yieldbot, devops@yieldbot.com
+#   Released under the same terms as Sensu (the MIT license); see LICENSE
+#   for details.
+#
+
+require 'sensu-plugin/check/cli'
+require 'rest-client'
+require 'json'
+
+# $LOAD_PATH.unshift([File.expand_path(File.dirname(__FILE__)), '..', 'lib'].join('/'))
+# require 'sensu-plugins-github'
+
+class CheckUser2FA < Sensu::Plugin::Check::CLI
+  option :api,
+         short: '-a URL',
+         long: '--api URL',
+         description: 'Github API URL'
+
+  option :token,
+         short: '-t TOKEN',
+         long: '--token TOKEN',
+         description: 'Github OAuth Token'
+
+  option :org,
+         short: '-o ORG',
+         long: '--org ORG',
+         description: 'Github Org',
+         required: true
+
+  option :exclude,
+         short: '-x E',
+         long: '--exclude-list EXCLUDE_LIST',
+         proc:        proc { |a| a.split(/[,;]\s*/) },
+         description: 'List of users to exclude'
+
+  def api_request(resource, api, token) #rubocop:disable all
+    endpoint = api + resource
+    request = RestClient::Resource.new(endpoint, timeout: 30)
+    headers = {}
+    headers[:Authorization] = "token #{ token }"
+    JSON.parse(request.get(headers), symbolize_names: true)
+  rescue RestClient::ResourceNotFound
+    warning "Resource not found (or not accessible): #{resource}"
+  rescue Errno::ECONNREFUSED
+    warning 'Connection refused'
+  rescue RestClient::RequestFailed => e
+    # #YELLOW Better handle github rate limiting case
+    # (with data from e.response.headers)
+    warning "Request failed: #{e.inspect}"
+  rescue RestClient::RequestTimeout
+    warning 'Connection timed out'
+  rescue RestClient::Unauthorized
+    warning 'Missing or incorrect Github API credentials'
+  rescue JSON::ParserError
+    warning 'Github API returned invalid JSON'
+  end
+
+  def run
+    # Set the token from the commandline or read it in from a file.  Preference
+    # is given towards the later and at some point it may be enforced.
+    token = config[:token] || SensuPluginsGithub::Auth.acquire_git_token
+
+    # This is the default url and will be fine for most people,
+    # github enterprise customers will have a url based upon the org name and
+    # will need to set it at the commandline.
+    api_url = config[:api] || 'https://api.github.com'
+
+    # List to hold users who do not have 2FA
+    user_list = []
+
+    exclude_list = config[:exclude] || ''
+
+    data = api_request("/orgs/#{config[:org]}/members?filter=2fa_disabled", api_url, token)
+    data.each do |d|
+      user_list << d[:login] unless exclude_list.include?(d[:login])
+    end
+    critical("The following users don't have 2FA enabled: #{ user_list }") unless user_list == []
+    ok
+  end
+end

data/bin/github-repo-metrics.rb

@@ -14,7 +14,6 @@
 # DEPENDENCIES:
 #   gem: sensu-plugin
 #   gem: rest-client
-#   gem: json
 #
 # USAGE:
 #
@@ -31,7 +30,9 @@
 require 'sensu-plugin/metric/cli'
 require 'rest-client'
 require 'json'
-require 'sensu-plugins-github/auth'
+
+# $:.unshift([File.expand_path(File.dirname(__FILE__)), '..', 'lib'].join('/'))
+# require 'sensu-plugins-github'
 
 #
 # AggregateMetrics

data/lib/sensu-plugins-github.rb

@@ -1,15 +1,2 @@
-
 require 'sensu-plugins-github/version'
-
-# Load the defaults
-
-#
-# Default class
-#
-module SensuPluginsGithub
-  class << self
-  end
-
-  class << self
-  end
-end
+require 'sensu-plugins-github/auth'

data/lib/sensu-plugins-github/auth.rb

@@ -2,11 +2,11 @@
 # Acquire auth for Github
 #
 module SensuPluginsGithub
-  def self.acquire_git_token
-    File.readlines(File.expand_path('~/.ssh/git_token')).each do |line|
-      @github_token = line
-      puts line
-      return line
+  module Auth
+    def self.acquire_git_token
+      File.readlines(File.expand_path('~/.ssh/git_token')).each do |line|
+        @github_token = line
+      end
     end
   end
 end

data/lib/sensu-plugins-github/version.rb

@@ -1,28 +1,11 @@
 require 'json'
 
-# encoding: utf-8
 module SensuPluginsGithub
-  # This defines the version of the gem
   module Version
     MAJOR = 0
     MINOR = 0
-    PATCH = 3
+    PATCH = 4
 
     VER_STRING = [MAJOR, MINOR, PATCH].compact.join('.')
-
-    NAME   = 'sensu-plugins-github'
-    BANNER = "#{NAME} v%s"
-
-    module_function
-
-    def version
-      format(BANNER, VER_STRING)
-    end
-
-    def json_version
-      {
-        'version' => VER_STRING
-      }.to_json
-    end
   end
 end

metadata

@@ -1,10 +1,10 @@
 --- !ruby/object:Gem::Specification
 name: sensu-plugins-github
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
-- Yieldbot, Inc. and contributors
+- Sensu Plugins and contributors
 autorequire: 
 bindir: bin
 cert_chain:
@@ -30,7 +30,7 @@ cert_chain:
   8sHuVruarogxxKPBzlL2is4EUb6oN/RdpGx2l4254+nyR+abg//Ed27Ym0PkB4lk
   HP0m8WSjZmFr109pE/sVsM5jtOCvogyujQOjNVGN4gz1wwPr
   -----END CERTIFICATE-----
-date: 2015-04-02 00:00:00.000000000 Z
+date: 2015-06-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -92,16 +92,16 @@ dependencies:
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.17.0
+        version: '0.30'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.17.0
+        version: '0.30'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -200,15 +200,18 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.10'
-description: Sensu plugins for working with Github
+description: Sensu plugins for Github
 email: "<sensu-users@googlegroups.com>"
-executables: []
+executables:
+- github-repo-metrics.rb
+- check-user-2fa.rb
 extensions: []
 extra_rdoc_files: []
 files:
 - CHANGELOG.md
 - LICENSE
 - README.md
+- bin/check-user-2fa.rb
 - bin/github-repo-metrics.rb
 - lib/sensu-plugins-github.rb
 - lib/sensu-plugins-github/auth.rb
@@ -220,7 +223,10 @@ metadata:
   maintainer: "@mattyjones"
   development_status: active
   production_status: unstable - testing recommended
-post_install_message: 
+  release_draft: 'false'
+  release_prerelease: 'false'
+post_install_message: You can use the embedded Ruby by setting EMBEDDED_RUBY=true
+  in /etc/default/sensu
 rdoc_options: []
 require_paths:
 - lib
@@ -236,9 +242,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
-summary: Sensu plugins for working with Github
+summary: Sensu plugins for Github
 test_files: []
-has_rdoc: