sumo-search 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a8e3759e39a03e8a3fceef78e0bf775275c35901
+  data.tar.gz: 193be08aa43cc6aebe1281606d6e24034a10900b
+SHA512:
+  metadata.gz: f513e2bdb1b53414aba48a4838de8320713d7425a209dde25535e9803b6a97b0ca3ca6ed8e90136da45707e24c696d42debc9f66b8bf3e6801e656a6ee48c397
+  data.tar.gz: f883c5490d9810001a7159fb3d9467dd7e7da03bf4ee9ef67e2184e1f86a42b02a496aad2efbd9765d8d355972373ae1e1092571072df30ab24ad269595cb109

data/.gitignore

@@ -0,0 +1,6 @@
+.DS_Store
+*.swp
+*.gem
+Gemfile.lock
+coverage/
+.rbenv-version

data/Gemfile

@@ -0,0 +1,3 @@
+source 'http://rubygems.org'
+
+gemspec

data/README.md

@@ -0,0 +1,44 @@
+# sumo-search
+
+This library can be used to query Sumo Logic's search API.
+
+## Installation
+
+From the command line:
+
+```shell
+$ sudo gem install sumo-search
+```
+
+Installing this gem will install a script called `sumo`.
+Note that this gem requires a Ruby version of at least 2.0.0.
+
+## Configuration
+
+To use this script, you must supply your Sumo Logic credentials.
+The script can read credentials from one of two places; either an environment variable or a configuration file.
+The environment variable is `SUMO_CREDS`, and the configuration file is `~/.sumo_creds`.
+Whichever you choose, the credentials must be in the following format:
+
+```
+username@website:password
+```
+
+## Usage
+
+```shell
+$ sumo [*options/flags*]
+```
+
+This script wraps the [Sumo Search API](https://github.com/SumoLogic/sumo-api-doc/wiki/search-api).
+The API only has one endpoint, `/api/v1/logs/search` which searches your logs.
+
+| Command Line Option    | Corresponding Query Parameter | Description                          |
+|------------------------|-------------------------------|--------------------------------------|
+| -q, --query QUERY      | q                             | The query to search (required)       |
+| -f, --from START       | from                          | Begin searching at START (ISO8601)   |
+| -t, --to END           | to                            | Finish searching at END (ISO8601)    |
+| -z, --time-zone ZONE   | tz                            | The timezone of the search           |
+| -c, --config-file FILE | -                             | Use the specified config file        |
+| -e, --extract-key KEY  | -                             | Extract the given key from your logs |
+| -h, --help             | -                             | Display the help message             |

data/Rakefile

@@ -0,0 +1,11 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), 'lib'))
+
+require 'rake'
+require 'sumo'
+require 'rspec/core/rake_task'
+require 'cane/rake_task'
+
+task :default => [:spec, :quality]
+
+RSpec::Core::RakeTask.new(:spec) { |t| t.pattern = 'spec/**/*_spec.rb' }
+Cane::RakeTask.new(:quality) { |t| t.canefile = '.cane' }

data/bin/sumo

@@ -0,0 +1,68 @@
+#!/usr/bin/ruby
+
+require 'sumo'
+require 'time'
+require 'optparse'
+
+include Sumo
+
+options = {
+  :query_options => {},
+  :config_file => DEFAULT_CONFIG_FILE,
+  :key => nil
+}
+
+OptionParser.new do |opts|
+  opts.banner = 'Usage: sumo [flags/options]'
+
+  opts.separator ''
+  opts.separator 'Specific options:'
+
+  opts.on('-q', '--query QUERY', 'Search for QUERY (required)') do |q|
+    options[:query] = q
+  end
+
+  opts.on('-f', '--from START', 'Begin at the given ISO8601 time') do |f|
+    options[:query_options]['from'] = f
+  end
+
+  opts.on('-t', '--to END', 'Finish at the given ISO8601 time') do |t|
+    options[:query_options]['to'] = t
+  end
+
+  opts.on('-z', '--time-zone ZONE', 'Use the given time zone') do |tz|
+    options[:query_options]['tz'] = tz
+  end
+
+  opts.on('-c', '--config-file FILE',
+          "Use the given config file instead of #{DEFAULT_CONFIG_FILE}") do |f|
+    options[:config_file] = config_file
+  end
+
+  opts.on('-e', '--extract-key KEY', 'Extract the specified key') do |k|
+    options[:key] = k
+  end
+
+  opts.on('-h', '--help', 'Print this message') do
+    puts opts
+    exit 0
+  end
+end.parse!
+
+if __FILE__ == $0
+  if options[:query].nil?
+    puts 'Please specify a query'
+    exit 1
+  else
+    begin
+      puts search(options[:query],
+                  options: options[:query_options],
+                  key: options[:key],
+                  config_file: options[:config_file])
+      exit 0
+    rescue StandardError => ex
+      puts ex.message
+      exit 1
+    end
+  end
+end

data/lib/sumo.rb

@@ -0,0 +1,28 @@
+require 'base64'
+require 'excon'
+require 'json'
+
+# This module acts as a namespace, and contains a `.search` method which ties
+# together functionality of its child modules.
+module Sumo
+  autoload :Config, 'sumo/config'
+  autoload :Error, 'sumo/error'
+  autoload :Formatter, 'sumo/formatter'
+  autoload :QueryBuilder, 'sumo/query_builder'
+
+  # Unless otherwise specified in the initializer, the configuration file
+  # defaults to '~/.sumo_creds'.
+  DEFAULT_CONFIG_FILE = File.expand_path('~/.sumo_creds').freeze
+
+  # Search the given query. If any options are supplied, those are sent to the
+  # QueryBuilder. If the key is supplied, that key will be attempted to be
+  # extracted from the JSON response. If a config_file is supplied, that will
+  # be read instead of the default.
+  def search(query, options: {}, key: nil, config_file: DEFAULT_CONFIG_FILE)
+    creds = Config.new(config_file).load_config!
+    response = QueryBuilder.new(creds, options.merge('q' => query)).execute
+    formatted = Formatter.format_json(response)
+    key.nil? ? formatted : Formatter.extract_key(key, formatted)
+  end
+  module_function :search
+end

data/lib/sumo/config.rb

@@ -0,0 +1,55 @@
+# This class contains the logic to find the user's credentials in either an
+# environment variable or a configuration file. If both exist and a
+# configuration file has not been specified, the environment variable is
+# preferred. If both exist and a config file has been specified, the config
+# file is preferred.
+#
+# The environment varibale is called 'SUMO_CREDS'; the default configuration
+# file is '~/.sumo_creds'.
+class Sumo::Config
+  include Sumo::Error
+
+  attr_reader :config_file
+
+  # Set and freeze the @config_file instance variable.
+  def initialize(config_file = Sumo::DEFAULT_CONFIG_FILE)
+    if config_file.is_a?(String)
+      @config_file = File.expand_path(config_file).freeze
+    else
+      raise TypeError, "Expected a String, got: #{config_file}"
+    end
+  end
+
+  # Test if an alternate file has been specified.
+  def file_specified?
+    config_file != Sumo::DEFAULT_CONFIG_FILE
+  end
+
+  # Memoize the credentials from the environment.
+  def env_creds
+    @env_creds ||= ENV['SUMO_CREDS']
+  end
+
+  # Memoize the credentials from the configuration file.
+  def file_creds
+    @file_creds ||= File.read(config_file).chomp if File.exists?(config_file)
+  end
+
+  # Load the credentials.
+  def load_config
+    if file_specified?
+      file_creds || env_creds
+    else
+      env_creds || file_creds
+    end
+  end
+
+  # Load the credentials, raising an error if none are specified.
+  def load_config!
+    if (creds = load_config).nil?
+      raise NoCredsFound, "No credentials were found, set ENV['SUMO_CREDS']."
+    else
+      creds
+    end
+  end
+end

data/lib/sumo/error.rb

@@ -0,0 +1,18 @@
+# This module acts as a namespace for all errors thrown in the gem.
+module Sumo::Error
+  # This error is never raised, but instead used to catch all other errors that
+  # may be raised.
+  class BaseError < StandardError; end
+
+  # Raised when an unexpected type is passed to a method.
+  class TypeError < BaseError; end
+
+  # This error is raised when no credentials can be found.
+  class NoCredsFound < BaseError; end
+
+  # This error is raised when there is an error on a request.
+  class RequestError < BaseError; end
+
+  # This error is raised when a parsing error occurs.
+  class ParseError < BaseError; end
+end

data/lib/sumo/formatter.rb

@@ -0,0 +1,21 @@
+# This module contains formatting functions to help make text more readable.
+module Sumo::Formatter
+  include Sumo::Error
+
+  # Given a sumo response (string)
+  def format_json(response)
+    JSON.parse(response)
+        .sort_by { |hash| hash['_messagetime'] }
+        .map { |hash| hash['_raw'] }
+  rescue
+    raise ParseError, 'Could not parse the response.'
+  end
+
+  def extract_key(key, logs)
+    logs.map { |log| JSON.parse(log)[key] }
+  rescue
+    raise ParseError, "Error extracting the #{key} from the hash."
+  end
+
+  module_function :format_json, :extract_key
+end

data/lib/sumo/query_builder.rb

@@ -0,0 +1,61 @@
+# This class can be used to build and execute queries. For example, the
+# following code builds a query for 'error' in the last 15 minutes.
+#
+# q = Sumo::QueryBuilder.new('user@example.com:pass')
+#         .query('error')
+#         .from('-15m')
+#         .to('now')
+#
+# Note that this class is immutable.
+class Sumo::QueryBuilder
+  include Sumo::Error
+
+  attr_reader :creds, :opts
+
+  # Create a new QueryBuilder with the given credentials and query.
+  def initialize(creds, opts = {})
+    if creds.is_a?(String) && opts.is_a?(Hash)
+      @creds = creds.freeze
+      @opts = opts.freeze
+    else
+      raise TypeError, "Invalid initialization parameters to QueryBuilder."
+    end
+  end
+
+  # Metaprogram the #query, #to, #from, #time_zone, and #format methods. Each
+  # of these methods accepts one argument, and returns a new 'QueryBuilder' that
+  # has the specified query parameter key set.
+  def self.builder(name, key)
+    klass = self
+    define_method(name) { |arg| klass.new(creds, opts.merge(key => arg)) }
+  end
+  private_class_method :builder
+
+  builder :to, 'to'
+  builder :from, 'from'
+  builder :query, 'q'
+  builder :format, 'format'
+  builder :time_zone, 'tz'
+
+  # Send the API request to Sumo Logic.
+  def execute
+    encoded = Base64.encode64(creds)
+    resp = connection.get(:path => '/api/v1/logs/search',
+                          :query => opts,
+                          :headers => { 'Authorization' => "Basic #{encoded}" })
+    if resp.status >= 400
+      if resp.body.nil? || resp.body.empty?
+        raise RequestError, "An error occurred sending your request."
+      else
+        raise RequestError, JSON.parse(resp.body)['message']
+      end
+    end
+    resp.body
+  end
+
+  # A memoized HTTP connection.
+  def connection
+    @connection ||= Excon.new('https://api.sumologic.com')
+  end
+  private :connection
+end

data/lib/sumo/version.rb

@@ -0,0 +1,4 @@
+# This file contains the version of the gem.
+module Sumo
+  VERSION = '0.0.1'
+end

data/spec/fixtures/sumo_creds

@@ -0,0 +1 @@
+fake_user@fake_site:fake_pass

data/spec/lib/sumo/config_spec.rb

@@ -0,0 +1,130 @@
+require 'spec_helper'
+
+describe Sumo::Config do
+  describe '.new' do
+    subject { Sumo::Config }
+
+    context 'when no argument is given' do
+      it 'sets @config_file to its default value' do
+        subject.new.config_file.should == Sumo::DEFAULT_CONFIG_FILE
+      end
+    end
+
+    context 'when an argument is given' do
+      context 'when it is not a String' do
+        it 'raises an error' do
+          expect { subject.new(nil) }.to raise_error(Sumo::Error::TypeError)
+        end
+      end
+
+      context 'when it is a String' do
+        let(:file) { '/dev/null' }
+
+        it 'sets @config_file to the argument' do
+          subject.new(file).config_file.should == file
+        end
+      end
+    end
+  end
+
+  describe '#file_specified?' do
+    context 'when @config_file is the default' do
+      it 'returns false' do
+        subject.file_specified?.should be_false
+      end
+    end
+
+    context 'when @config_file is not the default' do
+      subject { Sumo::Config.new('my-config-file') }
+
+      it 'returns true' do
+        subject.file_specified?.should be_true
+      end
+    end
+  end
+
+  describe '#env_creds' do
+    before { ENV['SUMO_CREDS'] = creds }
+
+    context 'when the environment variable is not set' do
+      let(:creds) { nil }
+
+      it 'returns nil' do
+        subject.env_creds.should be_nil
+      end
+    end
+
+    context 'when the environment variable is set' do
+      let(:creds) { 'alpha' }
+
+      it 'returns that variable' do
+        subject.env_creds.should == creds
+      end
+    end
+  end
+
+  describe '#file_creds' do
+    subject { Sumo::Config.new(file) }
+
+    context 'when the @config_file does not exist' do
+      let(:file) { 'not a file' }
+
+      it 'returns nil' do
+        subject.file_creds.should be_nil
+      end
+    end
+
+    context 'when @config_file does exist' do
+      let(:file) { 'spec/fixtures/sumo_creds' }
+
+      it 'returns its contents' do
+        subject.file_creds.should == 'fake_user@fake_site:fake_pass'
+      end
+    end
+  end
+
+  describe '#load_config' do
+    before do
+      subject.stub(:file_specified?).and_return(specified)
+      subject.stub(:file_creds).and_return('alpha')
+      subject.stub(:env_creds).and_return('beta')
+    end
+
+    context 'when an alternate file is specifed' do
+      let(:specified) { true }
+
+      it 'attempts to read the file first' do
+        subject.load_config.should == 'alpha'
+      end
+    end
+
+    context 'when an alternate file is not specified' do
+      let(:specified) { false }
+
+      it 'attempts to read the environment variable first' do
+        subject.load_config.should == 'beta'
+      end
+    end
+  end
+
+  describe 'load_config!' do
+    before { subject.stub(:load_config).and_return(config) }
+
+    context 'when #load_config returns nil' do
+      let(:config) { nil }
+
+      it 'raises an error' do
+        expect { subject.load_config! }
+            .to raise_error(Sumo::Error::NoCredsFound)
+      end
+    end
+
+    context 'when #load_config returns a value' do
+      let(:config) { 'configuration' }
+
+      it 'returns that value' do
+        subject.load_config!.should == config
+      end
+    end
+  end
+end

data/spec/lib/sumo/formatter_spec.rb

@@ -0,0 +1,51 @@
+require 'spec_helper'
+
+describe Sumo::Formatter do
+  subject { Sumo::Formatter }
+
+  describe '.format_json' do
+    context 'when the input cannot be parsed' do
+      it 'raises an error' do
+        expect { subject.format_json('cannot parse this') }
+            .to raise_error(Sumo::Error::ParseError)
+      end
+    end
+
+    context 'when the input can be parsed' do
+      let(:input) {
+        [
+          { '_messagetime' => 2, '_raw' => 'world' },
+          { '_messagetime' => 1, '_raw' => 'hello' }
+        ].to_json
+      }
+
+      it 'sorts the input by the _messagetime, returning a String' do
+        subject.format_json(input).should == %w(hello world)
+      end
+    end
+  end
+
+  describe '.extract_key' do
+    context 'when at least one element of the Array cannot be parsed' do
+      let(:input) { [ { :a => 1 }.to_json, 'qwerty'] }
+
+      it 'raises an error' do
+        expect { subject.extract_key('anything', input) }
+            .to raise_error(Sumo::Error::ParseError)
+      end
+    end
+
+    context 'when the input is an Array of parseable values' do
+      let(:input) {
+        [
+          { 'message' => 'rats', 'time' => 2 }.to_json,
+          { 'message' => 'cats', 'time' => 1 }.to_json
+        ]
+      }
+
+      it 'returns an Array with the specified key extracted' do
+        subject.extract_key('message', input).should == %w(rats cats)
+      end
+    end
+  end
+end

data/spec/lib/sumo/query_builder_spec.rb

@@ -0,0 +1,128 @@
+require 'spec_helper'
+
+describe Sumo::QueryBuilder do
+  subject { Sumo::QueryBuilder.new('fake-creds') }
+
+  describe '.new' do
+    context 'when the correct types of arguments are supplied' do
+      subject { Sumo::QueryBuilder.new('auth', 'q' => 'error') }
+
+      it 'creates a new QueryBuilder' do
+        subject.creds.should == 'auth'
+        subject.opts.should == { 'q' => 'error' }
+      end
+    end
+
+    context 'when invalid arguments are supplied' do
+      it 'raises an error' do
+        expect { Sumo::QueryBuilder.new(:symbol, 1) }
+            .to raise_error(Sumo::Error::TypeError)
+      end
+    end
+  end
+
+  describe '#query' do
+    it 'adds a query to the request' do
+      subject.query('alpha').opts.should == { 'q' => 'alpha' }
+    end
+  end
+
+  describe '#to' do
+    it 'adds an end time to the request' do
+      subject.to('now').opts.should == { 'to' => 'now' }
+    end
+  end
+
+  describe '#from' do
+    it 'adds an end time to the request' do
+      subject.from('-15m').opts.should == { 'from' => '-15m' }
+    end
+  end
+
+  describe '#time_zone' do
+    it 'adds a time zone to the request' do
+      subject.time_zone('UTC').opts.should == { 'tz' => 'UTC' }
+    end
+  end
+
+  describe '#format' do
+    it 'adds a format to the request' do
+      subject.format('JSON').opts.should == { 'format' => 'JSON' }
+    end
+  end
+
+  describe '#execute' do
+    let(:creds) { 'user@example.com:pass' }
+    let(:encoded) { Base64.encode64(creds) }
+    let(:conn) { double(:connection) }
+    let(:query) {
+      {
+        'q' => 'production',
+        'from' => '-30m',
+        'to' => '-15m',
+        'tz' => 'UTC',
+        'format' => 'json'
+      }
+    }
+    subject {
+      Sumo::QueryBuilder.new(creds).query('production')
+                                   .from('-30m')
+                                   .to('-15m')
+                                   .time_zone('UTC')
+                                   .format('json')
+    }
+
+    before do
+      subject.stub(:connection).and_return(conn)
+      conn.stub(:get)
+          .with(:path => '/api/v1/logs/search',
+                :query => query,
+                :headers => { 'Authorization' => "Basic #{encoded}" })
+          .and_return(resp)
+    end
+
+    context 'when the server responds' do
+      let(:resp) { double(:response, :body => '{}', :status => 200) }
+
+      it 'parses the response' do
+        subject.execute.should == '{}'
+      end
+    end
+
+    context 'when the server does not respond' do
+      let(:resp) { double(:response, :body => nil, :status => 504) }
+
+      it 'raises an error' do
+        expect { subject.execute }.to raise_error(Sumo::Error::RequestError)
+      end
+    end
+  end
+
+  describe 'integration', :vcr do
+    # WARNING: If you are going to change this VCR, modify the credentials so
+    # that they are valid, record the VCR, remove the credentials from it, and
+    # change the below variable back to its original form.
+    let(:creds) { 'aladdin@swipely.com:open sesame' }
+
+    context 'when the request is valid' do
+      let(:result) { JSON.parse(subject.execute) }
+      subject { Sumo::QueryBuilder.new(creds).query('nginx') }
+
+      it 'compiles and sends the query to the server' do
+        result.length.should_not be_zero
+        result.should be_all { |hash|
+          %w(_sourcecategory _raw _sourcehost _receipttime _sourcename
+             _messagetime).all? { |key| hash.has_key?(key) }
+        }
+      end
+    end
+
+    context 'when the request is invalid' do
+      subject { Sumo::QueryBuilder.new(creds).query('nginx').to('nonsense') }
+
+      it 'raises an error' do
+        expect { subject.execute }.to raise_error(Sumo::Error::RequestError)
+      end
+    end
+  end
+end

data/spec/lib/sumo_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+
+describe Sumo do
+  subject { Sumo }
+
+  it { should be_a Module }
+
+  describe '.search' do
+    context 'when the credentials cannot be found' do
+      before { ENV['SUMO_CREDS'] = nil }
+
+      it 'raises an error' do
+        expect { subject.search('anything') }
+            .to raise_error(Sumo::Error::NoCredsFound)
+      end
+    end
+
+    context 'when the credentials can be found' do
+      before { ENV['SUMO_CREDS'] = 'aladdin@swipely.com:open sesame' }
+
+      context 'but the query is invalid' do
+        it 'raises an error', :vcr do
+          expect { subject.search('Rails', options: { 'from' => 'never' }) }
+              .to raise_error(Sumo::Error::RequestError)
+        end
+      end
+
+      context 'and the query is valid' do
+        it 'parses the response', :vcr do
+          subject.search('rails').each { |str| str.should_not match(/_raw/) }
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'rspec'
+require 'simplecov'
+require 'sumo'
+
+SimpleCov.start
+
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
+
+RSpec.configure do |config|
+  config.mock_with :rspec
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.color_enabled = true
+  config.formatter = :documentation
+  config.tty = true
+end

data/spec/support/vcr.rb

@@ -0,0 +1,8 @@
+require 'vcr'
+
+VCR.configure do |c|
+  c.allow_http_connections_when_no_cassette = false
+  c.hook_into :excon
+  c.cassette_library_dir = File.join(File.dirname(__FILE__), '..', 'vcr')
+  c.configure_rspec_metadata!
+end

data/spec/vcr/Sumo/_search/when_the_credentials_can_be_found/and_the_query_is_valid/parses_the_response.yml

@@ -0,0 +1,49 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://api.sumologic.com/api/v1/logs/search?q=rails
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - excon/0.31.0
+      Authorization:
+      - |
+        Basic YWxhZGRpbkBzd2lwZWx5LmNvbTpvcGVuIHNlc2FtZQ==
+  response:
+    status:
+      code: 200
+      message: 
+    headers:
+      Cache-control:
+      - no-cache="set-cookie"
+      Content-Type:
+      - application/json; charset=ISO-8859-1
+      Date:
+      - Tue, 07 Jan 2014 18:32:15 GMT
+      Expires:
+      - Thu, 01-Jan-1970 00:00:00 GMT
+      Set-Cookie:
+      - JSESSIONID=p8dhtx823tvbbxs578ipt3mn;Path=/api, AWSELB=D5C1176F0665104977B708B0B48E6FFEC09E311CD1473A91FD800B5F0A2443FAC23088ACED0D807762BB3B769CEAADA14ED5C9BC9C86BA1749DC556A5C1B04944D462E0D92;PATH=/
+      Content-Length:
+      - '1052'
+      Connection:
+      - Close
+    body:
+      encoding: UTF-8
+      string: |-
+        [
+          {
+            "_sourcecategory" : "all",
+            "_raw" : "{\"@source\":\"syslog://\",\"@tags\":[\"railslog\"],\"@fields\":{\"facility\":\"local0\",\"severity\":[\"notice\",\"D\"],\"program\":\"swipely-ledger-delayed-1\",\"processid\":\"-\",\"sslsubject\":[\"/C=US/ST=Rhode Island/O=Swipely/OU=Engineering/CN=s-ledger\",\"/C=US/ST=Rhode Island/O=Swipely/OU=Engineering/CN=s-ledger\"],\"host\":[\"s-ledger\"],\"timestamp\":[\"140107-18:26:50.605\"],\"thread_id\":[\"8_15364200\"],\"msg\":[\"** [Honeybadger] Environment Info: [Ruby: 1.9.3] [Rails: 3.2.11] [Env: staging]\"]},\"@timestamp\":\"2014-01-07T18:26:54.159449+00:00\",\"@source_host\":\"ip-10-244-158-144\",\"@message\":\"Jan  7 18:26:54 swipely-ledger-delayed-1:D 140107-18:26:50.605 8_15364200: ** [Honeybadger] Environment Info: [Ruby: 1.9.3] [Rails: 3.2.11] [Env: staging]\",\"@type\":\"syslog\"}",
+            "_sourcehost" : "logs.example.com",
+            "_receipttime" : 1389119226829,
+            "_sourcename" : "/media/ephemeral0/logs/swipely/s-ledger-2014-01-07.log",
+            "_messagetime" : 1389119214159
+          }
+        ]
+    http_version: 
+  recorded_at: Tue, 07 Jan 2014 18:32:19 GMT
+recorded_with: VCR 2.8.0

data/spec/vcr/Sumo/_search/when_the_credentials_can_be_found/but_the_query_is_invalid/raises_an_error.yml

@@ -0,0 +1,43 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://api.sumologic.com/api/v1/logs/search?from=never&q=Rails
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - excon/0.31.0
+      Authorization:
+      - |
+        Basic YWxhZGRpbkBzd2lwZWx5LmNvbTpvcGVuIHNlc2FtZQ==
+  response:
+    status:
+      code: 400
+      message: 
+    headers:
+      Cache-control:
+      - no-cache="set-cookie"
+      Content-Type:
+      - application/json; charset=ISO-8859-1
+      Date:
+      - Tue, 07 Jan 2014 18:30:35 GMT
+      Set-Cookie:
+      - AWSELB=D5C1176F0665104977B708B0B48E6FFEC09E311CD1473A91FD800B5F0A2443FAC23088ACED0D807762BB3B769CEAADA14ED5C9BC9C86BA1749DC556A5C1B04944D462E0D92;PATH=/
+      Content-Length:
+      - '154'
+      Connection:
+      - Close
+    body:
+      encoding: UTF-8
+      string: |-
+        {
+          "status" : 400,
+          "id" : "9IJJK-HJQ9G-H09X3",
+          "code" : "search.invalid.timestamp.from",
+          "message" : "The 'from' field contains an invalid time."
+        }
+    http_version: 
+  recorded_at: Tue, 07 Jan 2014 18:30:39 GMT
+recorded_with: VCR 2.8.0

data/spec/vcr/Sumo_QueryBuilder/integration/when_the_request_is_invalid/raises_an_error.yml

@@ -0,0 +1,43 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://api.sumologic.com/api/v1/logs/search?q=nginx&to=nonsense
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - excon/0.31.0
+      Authorization:
+      - |
+        Basic YWxhZGRpbkBzd2lwZWx5LmNvbTpvcGVuIHNlc2FtZQ==
+  response:
+    status:
+      code: 400
+      message: 
+    headers:
+      Cache-control:
+      - no-cache="set-cookie"
+      Content-Type:
+      - application/json; charset=ISO-8859-1
+      Date:
+      - Tue, 07 Jan 2014 15:52:16 GMT
+      Set-Cookie:
+      - AWSELB=D5C1176F0665104977B708B0B48E6FFEC09E311CD10EE26CC6F86FEAE76E4BBB3D728D261CADA16D6256329826144A742E70346FDF2C8592D1FAF5BF2ABFF69B2FDD5A38FA;PATH=/
+      Content-Length:
+      - '150'
+      Connection:
+      - Close
+    body:
+      encoding: UTF-8
+      string: |-
+        {
+          "status" : 400,
+          "id" : "ELTN2-7BBZF-ZCZQ8",
+          "code" : "search.invalid.timestamp.to",
+          "message" : "The 'to' field contains an invalid time."
+        }
+    http_version: 
+  recorded_at: Tue, 07 Jan 2014 15:52:18 GMT
+recorded_with: VCR 2.8.0

data/spec/vcr/Sumo_QueryBuilder/integration/when_the_request_is_valid/compiles_and_sends_the_query_to_the_server.yml

@@ -0,0 +1,49 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://api.sumologic.com/api/v1/logs/search?q=nginx
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - excon/0.31.0
+      Authorization:
+      - |
+        Basic YWxhZGRpbkBzd2lwZWx5LmNvbTpvcGVuIHNlc2FtZQ==
+  response:
+    status:
+      code: 200
+      message: 
+    headers:
+      Cache-control:
+      - no-cache="set-cookie"
+      Content-Type:
+      - application/json; charset=ISO-8859-1
+      Date:
+      - Tue, 07 Jan 2014 15:49:55 GMT
+      Expires:
+      - Thu, 01-Jan-1970 00:00:00 GMT
+      Set-Cookie:
+      - JSESSIONID=1dybd1qub96gu13g5a9qh9dyqc;Path=/api, AWSELB=D5C1176F0665104977B708B0B48E6FFEC09E311CD1473A91FD800B5F0A2443FAC23088ACEDDBBB8C99D44C2403D82B59D74368F2FCC1FFB75ECAF9255D4A40FE87F45B4364;PATH=/
+      transfer-encoding:
+      - ''
+      Connection:
+      - Close
+    body:
+      encoding: UTF-8
+      string: |-
+        [
+          {
+            "_sourcecategory" : "all",
+            "_raw" : "nonsense result",
+            "_sourcehost" : "ls01.logs.swipely.com",
+            "_receipttime" : 1389109434302,
+            "_sourcename" : "/media/ephemeral0/logs/swipely/p-ledger-lb-2014-01-07.log",
+            "_messagetime" : 1389109430911
+          }
+        ]
+    http_version: 
+  recorded_at: Tue, 07 Jan 2014 15:49:59 GMT
+recorded_with: VCR 2.8.0

data/sumo-search.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/sumo/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Swipely, Inc."]
+  gem.email         = %w{tomhulihan@swipely.com}
+  gem.description   = %q{A CLI for querying the Sumo Logic search API}
+  gem.summary       = %q{A CLI for querying the Sumo Logic search API}
+  gem.homepage      = 'https://github.com/swipely/sumo-search'
+  gem.license       = 'MIT'
+  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          = 'sumo-search'
+  gem.require_paths = %w{lib}
+  gem.version       = Sumo::VERSION
+  gem.required_ruby_version = '>= 2.0.0'
+  gem.add_dependency 'excon', '>= 0.28'
+  gem.add_dependency 'json'
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'cane'
+  gem.add_development_dependency 'pry'
+  gem.add_development_dependency 'vcr', '>= 2.7.0'
+  gem.add_development_dependency 'simplecov'
+end

metadata

@@ -0,0 +1,192 @@
+--- !ruby/object:Gem::Specification
+name: sumo-search
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Swipely, Inc.
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: excon
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0.28'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0.28'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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'
+- !ruby/object:Gem::Dependency
+  name: cane
+  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'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 2.7.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 2.7.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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: A CLI for querying the Sumo Logic search API
+email:
+- tomhulihan@swipely.com
+executables:
+- sumo
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- bin/sumo
+- lib/sumo.rb
+- lib/sumo/config.rb
+- lib/sumo/error.rb
+- lib/sumo/formatter.rb
+- lib/sumo/query_builder.rb
+- lib/sumo/version.rb
+- spec/fixtures/sumo_creds
+- spec/lib/sumo/config_spec.rb
+- spec/lib/sumo/formatter_spec.rb
+- spec/lib/sumo/query_builder_spec.rb
+- spec/lib/sumo_spec.rb
+- spec/spec_helper.rb
+- spec/support/vcr.rb
+- spec/vcr/Sumo/_search/when_the_credentials_can_be_found/and_the_query_is_valid/parses_the_response.yml
+- spec/vcr/Sumo/_search/when_the_credentials_can_be_found/but_the_query_is_invalid/raises_an_error.yml
+- spec/vcr/Sumo_QueryBuilder/integration/when_the_request_is_invalid/raises_an_error.yml
+- spec/vcr/Sumo_QueryBuilder/integration/when_the_request_is_valid/compiles_and_sends_the_query_to_the_server.yml
+- sumo-search.gemspec
+homepage: https://github.com/swipely/sumo-search
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.7
+signing_key: 
+specification_version: 4
+summary: A CLI for querying the Sumo Logic search API
+test_files:
+- spec/fixtures/sumo_creds
+- spec/lib/sumo/config_spec.rb
+- spec/lib/sumo/formatter_spec.rb
+- spec/lib/sumo/query_builder_spec.rb
+- spec/lib/sumo_spec.rb
+- spec/spec_helper.rb
+- spec/support/vcr.rb
+- spec/vcr/Sumo/_search/when_the_credentials_can_be_found/and_the_query_is_valid/parses_the_response.yml
+- spec/vcr/Sumo/_search/when_the_credentials_can_be_found/but_the_query_is_invalid/raises_an_error.yml
+- spec/vcr/Sumo_QueryBuilder/integration/when_the_request_is_invalid/raises_an_error.yml
+- spec/vcr/Sumo_QueryBuilder/integration/when_the_request_is_valid/compiles_and_sends_the_query_to_the_server.yml
+has_rdoc: