splunker 0.0.0

data/spec/rspec_let_definitions.rb

@@ -0,0 +1,15 @@
+module Splunker
+  module RspecLetDefinitions
+    def self.included(base)
+      base.let(:client) {
+        Splunker.client(
+          :auth_mode => :http_auth,
+          :endpoint  => "https://127.0.0.1",
+          :username  => "tido",
+          :password  => "12345",
+          :app       => "search" 
+        )
+      }
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+require 'rspec'
+require 'splunker'
+require 'rspec_let_definitions'
+
+RSpec.configure do |config|
+  config.color_enabled = true
+  config.formatter     = 'documentation'
+  config.include Splunker::RspecLetDefinitions
+end

data/spec/unit/auth/http_auth_spec.rb

@@ -0,0 +1,68 @@
+require 'spec_helper'
+
+describe Splunker::Auth::HttpAuth do
+  let(:request_handler) do
+    Splunker::Auth::HttpAuth.new(client)
+  end
+
+  context "configuration" do
+    it "should have a valid configuratoin if username and password are present" do
+      request_handler.configuration_valid?.should be_true
+    end
+
+    it "should have an invalid configuration if either username or password are missing" do
+      request_handler.stub(:configuration).and_return({})
+      request_handler.configuration_valid?.should be_false
+
+      request_handler.stub(:configuration).and_return({:username => "tido"})
+      request_handler.configuration_valid?.should be_false
+
+      request_handler.stub(:configuration).and_return({:password => "12345"})
+      request_handler.configuration_valid?.should be_false
+    end
+
+    it "should raise an error when verifying configuration if invalid" do
+      request_handler.verify_configuration!
+      request_handler.stub(:configuration_valid?).and_return(false)
+      expect {
+        request_handler.verify_configuration!
+      }.to raise_error(Splunker::Errors::ConfigurationError)
+    end
+  end
+
+  context "connection handling" do
+    before(:all) do
+      @fake_connection = HttpAuthSpecConnection.new
+    end
+
+    it "should decorate a connection object with basic auth credentials" do
+      request_handler.authenticate_connection(@fake_connection)
+      @fake_connection.username.should eq("tido")
+    end
+
+    it "should not reconfigure a configured connection" do
+      request_handler.authenticate_connection(@fake_connection) # Configure with "tido"
+
+      request_handler.stub(:configuration).and_return({:username => "Ned", :password => "abcdefg"})
+      request_handler.authenticate_connection(@fake_connection)
+      @fake_connection.username.should eq("tido")
+    end
+
+    it "should reconfigure a configured connection after resetting" do
+      request_handler.authenticate_connection(@fake_connection) # configure with "tido"
+
+      request_handler.stub(:configuration).and_return({:username => "Ned", :password => "abcdefg"})
+      request_handler.reset  
+      request_handler.authenticate_connection(@fake_connection)
+      @fake_connection.username.should eq("Ned")
+    end
+  end
+end
+
+class HttpAuthSpecConnection
+  attr_accessor :username, :password
+  def basic_auth(username, password)
+    self.username = username
+    self.password = password
+  end
+end

data/spec/unit/auth/splunk_auth_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+describe Splunker::Auth::SplunkAuth do
+  let(:request_handler) do
+    Splunker::Auth::SplunkAuth.new(client)
+  end
+
+  context "configuration" do
+    it "should not be configured by default" do
+      request_handler.configured?.should be_false
+    end
+
+    it "should have access to client configuration" do
+      request_handler.configuration.should be_a(Hash)
+    end
+    
+    it "should raise exception when verifying configuration if invalid" do
+      request_handler.verify_configuration!
+      request_handler.stub(:configuration_valid?).and_return(false)
+      expect {
+        request_handler.verify_configuration!
+      }.to raise_error(Splunker::Errors::ConfigurationError)
+    end
+
+    it "should have a valid configuration by default" do
+      request_handler.configuration_valid?.should be_true
+    end
+  end
+end

data/spec/unit/client_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+describe Splunker::Client do
+  context "initialization" do
+    it "should be configurable" do
+      client.endpoint.should eq("https://127.0.0.1")
+    end
+  end
+
+  context "requests" do
+    it "should pass methods to request handler" do 
+      expect {
+        client.get
+      }.to raise_error ArgumentError
+    end
+
+    it "should respond to methods handled by request handler" do
+      client.respond_to?(:get).should be_true
+    end
+  end
+end

data/spec/unit/configuration_spec.rb

@@ -0,0 +1,23 @@
+describe Splunker::Configuration do
+  class MyConfigurableClass
+    include Splunker::Configuration
+  end
+  
+  let(:configurable) { MyConfigurableClass.new }
+
+  it "should set accessors" do
+    configurable.respond_to?(:endpoint=).should be_true
+  end
+
+  it "should set return a default configuration" do
+    configurable.reset
+    configurable.configuration[:app].should eq("search")
+  end
+
+  it "should be configurable" do
+    configurable.configure do |c|
+      c.username = "fred" 
+    end
+    configurable.username.should eq("fred")
+  end
+end

data/spec/unit/errors_spec.rb

@@ -0,0 +1,21 @@
+describe Splunker::Errors do
+  context ".raise_error_for_status" do
+    it "should raise no error for a 200..299 status" do
+      Splunker::Errors.raise_error_for_status!(200, "")
+      Splunker::Errors.raise_error_for_status!(201, "")
+      Splunker::Errors.raise_error_for_status!(299, "")
+    end
+
+    it "should raise a status from the map when there is a match" do
+      expect { 
+        Splunker::Errors.raise_error_for_status!(401, "") 
+      }.to raise_error(Splunker::Errors::AuthenticationFailureError)
+    end
+
+    it "should raise a generic error when status in 200..299 range" do
+      expect { 
+        Splunker::Errors.raise_error_for_status!(504, "") 
+      }.to raise_error(Splunker::Errors::ClientError)
+    end
+  end
+end

data/spec/unit/splunker_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+describe "Splunker" do
+  it "should create a new class if options are specified" do
+    Splunker.client(:endpoint => "https://127.0.0.2").should_not be(client)
+  end
+
+  it "should reuse the existing class if no options are specified" do
+    Splunker.client(:endpoint => "https://127.0.0.3").should be(Splunker.client)
+  end
+
+  it "should call methods on the client object" do
+    client.configuration[:endpoint].should eq("https://127.0.0.1")
+  end
+end

data/splunker.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/splunker/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Joshua Murray"]
+  gem.email         = ["joshua.murray@gmail.com"]
+  gem.description   = %q{A Ruby client for the Splunk API}
+  gem.summary       = %q{A Ruby client for the Splunk API}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "splunker"
+  gem.require_paths = ["lib"]
+  gem.version       = Splunker::VERSION
+
+  gem.add_dependency "nokogiri"
+  gem.add_dependency "faraday"
+  gem.add_development_dependency "rspec", "~> 2.11"
+  gem.add_development_dependency "rake", "~> 0.9.2"
+  gem.add_development_dependency "webmock"
+end

metadata

@@ -0,0 +1,170 @@
+--- !ruby/object:Gem::Specification
+name: splunker
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Joshua Murray
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-09-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A Ruby client for the Splunk API
+email:
+- joshua.murray@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- VERSION
+- lib/splunker.rb
+- lib/splunker/auth.rb
+- lib/splunker/auth/http_auth.rb
+- lib/splunker/auth/splunk_auth.rb
+- lib/splunker/auth/token_auth.rb
+- lib/splunker/cli.rb
+- lib/splunker/cli/setup.rb
+- lib/splunker/client.rb
+- lib/splunker/configuration.rb
+- lib/splunker/connection.rb
+- lib/splunker/errors.rb
+- lib/splunker/faraday_middleware.rb
+- lib/splunker/models/finders.rb
+- lib/splunker/models/resource.rb
+- lib/splunker/models/search/jobs.rb
+- lib/splunker/models/search/results.rb
+- lib/splunker/models/search/saved.rb
+- lib/splunker/request.rb
+- lib/splunker/version.rb
+- script/console
+- spec/fixtures/search_results_from_job.xml
+- spec/rspec_let_definitions.rb
+- spec/spec_helper.rb
+- spec/unit/auth/http_auth_spec.rb
+- spec/unit/auth/splunk_auth_spec.rb
+- spec/unit/client_spec.rb
+- spec/unit/configuration_spec.rb
+- spec/unit/errors_spec.rb
+- spec/unit/splunker_spec.rb
+- splunker.gemspec
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: A Ruby client for the Splunk API
+test_files:
+- spec/fixtures/search_results_from_job.xml
+- spec/rspec_let_definitions.rb
+- spec/spec_helper.rb
+- spec/unit/auth/http_auth_spec.rb
+- spec/unit/auth/splunk_auth_spec.rb
+- spec/unit/client_spec.rb
+- spec/unit/configuration_spec.rb
+- spec/unit/errors_spec.rb
+- spec/unit/splunker_spec.rb