splunk-client 0.6 → 0.6.1

data/README.md

@@ -2,6 +2,12 @@
 
 Ruby library for dealing with Splunk searches and results using the Splunk REST API.
 
+## Features
+
+* Session based authentication to Splunk REST interface
+* Create and check on the status of Splunk Jobs
+* Natural Ruby methods for interacting with search results (no need to parse XML or JSON or use Ruby Hashes)
+
 ## Installation
 
 	gem install splunk-client
@@ -10,7 +16,8 @@ Ruby library for dealing with Splunk searches and results using the Splunk REST
 
 Creating and using a client is easy:
 
-	require 'splunk-client.rb'
+	require 'rubygems' 
+	require 'splunk-client'
 
 	# Create the client
 	splunk = SplunkClient.new("username", "password", "hostname")
@@ -24,7 +31,7 @@ Creating and using a client is easy:
 	#Print the raw XML results 
 	puts search.results
 
-	#Print the time and host of each result
+	# Use ruby methods for dealing with results:
 	search.parsedResults.each do |result|
 		puts result.host + " : " + result.time
 	end
@@ -35,16 +42,22 @@ Creating and using a client is easy:
 
 * Looking for more or less results? Use `search.results(maxResults)` to control how much is returned. (A value of 0 returns all results (this is the default.))
 
-* Access Splunk fields in results via method calls 
-	`result = search.parsedResults`
-	`puts result[0].fieldName`
+* Access Splunk fields in results via simple method calls
+
+      `result = search.parsedResults`
+      `puts result[0].fieldName`
+
 
 ## Revision History
 
 #### 0.6
 * Added two new objects: SplunkResults and SplunkResult for to support:
 * Accessing Splunk fields via method calls
-    `search.parsedResults.each {|result| puts result.$$FIELD_NAME$$}`
+
+    
+      `search.parsedResults.each {|result| puts result.$$FIELD_NAME$$}`
+
+
 
 #### 0.5
 WARNING: Compatibility with prior versions will break as SplunkClient no longer returns a sid. It now returns a SplunkJob object.

data/VERSION

@@ -1 +1 @@
-0.6
+0.6.1

data/lib/splunk_client/splunk_result.rb

@@ -14,7 +14,7 @@ class SplunkResult
     @result.field("[@k=\"_time\"]").value.text
   end
 
-  # Ex: splunkResult.sourceIp => nokogiriNode.result.field("[@k=\"sourceIp\"]").value.text
+  # Ex: splunkResult.sourceIp => nokogiriNode.field("[@k=\"sourceIp\"]").value.text
   def method_missing(name, *args, &blk)
     if args.empty? && blk.nil? && @result.field("[@k=\"#{name}\"]")
       @result.field("[@k=\"#{name}\"]").value.text

data/lib/splunk_client/splunk_results.rb

@@ -20,7 +20,7 @@ class SplunkResults
       end
     else
       # Single results object
-      @results.push Splunkresults.new(nokoResults.results.result)
+      @results.push SplunkResult.new(nokoResults.results.result)
     end
     
     return @results

metadata

@@ -1,103 +1,102 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: splunk-client
-version: !ruby/object:Gem::Version
-  version: '0.6'
+version: !ruby/object:Gem::Version 
+  hash: 5
   prerelease: 
+  segments: 
+  - 0
+  - 6
+  - 1
+  version: 0.6.1
 platform: ruby
-authors:
+authors: 
 - Christopher Brito
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-19 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
+
+date: 2012-05-20 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
   name: nokogiri
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
   name: rake
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: simplecov-rcov
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: simplecov-rcov
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: json
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: json
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id005
 description: Simple Ruby library for interfacing with Splunk's REST API.
-email:
+email: 
 - cbrito@gmail.com
 executables: []
+
 extensions: []
+
 extra_rdoc_files: []
-files:
+
+files: 
 - lib/splunk-client.rb
 - lib/splunk_client/splunk_client.rb
 - lib/splunk_client/splunk_job.rb
@@ -112,28 +111,37 @@ files:
 - Gemfile.lock
 homepage: http://github.com/cbrito/splunk-client
 licenses: []
+
 post_install_message: 
 rdoc_options: []
-require_paths:
+
+require_paths: 
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement
+required_ruby_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
-required_rubygems_version: !ruby/object:Gem::Requirement
+  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
-      version: '0'
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
 requirements: []
+
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.15
 signing_key: 
 specification_version: 3
 summary: Ruby Library for interfacing with Splunk's REST API
-test_files:
+test_files: 
 - spec/spec_helper.rb
 - spec/splunk_client_spec.rb