slate 0.2.1 → 1.0.0

data/Guardfile

@@ -0,0 +1,17 @@
+guard 'rspec' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end
+
+notification :tmux,
+  :display_message => true,
+  :timeout => 3, # in seconds
+  :default_message_format => '%s >> %s',
+  :default => 'default',
+  :success => 'default',
+  :failed => 'colour1',
+  # the first %s will show the title, the second the message
+  # Alternately you can also configure *success_message_format*,
+  # *pending_message_format*, *failed_message_format*
+  :line_separator => ' > ' # since we are single line we need a separator

data/README.md

@@ -20,7 +20,83 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+### Configuration
+
+Configure the Slate client
+
+```ruby
+Slate.configure do |config|
+  config.endpoint = "http://your.graphite-server.com"
+end
+```
+
+### Ruby interface
+
+To build a basic graph
+
+```ruby
+graph = Slate::Graph.new
+graph << Slate::Target.build("stats.web01.load")
+
+puts graph.url
+puts graph.download(:json)
+```
+
+Adjust the timeframe of the graph
+
+```ruby
+graph       = Slate::Graph.new
+graph.from  = "-1w"
+graph.until = "-1d"
+graph << Slate::Target.build("stats.web01.load")
+```
+
+Use functions
+
+```ruby
+graph = Slate::Graph.new
+
+graph << Slate::Target.build("stats.web01.load") do |target|
+  target.add_function :sum
+  target.add_function :alias, "load"
+end
+```
+
+Or more complex targets (like passing targets to other targets): [Graph Spec](https://github.com/trobrock/slate/blob/master/spec/slate/graph_spec.rb)
+
+### Slate text interface
+
+Slate also provides a text interface for building targets, this can be useful if you want to enable users to create graphs.
+This text interface also support being able to pass targets as arguments to functions, like you need for the `asPercentOf` function.
+
+```ruby
+graph = Slate::Graph.new
+
+target = <<-SLATE
+"stats.web1.load" {
+  sum
+  alias "load"
+}
+SLATE
+
+graph << Slate::Parser.parse(target)
+```
+
+Full test cases for different things this syntax supports are here: [Parser Spec](https://github.com/trobrock/slate/blob/master/spec/slate/parser_spec.rb)
+
+### Calculations
+
+Slate supports things call Calculations, which take in graphite data and boil them down to single numbers, this can be useful if you wanted to calculate the average load over the week for all your servers.
+
+```ruby
+graph = Slate::Graph.new
+graph << Slate::Target.build("stats.web01.load")
+
+p Slate::Calculation::Mean.new(graph).result
+# [{ "name" => "stats.web01.load", "value" => 1.5 }]
+```
+
+All the possible calculation classes are [here](https://github.com/trobrock/slate/tree/master/lib/slate/calculation).
 
 ## Contributing
 
@@ -33,4 +109,5 @@ TODO: Write usage instructions here
 ## Contributors
 
 Trae Robrock (https://github.com/trobrock)
+
 Andrew Katz (https://github.com/andrewkatz)

data/lib/slate.rb

@@ -1,5 +1,5 @@
 require "slate/version"
-require "slate/configuration"
+require "slate/client"
 require "slate/target"
 require "slate/graph"
 require "slate/calculation"
@@ -9,11 +9,21 @@ require "slate/calculation/mean"
 require "slate/calculation/last"
 
 module Slate
+  # Public: Configures a new Client instance.
+  #
+  # Yields the Client instance to configure.
+  #
+  # Examples
+  #
+  #   Slate.configure do |config|
+  #     config.endpoint = "http://example.com"
+  #   end
+  #   # => Slate::Client
+  #
+  # Returns a configured Client instance.
   def self.configure
-    yield Configuration.instance
-  end
-
-  def self.configuration
-    Configuration.instance
+    client = Client.new
+    yield client
+    client
   end
 end

data/lib/slate/client.rb

@@ -0,0 +1,6 @@
+module Slate
+  class Client
+    # Public: Gets/Sets the URL endpoint of the Graphite server.
+    attr_accessor :endpoint
+  end
+end

data/lib/slate/graph.rb

@@ -5,7 +5,22 @@ module Slate
   class Graph
     attr_accessor :from, :until
 
-    def initialize(options={})
+    # Public: Creates a new graph instance.
+    #
+    # client  - A configured Slate::Client instance.
+    # options - Options for creating the graph (default: {}):
+    #           :from  - The String to start the data in the graph (optional).
+    #           :until - The String to end the data in the graph (optional).
+    #
+    # Examples
+    #
+    #   Slate::Graph.new(client)
+    #
+    #   Slate::Graph.new(client, { from: "-1d" })
+    #
+    #   Slate::Graph.new(client, { until: "-1h" })
+    def initialize(client, options={})
+      @client  = client
       @from    = options[:from]
       @until   = options[:until]
     end
@@ -14,9 +29,22 @@ module Slate
       @target = target
     end
 
+    # Public: Generate a URL to the image of the graph.
+    #
+    # format - The format of the graph to return, as a Symbol (default: :png).
+    #
+    # Examples
+    #
+    #   url
+    #   # => "http://example.com/render?format=png"
+    #
+    #   url(:svg)
+    #   # => "http://example.com/render?format=svg"
+    #
+    # Returns the URL String.
     def url(format=:png)
       options = url_options.push(["format", format.to_s])
-      "#{Configuration.instance.endpoint}/render?#{params(options)}"
+      "#{@client.endpoint}/render?#{params(options)}"
     end
 
     def download(format=:png)

data/lib/slate/parser.rb

@@ -1,4 +1,5 @@
 require 'treetop'
+require 'singleton'
 require 'slate/parser/extensions'
 Treetop.load File.join(File.dirname(__FILE__), 'parser', 'slate_tree')
 

data/lib/slate/version.rb

@@ -1,3 +1,3 @@
 module Slate
-  VERSION = "0.2.1"
+  VERSION = "1.0.0"
 end

data/slate.gemspec

@@ -26,4 +26,6 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency "rspec"
   gem.add_development_dependency "mocha"
   gem.add_development_dependency "webmock"
+  gem.add_development_dependency "guard-rspec"
+  gem.add_development_dependency "rb-fsevent", "~> 0.9"
 end

data/spec/{slate → lib/slate}/calculation/last_spec.rb

@@ -1,4 +1,4 @@
-require File.join(File.dirname(__FILE__), '..', '..', 'spec_helper')
+require File.join(File.dirname(__FILE__), '..', '..', '..', 'spec_helper')
 
 describe Slate::Calculation::Last do
   before do

data/spec/{slate → lib/slate}/calculation/mean_spec.rb

@@ -1,4 +1,4 @@
-require File.join(File.dirname(__FILE__), '..', '..', 'spec_helper')
+require File.join(File.dirname(__FILE__), '..', '..', '..', 'spec_helper')
 
 describe Slate::Calculation::Mean do
   before do

data/spec/{slate → lib/slate}/graph_spec.rb

@@ -1,8 +1,8 @@
-require File.join(File.dirname(__FILE__), '..', 'spec_helper')
+require File.join(File.dirname(__FILE__), '..', '..', 'spec_helper')
 
 describe Slate::Graph do
   before(:each) do
-    Slate.configure { |c| c.endpoint = "http://graphite" }
+    @client = Slate.configure { |c| c.endpoint = "http://graphite" }
 
     @png_stub  = "PNG Image Data"
     @raw_stub  = "RAW Image Data"
@@ -18,7 +18,7 @@ describe Slate::Graph do
   end
 
   it "should have accessors for from and until" do
-    graph = Slate::Graph.new(:from => "-1w")
+    graph = Slate::Graph.new(@client, :from => "-1w")
     graph.from.should == "-1w"
 
     graph.from = "-1d"
@@ -30,7 +30,7 @@ describe Slate::Graph do
 
   it "should be able to get a single target" do
     target = Slate::Target.build("app.server01.load")
-    graph = Slate::Graph.new
+    graph = Slate::Graph.new(@client)
     graph << target
     query(graph.url).should include("target" => "app.server01.load", "format" => "png")
   end
@@ -39,7 +39,7 @@ describe Slate::Graph do
     target = Slate::Target.build("app.server01.load") do |t|
       t.add_function :cumulative
     end
-    graph = Slate::Graph.new
+    graph = Slate::Graph.new(@client)
     graph << target
     graph.url.should include(CGI.escape("cumulative(app.server01.load)"))
 
@@ -47,21 +47,21 @@ describe Slate::Graph do
       t.add_function :cumulative
       t.add_function :alias, "load"
     end
-    graph = Slate::Graph.new
+    graph = Slate::Graph.new(@client)
     graph << target
     graph.url.should include(CGI.escape("alias(cumulative(app.server01.load),\"load\""))
 
     target = Slate::Target.build("app.server01.load") do |t|
       t.add_function :summarize, "1s", "sum"
     end
-    graph = Slate::Graph.new
+    graph = Slate::Graph.new(@client)
     graph << target
     graph.url.should include(CGI.escape("summarize(app.server01.load,\"1s\",\"sum\")"))
 
     target = Slate::Target.build("app.server01.load") do |t|
       t.add_function :movingAverage, 10
     end
-    graph = Slate::Graph.new
+    graph = Slate::Graph.new(@client)
     graph << target
     graph.url.should include(CGI.escape("movingAverage(app.server01.load,10)"))
   end
@@ -74,7 +74,7 @@ describe Slate::Graph do
       t.add_function :asPercent, first_target
     end
 
-    graph = Slate::Graph.new
+    graph = Slate::Graph.new(@client)
     graph << second_target
 
     graph.url.should include(CGI.escape("asPercent(app.server01.load,sum(app.server*.load))"))
@@ -82,15 +82,15 @@ describe Slate::Graph do
 
   it "should be able to specify start and end times" do
     target = Slate::Target.build("app.server01.load")
-    graph = Slate::Graph.new(:from => "-1d")
+    graph = Slate::Graph.new(@client, :from => "-1d")
     graph << target
     graph.url.should match(/from=-1d/)
 
-    graph = Slate::Graph.new(:until => "-1d")
+    graph = Slate::Graph.new(@client, :until => "-1d")
     graph << target
     graph.url.should match(/until=-1d/)
 
-    graph = Slate::Graph.new(:from => "-1d", :until => "-6h")
+    graph = Slate::Graph.new(@client, :from => "-1d", :until => "-6h")
     graph << target
     graph.url.should match(/from=-1d/)
     graph.url.should match(/until=-6h/)
@@ -98,7 +98,7 @@ describe Slate::Graph do
 
   it "should provide methods for retrieving formats" do
     target = Slate::Target.build("app.server01.load")
-    graph = Slate::Graph.new
+    graph = Slate::Graph.new(@client)
     graph << target
     graph.url(:png).should  match(/format=png/)
     graph.url(:raw).should  match(/format=raw/)
@@ -109,7 +109,7 @@ describe Slate::Graph do
 
   it "should retrieve the graph" do
     target = Slate::Target.build("app.server01.load")
-    graph = Slate::Graph.new
+    graph = Slate::Graph.new(@client)
     graph << target
     graph.download(:png).should  eq(@png_stub)
     graph.download(:raw).should  eq(@raw_stub)

data/spec/{slate → lib/slate}/parser_spec.rb

@@ -1,4 +1,4 @@
-require File.join(File.dirname(__FILE__), '..', 'spec_helper')
+require File.join(File.dirname(__FILE__), '..', '..', 'spec_helper')
 
 describe Slate::Parser do
   before do

data/spec/lib/slate_spec.rb

@@ -0,0 +1,11 @@
+require File.join(File.dirname(__FILE__), '..', 'spec_helper')
+
+describe Slate do
+  it "should be able to configure the graphite host" do
+    client = Slate.configure do |c|
+      c.endpoint = "http://graphite"
+    end
+
+    client.endpoint.should == "http://graphite"
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: slate
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 1.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-22 00:00:00.000000000 Z
+date: 2013-03-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -123,6 +123,38 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rb-fsevent
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
 description: Simple api on top of the graphite render api
 email:
 - trobrock@gmail.com
@@ -133,6 +165,7 @@ files:
 - .gitignore
 - .travis.yml
 - Gemfile
+- Guardfile
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -140,7 +173,7 @@ files:
 - lib/slate/calculation.rb
 - lib/slate/calculation/last.rb
 - lib/slate/calculation/mean.rb
-- lib/slate/configuration.rb
+- lib/slate/client.rb
 - lib/slate/graph.rb
 - lib/slate/parser.rb
 - lib/slate/parser/extensions.rb
@@ -148,11 +181,11 @@ files:
 - lib/slate/target.rb
 - lib/slate/version.rb
 - slate.gemspec
-- spec/slate/calculation/last_spec.rb
-- spec/slate/calculation/mean_spec.rb
-- spec/slate/graph_spec.rb
-- spec/slate/parser_spec.rb
-- spec/slate_spec.rb
+- spec/lib/slate/calculation/last_spec.rb
+- spec/lib/slate/calculation/mean_spec.rb
+- spec/lib/slate/graph_spec.rb
+- spec/lib/slate/parser_spec.rb
+- spec/lib/slate_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/trobrock/slate
 licenses: []
@@ -168,7 +201,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -51540163827976113
+      hash: 4327532724324902652
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -177,17 +210,17 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -51540163827976113
+      hash: 4327532724324902652
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Simple wrapper on top of the graphite render api
 test_files:
-- spec/slate/calculation/last_spec.rb
-- spec/slate/calculation/mean_spec.rb
-- spec/slate/graph_spec.rb
-- spec/slate/parser_spec.rb
-- spec/slate_spec.rb
+- spec/lib/slate/calculation/last_spec.rb
+- spec/lib/slate/calculation/mean_spec.rb
+- spec/lib/slate/graph_spec.rb
+- spec/lib/slate/parser_spec.rb
+- spec/lib/slate_spec.rb
 - spec/spec_helper.rb

data/lib/slate/configuration.rb

@@ -1,9 +0,0 @@
-require 'singleton'
-
-module Slate
-  class Configuration
-    include Singleton
-
-    attr_accessor :endpoint
-  end
-end

data/spec/slate_spec.rb

@@ -1,11 +0,0 @@
-require File.join(File.dirname(__FILE__), 'spec_helper')
-
-describe Slate do
-  it "should be able to configure the graphite host" do
-    Slate.configure do |c|
-      c.endpoint = "http://graphite"
-    end
-
-    Slate.configuration.endpoint.should == "http://graphite"
-  end
-end