splunker 0.0.0

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+*.swp
+.bundle
+.config
+.yardoc
+vendor/bundle
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in splunker.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Joshua Murray
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,38 @@
+# Splunker 
+
+A Ruby client for the [RESTful Splunk API](http://dev.splunk.com/view/rest-api-overview/SP-CAAADP8)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'splunker'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install splunker
+
+## Usage
+
+Models are on there way, but you can access resources by directly invoking the
+HTTP helper methods.
+
+# Basic Auth
+    c = Splunker.client(:auth_mode => :http_auth, :username => "MYUSERNAME", 
+      :password => "MYPASSWORD", :endpoint => "https://splunk.mysite.com")
+    # Returns Nokogiri::XML::Document 
+    r = c.get("/servicesNS/joshua/search/saved/searches/MySearch/history")
+    # Process away
+    r.xpath("...")
+    
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,5 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new('spec')

data/VERSION

@@ -0,0 +1 @@
+0.0.0

data/lib/splunker.rb

@@ -0,0 +1,37 @@
+require 'logger'
+require "splunker/version"
+require "splunker/client"
+require "splunker/errors"
+
+module Splunker
+  def self.client(options={})
+    unless options.empty?
+      Thread.current[:splunker_client] = Splunker::Client.new(options)
+    end
+
+    Thread.current[:splunker_client] 
+  end
+
+  def self.logger
+    if @logger.nil?
+      @logger = Logger.new(STDOUT)
+      @logger.level = Logger::INFO
+    end 
+    @logger
+  end
+
+  def self.logger=(custom_logger)
+    @logger = custom_logger
+  end
+  
+  def self.method_missing(method,*args,&block)
+    if self.client.respond_to?(method)
+      return self.client.send(method,*args,&block)
+    end
+    super
+  end
+  
+  def self.respond_to?(method)
+    self.client.respond_to?(method) || super
+  end
+end

data/lib/splunker/auth.rb

@@ -0,0 +1,18 @@
+require 'splunker/request'
+require 'splunker/auth/splunk_auth'
+Dir[File.dirname(__FILE__) + '/auth/*.rb'].each do |file| 
+  next if file.match("splunk_auth")
+  require file 
+end
+
+module Splunker
+  module Auth
+    def self.create(auth_type, configuration)
+      if (obj = Splunker::Auth.const_get("#{auth_type}".split('_').collect(&:capitalize).join))
+        obj.new(configuration)
+      else
+        raise ArgumentError, "Unknown auth type of #{auth_type}"
+      end
+    end
+  end
+end

data/lib/splunker/auth/http_auth.rb

@@ -0,0 +1,24 @@
+module Splunker
+  module Auth
+    class HttpAuth < SplunkAuth
+      def authenticate_connection(conn)
+        return if self.configured?
+        conn.basic_auth(configuration[:username],
+                        configuration[:password])
+        @configured = true
+      end
+
+      def configuration_valid?
+        !configuration[:username].nil? &&
+          !configuration[:password].nil?
+      end
+
+      def verify_configuration!
+        unless configuration_valid?
+          raise Splunker::Errors::ConfigurationError, 
+            "HttpAuth requires both :username and :password configuration options be set"
+        end
+      end
+    end
+  end
+end

data/lib/splunker/auth/splunk_auth.rb

@@ -0,0 +1,48 @@
+module Splunker
+  module Auth
+    class SplunkAuth
+      include Splunker::Request
+
+      attr_accessor :client
+      attr_reader :configured
+
+      # Parameters:
+      # * client => An instance of Splunker::Client
+      def initialize(client)
+        self.client = client
+      end
+
+      # A helper method to access the client's configuration.
+      # Returns:
+      # * A Hash of the client's current configuration settings.
+      def configuration
+        self.client.configuration
+      end
+
+      # Child classes must implement their own logic to determine when
+      # @configured is set to true.
+      def configured?
+        @configured == true
+      end
+
+      # Raises Splunker::Errors::ConfigurationError if configuration_valid?
+      # returns false.
+      def verify_configuration!
+        unless configuration_valid?
+          raise Splunker::Errors::ConfigurationError
+        end
+      end
+
+      # By default, always returns true
+      # Child classes must implement their own logic to determine when
+      # the client's configuration is invalid for its needs.
+      def configuration_valid?
+        true
+      end
+
+      def reset
+        @configured = false
+      end
+    end
+  end
+end

data/lib/splunker/auth/token_auth.rb

@@ -0,0 +1,7 @@
+module Splunker
+  module Auth
+    class TokenAuth < SplunkAuth
+
+    end
+  end
+end

data/lib/splunker/cli.rb

@@ -0,0 +1,89 @@
+require 'optparse'
+
+if ENV["SPLUNKER_CONSOLE"].nil?
+  require 'splunker'
+else
+  puts "Enabling console mode for local gem"
+  Bundler.require(:default, "development") if defined?(Bundler)
+  path = File.expand_path(File.dirname(__FILE__) + "/../../lib/")
+  $LOAD_PATH.unshift(path) unless $LOAD_PATH.include?(path)
+  require path + '/splunker'
+end
+
+module Splunker
+  module CLI
+    class ConsoleCLI
+
+      OPTIONS_ENV = {
+        :debug=> "DEBUG",
+        :console => "SPLUNKER_CONSOLE"
+      }
+
+      def self.execute(stdout, arguments=[])
+        options = setup_options(stdout,arguments)
+
+        libs =  " -r irb/completion"
+        setup = " -r #{File.dirname(__FILE__) + '/../../lib/splunker/cli/setup.rb'}"
+
+        bundler = (options[:console] ? "bundle exec" : "")  
+        cmd = "#{export_env(options)} #{bundler} #{irb} #{libs} #{setup} --simple-prompt"
+        puts "Loading splunker gem..."
+        exec "#{cmd}"
+      end
+      
+      def self.irb()
+        RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
+      end
+
+      private
+
+      def self.setup_options(stdout,arguments)
+        env_options = {
+          :console => ENV[OPTIONS_ENV[:console]]
+        }
+        cli_options = {}
+        file_options = {}
+        parser = OptionParser.new do |opts|
+          opts.banner = <<-BANNER.gsub(/^          /,'')
+            #{version}
+            Splunk Client Console
+
+            Proudly copied from Wade Mcewen's CLI code from the spark_api client.
+            
+            Usage: #{File.basename($0)} [options]
+            
+            Environment Variables: some options (as indicated below), will default to values of keys set in the environment. 
+        
+            Options are:
+          BANNER
+          opts.separator ""
+          opts.on("-e","--endpoint ENDPOINT",
+                  "URI of the API.",
+                  "Default: ENV['#{OPTIONS_ENV[:endpoint]}']") { |arg| cli_options[:endpoint] = arg }
+
+                    
+          opts.on("-v", "--version",
+                  "Show client version.") { stdout.puts version; exit }
+          opts.on("-h", "--help",
+                  "Show this help message.") { stdout.puts opts; exit }
+          opts.parse!(arguments)
+        
+        end
+        options = env_options.merge(file_options.merge(cli_options))
+        return options
+      end
+
+      def self.export_env(options)
+        run_env = ""
+        OPTIONS_ENV.each do |k,v|
+          run_env << " #{v}=\"#{options[k]}\"" unless options[k].nil?
+        end
+        run_env
+      end
+
+      def self.version
+        "Splunker v#{Splunker::VERSION}"
+      end
+    end
+  end
+end

data/lib/splunker/cli/setup.rb

@@ -0,0 +1,18 @@
+require "rubygems"
+require 'pp'
+require 'irb/ext/save-history'
+require 'splunker'
+
+IRB.conf[:SAVE_HISTORY] = 1000
+IRB.conf[:HISTORY_FILE] = "#{ENV['HOME']}/.splunker-history"
+
+
+IRB.conf[:AUTO_INDENT]=true
+IRB.conf[:PROMPT][:SPLUNKER]= {
+  :PROMPT_I => "Splunker:%03n:%i> ",
+  :PROMPT_S => "Splunker:%03n:%i%l ",
+  :PROMPT_C => "Splunker:%03n:%i* ",
+  :RETURN => "%s\n"
+} 
+
+IRB.conf[:PROMPT_MODE] = :SPLUNKER

data/lib/splunker/client.rb

@@ -0,0 +1,27 @@
+require 'splunker/configuration'
+require 'splunker/auth'
+
+module Splunker
+  class Client
+    include Configuration
+
+    def initialize(options={})
+      self.reset
+
+      (Configuration::MUTABLE_IMPLEMENTED_OPTION_KEYS + Configuration::MUTABLE_OPTION_KEYS).each do |key|
+        self.send "#{key}=", options[key] if options.include?(key)
+      end
+    end
+
+    def method_missing(method,*args,&block)
+      if self.request_handler.respond_to?(method)
+        return self.request_handler.send(method,*args,&block)
+      end
+      super
+    end
+    
+    def respond_to?(method)
+      self.request_handler.respond_to?(method) || super
+    end
+  end
+end

data/lib/splunker/configuration.rb

@@ -0,0 +1,47 @@
+module Splunker
+  module Configuration
+    MUTABLE_OPTION_KEYS = [:endpoint, :username, :password, :app, :ssl_verify]
+    # These options are mutable, but their setters are manually implemented
+    MUTABLE_IMPLEMENTED_OPTION_KEYS = [:auth_mode]
+    READONLY_OPTION_KEYS = [:request_handler]
+
+    DEFAULT_ENDPOINT = "https://localhost:8089"
+    DEFAULT_APP_NAME = "search"
+    DEFAULT_SSL_VERIFY = true
+
+    def self.included(base)
+      base.class_eval do
+        attr_accessor *MUTABLE_OPTION_KEYS
+        attr_reader *MUTABLE_IMPLEMENTED_OPTION_KEYS
+        attr_reader *READONLY_OPTION_KEYS
+      end
+    end
+
+    def configure
+      yield self
+    end
+    
+    def configuration
+      MUTABLE_OPTION_KEYS.inject({}) do |conf,key|
+        conf.merge!(key=>self.send(key))
+      end
+    end
+
+    def auth_mode=(mode)
+      @request_handler = if mode.nil?
+                           nil
+                         else
+                           Auth.create(mode, self)
+                         end
+    end
+    
+    def reset
+      self.endpoint = DEFAULT_ENDPOINT
+      self.app = DEFAULT_APP_NAME
+      self.ssl_verify = DEFAULT_SSL_VERIFY
+      self.auth_mode = nil
+      @username = @password = nil
+      self.request_handler.reset unless self.request_handler.nil?
+    end
+  end
+end

data/lib/splunker/connection.rb

@@ -0,0 +1,28 @@
+require 'faraday'
+require 'splunker/faraday_middleware'
+
+module Splunker
+  module Connection
+    def reset
+      @connection = nil
+    end
+
+    def connection
+      if self.configuration[:endpoint].nil?
+        raise ConfigurationError, "No endpoint set!"
+      end
+
+      opts = {
+        :url => self.configuration[:endpoint] 
+      }
+      opts[:ssl] = {:verify => false} if !self.configuration[:ssl_verify]
+
+      @connection ||= Faraday.new(opts) do |c|
+        c.use Faraday::Request::UrlEncoded  
+        c.use Faraday::Response::Logger
+        c.use Faraday::Adapter::NetHttp
+        c.use Splunker::FaradayMiddleware
+      end
+    end
+  end
+end