sumo-search 1.0.3 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6c2ca2e55a6f1e001ca804fbb35fa56569b13de3
-  data.tar.gz: 1598ea49bf905717c927192898a0fad437df0d44
+  metadata.gz: 7ed2fa4eca034af9b83515cfcee0e1f7f491ea3a
+  data.tar.gz: 75c6c374a0a966aaf3fefcc62d6c6400845003c9
 SHA512:
-  metadata.gz: 6aa24fc1127346528ddf529f43c4f13c2b39207e992aab58c923f8ff80998bdb5cf38d55d763e5629ae3cf54e5e283919612d5a504c7ee55764cb139d051c334
-  data.tar.gz: 49e01a996c9c9995e456d5340e0b006d62dfea39face339dfc5b556c810ba99c0af72254675ca307d2d4f25d9920e96b1cb7d20f696a60f0efd08992df11aeb0
+  metadata.gz: c7e7ea816310a6c07ccb81e52c8686741c4f99ed100fcce5ec702d7a9f651635cfb3eed35e219a0e4bde7345d7be766ff85967a9885c7fa21862905750ef8ef0
+  data.tar.gz: 33e61f4c901faad6ded980d08acd6a99cf72af45b40accc9f89dbfdeec19b5f81112b855d93691328db931aa2739795bd96feda9a76922db66e1bbe6ac030707

data/README.md

@@ -1,5 +1,7 @@
 # sumo-search
 
+[![Gem Version](https://badge.fury.io/rb/sumo-search.png)](http://badge.fury.io/rb/sumo-search) [![Build Status](https://travis-ci.org/swipely/sumo.svg?branch=add-fog-style-credential-loading)](https://travis-ci.org/swipely/sumo) [![Code Climate](https://codeclimate.com/github/swipely/sumo.png)](https://codeclimate.com/github/swipely/sumo) [![Dependency Status](https://gemnasium.com/swipely/sumo-search.svg)](https://gemnasium.com/swipely/sumo-search)
+
 This gem interfaces with the Sumo Logic [Search Job API](https://github.com/SumoLogic/sumo-api-doc/wiki/search-job-api).
 It may be used through native Ruby, or via a CLI that has been provided.
 
@@ -17,6 +19,23 @@ From your application's `Gemfile`:
 gem 'sumo-search'
 ```
 
+## Configuration
+
+Your credentials go into the YAML file `~/.sumo_creds`.
+An example YAML file is listed below:
+
+```yaml
+backend:
+  email: email@test.net
+  password: trustno1
+default:
+  email: email2@test.net
+  password: test-pass
+```
+
+The credentials in the `default` namespace are loaded by default.
+To change this, set `ENV['SUMO_CREDENTIAL']` to the credential that you would like to load.
+
 ## Ruby Usage
 
 To create a search job from ruby, the `Sumo.search` method is provided.

data/lib/sumo.rb

@@ -2,12 +2,13 @@ require 'base64'
 require 'clamp'
 require 'excon'
 require 'json'
+require 'yaml'
 
 # This is the top level module for the gem. It is used as a namespace and holds
 # top-level convenience functions.
 module Sumo
   # Define global constants.
-  DEFAULT_CONFIG_FILE = File.expand_path('~/.sumo_creds').freeze
+  CONFIG_FILE = File.expand_path('~/.sumo_creds').freeze
 
   # Require sub-modules.
   require 'sumo/error'

data/lib/sumo/cli.rb

@@ -8,17 +8,30 @@ class Sumo::CLI < Clamp::Command
   option ['-r', '--records'], :flag, 'Extract records instead of messages.'
   option ['-v', '--version'], :flag, 'Print the version.'
 
+  banner <<-EOS.gsub(/^.*\|/, '')
+    |Example
+    |
+    |Search for all of the logs containing 'HealthMetrics' on March 4, 2014,
+    |extracting the message key from the response:
+    |
+    |sumo --query HealthMetrics \\
+    |     --from 2014-03-14T00:00:00 \\
+    |     --to 2014-03-15T00:00:00 \\
+    |     --time-zone EST \\
+    |     --extract-key message
+  EOS
+
   # This method is called when the CLI is run.
   def execute
     if version?
       puts Sumo::VERSION
     elsif records?
-      search.records.each { |record| puts record }
+      search.records.each { |record| $stdout.puts record }
     else
-      search.messages.each { |message| puts format_message(message) }
+      search.messages.each { |message| $stdout.puts format_message(message) }
     end
   rescue StandardError => ex
-    puts "#{ex.class}: #{ex.message}"
+    $stderr.puts "#{ex.class}: #{ex.message}"
     exit 1
   end
 

data/lib/sumo/client.rb

@@ -2,14 +2,15 @@
 class Sumo::Client
   include Sumo::Error
 
-  attr_reader :creds, :cookie
+  attr_reader :email, :password, :cookie
 
   # The error message raised when the result can be parsed from Sumo.
   DEFAULT_ERROR_MESSAGE = 'Error sending API request'
 
   # Create a new `Sumo::Client` with the given credentials.
-  def initialize(creds = Sumo.creds)
-    @creds = creds.freeze
+  def initialize(credentials = Sumo.creds)
+    @email = credentials['email'].freeze
+    @password = credentials['password'].freeze
   end
 
   # Send a HTTP request to the server, handling any errors that may occur.
@@ -73,6 +74,11 @@ class Sumo::Client
   end
   private :encoded_creds
 
+  def creds
+    [email, password].join(':')
+  end
+  private :creds
+
   def connection
     @connection ||= Excon.new('https://api.sumologic.com')
   end

data/lib/sumo/config.rb

@@ -1,11 +1,5 @@
-# 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'.
+# This class contains the logic to find the user's credentials from a
+# configuration file. By default, the file is `~/.sumo_creds`.
 class Sumo::Config
   include Sumo::Error
 
@@ -13,40 +7,66 @@ class Sumo::Config
 
   # Given an optional `String`, sets and freezes the `@config_file` instance
   # variable, as long as it's a valid file path.
-  def initialize(config_file = Sumo::DEFAULT_CONFIG_FILE)
+  def initialize(config_file = Sumo::CONFIG_FILE)
     @config_file = File.expand_path(config_file).freeze
   end
 
-  # Test if an alternate file has been specified.
-  def file_specified?
-    config_file != Sumo::DEFAULT_CONFIG_FILE
+  # Load the credentials, raising an any errors that occur.
+  def load_creds!
+    @creds ||= load_file[cred_key].tap do |creds|
+      raise NoCredsFound, "#{cred_key} not found in #{config_file}" if !creds
+    end
   end
 
-  # Get the credentials from the environment.
-  def env_creds
-    ENV['SUMO_CREDS']
+  # Load the credentials, returning nil if an error occurs.
+  def load_creds
+    load_creds! rescue nil
   end
 
-  # Get the credentials from the configuration file.
-  def file_creds
-    File.read(config_file).chomp if File.exists?(config_file)
+  # Get the credentials from the environment.
+  def cred_key
+    @cred_key = ENV['SUMO_CREDENTIAL'] || 'default'
   end
+  private :cred_key
 
-  # Load the credentials.
-  def load_creds
-    @config ||= if file_specified?
-      file_creds || env_creds
+  # Get the credentials from the configuration file.
+  def load_file
+    if File.exists?(config_file)
+      parse_file
     else
-      env_creds || file_creds
+      raise NoCredsFound, bad_config_file("#{config_file} does not exist.")
     end
   end
+  private :load_file
 
-  # Load the credentials, raising an error if none are specified.
-  def load_creds!
-    if (creds = load_creds).nil?
-      raise NoCredsFound, "No credentials were found, set ENV['SUMO_CREDS']."
-    else
-      creds
-    end
+  # Parse the configuration file, raising an error if it is invalid YAML.
+  def parse_file
+    YAML.load_file(config_file).tap { |creds| raise unless creds.is_a?(Hash) }
+  rescue
+    raise NoCredsFound, bad_config_file("#{config_file} is not valid YAML.")
+  end
+  private :parse_file
+
+  def bad_config_file(message)
+    <<-EOS.gsub(/^.*\|/, '')
+      |#{message}
+      |
+      |sumo-search now expects its config file (located at #{config_file}) to
+      |be valid YAML. Below is an example of a valid config file:
+      |
+      |backend:
+      |  email: backend@example.com
+      |  password: trustno1
+      |frontend:
+      |  email: frontend@example.com
+      |  password: test-pass-1
+      |
+      |By default, the 'default' credential in #{config_file} will be used. To
+      |change this behavior, set the $SUMO_CREDENTIAL environment varibale
+      |to the credential you would like to use. In the above example, setting
+      |$SUMO_CREDENTIAL to 'frontend' would allow you to access the account with
+      |email 'frontend@example.com' and password 'test-pass-1'.
+    EOS
   end
+  private :bad_config_file
 end

data/lib/sumo/version.rb

@@ -1,8 +1,8 @@
 # This module holds versioning information for the gem.
 module Sumo
-  MAJOR = 1
+  MAJOR = 2
   MINOR = 0
-  PATCH = 3
+  PATCH = 0
   RELEASE = nil
 
   VERSION = [MAJOR, MINOR, PATCH, RELEASE].compact.join('.')

data/spec/fixtures/bad-creds

@@ -0,0 +1 @@
+test@test.net:trustno1

data/spec/fixtures/sumo-creds

@@ -1 +1,3 @@
-test@test.net:trustno1
+engineering:
+  email: test@example.com
+  password: trustno1

data/spec/lib/sumo/client_spec.rb

@@ -2,13 +2,20 @@ require 'spec_helper'
 
 describe Sumo::Client do
   describe '#initialize' do
-    let(:creds) { 'email@email.email:password' }
+    let(:creds) {
+      {
+        'email' => 'test@test.com',
+        'password' => 'example'
+      }
+    }
 
     context 'with no arguments' do
       subject { Sumo::Client.new }
       before { Sumo.stub(:creds).and_return(creds) }
+
       it 'sets the default credentials' do
-        subject.creds.should == creds
+        subject.email.should == 'test@test.com'
+        subject.password.should == 'example'
       end
     end
 
@@ -16,7 +23,8 @@ describe Sumo::Client do
       subject { Sumo::Client.new(creds) }
 
       it 'sets the credentials to that argument' do
-        subject.creds.should == creds
+        subject.email.should == 'test@test.com'
+        subject.password.should == 'example'
       end
     end
   end
@@ -24,8 +32,13 @@ describe Sumo::Client do
   describe '#request' do
     let(:connection) { double(:connection) }
     let(:response) { double(:response) }
-    let(:creds) { 'creds@email.com:test' }
-    let(:encoded) { Base64.encode64(creds).strip }
+    let(:creds) {
+      {
+        'email' => 'creds@email.com',
+        'password' => 'test'
+      }
+    }
+    let(:encoded) { Base64.encode64('creds@email.com:test').strip }
     subject { Sumo::Client.new(creds) }
     before { subject.stub(:connection).and_return(connection) }
 

data/spec/lib/sumo/config_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe Sumo::Config do
+describe Sumo::Config, :current do
   let(:test_config_file) {
     File.join(File.dirname(__FILE__), '..', '..', 'fixtures', 'sumo-creds')
   }
@@ -14,84 +14,35 @@ describe Sumo::Config do
     end
   end
 
-  describe '#file_specified?' do
-    context 'when Sumo::DEFAULT_CONFIG_FILE is not equal to @config_file' do
-      let(:config_file) { '/etc/sumo-creds' }
-      subject { Sumo::Config.new(config_file) }
-
-      it 'returns true' do
-        subject.file_specified?.should be_true
-      end
-    end
-
-    context 'when Sumo::DEFAULT_CONFIG_FILE is equal to @config_file' do
-      subject { Sumo::Config.new }
-
-      it 'returns false' do
-        subject.file_specified?.should be_false
-      end
-    end
-  end
-
-  describe '#env_creds' do
-    let(:email) { 'test@test.net' }
-    let(:password) { 'trustno1' }
-    let(:creds) { [email, password].join(':') }
-
-    before { ENV['SUMO_CREDS'] = creds }
-    after { ENV['SUMO_CREDS'] = nil }
-
-    it 'retrieves the $SUMO_CREDS environment variable' do
-      subject.env_creds.should == creds
-    end
-  end
-
-  describe '#file_creds' do
-    subject { Sumo::Config.new(config_file) }
-
-    context 'when @config_file is not a file' do
-      let(:config_file) { '/not/a/file' }
-
-      it 'returns nil' do
-        subject.file_creds.should be_nil
-      end
-    end
-
-    context 'when @config_file is a file' do
-      let(:config_file) { test_config_file }
-
-      it 'returns the contents of that file' do
-        subject.file_creds.should == File.read(config_file).strip
-      end
-    end
-  end
-
   describe '#load_creds' do
-    let(:email) { 'test@test.net' }
-    let(:password) { 'trustsum1' }
-    let(:creds) { [email, password].join(':') }
+    context 'when #load_creds! raises an error' do
+      before { subject.stub(:load_creds!).and_raise(Sumo::Error::NoCredsFound) }
 
-    before { ENV['SUMO_CREDS'] = creds }
-    after { ENV['SUMO_CREDS'] = nil }
-
-    context 'when a config file is not specified' do
-      it 'prefers the environment variable' do
-        subject.load_creds.should == ENV['SUMO_CREDS']
+      it 'returns nil' do
+        expect(subject.load_creds).to be_nil
       end
     end
 
-    context 'when a config file is specified' do
-      subject { Sumo::Config.new(test_config_file) }
-
-      it 'prefers the config file' do
-        subject.load_creds.should == File.read(test_config_file).strip
+    context 'when #load_creds! does not raise an error' do
+      let(:creds) {
+        {
+          :email => 'test@example.com',
+          :password => 'canthackthis'
+        }
+      }
+      before { subject.stub(:load_creds!).and_return(creds) }
+
+      it 'returns its return value' do
+        expect(subject.load_creds).to eq(creds)
       end
     end
   end
 
   describe '#load_creds!' do
-    context 'when the configuration cannot be found' do
-      before { subject.stub(:load_creds).and_return(nil) }
+    subject { Sumo::Config.new(test_config_file) }
+
+    context 'when the config file does not exist' do
+      before { File.stub(:exists?).and_return(false) }
 
       it 'raises an error' do
         expect { subject.load_creds! }
@@ -99,12 +50,43 @@ describe Sumo::Config do
       end
     end
 
-    context 'when the configuration can be found' do
-      let(:creds) { 'sumo@sumo.net:my-pass' }
-      before { subject.stub(:load_creds).and_return(creds) }
+    context 'when the config file does exist' do
+      context 'when the file is not valid YAML' do
+        let(:test_config_file) {
+          File.join(File.dirname(__FILE__), '..', '..', 'fixtures', 'bad-creds')
+        }
+
+        it 'raises an error' do
+          expect { subject.load_creds! }
+            .to raise_error(Sumo::Error::NoCredsFound)
+        end
+      end
 
-      it 'returns the configuration' do
-        subject.load_creds!.should == creds
+      context 'when the file is valid YAML' do
+        context 'but the specified key cannot be found' do
+          before { ENV['SUMO_CREDENTIAL'] = 'does-not-exist' }
+          after { ENV['SUMO_CREDENTIAL'] = nil }
+
+          it 'raises an error' do
+            expect { subject.load_creds! }
+              .to raise_error(Sumo::Error::NoCredsFound)
+          end
+        end
+
+        context 'when the specified key can be found' do
+          let(:expected) {
+            {
+              'email' => 'test@example.com',
+              'password' => 'trustno1'
+            }
+          }
+          before { ENV['SUMO_CREDENTIAL'] = 'engineering' }
+          after { ENV['SUMO_CREDENTIAL'] = nil }
+
+          it 'returns those credentials' do
+            expect(subject.load_creds!).to eq(expected)
+          end
+        end
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sumo-search
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 2.0.0
 platform: ruby
 authors:
 - Swipely, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-26 00:00:00.000000000 Z
+date: 2014-03-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: excon
@@ -145,6 +145,7 @@ files:
 - lib/sumo/error.rb
 - lib/sumo/search.rb
 - lib/sumo/version.rb
+- spec/fixtures/bad-creds
 - spec/fixtures/sumo-creds
 - spec/lib/sumo/client_spec.rb
 - spec/lib/sumo/config_spec.rb
@@ -183,6 +184,7 @@ signing_key:
 specification_version: 4
 summary: A simple REST client for the Sumo Search Job API
 test_files:
+- spec/fixtures/bad-creds
 - spec/fixtures/sumo-creds
 - spec/lib/sumo/client_spec.rb
 - spec/lib/sumo/config_spec.rb