splunk-sdk-ruby 1.0.0 → 1.0.1

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    YjJkNTU1NjU0YzMzMWNlMzIzMWYxMjI3OTkzNjMxODkzOTM4Nzk1Mw==
+    ZDYzOTEzMWYzOGMyOWRhOTA1ZjdlZmRmMGVhYTJhNGMwMTFiZDI2Mg==
   data.tar.gz: !binary |-
-    OWQ4MTk2YTNlYTlmYmJiYjFjZDQ5ZjAyZDBmNTI1MTkxN2RjNmJkOQ==
+    YTBmMWNkMDM3YmMwYjQyY2E1ODM1NjRjYTM1NGNiM2YwOTIzZDhhOA==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    NjcyMDg0MWFiZGFkYzkyNDU0MWMzZDNkZWE4YzA0YmUxOTgyM2Q4NzNiZGZh
-    NjVhOWMwY2FmMWI5NWRlNGI1NGFlNzQ0MDQ1NzhkNTQ1ZmY2N2I5YWEzZjVj
-    YjJkMjhmNjQ4Zjc1MTk1OWFhYjI1ZjhkNDY1YTVhMjZiNjdkODc=
+    MmNhZGUwMDdkYTBjM2U3NGQyYTRmMzEyNDUxZDZjYjNkYjU0ZmFiZTgyYTRk
+    Y2YwZjk0ZmJmOTQ2M2JjYTgyYWJmNjE4NTg1MTIzYWIwMGQ0YmY4YjFmOWU0
+    MWI2ZDRkMjMzMDUxNWE0MGQwY2M0ZTcyMzI5ZmE1MzIwZGE4NTM=
   data.tar.gz: !binary |-
-    N2FkYWVkNDYxYWYwZTllMTcwY2Q1MWQ0MjllMDM1YWI0MDU0NzA5OTgyMmFm
-    ZDU0YTRiYmFiNjRkNDg3YzQ1NTE0NDY4Mzk5ZjgwOTk4ZGUyZDlhNTI4YmQ5
-    ZWMyNWFmYTAyNjJkZmQ0Y2VhZGExN2Y2YTY1MGZiYTYzMjEwNDY=
+    ZDc5MmZiZGI2NTNmZjM5YzRiMThhNjY4MWFiM2Q1Yjc1ZTEyM2Q5MTQ1ZGJh
+    MjQxZjU1NTkxOTkyYTk5ZWJmYWM0Y2E3ZDA5NDkwNmZjNzYzMTRjZGQxMTc4
+    ZDdmZDFkZWY0MmE3OTA3NWMwZmViNmFmOWU1OWNkMDNkMjc5NDg=

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Splunk SDK for Ruby Changelog
 
+## Version 1.0.1
+
+* Fixed Job#results to properly handle arguments.
+	
 ## Version 1.0
 
 * No bugs found during beta period.

data/README.md

@@ -1,6 +1,6 @@
-# The Splunk Software Development Kit for Ruby (Beta Release)
+# The Splunk Software Development Kit for Ruby
 
-#### Version 1.0
+#### Version 1.0.1
 This Splunk Software Development Kit (SDK) for Ruby contains library code and 
 examples designed to enable developers to build applications using Splunk.
 
@@ -281,11 +281,26 @@ If you would like to contribute to the SDK, go here for more information:
 
 ### Support
 
-* SDKs in Preview are not Splunk supported. Once the Splunk SDK for Ruby moves to 
-an open beta we will provide more detail on support.
-
-* File any issues on 
-   [GitHub](https://github.com/splunk/splunk-sdk-ruby/issues).
+1. You will be granted support if you or your company are already covered 
+   under an existing maintenance/support agreement. Visit 
+   <http://www.splunk.com/support> and click **Submit a Case** under **Contact
+   a Support Engineer**.
+
+2. If you are not covered under an existing maintenance/support agreement, you 
+   can find help through the broader community at:
+
+   <ul>
+   <li><a href='http://splunk-base.splunk.com/answers/'>Splunk Answers</a> (use
+    the <b>sdk</b> and <b>ruby</b> tags to identify your questions)</li>
+   <li><a href='http://groups.google.com/group/splunkdev'>Splunkdev Google 
+    Group</a></li>
+   </ul>
+3. Splunk will NOT provide support for SDKs if the core library (the 
+   code in the <b>lib</b> directory) has been modified. If you modify an SDK
+   and want support, you can find help through the broader community and Splunk 
+   answers (see above). We would also like to know why you modified the core 
+   library&mdash;please send feedback to _devinfo@splunk.com_.
+4. File any issues on [GitHub](https://github.com/splunk/splunk-sdk-ruby/issues).
 
 ### Contact Us
 

data/examples/run_examples.rb

@@ -0,0 +1,124 @@
+#--
+# Copyright 2011-2012 Splunk, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"): you may
+# not use this file except in compliance with the License. You may obtain
+# a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+# License for the specific language governing permissions and limitations
+# under the License.
+#++
+
+# This script runs all the examples shipped with the SDK, one after another,
+# editing their source on the fly to set the correct login parameters for
+# your Splunk instance.
+#
+# You can specify the host and credentials to use on the command line, as in
+#
+#     $ ruby run_example.rb --host localhost --port 8089 
+#           --username admin --password changeme
+#
+# Any of these may be omitted. The values shown above are the defaults.
+
+require 'optparse'
+
+def main(argv)
+  credentials = {
+    :host => "localhost",
+    :port => 8089,
+    :username => "admin",
+    :password => "changeme",
+  }
+  
+  parser = OptionParser.new do |op|
+    op.on("--host HOSTNAME", String, "Set Splunk host (default: localhost)") do |s|
+      credentials[:host] = s
+    end
+
+    op.on("--port PORT", Integer, "Set Splunk port (default: 8089)") do |p|
+      credentials[:port] = p
+    end
+
+    op.on("--username USERNAME", String, "Set username for login (default: admin)") do |s|
+      credentials[:username] = s
+    end
+
+    op.on("--password PASSWORD", String, "Set password for login (default: changeme)") do |s|
+      credentials[:password] = s
+    end
+  end
+
+  parser.parse!(argv)
+
+  # The examples are all named as 1_something.rb, 2_something.rb in the same
+  # directory as this script.
+  example_path = File.dirname(File.expand_path(__FILE__))
+  example_files = Dir.entries(example_path).
+    select() {|s| s.match('^\\d_.+\\.rb')}.
+    map() {|s| File.join(example_path, s)}
+
+  # Add the path to the Splunk SDK for Ruby.
+  $LOAD_PATH.push(File.join(File.dirname(example_path), "lib"))
+
+  # Run 
+  example_files.each do |p|
+    run_example(p, credentials)
+  end
+end
+
+
+module Kernel
+  require 'stringio'
+
+  def eval_stdout
+    out = StringIO.new
+    err = StringIO.new
+    $stdout = out
+    $stderr = err
+    yield
+    return [out.string, err.string]
+  ensure
+    $stdout = STDOUT
+    $stderr = STDERR
+  end
+end
+
+def run_example(abspath, credentials)
+    handle = File.open(abspath)
+    contents = handle.read()
+    handle.close()
+
+    credentials.each_pair do |key, value|
+      contents.gsub!(Regexp.new(key.inspect + "\s*=>\s*[^,\\n]+"),
+                     key.inspect + " => " + value.inspect)
+    end
+ 
+    begin
+      output = eval_stdout do
+        eval(contents)
+      end
+      puts "SUCCESS: " + abspath
+      puts "  stdout was:"
+      puts output[0].lines.map() {|s| "    " + s}.join("")
+      if output[1] != ""
+        puts "  stderr was:"
+        puts output[1].lines.map() {|s| "    " + s}.join("")
+      end
+      puts
+    rescue Exception => e
+      puts "FAILURE: " + abspath
+      puts "  using credentials " + credentials.to_s
+      puts "  Error was:"
+      puts e.to_s.lines.map() {|s| "    " + s}.join("")
+      puts
+    end
+end
+
+if __FILE__ == $0
+  main(ARGV)
+end

data/examples/run_examples.rb~

@@ -0,0 +1,22 @@
+#--
+# Copyright 2011-2012 Splunk, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"): you may
+# not use this file except in compliance with the License. You may obtain
+# a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+# License for the specific language governing permissions and limitations
+# under the License.
+#++
+
+# This script runs all the examples shipped with the SDK, one after another,
+# editing their source on the fly to set the correct login parameters for
+# your Splunk instance. It pauses between each to ask if this was correct.
+
+example_path = File.dirname(File.expand_path(__FILE__))
+example_files = Dir.entries(example_path).filter() {|s| s.match('^\\d_')}

data/lib/splunk-sdk-ruby/entity/job.rb

@@ -219,7 +219,7 @@ module Splunk
     #
     def results(args={})
       response = @service.request(:resource => @resource + [sid, "results"],
-                                  :body => args)
+                                  :query => args)
       return response.body
     end
 

data/lib/splunk-sdk-ruby/version.rb

@@ -23,5 +23,5 @@
 # release new versions.
 #
 module Splunk
-  VERSION = '1.0.0'
+  VERSION = '1.0.1'
 end

data/splunk-sdk-ruby.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |gem|
   gem.name          = 'splunk-sdk-ruby'
-  gem.version       = '1.0.0'
+  gem.version       = '1.0.1'
 
   gem.authors       = ['Splunk']
   gem.email         = ['devinfo@splunk.com']

data/test/test_jobs.rb

@@ -270,6 +270,39 @@ class JobsTestCase < TestCaseWithSplunkConnection
       sleep(4)
     end
   end
+
+  ##
+  # Splunk by default returns 100 events in a call to results or preview.
+  # We need to make sure overriding this with count works.
+  #
+  def test_search_with_many_results
+    internal = @service.indexes.fetch("_internal")
+    internal.refresh()
+    if internal.fetch("totalEventCount").to_i < 150
+      fail("Need at 150 events in index _internal for this test.")
+    end
+
+    job = @service.jobs.create("search index=_internal | head 150")
+    while !job.is_done?()
+      sleep(0.1)
+    end
+
+    stream = job.results(:count => 0)
+    results = Splunk::ResultsReader.new(stream)
+    count = 0
+    results.each do |event|
+      count += 1
+    end
+    assert_equal(150, count)
+
+    stream = job.preview(:count => 0)
+    results = Splunk::ResultsReader.new(stream)
+    count = 0
+    results.each do |event|
+      count += 1
+    end
+    assert_equal(150, count)
+  end
 end
 
 class LongJobTestCase < JobsTestCase

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: splunk-sdk-ruby
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Splunk
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-03 00:00:00.000000000 Z
+date: 2013-05-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -45,86 +45,88 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/splunk-sdk-ruby/ambiguous_entity_reference.rb
 - lib/splunk-sdk-ruby/atomfeed.rb
-- lib/splunk-sdk-ruby/collection/apps.rb
-- lib/splunk-sdk-ruby/collection/case_insensitive_collection.rb
-- lib/splunk-sdk-ruby/collection/configuration_file.rb
-- lib/splunk-sdk-ruby/collection/configurations.rb
-- lib/splunk-sdk-ruby/collection/input_kinds.rb
-- lib/splunk-sdk-ruby/collection/jobs.rb
-- lib/splunk-sdk-ruby/collection/messages.rb
-- lib/splunk-sdk-ruby/collection.rb
 - lib/splunk-sdk-ruby/context.rb
-- lib/splunk-sdk-ruby/entity/index.rb
-- lib/splunk-sdk-ruby/entity/job.rb
-- lib/splunk-sdk-ruby/entity/message.rb
-- lib/splunk-sdk-ruby/entity/modular_input_kind.rb
-- lib/splunk-sdk-ruby/entity/saved_search.rb
-- lib/splunk-sdk-ruby/entity/stanza.rb
-- lib/splunk-sdk-ruby/entity.rb
-- lib/splunk-sdk-ruby/entity_not_ready.rb
+- lib/splunk-sdk-ruby/service.rb
 - lib/splunk-sdk-ruby/illegal_operation.rb
+- lib/splunk-sdk-ruby/version.rb
 - lib/splunk-sdk-ruby/namespace.rb
-- lib/splunk-sdk-ruby/resultsreader.rb
-- lib/splunk-sdk-ruby/service.rb
+- lib/splunk-sdk-ruby/entity.rb
 - lib/splunk-sdk-ruby/splunk_http_error.rb
+- lib/splunk-sdk-ruby/ambiguous_entity_reference.rb
+- lib/splunk-sdk-ruby/entity_not_ready.rb
 - lib/splunk-sdk-ruby/synonyms.rb
-- lib/splunk-sdk-ruby/version.rb
+- lib/splunk-sdk-ruby/resultsreader.rb
 - lib/splunk-sdk-ruby/xml_shim.rb
+- lib/splunk-sdk-ruby/entity/job.rb
+- lib/splunk-sdk-ruby/entity/saved_search.rb
+- lib/splunk-sdk-ruby/entity/stanza.rb
+- lib/splunk-sdk-ruby/entity/index.rb
+- lib/splunk-sdk-ruby/entity/modular_input_kind.rb
+- lib/splunk-sdk-ruby/entity/message.rb
+- lib/splunk-sdk-ruby/collection/configurations.rb
+- lib/splunk-sdk-ruby/collection/case_insensitive_collection.rb
+- lib/splunk-sdk-ruby/collection/jobs.rb
+- lib/splunk-sdk-ruby/collection/messages.rb
+- lib/splunk-sdk-ruby/collection/apps.rb
+- lib/splunk-sdk-ruby/collection/configuration_file.rb
+- lib/splunk-sdk-ruby/collection/input_kinds.rb
+- lib/splunk-sdk-ruby/collection.rb
 - lib/splunk-sdk-ruby.rb
 - examples/1_connect.rb
 - examples/2_manage.rb
-- examples/3_blocking_searches.rb
+- examples/run_examples.rb
+- examples/example_modular_inputs.spl
 - examples/4_asynchronous_searches.rb
+- examples/run_examples.rb~
 - examples/5_stream_data_to_splunk.rb
+- examples/3_blocking_searches.rb
 - examples/6_work_with_modular_inputs.rb
-- examples/example_modular_inputs.spl
-- test/data/atom/atom_feed_with_message.xml
-- test/data/atom/atom_with_feed.xml
-- test/data/atom/atom_with_several_entries.xml
-- test/data/atom/atom_with_simple_entries.xml
-- test/data/atom/atom_without_feed.xml
-- test/data/atom_test_data.json
-- test/data/export/4.2.5/export_results.xml
+- test/test_restarts.rb
+- test/test_jobs.rb
+- test/test_helper.rb
+- test/test_service.rb
+- test/test_configuration_file.rb
+- test/test_saved_searches.rb
+- test/test_users.rb
+- test/test_context.rb
 - test/data/export/4.3.5/export_results.xml
 - test/data/export/5.0.1/export_results.xml
 - test/data/export/5.0.1/nonreporting.xml
-- test/data/export_test_data.json
-- test/data/results/4.2.5/results-empty.xml
-- test/data/results/4.2.5/results-preview.xml
-- test/data/results/4.2.5/results.xml
-- test/data/results/4.3.5/results-empty.xml
-- test/data/results/4.3.5/results-preview.xml
-- test/data/results/4.3.5/results.xml
-- test/data/results/5.0.2/results-empty.xml
-- test/data/results/5.0.2/results-empty_preview.xml
+- test/data/export/4.2.5/export_results.xml
 - test/data/results/5.0.2/results-preview.xml
 - test/data/results/5.0.2/results.xml
+- test/data/results/5.0.2/results-empty.xml
+- test/data/results/5.0.2/results-empty_preview.xml
+- test/data/results/4.3.5/results-preview.xml
+- test/data/results/4.3.5/results.xml
+- test/data/results/4.3.5/results-empty.xml
+- test/data/results/4.2.5/results-preview.xml
+- test/data/results/4.2.5/results.xml
+- test/data/results/4.2.5/results-empty.xml
 - test/data/resultsreader_test_data.json
-- test/services.server.info.xml
-- test/services.xml
-- test/test_atomfeed.rb
+- test/data/atom/atom_without_feed.xml
+- test/data/atom/atom_with_feed.xml
+- test/data/atom/atom_with_several_entries.xml
+- test/data/atom/atom_feed_with_message.xml
+- test/data/atom/atom_with_simple_entries.xml
+- test/data/atom_test_data.json
+- test/data/export_test_data.json
 - test/test_collection.rb
-- test/test_configuration_file.rb
-- test/test_context.rb
-- test/test_entity.rb
-- test/test_helper.rb
-- test/test_http_error.rb
-- test/test_index.rb
-- test/test_inputs.rb
-- test/test_jobs.rb
-- test/test_messages.rb
-- test/test_modular_input_kinds.rb
-- test/test_namespace.rb
-- test/test_restarts.rb
-- test/test_resultsreader.rb
 - test/test_roles.rb
-- test/test_saved_searches.rb
-- test/test_service.rb
-- test/test_users.rb
 - test/test_xml_shim.rb
+- test/test_atomfeed.rb
 - test/testfile.txt
+- test/services.xml
+- test/test_http_error.rb
+- test/test_resultsreader.rb
+- test/test_namespace.rb
+- test/test_modular_input_kinds.rb
+- test/test_inputs.rb
+- test/test_entity.rb
+- test/test_index.rb
+- test/services.server.info.xml
+- test/test_messages.rb
 - CHANGELOG.md
 - LICENSE
 - README.md
@@ -156,48 +158,48 @@ signing_key:
 specification_version: 4
 summary: Ruby bindings to Splunk REST layer
 test_files:
-- test/data/atom/atom_feed_with_message.xml
-- test/data/atom/atom_with_feed.xml
-- test/data/atom/atom_with_several_entries.xml
-- test/data/atom/atom_with_simple_entries.xml
-- test/data/atom/atom_without_feed.xml
-- test/data/atom_test_data.json
-- test/data/export/4.2.5/export_results.xml
+- test/test_restarts.rb
+- test/test_jobs.rb
+- test/test_helper.rb
+- test/test_service.rb
+- test/test_configuration_file.rb
+- test/test_saved_searches.rb
+- test/test_users.rb
+- test/test_context.rb
 - test/data/export/4.3.5/export_results.xml
 - test/data/export/5.0.1/export_results.xml
 - test/data/export/5.0.1/nonreporting.xml
-- test/data/export_test_data.json
-- test/data/results/4.2.5/results-empty.xml
-- test/data/results/4.2.5/results-preview.xml
-- test/data/results/4.2.5/results.xml
-- test/data/results/4.3.5/results-empty.xml
-- test/data/results/4.3.5/results-preview.xml
-- test/data/results/4.3.5/results.xml
-- test/data/results/5.0.2/results-empty.xml
-- test/data/results/5.0.2/results-empty_preview.xml
+- test/data/export/4.2.5/export_results.xml
 - test/data/results/5.0.2/results-preview.xml
 - test/data/results/5.0.2/results.xml
+- test/data/results/5.0.2/results-empty.xml
+- test/data/results/5.0.2/results-empty_preview.xml
+- test/data/results/4.3.5/results-preview.xml
+- test/data/results/4.3.5/results.xml
+- test/data/results/4.3.5/results-empty.xml
+- test/data/results/4.2.5/results-preview.xml
+- test/data/results/4.2.5/results.xml
+- test/data/results/4.2.5/results-empty.xml
 - test/data/resultsreader_test_data.json
-- test/services.server.info.xml
-- test/services.xml
-- test/test_atomfeed.rb
+- test/data/atom/atom_without_feed.xml
+- test/data/atom/atom_with_feed.xml
+- test/data/atom/atom_with_several_entries.xml
+- test/data/atom/atom_feed_with_message.xml
+- test/data/atom/atom_with_simple_entries.xml
+- test/data/atom_test_data.json
+- test/data/export_test_data.json
 - test/test_collection.rb
-- test/test_configuration_file.rb
-- test/test_context.rb
-- test/test_entity.rb
-- test/test_helper.rb
-- test/test_http_error.rb
-- test/test_index.rb
-- test/test_inputs.rb
-- test/test_jobs.rb
-- test/test_messages.rb
-- test/test_modular_input_kinds.rb
-- test/test_namespace.rb
-- test/test_restarts.rb
-- test/test_resultsreader.rb
 - test/test_roles.rb
-- test/test_saved_searches.rb
-- test/test_service.rb
-- test/test_users.rb
 - test/test_xml_shim.rb
+- test/test_atomfeed.rb
 - test/testfile.txt
+- test/services.xml
+- test/test_http_error.rb
+- test/test_resultsreader.rb
+- test/test_namespace.rb
+- test/test_modular_input_kinds.rb
+- test/test_inputs.rb
+- test/test_entity.rb
+- test/test_index.rb
+- test/services.server.info.xml
+- test/test_messages.rb