splunk-sdk-ruby 1.0.4 → 1.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b3c38b77a9adcc58802292d0d327961f78aec70b
-  data.tar.gz: 6a3dd18f3a37e32f82753f695655e89f26f43367
+  metadata.gz: 34a1f802857efc8505ade417d3dd2d75de7a8c30
+  data.tar.gz: 2a8068e47040a22d4148f1db614965a64a3ec368
 SHA512:
-  metadata.gz: 27cdf2cc8daa4b942cc23a266630fa5bc4c58fac9eb7b789b7858712df257aecdaf1ff42d91e20a66dd61924fdfa81a419b52cad1d925afd104f7eeb8a44b7f1
-  data.tar.gz: 0d782c21487ac3d410263cd4590509185e71c2c1805cb250d654384e7f8c380582de7853ff0d0eb72fe3627d0067842036ac12d5bbb16689735e40f657c6dca5
+  metadata.gz: f41166be1bff0c9479246d6ef477954f3d54b27f295f5bb38051422b9d99fb8021b3df08f9d8bef884f63ecb9ba91a4c1299e43f645fbd8bc71d426eec7db3cd
+  data.tar.gz: a05a8a35e1f459a7e39fcdb63869e20cf4cc3c5fe7868a9bf6fae057bbbc727d48288f4157cac9a4c4a330748d943d877d07be8518e2ee5d89b0527192e3d71b

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Splunk SDK for Ruby Changelog
 
+## Version 1.0.5
+
+* Added support for basic authentication.
+* Added an example for load balanced search heads.
+
 ## Version 1.0.4
 
 * Added support for client certificates and path prefix.

data/README.md

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

data/Rakefile

@@ -4,20 +4,6 @@ require 'rubygems/specification'
 require 'rake/testtask'
 require 'date'
 
-spec = Gem::Specification.new do |s|
-  s.name = "splunk-sdk"
-  s.version = "0.1.0"
-  s.author = "Splunk"
-  s.email = "devinfo@splunk.com"
-  s.homepage = "http://dev.splunk.com"
-  s.summary = "SDK for easily working with Splunk from Ruby."
-  s.description = s.summary
-  s.has_rdoc = true
-  s.extra_rdoc_files = ["README", "LICENSE", "TODO"]
-  s.require_path = "lib"
-  s.files = %w(LICENSE README Rakefile TODO) + Dir.glob('{lib,test}/**/*')
-end
-
 task :default => :help
 
 desc "Print help on using the Rakefile for the Ruby SDK for Splunk."
@@ -36,5 +22,5 @@ end
 Rake::TestTask.new do |t|
   t.libs << "test"
   t.pattern = "test/test_*.rb"
-  t.verbose = true
+  t.options = "-v"
 end

data/examples/connect_load_balanced_search_heads.rb

@@ -0,0 +1,44 @@
+#--
+# Copyright 2011-2015 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.
+#++
+
+require 'splunk-sdk-ruby'
+
+# How to get to the Splunk server. Edit this to match your
+# own Splunk install.
+config = {
+    :scheme => :https,
+    :host => "localhost",
+    :port => 8089,
+    :username => "admin",
+    :password => "changeme",
+    # Set basic = true to use basic auth instead of token auth
+    :basic => true
+}
+
+# Create a Service logged into Splunk.
+service = Splunk::connect(config)
+
+# Access some resource
+num_apps = service.apps().length
+puts "Found #{num_apps} apps on #{config[:host]}"
+
+# Mock the behavior of a load balancer
+config[:host] = "127.0.0.1"
+service = Splunk::connect(config)
+
+# Access some resource again
+num_apps = service.apps().length
+puts "Found #{num_apps} apps on #{config[:host]}"

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

@@ -63,6 +63,7 @@ module Splunk
   # * +:ssl_client_cert+ A +OpenSSL::X509::Certificate+ object to use as a client certificate.
   # * +:ssl_client_key+ A +OpenSSL::PKey::RSA+ or +OpenSSL::PKey::DSA+ object to use as a client key.
   # * +:token+ - a preauthenticated Splunk token (default: +nil+)
+  # * +:basic+ - indicates if HTTP Basic Auth is going to be used (default: +false+)
   #
   # If you specify a token, you need not specify a username or password, nor
   # do you need to call the +login+ method.
@@ -87,6 +88,7 @@ module Splunk
       @namespace = args.fetch(:namespace,
                               Splunk::namespace(:sharing => "default"))
       @proxy = args.fetch(:proxy, nil)
+      @basic = args.fetch(:basic, false)
       @path_prefix = args.fetch(:path_prefix, DEFAULT_PATH_PREFIX)
       @ssl_client_cert = args.fetch(:ssl_client_cert, nil)
       @ssl_client_key = args.fetch(:ssl_client_key, nil)
@@ -223,9 +225,11 @@ module Splunk
     #
     def login()
       if @token # If we're already logged in, this method is a nop.
-        return
+        return self
+      end
+      if @basic # We're using basic authentication, thus making this a nop
+        return self
       end
-
       response = request(:namespace => Splunk::namespace(:sharing => "default"),
                          :method => :POST,
                          :resource => ["auth", "login"],
@@ -418,6 +422,11 @@ module Splunk
       # Headers
       request["User-Agent"] = "splunk-sdk-ruby/#{VERSION}"
       request["Authorization"] = "Splunk #{@token}" if @token
+
+      # basic authentication supercedes Splunk authentication
+      if @basic then
+        request.basic_auth(@username, @password)
+      end
       headers.each_entry do |key, value|
         request[key] = value
       end

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

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

data/splunk-sdk-ruby.gemspec

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

data/test/test_context.rb

@@ -57,6 +57,15 @@ class TestContext < TestCaseWithSplunkConnection
     assert_logged_in(new_service)
   end
 
+  def test_authenticate_with_basic
+    new_arguments = @splunkrc.clone
+    new_arguments[:basic] = true
+
+    new_service = Context.new(new_arguments)
+    assert_logged_in(new_service)
+    assert_equal(new_service.request(:resource => ["apps", "local"]).code, "200")
+  end
+
   def test_failed_login()
     args = @splunkrc.clone()
     args[:username] = args[:username] + "-boris"

data/test/test_jobs.rb

@@ -99,7 +99,7 @@ class JobsTestCase < TestCaseWithSplunkConnection
   def test_export_on_reporting_search
     stream = @service.create_export("search index=_internal earliest=-2d | stats count(_raw) by method")
     results = ResultsReader.new(stream).to_a()
-    assert_true(3 >= results.length())
+    assert_true(3 <= results.length())
   end
 
   ##
@@ -340,27 +340,27 @@ class LongJobTestCase < JobsTestCase
       ttl <= new_ttl && ttl > old_ttl
     end
   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)
-      old_ttl = Integer(@job.refresh()["ttl"])
-      @job.touch()
-      new_ttl = Integer(@job.refresh()["ttl"])
-      if new_ttl > old_ttl
-        break
-      else
-        i += 1
-      end
-    end
-    assert_true(new_ttl > old_ttl)
-  end
+  # NOTE: this test is no longer relevant due to some changes in Splunk 6.0+
+  # 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)
+  #     old_ttl = Integer(@job.refresh()["ttl"])
+  #     @job.touch()
+  #     new_ttl = Integer(@job.refresh()["ttl"])
+  #     if new_ttl > old_ttl
+  #       break
+  #     else
+  #       i += 1
+  #     end
+  #   end
+  #   assert_true(new_ttl > old_ttl)
+  # end
 end
 
 class RealTimeJobTestCase < JobsTestCase

metadata

@@ -1,41 +1,41 @@
 --- !ruby/object:Gem::Specification
 name: splunk-sdk-ruby
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 1.0.5
 platform: ruby
 authors:
 - Splunk
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-25 00:00:00.000000000 Z
+date: 2015-08-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '10'
 - !ruby/object:Gem::Dependency
   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,24 +45,8 @@ 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/connect_via_reverse_proxy.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
@@ -70,14 +54,15 @@ files:
 - 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.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/illegal_operation.rb
 - lib/splunk-sdk-ruby/namespace.rb
@@ -87,7 +72,17 @@ files:
 - lib/splunk-sdk-ruby/synonyms.rb
 - lib/splunk-sdk-ruby/version.rb
 - lib/splunk-sdk-ruby/xml_shim.rb
-- splunk-sdk-ruby.gemspec
+- lib/splunk-sdk-ruby.rb
+- 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/connect_load_balanced_search_heads.rb
+- examples/connect_via_reverse_proxy.rb
+- examples/example_modular_inputs.spl
+- examples/run_examples.rb
 - test/data/atom/atom_feed_with_message.xml
 - test/data/atom/atom_with_feed.xml
 - test/data/atom/atom_with_several_entries.xml
@@ -133,6 +128,12 @@ files:
 - test/test_users.rb
 - test/test_xml_shim.rb
 - test/testfile.txt
+- CHANGELOG.md
+- LICENSE
+- README.md
+- Gemfile
+- Rakefile
+- splunk-sdk-ruby.gemspec
 homepage: http://dev.splunk.com
 licenses:
 - APL2
@@ -143,17 +144,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: 1.9.2
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.1
+rubygems_version: 2.0.14
 signing_key: 
 specification_version: 4
 summary: Ruby bindings to Splunk REST layer