splunk-client 0.5.1

data/lib/splunk-client.rb

@@ -0,0 +1,93 @@
+# Author::        Christopher Brito (cbrito@gmail.com)
+# Original Repo:: https://github.com/cbrito/splunk-client
+
+require 'net/https'
+require 'cgi'
+require 'rubygems'
+require 'nokogiri'
+
+class SplunkJob
+  attr_reader :jobId
+  
+  def initialize(jobId, clientPointer)
+      @jobId  = jobId
+      @client = clientPointer #SplunkClient object pointer
+  end
+
+  def wait
+    wait_for_results
+  end
+  
+  def wait_for_results
+    # Wait for the Splunk search to complete
+  	while (@client.get_search_status(@jobId).to_i == 0)
+  	  sleep 2
+  	end
+  end
+  
+  def complete?
+    # Return status of job
+    @client.get_search_status(@jobId).to_i == 0
+  end
+  
+  def results(maxResults=0)
+    # Return search results
+    @client.get_search_results(@jobId, maxResults)
+  end
+  
+end #class SplunkJob
+
+class SplunkClient
+  
+  def initialize(username, password, host, port=8089)
+    @USER=username; @PASS=password; @HOST=host; @PORT=port
+    
+    @SESSION_KEY = { 'authorization' => "Splunk #{get_session_key}" }
+  end
+  
+  def create_search(search)
+    # Returns a SplunkJob 
+    xml = splunk_post_request("/services/search/jobs",
+                              "search=#{CGI::escape("search #{search}")}",
+                              @SESSION_KEY)
+
+    @doc = Nokogiri::Slop(xml)
+    
+    return SplunkJob.new(@doc.xpath("//sid").text, self)
+  end
+
+  def get_search_status(sid)
+    xml = splunk_get_request("/services/search/jobs/#{sid}")
+    @doc = Nokogiri::Slop(xml)
+    return @doc.xpath("//s:key[@name='isDone']").text
+  end
+
+  def get_search_results(sid, maxResults=0)
+    splunk_get_request("/services/search/jobs/#{sid}/results?count=#{maxResults}")
+  end
+  
+  private ###############################################################################
+  
+  def splunk_http_request
+    http = Net::HTTP.new(@HOST, @PORT)
+    http.use_ssl = true
+    http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+    return http
+  end
+  
+  def splunk_get_request(path)
+    splunk_http_request.get(path, @SESSION_KEY).body
+  end
+  
+  def splunk_post_request(path, data=nil, headers=nil)
+    splunk_http_request.post(path,data,headers).body
+  end
+
+  def get_session_key
+    xml = splunk_post_request("/services/auth/login",
+                              "username=#{@USER}&password=#{@PASS}")
+    @doc = Nokogiri::Slop(xml)
+    return @doc.xpath("//sessionKey").text
+  end
+  
+end #class SplunkClient

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification 
+name: splunk-client
+version: !ruby/object:Gem::Version 
+  hash: 9
+  prerelease: 
+  segments: 
+  - 0
+  - 5
+  - 1
+  version: 0.5.1
+platform: ruby
+authors: 
+- Christopher Brito
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-04-24 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: nokogiri
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+description: Simple Ruby library for interfacing with Splunk's REST API.
+email: cbrito@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/splunk-client.rb
+homepage: http://github.com/cbrito/splunk-client
+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: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: Ruby Library for interfacing with Splunk's REST API
+test_files: []
+