dashboarder 0.0.2 → 0.0.3

data/README.md

@@ -23,24 +23,11 @@ $ LIBRATO_EMAIL=me@example.co LIBRATO_KEY=123456 irb -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])
-
-  # If an instrument has already been defined, you can compose
-  # like so:
-  Dashboarder::Dashboard.compose([:my_dashboard, :some_instrument, :some_other_instrument])
+# compose an instrument
+Dashboarder::Instrument.compose(:my_instrument, [:my_metric, :my_other_metric])
+
+# compose a dashboard
+Dashboarder::Dashboard.compose(:my_dashboard, [:my_instrument, :my_other_instrument])
 ```
 
 ## Contributing

data/lib/dashboarder/dashboard.rb

@@ -1,18 +1,15 @@
 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'] }
+    def self.compose!(name, instrument_names)
+      instrument_ids = instrument_names.map do |d|
+        i = Instrument.get(d) || raise("Instrument #{name} not defined yet")
+        i['id']
+      end
       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
+    def self.compose(name, instrument_names)
+      get(name) || compose!(name, instrument_names)
     end
     
     def self.get(name)

data/lib/dashboarder/instrument.rb

@@ -4,29 +4,13 @@ module Dashboarder
       Dashboarder.api.get('/v1/instruments', :query => {:name => name})['instruments'].first
     end
 
-    def self.compose!(definition)
-      name = definition.first
-      metric_names = definition[1..-1]
-
+    def self.compose!(name, metric_names)
       streams = metric_names.map { |n| { :metric => n, :source => '*' } }
       Dashboarder.api.post('/v1/instruments', { :name => name, :streams => streams })
     end
     
-    def self.compose(definition)
-      # if we passed an atom, attempt to fetch rather than build
-      if definition.kind_of?(String) || definition.kind_of?(Symbol)
-        instrument = get(definition)
-        raise "instrument #{definition} has not been created yet" unless instrument
-        instrument
-      else
-        name = definition.first
-        instrument = get(name)
-
-        unless instrument
-          instrument = compose!(definition)  
-        end
-        instrument
-     end
+    def self.compose(name, metric_names)
+      get(name) || compose!(name, metric_names)
     end
   end
 end

data/lib/dashboarder/version.rb

@@ -1,3 +1,3 @@
 module Dashboarder
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dashboarder
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2012-11-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &70262015999380 !ruby/object:Gem::Requirement
+  requirement: &70137711475360 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70262015999380
+  version_requirements: *70137711475360
 - !ruby/object:Gem::Dependency
   name: excon
-  requirement: &70262015998380 !ruby/object:Gem::Requirement
+  requirement: &70137711474340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,7 +32,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70262015998380
+  version_requirements: *70137711474340
 description: a lightweight composer for librato instruments and dashboards
 email:
 - michael.gorsuch@gmail.com