dashboarder 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in dashboarder.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Michael Gorsuch
+
+MIT License
+
+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

@@ -0,0 +1,40 @@
+# Dashboarder
+
+An experimental library to help in the construction of Librato Metrics dashboards from simple definitions. 
+
+## Installation
+
+Fetch the repo for now.  Will consider a gem release once things seem steady.  
+
+## Usage
+
+```bash
+$ export LIBRATO_EMAIL=me@example.com
+$ export LIBRATO_KEY=123456
+$ bundle exec irb -I lib -r dashboarder
+```
+
+```ruby
+  # a simple dashboard definition
+  definition = [
+    'my dashboard name',
+    [:an_instrument_name, :a_metric_name, :another_metric_name],
+    [:another_instrument_name, :a_metric_name]
+  ]
+  
+  # this will ensure the dashboard exists
+  # will not overwrite if already does
+  Dashboarder::Dashboard.compose(definition)
+
+  # compose an individual instrument
+  # will not overwrite if already exists
+  Dashboarder::Instrument.compose(['my instrument', :first_metric, :second_metric])
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/dashboarder.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'dashboarder/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "dashboarder"
+  gem.version       = Dashboarder::VERSION
+  gem.authors       = ["Michael Gorsuch"]
+  gem.email         = ["michael.gorsuch@gmail.com"]
+  gem.description   = %q{a lightweight composer for librato instruments and dashboards}
+  gem.summary       = gem.description
+  gem.homepage      = "https://github.com/gorsuch/dashboarder"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+  gem.add_dependency('json')
+  gem.add_dependency('excon')
+end

data/lib/dashboarder.rb

@@ -0,0 +1,14 @@
+require 'excon'
+require 'json'
+
+require 'dashboarder/api'
+require 'dashboarder/config'
+require 'dashboarder/dashboard'
+require 'dashboarder/instrument'
+require 'dashboarder/version'
+
+module Dashboarder
+  def self.api
+    @api ||=  Api.new
+  end
+end

data/lib/dashboarder/api.rb

@@ -0,0 +1,39 @@
+module Dashboarder
+  class Api
+    def initialize(options={})
+      @options = options
+      @options[:api_url] = Config.librato_api_url || 'https://metrics-api.librato.com'
+      @options[:api_user] = Config.librato_email
+      @options[:api_pass] = Config.librato_key
+    end
+
+    def connection
+      @connection ||= connect
+    end
+
+    def get(path, options = {})
+      JSON.load(connection.get(options.merge(:path => path, :idempotent => true)).body)
+    end
+
+    def post(path, body, options = {})
+      JSON.load(connection.post(options.merge(:path => path, :body => body.to_json, :headers => { 'Content-Type' => 'application/json' })).body)
+    end
+    
+    def connect
+      uri = URI.parse(@options[:api_url])
+      Excon.new(api_url, :headers => { 'Authorization' => 'Basic ' + [api_user.sub('%40', '@') + ':' + api_pass].pack('m').delete(Excon::CR_NL) })
+    end
+
+    def api_url
+      @options[:api_url]
+    end
+
+    def api_user
+      @options[:api_user]
+    end
+
+    def api_pass
+      @options[:api_pass]
+    end
+  end
+end

data/lib/dashboarder/config.rb

@@ -0,0 +1,21 @@
+module Dashboarder
+  module Config
+    extend self
+
+    def env!(key)
+      ENV[key] || raise("#{key} not found in ENV")
+    end
+
+    def librato_api_url
+      ENV['LIBRATO_API_URL']
+    end
+
+    def librato_key
+      env!('LIBRATO_KEY')
+    end
+
+    def librato_email
+      env!('LIBRATO_EMAIL')
+    end
+  end
+end

data/lib/dashboarder/dashboard.rb

@@ -0,0 +1,22 @@
+module Dashboarder
+  module Dashboard
+    def self.compose!(definition)
+      name = definition.first
+      instrument_definitions = definition[1..-1]
+      instrument_ids = instrument_definitions.map { |d| Instrument.compose(d)['id'] }
+      Dashboarder.api.post('/v1/dashboards', { :name => name, :instruments => instrument_ids })
+    end
+    
+    def self.compose(definition)
+      dashboard = get(definition.first)
+      unless dashboard
+        dashboard = compose!(definition)
+      end
+      dashboard
+    end
+    
+    def self.get(name)
+      Dashboarder.api.get('/v1/dashboards', :query => {:name => name})['dashboards'].first
+    end
+  end
+end

data/lib/dashboarder/instrument.rb

@@ -0,0 +1,25 @@
+module Dashboarder
+  module Instrument
+    def self.get(name)
+      Dashboarder.api.get('/v1/instruments', :query => {:name => name})['instruments'].first
+    end
+
+    def self.compose!(definition)
+      name = definition.first
+      metric_names = definition[1..-1]
+
+      streams = metric_names.map { |n| { :metric => n, :source => '*' } }
+      Dashboarder.api.post('/v1/instruments', { :name => name, :streams => streams })
+    end
+    
+    def self.compose(definition)
+      name = definition.first
+      instrument = get(name)
+
+      unless instrument
+        instrument = compose!(definition)  
+      end
+      instrument
+    end
+  end
+end

data/lib/dashboarder/metric.rb

@@ -0,0 +1,7 @@
+module Dashboarder
+  module Metric
+    def self.get(name)
+      Dashboard.api.get("/v1/metrics/name")
+    end
+  end
+end

data/lib/dashboarder/version.rb

@@ -0,0 +1,3 @@
+module Dashboarder
+  VERSION = "0.0.1"
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification
+name: dashboarder
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Michael Gorsuch
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: &70101351060000 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70101351060000
+- !ruby/object:Gem::Dependency
+  name: excon
+  requirement: &70101351058660 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70101351058660
+description: a lightweight composer for librato instruments and dashboards
+email:
+- michael.gorsuch@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- dashboarder.gemspec
+- lib/dashboarder.rb
+- lib/dashboarder/api.rb
+- lib/dashboarder/config.rb
+- lib/dashboarder/dashboard.rb
+- lib/dashboarder/instrument.rb
+- lib/dashboarder/metric.rb
+- lib/dashboarder/version.rb
+homepage: https://github.com/gorsuch/dashboarder
+licenses: []
+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.10
+signing_key: 
+specification_version: 3
+summary: a lightweight composer for librato instruments and dashboards
+test_files: []
+has_rdoc: