splunk-sdk-ruby 0.1.0

data/CHANGELOG.md

@@ -0,0 +1,160 @@
+# Splunk SDK for Ruby Changelog
+
+## Version 0.1.0 (preview)
+
+### Breaking changes
+
+* The Splunk SDK for Ruby now uses the same **.splunkrc** format as the other SDKs.
+* Moved `Service#connect` to being a static method of the `Splunk` module, so you now call connect as
+
+      service = Splunk::connect(...)
+
+  instead of
+
+      service = Splunk::Service.connect(...)
+      
+* **aloader.rb** and the `AtomResponseLoader` it contained have been replaced in their entirety by atomfeed.rb and the `AtomFeed` class it contains.
+* Changes to `Context`:
+  * Removed `Context#post`, `Context#delete`, and `Context#get`. Replaced
+  them all with `Context#request` (which takes a structured specification of
+  the resource) and `Context#request_by_url` (which takes an already
+  constructed URL to the resource).
+  * Removed the methods `Context#fullpath`, `Context#init_default`, 
+    `Context#url`, `Context#create_resource`, `Context#check_for_error_return`,
+    `Context#build_stream`, `Context#handle_key`, `Context#flatten_params`, 
+    and `Context#flatten_params_array` since simplification of the request
+    infrastructure made them unnecessary.
+  * Renamed `Context#protocol` to `Context#scheme` to match correct naming in RFC.
+* Removed the `parse` method from `Service`, since it didn't actually parse
+  the response in any useful way.
+* Changes to naming of the configuration endpoints:
+  * `ConfCollection` renamed to `ConfigurationFile` (and **conf_collection.rb** 
+  renamed to **configuration_file.rb**).
+  * `Conf` renamed to `Stanza` (and **conf.rb** renamed to **stanza.rb**).
+* `Index#submit` and `Index#attach` now take hash arguments instead of positional
+  arguments.
+* `Job#setttl` renamed to `Job#set_ttl`.
+* `Job#setpriority` renamed to `Job#set_priority`.
+* `Job#disable_preview` removed, since a working test scenario couldn't be found
+  for it.
+* `Collection`'s constructor arguments have changed.
+* `Entity`'s constructor arguments have changed.
+* `SplunkError` has been removed, and `SplunkHTTPError` has been made a direct
+  subclass of `StandardError`.
+* Deleted `SearchResults`, since it was superseded by `ResultsReader`.
+* The metaprogramming to allow fetching entries of a `Hash` via dot notation has
+  been removed. That is, `hash.key` is no longer a synonym for `hash["key"]`.
+* The `urlencode` method previously monkeypatched onto `Hash` has been removed.
+* `Service#create_collection` was removed.
+
+### New features and APIs
+
+* New examples in the **/examples** directory, showing how to:
+  * connect to Splunk
+  * manage entities in Splunk
+  * run searches and fetch their results from Splunk
+  * write data into Splunk
+* The whole SDK now handles namespaces properly, and namespaces are first class
+  objects. See the header comments of **namespace.rb** for a detailed description
+  of Splunk namespaces and their representation in this SDK.
+* All XML handling is shimmed to work with either Nokogiri or REXML. It tries
+  Nokogiri first, which can process XML vastly faster, and falls back to REXML,
+  which will be present in all Ruby installs. The user may all call
+  `require_xml_library` to force the SDK to use a Nokogiri or REXML. See
+  **xml_shim.rb** for all this behavior.
+* Added documentation throughout the SDK.
+* The unit testing suite has been completely rewritten and expanded.
+* Added a `ResultsReader` class to parse and iterate over sets of XML results from
+  search jobs.
+* Added methods to `Context`:
+  * `host`
+  * `port`
+  * `token`
+  * `username`
+  * `password`
+  * `namespace`
+  * `server_accepting_connections?`
+* `Context#restart` takes an optional timeout, and properly handles waiting for
+  Splunk to restart.
+* Added convenience methods to `Service` to create searches:
+  * `create_oneshot`
+  * `create_search`
+  * `create_stream`
+* Added methods to `Service`:
+  * `splunk_version`
+  * `saved_searches`
+* New features added to `Collection`:
+  * `Collection#each`, when called without a block, now returns an enumerator over
+    all elements in the collection.
+  * Added an optional _namespace_ argument to `Collection#delete` and
+    `Collection#fetch` so entities can be specified uniquely even in the presence
+    of name collisions.
+  * Added new methods to `Collection`, mostly designed to recapitulate the
+    relevant methods of `Hash`. In the notation below, synonym sets are separated
+    by slashes, and names in a set of synonyms that already existed are
+    surrounded by square brackets:
+    * `[contains?]/has_key?/include?/key?/member?`
+    * `[list]/values/to_a`
+    * `each_key`
+    * `each_pair`
+    * `empty?`
+    * `entity_class`
+    * `fetch/[ [] ]`
+    * `keys`
+    * `length`
+    * `resource`
+    * `service`
+* Added methods to `Entity`. In the notation below, synonym sets are separated
+  by slashes, and names in a set of synonyms that already existed are
+  surrounded by square brackets:
+  * `content`
+  * `delete`
+  * `fetch/[ [] ]`
+  * `links`
+  * `namespace`
+  * `refresh`
+  * `resource`
+  * `service`
+* Entities now cache their state. To update the cache, call the entity's `refresh`
+  method.
+* `Index#clean` takes a timeout instead of waiting forever. If no timeout is
+  specified, a default value will be used.
+* Added new methods to `Job`. In the notation below, synonym sets are separated
+  by slashes, and names in a set of synonyms that already existed are
+  surrounded by square brackets:
+  * `control`
+  * `is_done?`
+  * `is_ready?`
+  * `sid`
+* Added saved search support, accessible via `Service#saved_searches`. `SavedSearch`
+  entities have the following additional methods beyond `Entity`:
+  * `dispatch`
+  * `history`
+* Added the following methods to `Stanza` (was: `Conf`). In the notation below, synonym sets are separated by slashes, and names in a set of synonyms that already existed are surrounded by square brackets:
+  * `length`
+  * `update/[submit]`
+* Added new custom exceptions:
+  * `AmbiguousEntityReference`, for when a fetch of an entity by name would
+    return multiple entities due to name collisions.
+  * `EntityNotReady`, raised when a program tries to fetch the state of an entity
+    which is queued for creation, but not yet created, such as a search job that
+    is not yet ready.
+  * `IllegalOperation`, raised by a program when an operation known statically not
+    to work, such as deleting an index on Splunk 4.x, is called.
+
+### Architectural changes
+
+* `Job` is now a subclass of `Entity`.
+* `Service` is now a subclass of `Context` instead of including the `Context` as
+  an instance variable. 
+* Removed dependence of `Context` (and the SDK) on the libraries `netrc`, `pathname`,
+  and `rest-client`. Now it uses only the standard library plus (optionally)
+  Nokogiri.
+* Reorganized directory structure of the SDK.
+  * The contents of `lib/splunk-sdk-ruby/client/` have been moved to
+    `lib/splunk-sdk-ruby`, and **client.rb** has been deleted.
+  * **jobs.rb** was moved to `lib/splunk-sdk-ruby/collection/`
+  * **job.rb** was moved to `lib/splunk-sdk-ruby/entity/`
+* Made all unit test filenames start with **test_** instead of **tc_**.
+
+

data/Gemfile

@@ -0,0 +1,8 @@
+source :rubygems
+# 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.
+# See http://youtrack.jetbrains.com/issue/RUBY-11922
+gem 'test-unit', :require => false
+gem 'nokogiri', :require => true
+gemspec

data/LICENSE

@@ -0,0 +1,177 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS

data/README.md

@@ -0,0 +1,310 @@
+# The Splunk Software Development Kit for Ruby (Preview Release)
+
+#### Version 0.1
+This Splunk Software Development Kit (SDK) contains library code and examples
+designed to enable developers to build applications using Splunk.
+
+Splunk is a search engine and analytic environment that uses a distributed
+map-reduce architecture to efficiently index, search, and process large 
+time-varying data sets.
+
+The Splunk product is popular with system administrators for aggregation and
+monitoring of IT machine data, security, compliance, and a wide variety of 
+other scenarios that share a requirement to efficiently index, search, analyze,
+and generate real-time notifications from large volumes of time series data.
+
+The Splunk developer platform enables developers to take advantage of the 
+same technology used by the Splunk product to build exciting new applications
+that are enabled by Splunk's unique capabilities.
+
+1.  This Preview release is pre-beta, and therefore is incomplete and may have 
+    bugs. A Beta release is planned prior to a general release. 
+
+2.  The Apache license only applies to this SDK and no other software provided 
+    by Splunk.
+
+3.  Splunk, in using the Apache license, is not providing any warranties or 
+    indemnification, or accepting any liabilities with the Preview of this SDK.
+
+## Getting started with the Splunk SDK for Ruby
+
+The Splunk SDK for Ruby contains code and some examples that show how to
+programmatically interact with Splunk for a variety of scenarios, including
+searching, saved searches, configuration, and many more. This SDK is still 
+in progress and is missing features such as inputs. Stay tuned.
+
+
+### Requirements
+
+Here's what you need to get going with the Splunk SDK for Ruby.
+
+#### Splunk
+
+If you haven't already installed Splunk, download it 
+[here](http://www.splunk.com/download). For more information about installing 
+and running Splunk and system requirements, see 
+[Installing & Running Splunk](http://dev.splunk.com/view/SP-CAAADRV).
+
+#### Ruby
+
+The Splunk SDK for Ruby requires Ruby 1.9.2 or later.
+
+#### Splunk SDK for Ruby
+
+Get the Splunk SDK for Ruby from [GitHub](https://www.github.com) and clone the
+resources to your computer. Use the following command:
+
+    git clone https://github.com/splunk/splunk-sdk-ruby.git    
+
+You can also download the SDK as a ZIP file, or install it directly (see below). 
+
+
+### Installing the Splunk SDK for Ruby
+
+If you have cloned the Splunk SDK for Ruby from GitHub, you should first
+install the latest version of `rake`. For example, open a command prompt and 
+enter the following:
+
+    gem install rake
+
+Then you can install the Splunk SDK for Ruby by running the following
+command from the root of the repository (**/splunk-sdk-ruby**):
+
+    rake install
+
+Or, install the Splunk SDK for Ruby directly from RubyGems,
+without cloning the repository or downloading the ZIP file, by running:
+
+    gem install splunk-sdk-ruby
+
+If you are using the Splunk SDK for Ruby in an application, we highly
+recommend that you use [bundler](http://gembundler.com/), which installs
+the prerequisites when you deploy your application. Add the following 
+line to your application's Gemfile to make bundler aware of the Splunk 
+SDK for Ruby:
+
+    gem 'splunk-sdk-ruby'
+
+Then run the following command to install all of your application's
+dependencies, including the Splunk SDK for Ruby:
+
+    bundle
+
+#### Examples
+
+Examples are located in several locations within the Splunk SDK for Ruby:
+
+* The **/splunk-sdk-ruby/examples/** directory
+* Inline with the source code within the SDK
+* In the documentation on the [Splunk Developer Portal](http://dev.splunk.com/view/ruby-sdk/SP-CAAAENQ).
+
+#### Prepare for the unit tests
+
+First, do not run the test suite against your production Splunk server! Install
+another copy of Splunk and run the test suite against that.
+
+Second, update your installations of both the [Rake](http://rake.rubyforge.org) 
+build tool and the [Test::Unit](http://test-unit.rubyforge.org) unit 
+test framework from RubyGems:
+
+    gem install rake
+    gem install test-unit
+
+The test suite reads the host to connect to and credentials to use from a
+**.splunkrc** file. To connect to Splunk, all of the SDK examples and unit
+tests take command-line arguments that specify values for the host, port,
+and login credentials for Splunk. For convenience during development, you
+can store these arguments as key-value pairs in a text file named 
+**.splunkrc**. Then, when you don't specify these arguments at the command
+line, the SDK examples and unit tests use the values from the .splunkrc file.
+
+**To set up a .splunkrc file**
+
+1. Create a text file with the following format:
+
+    <pre> # Splunk host (default: localhost)
+    host=localhost
+    # Splunk admin port (default: 8089)
+    port=8089
+    # Splunk username
+    username=admin
+    # Splunk password
+    password=changeme
+    # Access scheme (default: https)
+    scheme=https
+    # Your version of Splunk (default: 5.0)
+    version=5.0</pre>
+
+2. Save the file as .splunkrc in the current user's home directory.
+
+**On Mac OS X**
+
+Save the file as:
+
+    ~/.splunkrc
+
+**On Windows**
+
+Save the file as:
+
+    C:\Users\[currentusername]\.splunkrc
+
+You might get errors in Windows when you try to name the file because 
+".splunkrc" looks like a nameless file with an extension. You can use 
+the command line to create this file; go to the 
+**C:\Users\\[currentusername]\\** directory and enter the following command:
+
+    Notepad.exe .splunkrc
+    
+Click **Yes**, then continue creating the file.
+
+**Notes**
+
+* Storing login credentials in the .splunkrc file is only for 
+  convenience during development; this file isn't part of the 
+  Splunk platform and shouldn't be used for storing user credentials
+  for production. And, if you're at all concerned about the security 
+  of your credentials, just enter them at the command line and don't 
+  bother using the .splunkrc file.
+* The format of the .splunkrc file has changed between releases. If 
+  you are using a preview or beta version of the SDK, some of the 
+  newer fields might not be recognized and you might see errors while
+  running the examples. You can either update to the latest version
+  of the SDK, or comment out the <tt>app</tt>, <tt>owner</tt>, and 
+  <tt>version</tt> fields.
+* The <tt>version</tt> field is only used by the Splunk SDK for JavaScript.
+
+#### Run the unit tests
+
+In the base directory where you installed the Splunk SDK for Ruby, run
+
+    rake test
+
+It should run many tests without error.
+
+To generate code coverage of the test suite, first ensure you've installed
+the latest version of [SimpleCov](http://rubygems.org/gems/simplecov): 
+
+    gem install simplecov
+
+To generate the code coverage, run:
+
+    rake test COVERAGE=true
+
+It will produce a directory called **coverage**. Open coverage/index.html to
+see the coverage report.
+
+**Note**: To protect your Splunk password, you may want to delete the .splunkrc 
+file when you are done running the unit tests.
+
+## Repository
+
+<table>
+
+<tr>
+<tr>
+<td><b>/examples</b></td>
+<td>Examples demonstrating various SDK features</td>
+</tr>
+
+<tr>
+<td><b>/lib</b></td>
+<td>Source for the Splunk library modules</td>
+</tr>
+
+<tr>
+<td><b>/test</b></td>
+<td>Source for unit tests</td>
+</tr>
+
+</table>
+
+### Changelog
+
+The **CHANGELOG.md** file in the root of the repository contains a description
+of changes for each version of the SDK. You can also find it online at
+[https://github.com/splunk/splunk-sdk-ruby/blob/master/CHANGELOG.md](https://github.com/splunk/splunk-sdk-ruby/blob/master/CHANGELOG.md).
+
+### Branches
+
+The **master** branch always represents a stable and released version of the SDK.
+
+## Documentation and resources
+
+If you need to know more: 
+
+* For all things developer with Splunk, your main resource is the [Splunk Developer Portal](http://dev.splunk.com).
+
+* For conceptual and how-to documentation, see the [Overview of the Splunk SDK for Ruby](http://dev.splunk.com/view/SP-CAAAENQ).
+
+* For API reference documentation, see the [Splunk SDK for Ruby Reference](http://docs.splunk.com/Documentation/RubySDK).
+
+* For more about the Splunk REST API, see the [REST API Reference](http://docs.splunk.com/Documentation/Splunk/latest/RESTAPI).
+
+* For more about about Splunk in general, see [Splunk>Docs](http://docs.splunk.com/Documentation/Splunk).
+
+* For more about this SDK's repository, see our [GitHub Wiki](https://github.com/splunk/splunk-sdk-ruby/wiki/).
+
+## Community
+
+<table>
+
+<tr>
+<td><b>Email</b></td>
+<td><a href="mailto:devinfo@splunk.com">devinfo@splunk.com</a></td>
+</tr>
+
+<tr>
+<td><strong>Forum</strong></td>
+<td><a href="https://groups.google.com/forum/#!forum/splunkdev">https://groups.google.com/forum/#!forum/splunkdev</a>
+</tr>
+
+<tr>
+<td><b>Issues</b>
+<td><a href="https://github.com/splunk/splunk-sdk-ruby/issues/">https://github.com/splunk/splunk-sdk-ruby/issues/</a></td>
+</tr>
+
+<tr>
+<td><b>Answers</b>
+<td><a href="http://splunk-base.splunk.com/tags/ruby/">http://splunk-base.splunk.com/tags/ruby/</a></td>
+</tr>
+
+<tr>
+<td><b>Blog</b>
+<td><a href="http://blogs.splunk.com/dev/">http://blogs.splunk.com/dev/</a></td>
+</tr>
+
+<tr>
+<td><b>Twitter</b>
+<td><a href="http://twitter.com/#!/splunkdev">@splunkdev</a></td>
+</tr>
+
+</table>
+
+### How to contribute
+
+If you would like to contribute to the SDK, go here for more information:
+
+* [Splunk and open source](http://dev.splunk.com/view/opensource/SP-CAAAEDM)
+
+* [Individual contributions](http://dev.splunk.com/goto/individualcontributions)
+
+* [Company contributions](http://dev.splunk.com/view/companycontributions/SP-CAAAEDR)
+
+### 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).
+
+### Contact Us
+
+You can reach the Dev Platform team at <a href="mailto:devinfo@splunk.com">
+devinfo@splunk.com</a>.
+
+## License
+
+The Splunk Software Development Kit for Ruby is licensed under the Apache
+License 2.0. Details can be found in the LICENSE file.