copperegg-revealmetrics 0.6.2 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9b7bb1be69dca77240c15db94a5eebc10f30b005
-  data.tar.gz: b1d20e84a42d1885a62b2b484421bfa384e8c748
+  metadata.gz: 46b48e05cc03369a33465d7a7bf15b5d0c5ad2f6
+  data.tar.gz: b0e7abe6d5914abeac84f090125ef2d84df7d48d
 SHA512:
-  metadata.gz: e725f928629913a3c9e6ce970c2ffa7b4a77e5f64c891699e24b73a5812aaa4ea5d30e6f908e67fe528c2293904414202c21e21cdbd87cec253658972ced6708
-  data.tar.gz: 826f07d4c1bb2fb4f49d103e6018a743faee47aa511fc0c412680342862e95f4716238d0e2da26a45c55dc70c9d3912ae0ced630d43baeff9aac6aedd68acbce
+  metadata.gz: d0d773616060d88966044830bbce56ac47cb487be77fe7c017d545bc34b6599a34651f0f7fad12cbcb8fa87915e1393e9df779dec4b579f14434d4adfd7ef61f
+  data.tar.gz: e9521b6fef6bf58a6e8ba41d974dcf18c7ac039b453ceb90ac98bebb8b3a95187ec436ae3d215037d9944b2bb7690ea7c853cf4c20710a6e963f74d03f03cf8f

data/Users/reto/Projects/copperegg-revealmetrics/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.7.0
+ - Cover "tags" functionality of API with `CopperEgg::Tag`.
+
+
 ## 0.6.2
  - Fork from `CopperEgg/copperegg-ruby` to `cargomedia/copperegg-revealmetrics`
 

data/Users/reto/Projects/copperegg-revealmetrics/README.md

@@ -4,22 +4,22 @@ This gem allows programmatic access to the CopperEgg Revealmetrics API.
 
 This is a fork of the [official client](https://github.com/CopperEgg/copperegg-ruby), adding additional functionality.
 
-## Install
+## Getting Started
 
+Install with ruby gems:
 ```
 gem install copperegg-revealmetrics
 ```
 
-## Getting Started
-
-### Setup
-
+Set up your API key:
 ``` ruby
 require 'copperegg-revealmetrics'
 CopperEgg::Api.apikey = "sdf87xxxxxxxxxxxxxxxxxxxxx" # from the web UI
 ```
 
-### Get a metric group:
+## Metric Groups
+
+#### Get a metric group:
 
 ``` ruby
 metric_group = CopperEgg::MetricGroup.find("my_metric_group")
@@ -31,7 +31,7 @@ metric_group.metrics
 # => [#<CopperEgg::MetricGroup::Metric:0x007fb43aab2570 @position=0, @type="ce_gauge", @name="metric1", @label="Metric 1", @unit="b">]
 ```
 
-### Create a metric group:
+#### Create a metric group:
 
 ``` ruby
 metric_group = CopperEgg::MetricGroup.new(:name => "my_new_metric_group", :label => "Cool New Group Visible Name", :frequency => 60) # data is sent every 60 seconds
@@ -56,7 +56,7 @@ metric_group2.name
 # => "my_metric_group"
 ```
 
-### Updating a metric group:
+#### Update a metric group:
 
 Labels, frequency, metric types and metric units can be updated and additional metrics can be added. Changes to the metric group name or names of metrics within will be ignored.
 
@@ -75,20 +75,21 @@ metric_group.frequency
 # => 5
 ```
 
-### Delete a metric group
+#### Delete a metric group
 
 ```ruby
 metric_group.delete
 ```
 
+## Samples
 
-### Post samples for a metric group
+#### Post samples for a metric group
 
 ```ruby
 CopperEgg::MetricSample.save(metric_group.name, "custom_identifier1", Time.now.to_i, "active_connections" => 2601, "connections_accepts" => 154, "connections_handled" => 128, "connections_requested" => 1342, ...)
 ```
 
-### Get samples
+#### Get samples
 
 ```ruby
 # Get the most recent samples for a single metric
@@ -103,7 +104,9 @@ CopperEgg::MetricSample.samples(metric_group.name, ["connections_accepts", "conn
 
 The raw JSON response is returned as specified in the [API docs][sample_docs].
 
-### Create a dashboard from a metric group
+## Dashboards
+
+#### Create a dashboard from a metric group
 
 By default, the dashboard created will be named "_MetricGroupLabel_ Dashboard" and will have one timeline widget per metric matching all sources.
 
@@ -136,13 +139,13 @@ You can limit the widgets created by metric.
 dashboard = CopperEgg::CustomDashboard.create(metric_group, :name => "Cloud Servers", :identifiers => ["custom_identifier1", "custom_identifier2"], :metrics => ["reading", "writing", "waiting"])
 ```
 
-### Get a dashboard
+#### Get a dashboard
 
 ```ruby
 dashboard = CopperEgg::CustomDashboard.find_by_name("My Metric Group Dashboard")
 ```
 
-### Delete a dashboard
+#### Delete a dashboard
 
 Dashboards can be deleted like metric groups:
 
@@ -150,6 +153,38 @@ Dashboards can be deleted like metric groups:
 dashboard.delete
 ```
 
+## Tags
+
+#### Get all or specific tags
+
+```ruby
+tags_list = CopperEgg::Tag.find
+tag = CopperEgg::Tag.find_by_name("my-tag")
+```
+
+#### Create a tag
+
+```ruby
+tag = CopperEgg::Tag.new({:name => "my-tag"})
+tag.objects = ["object-identifier-1", "object-identifier-2"]
+tag.save
+```
+
+#### Update a tag
+
+```ruby
+tag.objects = ["object-identifier-1", "object-identifier-2", "object-identifier-3"]
+tag.save
+```
+
+#### Delete a tag
+
+```ruby
+tag.delete
+```
+
+
+
 ## Questions / Problems?
 
 There are more detailed examples in the [test classes][test_classes].

data/Users/reto/Projects/copperegg-revealmetrics/lib/copperegg.rb

@@ -6,6 +6,7 @@ require File.dirname(__FILE__) + "/copperegg/mixins/persistence"
 require File.dirname(__FILE__) + "/copperegg/metric_group"
 require File.dirname(__FILE__) + "/copperegg/custom_dashboard"
 require File.dirname(__FILE__) + "/copperegg/metric_sample"
+require File.dirname(__FILE__) + "/copperegg/tag"
 require File.dirname(__FILE__) + "/copperegg/api"
 
 module CopperEgg

data/Users/reto/Projects/copperegg-revealmetrics/lib/copperegg/mixins/persistence.rb

@@ -1,6 +1,8 @@
 module CopperEgg
 	class ValidationError < Exception; end
 
+	class HttpError < Exception; end
+
 	module Mixins
 		module Persistence
 			def self.included(klass)
@@ -34,7 +36,7 @@ module CopperEgg
 
 						def request(params={})
 							request_type = params.delete(:request_type)
-							raise "invalid type" if !%w(get post put delete).include?(request_type)
+							raise "invalid type `#{request_type}`" if !%w(get post put delete).include?(request_type)
 							id = params.delete(:id)
 
 							uri = id ? URI.parse("#{Api.uri}/#{self.resource_name}/#{id}.json") : URI.parse("#{Api.uri}/#{self.resource_name}.json")
@@ -57,6 +59,14 @@ module CopperEgg
 				      response
 						end
 
+						def request_200(params={})
+							response = request(params)
+							unless response.code === "200"
+								raise HttpError.new("HTTP request failed with code `#{response.code}`: `#{response.body}`")
+							end
+							response
+						end
+
 						private
 
 						def resource(value)

data/Users/reto/Projects/copperegg-revealmetrics/lib/copperegg/tag.rb

@@ -0,0 +1,94 @@
+module CopperEgg
+  class Tag
+    include CopperEgg::Mixins::Persistence
+
+    resource "tags"
+
+    attr_accessor :name, :objects
+
+    def load_attributes(attributes)
+      @objects_original = []
+
+      attributes.each do |name, value|
+        if name.to_s == "id"
+          @id = value
+        elsif !respond_to?("#{name}=")
+          next
+        elsif name.to_s == "objects"
+          @objects = value.map { |object| object["idv"].to_s.gsub(/\|$/, "") }
+          @objects_original = @objects.clone
+        else
+          send "#{name}=", value
+        end
+      end
+    end
+
+    def name
+      @name || @id
+    end
+
+    def valid?
+      @error = nil
+
+      if self.name.nil? || self.name.to_s.strip.empty?
+        @error = "Name can't be blank."
+        return false
+      end
+
+      if self.name.to_s.match(/[^\w-]/)
+        @error = "Name contains invalid characters."
+        return false
+      end
+
+      if self.objects.nil? || self.objects.empty?
+        @error = "You must define at least one object."
+        return false
+      end
+
+      unless self.objects.kind_of?(Array)
+        @error = "Invalid objects field."
+        return false
+      end
+
+      if self.objects.any? { |object| !object.kind_of?(String) }
+        @error = "Invalid object identifier."
+        return false
+      end
+
+      true
+    end
+
+    def delete
+      self.class.request_200({:id => name, :request_type => "delete"})
+    end
+
+    def save
+      unless valid?
+        raise ValidationError.new(@error)
+      end
+
+      remove_objects(@objects_original - @objects)
+      add_objects(@objects - @objects_original)
+      @objects_original = @objects
+    end
+
+    def update
+      save
+    end
+
+    def to_hash
+      {"tag" => name, "ids" => objects}
+    end
+
+    private
+
+    def remove_objects(ids)
+      self.class.request_200({:id => name, :ids => ids, :request_type => "delete"}) unless ids.empty?
+    end
+
+    def add_objects(ids)
+      self.class.request_200({:tag => name, :ids => ids, :request_type => "post"}) unless ids.empty?
+    end
+
+  end
+end

data/Users/reto/Projects/copperegg-revealmetrics/lib/copperegg/ver.rb

@@ -1,3 +1,3 @@
 module CopperEgg
-  GEM_VERSION = "0.6.2"
+  GEM_VERSION = "0.7.0"
 end

data/Users/reto/Projects/copperegg-revealmetrics/test/tag_test.rb

@@ -0,0 +1,59 @@
+require "test/unit"
+require "copperegg"
+
+class TagTest < Test::Unit::TestCase
+
+	def test_name_accessor_and_setter
+		tag = CopperEgg::Tag.new(:name => "my_tag")
+
+		assert_equal "my_tag", tag.name
+	end
+
+	def test_save_should_fail_if_name_is_blank
+		tag = CopperEgg::Tag.new
+
+		error = assert_raise(CopperEgg::ValidationError) { tag.save }
+		assert_equal "Name can't be blank.", error.message
+	end
+
+	def test_save_should_fail_if_name_contains_invalid_characters
+		tag = CopperEgg::Tag.new(:name => "my%%%tag")
+
+		error = assert_raise(CopperEgg::ValidationError) { tag.save }
+		assert_equal "Name contains invalid characters.", error.message
+	end
+
+	def test_objects_accessor_and_setter
+		tag = CopperEgg::Tag.new(:name => "my_tag", :objects => [{"idv" => "obj1"}, {"idv" => "obj2"}])
+
+		assert_equal ["obj1", "obj2"], tag.objects
+	end
+
+	def test_save_should_fail_if_no_objects_are_declared
+		tag = CopperEgg::Tag.new(:name => "my_tag")
+
+		error = assert_raise(CopperEgg::ValidationError) { tag.save }
+		assert_equal "You must define at least one object.", error.message
+	end
+
+	def test_save_should_fail_if_objects_include_non_strings
+		tag = CopperEgg::Tag.new(:name => "my_tag")
+		tag.objects = ["obj1", 12323]
+
+		error = assert_raise(CopperEgg::ValidationError) { tag.save }
+		assert_equal "Invalid object identifier.", error.message
+	end
+
+	def test_to_hash
+		tag = CopperEgg::Tag.new(:name => "test")
+		tag.objects = ["obj1", "obj2"]
+
+		assert tag.valid?
+		hash = tag.to_hash
+
+		assert_nil hash["id"]
+		assert_equal "test", hash["tag"]
+		assert_equal ["obj1", "obj2"], hash["ids"]
+	end
+
+end

data/test/tag_test.rb

@@ -0,0 +1,59 @@
+require "test/unit"
+require "copperegg"
+
+class TagTest < Test::Unit::TestCase
+
+	def test_name_accessor_and_setter
+		tag = CopperEgg::Tag.new(:name => "my_tag")
+
+		assert_equal "my_tag", tag.name
+	end
+
+	def test_save_should_fail_if_name_is_blank
+		tag = CopperEgg::Tag.new
+
+		error = assert_raise(CopperEgg::ValidationError) { tag.save }
+		assert_equal "Name can't be blank.", error.message
+	end
+
+	def test_save_should_fail_if_name_contains_invalid_characters
+		tag = CopperEgg::Tag.new(:name => "my%%%tag")
+
+		error = assert_raise(CopperEgg::ValidationError) { tag.save }
+		assert_equal "Name contains invalid characters.", error.message
+	end
+
+	def test_objects_accessor_and_setter
+		tag = CopperEgg::Tag.new(:name => "my_tag", :objects => [{"idv" => "obj1"}, {"idv" => "obj2"}])
+
+		assert_equal ["obj1", "obj2"], tag.objects
+	end
+
+	def test_save_should_fail_if_no_objects_are_declared
+		tag = CopperEgg::Tag.new(:name => "my_tag")
+
+		error = assert_raise(CopperEgg::ValidationError) { tag.save }
+		assert_equal "You must define at least one object.", error.message
+	end
+
+	def test_save_should_fail_if_objects_include_non_strings
+		tag = CopperEgg::Tag.new(:name => "my_tag")
+		tag.objects = ["obj1", 12323]
+
+		error = assert_raise(CopperEgg::ValidationError) { tag.save }
+		assert_equal "Invalid object identifier.", error.message
+	end
+
+	def test_to_hash
+		tag = CopperEgg::Tag.new(:name => "test")
+		tag.objects = ["obj1", "obj2"]
+
+		assert tag.valid?
+		hash = tag.to_hash
+
+		assert_nil hash["id"]
+		assert_equal "test", hash["tag"]
+		assert_equal ["obj1", "obj2"], hash["ids"]
+	end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: copperegg-revealmetrics
 version: !ruby/object:Gem::Version
-  version: 0.6.2
+  version: 0.7.0
 platform: ruby
 authors:
 - Eric Anderson
@@ -72,14 +72,19 @@ files:
 - "/Users/reto/Projects/copperegg-revealmetrics/lib/copperegg/metric_group.rb"
 - "/Users/reto/Projects/copperegg-revealmetrics/lib/copperegg/metric_sample.rb"
 - "/Users/reto/Projects/copperegg-revealmetrics/lib/copperegg/mixins/persistence.rb"
+- "/Users/reto/Projects/copperegg-revealmetrics/lib/copperegg/tag.rb"
 - "/Users/reto/Projects/copperegg-revealmetrics/lib/copperegg/ver.rb"
 - "/Users/reto/Projects/copperegg-revealmetrics/pkg/copperegg-revealmetrics-0.6.1.gem"
+- "/Users/reto/Projects/copperegg-revealmetrics/pkg/copperegg-revealmetrics-0.6.2.gem"
+- "/Users/reto/Projects/copperegg-revealmetrics/pkg/copperegg-revealmetrics-0.7.0.gem"
 - "/Users/reto/Projects/copperegg-revealmetrics/test/custom_dashboard_test.rb"
 - "/Users/reto/Projects/copperegg-revealmetrics/test/metric_group_test.rb"
 - "/Users/reto/Projects/copperegg-revealmetrics/test/metric_sample_test.rb"
+- "/Users/reto/Projects/copperegg-revealmetrics/test/tag_test.rb"
 - test/custom_dashboard_test.rb
 - test/metric_group_test.rb
 - test/metric_sample_test.rb
+- test/tag_test.rb
 homepage: https://github.com/cargomedia/copperegg-revealmetrics
 licenses:
 - MIT
@@ -114,3 +119,4 @@ test_files:
 - test/custom_dashboard_test.rb
 - test/metric_group_test.rb
 - test/metric_sample_test.rb
+- test/tag_test.rb