cephdetail 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 364735d754c347eb09d3adfd7fdc7fb50506d5f3
-  data.tar.gz: ddf6b8b562489dc34421ea8800aa55c177f1cee1
+  metadata.gz: ceee182aa8069023fbfc0b1e49781011ebe956ab
+  data.tar.gz: a4ce7cb5e50d0e10121f97d54847a03c4a0f62b6
 SHA512:
-  metadata.gz: eff00ba84e172ab1ea811ac899b019d9c27e698390855fdb258439bd566fabd29319b4fc1162bf4ff952f5b12f080c556a89419fdb257c547ce0c56d35dfde02
-  data.tar.gz: a1d4a26720c8cc02748b039b34cb237eeb0955a26f010fee3c30771364b4f30bba3a0ad5ecbf127ce5b66228ab77e6470c828607a5f65c301522a7d4e0891ad0
+  metadata.gz: 75df302e460aeb2f68e8356640482577346fd16d49b220e3e3844c27a5e2bcfa836aa63a06989c0cf63358017c635843fcc0c078c753d1b8027c3b80f2738e34
+  data.tar.gz: 158f2b9ff8459b93344f332d6317c22e36fba15b5168cfcb85f96dbbcb0ff73976a413f619508880d5bd103190129d2f1ff9be2649958cc269c5c9947f8eab8d

data/.travis.yml

@@ -1,4 +1,8 @@
 language: ruby
 rvm:
-  - 2.2.3
+  - 1.9.3
+  - 2.0
+  - 2.1
+  - 2.2
+  - jruby
 before_install: gem install bundler -v 1.10.6

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2015 xnoder
+Copyright (c) 2015 Paul Stevens
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,5 +1,8 @@
 # Cephdetail
 
+[![Build Status](https://travis-ci.org/xnoder/cephdetail.svg?branch=master)](https://travis-ci.org/xnoder/cephdetail)
+[![Gem Version](https://badge.fury.io/rb/cephdetail.svg)](https://badge.fury.io/rb/cephdetail)
+
 `Cephdetail` fetches Ceph capacity and monitoring data from the Ceph REST API, and returns the responses as
 Ruby Hashes to be used in other code.
 
@@ -26,7 +29,7 @@ Or install it yourself as:
 Using `cephdetail` is very straight forward. First though, you'll need an environment variable called
 `CEPH_REST_API` so that the gem can find the URL of your WSGI service, such as `http://localhost:5000`.
 
-Here's an example:
+Here's some examples on how to use the gem:
 
 ```ruby
 require 'cephdetail'
@@ -35,7 +38,9 @@ health = Cephdetail::Health.new
     
 df = health.df
 status = health.status
+cluster_health = health.cluster_health
 osdstat = health.osdstat
+osdperf = health.osdperf
 ```
 
 What you get back are hashes constructed from the JSON returned by the API. The methods mock the following `ceph`
@@ -43,13 +48,33 @@ client commands:
 
 * `df` = `ceph df`
 * `status` = `ceph status`
+* `cluster_health` = `ceph health detail`
 * `osdstat` = `ceph osd stat`
+* `osdperf` = `ceph osd perf`
+
+### Notes on security
+
+By default, when installing the Ceph REST API, there is no security. You use a `cephx` authentication key to authenticate
+the API against your Ceph cluster, but insofar as the WSGI service is concerned, there's no authentication of
+requests. In our environment, the VM that runs the Apache2 service that hosts the API service is buried deep within
+our core network and protected by access lists and firewall rules limiting incoming to a handful of addresses. On the
+surface, if you've hacked that far into my network, I'm screwed anyway, but figuring out some form of authentication
+would definitely be a good idea. I'll also bake in support for using HTTPS and not plain old HTTP in coming versions.
+
+The long and the short of it is this: the gem provides no mechanism for authentication as of `0.2.0`. This will be
+baked into the gem in later releases, but for now, be aware that you are communicating with your Ceph API, and thus,
+your cluster, using unauthenticated and unencrypted requests, and are encouraged to think and plan accordingly.
+
+I'll only be updating this gem for PUT and POST paths when the above has been completed.
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can 
+also run `bin/console` for an interactive prompt that will allow you to experiment.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the 
+version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, 
+push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 ## Contributing
 
@@ -58,5 +83,7 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/xnoder
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+The gem is available as open source under the terms of the [MIT License (MIT)][1]
+
+[1]: https://opensource.org/licenses/MIT
 

data/cephdetail.gemspec

@@ -19,9 +19,17 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_runtime_dependency 'rest-client', '~> 1.8.0'
+  spec.required_ruby_version = '~> 2.0'
+
+  spec.add_runtime_dependency 'rest-client', '~> 1.8', '>= 1.8.0'
 
   spec.add_development_dependency 'bundler', '~> 1.10'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'webmock', '~> 1.21', '>= 1.21.0'
+  spec.add_development_dependency 'codeclimate-test-reporter', '>= 0.4.8'
+
+  spec.requirements << 'A web server running the Ceph REST API.'
+
+  spec.post_install_message = 'Thank you for installing Cephdetail!'
 end

data/lib/cephdetail/version.rb

@@ -1,3 +1,3 @@
 module Cephdetail
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/cephdetail.rb

@@ -19,7 +19,9 @@ module Cephdetail
   #   >> health = Cephdetail::Health.new
   #   >> df = health.df
   #   >> status = health.status
+  #   >> cluster_health = health.cluster_health
   #   >> osdstat = health.osdstat
+  #   >> osdperf = health.osdperf
 
   class Health
 
@@ -42,19 +44,34 @@ module Cephdetail
       return check("status")
     end
 
+    # Return /health?detail data (ceph health detail) in the form of a Ruby Hash for manipulation by other code/applications.
+    # Uses the private check(attrib) method to make the HTTP request.
+    def cluster_health
+      return check("health?detail")
+    end
+
     # Return  /osd/stat data (ceph osd stat) in the form of a Ruby Hash for manipulation by other code/applications.
     # Uses the private check(attrib) method to make the HTTP request.
     def osdstat
       return check("osd/stat")
     end
 
+    # Return /osd/perf data (ceph osd perf) in the form of a Ruby Hash for manipulation by other code/applications.
+    # Uses the private check(attrib) method to make the HTTP request
+    def osdperf
+      return check("osd/perf")
+    end
+
     private
 
     # Send a request to the Ceph REST API and convert the response into a Ruby Hash.
     def check(attrib)
       url = "#{@api_url}/api/v0.1/#{attrib}"
-      request = RestClient.get "#{url}", { :accept => :json }
-      return JSON.parse(request)
+      begin
+        JSON.parse(RestClient.get "#{url}", { :accept => :json })
+      rescue => e
+        e.response
+      end
     end
 
   end

metadata

@@ -1,20 +1,23 @@
 --- !ruby/object:Gem::Specification
 name: cephdetail
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Paul Stevens
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-11-25 00:00:00.000000000 Z
+date: 2015-11-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.8.0
   type: :runtime
@@ -22,6 +25,9 @@ dependencies:
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.8.0
 - !ruby/object:Gem::Dependency
@@ -66,6 +72,40 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.21.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.21.0
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.4.8
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.4.8
 description: This gem relies on the presence of a Ceph REST API server to pull down
   and parse health information for your Ceph cluster.
 email:
@@ -88,21 +128,22 @@ homepage: https://github.com/xnoder/cephdetail
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message: Thank you for installing Cephdetail!
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - "~>"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-requirements: []
+requirements:
+- A web server running the Ceph REST API.
 rubyforge_project: 
 rubygems_version: 2.4.5.1
 signing_key: