rsplunk 0.1.1 → 0.2.0

data/README.txt

@@ -6,10 +6,42 @@ This is a gem to facilitate Splunk searches and indexing.
 
 == SYNOPSIS:
 
-require 'splunk'
+require 'rsplunk'
 
-foo = Rsplunk::Auth.new('HOST', PORT)
-foo.token('email address', 'password')
+=== To create a Splunk instance
+foo = Rsplunk.set('HOST', PORT)
+=> "@host, @port"
+
+=== To create a Splunk session
+session = Rsplunk::Auth.new('username', 'password')
+=> #<Rsplunk::Auth:0x1080daf8 @pass="password", @user="username">
+
+Appending the 'session_token' method will give you your token:
+session.session_token
+=> "66f8ee2ab56a2e30d3a016f6b78e50ce"
+
+=== To view current query jobs:
+bar = Rsplunk::Search.new
+bar.query_jobs
+
+This will bring back a very unsexy XML package for you.
+
+'query_jobs' can take arguements to return certain XML parameters:
+
+For example:
+bar.query_jobs("name", "published", "title")
+
+will return the owner, published date, and query string for all current running jobs.
+
+=== To create a job:
+res = bar.create_job("Hello, World")
+=> "1334848433.7828"
+
+Where, "1334848433.7828" is the Search ID returned from the job.
+
+=== To list job results:
+bar.job_results(res)
+=> XML results
 
 == REQUIREMENTS:
 
@@ -20,8 +52,8 @@ Access to a working Splunk environment.
 gem install rsplunk
 
 == Upcoming Features:
-* As of now, receiving tokens is the only function
-* Full search capabilities are on the horizon
+* Provide a timeline for Search.  As of now, it sets to 'All Time'.
+* Credentials providing: delete a query
 
 == Contributing to rSplunk
 

data/Rakefile

@@ -12,7 +12,7 @@ require 'hoe'
 
 Hoe.spec 'rsplunk' do
 
-  developer('Ben Woodall', 'ben.woodall@theplatform.com')
+  developer('Ben Woodall', 'mail@benwoodall.com')
 
 end
 

data/lib/rsplunk/auth.rb

@@ -1,28 +1,28 @@
 module Rsplunk
 
   class Auth
-
-    def initialize(host, port)
-      @host = host
-      @port = port
+    # Create a Splunk session
+    def initialize(user, pass)
+      @user = user
+      @pass = pass
+      session_token
     end
 
-    attr_accessor :host, :port
-
-    # Initial SSL request
-    def splunk_ssl_request(path, data = nil, headers = nil)
-      http = Net::HTTP.new(@host, @port)
-      http.use_ssl = true
-      http.verify_mode = OpenSSL::SSL::VERIFY_NONE
-      http.post(path, data, headers).body
-    end
+    attr_accessor :user, :pass
 
     # Grab token with username and password
-    def token(user, pass)
-      doc = Hpricot(splunk_ssl_request("/services/auth/login", "username=#{user}&password=#{pass}"))
+    def create_token
+      doc = Hpricot(Rsplunk.splunk_ssl_post_request("/services/auth/login",
+                                                          "username=#{@user}&password=#{@pass}"))
       (doc/"//sessionkey").inner_html
     end
 
+    # Returns the session token
+
+    def session_token
+      $session_token = create_token
+    end
+
   end
 
 end

data/lib/rsplunk.rb

@@ -3,11 +3,45 @@ $:.unshift( File.dirname( __FILE__ ))
 require 'net/https'
 require 'rubygems'
 require 'hpricot'
+require 'json'
+require 'cgi'
 
 module Rsplunk
 
-  VERSION = '0.1.1'
+  VERSION = '0.2.0'
 
   require 'rsplunk/auth'
+  require 'rsplunk/search'
+
+  attr_accessor :host, :port
+
+  # Set the Splunk server instance.  Defaults to 'localhost:8089'
+  def self.set(host='localhost', port = 8089)
+    @host = host
+    @port = port
+    "#{@host}, #{@port}"
+  end
+
+  # Create an SSL POST
+  def self.splunk_ssl_post_request(path, data = nil, headers = nil)
+    http = Net::HTTP.new(@host, @port)
+    http.use_ssl = true
+    http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+    http.post(path, data, headers).body
+  end
+  # Create and SSL GET
+  def self.splunk_ssl_get_request(path, headers = nil)
+    http = Net::HTTP.new(@host, @port)
+    http.use_ssl = true
+    http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+    http.get(path, headers).body
+  end
+  # Create an SSL DELETE
+  def self.splunk_ssl_delete_request(path, headers = nil)
+  	http = Net::HTTP.new(@host, @port)
+  	http.use_ssl = true
+  	http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+  	http.delete(path, headers).body
+  end
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rsplunk
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-30 00:00:00.000000000 Z
+date: 2012-04-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rdoc
-  requirement: &72363840 !ruby/object:Gem::Requirement
+  requirement: &85809630 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: '3.10'
   type: :development
   prerelease: false
-  version_requirements: *72363840
+  version_requirements: *85809630
 - !ruby/object:Gem::Dependency
   name: hoe
-  requirement: &72363500 !ruby/object:Gem::Requirement
+  requirement: &85809360 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: '3.0'
   type: :development
   prerelease: false
-  version_requirements: *72363500
+  version_requirements: *85809360
 description: This is a gem to facilitate Splunk searches and indexing.
 email:
-- ben.woodall@theplatform.com
+- mail@benwoodall.com
 executables:
 - rsplunk
 extensions: []