splunk-sdk-ruby 1.0.3 → 1.0.4

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    MDNmYWQwZDZmOTkwODM0NDc3MTJjYWNlODBhZjFkNzAwMzE2NDgwMw==
-  data.tar.gz: !binary |-
-    N2Y0OWM1OTg3ZWVjYmJiYmY1NjZlNzM5YzY4MDA5ZTU0OTYzZDYyNA==
+SHA1:
+  metadata.gz: b3c38b77a9adcc58802292d0d327961f78aec70b
+  data.tar.gz: 6a3dd18f3a37e32f82753f695655e89f26f43367
 SHA512:
-  metadata.gz: !binary |-
-    MjUwYWNkYmM0ZTg2MzA0M2U3YTk0MWJhOTE4ZDFlNmU1NjFkODRhODU2MzY4
-    YjdmNjYzMTYzZWQxZWRhYmQ5MDJlNGRkN2Q0NmE5YTQxMWExZGZiZjA2ZTcz
-    ZDA0MzJjMDgzY2MzZDFmZDYyNmQ0OTdjZjVkMzg3NDg2MjdjODM=
-  data.tar.gz: !binary |-
-    NjA5N2I4ZDE4ZGQxNDU2MDgxNWM0MGQ1NzlhOTc4OTRlNDE5ZmUzMGJlOTAx
-    ZWIyZmE0MTM0YWVhODM5NWVjMmYzYWUyMmZlZjEzOGQzYjI4MGFhNDA1ZjFj
-    Mjc3OTdmY2NiYjg4ODJkZDUzZmFlNmQ2ZjhjOTg3OGVmODA3Y2I=
+  metadata.gz: 27cdf2cc8daa4b942cc23a266630fa5bc4c58fac9eb7b789b7858712df257aecdaf1ff42d91e20a66dd61924fdfa81a419b52cad1d925afd104f7eeb8a44b7f1
+  data.tar.gz: 0d782c21487ac3d410263cd4590509185e71c2c1805cb250d654384e7f8c380582de7853ff0d0eb72fe3627d0067842036ac12d5bbb16689735e40f657c6dca5

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Splunk SDK for Ruby Changelog
 
+## Version 1.0.4
+
+* Added support for client certificates and path prefix.
+* Added an option to specify a proxy server to use. Includes connect_via_proxy.rb example.
+* Minor Fixes
+
 ## Version 1.0.3
 
 * Splunk SDK for Ruby now works with Splunk 6.

data/Gemfile

@@ -1,4 +1,4 @@
-source :rubygems
+source "https://rubygems.org"
 # This line is required to let RubyMine run the test suite,
 # since otherwise random packages load other random packages
 # in random order and clobber RubyMine's configuration.

data/README.md

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

data/examples/connect_via_reverse_proxy.rb

@@ -0,0 +1,66 @@
+#--
+# 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.
+#++
+
+require 'splunk-sdk-ruby'
+
+# Your client certififcate that grants access to the reverse proxy.
+CERT_PATH = "#{ENV['HOME']}/.ssl/client.p12"
+CERT_PASS = '12changeme34'
+p12 = OpenSSL::PKCS12.new(File.read(CERT_PATH), CERT_PASS)
+
+# How to get to the Splunk server that lives behind a reverse proxy
+# that requires a client certificate to access
+# and when a HTTP proxy is required to leave the local network.
+# Edit this to match your own server setup.
+config = {
+    :proxy => Net::HTTP::Proxy('myproxy.intranet.example.com', 80),
+    :scheme => :https,
+    :host => "externalservices.example.com",
+    :port => 443,
+    :path_prefix => '/splunk/api/',
+    :ssl_client_cert => p12.certificate,
+    :ssl_client_key  => p12.key,
+    :username => "admin",
+    :password => "changeme"
+}
+
+# Create a Service logged into Splunk, and print the authentication token
+# that Splunk sent us.
+service0 = Splunk::connect(config)
+puts "Logged in service 0. Token: #{service0.token}"
+
+# connect is a synonym for creating a Service by hand and calling login.
+service1 = Splunk::Service.new(config)
+service1.login()
+puts "Logged in. Token: #{service1.token}"
+
+# However, we don't always want to call login. If we have already obtained a
+# valid token, we can use it instead of a username or password. In this case
+# we must create the Service manually.
+token_config = {
+    :proxy => config[:proxy],
+    :scheme => config[:scheme],
+    :host => config[:host],
+    :port => config[:port],
+    :path_prefix => config[:path_prefix],
+    :ssl_client_cert => config[:ssl_client_cert],
+    :ssl_client_key  => config[:ssl_client_key],
+    :token => service1.token
+}
+
+service2 = Splunk::Service.new(token_config)
+puts "Theoretically logged in. Token: #{service2.token}"
+

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

@@ -23,6 +23,7 @@
 #
 
 require 'net/http'
+require 'openssl'
 
 require_relative 'splunk_http_error'
 require_relative 'version'
@@ -33,6 +34,7 @@ module Splunk
   DEFAULT_HOST = 'localhost'
   DEFAULT_PORT = 8089
   DEFAULT_SCHEME = :https
+  DEFAULT_PATH_PREFIX = ''
 
   # Class encapsulating a connection to a Splunk server.
   #
@@ -56,6 +58,10 @@ module Splunk
   # * +:protocol+ - either :https or :http (default: :https)
   # * +:namespace+ - a +Namespace+ object representing the default namespace for
   #   this context (default: +DefaultNamespace+)
+  # * +:proxy+ An instance of +Net::HTTP::Proxy+ to use as a proxy service.
+  # * +:path_prefix+ A path prefix that should be prepended to all URLs.
+  # * +: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+)
   #
   # If you specify a token, you need not specify a username or password, nor
@@ -80,6 +86,10 @@ module Splunk
       # local accessor.
       @namespace = args.fetch(:namespace,
                               Splunk::namespace(:sharing => "default"))
+      @proxy = args.fetch(:proxy, nil)
+      @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)
     end
 
     ##
@@ -149,6 +159,29 @@ module Splunk
     #
     attr_reader :namespace
 
+    ##
+    # An instance of +Net::HTTP::Proxy+ to use as a proxy service.
+    #
+    attr_reader :proxy
+
+    ##
+    # The path prefix that should be prepended to all URLs.
+    # This is useful if the Splunk server is behind a reverse proxy server.
+    #
+    # Defaults to empty string.
+    #
+    attr_reader :path_prefix
+
+    ##
+    # A +OpenSSL::X509::Certificate+ object to use as a client certificate.
+    #
+    attr_reader :ssl_client_cert
+
+    ##
+    # A +OpenSSL::PKey::RSA+ or +OpenSSL::PKey::DSA+ object to use as a client key.
+    #
+    attr_reader :ssl_client_key
+
     ##
     # Opens a TCP socket to the Splunk HTTP server.
     #
@@ -307,6 +340,7 @@ module Splunk
       url = ""
       url << "#{(scheme || @scheme).to_s}://"
       url << "#{host || @host}:#{(port || @port).to_s}/"
+      url << @path_prefix
       # 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.
@@ -401,11 +435,13 @@ module Splunk
       if url.respond_to?(:hostname)
         url_hostname = url.hostname
       end
-      response = Net::HTTP::start(
+      response = (@proxy || Net::HTTP)::start(
           url_hostname, url.port,
           :use_ssl => url.scheme == 'https',
           # We don't support certificates.
-          :verify_mode => OpenSSL::SSL::VERIFY_NONE
+          :verify_mode => OpenSSL::SSL::VERIFY_NONE,
+          :cert => @ssl_client_cert,
+          :key => @ssl_client_key
       ) do |http|
         http.request(request)
       end

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

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

data/splunk-sdk-ruby.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |gem|
   gem.name          = 'splunk-sdk-ruby'
-  gem.version       = '1.0.3'
+  gem.version       = '1.0.4'
 
   gem.authors       = ['Splunk']
   gem.email         = ['devinfo@splunk.com']
@@ -12,8 +12,8 @@ Gem::Specification.new do |gem|
   gem.license       = 'APL2'
 
   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_dependency 'jruby-openssl', '>=0.7.7' if RUBY_PLATFORM == "java"
+  gem.add_development_dependency 'rake', '~>10'
   gem.add_development_dependency 'test-unit', '~> 0'
 
   gem.files         = Dir['{lib,examples,test}/**/*',

metadata

@@ -1,41 +1,41 @@
 --- !ruby/object:Gem::Specification
 name: splunk-sdk-ruby
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.0.4
 platform: ruby
 authors:
 - Splunk
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-27 00:00:00.000000000 Z
+date: 2014-07-25 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: :runtime
+  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
@@ -56,6 +56,7 @@ files:
 - 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
@@ -142,63 +143,63 @@ 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.2.1
+rubygems_version: 2.4.1
 signing_key: 
 specification_version: 4
 summary: Ruby bindings to Splunk REST layer
 test_files:
-- 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/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
+- 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