hinoki 1.0.0

data/LICENSE

@@ -0,0 +1,201 @@
+                              Apache License
+                        Version 2.0, January 2004
+                     http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+   "License" shall mean the terms and conditions for use, reproduction,
+   and distribution as defined by Sections 1 through 9 of this document.
+
+   "Licensor" shall mean the copyright owner or entity authorized by
+   the copyright owner that is granting the License.
+
+   "Legal Entity" shall mean the union of the acting entity and all
+   other entities that control, are controlled by, or are under common
+   control with that entity. For the purposes of this definition,
+   "control" means (i) the power, direct or indirect, to cause the
+   direction or management of such entity, whether by contract or
+   otherwise, or (ii) ownership of fifty percent (50%) or more of the
+   outstanding shares, or (iii) beneficial ownership of such entity.
+
+   "You" (or "Your") shall mean an individual or Legal Entity
+   exercising permissions granted by this License.
+
+   "Source" form shall mean the preferred form for making modifications,
+   including but not limited to software source code, documentation
+   source, and configuration files.
+
+   "Object" form shall mean any form resulting from mechanical
+   transformation or translation of a Source form, including but
+   not limited to compiled object code, generated documentation,
+   and conversions to other media types.
+
+   "Work" shall mean the work of authorship, whether in Source or
+   Object form, made available under the License, as indicated by a
+   copyright notice that is included in or attached to the work
+   (an example is provided in the Appendix below).
+
+   "Derivative Works" shall mean any work, whether in Source or Object
+   form, that is based on (or derived from) the Work and for which the
+   editorial revisions, annotations, elaborations, or other modifications
+   represent, as a whole, an original work of authorship. For the purposes
+   of this License, Derivative Works shall not include works that remain
+   separable from, or merely link (or bind by name) to the interfaces of,
+   the Work and Derivative Works thereof.
+
+   "Contribution" shall mean any work of authorship, including
+   the original version of the Work and any modifications or additions
+   to that Work or Derivative Works thereof, that is intentionally
+   submitted to Licensor for inclusion in the Work by the copyright owner
+   or by an individual or Legal Entity authorized to submit on behalf of
+   the copyright owner. For the purposes of this definition, "submitted"
+   means any form of electronic, verbal, or written communication sent
+   to the Licensor or its representatives, including but not limited to
+   communication on electronic mailing lists, source code control systems,
+   and issue tracking systems that are managed by, or on behalf of, the
+   Licensor for the purpose of discussing and improving the Work, but
+   excluding communication that is conspicuously marked or otherwise
+   designated in writing by the copyright owner as "Not a Contribution."
+
+   "Contributor" shall mean Licensor and any individual or Legal Entity
+   on behalf of whom a Contribution has been received by Licensor and
+   subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   copyright license to reproduce, prepare Derivative Works of,
+   publicly display, publicly perform, sublicense, and distribute the
+   Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   (except as stated in this section) patent license to make, have made,
+   use, offer to sell, sell, import, and otherwise transfer the Work,
+   where such license applies only to those patent claims licensable
+   by such Contributor that are necessarily infringed by their
+   Contribution(s) alone or by combination of their Contribution(s)
+   with the Work to which such Contribution(s) was submitted. If You
+   institute patent litigation against any entity (including a
+   cross-claim or counterclaim in a lawsuit) alleging that the Work
+   or a Contribution incorporated within the Work constitutes direct
+   or contributory patent infringement, then any patent licenses
+   granted to You under this License for that Work shall terminate
+   as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+   Work or Derivative Works thereof in any medium, with or without
+   modifications, and in Source or Object form, provided that You
+   meet the following conditions:
+
+   (a) You must give any other recipients of the Work or
+       Derivative Works a copy of this License; and
+
+   (b) You must cause any modified files to carry prominent notices
+       stating that You changed the files; and
+
+   (c) You must retain, in the Source form of any Derivative Works
+       that You distribute, all copyright, patent, trademark, and
+       attribution notices from the Source form of the Work,
+       excluding those notices that do not pertain to any part of
+       the Derivative Works; and
+
+   (d) If the Work includes a "NOTICE" text file as part of its
+       distribution, then any Derivative Works that You distribute must
+       include a readable copy of the attribution notices contained
+       within such NOTICE file, excluding those notices that do not
+       pertain to any part of the Derivative Works, in at least one
+       of the following places: within a NOTICE text file distributed
+       as part of the Derivative Works; within the Source form or
+       documentation, if provided along with the Derivative Works; or,
+       within a display generated by the Derivative Works, if and
+       wherever such third-party notices normally appear. The contents
+       of the NOTICE file are for informational purposes only and
+       do not modify the License. You may add Your own attribution
+       notices within Derivative Works that You distribute, alongside
+       or as an addendum to the NOTICE text from the Work, provided
+       that such additional attribution notices cannot be construed
+       as modifying the License.
+
+   You may add Your own copyright statement to Your modifications and
+   may provide additional or different license terms and conditions
+   for use, reproduction, or distribution of Your modifications, or
+   for any such Derivative Works as a whole, provided Your use,
+   reproduction, and distribution of the Work otherwise complies with
+   the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+   any Contribution intentionally submitted for inclusion in the Work
+   by You to the Licensor shall be under the terms and conditions of
+   this License, without any additional terms or conditions.
+   Notwithstanding the above, nothing herein shall supersede or modify
+   the terms of any separate license agreement you may have executed
+   with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+   names, trademarks, service marks, or product names of the Licensor,
+   except as required for reasonable and customary use in describing the
+   origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+   agreed to in writing, Licensor provides the Work (and each
+   Contributor provides its Contributions) on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+   implied, including, without limitation, any warranties or conditions
+   of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+   PARTICULAR PURPOSE. You are solely responsible for determining the
+   appropriateness of using or redistributing the Work and assume any
+   risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+   whether in tort (including negligence), contract, or otherwise,
+   unless required by applicable law (such as deliberate and grossly
+   negligent acts) or agreed to in writing, shall any Contributor be
+   liable to You for damages, including any direct, indirect, special,
+   incidental, or consequential damages of any character arising as a
+   result of this License or out of the use or inability to use the
+   Work (including but not limited to damages for loss of goodwill,
+   work stoppage, computer failure or malfunction, or any and all
+   other commercial damages or losses), even if such Contributor
+   has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+   the Work or Derivative Works thereof, You may choose to offer,
+   and charge a fee for, acceptance of support, warranty, indemnity,
+   or other liability obligations and/or rights consistent with this
+   License. However, in accepting such obligations, You may act only
+   on Your own behalf and on Your sole responsibility, not on behalf
+   of any other Contributor, and only if You agree to indemnify,
+   defend, and hold each Contributor harmless for any liability
+   incurred by, or claims asserted against, such Contributor by reason
+   of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+   To apply the Apache License to your work, attach the following
+   boilerplate notice, with the fields enclosed by brackets "[]"
+   replaced with your own identifying information. (Don't include
+   the brackets!)  The text should be enclosed in the appropriate
+   comment syntax for the file format. We also recommend that a
+   file or class name and description of purpose be included on the
+   same "printed page" as the copyright notice for easier
+   identification within third-party archives.
+
+Copyright 2013 Jake Davis
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -0,0 +1,57 @@
+# Hinoki
+A programmatic interface to the Sensu API. Named after the
+[Japanese tree](http://en.wikipedia.org/wiki/Chamaecyparis_obtusa) which were 
+(are?) once used for Japanese hand fans (Sensu).
+
+## Usage
+This gem is designed to be easy to use and programmatic. It is basically just a
+light Net::HTTP wrapper. Things are namespaced by API endpoint first, and then
+by a DSL-like logical description of the desired task. Where appropriate, the
+same terminology is used across endpoints.
+
+### Configuration
+Hinoki looks for a config file in `~/.hinoki/config`. If it does not find this
+configuration file, it will assume it should contact `localhost:4567` for all
+requests. The config file is JSON format and accepts only a `host` and `port`
+parameter at present.
+
+``` json
+{
+  "host": "sensu.example.com",
+  "port": 5000
+}
+```
+
+### Examples
+``` ruby
+require 'hinoki'
+h = Hinoki.new
+
+h.checks.all
+h.checks.by_name('check_flux_capacitor')
+h.checks.request('check_flux_capacitor', ['my_client'])
+
+h.events.all
+h.events.for_client('my_client')
+h.events.resolve('my_client', 'check_flux_capacitor')
+
+h.clients.all
+h.clients.by_name('my_client')
+h.clients.history('my_client')
+h.clients.delete('my_client')
+
+h.stashes.all
+h.stashes.create('/test', {reason: 'because reasons'}}
+h.stashes.by_name('/test')
+h.stashes.delete('/test')
+
+h.aggregates.all
+h.aggregates.by_name('my_aggregate')
+h.aggregates.summarize('my_aggregate')
+h.aggregates.delete('my_aggregate')
+```
+
+## Author and License
+Jake Davis \<jake.davis5989@gmail.com\>
+
+Apache License, Version 2.0

data/hinoki.gemspec

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+
+lib = File.expand_path('../lib', __FILE__)
+$:.unshift lib unless $:.include?(lib)
+require 'hinoki/version'
+
+Gem::Specification.new do |s|
+  s.name          = 'hinoki'
+  s.version       = Hinoki::VERSION
+  s.summary       = 'Sensu CLI utility'
+  s.description   = 'A programmatic CLI utility for interacting with the Sensu API'
+  s.author        = 'Jake Davis'
+  s.email         = 'jake.davis5989@gmail.com'
+  s.licenses      = 'Apache 2.0'
+  s.homepage      = 'http://github.com/jakedavis/hinoki'
+  s.files         = Dir.glob('**/*')
+  s.require_paths = ['lib']
+end

data/lib/hinoki/aggregates.rb

@@ -0,0 +1,47 @@
+# hinoki/aggregates.rb
+
+require 'hinoki/connection'
+
+class Hinoki
+  module Aggregates
+
+    @conn = Hinoki::Connection.new
+
+    # Return a list of all aggregates
+    def self.all(limit=nil, offset=nil)
+      url = "/aggregates"
+      if limit  then url.append("?limit=#{limit}") end
+      if offset then url.append("&offset=#{offset}") end
+
+      return @conn.get(url)
+    end
+
+    # Return a specific aggregate check
+    def self.by_name(name, age=nil)
+      url = "/aggregates/#{name}"
+      if age then url.append("?age=#{age}") end
+
+      return @conn.get(url)
+    end
+
+    # Delete an aggregate check
+    def self.delete(name)
+      return @conn.delete("/aggregates/#{name}")
+    end
+
+    # Returns the list of aggregates
+    def self.summarize(name, summarize=nil, results=false)
+      url = "/aggregates"
+      if summarize && results
+        url.append("?summarize=#{summarize}&results=#{results}")
+      elsif summarize 
+        url.append("?summarize=#{summarize}")
+      elsif results 
+        url.append("?results=#{results}") 
+      end
+
+      return @conn.get(url)
+    end
+
+  end
+end

data/lib/hinoki/base.rb

@@ -0,0 +1,32 @@
+# hinoki/hinoki.rb
+
+require 'hinoki/aggregates'
+require 'hinoki/clients'
+require 'hinoki/checks'
+require 'hinoki/connection'
+require 'hinoki/events'
+require 'hinoki/stashes'
+
+class Hinoki
+  attr_accessor(:aggregates, :clients, :checks, :events, :stashes)
+  
+  def initialize
+    @conn       = Hinoki::Connection.new
+    @aggregates = Hinoki::Aggregates
+    @checks     = Hinoki::Checks
+    @clients    = Hinoki::Clients
+    @events     = Hinoki::Events
+    @stashes    = Hinoki::Stashes
+  end
+
+  # Delivers information about Sensu and RabbitMQ performance
+  def health(consumers=1, messages=1)
+    return @conn.get("/health?consumers=#{consumers}&messages=#{messages}")
+  end
+
+  # Metadata about the Sensu installation
+  def info
+    return @conn.get('/info')
+  end
+
+end

data/lib/hinoki/checks.rb

@@ -0,0 +1,28 @@
+# hinoki/checks.rb
+
+require 'hinoki/connection'
+
+class Hinoki
+  module Checks
+
+    @conn = Hinoki::Connection.new
+
+    # Lists all checks
+    def self.all
+      return @conn.get('/checks')
+    end
+
+    # Returns info about a specific check
+    def self.by_name(check)
+      return @conn.get("/checks/#{check}")
+    end
+
+    # Request a check to be run
+    def self.request(check, subscribers=[])
+      payload = JSON.generate({check: check, subscribers: subscribers})
+
+      return @conn.post("/checks", payload)
+    end
+
+  end
+end

data/lib/hinoki/clients.rb

@@ -0,0 +1,35 @@
+# hinoki/client.rb
+
+require 'hinoki/connection'
+
+class Hinoki
+  module Clients
+    
+    @conn = Hinoki::Connection.new
+
+    # Retrieves list of all clients
+    def self.all(limit=nil, offset=nil)
+      url = "/clients"
+      if limit  then url.append("?limit=#{limit}") end
+      if offset then url.append("&offset=#{offset}") end
+
+      return @conn.get(url)
+    end
+
+    # Gets info about a specific client
+    def self.by_name(client)
+      return @conn.get("/clients/#{client}")
+    end
+
+    # Deletes a client (and resolves its events)
+    def self.delete(client)
+      return @conn.delete("/clients/#{client}")
+    end
+
+    # Gets recent history of this client's status
+    def self.history(client)
+      return @conn.get("/clients/#{client}/history")
+    end
+
+  end
+end

data/lib/hinoki/config.rb

@@ -0,0 +1,41 @@
+# hinoki/config.rb
+
+require 'json'
+
+class Hinoki
+  class Config
+    attr_accessor(:host, :port)
+
+    def initialize
+      @config = parse_config_file
+      @host = @config['host']
+      @port = @config['port']
+    end
+
+    private
+
+    # Reads the base config file and parses it to a hash
+    def parse_config_file(path=File.join(ENV['HOME'], '.hinoki', 'config'))
+      if !File.exists?(path)
+        puts 'I was unable to find your Hinoki config file!'
+        return defaults 
+      end
+
+      begin 
+        return JSON.parse(File.read(path))
+      rescue JSON::ParserError
+        puts 'I was unable to parse your Hinoki config file!'
+        return defaults
+      end
+    end
+
+    # Default values if the config file cannot be located or read
+    def defaults
+      return {
+        host: 'localhost',
+        port: 4567
+      }
+    end
+
+  end
+end

data/lib/hinoki/connection.rb

@@ -0,0 +1,59 @@
+# hinoki/connection.rb
+
+require 'json'
+require 'net/http'
+require 'hinoki/config'
+
+class Hinoki
+  class Connection
+
+    def initialize
+      @config = Hinoki::Config.new
+      @http = Net::HTTP.new(@config.host, @config.port)
+    end
+
+    # Wrapper around Net::HTTP.get
+    def get(path)
+      return interpret_response(@http.get(path))
+    end
+
+    # Wrapper around Net::HTTP.post
+    def post(path)
+      return interpret_response(@http.post(path))
+    end
+    
+    # Wrapper around Net::HTTP.delete
+    def delete(path)
+      return interpret_response(@http.delete(path))
+    end
+   
+    private
+
+    # Helper to basically handle any repsonse we could get.
+    def interpret_response(response)
+      case response.code.to_i
+      when 200
+        puts 'OK'
+      when 201
+        puts 'Success'
+      when 204
+        puts 'Success; no content'
+        return
+      when 400
+        puts 'Invalid request'
+        return
+      when 404
+        puts 'Resource not found'
+        return
+      when 500
+        puts 'Sensu encountered an error'
+        return
+      else
+        puts 'Unknown HTTP response code ...'
+        return
+      end
+
+      return JSON.parse(response.body)
+    end
+  end
+end

data/lib/hinoki/events.rb

@@ -0,0 +1,26 @@
+# hinoki/events.rb
+
+require 'hinoki/connection'
+
+class Hinoki
+  module Events
+
+    @conn = Hinoki::Connection.new
+
+    # Lists all events
+    def self.all
+      return @conn.get('/events')
+    end
+
+    # Returns events associated with the given client
+    def self.for_client(client)
+      return @conn.get("/events/#{client}")
+    end
+
+    # Clears an event from Sensu
+    def self.resolve(client, check)
+      return @conn.delete("/events/#{client}/#{check}")
+    end
+
+  end
+end

data/lib/hinoki/stashes.rb

@@ -0,0 +1,39 @@
+# hinoki/stashes.rb
+
+require 'json'
+require 'hinoki/connection'
+
+class Hinoki
+  module Stashes
+
+    @conn = Hinoki::Connection.new
+
+    # Lists all stashes
+    def self.all(limit=nil, offset=nil)
+      url = "/stashes"
+      if limit  then url.append("?limit=#{limit}") end
+      if offset then url.append("&offset=#{offset}") end
+      
+      return @conn.get(url)
+    end
+
+    # Add a new stash (JSON formatted)
+    def self.create(path, content, expiration=nil)
+      hash = {path: path, content: content}
+      if expiration then hash.merge!({expire: expiration}) end
+
+      return @conn.post('/stashes', JSON.generate(hash))
+    end 
+
+    # Get information about a specific stash
+    def self.by_name(stash)
+      return @conn.get("/stashes/#{stash}")
+    end
+
+    # Remove a stash
+    def self.delete(stash)
+      return @conn.delete("/stashes/#{stash}")
+    end
+
+  end
+end

data/lib/hinoki/version.rb

@@ -0,0 +1,5 @@
+# hinoki/version.rb
+
+class Hinoki
+  VERSION = '1.0.0'
+end

data/lib/hinoki.rb

@@ -0,0 +1,3 @@
+# hinoki.rb
+require 'hinoki/version'
+require 'hinoki/base'

metadata

@@ -0,0 +1,58 @@
+--- !ruby/object:Gem::Specification
+name: hinoki
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Jake Davis
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-26 00:00:00.000000000 Z
+dependencies: []
+description: A programmatic CLI utility for interacting with the Sensu API
+email: jake.davis5989@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- hinoki.gemspec
+- lib/hinoki/aggregates.rb
+- lib/hinoki/base.rb
+- lib/hinoki/checks.rb
+- lib/hinoki/clients.rb
+- lib/hinoki/config.rb
+- lib/hinoki/connection.rb
+- lib/hinoki/events.rb
+- lib/hinoki/stashes.rb
+- lib/hinoki/version.rb
+- lib/hinoki.rb
+- LICENSE
+- README.md
+homepage: http://github.com/jakedavis/hinoki
+licenses:
+- Apache 2.0
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Sensu CLI utility
+test_files: []