splunk-sdk-ruby 1.0.2 → 1.0.3

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ZmVkNmYzMTIwZTAwOGM1ZTQwNjc2MGUxMTY1ZDQwY2IzMWIzZTc4MQ==
+    MDNmYWQwZDZmOTkwODM0NDc3MTJjYWNlODBhZjFkNzAwMzE2NDgwMw==
   data.tar.gz: !binary |-
-    MWU0MWM2ZTYwZDI5NzdmN2MwOTk3NTUzNmI2ZTRkMjY3ZjJkM2ZhMw==
-!binary "U0hBNTEy":
+    N2Y0OWM1OTg3ZWVjYmJiYmY1NjZlNzM5YzY4MDA5ZTU0OTYzZDYyNA==
+SHA512:
   metadata.gz: !binary |-
-    MTE4NjE3NzJjZTJmOWY3MjQ4MjNjMWQ4YjUwYTNlYWIzYTA3NmYyZWVhOTY2
-    NDMzMGE3NTUwNDIxNDRhNThmYzM1M2U4YjI3YWU4ZjFiMWU1NmNkYzk4YTkx
-    ZDI3MjkyNmQwOWY2M2Y2OTQwNGFmZDY5OTdmMTliNjBkZTg4NWE=
+    MjUwYWNkYmM0ZTg2MzA0M2U3YTk0MWJhOTE4ZDFlNmU1NjFkODRhODU2MzY4
+    YjdmNjYzMTYzZWQxZWRhYmQ5MDJlNGRkN2Q0NmE5YTQxMWExZGZiZjA2ZTcz
+    ZDA0MzJjMDgzY2MzZDFmZDYyNmQ0OTdjZjVkMzg3NDg2MjdjODM=
   data.tar.gz: !binary |-
-    YjQ5NGQ3MjFjMjZiZWU5MzJmM2MxNGNjOTg1ZTkzOGUxMGUwNDEwYjVhMjUz
-    NTY3MDE2MzliY2E2NzljNjFiZmFlY2YxNzA0YTY0YWI3YjE3ZjZmMjVkZDlj
-    NDliZTE4NGI0ODBlYTBkYzdmY2M2NWFiMzcwYjA3ZmIwZDBiMjI=
+    NjA5N2I4ZDE4ZGQxNDU2MDgxNWM0MGQ1NzlhOTc4OTRlNDE5ZmUzMGJlOTAx
+    ZWIyZmE0MTM0YWVhODM5NWVjMmYzYWUyMmZlZjEzOGQzYjI4MGFhNDA1ZjFj
+    Mjc3OTdmY2NiYjg4ODJkZDUzZmFlNmQ2ZjhjOTg3OGVmODA3Y2I=

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Splunk SDK for Ruby Changelog
 
+## Version 1.0.3
+
+* Splunk SDK for Ruby now works with Splunk 6.
+* Fixed URL escaping of owners and apps in namespaces that contain special characters.
+
+## Version 1.0.2
+
+* Cosmetic changes to the repository only.
+
 ## Version 1.0.1
 
 * Fixed Job#results to properly handle arguments.

data/README.md

@@ -1,6 +1,7 @@
 # The Splunk Software Development Kit for Ruby
 
-#### Version 1.0.2
+#### Version 1.0.3
+
 This Splunk Software Development Kit (SDK) for Ruby contains library code and 
 examples designed to enable developers to build applications using Splunk.
 

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

@@ -307,8 +307,11 @@ module Splunk
       url = ""
       url << "#{(scheme || @scheme).to_s}://"
       url << "#{host || @host}:#{(port || @port).to_s}/"
+      # You would think that the second argument to URI::encode would be unnecessary
+      # for it to actually escape URI reserved characters. You would be wrong. It does
+      # have to be there, or URI::encode doesn't actually escape any characters.
       url << (namespace.to_path_fragment() + resource).
-          map {|fragment| URI::encode(fragment)}.
+          map {|fragment| URI::encode(fragment, Regexp.new("[^#{URI::PATTERN::UNRESERVED}]"))}.
           join("/")
 
       return request_by_url(:url => url,
@@ -394,8 +397,12 @@ module Splunk
       end
 
       # Issue the request.
+      url_hostname = url.host
+      if url.respond_to?(:hostname)
+        url_hostname = url.hostname
+      end
       response = Net::HTTP::start(
-          url.hostname, url.port,
+          url_hostname, url.port,
           :use_ssl => url.scheme == 'https',
           # We don't support certificates.
           :verify_mode => OpenSSL::SSL::VERIFY_NONE
@@ -522,4 +529,4 @@ module Splunk
     end
 
   end
-end
+end

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

@@ -167,7 +167,11 @@ module Splunk
     def is_ready?()
       begin
         refresh()
-        return true
+        if @state["content"]["dispatchState"] == "QUEUED" || @state["content"]["dispatchState"] == "PARSING"
+          return false
+        else
+          return true
+        end
       rescue EntityNotReady
         return false
       end

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

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

data/splunk-sdk-ruby.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |gem|
   gem.name          = 'splunk-sdk-ruby'
-  gem.version       = '1.0.2'
+  gem.version       = '1.0.3'
 
   gem.authors       = ['Splunk']
   gem.email         = ['devinfo@splunk.com']
@@ -14,7 +14,7 @@ Gem::Specification.new do |gem|
   gem.required_ruby_version = '>=1.9.2'
   gem.add_dependency 'jruby-openssl', '~>0.7.7' if RUBY_PLATFORM == "java"
   gem.add_dependency 'rake', '~>10'
-  gem.add_development_dependency 'test-unit'
+  gem.add_development_dependency 'test-unit', '~> 0'
 
   gem.files         = Dir['{lib,examples,test}/**/*',
                           'CHANGELOG.md', 

data/test/test_atomfeed.rb

@@ -39,12 +39,14 @@ class TestAtomFeed < Test::Unit::TestCase
     puts "Nokogiri not installed. Skipping."
   end
 
-  test_cases = JSON::parse(open("test/data/atom_test_data.json").read())
+  data_path = File.dirname(File.expand_path(__FILE__))
+  test_cases = JSON::parse(open(data_path + "/data/atom_test_data.json").read())
 
   xml_libraries.each do |xml_library|
     test_cases.each_entry do |filename, expected|
       define_method("test_#{xml_library}_#{filename}".intern()) do
-        file = File.open("test/data/atom/#{filename}.xml")
+
+        file = File.open(File.dirname(File.expand_path(__FILE__)) + "/data/atom/#{filename}.xml")
         Splunk::require_xml_library(xml_library)
         feed = Splunk::AtomFeed.new(file)
 

data/test/test_context.rb

@@ -116,4 +116,16 @@ class TestContext < TestCaseWithSplunkConnection
       assert_true(v.is_a?(Integer))
     end
   end
+
+  def test_url_encoding_of_characters_in_usernames
+    name = temporary_name() + "/\441@"
+    begin
+      @service.request(:namespace => Splunk::namespace(:sharing => "user", :owner => name, :app => name))
+      fail("Didn't receive an error.")
+    rescue SplunkHTTPError => err
+      assert_equal(404, err.code)
+      assert_equal("User does not exist: " + name, err.detail)
+    end
+  end
+
 end

data/test/test_index.rb

@@ -42,7 +42,9 @@ class IndexTestCase < TestCaseWithSplunkConnection
 
   def test_disable_enable
     @index.disable()
-    checked_restart(@service)
+    if @service.splunk_version[0] < 6
+      checked_restart(@service)
+    end
     @index.refresh()
     assert_equal('1', @index["disabled"])
 

data/test/test_jobs.rb

@@ -250,9 +250,11 @@ class JobsTestCase < TestCaseWithSplunkConnection
     begin
       install_app_from_collection("sleep_command")
       job = @service.jobs.create("search index=_internal | sleep 2 | join [sleep 2]")
+
       while !job.is_ready?()
         sleep(0.1)
       end
+
       assert_equal("0", job["isPreviewEnabled"])
       job.enable_preview()
       assert_eventually_true(1000) do
@@ -340,6 +342,11 @@ class LongJobTestCase < JobsTestCase
   end
 
   def test_touch
+    # Any request resets the TTL in Splunk 6.0. This was an error that
+    # has been filed and will be reverted (TODO: Insert Jira number once dnoble logs it).
+    if @service.splunk_version[0,2] == [6,0]
+      return
+    end
     i = 2
     while i < 20
       sleep(i)

data/test/test_namespace.rb

@@ -117,16 +117,16 @@ class TestNamespaces < Test::Unit::TestCase
                  Splunk::namespace(:sharing => "global").to_path_fragment)
     assert_equal(["servicesNS", "nobody", "system"],
                  Splunk::namespace(:sharing => "system").to_path_fragment)
-    assert_equal(["servicesNS", "nobody", "search"],
-                 Splunk::namespace(:sharing => "app", :app => "search").to_path_fragment)
+    assert_equal(["servicesNS", "nobody", "search/@!"],
+                 Splunk::namespace(:sharing => "app", :app => "search/@!").to_path_fragment)
     assert_equal(["servicesNS", "nobody", "-"],
                  Splunk::namespace(:sharing => "app", :app => "-").to_path_fragment)
     assert_equal(["services"], Splunk::namespace(:sharing => "app",
                                                  :app => "").to_path_fragment)
-    assert_equal(["servicesNS", "boris", "search"],
+    assert_equal(["servicesNS", "boris/@!", "search/@!"],
                  Splunk::namespace(:sharing => "user",
-                                   :app => "search",
-                                   :owner => "boris").to_path_fragment)
+                                   :app => "search/@!",
+                                   :owner => "boris/@!").to_path_fragment)
   end
 
   def test_eai_acl_to_namespace

data/test/test_resultsreader.rb

@@ -4,6 +4,8 @@ require 'json'
 
 include Splunk
 
+TEST_PATH = File.dirname(File.expand_path(__FILE__))
+
 class TestResultsReader < Test::Unit::TestCase
   if nokogiri_available?
     xml_libraries = [:nokogiri, :rexml]
@@ -34,8 +36,9 @@ class TestResultsReader < Test::Unit::TestCase
     assert_equal(expected["results"].length, n_results)
   end
 
-  test_data = JSON::parse(open("test/data/resultsreader_test_data.json").read())
-  export_data = JSON::parse(open("test/data/export_test_data.json").read())
+  data_path = File.dirname(File.expand_path(__FILE__))
+  test_data = JSON::parse(open(data_path + "/data/resultsreader_test_data.json").read())
+  export_data = JSON::parse(open(data_path + "/data/export_test_data.json").read())
 
   xml_libraries.each do |xml_library|
     test_data.each_entry do |version, tests|
@@ -43,7 +46,7 @@ class TestResultsReader < Test::Unit::TestCase
         test_name = "test_#{xml_library}_#{version.gsub(/\./, "_")}_#{name}"
         define_method(test_name.intern()) do
           Splunk::require_xml_library(xml_library)
-          file = File.open("test/data/results/#{version}/#{name}.xml")
+          file = File.open(TEST_PATH + "/data/results/#{version}/#{name}.xml")
           reader = ResultsReader.new(file)
           assert_results_reader_equals(expected, reader)
         end
@@ -55,7 +58,7 @@ class TestResultsReader < Test::Unit::TestCase
       test_name = "test_#{xml_library}_#{version.gsub(/\./, "_")}_export_via_results_reader"
       define_method(test_name.intern) do
         Splunk::require_xml_library(xml_library)
-        raw_file = File.open("test/data/export/#{version}/export_results.xml")
+        raw_file = File.open(TEST_PATH + "/data/export/#{version}/export_results.xml")
         file = Splunk::ExportStream.new(raw_file)
         found = ResultsReader.new(file)
         expected = tests["without_preview"]
@@ -66,7 +69,7 @@ class TestResultsReader < Test::Unit::TestCase
       test_name = "test_#{xml_library}_#{version.gsub(/\./, "_")}_sans_preview"
       define_method(test_name.intern) do
         Splunk::require_xml_library(xml_library)
-        raw_file = File.open("test/data/export/#{version}/export_results.xml")
+        raw_file = File.open(TEST_PATH + "/data/export/#{version}/export_results.xml")
         file = Splunk::ExportStream.new(raw_file)
         reader = MultiResultsReader.new(file)
         found = reader.final_results()
@@ -78,7 +81,7 @@ class TestResultsReader < Test::Unit::TestCase
       test_name = "test_#{xml_library}_#{version.gsub(/\./, "_")}_with_preview"
       define_method(test_name.intern) do
         Splunk::require_xml_library(xml_library)
-        raw_file = File.open("test/data/export/#{version}/export_results.xml")
+        raw_file = File.open(TEST_PATH + "/data/export/#{version}/export_results.xml")
         file = Splunk::ExportStream.new(raw_file)
         multireader = MultiResultsReader.new(file)
         n_results_sets = 0
@@ -100,7 +103,7 @@ class TestResultsReader < Test::Unit::TestCase
       if tests.has_key?("nonreporting")
         define_method(test_name.intern) do
           Splunk::require_xml_library(xml_library)
-          file = File.open("test/data/export/#{version}/nonreporting.xml")
+          file = File.open(TEST_PATH + "/data/export/#{version}/nonreporting.xml")
           multireader = MultiResultsReader.new(file)
           n_results_sets = 0
           readers = []

data/test/test_service.rb

@@ -61,5 +61,5 @@ class ServiceTestCase < TestCaseWithSplunkConnection
     expected.each do |item|
       assert(capabilities.include?(item))
     end
-  end
+    end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: splunk-sdk-ruby
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors:
 - Splunk
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-22 00:00:00.000000000 Z
+date: 2014-01-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -28,14 +28,14 @@ dependencies:
   name: test-unit
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
         version: '0'
 description: Splunk SDK for Ruby
@@ -45,94 +45,93 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- examples/1_connect.rb
+- examples/2_manage.rb
+- examples/3_blocking_searches.rb
+- examples/4_asynchronous_searches.rb
+- examples/5_stream_data_to_splunk.rb
+- examples/6_work_with_modular_inputs.rb
+- examples/example_modular_inputs.spl
+- examples/run_examples.rb
+- lib/splunk-sdk-ruby.rb
+- lib/splunk-sdk-ruby/ambiguous_entity_reference.rb
 - lib/splunk-sdk-ruby/atomfeed.rb
+- lib/splunk-sdk-ruby/collection.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/context.rb
-- lib/splunk-sdk-ruby/service.rb
+- lib/splunk-sdk-ruby/entity.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_not_ready.rb
 - lib/splunk-sdk-ruby/illegal_operation.rb
-- lib/splunk-sdk-ruby/version.rb
 - lib/splunk-sdk-ruby/namespace.rb
-- lib/splunk-sdk-ruby/entity.rb
+- lib/splunk-sdk-ruby/resultsreader.rb
+- lib/splunk-sdk-ruby/service.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/resultsreader.rb
+- lib/splunk-sdk-ruby/version.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/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
-- 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
+- splunk-sdk-ruby.gemspec
+- 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/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/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/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.2.5/results-empty.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/results/5.0.2/results-preview.xml
+- test/data/results/5.0.2/results.xml
 - test/data/resultsreader_test_data.json
-- 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_roles.rb
-- test/test_xml_shim.rb
-- test/test_atomfeed.rb
-- test/testfile.txt
+- test/services.server.info.xml
 - 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_atomfeed.rb
+- 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/services.server.info.xml
+- test/test_inputs.rb
+- test/test_jobs.rb
 - test/test_messages.rb
-- CHANGELOG.md
-- LICENSE
-- README.md
-- Gemfile
-- Rakefile
-- splunk-sdk-ruby.gemspec
+- 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/testfile.txt
 homepage: http://dev.splunk.com
 licenses:
 - APL2
@@ -153,7 +152,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.2.1
 signing_key: 
 specification_version: 4
 summary: Ruby bindings to Splunk REST layer

data/examples/run_examples.rb~

@@ -1,22 +0,0 @@
-#--
-# 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_')}