sumo-search 0.1.1 → 1.0.2

data/spec/vcr/Sumo_Search/_status/returns_the_status_of_the_search.yml

@@ -0,0 +1,71 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://api.sumologic.com/api/v1/search/jobs
+    body:
+      encoding: UTF-8
+      string: "{\"query\":\"| count _sourceCategory\",\"from\":\"2013-01-01T00:00:00\",\"to\":\"2014-03-01T00:00:00\",\"timeZone\":\"EST\"}"
+    headers:
+      User-Agent:
+      - excon/0.32.1
+      Content-Type:
+      - application/json
+      Accept:
+      - application/json
+  response:
+    status:
+      code: 202
+      message: 
+    headers:
+      Content-Type:
+      - application/json
+      Date:
+      - Wed, 26 Mar 2014 13:49:41 GMT
+      Location:
+      - http://api.sumologic.com/api/v1/search/jobs/24997BFEE7AC89B5
+      Strict-Transport-Security:
+      - max-age=15552000
+      Content-Length:
+      - '117'
+      Connection:
+      - Close
+    body:
+      encoding: UTF-8
+      string: "{\"id\":\"24997BFEE7AC89B5\",\"link\":{\"rel\":\"filtered\",\"href\":\"filtered\"}}"
+    http_version: 
+  recorded_at: Wed, 26 Mar 2014 13:49:43 GMT
+- request:
+    method: get
+    uri: https://api.sumologic.com/api/v1/search/jobs/24997BFEE7AC89B5
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - excon/0.32.1
+      Content-Type:
+      - application/json
+      Accept:
+      - application/json
+  response:
+    status:
+      code: 200
+      message: 
+    headers:
+      Content-Type:
+      - application/json
+      Date:
+      - Wed, 26 Mar 2014 13:49:42 GMT
+      Strict-Transport-Security:
+      - max-age=15552000
+      Content-Length:
+      - '125'
+      Connection:
+      - Close
+    body:
+      encoding: UTF-8
+      string: "{\"state\":\"GATHERING RESULTS\",\"pendingWarnings\":[],\"pendingErrors\":[],\"histogramBuckets\":[],\"messageCount\":0,\"recordCount\":-1}"
+    http_version: 
+  recorded_at: Wed, 26 Mar 2014 13:49:43 GMT
+recorded_with: VCR 2.8.0

data/sumo-search.gemspec

@@ -4,9 +4,9 @@ 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.description   = %q{A simple REST client for the Sumo Search Job API}
+  gem.summary       = %q{A simple REST client for the Sumo Search Job API}
+  gem.homepage      = 'https://github.com/swipely/sumo-job'
   gem.license       = 'MIT'
   gem.files         = `git ls-files`.split($\)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
@@ -14,13 +14,12 @@ Gem::Specification.new do |gem|
   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 'excon', '>= 0.32'
+  gem.add_dependency 'clamp', '>= 0.6.3'
   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

@@ -1,128 +1,128 @@
 --- !ruby/object:Gem::Specification
 name: sumo-search
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Swipely, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-08 00:00:00.000000000 Z
+date: 2014-03-26 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'
+        version: '0.32'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.28'
+        version: '0.32'
+- !ruby/object:Gem::Dependency
+  name: clamp
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.6.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.6.3
 - !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
+description: A simple REST client for the Sumo Search Job API
 email:
 - tomhulihan@swipely.com
 executables:
@@ -130,30 +130,35 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".cane"
+- ".gitignore"
+- ".travis.yml"
 - Gemfile
 - README.md
 - Rakefile
 - bin/sumo
 - lib/sumo.rb
+- lib/sumo/cli.rb
+- lib/sumo/client.rb
+- lib/sumo/collection.rb
 - lib/sumo/config.rb
 - lib/sumo/error.rb
-- lib/sumo/formatter.rb
-- lib/sumo/query_builder.rb
+- lib/sumo/search.rb
 - lib/sumo/version.rb
-- spec/fixtures/sumo_creds
+- spec/fixtures/sumo-creds
+- spec/lib/sumo/client_spec.rb
 - spec/lib/sumo/config_spec.rb
-- spec/lib/sumo/formatter_spec.rb
-- spec/lib/sumo/query_builder_spec.rb
+- spec/lib/sumo/search_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
+- spec/vcr/Sumo_Search/_create/sets_the_id_and_client.yml
+- spec/vcr/Sumo_Search/_delete_/deletes_the_search.yml
+- spec/vcr/Sumo_Search/_messages/returns_an_Enumerator_of_each_message_in_the_search.yml
+- spec/vcr/Sumo_Search/_records/returns_an_Enumerator_of_each_record_in_the_search.yml
+- spec/vcr/Sumo_Search/_status/returns_the_status_of_the_search.yml
 - sumo-search.gemspec
-homepage: https://github.com/swipely/sumo-search
+homepage: https://github.com/swipely/sumo-job
 licenses:
 - MIT
 metadata: {}
@@ -163,30 +168,30 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 2.0.0
+      version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.7
+rubygems_version: 2.2.0
 signing_key: 
 specification_version: 4
-summary: A CLI for querying the Sumo Logic search API
+summary: A simple REST client for the Sumo Search Job API
 test_files:
-- spec/fixtures/sumo_creds
+- spec/fixtures/sumo-creds
+- spec/lib/sumo/client_spec.rb
 - spec/lib/sumo/config_spec.rb
-- spec/lib/sumo/formatter_spec.rb
-- spec/lib/sumo/query_builder_spec.rb
+- spec/lib/sumo/search_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: 
+- spec/vcr/Sumo_Search/_create/sets_the_id_and_client.yml
+- spec/vcr/Sumo_Search/_delete_/deletes_the_search.yml
+- spec/vcr/Sumo_Search/_messages/returns_an_Enumerator_of_each_message_in_the_search.yml
+- spec/vcr/Sumo_Search/_records/returns_an_Enumerator_of_each_record_in_the_search.yml
+- spec/vcr/Sumo_Search/_status/returns_the_status_of_the_search.yml

data/lib/sumo/formatter.rb

@@ -1,21 +0,0 @@
-# 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

@@ -1,61 +0,0 @@
-# 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/spec/fixtures/sumo_creds

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

data/spec/lib/sumo/formatter_spec.rb

@@ -1,51 +0,0 @@
-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