graphite-dashboard-api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 026018d8a4341a1ebef7965fec8089f395266064
+  data.tar.gz: 17b8708e169cce2ae098298de0f37ba871876191
+SHA512:
+  metadata.gz: 3ed9217aff65cb7e6c300419f9ee322e4d0809cbb431dbe9e6c48c347b4c2f324ddd7a2c0e2fe2b390f40101ff91264686ba0106e9ef77800e92d507de81ffce
+  data.tar.gz: 3eb99d69b1ca9184726d5697b48cf1f30238b247a260801ca4ce06d243e489008b3994239af2b082b6d1ed6a2bd91a6188b7bb83fd8fcfb1871c2f7bed543a79

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.1.0
+  - ruby-head
+script: bundle exec rspec

data/Gemfile

@@ -0,0 +1,5 @@
+# A sample Gemfile
+source "https://rubygems.org"
+
+gemspec
+

data/Gemfile.lock

@@ -0,0 +1,28 @@
+PATH
+  remote: .
+  specs:
+    graphite-dashboard-api (0.1.0)
+      rest-client
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.2.5)
+    mime-types (1.25.1)
+    rest-client (1.6.7)
+      mime-types (>= 1.16)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.7)
+    rspec-expectations (2.14.5)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.6)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  graphite-dashboard-api!
+  rspec

data/README.md

@@ -0,0 +1,32 @@
+Graphite Dashboard API
+----------------------
+
+[![Build Status](https://travis-ci.org/criteo/graphite-dashboard-api.png?branch=master)](https://travis-ci.org/criteo/graphite-dashboard-api)
+
+
+Graphite dashboard api is a ruby gem which help to create and update graphite dashboards.
+
+It allows to create dashboard with code instead of long manipulations in graphite dashboard UI.
+
+How to
+------
+
+Simple example:
+```ruby
+my_graphs = %w(preprod prod).map do |env|
+  GraphiteDashboardApi::Graph.new "chef-client run time" do
+    targets [
+      "alias(averageSeries(storage.#{env}.chef.*.elapsed_time),\"average run time\")",
+      "alias(maxSeries(storage.#{env}.chef.*.elapsed_time),\"max run time\")"
+      ]
+    end
+  end
+
+dashboard = GraphiteDashboardApi::Dashboard.new 'chef-run-time' do
+  graphs my_graphs
+end
+
+dashboard.save!('http://mygraphite.server.com')
+```
+
+For more complex examples, see `spec/` folder

data/graphite_dashboard_api.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "graphite-dashboard-api"
+  s.version     = '0.1.0'
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Grégoire Seux"]
+  s.license     = "Apache License v2"
+  s.summary     = %q{DSL over graphite dashboard api}
+  s.homepage    = "http://github.com/criteo/graphite-dashboard-api"
+  s.description = %q{}
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- spec/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+
+  s.add_development_dependency 'rspec'
+
+  s.add_dependency 'rest-client'
+end

data/lib/graphite-dashboard-api.rb

@@ -0,0 +1,3 @@
+require 'graphite-dashboard-api/graph'
+require 'graphite-dashboard-api/api'
+require 'graphite-dashboard-api/dashboard'

data/lib/graphite-dashboard-api/api.rb

@@ -0,0 +1,54 @@
+require 'uri'
+require 'rest_client'
+require 'json'
+
+module GraphiteDashboardApi
+  module Api
+    # this mixin requires a from_hash! and to_hash methods + @name
+    def save!(uri)
+      data = encode
+      response = rest_request(uri, "save/#{@name}", :post, data)
+      response
+    end
+
+    def load!(uri, name = nil)
+      response = rest_request(uri, "load/#{name || @name}", :get)
+      self.from_hash!(response)
+    end
+
+    def search(uri, pattern)
+      response = rest_request(uri, "find/?query=#{pattern}", :get)
+      response['dashboards']
+    end
+
+    def exists?(uri, name = nil)
+      pattern = name || @name
+      search(uri, pattern).map { |el| el['name'] }.include? (pattern)
+    end
+
+    private
+    def rest_request(uri, endpoint, method, payload = nil)
+      uri = "#{uri}/dashboard/#{endpoint}"
+      begin
+        r = RestClient::Request.new(
+          url: uri,
+          payload: payload,
+          method: method,
+          timeout: 2,
+          open_timeout: 2,
+          headers: {
+            accept: :json,
+            content_type: :json,
+          }
+        )
+        response = r.execute
+      rescue => e
+        raise "Rest client error: #{e}"
+      end
+      if response.code != 200 || JSON.parse(response.body)['error']
+        fail "Error calling dashboard API: #{response.code} #{response.body}"
+      end
+      JSON.parse(response.body)
+    end
+  end
+end

data/lib/graphite-dashboard-api/dashboard.rb

@@ -0,0 +1,139 @@
+module GraphiteDashboardApi
+  class Dashboard
+
+    include Api
+
+    attr_accessor :name
+    attr_accessor :graphs
+    attr_accessor :stringify_graphSize
+
+    def initialize(name = nil, &block)
+      @name = name
+      @graphs = []
+      @defaultGraphParams_width  = '800'
+      @defaultGraphParams_from   = '-5minutes'
+      @defaultGraphParams_until  = 'now'
+      @defaultGraphParams_height = '400'
+      @refreshConfig_interval =  600000
+      @refreshConfig_enabled  = false
+      @graphSize_width        = 400
+      @graphSize_height       = 250
+      @stringify_graphSize    = false # tweaking option
+
+      # default timeConfig
+      @timeConfig_type = 'relative'
+      @timeConfig_relativeStartUnits = 'minutes'
+      @timeConfig_relativeStartQuantity = '5'
+      @timeConfig_relativeUntilUnits = 'now'
+      @timeConfig_relativeUntilQuantity = ''
+
+      @timeConfig_startDate = '1970-01-01T00:00:00'
+      @timeConfig_endDate = '1970-01-01T00:05:00'
+      @timeConfig_startTime = '9:00 AM'
+      @timeConfig_endTime  = '5:00 PM'
+
+      instance_eval(&block) if block
+    end
+
+    DEFAULT_GRAPH_PARAMS = [:width, :from, :until, :height]
+    REFRESH_CONFIG = [:interval, :enabled]
+    TIME_CONFIG = [:startDate, :relativeStartUnits, :endDate, :relativeStartQuantity, :relativeUntilQuantity, :startTime, :endTime, :type, :relativeUntilUnits]
+    GRAPH_SIZE = [:width, :height]
+
+    OPTIONS = {
+      'defaultGraphParams' => DEFAULT_GRAPH_PARAMS,
+      'refreshConfig' => REFRESH_CONFIG,
+      'timeConfig' => TIME_CONFIG,
+      'graphSize' => GRAPH_SIZE,
+    }
+
+    def stringify_graphSize(arg = nil)
+      if arg
+        @stringify_graphSize = arg
+      end
+      @stringify_graphSize
+    end
+
+    def graphs(arg = nil)
+      if arg
+        @graphs = arg
+      end
+      @graphs
+    end
+
+    OPTIONS.each do |k, options|
+      options.each do |v|
+        accessor_name = k + '_' + v.to_s
+        attr_accessor accessor_name
+        define_method(accessor_name) do |arg = nil|
+        if arg
+          instance_variable_set("@#{accessor_name}".to_sym, arg)
+        else
+          instance_variable_get "@#{accessor_name}".to_sym
+        end
+        end
+        define_method((accessor_name.to_s + '_').to_sym) do |arg = nil|
+        send(accessor_name, arg)
+        end
+      end
+    end
+
+    def to_hash
+      state = {}
+      state['name'] = @name
+      OPTIONS.each do |k, options|
+        state[k] = Hash.new
+        options.each do |kk|
+          state[k][kk.to_s] = instance_variable_get "@#{k}_#{kk}".to_sym
+          state[k][kk.to_s] = state[k][kk.to_s].to_s if (k.eql? 'graphSize' and @stringify_graphSize)
+        end
+      end
+
+      state['graphs'] = @graphs.map do |graph|
+
+        [graph.leading_entries, graph.to_hash, graph.url(state['graphSize'])]
+      end
+
+      hash = { 'state' => state }
+      hash
+    end
+
+    def from_hash!(hash)
+      state = hash['state']
+      @name = state['name']
+      OPTIONS.each do |k, options|
+        if state[k]
+          options.each do |kk|
+            value = state[k][kk.to_s]
+            instance_variable_set("@#{k}_#{kk}".to_sym, value) if value
+          end
+        end
+      end
+      if state['graphs']
+        state['graphs'].each do |graph_entry|
+          fail 'Graph entry is supposed to have 3 elements' unless graph_entry.size.eql? 3
+          graph = graph_entry[1]
+          new_graph = Graph.new
+          new_graph.from_hash!(graph)
+          @graphs << new_graph
+        end
+      end
+      self
+    end
+
+    def encode
+      json = JSON.generate(to_hash['state'])
+      'state=' + URI.encode(json, my_unsafe)
+    end
+
+    def decode(encoded_string)
+      json = URI.decode(encoded_string[/=(.*)/, 1], my_unsafe)
+      JSON.parse(json)
+    end
+
+    def my_unsafe
+      Regexp.union(URI::UNSAFE, /[,&+]/)
+    end
+
+  end
+end

data/lib/graphite-dashboard-api/graph.rb

@@ -0,0 +1,85 @@
+require 'uri'
+
+module GraphiteDashboardApi
+  class Graph
+    PROPS = [:from, :until, :width, :height]
+    [PROPS, :targets, :titles, :compact_leading].flatten.each do |a|
+      attr_accessor a
+      define_method(a) do |arg = nil|
+      if arg
+        instance_variable_set("@#{a}".to_sym, arg)
+      else
+        instance_variable_get "@#{a}".to_sym
+      end
+      end
+      define_method((a.to_s + '_').to_sym) do |arg = nil|
+      send(a, arg)
+      end
+    end
+
+    def initialize(title = nil, &block)
+      @title = title
+      @targets = []
+      @compact_leading = false # this is tweaking stuff
+      instance_eval(&block) if block
+    end
+
+    def url(default_options)
+      '/render?' + render_options(default_options) + '&' + target_encode + "&title=#{@title || default_title}"
+    end
+
+    # This is probably an over simplification TODO
+    def default_title
+      @targets.first
+    end
+
+    def render_options(default_options)
+      opts = []
+      PROPS.each do |k|
+        v = instance_variable_get "@#{k}".to_sym
+        v ||= default_options[k.to_s]
+        opts << "#{k.to_s}=#{v}" if v
+      end
+      opts.join('&')
+    end
+
+    def leading_entries
+      if @compact_leading
+        leading_entries = target_encode
+      else
+        leading_entries = @targets
+      end
+    end
+
+    def target_encode
+      @targets.map do |target|
+        'target=' + target
+      end.join('&')
+    end
+
+    def to_hash
+      hash = {}
+      hash['title'] = @title if @title
+      PROPS.each do |k|
+        v = instance_variable_get "@#{k}".to_sym
+        hash[k.to_s] = v if v
+      end
+      hash['target'] = @targets
+      hash
+    end
+
+    def from_hash!(hash)
+      @title = hash['title']
+      PROPS.each do |k|
+        value = hash[k.to_s]
+        instance_variable_set("@#{k}".to_sym, value) if value
+      end
+      if hash['target']
+        hash['target'].each do |target|
+          @targets << target
+        end
+      end
+      self
+    end
+  end
+end

data/spec/dashboard_spec.rb

@@ -0,0 +1,97 @@
+require 'rspec'
+require_relative '../lib/graphite-dashboard-api'
+require 'json'
+
+describe GraphiteDashboardApi::Dashboard do
+
+  it 'can generate complex dashboards' do
+    part1 = 'state=%7B%22name%22:%22chef-storage-automatic%22%2C%22defaultGraphParams%22:%7B%22width%22:%22350%22%2C%22from%22:%22-4days%22%2C%22until%22:%22now%22%2C%22height%22:%22250%22%7D%2C%22refreshConfig%22:%7B%22interval%22:600000%2C%22enabled%22:true%7D%2C%22timeConfig%22:%7B%22startDate%22:%221970-01-01T00:00:00%22%2C%22relativeStartUnits%22:%22days%22%2C%22endDate%22:%221970-01-01T00:05:00%22%2C%22relativeStartQuantity%22:%224%22%2C%22relativeUntilQuantity%22:%22%22%2C%22startTime%22:%229:00%20AM%22%2C%22endTime%22:%225:00%20PM%22%2C%22type%22:%22relative%22%2C%22relativeUntilUnits%22:%22now%22%7D%2C%22graphSize%22:%7B%22width%22:%22350%22%2C%22height%22:%22250%22%7D%2C%22graphs%22:[[[%22cactiStyle(alias(averageSeries(storage.chef.mdb*.elapsed_time)%2C%5C%22mean%20run%20time%5C%22))%22%2C%22alias(dashed(drawAsInfinite(sumSeries(storage.chef.mdb*.fail)))%2C%5C%22fails%5C%22)%22]%2C%7B%22title%22:%22mongo%20pool%22%2C%22from%22:%22-4days%22%2C%22until%22:%22now%22%2C%22target%22:[%22cactiStyle(alias(averageSeries(storage.chef.mdb*.elapsed_time)%2C%5C%22mean%20run%20time%5C%22))%22%2C%22alias(dashed(drawAsInfinite(sumSeries(storage.chef.mdb*.fail)))%2C%5C%22fails%5C%22)%22]%7D%2C%22/render?from=-4days%26until=now%26width=350%26height=250%26target=cactiStyle(alias(averageSeries(storage.chef.mdb*.elapsed_time)%2C%5C%22mean%20run%20time%5C%22))%26target=alias(dashed(drawAsInfinite(sumSeries(storage.chef.mdb*.fail)))%2C%5C%22fails%5C%22)%26title=mongo%20pool%22]%2C[[%22cactiStyle(alias(averageSeries(storage.chef.rmq*.elapsed_time)%2C%5C%22mean%20run%20time%5C%22))%22%2C%22alias(dashed(drawAsInfinite(sumSeries(storage.chef.rmq*.fail)))%2C%5C%22fails%5C%22)%22]%2C%7B%22title%22:%22Rabbit%20pool%22%2C%22from%22:%22-4days%22%2C%22until%22:%22now%22%2C%22target%22:[%22cactiStyle(alias(averageSeries(storage.chef.rmq*.elapsed_time)%2C%5C%22mean%20run%20time%5C%22))%22%2C%22alias(dashed(drawAsInfinite(sumSeries(storage.chef.rmq*.fail)))%2C%5C%22fails%5C%22)%22]%7D%2C%22/render?from=-4days%26until=now%26width=350%26height=250%26target=cactiStyle(alias(averageSeries(storage.chef.rmq*.elapsed_time)%2C%5C%22mean%20run%20time%5C%22))%26target=alias(dashed(drawAsInfinite(sumSeries(storage.chef.rmq*.fail)))%2C%5C%22fails%5C%22)%26title=Rabbit%20pool%22]%2C[[%22cactiStyle(alias(averageSeries(storage.chef.%7Bcouch%2Cmem%7D*.elapsed_time)%2C%5C%22mean%20run%20time%5C%22))%22%2C%22alias(dashed(drawAsInfinite(sumSeries(storage.chef.%7Bcouch%2Cmem%7D*.fail)))%2C%5C%22fails%5C%22)%22]%2C%7B%22title%22:%22couchbase%20pool%22%2C%22from%22:%22-4days%22%2C%22until%22:%22now%22%2C%22target%22:[%22cactiStyle(alias(averageSeries(storage.chef.%7Bcouch%2Cmem%7D*.elapsed_time)%2C%5C%22mean%20run%20time%5C%22))%22%2C%22alias(dashed(drawAsInfinite(sumSeries(storage.chef.%7Bcouch%2Cmem%7D*.fail)))%2C%5C%22fails%5C%22)%22]%7D%2C%22/render?from=-4days%26until=now%26width=350%26height=250%26target=cactiStyle(alias(averageSeries(storage.chef.%7Bcouch%2Cmem%7D*.elapsed_time)'
+    part2 = '%2C%5C%22mean%20run%20time%5C%22))%26target=alias(dashed(drawAsInfinite(sumSeries(storage.chef.%7Bcouch%2Cmem%7D*.fail)))%2C%5C%22fails%5C%22)%26title=couchbase%20pool%22]%2C[[%22cactiStyle(alias(averageSeries(storage.chef.%7Bkestrel%2Cbungee%7D*.elapsed_time)%2C%5C%22mean%20run%20time%5C%22))%22%2C%22alias(dashed(drawAsInfinite(sumSeries(storage.chef.%7Bkestrel%2Cbungee%7D*.fail)))%2C%5C%22fails%5C%22)%22]%2C%7B%22title%22:%22kestrel%2Bbungee%20pool%22%2C%22from%22:%22-4days%22%2C%22until%22:%22now%22%2C%22target%22:[%22cactiStyle(alias(averageSeries(storage.chef.%7Bkestrel%2Cbungee%7D*.elapsed_time)%2C%5C%22mean%20run%20time%5C%22))%22%2C%22alias(dashed(drawAsInfinite(sumSeries(storage.chef.%7Bkestrel%2Cbungee%7D*.fail)))%2C%5C%22fails%5C%22)%22]%7D%2C%22/render?from=-4days%26until=now%26width=350%26height=250%26target=cactiStyle(alias(averageSeries(storage.chef.%7Bkestrel%2Cbungee%7D*.elapsed_time)%2C%5C%22mean%20run%20time%5C%22))%26target=alias(dashed(drawAsInfinite(sumSeries(storage.chef.%7Bkestrel%2Cbungee%7D*.fail)))%2C%5C%22fails%5C%22)%26title=kestrel%2Bbungee%20pool%22]%2C[[%22cactiStyle(alias(averageSeries(storage.chef.%7Bsquirrel%2Cgraphite%7D*.elapsed_time)%2C%5C%22mean%20run%20time%5C%22))%22%2C%22alias(dashed(drawAsInfinite(sumSeries(storage.chef.%7Bsquirrel%2Cgraphite%7D*.fail)))%2C%5C%22fails%5C%22)%22]%2C%7B%22title%22:%22Graphites%20pool%22%2C%22from%22:%22-4days%22%2C%22until%22:%22now%22%2C%22target%22:[%22cactiStyle(alias(averageSeries(storage.chef.%7Bsquirrel%2Cgraphite%7D*.elapsed_time)%2C%5C%22mean%20run%20time%5C%22))%22%2C%22alias(dashed(drawAsInfinite(sumSeries(storage.chef.%7Bsquirrel%2Cgraphite%7D*.fail)))%2C%5C%22fails%5C%22)%22]%7D%2C%22/render?from=-4days%26until=now%26width=350%26height=250%26target=cactiStyle(alias(averageSeries(storage.chef.%7Bsquirrel%2Cgraphite%7D*.elapsed_time)%2C%5C%22mean%20run%20time%5C%22))%26target=alias(dashed(drawAsInfinite(sumSeries(storage.chef.%7Bsquirrel%2Cgraphite%7D*.fail)))%2C%5C%22fails%5C%22)%26title=Graphites%20pool%22]%2C[[%22hitcount(sumSeries(storage.chef.%7Bkestrel%2Cbungee%7D*.fail)%2C%5C%2230min%5C%22)%22%2C%22hitcount(sumSeries(storage.chef.%7Bgraphite%2Csquirrel%7D*.fail)%2C%5C%2230min%5C%22)%22%2C%22hitcount(sumSeries(storage.chef.rmq*.fail)%2C%5C%2230min%5C%22)%22%2C%22hitcount(sumSeries(storage.chef.%7Bcouch%2Cmem%7D*.fail)%2C%5C%2230min%5C%22)%22%2C%22hitcount(sumSeries(storage.chef.mdb*.fail)%2C%5C%2230min%5C%22)%22%2C%22color(secondYAxis(sumSeries(storage.chef.*.success))%2C%5C%22green%5C%22)%22]%2C%7B%22title%22:%22Sucess%20%26%20failure%22%2C%22from%22:%22-4days%22%2C%22until%22:%22now%22%2C%22target%22:[%22hitcount(sumSeries(storage.chef.%7Bkestrel%2Cbungee%7D*.fail)%2C%5C%2230min%5C%22)%22%2C%22hitcount(sumSeries(storage.chef.%7Bgraphite%2Csquirrel%7D*.fail)%2C%5C%2230min%5C%22)%22%2C%22hitcount(sumSeries(storage.chef.rmq*.fail)%2C%5C%2230min%5C%22)%22%2C%22hitcount(sumSeries(storage.chef.%7Bcouch%2Cmem%7D*.fail)%2C%5C%2230min'
+    part3 = '%5C%22)%22%2C%22hitcount(sumSeries(storage.chef.mdb*.fail)%2C%5C%2230min%5C%22)%22%2C%22color(secondYAxis(sumSeries(storage.chef.*.success))%2C%5C%22green%5C%22)%22]%7D%2C%22/render?from=-4days%26until=now%26width=350%26height=250%26target=hitcount(sumSeries(storage.chef.%7Bkestrel%2Cbungee%7D*.fail)%2C%5C%2230min%5C%22)%26target=hitcount(sumSeries(storage.chef.%7Bgraphite%2Csquirrel%7D*.fail)%2C%5C%2230min%5C%22)%26target=hitcount(sumSeries(storage.chef.rmq*.fail)%2C%5C%2230min%5C%22)%26target=hitcount(sumSeries(storage.chef.%7Bcouch%2Cmem%7D*.fail)%2C%5C%2230min%5C%22)%26target=hitcount(sumSeries(storage.chef.mdb*.fail)%2C%5C%2230min%5C%22)%26target=color(secondYAxis(sumSeries(storage.chef.*.success))%2C%5C%22green%5C%22)%26title=Sucess%20%26%20failure%22]%2C[[%22keepLastValue(averageSeries(storage.chef.%7Bkestrel%2Cbungee%7D*.updated_resources))%22%2C%22keepLastValue(averageSeries(storage.chef.%7Bgraphite%2Csquirrel%7D%7D*.updated_resources))%22%2C%22keepLastValue(averageSeries(storage.chef.rmq*.updated_resources))%22%2C%22keepLastValue(averageSeries(storage.chef.%7Bcouch%2Cmem%7D*.updated_resources))%22%2C%22keepLastValue(averageSeries(storage.chef.mdb*.updated_resources))%22]%2C%7B%22title%22:%22Updated%20resources%22%2C%22from%22:%22-4days%22%2C%22until%22:%22now%22%2C%22target%22:[%22keepLastValue(averageSeries(storage.chef.%7Bkestrel%2Cbungee%7D*.updated_resources))%22%2C%22keepLastValue(averageSeries(storage.chef.%7Bgraphite%2Csquirrel%7D%7D*.updated_resources))%22%2C%22keepLastValue(averageSeries(storage.chef.rmq*.updated_resources))%22%2C%22keepLastValue(averageSeries(storage.chef.%7Bcouch%2Cmem%7D*.updated_resources))%22%2C%22keepLastValue(averageSeries(storage.chef.mdb*.updated_resources))%22]%7D%2C%22/render?from=-4days%26until=now%26width=350%26height=250%26target=keepLastValue(averageSeries(storage.chef.%7Bkestrel%2Cbungee%7D*.updated_resources))%26target=keepLastValue(averageSeries(storage.chef.%7Bgraphite%2Csquirrel%7D%7D*.updated_resources))%26target=keepLastValue(averageSeries(storage.chef.rmq*.updated_resources))%26target=keepLastValue(averageSeries(storage.chef.%7Bcouch%2Cmem%7D*.updated_resources))%26target=keepLastValue(averageSeries(storage.chef.mdb*.updated_resources))%26title=Updated%20resources%22]]%7D'
+
+    expected_encoded_string = part1 + part2 + part3 # vim syntaxic coloration does not handle long lines well
+
+    pool_definitions = {
+      'mongo' => %w(mdb),
+      'Rabbit' => %w(rmq),
+      'couchbase' => %w(couch mem),
+      'kestrel+bungee' => %w(kestrel bungee),
+      'Graphites' => %w(squirrel graphite),
+    }
+    graphs = pool_definitions.map do |pool, prefixes|
+      prefixes_ = '{' + prefixes.join(',') + '}'
+      prefixes_ = prefixes.first if prefixes.size.eql? 1
+      GraphiteDashboardApi::Graph.new "#{pool} pool" do
+        from   '-4days'
+        until_ 'now'
+        targets [
+          "cactiStyle(alias(averageSeries(storage.chef.#{prefixes_}*.elapsed_time),\"mean run time\"))",
+          "alias(dashed(drawAsInfinite(sumSeries(storage.chef.#{prefixes_}*.fail))),\"fails\")",
+        ]
+      end
+    end
+    success_failure = GraphiteDashboardApi::Graph.new 'Sucess & failure' do
+      from   '-4days'
+      until_ 'now'
+      targets [
+        "hitcount(sumSeries(storage.chef.{kestrel,bungee}*.fail),\"30min\")",
+        "hitcount(sumSeries(storage.chef.{graphite,squirrel}*.fail),\"30min\")",
+        "hitcount(sumSeries(storage.chef.rmq*.fail),\"30min\")",
+        "hitcount(sumSeries(storage.chef.{couch,mem}*.fail),\"30min\")",
+        "hitcount(sumSeries(storage.chef.mdb*.fail),\"30min\")",
+        "color(secondYAxis(sumSeries(storage.chef.*.success)),\"green\")"
+      ]
+    end
+    updated_resources = GraphiteDashboardApi::Graph.new 'Updated resources' do
+      from   '-4days'
+      until_ 'now'
+      targets [
+        'keepLastValue(averageSeries(storage.chef.{kestrel,bungee}*.updated_resources))',
+        'keepLastValue(averageSeries(storage.chef.{graphite,squirrel}}*.updated_resources))',
+        'keepLastValue(averageSeries(storage.chef.rmq*.updated_resources))',
+        'keepLastValue(averageSeries(storage.chef.{couch,mem}*.updated_resources))',
+        'keepLastValue(averageSeries(storage.chef.mdb*.updated_resources))'
+      ]
+    end
+
+    dashboard = GraphiteDashboardApi::Dashboard.new 'chef-storage-automatic' do
+      defaultGraphParams_width '350'
+      defaultGraphParams_height '250'
+      graphSize_width            350
+      stringify_graphSize        true
+      defaultGraphParams_from   '-4days'
+      timeConfig_relativeStartUnits 'days'
+      timeConfig_relativeStartQuantity '4'
+      refreshConfig_enabled true
+      graphs ([graphs, success_failure, updated_resources].flatten)
+    end
+
+    expected_json = { 'state' => JSON.parse(URI.decode(expected_encoded_string)[/^state=(.*)/, 1]) }
+    comparison_by_block(dashboard, expected_json)
+    # expect(dashboard.save!(a_graphite_url)['success']).to eq true
+
+  end
+end
+
+def comparison_by_block(dashboard, expected_json)
+  result = JSON.parse(JSON.generate(dashboard.to_hash))['state']
+  expected_json['state'].each do |k, v|
+    expect(result[k]).to eq v
+  end
+  expect(JSON.parse(JSON.generate(dashboard.to_hash))).to eq expected_json
+
+  # also check idempotency of (to_hash o from_hash)
+  # we have to be careful with tweaking options
+  new_dashboard = GraphiteDashboardApi::Dashboard.new
+  new_dashboard.from_hash! dashboard.to_hash
+  expect(new_dashboard.graphs.size).to eq dashboard.graphs.size
+  dashboard.graphs.each_with_index do |el, index|
+    if el.compact_leading
+      new_dashboard.graphs[index].compact_leading = true
+    end
+  end
+  new_dashboard.to_hash['state'].each do |k, v|
+    expect(dashboard.to_hash['state'][k]).to eq v
+  end
+  expect(new_dashboard.to_hash).to eq dashboard.to_hash
+end

data/spec/graph_spec.rb

@@ -0,0 +1,54 @@
+require 'rspec'
+require_relative '../lib/graphite-dashboard-api'
+require 'json'
+
+describe GraphiteDashboardApi::Graph do
+
+  let(:graph_with_title) do
+    graph = GraphiteDashboardApi::Graph.new 'title' do
+      from '-5minutes'
+      until_ 'now'
+      targets ['storage.rsyslog.action1.processed.kestrel01-am5']
+    end
+    expected_json = JSON.parse('{"until": "now","from": "-5minutes","target": ["storage.rsyslog.action1.processed.kestrel01-am5"],"title": "title"}')
+    [graph, expected_json]
+  end
+
+  let(:graph_without_title) do
+    graph = GraphiteDashboardApi::Graph.new do
+      from '-5minutes'
+      until_ 'now'
+      targets ['storage.rsyslog.action1.processed.kestrel01-am5']
+    end
+    expected_json = JSON.parse('{"until": "now","from": "-5minutes","target": ["storage.rsyslog.action1.processed.kestrel01-am5"]}')
+    [graph, expected_json]
+  end
+
+  it 'can be constructed' do
+    graph = GraphiteDashboardApi::Graph.new('Test graph') do
+      from '-4hours'
+      until_ '-2hours'
+    end
+
+    expect(graph.from).to eq('-4hours')
+    expect(graph.until).to eq('-2hours')
+  end
+
+  it 'can be converted to json' do
+    graph, expected_json = graph_with_title
+    expect(JSON.parse(JSON.generate(graph.to_hash))).to eq expected_json
+    # also check idempotency of (to_hash o from_hash)
+    new_graph = GraphiteDashboardApi::Graph.new
+    expect((new_graph.from_hash! graph.to_hash).to_hash).to eq graph.to_hash
+  end
+
+  it 'can be converted to json when no title' do
+    graph, expected_json = graph_without_title
+    expect(graph.target_encode).to eq 'target=storage.rsyslog.action1.processed.kestrel01-am5'
+    expect(JSON.parse(JSON.generate(graph.to_hash))).to eq expected_json
+
+    # also check idempotency of (to_hash o from_hash)
+    new_graph = GraphiteDashboardApi::Graph.new
+    expect((new_graph.from_hash! graph.to_hash).to_hash).to eq graph.to_hash
+  end
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: graphite-dashboard-api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Grégoire Seux
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ''
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .travis.yml
+- Gemfile
+- Gemfile.lock
+- README.md
+- graphite_dashboard_api.gemspec
+- lib/graphite-dashboard-api.rb
+- lib/graphite-dashboard-api/api.rb
+- lib/graphite-dashboard-api/dashboard.rb
+- lib/graphite-dashboard-api/graph.rb
+- spec/dashboard_spec.rb
+- spec/graph_spec.rb
+homepage: http://github.com/criteo/graphite-dashboard-api
+licenses:
+- Apache License v2
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: DSL over graphite dashboard api
+test_files:
+- spec/dashboard_spec.rb
+- spec/graph_spec.rb