slate 1.0.3 → 1.1.0

data/README.md

@@ -27,8 +27,9 @@ Or install it yourself as:
 Configure the Slate client
 
 ```ruby
-Slate.configure do |config|
+client = Slate.configure do |config|
   config.endpoint = "http://your.graphite-server.com"
+  config.timeout  = 30 # In seconds (default: 10)
 end
 ```
 
@@ -37,7 +38,7 @@ end
 To build a basic graph
 
 ```ruby
-graph = Slate::Graph.new
+graph = Slate::Graph.new(client)
 graph << Slate::Target.build("stats.web01.load")
 
 puts graph.url
@@ -47,7 +48,7 @@ puts graph.download(:json)
 Adjust the timeframe of the graph
 
 ```ruby
-graph       = Slate::Graph.new
+graph       = Slate::Graph.new(client)
 graph.from  = "-1w"
 graph.until = "-1d"
 graph << Slate::Target.build("stats.web01.load")
@@ -56,7 +57,7 @@ graph << Slate::Target.build("stats.web01.load")
 Use functions
 
 ```ruby
-graph = Slate::Graph.new
+graph = Slate::Graph.new(client)
 
 graph << Slate::Target.build("stats.web01.load") do |target|
   target.add_function :sum
@@ -72,7 +73,7 @@ Slate also provides a text interface for building targets, this can be useful if
 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
+graph = Slate::Graph.new(client)
 
 target = <<-SLATE
 "stats.web1.load" {
@@ -91,7 +92,7 @@ Full test cases for different things this syntax supports are here: [Parser Spec
 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::Graph.new(client)
 graph << Slate::Target.build("stats.web01.load")
 
 p Slate::Calculation::Mean.new(graph).result
@@ -113,3 +114,5 @@ All the possible calculation classes are [here](https://github.com/trobrock/slat
 Trae Robrock (https://github.com/trobrock)
 
 Andrew Katz (https://github.com/andrewkatz)
+
+David Sennerlöv (https://github.com/dsennerlov)

data/lib/slate.rb

@@ -1,4 +1,5 @@
 require "slate/version"
+require "slate/error"
 require "slate/client"
 require "slate/target"
 require "slate/graph"

data/lib/slate/client.rb

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

data/lib/slate/error.rb

@@ -0,0 +1,5 @@
+module Slate
+  module Error
+    class TimeoutError < StandardError ; end
+  end
+end

data/lib/slate/graph.rb

@@ -1,5 +1,5 @@
 require 'cgi'
-require 'rest-client'
+require 'faraday'
 
 module Slate
   class Graph
@@ -26,6 +26,14 @@ module Slate
       @targets = options[:targets] || []
     end
 
+    # Public: Adds a target to a graph.
+    #
+    # target - A Slate::Target instance.
+    #
+    # Examples
+    #
+    #   graph = Slate::Graph.new(client)
+    #   graph << Slate::Target.build("test.metric")
     def <<(target)
       @targets << target
     end
@@ -48,12 +56,29 @@ module Slate
       "#{@client.endpoint}/render?#{params(options)}"
     end
 
+    # Public: Retrieve the data from the graphite server in the requested format.
+    #
+    # format - The format of the data to return, as a Symbol (default: :png).
+    #
+    # Examples
+    #
+    #   download(:json)
+    #   # => '{"targets":[]}'
     def download(format=:png)
-      RestClient.get url(format)
+      connection.get(url(format)).body
+    rescue Faraday::Error::TimeoutError
+      raise Slate::Error::TimeoutError
     end
 
     private
 
+    def connection
+      @connection ||= Faraday.new do |faraday|
+        faraday.options[:timeout] = @client.timeout || 10
+        faraday.adapter Faraday.default_adapter
+      end
+    end
+
     def url_options
       options = []
       options += @targets.map { |t| ["target", t.to_s] }

data/lib/slate/parser/extensions.rb

@@ -1,56 +1,33 @@
 module Slate
   module SlateTree
     class Target < Treetop::Runtime::SyntaxNode
-      def type
-        :target
-      end
-
       def text_value
         elements.detect{ |e| e.is_a? String }.text_value
       end
     end
 
     class Function < Treetop::Runtime::SyntaxNode
-      def type
-        :function
-      end
-
       def text_value
         elements.detect{ |e| e.is_a? Token }.text_value
       end
     end
 
     class Token < Treetop::Runtime::SyntaxNode
-      def type
-        :token
-      end
     end
 
     class Argument < Treetop::Runtime::SyntaxNode
-      def type
-        :argument
-      end
-
       def text_value
         elements.first.text_value
       end
     end
 
     class String < Treetop::Runtime::SyntaxNode
-      def type
-        :string
-      end
-
       def text_value
         super.gsub(/"/,'')
       end
     end
 
     class Integer < Treetop::Runtime::SyntaxNode
-      def type
-        :integer
-      end
-
       def text_value
         super.to_i
       end

data/lib/slate/target.rb

@@ -43,8 +43,6 @@ module Slate
       args.map do |arg|
         if arg.is_a?(Numeric)
           arg.to_s
-        elsif arg.is_a?(Slate::Graph)
-          arg.send(:target)
         elsif arg.is_a? Slate::Target
           arg.to_s
         else

data/lib/slate/version.rb

@@ -1,3 +1,3 @@
 module Slate
-  VERSION = "1.0.3"
+  VERSION = "1.1.0"
 end

data/slate.gemspec

@@ -17,10 +17,10 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
 
-  gem.add_dependency "rest-client", "~> 1.6.7"
-  gem.add_dependency "json", "~> 1.7.5"
+  gem.add_dependency "faraday", "~> 0.8"
+  gem.add_dependency "json", "~> 1.8"
   gem.add_dependency "jruby-openssl" if RUBY_PLATFORM == 'java'
-  gem.add_dependency "treetop", "~> 1.4.12"
+  gem.add_dependency "treetop", "~> 1.4"
 
   gem.add_development_dependency "rake"
   gem.add_development_dependency "rspec"

data/spec/lib/slate/graph_spec.rb

@@ -124,6 +124,19 @@ describe Slate::Graph do
     graph.download(:json).should eq(@json_stub)
     graph.download(:svg).should  eq(@svg_stub)
   end
+
+  it "should respect the configured timeout" do
+    stub_request(:get, "http://graphite/render?format=png&target=app.server01.timeout").
+      to_timeout
+
+    target = Slate::Target.build("app.server01.timeout")
+    graph = Slate::Graph.new(@client)
+    graph << target
+
+    expect {
+      graph.download(:png).should  eq(@png_stub)
+    }.to raise_error(Slate::Error::TimeoutError)
+  end
 end
 
 def stub_download(format, body="")

data/spec/lib/slate/target_spec.rb

@@ -0,0 +1,75 @@
+require File.join(File.dirname(__FILE__), '..', '..', 'spec_helper')
+
+describe Slate::Target do
+  context "build" do
+    it "should return a target" do
+      Slate::Target.build("some.target").should be_a Slate::Target
+    end
+
+    it "should be able to configure the target" do
+      target = Slate::Target.build("some.target") do |target|
+        target.add_function :sum
+      end
+
+      target.to_s.should include("sum")
+    end
+  end
+
+  context "#to_s" do
+    let(:target) { Slate::Target.build("some.target") }
+
+    it "should return the target name" do
+      target.to_s.should == "some.target"
+    end
+
+    it "should wrap the target with functions that have no arguments" do
+      target.add_function :sum
+
+      target.to_s.should == "sum(some.target)"
+    end
+
+    context "with a string as a function argument" do
+      it "should add an argument" do
+        target.add_function :summarize, "1h"
+
+        target.to_s.should == "summarize(some.target,\"1h\")"
+      end
+
+      it "should add the arguments" do
+        target.add_function :summarize, "1h", "avg"
+
+        target.to_s.should == "summarize(some.target,\"1h\",\"avg\")"
+      end
+    end
+
+    context "with a number as a function argument" do
+      it "should add an argument" do
+        target.add_function :aliasByNode, 1
+
+        target.to_s.should == "aliasByNode(some.target,1)"
+      end
+
+      it "should add the arguments" do
+        target.add_function :aliasByNode, 1, 2
+
+        target.to_s.should == "aliasByNode(some.target,1,2)"
+      end
+    end
+
+    context "with a target as a function argument" do
+      let(:other_target) { Slate::Target.build "some.new.target" }
+
+      it "should add an argument" do
+        target.add_function :asPercentOf, other_target
+
+        target.to_s.should == "asPercentOf(some.target,some.new.target)"
+      end
+
+      it "should add the arguments" do
+        target.add_function :asPercentOf, other_target, other_target
+
+        target.to_s.should == "asPercentOf(some.target,some.new.target,some.new.target)"
+      end
+    end
+  end
+end

data/spec/lib/slate_spec.rb

@@ -8,4 +8,12 @@ describe Slate do
 
     client.endpoint.should == "http://graphite"
   end
+
+  it "should be able to configure the request timeout" do
+    client = Slate.configure do |c|
+      c.timeout = 30
+    end
+
+    client.timeout.should == 30
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: slate
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,16 +9,16 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-14 00:00:00.000000000 Z
+date: 2013-07-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rest-client
+  name: faraday
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.6.7
+        version: '0.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.6.7
+        version: '0.8'
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
@@ -34,7 +34,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.7.5
+        version: '1.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -42,7 +42,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.7.5
+        version: '1.8'
 - !ruby/object:Gem::Dependency
   name: treetop
   requirement: !ruby/object:Gem::Requirement
@@ -50,7 +50,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.4.12
+        version: '1.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -58,7 +58,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.4.12
+        version: '1.4'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -190,6 +190,7 @@ files:
 - lib/slate/calculation/last.rb
 - lib/slate/calculation/mean.rb
 - lib/slate/client.rb
+- lib/slate/error.rb
 - lib/slate/graph.rb
 - lib/slate/parser.rb
 - lib/slate/parser/extensions.rb
@@ -202,6 +203,7 @@ files:
 - spec/lib/slate/calculation_spec.rb
 - spec/lib/slate/graph_spec.rb
 - spec/lib/slate/parser_spec.rb
+- spec/lib/slate/target_spec.rb
 - spec/lib/slate_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/trobrock/slate
@@ -218,7 +220,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4420928061337880336
+      hash: 3246476924624244754
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -227,7 +229,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4420928061337880336
+      hash: 3246476924624244754
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
@@ -240,5 +242,6 @@ test_files:
 - spec/lib/slate/calculation_spec.rb
 - spec/lib/slate/graph_spec.rb
 - spec/lib/slate/parser_spec.rb
+- spec/lib/slate/target_spec.rb
 - spec/lib/slate_spec.rb
 - spec/spec_helper.rb