splunk-sdk-ruby 0.1.0 → 0.8.1

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

@@ -18,6 +18,7 @@ require_relative 'atomfeed'
 require_relative 'collection'
 require_relative 'collection/apps'
 require_relative 'collection/configurations'
+require_relative 'collection/input_kinds'
 require_relative 'collection/jobs'
 require_relative 'collection/messages'
 require_relative 'collection/case_insensitive_collection'
@@ -26,6 +27,7 @@ require_relative 'entity'
 require_relative 'entity/index'
 require_relative 'entity/job'
 require_relative 'entity/message'
+require_relative 'entity/modular_input_kind'
 require_relative 'entity/saved_search'
 require_relative 'entity/stanza'
 
@@ -39,10 +41,12 @@ module Splunk
   PATH_APPS_LOCAL = ["apps", "local"]
   PATH_CAPABILITIES = ["authorization", "capabilities"]
   PATH_LOGGER = ["server","logger"]
-  PATH_ROLES = ["authentication", "roles"]
-  PATH_USERS = ['authentication','users']
-  PATH_MESSAGES = ['messages']
+  PATH_ROLES = ["authorization", "roles"]
+  PATH_USERS = ["authentication","users"]
+  PATH_MESSAGES = ["messages"]
+  PATH_MODULAR_INPUT_KINDS = ["data", "modular-inputs"]
   PATH_INFO = ["server", "info"]
+  PATH_INPUTS = ["data", "inputs"]
   PATH_SETTINGS = ["server", "settings"]
   PATH_INDEXES = ["data","indexes"]
   PATH_CONFS = ["properties"]
@@ -219,6 +223,13 @@ module Splunk
       feed.entries[0]["content"]
     end
 
+    ##
+    # Return a collection of the input kinds.
+    #
+    def inputs
+      InputKinds.new(self, PATH_INPUTS)
+    end
+
     ##
     # Returns a collection of all the search jobs running on Splunk.
     #
@@ -272,6 +283,27 @@ module Splunk
       Messages.new(self, PATH_MESSAGES, entity_class=Message)
     end
 
+    ##
+    # Returns a read only collection of modular input kinds.
+    #
+    # The modular input kinds are custom input kinds on this Splunk instance.
+    # To access the actual inputs of these kinds, use the +Service+#+inputs+
+    # method. This method gives access to the metadata describing the input
+    # kinds.
+    #
+    # Returns: A +ReadOnlyCollection+ of +ModularInputKind+ objects representing
+    # all the custom input types added to this Splunk instance.
+    #
+    def modular_input_kinds
+      if self.splunk_version[0] < 5
+        raise IllegalOperation.new("Modular input kinds are " +
+                                       "not supported before Splunk 5.0")
+      else
+        ReadOnlyCollection.new(self, PATH_MODULAR_INPUT_KINDS,
+                               entity_class=ModularInputKind)
+      end
+    end
+
     ##
     # Returns a collection of the roles on the system.
     #
@@ -320,8 +352,8 @@ module Splunk
     #
     # The version is represented as an +Array+ of length 3, with each
     # of its components an integer. For example, on Splunk 4.3.5,
-    # +splunk_version+ would return [+4, 3, 5+], while on Splunk 5.0.2,
-    # +splunk_version+ would return [+5, 0, 2+].
+    # +splunk_version+ would return [+4+, +3+, +5+], while on Splunk 5.0.2,
+    # +splunk_version+ would return [+5+, +0+, +2+].
     #
     # Returns: An +Array+ of +Integers+ of length 3.
     #

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

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

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

@@ -113,5 +113,16 @@ module Splunk
       end
     end
   end
+
+  ##
+  # Escape reserved XML entities in a string.
+  #
+  # To match the behavior of splunkd, we only escape &, <, and >, not single
+  # and double quotes. This means we have to write the behavior ourselves,
+  # since both REXML and Nokogiri also escape both kinds of quotes.
+  #
+  def self.escape_string(str)
+    str.gsub(/&/, "&amp;").gsub(/</, "&lt;").gsub(/>/, "&gt;")
+  end
 end
 

data/splunk-sdk-ruby.gemspec

@@ -2,18 +2,19 @@
 
 Gem::Specification.new do |gem|
   gem.name          = 'splunk-sdk-ruby'
-  gem.version       = '0.1.0'
+  gem.version       = '0.8.1'
 
   gem.authors       = ['Splunk']
   gem.email         = ['devinfo@splunk.com']
   gem.description   = %q{Splunk SDK for Ruby}
   gem.summary       = %q{Ruby bindings to Splunk REST layer}
   gem.homepage      = 'http://dev.splunk.com'
+  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 'test-unit'
+  gem.add_development_dependency 'test-unit'
 
   gem.files         = Dir['{lib,examples,test}/**/*',
                           'CHANGELOG.md', 

data/test/data/atom_test_data.json

@@ -0,0 +1,457 @@
+{
+  "atom_with_feed": {
+    "metadata": {
+      "title": "localapps",
+      "id": "https://localhost:8089/servicesNS/nobody/system/apps/local",
+      "updated": "2012-12-19T11:07:48-08:00",
+      "generator": {"build": "144175", "version": "5.0.2"},
+      "author": "Splunk",
+      "links": {
+        "create": "/servicesNS/nobody/system/apps/local/_new",
+        "_reload": "/servicesNS/nobody/system/apps/local/_reload"
+      },
+      "totalResults": "1",
+      "itemsPerPage": "30",
+      "startIndex": "0",
+      "messages": []
+    },
+    "entries": [
+      {
+        "title": "gettingstarted",
+        "id": "https://localhost:8089/servicesNS/nobody/system/apps/local/gettingstarted",
+        "updated": "2012-12-19T11:07:48-08:00",
+        "author": "nobody",
+        "links": {
+          "alternate": "/servicesNS/nobody/system/apps/local/gettingstarted",
+          "list": "/servicesNS/nobody/system/apps/local/gettingstarted",
+          "_reload": "/servicesNS/nobody/system/apps/local/gettingstarted/_reload",
+          "edit": "/servicesNS/nobody/system/apps/local/gettingstarted",
+          "remove": "/servicesNS/nobody/system/apps/local/gettingstarted",
+          "disable": "/servicesNS/nobody/system/apps/local/gettingstarted/disable",
+          "package": "/servicesNS/nobody/system/apps/local/gettingstarted/package"
+        },
+        "content": {
+          "author": "Splunk",
+          "check_for_updates": "1",
+          "configured": "1",
+          "description": "Get started with Splunk.  This app introduces you to many of Splunk's features.  You'll learn how to use Splunk to index data, search and investigate, add knowledge, monitor and alert, report and analyze.",
+          "disabled": "0",
+          "eai:acl": {
+            "app": "system",
+            "can_change_perms": "1",
+            "can_list": "1",
+            "can_share_app": "1",
+            "can_share_global": "1",
+            "can_share_user": "0",
+            "can_write": "1",
+            "modifiable": "1",
+            "owner": "nobody",
+            "perms": {
+              "read": ["*"],
+              "write": ["power"]
+            },
+            "removable": "0",
+            "sharing": "app"
+          },
+          "eai:attributes": {
+            "optionalFields": ["author", "check_for_updates",
+                               "configured", "description",
+                               "label", "manageable", "version",
+                               "visible"],
+            "requiredFields": [],
+            "wildcardFields": []
+          },
+          "label": "Getting started",
+          "manageable": "1",
+          "state_change_requires_restart": "0",
+          "version": "1.0",
+          "visible": "1"
+        }
+      }
+    ]
+  },
+  "atom_without_feed": {
+    "metadata": {},
+    "entries": [
+      {
+        "title": "| metadata type=sources | search totalCount>0 | rename totalCount as Count recentTime as \"Last Update\" | table source Count \"Last Update\" | fieldformat Count=tostring(Count, \"commas\") | fieldformat \"Last Update\"=strftime('Last Update', \"%c\")",
+        "id": "https://localhost:8089/services/search/jobs/rt_1355944187.129",
+        "updated": "2012-12-19T11:09:52.000-08:00",
+        "published": "2012-12-19T11:09:47.000-08:00",
+        "links": {
+          "alternate": "/services/search/jobs/rt_1355944187.129",
+          "search.log": "/services/search/jobs/rt_1355944187.129/search.log",
+          "events": "/services/search/jobs/rt_1355944187.129/events",
+          "results": "/services/search/jobs/rt_1355944187.129/results",
+          "results_preview": "/services/search/jobs/rt_1355944187.129/results_preview",
+          "timeline": "/services/search/jobs/rt_1355944187.129/timeline",
+          "summary": "/services/search/jobs/rt_1355944187.129/summary",
+          "control": "/services/search/jobs/rt_1355944187.129/control"
+        },
+        "author": "admin",
+        "content": {
+          "cursorTime": "1969-12-31T16:00:00.000-08:00",
+          "delegate": "",
+          "diskUsage": "49152",
+          "dispatchState": "RUNNING",
+          "doneProgress": "1.00000",
+          "dropCount": "0",
+          "earliestTime": "1969-12-31T16:00:00.000-08:00",
+          "eventAvailableCount": "0",
+          "eventCount": "0",
+          "eventFieldCount": "0",
+          "eventIsStreaming": "1",
+          "eventIsTruncated": "1",
+          "eventSearch": "",
+          "eventSorting": "none",
+          "isDone": "0",
+          "isFailed": "0",
+          "isFinalized": "0",
+          "isPaused": "0",
+          "isPreviewEnabled": "1",
+          "isRealTimeSearch": "1",
+          "isRemoteTimeline": "0",
+          "isSaved": "0",
+          "isSavedSearch": "0",
+          "isZombie": "0",
+          "keywords": "",
+          "label": "",
+          "latestTime": "1969-12-31T16:00:00.000-08:00",
+          "meanPreviewPeriod": "1.708000",
+          "numPreviews": "3",
+          "pid": "11902",
+          "priority": "5",
+          "remoteSearch": "metadata  gather=false type=sources  update_period=0",
+          "reportSearch": "metadata  type=sources  | search totalCount>0  | rename  totalCount as Count recentTime as \"Last Update\"  | table  source Count \"Last Update\" ",
+          "resultCount": "0",
+          "resultIsStreaming": "0",
+          "resultPreviewCount": "5",
+          "runDuration": "5.124000",
+          "scanCount": "0",
+          "sid": "rt_1355944187.129",
+          "statusBuckets": "0",
+          "ttl": "599",
+          "performance": {
+            "command.metadata": {
+              "duration_secs": "4.995000",
+              "invocations": "9",
+              "input_count": "0",
+              "output_count": "6"
+            },
+            "command.metadata.execute_input": {
+              "duration_secs": "0.009000",
+              "invocations": "9"
+            },
+            "dispatch.check_disk_usage": {
+              "duration_secs": "0.001000",
+              "invocations": "1"
+            },
+            "dispatch.createProviderQueue": {
+              "duration_secs": "0.005000",
+              "invocations": "1"
+            },
+            "dispatch.evaluate": {
+              "duration_secs": "0.028000",
+              "invocations": "1"
+            },
+            "dispatch.evaluate.fieldformat": {
+              "duration_secs": "0.002000",
+              "invocations": "2"
+            },
+            "dispatch.evaluate.metadata": {
+              "duration_secs": "0.003000",
+              "invocations": "1"
+            },
+            "dispatch.evaluate.rename": {
+              "duration_secs": "0.001000",
+              "invocations": "1"
+            },
+            "dispatch.evaluate.search": {
+              "duration_secs": "0.021000",
+              "invocations": "1"
+            },
+            "dispatch.evaluate.table": {
+              "duration_secs": "0.001000",
+              "invocations": "1"
+            },
+            "dispatch.fetch": {
+              "duration_secs": "4.996000",
+              "invocations": "9"
+            },
+            "dispatch.preview": {
+              "duration_secs": "0.088000",
+              "invocations": "3"
+            },
+            "dispatch.preview.command.rename": {
+              "duration_secs": "0.004000",
+              "invocations": "3",
+              "input_count": "15",
+              "output_count": "15"
+            },
+            "dispatch.preview.command.search": {
+              "duration_secs": "0.057000",
+              "invocations": "3",
+              "input_count": "15",
+              "output_count": "15"
+            },
+            "dispatch.preview.command.search.filter": {
+              "duration_secs": "0.003000",
+              "invocations": "3"
+            },
+            "dispatch.preview.command.table": {
+              "duration_secs": "0.013000",
+              "invocations": "3",
+              "input_count": "15",
+              "output_count": "30"
+            },
+            "dispatch.preview.metadata.execute_output": {
+              "duration_secs": "0.003000",
+              "invocations": "3"
+            },
+            "dispatch.preview.write_results_to_disk": {
+              "duration_secs": "0.015000",
+              "invocations": "3"
+            },
+            "dispatch.stream.local": {
+              "duration_secs": "4.996000",
+              "invocations": "9"
+            },
+            "dispatch.writeStatus": {
+              "duration_secs": "0.013000",
+              "invocations": "6"
+            },
+            "startup.handoff": {
+              "duration_secs": "0.138000",
+              "invocations": "1"
+            }
+          },
+          "messages": {},
+          "request": {
+            "auto_cancel": "90",
+            "earliest_time": "rt",
+            "latest_time": "rt",
+            "max_count": "100000",
+            "search": "| metadata type=sources | search totalCount>0 | rename totalCount as Count recentTime as \"Last Update\" | table source Count \"Last Update\" | fieldformat Count=tostring(Count, \"commas\") | fieldformat \"Last Update\"=strftime('Last Update', \"%c\")",
+            "status_buckets": "0",
+            "time_format": "%s.%Q",
+            "ui_dispatch_app": "search",
+            "ui_dispatch_view": "dashboard_live"
+          },
+          "eai:acl": {
+            "perms": {
+              "read": ["admin"],
+              "write": ["admin"]
+            },
+            "owner": "admin",
+            "modifiable": "1",
+            "sharing": "global",
+            "app": "search",
+            "can_write": "1"
+          },
+          "searchProviders": ["fross-mbp15.local"]
+        }
+      }
+    ]
+  },
+  "atom_with_several_entries": {
+    "metadata": {
+      "title": "localapps",
+      "id": "https://localhost:8089/services/apps/local",
+      "updated": "2012-12-19T15:27:58-08:00",
+      "generator": {"version": "140437"},
+      "author": "Splunk",
+      "links": {
+        "create": "/services/apps/local/_new",
+        "_reload": "/services/apps/local/_reload"
+      },
+      "totalResults": "12",
+      "itemsPerPage": "30",
+      "startIndex": "0",
+      "messages": []
+    },
+    "entries": [
+      {
+        "title": "gettingstarted",
+        "id": "https://localhost:8089/services/apps/local/gettingstarted",
+        "updated": "2012-12-19T15:27:58-08:00",
+        "author": "system",
+        "links": {
+          "alternate": "/services/apps/local/gettingstarted",
+          "list": "/services/apps/local/gettingstarted",
+          "_reload": "/services/apps/local/gettingstarted/_reload",
+          "edit": "/services/apps/local/gettingstarted",
+          "remove": "/services/apps/local/gettingstarted",
+          "disable": "/services/apps/local/gettingstarted/disable",
+          "package": "/services/apps/local/gettingstarted/package"
+        },
+        "content": {
+          "author": "Splunk",
+          "check_for_updates": "1",
+          "configured": "1",
+          "description": "Get started with Splunk.  This app introduces you to many of Splunk's features.  You'll learn how to use Splunk to index data, search and investigate, add knowledge, monitor and alert, report and analyze.",
+          "disabled": "0",
+          "eai:acl": {
+            "app": "",
+            "can_change_perms": "1",
+            "can_list": "1",
+            "can_share_app": "1",
+            "can_share_global": "1",
+            "can_share_user": "0",
+            "can_write": "1",
+            "modifiable": "1",
+            "owner": "system",
+            "perms": {
+              "read": ["*"],
+              "write": ["power"]
+            },
+            "removable": "0",
+            "sharing": "app"
+          },
+          "label": "Getting started",
+          "manageable": "0",
+          "state_change_requires_restart": "0",
+          "version": "1.0",
+          "visible": "1"
+        }
+      },
+      {
+        "title": "launcher",
+        "id": "https://localhost:8089/services/apps/local/launcher",
+        "updated": "2012-12-19T15:27:58-08:00",
+        "author": "system",
+        "links": {
+          "alternate": "/services/apps/local/launcher",
+          "list": "/services/apps/local/launcher",
+          "_reload": "/services/apps/local/launcher/_reload",
+          "edit": "/services/apps/local/launcher",
+          "remove": "/services/apps/local/launcher",
+          "package": "/services/apps/local/launcher/package"
+        },
+        "content": {
+          "check_for_updates": "1",
+          "configured": "1",
+          "disabled": "0",
+          "eai:acl": {
+            "app": "",
+            "can_change_perms": "1",
+            "can_list": "1",
+            "can_share_app": "1",
+            "can_share_global": "1",
+            "can_share_user": "0",
+            "can_write": "1",
+            "modifiable": "1",
+            "owner": "system",
+            "perms": {
+              "read": ["*"],
+              "write": ["power"]
+            },
+            "removable": "0",
+            "sharing": "app"
+          },
+          "label": "Home",
+          "manageable": "0",
+          "state_change_requires_restart": "0",
+          "visible": "1"
+        }
+      },
+
+      {
+        "title": "learned",
+        "id": "https://localhost:8089/services/apps/local/learned",
+        "updated": "2012-12-19T15:27:58-08:00",
+        "author": "system",
+        "links": {
+          "alternate": "/services/apps/local/learned",
+          "list": "/services/apps/local/learned",
+          "_reload": "/services/apps/local/learned/_reload",
+          "edit": "/services/apps/local/learned",
+          "remove": "/services/apps/local/learned",
+          "disable": "/services/apps/local/learned/disable",
+          "package": "/services/apps/local/learned/package"
+        },
+        "content": {
+          "check_for_updates": "1",
+          "configured": "0",
+          "disabled": "0",
+          "eai:acl": {
+            "app": "",
+            "can_change_perms": "1",
+            "can_list": "1",
+            "can_share_app": "1",
+            "can_share_global": "1",
+            "can_share_user": "0",
+            "can_write": "1",
+            "modifiable": "1",
+            "owner": "system",
+            "perms": {"read": ["*"], "write": ["*"]},
+            "removable": "0",
+            "sharing": "app"
+          },
+          "label": "learned",
+          "manageable": "1",
+          "state_change_requires_restart": "0",
+          "visible": "0"
+        }
+      }
+    ]
+  },
+  "atom_with_simple_entries": {
+    "metadata": {
+      "title": "services",
+      "id": "https://localhost:8089/services/",
+      "updated": "2012-12-20T09:48:01-08:00",
+      "generator": {"version": "140437"},
+      "author": "Splunk",
+      "links": {},
+      "messages": []
+    },
+    "entries": [
+      {
+        "title": "alerts",
+        "id": "https://localhost:8089/services/alerts",
+        "updated": "2012-12-20T09:48:01-08:00",
+        "links": {
+          "alternate": "/services/alerts"
+        }
+      },
+      {
+        "title": "apps",
+        "id": "https://localhost:8089/services/apps",
+        "updated": "2012-12-20T09:48:01-08:00",
+        "links": {
+          "alternate": "/services/apps"
+        }
+      },
+      {
+        "title": "auth",
+        "id": "https://localhost:8089/services/auth",
+        "updated": "2012-12-20T09:48:01-08:00",
+        "links": {
+          "alternate": "/services/auth"
+        }
+      }
+    ]
+  },
+  "atom_feed_with_message": {
+    "metadata": {
+      "title": "roles",
+      "id": "https://localhost:8089/services/authorization/roles",
+      "updated": "2013-01-22T08:52:24-08:00",
+      "generator": {"build": "146385", "version": "5.0.2"},
+      "author": "Splunk",
+      "links": {
+        "create": "/services/authorization/roles/_new"
+      },
+      "startIndex": "0",
+      "totalResults": "0",
+      "itemsPerPage": "30",
+      "messages": [
+        {
+          "type": "WARN",
+          "message": "This role will be disabled after the Enterprise Trial License expires"
+        }
+      ]
+    },
+    "entries": []
+  }
+}