copperegg 0.6.4 → 0.6.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c5054bedeb67b89a9135876f83f23ea041f2f05b
-  data.tar.gz: 4b570e797e1c336d2556cc76d6a8aac079976bff
+  metadata.gz: 59b70ed5f945021c7dfe5684b46eb70422effc51
+  data.tar.gz: 2eb98a496a3a433cae923714fdcdca3c5efe0100
 SHA512:
-  metadata.gz: 59409bae3cf86c65e1e9ef868a746a9b325395e682974057812d786f94d100d6b415ff19330f45db2a6de8d30323010f0b7ce539b63d66e60e78211068264c53
-  data.tar.gz: a1e10e6be0bf51e1894027e2f261df45db4f8aa60839d1e138a9fa4ee601ab539bb424f4e4918622639d68ede5153ad85475798afbf455ecfcd1209fe0dfdc9d
+  metadata.gz: 193356a9428c2ef79df3cc01d124ae08bd010182755448c127fc89092e7f76e08ddf1d574e3e71720f9f72223629a9049a35dd0d0994ad61718bcbdb9a9541e0
+  data.tar.gz: 0afbce8c5665297c495f11f580deb7b058d86f4a0d7804292cfa98bb5295360218eadfb98de82b3fa850d837ee258432ad048074e6195466cb44c0887ae15a27

data/CHANGELOG.md

@@ -41,7 +41,7 @@ Changes:
 
 Bugfixes:
 
-  - format to match changes in CopperEgg API
+  - format to match changes in Uptime Cloud Monitor API
 
 
 ## 0.5.2 (Dec 3, 2012)

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2013 CopperEgg Corporation.
+Copyright (c) 2013 IDERA.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,6 +1,6 @@
 # CopperEgg Gem
 
-The CopperEgg gem allows programmatic access to the CopperEgg API.
+The CopperEgg gem allows programmatic access to the Uptime Cloud Monitor API.
 
 ## Install
 
@@ -21,7 +21,7 @@ $ gem install copperegg-{version}.gem
 
 ## Getting Started
 
-### Setup
+#### Setup
 
 ``` ruby
 require 'rubygems' # not necessary with ruby 1.9 but included for completeness
@@ -29,7 +29,9 @@ require 'copperegg'
 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")
@@ -41,7 +43,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
@@ -66,7 +68,7 @@ metric_group2.name
 # => "my_metric_group"
 ```
 
-### Updating a metric group:
+#### Updating 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.
 
@@ -85,20 +87,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
@@ -113,7 +116,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.
 
@@ -146,13 +151,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:
 
@@ -160,6 +165,38 @@ Dashboards can be deleted like metric groups:
 dashboard.delete
 ```
 
+## Tags
+
+#### Getting 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].
@@ -171,4 +208,4 @@ Full [API docs][docs] are available.
 [docs]:http://dev.copperegg.com
 
 ## Copyright
-Copyright 2013 CopperEgg.
+Copyright 2013 IDERA.

data/copperegg.gemspec

@@ -6,8 +6,8 @@ Gem::Specification.new do |s|
   s.author  = 'Eric Anderson'
   s.email   = 'anderson@copperegg.com'
 
-  s.description = 'Library for using the CopperEgg REST API'
-  s.summary   = 'Library for using the CopperEgg REST API'
+  s.description = 'Library for using the Uptime Cloud Monitor REST API'
+  s.summary   = 'Library for using the Uptime Cloud Monitor REST API'
   s.homepage  = 'http://github.com/copperegg/copperegg-ruby'
   s.license   = 'MIT'
 

data/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/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/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/lib/copperegg/ver.rb

@@ -1,3 +1,3 @@
 module CopperEgg
-  GEM_VERSION = "0.6.4"
+  GEM_VERSION = '0.6.5'
 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,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: copperegg
 version: !ruby/object:Gem::Version
-  version: 0.6.4
+  version: 0.6.5
 platform: ruby
 authors:
 - Eric Anderson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-14 00:00:00.000000000 Z
+date: 2018-05-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json_pure
@@ -30,7 +30,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.7.6
-description: Library for using the CopperEgg REST API
+description: Library for using the Uptime Cloud Monitor REST API
 email: anderson@copperegg.com
 executables: []
 extensions: []
@@ -41,8 +41,6 @@ files:
 - "./LICENSE"
 - "./README.md"
 - "./Rakefile"
-- "./copperegg-0.6.2.gem"
-- "./copperegg-0.6.3.gem"
 - "./copperegg.gemspec"
 - "./lib/copperegg.rb"
 - "./lib/copperegg/api.rb"
@@ -50,14 +48,17 @@ files:
 - "./lib/copperegg/metric_group.rb"
 - "./lib/copperegg/metric_sample.rb"
 - "./lib/copperegg/mixins/persistence.rb"
+- "./lib/copperegg/tag.rb"
 - "./lib/copperegg/ver.rb"
 - "./supplemental/release_version.sh"
 - "./test/custom_dashboard_test.rb"
 - "./test/metric_group_test.rb"
 - "./test/metric_sample_test.rb"
+- "./test/tag_test.rb"
 - test/custom_dashboard_test.rb
 - test/metric_group_test.rb
 - test/metric_sample_test.rb
+- test/tag_test.rb
 homepage: http://github.com/copperegg/copperegg-ruby
 licenses:
 - MIT
@@ -84,11 +85,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.6.12
 signing_key: 
 specification_version: 4
-summary: Library for using the CopperEgg REST API
+summary: Library for using the Uptime Cloud Monitor REST API
 test_files:
+- test/tag_test.rb
+- test/metric_group_test.rb
 - test/custom_dashboard_test.rb
 - test/metric_sample_test.rb
-- test/metric_group_test.rb