circonus_api 0.3.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a3ede201a007dc23e83a498822aaecdd1d088c10
+  data.tar.gz: 2acd47ca32aa05a890eaa51b73166cd30bc39044
+SHA512:
+  metadata.gz: 117a9a496d9d6c056cddfcc42a6a0185a300d2ab7fb729498f30bc493cf024e773b40109ec16d64531456fe22b29261823461f66872e9396b8b3642e047e2ca8
+  data.tar.gz: 041229edd86a31bacb0f557107bef5ac6940c2246eb645460347d71d4e14191cbe22b4c5123f0efaadf223f79940544be133fcc109b6e981821b1eb8d3d20fad

data/README.markdown

@@ -0,0 +1,99 @@
+#circonus_api
+
+##### The gem implements Active Resource pattern for Circonus API. The library maps Circonus' models to corresponding ruby classes and implements simple CRUD interface.
+
+## Contents
+- [Installation](#installation)
+- [Models](#models)
+- [CRUD](#crud)
+- [Search](#search)
+- [Contributing](#contributing)
+
+## Installation
+In your `Gemfile`:
+```ruby
+  gem 'circonus_api'
+```
+Require library in the project:
+```ruby
+  require 'circonus_api'
+```
+Initialize `Circonus` with client:
+```ruby
+  client = Circonus::Client.new(app_name, auth_token)
+  Circonus.init(client)
+```
+Check if it works:
+```ruby
+> Circonus::Account.current
+=> #<Circonus::Account:0x007f99bfac8090 ...
+```
+
+## Models
+There is a list of the Circonus models with links to API documentation:
+- [Account](https://login.circonus.com/resources/api/calls/account)
+- [Acknowledgement](https://login.circonus.com/resources/api/calls/acknowledgement)
+- [Alert](https://login.circonus.com/resources/api/calls/alert)
+- [Annotation](https://login.circonus.com/resources/api/calls/annotation)
+- [Broker](https://login.circonus.com/resources/api/calls/broker)
+- [Check](https://login.circonus.com/resources/api/calls/check)
+- [Check Bundle](https://login.circonus.com/resources/api/calls/check_bundle)
+- [Check Move](https://login.circonus.com/resources/api/calls/check_move)
+- [Contact Group](https://login.circonus.com/resources/api/calls/contact_group)
+- [Data](https://login.circonus.com/resources/api/calls/data)
+- [Graph](https://login.circonus.com/resources/api/calls/graph)
+- [Metric Cluster](https://login.circonus.com/resources/api/calls/metric_cluster)
+- [Maintenance](https://login.circonus.com/resources/api/calls/maintenance)
+- [Rebuild Broker](https://login.circonus.com/resources/api/calls/rebuild_broker)
+- [Rule Set](https://login.circonus.com/resources/api/calls/rule_set)
+- [Rule Set Group](https://login.circonus.com/resources/api/calls/rule_set_group)
+- [Tag](https://login.circonus.com/resources/api/calls/tag)
+- [Template](https://login.circonus.com/resources/api/calls/template)
+- [User](https://login.circonus.com/resources/api/calls/user)
+- [Worksheet](https://login.circonus.com/resources/api/calls/worksheet)
+
+## CRUD
+There are several basic CRUD methods:
+
+Class methods:
+
+`::all` - returns all records for corresponding model
+```ruby
+Circonus::RuleSet.all
+```
+`::find` - find the record by id
+```ruby
+Circonus::RuleSet.find(42)
+```
+`::create` - creates new record
+```ruby
+Circonus::RuleSet.create(attribute_hash)
+```
+
+Instrance methods:
+`#update` - updates the record on Circonus (performs PUT request) and returns new object.
+```ruby
+rule_set = Circonus::RuleSet.find(42)
+rule_set.metric_type = 'code'
+rule_set.update
+```
+`#create` creates a new record on Circonus (performs POST request) and returns new object.
+```ruby
+rule_set = Circonus::RuleSet.new({metric_type: 'code', ...})
+rule_set.create
+```
+There is also the `#save` method which calls `#update` if record has `id` or `#create` if `id` is `nil`.
+
+Some models don't implement all CRUD functionality. See Circonus documentation and specs.
+
+## Search
+There is the `::search` method which can filter results by attributes:
+```ruby
+rule_sets = Circonus::RuleSet.search(metric_name: 'code', check: '/check/100500')
+```
+
+## Contributing
+##### Contributions are welcome and appreciated!
+
+
+

data/lib/circonus.rb

@@ -0,0 +1,18 @@
+require 'rest-client'
+require 'json'
+
+require 'circonus/version'
+require 'circonus/models'
+require 'circonus/exceptions'
+require 'circonus/client'
+
+
+module Circonus
+  def self.init(client)
+    @client = client
+  end
+
+  def self.client
+    @client || fail('Client is not set')
+  end
+end

data/lib/circonus/client.rb

@@ -0,0 +1,36 @@
+module Circonus
+  class Client
+    API_URL = 'https://api.circonus.com/v2'
+
+    def initialize(app_name, auth_token)
+      headers = { x_circonus_app_name: app_name, x_circonus_auth_token: auth_token, content_type: :json, accept: :json }
+      @resource = RestClient::Resource.new(API_URL, headers: headers)
+    end
+
+    def get(path, params = {})
+      with_rescue { @resource[path].get(params: params) }
+    end
+
+    def post(path, data)
+      with_rescue { @resource[path].post(data.to_json) }
+    end
+
+    def put(path, data)
+      with_rescue { @resource[path].put(data.to_json) }
+    end
+
+    def delete(path)
+      with_rescue { @resource[path].delete }
+    end
+
+    private
+
+    def with_rescue
+      begin
+        yield
+      rescue RestClient::Exception => e
+        raise ClientError.new(e.inspect)
+      end
+    end
+  end
+end

data/lib/circonus/exceptions.rb

@@ -0,0 +1,7 @@
+module Circonus
+  class UnsupportedAction < StandardError
+  end
+
+  class ClientError < StandardError
+  end
+end

data/lib/circonus/models.rb

@@ -0,0 +1,23 @@
+require 'circonus/models/actions'
+require 'circonus/models/base_model'
+
+require 'circonus/models/account'
+require 'circonus/models/acknowledgement'
+require 'circonus/models/alert'
+require 'circonus/models/annotation'
+require 'circonus/models/broker'
+require 'circonus/models/check'
+require 'circonus/models/check_bundle'
+require 'circonus/models/check_move'
+require 'circonus/models/contact_group'
+require 'circonus/models/data'
+require 'circonus/models/graph'
+require 'circonus/models/metric_cluster'
+require 'circonus/models/maintenance'
+require 'circonus/models/rebuild_broker'
+require 'circonus/models/rule_set'
+require 'circonus/models/rule_set_group'
+require 'circonus/models/tag'
+require 'circonus/models/template'
+require 'circonus/models/user'
+require 'circonus/models/worksheet'

data/lib/circonus/models/account.rb

@@ -0,0 +1,20 @@
+module Circonus
+  class Account < BaseModel
+    fields :_cid, :country_code, :timezone, :name, :_owner, :users, :description, :address2,
+           :_contact_groups, :city, :invites, :state_prov, :address1, :_usage
+    actions :all, :find
+
+    class << self
+      def current
+        data = client.get('account/current')
+        new(JSON.parse(data))
+      end
+    end
+
+    def update
+      client.put('account/current', attributes)
+    end
+
+    alias_method :save, :update
+  end
+end

data/lib/circonus/models/acknowledgement.rb

@@ -0,0 +1,7 @@
+module Circonus
+  class Acknowledgement < BaseModel
+    fields :_cid, :alert, :_last_modified_by, :_acknowledged_by,
+               :acknowledged_until, :_acknowledged_on, :notes, :_active, :_last_modified
+    actions :all, :find, :search, :create, :update
+  end
+end

data/lib/circonus/models/actions.rb

@@ -0,0 +1,82 @@
+module Circonus
+  module Actions
+    module ClassMethods
+      module All
+        def all
+          data = client.get(URI.escape(path))
+          JSON.parse(data).map { |datum| new(datum) }
+        end
+      end
+
+      module Find
+        def find(id, conditions = {})
+          data = client.get(URI.escape("#{path}/#{id}"), conditions)
+          new(JSON.parse(data))
+        end
+      end
+
+      module Create
+        def create(attributes)
+          data = client.post(URI.escape(path), attributes)
+          new(JSON.parse(data))
+        end
+      end
+
+      module Search
+        def search(conditions)
+          query = build_query(conditions)
+          full_path = URI.escape("#{path}?#{query}")
+          data = client.get(full_path, {})
+          JSON.parse(data).map { |datum| new(datum) }
+        end
+
+        private
+
+        def build_query(conditions)
+          conditions.map do |key, value|
+            if value.is_a?(Array)
+              value.map { |v| "f_#{key}=#{v}" }.join('&')
+            else
+              "f_#{key}=#{value}"
+            end
+          end.join('&')
+        end
+      end
+    end
+
+    module InstanceMethods
+      module Save
+        def save
+          new_record? ? create : update
+        end
+
+        def new_record?
+          id.nil?
+        end
+      end
+
+      module Create
+        include Circonus::Actions::InstanceMethods::Save
+        def create
+          data = client.post(URI.escape(path), filtered_attributes)
+          self.class.new(JSON.parse(data))
+        end
+      end
+
+      module Update
+        include Circonus::Actions::InstanceMethods::Save
+        def update
+          data = client.put(URI.escape("#{path}/#{id}"), filtered_attributes)
+          self.class.new(JSON.parse(data))
+        end
+      end
+
+      module Destroy
+        def destroy
+          client.delete(URI.escape("#{path}/#{id}"))
+        end
+        alias_method :delete, :destroy
+      end
+    end
+  end
+end

data/lib/circonus/models/alert.rb

@@ -0,0 +1,8 @@
+module Circonus
+  class Alert < BaseModel
+    fields :_cid, :_metric_notes, :_cleared_value, :_tags, :_occurred_on, :_cleared_on,
+           :_check_name, :_broker, :_rule_set, :_maintenance, :_metric_link, :_value,
+           :_acknowledgement, :_severity, :_check, :_alert_url, :_metric_name
+    actions :all, :find, :search
+  end
+end

data/lib/circonus/models/annotation.rb

@@ -0,0 +1,7 @@
+module Circonus
+  class Annotation < BaseModel
+    fields :_cid, :_created, :stop, :_last_modified_by, :rel_metrics,
+           :description, :title, :category, :_last_modified, :start
+    actions :all, :find, :search, :create, :update, :destroy
+  end
+end

data/lib/circonus/models/base_model.rb

@@ -0,0 +1,81 @@
+module Circonus
+  class BaseModel
+    ACTIONS_CLASS = {
+        all: Circonus::Actions::ClassMethods::All,
+        find: Circonus::Actions::ClassMethods::Find,
+        create: Circonus::Actions::ClassMethods::Create,
+        search: Circonus::Actions::ClassMethods::Search
+    }
+
+    ACTIONS_INSTANCE = {
+        create: Circonus::Actions::InstanceMethods::Create,
+        update: Circonus::Actions::InstanceMethods::Update,
+        destroy: Circonus::Actions::InstanceMethods::Destroy
+    }
+
+    class << self
+      attr_reader :attributes
+
+      def circonus_path(path)
+        @circonus_path = path.to_s
+      end
+
+      def path
+        @circonus_path ||= name.split('::').last.gsub(/([a-z\d])([A-Z])/,'\1_\2').downcase
+      end
+
+      def fields(*attributes)
+        @attributes = attributes.map(&:to_s)
+        attr_accessor(*attributes)
+      end
+
+      def actions(*acts)
+        acts.each do |action|
+          module_class = ACTIONS_CLASS[action]
+          module_instance = ACTIONS_INSTANCE[action]
+          if module_class || module_instance
+            extend(module_class) if module_class
+            include(module_instance) if module_instance
+          else
+            fail 'Wrong action'
+          end
+        end
+      end
+
+      def client
+        ::Circonus.client
+      end
+    end
+
+    def initialize(data = {})
+      self.class::attributes.each do |attribute|
+        value = data[attribute.to_s].nil? ? data[attribute.to_sym] : data[attribute.to_s]
+        send("#{attribute}=", value)
+      end
+    end
+
+    def id
+      _cid ? _cid.split('/').last : nil
+    end
+
+    def attributes
+      Hash[self.class::attributes.map { |attr| [attr, send(attr)] }]
+    end
+
+    def filtered_attributes
+      attributes.reject { |_k, v| v.nil? }
+    end
+
+    def client
+      self.class.client
+    end
+
+    def path
+      self.class.path
+    end
+
+    (ACTIONS_CLASS.keys + ACTIONS_INSTANCE.keys).each do |action|
+      define_method(action) { raise Circonus::UnsupportedAction }
+    end
+  end
+end

data/lib/circonus/models/broker.rb

@@ -0,0 +1,6 @@
+module Circonus
+  class Broker < BaseModel
+    fields :_cid, :_tags, :_name, :_type, :_longitude, :_latitude, :_details
+    actions :all, :find, :search
+  end
+end

data/lib/circonus/models/check.rb

@@ -0,0 +1,6 @@
+module Circonus
+  class Check < BaseModel
+    fields :_cid, :_broker, :_active, :_check_uuid, :_check_bundle, :_details
+    actions :all, :find, :search
+  end
+end

data/lib/circonus/models/check_bundle.rb

@@ -0,0 +1,7 @@
+module Circonus
+  class CheckBundle < BaseModel
+    fields :_created, :status, :_reverse_connection_urls, :target, :_checks, :timeout, :metrics, :_last_modified,
+           :brokers, :_last_modified_by, :period, :_cid, :display_name, :tags, :_check_uuids, :notes, :type, :config
+    actions :all, :find, :search, :create, :update, :destroy
+  end
+end

data/lib/circonus/models/check_move.rb

@@ -0,0 +1,6 @@
+module Circonus
+  class CheckMove < BaseModel
+    fields :_cid, :_error, :new_broker, :check_id, :_broker, :_status
+    actions :all, :find, :search, :create, :update, :destroy
+  end
+end

data/lib/circonus/models/contact_group.rb

@@ -0,0 +1,7 @@
+module Circonus
+  class ContactGroup < BaseModel
+    fields :_cid, :contacts, :aggregation_window, :_last_modified_by, :name,
+           :escalations, :tags, :reminders, :_last_modified, :alert_formats
+    actions :all, :find, :search, :create, :update, :destroy
+  end
+end

data/lib/circonus/models/data.rb

@@ -0,0 +1,35 @@
+module Circonus
+  class Data < BaseModel
+    TYPES = %w(text numeric histogram)
+    PERIODS = [300, 1800, 10800, 86400]
+    REQUIRED_CONDITIONS = [:type, :start, :end, :period]
+
+    fields :_cid, :data
+    actions :find
+
+    class << self
+      def find(check_id, metric_name, conditions)
+        check_conditions!(conditions)
+        convert_time!(conditions)
+        super("#{check_id}_#{metric_name}", conditions)
+      end
+
+      alias_method :search, :find
+
+      private
+
+      def check_conditions!(conditions)
+        REQUIRED_CONDITIONS.each do |condition|
+          fail "'#{condition}' is required" unless conditions.include?(condition)
+        end
+        fail "wrong 'type'" unless TYPES.include?(conditions[:type])
+        fail "wrong 'period'" unless PERIODS.include?(conditions[:period])
+      end
+
+      def convert_time!(conditions)
+        conditions[:start] = conditions[:start].to_i
+        conditions[:end] = conditions[:end].to_i
+      end
+    end
+  end
+end

data/lib/circonus/models/graph.rb

@@ -0,0 +1,8 @@
+module Circonus
+  class Graph < BaseModel
+    fields :_cid, :access_keys, :composites, :style, :description, :line_style,
+           :tags, :logarithmic_right_y, :logarithmic_left_y, :datapoints, :max_left_y,
+           :notes, :title, :max_right_y, :min_left_y, :guides, :metric_clusters, :min_right_y
+    actions :all, :find, :search, :create, :update, :destroy
+  end
+end

data/lib/circonus/models/maintenance.rb

@@ -0,0 +1,6 @@
+module Circonus
+  class Maintenance < BaseModel
+    fields :_cid, :severities, :stop, :item, :tags, :notes, :type, :start
+    actions :all, :find, :search, :create, :update, :destroy
+  end
+end

data/lib/circonus/models/metric_cluster.rb

@@ -0,0 +1,6 @@
+module Circonus
+  class MetricCluster < BaseModel
+    fields :_cid, :name, :queries, :description, :tags
+    actions :all, :find, :search, :create, :update, :destroy
+  end
+end

data/lib/circonus/models/rebuild_broker.rb

@@ -0,0 +1,10 @@
+module Circonus
+  class RebuildBroker < BaseModel
+    fields :_cid, :_cert, :rebuild, :csr
+    actions :all, :find, :search, :update
+
+    def self.all
+      raise UnsupportedAction
+    end
+  end
+end

data/lib/circonus/models/rule_set.rb

@@ -0,0 +1,6 @@
+module Circonus
+  class RuleSet < BaseModel
+    fields :_cid, :link, :parent, :metric_type, :rules, :check, :metric_name, :notes, :derive, :contact_groups
+    actions :all, :find, :search, :create, :update, :destroy
+  end
+end

data/lib/circonus/models/rule_set_group.rb

@@ -0,0 +1,6 @@
+module Circonus
+  class RuleSetGroup < BaseModel
+    fields :_cid, :formulas, :name, :contact_groups, :tags, :rule_set_conditions
+    actions :all, :find, :search, :create, :update, :destroy
+  end
+end

data/lib/circonus/models/tag.rb

@@ -0,0 +1,6 @@
+module Circonus
+  class Tag < BaseModel
+    fields :_cid
+    actions :all, :find, :search
+  end
+end

data/lib/circonus/models/template.rb

@@ -0,0 +1,7 @@
+module Circonus
+  class Template < BaseModel
+    fields :_cid, :hosts, :_last_modified_by, :status, :name, :sync_rules,
+           :tags, :master_host, :notes, :check_bundles, :_last_modified
+    actions :all, :find, :search, :create, :update, :destroy
+  end
+end

data/lib/circonus/models/user.rb

@@ -0,0 +1,6 @@
+module Circonus
+  class User < BaseModel
+    fields :_cid, :firstname, :lastname, :email, :contact_info
+    actions :all, :find, :search, :update
+  end
+end

data/lib/circonus/models/worksheet.rb

@@ -0,0 +1,6 @@
+module Circonus
+  class Worksheet < BaseModel
+    fields :_cid, :description, :tags, :graphs, :notes, :smart_queries, :title, :favorite
+    actions :all, :find, :search, :create, :update, :destroy
+  end
+end

data/lib/circonus/version.rb

@@ -0,0 +1,3 @@
+module Circonus
+  VERSION = '0.3.4'
+end

data/lib/circonus_api.rb

@@ -0,0 +1 @@
+require 'circonus'

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: circonus_api
+version: !ruby/object:Gem::Version
+  version: 0.3.4
+platform: ruby
+authors:
+- Anton Mishchuk
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-12-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Object Oriented mapper for Circonus API
+email: anton.mishchuk@opower.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.markdown
+- lib/circonus.rb
+- lib/circonus/client.rb
+- lib/circonus/exceptions.rb
+- lib/circonus/models.rb
+- lib/circonus/models/account.rb
+- lib/circonus/models/acknowledgement.rb
+- lib/circonus/models/actions.rb
+- lib/circonus/models/alert.rb
+- lib/circonus/models/annotation.rb
+- lib/circonus/models/base_model.rb
+- lib/circonus/models/broker.rb
+- lib/circonus/models/check.rb
+- lib/circonus/models/check_bundle.rb
+- lib/circonus/models/check_move.rb
+- lib/circonus/models/contact_group.rb
+- lib/circonus/models/data.rb
+- lib/circonus/models/graph.rb
+- lib/circonus/models/maintenance.rb
+- lib/circonus/models/metric_cluster.rb
+- lib/circonus/models/rebuild_broker.rb
+- lib/circonus/models/rule_set.rb
+- lib/circonus/models/rule_set_group.rb
+- lib/circonus/models/tag.rb
+- lib/circonus/models/template.rb
+- lib/circonus/models/user.rb
+- lib/circonus/models/worksheet.rb
+- lib/circonus/version.rb
+- lib/circonus_api.rb
+homepage: https://github.com/opower/circonus_api
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: Client for Circonus API
+test_files: []