splunker 0.0.2 → 0.0.3

data/VERSION

@@ -1 +1 @@
-0.0.2
+0.0.3

data/lib/splunker/models/finders.rb

@@ -19,14 +19,14 @@ module Splunker::Models
           end
       end
 
-      def find_all(options)
+      def find_all(options={})
         raise NotImplemented, "Not yet implemented!"
         self.client.get @service_path, options
       end
 
       def find_by_id(object_id, options={})
         object_path = "#{@service_path}/#{escape_object_id(object_id)}"
-        self.new(self.client.get(object_path))
+        self.new(self.client.get(object_path, options))
       end
     end
 

data/lib/splunker/models/resource.rb

@@ -3,6 +3,7 @@ module Splunker
     require 'cgi'
     require 'splunker/models/finders'
     require 'splunker/models/xml_processor'
+    require 'splunker/models/subresource'
 
     class Resource 
 
@@ -14,6 +15,10 @@ module Splunker
         @service_path = path
       end
 
+      def self.my_service_path
+        @service_path
+      end
+
       def self.client
         Splunker.client
       end

data/lib/splunker/models/search/history.rb

@@ -0,0 +1,7 @@
+module Splunker::Models
+  module Search 
+    class History < Splunker::Models::Resource
+      include Subresource
+    end
+  end
+end

data/lib/splunker/models/search/job.rb

@@ -2,7 +2,20 @@ module Splunker::Models
   module Search 
     class Job < Splunker::Models::Resource
       # http://docs.splunk.com/Documentation/Splunk/latest/RESTAPI/RESTsearch#search.2Fjobs.2F.7Bsearch_id.7D
-      service_path "jobs"
+      service_path "search/jobs"
+
+      def results
+        Results.find_as_subresource(Job.my_service_path, self.sid, "results")
+      end
+=begin BIG FAT TODO
+search/jobs/{search_id}/export
+search/jobs/{search_id}/control
+search/jobs/{search_id}/events
+search/jobs/{search_id}/results_preview
+search/jobs/{search_id}/search.log
+search/jobs/{search_id}/summary
+search/jobs/{search_id}/timeline
+=end
     end
   end
 end

data/lib/splunker/models/search/results.rb

@@ -0,0 +1,7 @@
+module Splunker::Models
+  module Search 
+    class Results < Splunker::Models::Resource
+      include Subresource
+    end
+  end
+end

data/lib/splunker/models/search/saved.rb

@@ -4,10 +4,13 @@ module Splunker::Models
       # http://docs.splunk.com/Documentation/Splunk/4.3.4/RESTAPI/RESTsearch#saved.2Fsearches.2F.7Bname.7D
       service_path "saved/searches"
 
+      def history
+        History.find_as_subresource(Saved.my_service_path, self.title, "history")
+      end
+
 =begin Can these actions be standardized?
       def acknowledge; end
       def dispatch; end
-      def history; end
       def scheduled_times; end
       def suppress; end
 =end

data/lib/splunker/models/subresource.rb

@@ -0,0 +1,26 @@
+module Splunker::Models
+  module Subresource
+    module ClassMethods
+      def find_as_subresource(service_path, object_id, subresource, options={})
+        object_path = "#{service_path}/#{escape_object_id(object_id)}/#{subresource}"
+        self.new(self.client.get(object_path, options))
+      end
+
+      def where(options={})
+        raise NoMethodError, "Finders not available for subresources."
+      end
+
+      def find_all(options={})
+        raise NoMethodError, "Finders not available for subresources."
+      end
+
+      def find_by_id(object_id, options={})
+        raise NoMethodError, "Finders not available for subresources."
+      end
+    end
+
+    def self.included(base)
+      base.send(:extend, ClassMethods)
+    end
+  end
+end

data/lib/splunker/models/xml_processor.rb

@@ -25,6 +25,25 @@ module Splunker
         hash
       end
 
+      def process_results(hash, node)
+        # TODO: Process meta. Ugh.
+        hash["meta"] = Array(node.xpath("./meta").children)
+
+        # Process results, yay.
+        hash["results"] = []
+
+        node.xpath("./result").each do |r|
+          result = {}
+          r.xpath("./field").each do |f|
+            next unless f.attributes.include?("k")
+            result[f.attribute("k").value] = f.text.strip
+          end
+          hash["results"] << result
+        end
+
+        hash
+      end
+
       def process_text(hash, node)
         hash
       end

data/spec/fixtures/saved_history.xml

@@ -0,0 +1,94 @@
+<?xml-stylesheet type="text/xml" href="/static/atom.xsl"?>
+<feed xmlns="http://www.w3.org/2005/Atom" xmlns:s="http://dev.splunk.com/ns/rest" xmlns:opensearch="http://a9.com/-/spec/opensearch/1.1/">
+  <title>50msclub</title>
+  <id>https://localhost:8089/servicesNS/wade/search/saved/searches</id>
+  <updated>2012-10-10T14:19:50-05:00</updated>
+  <generator version="128297"/>
+  <author>
+    <name>Splunk</name>
+  </author>
+  <link href="/servicesNS/wade/search/saved/searches/_new" rel="create"/>
+  <link href="/servicesNS/wade/search/saved/searches/_reload" rel="_reload"/>
+  <opensearch:totalResults>3</opensearch:totalResults>
+  <opensearch:itemsPerPage>30</opensearch:itemsPerPage>
+  <opensearch:startIndex>0</opensearch:startIndex>
+  <s:messages/>
+  <entry>
+    <title>scheduler__wade__search__50msclub_at_1349896500_9be96fb18ff7bb9a</title>
+    <id>https://localhost:8089/servicesNS/nobody/search/search/jobs/scheduler__wade__search__50msclub_at_1349896500_9be96fb18ff7bb9a</id>
+    <updated>2012-10-10T14:15:40-05:00</updated>
+    <link href="/servicesNS/nobody/search/search/jobs/scheduler__wade__search__50msclub_at_1349896500_9be96fb18ff7bb9a" rel="alternate"/>
+    <author>
+      <name>wade</name>
+    </author>
+    <published>2012-10-10T14:15:00-05:00</published>
+    <link href="/servicesNS/nobody/search/search/jobs/scheduler__wade__search__50msclub_at_1349896500_9be96fb18ff7bb9a" rel="list"/>
+    <link href="/servicesNS/nobody/search/search/jobs/scheduler__wade__search__50msclub_at_1349896500_9be96fb18ff7bb9a/_reload" rel="_reload"/>
+    <link href="/servicesNS/nobody/search/search/jobs/scheduler__wade__search__50msclub_at_1349896500_9be96fb18ff7bb9a" rel="edit"/>
+    <link href="/servicesNS/nobody/search/search/jobs/scheduler__wade__search__50msclub_at_1349896500_9be96fb18ff7bb9a" rel="remove"/>
+    <content type="text/xml">
+      <s:dict>
+        <s:key name="eai:acl"><s:dict><s:key name="app">search</s:key><s:key name="can_change_perms">1</s:key><s:key name="can_list">1</s:key><s:key name="can_share_app">1</s:key><s:key name="can_share_global">0</s:key><s:key name="can_share_user">1</s:key><s:key name="can_write">1</s:key><s:key name="modifiable">1</s:key><s:key name="owner">wade</s:key><s:key name="perms"><s:dict><s:key name="read"><s:list><s:item>wade</s:item></s:list></s:key><s:key name="write"><s:list><s:item>wade</s:item></s:list></s:key></s:dict></s:key><s:key name="removable">0</s:key><s:key name="sharing">system</s:key></s:dict></s:key>
+        <s:key name="isDone">1</s:key>
+        <s:key name="isFinalized">0</s:key>
+        <s:key name="isRealTimeSearch">0</s:key>
+        <s:key name="isSaved">0</s:key>
+        <s:key name="isScheduled">1</s:key>
+        <s:key name="isZombie">0</s:key>
+        <s:key name="ttl">321</s:key>
+      </s:dict>
+    </content>
+  </entry>
+  <entry>
+    <title>scheduler__wade__search__50msclub_at_1349896200_1e5173a9ac1371bc</title>
+    <id>https://localhost:8089/servicesNS/nobody/search/search/jobs/scheduler__wade__search__50msclub_at_1349896200_1e5173a9ac1371bc</id>
+    <updated>2012-10-10T14:10:37-05:00</updated>
+    <link href="/servicesNS/nobody/search/search/jobs/scheduler__wade__search__50msclub_at_1349896200_1e5173a9ac1371bc" rel="alternate"/>
+    <author>
+      <name>wade</name>
+    </author>
+    <published>2012-10-10T14:10:13-05:00</published>
+    <link href="/servicesNS/nobody/search/search/jobs/scheduler__wade__search__50msclub_at_1349896200_1e5173a9ac1371bc" rel="list"/>
+    <link href="/servicesNS/nobody/search/search/jobs/scheduler__wade__search__50msclub_at_1349896200_1e5173a9ac1371bc/_reload" rel="_reload"/>
+    <link href="/servicesNS/nobody/search/search/jobs/scheduler__wade__search__50msclub_at_1349896200_1e5173a9ac1371bc" rel="edit"/>
+    <link href="/servicesNS/nobody/search/search/jobs/scheduler__wade__search__50msclub_at_1349896200_1e5173a9ac1371bc" rel="remove"/>
+    <content type="text/xml">
+      <s:dict>
+        <s:key name="eai:acl"><s:dict><s:key name="app">search</s:key><s:key name="can_change_perms">1</s:key><s:key name="can_list">1</s:key><s:key name="can_share_app">1</s:key><s:key name="can_share_global">0</s:key><s:key name="can_share_user">1</s:key><s:key name="can_write">1</s:key><s:key name="modifiable">1</s:key><s:key name="owner">wade</s:key><s:key name="perms"><s:dict><s:key name="read"><s:list><s:item>wade</s:item></s:list></s:key><s:key name="write"><s:list><s:item>wade</s:item></s:list></s:key></s:dict></s:key><s:key name="removable">0</s:key><s:key name="sharing">system</s:key></s:dict></s:key>
+        <s:key name="isDone">1</s:key>
+        <s:key name="isFinalized">0</s:key>
+        <s:key name="isRealTimeSearch">0</s:key>
+        <s:key name="isSaved">0</s:key>
+        <s:key name="isScheduled">1</s:key>
+        <s:key name="isZombie">0</s:key>
+        <s:key name="ttl">34</s:key>
+      </s:dict>
+    </content>
+  </entry>
+  <entry>
+    <title>scheduler__wade__search__50msclub_at_1349890200_9c17278833a16531</title>
+    <id>https://localhost:8089/servicesNS/nobody/search/search/jobs/scheduler__wade__search__50msclub_at_1349890200_9c17278833a16531</id>
+    <updated>2012-10-10T12:30:51-05:00</updated>
+    <link href="/servicesNS/nobody/search/search/jobs/scheduler__wade__search__50msclub_at_1349890200_9c17278833a16531" rel="alternate"/>
+    <author>
+      <name>wade</name>
+    </author>
+    <published>2012-10-10T12:30:32-05:00</published>
+    <link href="/servicesNS/nobody/search/search/jobs/scheduler__wade__search__50msclub_at_1349890200_9c17278833a16531" rel="list"/>
+    <link href="/servicesNS/nobody/search/search/jobs/scheduler__wade__search__50msclub_at_1349890200_9c17278833a16531/_reload" rel="_reload"/>
+    <link href="/servicesNS/nobody/search/search/jobs/scheduler__wade__search__50msclub_at_1349890200_9c17278833a16531" rel="edit"/>
+    <link href="/servicesNS/nobody/search/search/jobs/scheduler__wade__search__50msclub_at_1349890200_9c17278833a16531" rel="remove"/>
+    <content type="text/xml">
+      <s:dict>
+        <s:key name="eai:acl"><s:dict><s:key name="app">search</s:key><s:key name="can_change_perms">1</s:key><s:key name="can_list">1</s:key><s:key name="can_share_app">1</s:key><s:key name="can_share_global">0</s:key><s:key name="can_share_user">1</s:key><s:key name="can_write">1</s:key><s:key name="modifiable">1</s:key><s:key name="owner">wade</s:key><s:key name="perms"><s:dict><s:key name="read"><s:list><s:item>wade</s:item></s:list></s:key><s:key name="write"><s:list><s:item>wade</s:item></s:list></s:key></s:dict></s:key><s:key name="removable">0</s:key><s:key name="sharing">system</s:key></s:dict></s:key>
+        <s:key name="isDone">1</s:key>
+        <s:key name="isFinalized">0</s:key>
+        <s:key name="isRealTimeSearch">0</s:key>
+        <s:key name="isSaved">0</s:key>
+        <s:key name="isScheduled">1</s:key>
+        <s:key name="isZombie">0</s:key>
+        <s:key name="ttl">79853</s:key>
+      </s:dict>
+    </content>
+  </entry>
+</feed>

data/spec/unit/models/finders_spec.rb

@@ -11,17 +11,17 @@ describe Splunker::Models::Finders do
 
   before(:each) do
     object_path = "saved/searches/MyFinderTestSavedSearch"
-    resource.client.stub(:get).with(object_path).and_return(search_fixture)
+    resource.client.stub(:get).with(object_path,{}).and_return(search_fixture)
   end
 
   it "should find_by_id" do
-    a = resource.find_by_id("MyFinderTestSavedSearch")
+    a = resource.find_by_id("MyFinderTestSavedSearch", {})
     a.should be_a(Splunker::Models::Search::Saved)
     a.title.should eq("MySavedSearch")
   end
 
   it "should find by id by default" do
-    a = resource.find("MyFinderTestSavedSearch")
+    a = resource.find("MyFinderTestSavedSearch", {})
     a.should be_a(Splunker::Models::Search::Saved)
     a.title.should eq("MySavedSearch")
   end

data/spec/unit/models/search/history_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe Splunker::Models::Search::History do
+  
+  let(:resource_fixture) do
+    Nokogiri::XML(fixture("saved_history.xml"))
+  end
+
+  context "initialization" do
+    let(:history) do
+      Splunker::Models::Search::History.new(resource_fixture)
+    end
+
+    it "should load history" do
+      history.title.should eq("scheduler__wade__search__50msclub_at_1349890200_9c17278833a16531")
+      history.published.should eq("2012-10-10T12:30:32-05:00")
+    end
+  end
+end

data/spec/unit/models/search/job_spec.rb

@@ -9,17 +9,54 @@ describe Splunker::Models::Search::Job do
     Nokogiri::XML(fixture("job_mysearch.xml"))
   end
 
+  let(:job) do
+    resource.new(job_fixture)
+  end
+
   # Covered in finders_spec, but I'm feeling redundant this morning. 
   context "searching" do
     before(:each) do
-      object_path = "jobs/MyFinderTestJob"
-      resource.client.stub(:get).with(object_path).and_return(job_fixture)
+      object_path = "search/jobs/MyFinderTestJob"
+      resource.client.stub(:get).with(object_path, {}).and_return(job_fixture)
     end
 
     it "should find by id by default" do
-      a = resource.find("MyFinderTestJob")
+      a = resource.find("MyFinderTestJob", {})
       a.should be_a(Splunker::Models::Search::Job)
       a.title.should eq("search index")
     end
   end
+
+  context "loads sid" do
+    let(:job) do
+      resource.new(job_fixture)
+    end
+
+    it "should have an sid" do
+      job.sid.should eq("mysearch")
+    end
+  end
+
+  context "subresources" do
+    let(:results_resource) do
+      Splunker::Models::Search::Results
+    end
+
+    let(:results_job_fixture) do
+      Nokogiri::XML(fixture("search_results_from_job.xml"))
+    end
+
+
+    before(:each) do
+      object_path = "search/jobs/mysearch/results"
+      resource.client.stub(:get).with(object_path, {}).and_return(results_job_fixture)
+    end
+
+    it "should load results" do
+      r = job.results
+      r.should be_a(Splunker::Models::Search::Results)
+      r.meta.should_not be_nil
+      r.results.first["median(time_total)"].should eq("280")
+    end
+  end
 end

data/spec/unit/models/search/results_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+describe Splunker::Models::Search::Job do
+  let(:resource) do
+    Splunker::Models::Search::Results
+  end
+
+  let(:job_fixture) do
+    Nokogiri::XML(fixture("search_results_from_job.xml"))
+  end
+
+  context "initialization" do
+    let(:results) do
+      resource.new(job_fixture)
+    end
+
+    it "should load top level attributes" do
+      results.meta.should_not be_nil
+      results.results.first["median(time_total)"].should eq("280")
+    end
+  end
+end

data/spec/unit/models/subresource_spec.rb

@@ -0,0 +1,47 @@
+require 'spec_helper'
+
+describe Splunker::Models::Finders do
+  let(:resource) do
+    Splunker::Models::Search::Results
+  end
+
+  let(:search_fixture) do
+    Nokogiri::XML(fixture("search_results_from_job.xml"))
+  end
+
+  before(:each) do
+    object_path = "search/jobs/myjob/results"
+    resource.client.stub(:get).with(object_path, {}).and_return(search_fixture)
+  end
+
+  context "retrieval" do
+    it "should retrieve the subresource data" do
+      r = resource.find_as_subresource("search/jobs", "myjob", "results", {})
+      r.should be_a(Splunker::Models::Search::Results)
+    end
+  end
+
+  context "finders" do
+    it "should not allow the where method" do
+      expect {
+        resource.where(:me => "you")
+      }.to raise_error(NoMethodError)
+    end
+    it "should not allow the find method" do
+      expect {
+        resource.find(:all)
+      }.to raise_error(NoMethodError)
+    end
+    it "should not allow the find_all method" do
+      expect {
+        resource.find_all
+      }.to raise_error(NoMethodError)
+    end
+    it "should not allow the find_by_id method" do
+      expect {
+        resource.find_by_id "my_resource"
+      }.to raise_error(NoMethodError)
+    end
+  end
+end
+

data/spec/unit/models/xml_processor_spec.rb

@@ -7,7 +7,11 @@ describe Splunker::Models::XmlProcessor do
   end
 
   let(:xml) do
-    Nokogiri::Slop(fixture("saved_search.xml"))
+    Nokogiri::XML(fixture("saved_search.xml"))
+  end
+
+  let(:results_xml) do
+    Nokogiri::XML(fixture("search_results_from_job.xml"))
   end
 
   context "hashify xml" do
@@ -44,6 +48,20 @@ describe Splunker::Models::XmlProcessor do
     end
   end
 
+  context "process results xml" do
+    let(:results) do
+      processor.hashify(results_xml)
+    end
+
+    it "should load meta as a top level attribute" do
+      results["meta"].should_not be_nil
+    end
+
+    it "should load results, with key-value pairs" do
+      results["results"].first["avg(time_total)"].should eq("626.604469")
+    end
+  end
+
   context "dictionary builders" do
     it "should build a nested hash from a string in dot notation" do
       h = {

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: splunker
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-24 00:00:00.000000000 Z
+date: 2012-10-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -135,13 +135,17 @@ files:
 - lib/splunker/models.rb
 - lib/splunker/models/finders.rb
 - lib/splunker/models/resource.rb
+- lib/splunker/models/search/history.rb
 - lib/splunker/models/search/job.rb
+- lib/splunker/models/search/results.rb
 - lib/splunker/models/search/saved.rb
+- lib/splunker/models/subresource.rb
 - lib/splunker/models/xml_processor.rb
 - lib/splunker/request.rb
 - lib/splunker/version.rb
 - script/console
 - spec/fixtures/job_mysearch.xml
+- spec/fixtures/saved_history.xml
 - spec/fixtures/saved_search.xml
 - spec/fixtures/search_results_from_job.xml
 - spec/functional/request_spec.rb
@@ -154,8 +158,11 @@ files:
 - spec/unit/errors_spec.rb
 - spec/unit/models/finders_spec.rb
 - spec/unit/models/resource_spec.rb
+- spec/unit/models/search/history_spec.rb
 - spec/unit/models/search/job_spec.rb
+- spec/unit/models/search/results_spec.rb
 - spec/unit/models/search/saved_spec.rb
+- spec/unit/models/subresource_spec.rb
 - spec/unit/models/xml_processor_spec.rb
 - spec/unit/request_spec.rb
 - spec/unit/splunker_spec.rb
@@ -186,6 +193,7 @@ specification_version: 3
 summary: A Ruby client for the Splunk API
 test_files:
 - spec/fixtures/job_mysearch.xml
+- spec/fixtures/saved_history.xml
 - spec/fixtures/saved_search.xml
 - spec/fixtures/search_results_from_job.xml
 - spec/functional/request_spec.rb
@@ -198,8 +206,11 @@ test_files:
 - spec/unit/errors_spec.rb
 - spec/unit/models/finders_spec.rb
 - spec/unit/models/resource_spec.rb
+- spec/unit/models/search/history_spec.rb
 - spec/unit/models/search/job_spec.rb
+- spec/unit/models/search/results_spec.rb
 - spec/unit/models/search/saved_spec.rb
+- spec/unit/models/subresource_spec.rb
 - spec/unit/models/xml_processor_spec.rb
 - spec/unit/request_spec.rb
 - spec/unit/splunker_spec.rb