sensu-plugins-github 0.0.5 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 24ea0535f42625ae71bad8899063a8e1a89e139e
-  data.tar.gz: 742966426f75029da44ed800b4d4ebf409951781
+  metadata.gz: 4b9945073e5d20947fc066c43eaf72dc0a6fa583
+  data.tar.gz: 814b97411b40fd7fd1f19b2431ee83c920ad1d05
 SHA512:
-  metadata.gz: c4dcc0e4c2e2b34e153d17ce49d31361cf2274ccaa2346b59228c262973ff8c4b5981d200d10f991642e20fd4f48d7ca06b0b7b72d6337b23586508518de77ec
-  data.tar.gz: ca4c20dd4f919de0378b60f24fcba3825b49d81986e1b8840188c4cfe23c433aad163f0c0c67a58f13939b3a2e9dcb6c80c9ca08eb2b538d30c01e58b6b959b2
+  metadata.gz: 3e8f8ab8ea9e795a7a46caed92827402846dbbbad51d6133287062ad8f3b4d746fc344b04706e743b67a8a43282ac111a21e9f5853cac63754d787957254fca1
+  data.tar.gz: 16a7be73168efe7943f9fd1484e7271b1e9ce58630c1fd1589214b02669aa37225b6781f8a4777f6124b5876ed367017dff5cffd1d7cdf404539121183109484

data/CHANGELOG.md

@@ -3,7 +3,19 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 This CHANGELOG follows the format listed at [Keep A Changelog](http://keepachangelog.com/)
 
-## Unreleased][unreleased]
+## Unreleased[unreleased]
+
+## [1.0.0] - 2015-08-14
+### Added
+- check-github-rate-limit.rb for checking the rate limit of a user
+
+### Changed
+- updated documentation urls
+- general gem cleanup
+- changed the name of *github-repo-metrics* to *metrics-github-repo* to keep with convention
+
+### Fixed
+- set binstubs to only be created for Ruby binaries
 
 ## [0.0.5] - 2015-07-14
 ### Changed
@@ -15,7 +27,7 @@ This CHANGELOG follows the format listed at [Keep A Changelog](http://keepachang
 ## [0.0.4] - 2015-06-02
 
 ### Added
-- check-user-2fa.rb 
+- check-user-2fa.rb
     - Check to alert upon org users that do not have 2FA enabled
 
 ### Fixed
@@ -24,3 +36,13 @@ This CHANGELOG follows the format listed at [Keep A Changelog](http://keepachang
 ### Changed
 - removed cruft from /lib
 
+## [0.0.3] - 2015-04-02
+## [0.0.2] - 2015-02-12
+## [0.0.1] - 2015-02-11
+
+[unreleased]: https://github.com/sensu-plugins/sensu-plugins-github/compare/1.0.0...HEAD
+[1.0.0]: https://github.com/sensu-plugins/sensu-plugins-github/compare/0.0.5...1.0.0
+[0.0.5]: https://github.com/sensu-plugins/sensu-plugins-github/compare/0.0.4...0.0.5
+[0.0.4]: https://github.com/sensu-plugins/sensu-plugins-github/compare/0.0.3...0.0.4
+[0.0.3]: https://github.com/sensu-plugins/sensu-plugins-github/compare/0.0.2...0.0.3
+[0.0.2]: https://github.com/sensu-plugins/sensu-plugins-github/compare/0.0.1...0.0.2

data/README.md

@@ -14,14 +14,16 @@
 Interacts with Github API to generate metrics about repo.
 
 ## Files
- * bin/github-repo-metrics.rb
+ * bin/check-github-rate-limit.rb
+ * bin/check-user-2fa.rb
+ * bin/metrics-github-repo.rb
 
 ## Usage
 
-Your github token must be placed in *~/.ssh/git_token*, you should not be entring secure items on the commandline.  The plugin will continue to be backwards compatible for a period but the ability to specify the token on the commandline will be removed in the **0.1.0** release.
+Your github token must be placed in *~/.ssh/git_token*, you should not be entering secure items on the commandline.
 
 ## Installation
 
-[Installation and Setup](https://github.com/sensu-plugins/documentation/blob/master/user_docs/installation_instructions.md)
+[Installation and Setup](http://sensu-plugins.io/docs/installation_instructions.html)
 
 ## Notes

data/bin/check-github-rate-limit.rb

@@ -0,0 +1,98 @@
+#! /usr/bin/env ruby
+#
+#   check-github-rate-llimit.rb
+#
+# DESCRIPTION:
+#   Interacts with Github API to check the rate limit of a user.
+#
+# 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'
+
+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 :crit_threshold,
+         short: '-c THRESHOLD',
+         long: '--critical THRESHOLD',
+         description: 'GH API request threshold',
+         required: true
+
+  def api_request(resource, api, token)
+    endpoint = api + resource
+    request = RestClient::Resource.new(endpoint, timeout: 30)
+    headers = {}
+    headers[:Authorization] = "token #{token}"
+    JSON.parse(request.get(headers))
+  rescue RestClient::ResourceNotFound
+    warning "Resource not found (or not accessible): #{resource}"
+  rescue Errno::ECONNREFUSED
+    warning 'Connection refused'
+  rescue RestClient::RequestFailed => e
+    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'
+
+    data = api_request('/rate_limit', api_url, token)
+
+    rate_val = 5000 - data['resources']['core']['remaining'].to_i
+    crit_val = config[:crit_threshold].to_i
+
+    if rate_val > 0
+      critical("GH api requests are above #{crit_val} for the last hour") if crit_val > rate_val
+    end
+
+    ok
+  end
+end

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

@@ -2,9 +2,9 @@ require 'json'
 
 module SensuPluginsGithub
   module Version
-    MAJOR = 0
+    MAJOR = 1
     MINOR = 0
-    PATCH = 5
+    PATCH = 0
 
     VER_STRING = [MAJOR, MINOR, PATCH].compact.join('.')
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sensu-plugins-github
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 1.0.0
 platform: ruby
 authors:
 - Sensu Plugins and contributors
@@ -30,7 +30,7 @@ cert_chain:
   8sHuVruarogxxKPBzlL2is4EUb6oN/RdpGx2l4254+nyR+abg//Ed27Ym0PkB4lk
   HP0m8WSjZmFr109pE/sVsM5jtOCvogyujQOjNVGN4gz1wwPr
   -----END CERTIFICATE-----
-date: 2015-07-14 00:00:00.000000000 Z
+date: 2015-08-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -61,61 +61,61 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 1.2.0
 - !ruby/object:Gem::Dependency
-  name: codeclimate-test-reporter
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '1.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '1.7'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: codeclimate-test-reporter
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.32.1
+        version: '0.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.32.1
+        version: '0.4'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: github-markup
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '1.3'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '0.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '0.10'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -131,72 +131,74 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '10.0'
 - !ruby/object:Gem::Dependency
-  name: github-markup
+  name: redcarpet
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '3.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '3.2'
 - !ruby/object:Gem::Dependency
-  name: redcarpet
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: 0.32.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: 0.32.1
 - !ruby/object:Gem::Dependency
-  name: yard
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '3.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '3.1'
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: '0.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: '0.8'
 description: Sensu plugins for Github
 email: "<sensu-users@googlegroups.com>"
 executables:
 - github-repo-metrics.rb
 - check-user-2fa.rb
+- check-github-rate-limit.rb
 extensions: []
 extra_rdoc_files: []
 files:
 - CHANGELOG.md
 - LICENSE
 - README.md
+- bin/check-github-rate-limit.rb
 - bin/check-user-2fa.rb
 - bin/github-repo-metrics.rb
 - lib/sensu-plugins-github.rb
@@ -228,7 +230,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Sensu plugins for Github

metadata.gz.sig

@@ -1,3 +1,2 @@
-^����ɥ�r���6
;i���8��m3��wo9�eL�����
-rkz>�t�7�
-��K���(Sx�#3�@��m
+�!��r�[�8�U�!�Z���.OɎѵ�*������W\��9>Z�Ѯ��������c0/�w˨�b��`ձ�[���=�6��o�X=�m6����`[��K�P
+jc�Eoc�w��3�v��ʠ������Ax���1���c=�Vk��i���]��k��s��J��d��Z�팧,���A�Y���n����Tun2O�s-?z�"�s��hx���i2�h�V��