errand 0.8.0 → 0.8.1

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+0.8.1 - 2014/02/21
+ - Feature: Add support for retrieving the first available metric in an RRD - @jessereynolds
+
 0.8.0 - 2013/02/23
- - Chore: switched from using librrd-ruby to rrd-ffi, to be more portable
+ - Chore: switched from using librrd-ruby to rrd-ffi, to be more portable - @auxesis
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    errand (0.8.0)
+    errand (0.8.1)
       rrd-ffi (= 0.2.13)
 
 GEM
@@ -12,9 +12,9 @@ GEM
       multi_json (~> 1.0)
     colorize (0.5.8)
     diff-lcs (1.1.3)
-    ffi (1.4.0)
-    i18n (0.6.1)
-    multi_json (1.6.1)
+    ffi (1.9.3)
+    i18n (0.6.4)
+    multi_json (1.8.2)
     rake (0.8.7)
     rrd-ffi (0.2.13)
       activesupport

data/LICENCE

@@ -0,0 +1,20 @@
+Copyright (c) 2011-2014 Lindsay Holmwood
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -1,100 +1,129 @@
-Errand
-======
+# Errand
 
-Errand provides Ruby bindings for RRD functions (via librrd), and a clear
-API for interacting with RRDs. 
+Errand provides Ruby bindings for RRD functions (via librrd), and a clear API for interacting with RRDs.
 
-Check under spec/ for usage examples. 
+## Installing
 
-Using
-=====
+Install Errand via RubyGems:
 
-To set up an RRD to work with (whether it exists or otherwise): 
+```
+gem install errand
+```
 
-    @rrd = Errand.new(:filename => "data.rrd")
+Or adding do your Gemfile:
+
+```
+gem 'errand'
+```
+
+## Using
+
+To start working with an RRD:
+
+``` ruby
+@rrd = Errand.new(:filename => "data.rrd")
+```
+
+This will either read an existing RRD, or stub out the bits to create a new one.
 
 To create an RRD:
 
-    @rrd.create(:sources => [
-                  {:name => "Counter", :type => :counter, :heartbeat => 1800, :min => 0, :max => 4294967295}],
-                :archives => [
-                  {:function => :average, :xff => 0.5, :steps => 1, :rows => 2400}])
+``` ruby
+options = {
+  :sources => [
+    {
+      :name => "Counter",
+      :type => :counter,
+      :heartbeat => 1800,
+      :min => 0,
+      :max => 4294967295
+    }
+  ],
+  :archives => [
+    {
+      :function => :average,
+      :xff => 0.5,
+      :steps => 1,
+      :rows => 2400
+    }
+  ]
+}
 
-To update said RRD: 
+@rrd.create(options)
+```
 
-    @rrd.update(:sources => [{:name => "Counter", :value => 1}]
+To update said RRD:
 
-To fetch that data: 
+``` ruby
+@rrd.update(:sources => [{:name => "Counter", :value => 1}]
+```
 
-    @rrd.fetch # <= {:start => Time, :end => Time, 
-                     :data => {"Counter" => [nil, nil, nil, 1]}
+To fetch that data:
 
-Dependencies
-============
+``` ruby
+@rrd.fetch # <= {:start => Time, :end => Time,
+                 :data =>  {"Counter" => [nil, nil, nil, 1]}
+```
 
-**Errand** requires RRDtool version 1.2 or later. Some RRD functions such
-as rrddump are only available with the latest RRDtool.
+Check under `spec/` for more usage examples.
 
-Installation is standard. If you've installed the gem, you should be ready
-to go. 
+## Developing
 
-Otherwise, simply run:
+Clone the repository:
 
-    ruby extconf.rb
-    make
-    make install
+```
+git clone git@github.com:auxesis/errand.git
+```
 
-This should build a library named `rrd.so` in the current directory. If it 
-doesn't, please report bugs at [http://github.com/eric/rubyrrdtool/issues](http://github.com/eric/rubyrrdtool/issues)!
+Suck down all the dependencies:
 
-Building the gem
-================
+``` bash
+cd errand
+bundle
+```
 
-Errand is managed by Jeweller, which generates the gemspec for you: 
+### Dependencies
 
-    rake gemspec
+Errand requires RRDtool version 1.2 or later. Some RRD functions such
+as rrddump are only available with the latest RRDtool.
 
-Once the gemspec is generated, build the gem: 
+Installation is standard. If you've installed the gem, you should be ready
+to go.
 
-    gem build errand.gemspec 
+Otherwise, simply run:
+
+``` bash
+ruby extconf.rb
+make
+make install
+```
 
-Testing 
-=======
+This should build a library named `rrd.so` in the current directory. If it
+doesn't, please report bugs at [http://github.com/eric/rubyrrdtool/issues](http://github.com/eric/rubyrrdtool/issues)!
 
-Testing is done with RSpec. 
 
-To run tests: 
+### Testing
 
-   rake spec
+Testing is done with RSpec.
 
-Todo
-====
+To run tests:
 
-* Extend documentation with examples
+``` bash
+rake spec
+```
 
+### Building the gem
 
-License
-=======
+Build the gem:
 
-(the MIT license)
+``` bash
+rake build
+```
 
-Copyright (c) 2006 
+## TODO
 
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
+* Extend documentation with more examples
 
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
+## License
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
-IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
-CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
-TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
-SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+Errand is distributed under the MIT license.

data/lib/errand.rb

@@ -19,6 +19,10 @@ class Errand
     @backend.dump(@filename, output)
   end
 
+  def first
+    @backend.first(@filename)
+  end
+
   def last
     @backend.last(@filename)
   end

data/lib/errand/version.rb

@@ -1,5 +1,5 @@
 #!/usr/bin/env ruby
 
 class Errand
-  VERSION = "0.8.0"
+  VERSION = "0.8.1"
 end

data/spec/errand_spec.rb

@@ -14,6 +14,19 @@ describe Errand do
     @rrd = Errand.new(:filename => File.join(@tmpdir, 'test.rrd'))
   end
 
+  def create_simple_test_rrd(time)
+    @rrd.create(:start => time - 1, :step => 1,
+                :sources => [
+                  {:name => "Sum", :type => :gauge, :heartbeat => 1800, :min => 0, :max => 4294967295},
+                  {:name => "Total", :type => :gauge, :heartbeat => 1800, :min => 0, :max => 'U'} ],
+                :archives => [
+                  {:function => :average, :xff => 0.5, :steps => 1, :rows => 2400}]).should be_true
+
+    @rrd.update(:sources => [
+                  {:name => "Sum", :time => time, :value => 1},
+                  {:name => "Total", :time => time, :value => 30}]).should be_true
+  end
+
   it "should create data" do
 
     @rrd.create(:start => Time.now.to_i - 1, :step => 300,
@@ -125,7 +138,18 @@ describe Errand do
     end
   end
 
-  it "should return timestamp of first value"
-  it "should return timestamp of last value"
+  it "should return timestamp of first value" do
+    time = Time.now.to_i
+    create_simple_test_rrd(time)
+    # FIXME: the first update time is coming back as T minus 40 minutes, don't know why
+    #@rrd.first.should eq(time - 1)
+    @rrd.first.should be_a(Integer)
+  end
+
+  it "should return timestamp of last value" do
+    time = Time.now.to_i
+    create_simple_test_rrd(time)
+    @rrd.last.should eq(time)
+  end
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: errand
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.8.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-24 00:00:00.000000000 Z
+date: 2014-02-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rrd-ffi
@@ -90,6 +90,7 @@ files:
 - CHANGELOG.md
 - Gemfile
 - Gemfile.lock
+- LICENCE
 - README.md
 - Rakefile
 - VERSION
@@ -123,4 +124,7 @@ rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Ruby language binding for RRD tool version 1.2+
-test_files: []
+test_files:
+- spec/errand_spec.rb
+- spec/spec.opts
+- test/test_rrdtool.rb