librato_silverline_api 1.0.0

data/.gitignore

@@ -0,0 +1,7 @@
+pkg/*
+*.gem
+.bundle
+.DS_Store
+config/librato-silverline-api.yml
+samples/test.rb
+coverage

data/Gemfile

@@ -0,0 +1,4 @@
+source :gemcutter
+
+# Specify your gem's dependencies in librato_silverline_api.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,23 @@
+PATH
+  remote: .
+  specs:
+    librato_silverline_api (0.0.1)
+      json
+      rest-client (= 1.6.1)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    json (1.4.6)
+    mime-types (1.16)
+    rest-client (1.6.1)
+      mime-types (>= 1.16)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (>= 1.0.0)
+  json
+  librato_silverline_api!
+  rest-client (= 1.6.1)

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2011 Librato Inc.
+
+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 @@
+# Silverline API Gem
+
+Ruby wrapper for the Librato Silverline API.
+
+## Installation
+
+    sudo gem install librato_silverline_api
+    
+## Description
+
+  This gem conists of three classes: Template, Container and Axis.
+  The interaction with the API happens exclusively through the Template class. It offers very basic Active Resource methods to find, create, save and update templates. Templates contains Containers and they again contain Axes.
+  
+## Example Usage
+
+    # Configure API Access
+    SilverlineAPI.username = "example@librato.com"
+    SilverlineAPI.key = "YOUR_API_TOKEN"
+    
+    # Retrieve Templates
+    templates = SilverlineAPI::Templates.find(:all) # returns a maximum of 100 templates
+
+    templates = SilverlineAPI::Templates.find(:all, :length => 10, :offset => 20) # returns the 3rd page and contains 10 templates
+
+    templates = SilverlineAPI::Templates.find(:all, :name => "foo") # returns a maximum of 100 templates which partially match the name
+
+    SilverlineAPI.last_response # holds the information of the last response, e.g. the amount of templates, pagination and search detail, etc.
+
+    # create a template with the default containers
+    template = SilverlineAPI::Template.new(:name => "foo", :min_cpu => 200, :min_mem => 128)
+    template.save # saves the newly created template
+
+    # add a special container
+    container = SilverlineAPI::Container.new(:name => "bar", :cpu => {:allocation => 40}, :mem => {:allocation => 64, :max => 64})
+    template.containers.push(container)
+    template.save
+
+### Copyright
+
+Copyright (c) 2011 [Librato Inc.](http://librato.com). See LICENSE for details.

data/Rakefile

@@ -0,0 +1,28 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+desc "Check settings"
+task :check_settings do
+  unless ENV["SILVERLINE_API_SITE"] && ENV["SILVERLINE_API_USERNAME"] && ENV["SILVERLINE_API_KEY"]
+    puts "Please configure your environment."
+    exit
+  end
+end
+
+desc "Run functional tests"
+task :run_functional_tests do
+  Rake::Task["check_settings"].invoke
+  exec("ruby test/functional_test.rb")
+end
+
+desc "Run unit tests"
+task :run_unit_tests do
+  Rake::Task["check_settings"].invoke
+  exec("ruby test/unit/axis-test.rb; ruby test/unit/container-test.rb; ruby test/unit/template-test.rb")
+end
+
+desc "Run all tests"
+task :run_all_tests do
+  Rake::Task["check_settings"].invoke
+  exec("rcov test/unit/axis-test.rb test/unit/container-test.rb test/unit/template-test.rb test/functional_test.rb")
+end

data/config/librato_silverline_api.example.yml

@@ -0,0 +1,6 @@
+# Copy this file to config/remote.yml and make adjustments as necessary.
+#
+# Note: Remote tests will only work when configured to run on a test site that uses the Bogus gateway.
+# Warning: all data in the site specified by 'subdomain' will be cleared and replaced with test data.
+username: xxx
+key: xxx

data/lib/librato_silverline_api.rb

@@ -0,0 +1,209 @@
+require "rubygems"
+require "rest_client"
+require "cgi"
+require "json"
+
+def symbolize_keys(arg)
+  case arg
+  when Array
+    arg.map { |elem| symbolize_keys elem }
+  when Hash
+    Hash[
+      arg.map do |key, value|  
+        k = key.is_a?(String) ? key.to_sym : key
+        v = symbolize_keys(value)
+        [k,v]
+      end
+    ]
+  else
+    arg
+  end
+end
+
+module SilverlineAPI
+  class << self
+    attr_accessor :username, :key, :site, :last_response
+    attr_reader :url
+    
+    def url
+      @url ||= url!
+    end
+    
+    def username=(new_username)
+      @username = CGI.escape(new_username)
+      url!
+    end
+    
+    def key=(new_key)
+      @key = new_key
+      url!
+    end
+    
+    def site=(new_site)
+      @site = new_site
+      url!
+    end
+  
+  private
+  
+    def url!
+      if @site
+        protocol, domain = /(https?:\/\/)(.+)/.match(@site).captures
+      else
+        protocol = "https://"
+        domain = "api.librato.com/v1"
+      end
+      @url = "#{protocol}#{@username}:#{@key}@#{domain}"
+    end
+  end
+  
+  class Template
+    attr_accessor :id, :name, :min_cpu, :min_mem, :min_network_rbw, :min_network_wbw, :min_storage_rbw, :min_storage_wbw, :containers
+    attr_reader :errors
+
+    def initialize(args = {})
+      @id = args[:id] if args[:id]
+      @name = args[:name] if args[:name]
+      @min_cpu = args[:min_cpu] if args[:min_cpu]
+      @min_mem = args[:min_mem] if args[:min_mem]
+      @min_network_rbw = args[:min_network_rbw] if args[:min_network_rbw]
+      @min_network_wbw = args[:min_network_wbw] if args[:min_network_wbw]
+      @min_storage_rbw = args[:min_storage_rbw] if args[:min_storage_rbw]
+      @min_storage_wbw = args[:min_storage_wbw] if args[:min_storage_wbw]
+      @containers = []
+      if args[:containers]
+        args[:containers].each do |container|
+          container.map {|k, v| container[k.to_sym] = v}
+          @containers.push(Container.new(container))
+        end
+      end
+
+      if @containers.size == 0
+        @containers.push(Container.new(:name => "system"))
+        @containers.push(Container.new(:name => "harvest", :cpu => {:allocation => 0}))
+      end
+    end
+
+    def new?
+      @id.nil?
+    end
+    
+    def save
+      @errors = []
+      parameters = {
+        :name => @name, 
+        :min_cpu => @min_cpu, 
+        :min_mem => @min_mem,
+        :min_network_rbw => @min_network_rbw,
+        :min_network_wbw => @min_network_wbw,
+        :min_storage_rbw => @min_storage_rbw,
+        :min_storage_wbw => @min_storage_wbw,
+        :containers => @containers
+      }.to_json
+            
+      if @id
+        begin
+          x = RestClient.put("#{SilverlineAPI.url}/templates/#{@id}.json", parameters, :content_type => :json)
+        rescue RestClient::UnprocessableEntity => e
+          @errors = JSON.parse(e.http_body)["errors"]
+          return false
+        end
+      else
+        begin
+          x = RestClient.post("#{SilverlineAPI.url}/templates.json", parameters, :content_type => :json)
+        rescue RestClient::UnprocessableEntity => e
+          @errors = JSON.parse(e.http_body)["errors"]
+          return false
+        end
+        @id = x.headers[:location].scan(/\d+/).last
+      end
+      true
+    end
+    
+    def self.create(args = {})
+      template = Template.new(args)
+      template.save
+      template
+    end
+    
+    def self.find(*args)
+      scope   = args.slice!(0)
+      options = args.slice!(0) || {}
+
+      if scope == :all
+        array = options.map {|k, v| "#{k}=#{v}"}
+        arguments = array.join("&")
+        unless arguments.empty?
+          query = "/templates.json?#{arguments}"
+        else
+          query = "/templates.json"
+        end
+        response = RestClient.get("#{SilverlineAPI.url}#{query}")
+        hash = symbolize_keys(JSON.parse(response))
+
+        templates = []
+        hash[:templates].each {|template| templates.push(Template.new(template))}
+        SilverlineAPI.last_response = hash[:query]
+        templates
+      else # scope is ID => Template.find(5)
+        query = "/templates/#{scope}.json"
+        response = RestClient.get("#{SilverlineAPI.url}#{query}")
+        hash = symbolize_keys(JSON.parse(response))
+        Template.new(hash)
+      end
+    end
+    
+    
+    def self.find_by_name(template_name)
+      response = RestClient.get("#{SilverlineAPI.url}/templates.json?q=#{template_name}")
+      template = symbolize_keys(JSON.parse(response))
+      Template.new(template.first)
+    end
+    
+    def container_by_name(container_name)
+      @containers.find {|c| c.name == container_name}
+    end
+  end
+
+  class Container
+    attr_accessor :name, :cpu, :mem, :network_rbw, :network_wbw, :storage_rbw, :storage_wbw
+    
+    def initialize(args = {})
+      @name = args[:name]
+      @cpu = args[:cpu] ? Axis.new(args[:cpu]) : Axis.new
+      @mem = args[:mem] ? Axis.new(args[:mem]) : Axis.new
+      @network_rbw = args[:network_rbw] ? Axis.new(args[:network_rbw]) : Axis.new
+      @network_wbw = args[:network_wbw] ? Axis.new(args[:network_wbw]) : Axis.new
+      @storage_rbw = args[:storage_rbw] ? Axis.new(args[:storage_rbw]) : Axis.new
+      @storage_wbw = args[:storage_wbw] ? Axis.new(args[:storage_wbw]) : Axis.new
+    end
+    
+    def to_json(x = nil)
+      {
+        :name => @name,
+        :cpu => @cpu,
+        :mem => @mem,
+        :network_rbw => @network_rbw,
+        :network_wbw => @network_wbw,
+        :storage_rbw => @storage_rbw,
+        :storage_wbw => @storage_wbw
+      }.to_json
+    end
+  end
+  
+  class Axis
+    attr_accessor :allocation, :max
+
+    def initialize(args = {})
+      @allocation = args && args[:allocation] ? args[:allocation] : "unlimited"
+      @max = args && args[:max] ? args[:max] : nil
+    end
+    
+    def to_json(x = nil)
+      {
+        :allocation => @allocation,
+        :max => @max
+      }.to_json
+    end
+  end
+end

data/lib/librato_silverline_api/version.rb

@@ -0,0 +1,3 @@
+module SilverlineAPI
+  VERSION = "1.0.0"
+end

data/librato_silverline_api.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path("../lib/librato_silverline_api/version", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "librato_silverline_api"
+  s.version     = SilverlineAPI::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = "Chris Blaettermann"
+  s.email       = "chris@librato.com"
+  s.homepage    = "http://rubygems.org/gems/librato_silverline_api"
+  s.summary     = "Write a gem summary"
+  s.description = "Write a gem description"
+
+  s.required_rubygems_version = ">= 1.3.6"
+  s.rubyforge_project         = "librato_silverline_api"
+
+  s.add_development_dependency "bundler", ">= 1.0.0"
+  
+  s.add_dependency("rest-client", "1.6.1")
+  s.add_dependency("json", "1.4.6")
+
+  s.files        = `git ls-files`.split("\n")
+  s.executables  = `git ls-files`.split("\n").map{|f| f =~ /^bin\/(.*)/ ? $1 : nil}.compact
+  s.require_path = 'lib'
+end

data/samples/templates.rb

@@ -0,0 +1,27 @@
+require "rubygems"
+require "librato-silverline-api"
+
+# Only for demonstration purposes
+silverline_api_config = YAML::load_file(File.join(File.dirname(__FILE__), "..", "config", "librato-silverline-api.yml"))
+
+# Configure API Access
+SilverlineAPI.username = silverline_api_config["username"]
+SilverlineAPI.key = silverline_api_config["key"]
+
+# Retrieve Templates
+templates = SilverlineAPI::Templates.find(:all) # returns a maximum of 100 templates
+
+templates = SilverlineAPI::Templates.find(:all, :length => 10, :offset => 20) # returns the 3rd page and contains 10 templates
+
+templates = SilverlineAPI::Templates.find(:all, :name => "foo") # returns a maximum of 100 templates which partially match the name
+
+SilverlineAPI.last_response # holds the information of the last response, e.g. the amount of templates, pagination and search detail, etc.
+
+# create a template with the default containers
+template = SilverlineAPI::Template.new(:name => "foo", :min_cpu => 200, :min_mem => 128)
+template.save # saves the newly created template
+
+# add a special container
+container = SilverlineAPI::Container.new(:name => "bar", :cpu => {:allocation => 40}, :mem => {:allocation => 64, :max => 64})
+template.containers.push(container)
+template.save

data/test/functional_test.rb

@@ -0,0 +1,85 @@
+require "test/unit"
+require "./lib/librato_silverline_api.rb"
+
+module SilverlineAPI
+  class FunctionalTest < Test::Unit::TestCase    
+    def configure
+      SilverlineAPI.site = ENV["SILVERLINE_API_SITE"]
+      SilverlineAPI.username = ENV["SILVERLINE_API_USERNAME"]
+      SilverlineAPI.key = ENV["SILVERLINE_API_KEY"]
+    end
+    
+    def has_error?(template, name)
+      template.errors["params"].find {|x| x.include?(name)} != nil
+    end
+    
+    def test_find_all_templates
+      configure
+      
+      templates = Template.find(:all)
+      assert templates.count > 0
+      
+      templates = Template.find(:all, :name => "oo")
+      assert templates.first.name == "foo"
+    end
+    
+    def test_new_template
+      configure
+      
+      template = Template.new
+      assert template.save == false
+      assert has_error?(template, "name")
+      assert has_error?(template, "min_cpu")
+      assert has_error?(template, "min_mem")
+      
+      template.name = "fwfewofiwe"
+      assert template.save == false
+      assert !has_error?(template, "name")
+      assert has_error?(template, "min_cpu")
+      assert has_error?(template, "min_mem")
+      
+      template.min_cpu = 100
+      assert template.save == false
+      assert !has_error?(template, "name")
+      assert !has_error?(template, "min_cpu")
+      assert has_error?(template, "min_mem")
+
+      template = Template.new(:name => "bar")
+      assert template.name == "bar"
+      assert template.save == false
+      assert !has_error?(template, "name")
+      assert has_error?(template, "min_cpu")
+      assert has_error?(template, "min_mem")
+
+      template = Template.create
+      assert has_error?(template, "name")
+      assert has_error?(template, "min_cpu")
+      assert has_error?(template, "min_mem")
+      
+      new_name = Time.now.to_i.to_s
+      
+      template = Template.new
+      template.name = new_name
+      template.min_cpu = 100
+      template.min_mem = 100
+      assert template.save
+      
+      id = template.id
+      template.min_cpu = 200
+      assert template.save
+      
+      template = Template.find(id)
+      assert template != nil
+      assert template.min_cpu == 200
+      
+      template.min_cpu = 50
+      assert template.save == false
+      
+      template = Template.find_by_name(new_name)
+      assert template.name == new_name
+      
+      container = template.container_by_name("system")
+      assert container.name == "system"
+    end
+  end
+end

data/test/unit/axis-test.rb

@@ -0,0 +1,47 @@
+require "test/unit"
+require "./lib/librato_silverline_api.rb"
+
+module SilverlineAPI
+  class AxisTest < Test::Unit::TestCase    
+    def test_empty_axis
+      axis = Axis.new
+      assert axis.allocation == "unlimited"
+      assert axis.max == nil
+    end
+   
+    # Validation does not happen in the gem for now. Therefore we only 
+    # check whether values get handled correctly in the model.
+   
+    def test_parameters
+      axis = Axis.new(:allocation => 20)
+      assert axis.allocation == 20
+      assert axis.max == nil
+      
+      axis = Axis.new(:allocation => 20, :max => 20)
+      assert axis.allocation == 20
+      assert axis.max == 20
+      
+      axis = Axis.new(:allocation => "unlimited")
+      assert axis.allocation == "unlimited"
+      assert axis.max == nil
+      
+      axis = Axis.new({:allocation => "fair"})
+      assert axis.allocation == "fair"
+      assert axis.max == nil
+      
+      axis = Axis.new({:allocation => "monitor"})
+      assert axis.allocation == "monitor"
+      assert axis.max == nil
+      
+      axis = Axis.new({:allocation => 20, :max => nil})
+      assert axis.allocation == 20
+      assert axis.max == nil
+      
+      axis = Axis.new({:allocation => "unlimited", :max => nil})
+      assert axis.allocation == "unlimited"
+      assert axis.max == nil
+      
+      assert axis.to_json == '{"allocation":"unlimited","max":null}'
+    end
+  end
+end

data/test/unit/container-test.rb

@@ -0,0 +1,52 @@
+require "test/unit"
+require "./lib/librato_silverline_api.rb"
+
+module SilverlineAPI
+  class ContainerTest < Test::Unit::TestCase    
+    def test_empty_container
+      container = Container.new
+      assert container.name == nil
+      assert container.cpu.class == Axis
+      assert container.cpu.allocation == "unlimited"
+      assert container.cpu.max == nil
+      assert container.mem.class == Axis
+      assert container.mem.allocation == "unlimited"
+      assert container.mem.max == nil
+      assert container.network_rbw.class == Axis
+      assert container.network_rbw.allocation == "unlimited"
+      assert container.network_rbw.max == nil
+      assert container.network_wbw.class == Axis
+      assert container.network_wbw.allocation == "unlimited"
+      assert container.network_wbw.max == nil
+      assert container.storage_rbw.class == Axis
+      assert container.storage_rbw.allocation == "unlimited"
+      assert container.storage_rbw.max == nil
+      assert container.storage_wbw.class == Axis
+      assert container.storage_wbw.allocation == "unlimited"
+      assert container.storage_wbw.max == nil
+    end
+    
+    def test_container_with_hash
+      container = Container.new(:name => "foo", :cpu => {:allocation => 10})
+      assert container.name == "foo"
+      assert container.cpu.class == Axis
+      assert container.cpu.allocation == 10
+      assert container.cpu.max == nil
+      assert container.mem.class == Axis
+      assert container.mem.allocation == "unlimited"
+      assert container.mem.max == nil
+      assert container.network_rbw.class == Axis
+      assert container.network_rbw.allocation == "unlimited"
+      assert container.network_rbw.max == nil
+      assert container.network_wbw.class == Axis
+      assert container.network_wbw.allocation == "unlimited"
+      assert container.network_wbw.max == nil
+      assert container.storage_rbw.class == Axis
+      assert container.storage_rbw.allocation == "unlimited"
+      assert container.storage_rbw.max == nil
+      assert container.storage_wbw.class == Axis
+      assert container.storage_wbw.allocation == "unlimited"
+      assert container.storage_wbw.max == nil
+    end
+  end
+end

data/test/unit/template-test.rb

@@ -0,0 +1,27 @@
+require "test/unit"
+require "./lib/librato_silverline_api.rb"
+
+module SilverlineAPI
+  class TemplateTest < Test::Unit::TestCase    
+    def test_empty_template
+      template = Template.new
+      assert template.new?
+      assert template.containers != nil
+      assert template.containers.class == Array
+      assert template.containers.count == 2 # System and Harvest container
+      template.containers.each do |container|
+        assert container.class == Container
+      end
+    end
+    
+    def test_template
+      # Because unit tests do not support the real deal, the following line goes into the functional tests
+      # template = SilverlineTemplate.new(:name => "foo")
+      
+      # This test is no joke, since SilverlineTemplate is a wrapper around Template.
+      template = Template.new
+      template.name = "foo"
+      assert template.name == "foo"
+    end
+  end
+end

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification 
+name: librato_silverline_api
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: 
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Chris Blaettermann
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-01-26 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rest-client
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 13
+        segments: 
+        - 1
+        - 6
+        - 1
+        version: 1.6.1
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: json
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 11
+        segments: 
+        - 1
+        - 4
+        - 6
+        version: 1.4.6
+  type: :runtime
+  version_requirements: *id003
+description: Write a gem description
+email: chris@librato.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- config/librato_silverline_api.example.yml
+- lib/librato_silverline_api.rb
+- lib/librato_silverline_api/version.rb
+- librato_silverline_api.gemspec
+- samples/templates.rb
+- test/functional_test.rb
+- test/unit/axis-test.rb
+- test/unit/container-test.rb
+- test/unit/template-test.rb
+has_rdoc: true
+homepage: http://rubygems.org/gems/librato_silverline_api
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 23
+      segments: 
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
+requirements: []
+
+rubyforge_project: librato_silverline_api
+rubygems_version: 1.4.2
+signing_key: 
+specification_version: 3
+summary: Write a gem summary
+test_files: []
+