vayacondios-client 0.1.2 → 0.1.6

data/lib/vayacondios-client.rb

@@ -16,5 +16,7 @@ require 'gorillib/string/constantize'
 require 'gorillib/string/inflections'
 
 require 'vayacondios/client/http_client'
+require 'vayacondios/client/cube_client'
+require 'vayacondios/client/zabbix_client'
 require 'vayacondios/client/notifier'
 require 'vayacondios/client/configliere'

data/lib/vayacondios/client/cube_client.rb

@@ -0,0 +1,39 @@
+class Vayacondios
+  class CubeClient
+    include Gorillib::Model
+
+    field :host,         String,  :default => 'localhost'
+    field :port,         Integer, :default => 6000
+    
+    class Error < StandardError; end
+
+    def uri
+      return @uri if @uri
+
+      uri_str  = "http://#{host}:#{port}/1.0"
+      @uri ||= URI(uri_str)
+    end
+    
+    def event(topic, document = {})
+      request(:post, File.join(uri.path, 'event'), MultiJson.dump(document))
+    end
+    
+  private
+    
+    def request(method, path, document=nil)
+      http    = Net::HTTP.new(uri.host, uri.port)
+
+      params  = [method.to_sym, path]
+      params += [document, {'Content-Type' => 'application/json'}] unless document.nil?
+      
+      response = http.send *params
+
+      if Net::HTTPSuccess === response
+        MultiJson.load(response.body) rescue response.body
+      else
+        raise Error.new("Error (#{response.code}) while #{method.to_s == 'get' ? 'fetching' : 'inserting'} document: " + response.body)
+      end
+    end
+  end
+end
+  

data/lib/vayacondios/client/itemset.rb

@@ -4,42 +4,29 @@ require 'multi_json'
 class Vayacondios
   class Client
     class ItemSet
-      def initialize host, port, organization, topic, id
-        @host = host
-        @port = port
-
-        @path = "/v1/#{organization}/itemset/#{topic}/#{id}"
+      def initialize host, port, organization=nil, topic=nil, id=nil
+        @host         = host
+        @port         = port
+        @organization = organization
+        @topic        = topic
+        @id           = id
       end
 
-      # Exposed for testing.
-      def _req type, ary = nil
-        case type
-        when :fetch  then
-          req = Net::HTTP::Get.new(@path)
-        when :create then
-          (req = Net::HTTP::Put.new(@path)).body = MultiJson.encode(ary)
-        when :update then
-          (req = Net::HTTP::Put.new(@path, {"x-method" => "PATCH"})).body = MultiJson.encode(ary)
-        when :remove then
-          (req = Net::HTTP::Delete.new(@path)).body = MultiJson.encode(ary)
-        end
-        req
+      def fetch organization=nil, topic=nil, id=nil
+        resp = execute_request(_req(:fetch, nil, organization, topic, id)) and
+          resp["contents"]
       end
 
-      def fetch
-        execute_request(_req(:fetch))
+      def update ary, organization=nil, topic=nil, id=nil
+        execute_request(_req(:update, ary, organization, topic, id))
       end
 
-      def update ary
-        execute_request(_req(:update, ary))
+      def create ary, organization=nil, topic=nil, id=nil
+        execute_request(_req(:create, ary, organization, topic, id))
       end
 
-      def create ary
-        execute_request(_req(:create, ary))
-      end
-
-      def remove ary
-        execute_request(_req(:remove, ary))
+      def remove ary, organization=nil, topic=nil, id=nil
+        execute_request(_req(:remove, ary, organization, topic, id))
       end
 
 
@@ -52,6 +39,34 @@ class Vayacondios
         result = MultiJson.decode(resp) unless resp.nil? or resp.empty?
         (result.respond_to?(:has_key?) and result.has_key? "error") ? nil : result
       end
+
+      def path organization, topic, id
+        if ((the_organization = (organization || @organization)).nil? ||
+            (the_topic        = (topic        || @topic       )).nil? ||
+            (the_id           = (id           || @id          )).nil?)
+          raise ArgumentError.new("must provide organization, topic, and id!")
+        end
+
+        ['/v1', the_organization, 'itemset', the_topic, the_id].join("/")
+      end
+
+      # This is the only private method that is tested.
+      def _req type, ary=nil, organization=nil, topic=nil, id=nil
+
+        the_path = path(organization, topic, id)
+        headers = {"content-type" => "application/json"}
+        headers.merge!("x-method" => "PATCH") if type == :update
+ 
+        case type
+        when :fetch  then Net::HTTP::Get
+        when :create then Net::HTTP::Put
+        when :update then Net::HTTP::Put
+        when :remove then Net::HTTP::Delete
+        else         raise ArgumentError.new("invalid type: #{type}")
+        end.new(the_path, headers).tap do |req|
+          req.body = MultiJson.encode(contents: ary) unless type == :fetch
+        end
+      end
     end
   end
 end

data/lib/vayacondios/client/notifier.rb

@@ -56,11 +56,34 @@ class Vayacondios
     end
   end
 
+  class CubeNotifier < Notifier
+    def initialize(options={})
+      @client = Vayacondios::CubeClient.receive(options)
+    end
+    def notify topic, cargo={}
+      prepped = prepare(cargo)
+      client.event(topic, prepped)
+      nil
+    end
+  end
+
+  class ZabbixNotifier < Notifier
+    def initialize options={}
+      @client = Vayacondios::ZabbixClient.receive(options)
+    end
+    def notify(topic, cargo={})
+      prepped = prepare(cargo)
+      client.insert(topic, prepped)
+    end
+  end
+  
   class NotifierFactory
     def self.receive(attrs = {})
       type = attrs[:type]
       case type
       when 'http'        then HttpNotifier.new(attrs)
+      when 'cube'        then CubeNotifier.new(attrs)
+      when 'zabbix'      then ZabbixNotifier.new(attrs)
       when 'log'         then LogNotifier.new(attrs)
       when 'none','null' then NullNotifier.new(attrs)
       else
@@ -80,7 +103,7 @@ class Vayacondios
     def self.included klass
       if klass.ancestors.include? Gorillib::Model
         klass.class_eval do
-          field :notifier, Vayacondios::NotifierFactory, default: Vayacondios.default_notifier
+          field :notifier, Vayacondios::NotifierFactory, default: Vayacondios.default_notifier, :doc => "Notifier used to notify out of band data"
           
           def receive_notifier params
             params.merge!(log: try(:log)) if params[:type] == 'log'

data/lib/vayacondios/client/zabbix_client.rb

@@ -0,0 +1,148 @@
+require 'socket'
+
+class Vayacondios
+
+  # Used for sending events to a Zabbix server.
+  #
+  # An 'event' from Vayacondios' perspective is an arbitrary Hash.
+  #
+  # An 'event' from Zabbix's perspective is a tuple of values:
+  #
+  # * time
+  # * host
+  # * key
+  # * value
+  #
+  # This client will accept a Vayacondios event and internally
+  # translate it into a set of Zabbix events.
+  #
+  # @example A CPU monitoring notification
+  #
+  #   notify "foo-server.example.com", cpu: {
+  #     util: {
+  #       user: 0.20,
+  #       idle: 0.70,
+  #       sys:  0.10
+  #     },
+  #     load: 1.3
+  #   }
+  #
+  # would get turned into the following events when written to Zabbix:
+  #
+  # @example The CPU monitoring notification translated to Zabbix events
+  #
+  # [
+  #   { host: "foo-server.example.com", key: "cpu.util.user", value: 0.20 }
+  #   { host: "foo-server.example.com", key: "cpu.util.idle", value: 0.70 },
+  #   { host: "foo-server.example.com", key: "cpu.util.sys",  value: 0.10 },
+  #   { host: "foo-server.example.com", key: "cpu.load",      value: 1.3  }
+  # ]
+  #
+  # Zabbix will interpret the time as the time it receives each event.
+  #
+  # The following links provide details on the protocol used by Zabbix
+  # to receive events:
+  #
+  # * https://www.zabbix.com/forum/showthread.php?t=20047&highlight=sender
+  # * https://gist.github.com/1170577
+  # * http://spin.atomicobject.com/2012/10/30/collecting-metrics-from-ruby-processes-using-zabbix-trappers/?utm_source=rubyflow&utm_medium=ao&utm_campaign=collecting-metrics-zabix
+  class ZabbixClient
+    include Gorillib::Builder
+
+    attr_accessor :socket
+
+    field :host, String,  :default => 'localhost', :doc => "Host for the Zabbix server"
+    field :port, Integer, :default => 10051,       :doc => "Port for the Zabbix server"
+
+    # Insert events to a Zabbix server.
+    #
+    # The `topic` will be used as the name of the Zabbix host to
+    # associate event data to.
+    #
+    # As per the documentation for the [Zabbix sender
+    # protocol](https://www.zabbix.com/wiki/doc/tech/proto/zabbixsenderprotocol),
+    # a new TCP connection will be created for each event.
+    #
+    # @param [String] topic
+    # @param [Hash] cargo
+    # Array<Hash>] text
+    def insert topic, cargo={}
+      self.socket = TCPSocket.new(host, port)
+      send_request(topic, cargo)
+      handle_response
+      self.socket.close
+    end
+
+    private
+
+    # :nodoc
+    def send_request topic, cargo
+      socket.write(payload(topic, cargo))
+    end
+
+    # :nodoc
+    def handle_response
+      header = socket.recv(5)
+      if header == "ZBXD\1"
+        data_header = socket.recv(8)
+        length      = data_header[0,4].unpack("i")[0]
+        response    = MultiJson.load(socket.recv(length))
+        puts response["info"]
+      else
+        puts "Invalid response: #{header}"
+      end
+    end
+
+    # :nodoc
+    def payload topic, cargo={}
+      body = body_for(topic, cargo)
+      header_for(body) + body
+    end
+
+    # :nodoc
+    def body_for topic, cargo={}
+      MultiJson.dump({request: "sender data", data: zabbix_events_from(topic, cargo) })
+    end
+
+    # :nodoc
+    def header_for body
+      length = body.bytesize
+      "ZBXD\1".encode("ascii") + [length].pack("i") + "\x00\x00\x00\x00"
+    end
+
+    # :nodoc
+    def zabbix_events_from topic, cargo, scope=''
+      events = []
+      case cargo
+      when Hash
+        cargo.each_pair do |key, value|
+          events += zabbix_events_from(topic, value, new_scope(scope, key))
+        end
+      when Array
+        cargo.each_with_index do |item, index|
+          events += zabbix_events_from(topic, item, new_scope(scope, index))
+        end
+      else
+        events << event_body(topic, scope, cargo)
+      end
+      events
+    end
+
+    # :nodoc
+    def new_scope(current_scope, new_scope)
+      [current_scope, new_scope].map(&:to_s).reject(&:empty?).join('.')
+    end
+
+    # :nodoc
+    def event_body topic, scope, cargo
+      value = case cargo
+      when Hash  then cargo[:value]
+      when Array then cargo.first
+      else cargo
+      end
+      { host: topic, key: scope, value: value }
+    end
+    
+  end
+end
+

data/spec/client/itemset_spec.rb

@@ -16,28 +16,28 @@ describe Vayacondios::Client::ItemSet do
     itemset = Vayacondios::Client::ItemSet.new("foohost", 9999, "fooorg", "footopic", "fooid")
     ary = ["foo", "bar", "baz"]
 
-    # Actually testing internals here to avoid 
+    # testing internals here to avoid shimming up HTTP libraries.
 
     it "generates a put request without a patch header when asked to create" do
-      req = itemset._req :create, ary
+      req = itemset.instance_eval{_req(:create, ary)}
 
       req.method.should eql('PUT')
-      req.body.should eql(ary.to_json)
+      req.body.should eql(MultiJson.encode(contents: ary))
       req.path.should eql('/v1/fooorg/itemset/footopic/fooid')
       req.each_header.to_a.should_not include(["x_method", "PATCH"])
     end
 
     it "generates a put request with a patch header when asked to update" do
-      req = itemset._req :update, ary
+      req = itemset.instance_eval{_req(:update, ary)}
 
       req.method.should eql('PUT')
-      req.body.should eql(ary.to_json)
+      req.body.should eql(MultiJson.encode(contents: ary))
       req.path.should eql('/v1/fooorg/itemset/footopic/fooid')
       req.each_header.to_a.should include(["x-method", "PATCH"])
     end
 
     it "generates a get request when asked to fetch" do
-      req = itemset._req :fetch
+      req = itemset.instance_eval{_req(:fetch)}
 
       req.method.should eql('GET')
       req.body.should be_nil
@@ -45,10 +45,10 @@ describe Vayacondios::Client::ItemSet do
     end
 
     it "generates a delete request when asked to remove" do
-      req = itemset._req :remove, ary
+      req = itemset.instance_eval{_req(:remove, ary)}
 
       req.method.should eql('DELETE')
-      req.body.should eql(ary.to_json)
+      req.body.should eql(MultiJson.encode(contents: ary))
       req.path.should eql('/v1/fooorg/itemset/footopic/fooid')
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vayacondios-client
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.6
   prerelease: 
 platform: ruby
 authors:
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-17 00:00:00.000000000 Z
+date: 2013-03-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: configliere
@@ -35,23 +35,23 @@ dependencies:
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: 1.3.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: 1.3.6
 - !ruby/object:Gem::Dependency
   name: gorillib
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: 0.4.2
   type: :runtime
@@ -59,7 +59,7 @@ dependencies:
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: 0.4.2
 - !ruby/object:Gem::Dependency
@@ -119,9 +119,11 @@ extra_rdoc_files: []
 files:
 - lib/vayacondios-client.rb
 - lib/vayacondios/client/configliere.rb
+- lib/vayacondios/client/cube_client.rb
 - lib/vayacondios/client/http_client.rb
 - lib/vayacondios/client/itemset.rb
 - lib/vayacondios/client/notifier.rb
+- lib/vayacondios/client/zabbix_client.rb
 - spec/client/itemset_spec.rb
 - spec/client/notifier_spec.rb
 homepage: https://github.com/infochimps-labs/vayacondios
@@ -138,7 +140,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2836890391198069767
+      hash: -1918215973120450598
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -147,10 +149,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2836890391198069767
+      hash: -1918215973120450598
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: Data goes in. The right thing happens