sumo-search 2.0.3 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 27b7af6b07a96c23c0583a4dea06fcfb5bf118d2
-  data.tar.gz: 9e5b066988e0bd14f73fb82b261ca7930a92a2e8
+  metadata.gz: 34911b9efb6c328c089cda2f45d3b6ddbe941c98
+  data.tar.gz: 9ff1594f807e696be3b703609f322289cff41c52
 SHA512:
-  metadata.gz: 16a15d1e68e1ac6601bc7bd8471092bee2c744c9ffcb32c63b17e942162cad3cd6828d665d10b69ffa0b991153e9b43319b4bdd1f8a7307d23b714291c3156f2
-  data.tar.gz: 05fb4b9cd0ffcf642160fcdcbef91c55d88ebd7714a8b260d80c9f01b044e9e21da449fc1addb27053474798872fe7c0ef33ab0a992803170078042da91e64b6
+  metadata.gz: 367766f8515371162e4be5bdffffc4d2f805e363fae0265640e0e7f655ce96531e1e4312d46d3944e0683cf6f6cd90484474faa20a29d5913294f544695621d9
+  data.tar.gz: 6c812fc6cc43eb95156b825a51e4ea9a1f54c609a98ffa66c684d4c9e86af289973b2da77da52ddef3ac08366193dc1ee8973db912b3441e066ca55c12bf5d61

data/lib/sumo/client.rb

@@ -4,6 +4,8 @@ class Sumo::Client
 
   attr_reader :email, :password, :cookie
 
+  REDIRECT_STATUSES = [301, 302, 303, 307, 308]
+
   # The error message raised when the result can be parsed from Sumo.
   DEFAULT_ERROR_MESSAGE = 'Error sending API request'
 
@@ -13,13 +15,25 @@ class Sumo::Client
     @password = credentials['password'].freeze
   end
 
-  # Send a HTTP request to the server, handling any errors that may occur.
+  # Send a request to the API and retrieve processed data.
   def request(hash, &block)
-    response = connection.request(add_defaults(hash), &block)
+    handle_request(hash, &block).body
+  end
+
+  # Send a HTTP request to the server, handling any errors that may occur.
+  def handle_request(hash, endpoint = nil, depth = 0, &block)
+    response = connection(endpoint).request(add_defaults(hash), &block)
+
+    if REDIRECT_STATUSES.include?(response.status) &&
+       response.headers['Location']
+      response = handle_redirect(response, hash, depth, &block)
+    end
+
     handle_errors!(response)
     set_cookie!(response)
-    response.body
+    response
   end
+  private :handle_request
 
   # Define methods for the HTTP methods used by the API (#get, #post, and
   # #delete).
@@ -32,13 +46,27 @@ class Sumo::Client
   # Private functions that operate on the request and response.
 
   def add_defaults(hash)
-    hash.merge(
-      :headers => default_headers.merge(hash[:headers] || {}),
-      :path => "/api/v#{Sumo::API_VERSION}#{hash[:path]}"
-    )
+    hash[:headers] = default_headers.merge(hash[:headers] || {})
+    hash[:path] = "/api/v#{Sumo::API_VERSION}#{hash[:path]}" unless
+      hash[:path].index("/api/v#{Sumo::API_VERSION}") == 0
+    hash
   end
   private :add_defaults
 
+  # Recursively handle redirection up to 10 level depth
+  def handle_redirect(response, hash, depth, &block)
+    fail 'Too many redirections.' if depth > 9
+
+    endpoint = response.headers['Location']
+               .match(%r{^(https://.+\.[a-z]+)/}).to_a[1]
+
+    depth += 1
+    # I tried to blindly follow redirection path, but it omits the job ID.
+    # hash[:path] = path
+    handle_request(hash, endpoint, depth, &block)
+  end
+  private :handle_redirect
+
   def handle_errors!(response)
     case response.status
     when 400..499 then raise ClientError, extract_error_message(response.body)
@@ -79,8 +107,13 @@ class Sumo::Client
   end
   private :creds
 
-  def connection
-    @connection ||= Excon.new('https://api.sumologic.com')
+  def connection(endpoint = nil)
+    @connections ||= {}
+    endpoint ||= 'https://api.sumologic.com'
+
+    fail 'Base url out of allowed domain.' unless
+      endpoint.match(%r{^https://.+\.sumologic\.com$})
+    @connections[endpoint] ||= Excon.new(endpoint)
   end
   private :connection
 end

data/lib/sumo/version.rb

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

data/spec/lib/sumo/client_spec.rb

@@ -46,6 +46,7 @@ describe Sumo::Client do
       subject.stub(:handle_errors!)
       response.stub(:body)
       response.stub(:headers).and_return({})
+      response.stub(:status).and_return(200)
       connection.should_receive(:request)
                 .with(
                   :method => :get,
@@ -134,6 +135,118 @@ describe Sumo::Client do
         end
       end
     end
+
+    context 'when a 3xx-level status code is returned by the API' do
+      let(:cookie) { 'oreo' }
+      let(:headers) { {'Set-Cookie' => cookie } }
+      let(:default_connection) { double(:default_connection) }
+      let(:redirect_connection) { double(:redirect_connection) }
+
+      before do
+        # Do not stub full connection method but only Excon.
+        subject.stub(:connection).and_call_original
+        default_connection.stub(:request).and_return(response)
+        allow(Excon).to receive(:new)
+          .with('https://api.sumologic.com').and_return default_connection
+        allow(Excon).to receive(:new)
+          .with('https://api.us2.sumologic.com').and_return redirect_connection
+      end
+
+      context 'and the redirection url is within sumologic domain' do
+        let(:response) do
+          double(:response, :status => 301, :body => '', :headers => {
+            'Location' => 'https://api.us2.sumologic.com/api/v1/jobs'
+          })
+        end
+        let(:final_response) do
+          double(:response, :status => 200, :body => '', :headers => {})
+        end
+
+        it 'should follow it' do
+          expect(default_connection).to receive(:request)
+                  .with(
+                    :method => :get,
+                    :path => '/api/v1/',
+                    :headers => {
+                      'Content-Type' => 'application/json',
+                      'Accept' => 'application/json',
+                      'Authorization' => "Basic #{encoded}" })
+                  .and_return(response)
+
+          expect(redirect_connection).to receive(:request)
+            .with(
+              :method => :get,
+              :path => '/api/v1/',
+              :headers => {
+                'Content-Type' => 'application/json',
+                'Accept' => 'application/json',
+                'Authorization' => "Basic #{encoded}" })
+            .and_return(final_response)
+          subject.request(:method => :get, :path => '/')
+        end
+      end
+
+      context 'and the redirection url is outside of sumologic' do
+        let(:response) do
+          double(:response, :status => 301, :body => '', :headers => {
+            'Location' => 'https://donotfollow.me/api/v1/jobs'
+          })
+        end
+
+        it 'should not follow it' do
+          expect(default_connection).to receive(:request)
+                  .with(
+                    :method => :get,
+                    :path => '/api/v1/',
+                    :headers => {
+                      'Content-Type' => 'application/json',
+                      'Accept' => 'application/json',
+                      'Authorization' => "Basic #{encoded}" })
+                  .once
+                  .and_return(response)
+          expect(Excon).not_to receive(:new)
+            .with('https://donotfollow.me')
+          expect do
+            subject.request(:method => :get, :path => '/')
+          end.to raise_error 'Base url out of allowed domain.'
+        end
+      end
+
+      context 'and there is a redirection loop' do
+        let(:response) do
+          double(:response, :status => 301, :body => '', :headers => {
+            'Location' => 'https://api.us2.sumologic.com/api/v1/jobs'
+          })
+        end
+
+        it 'should throw a too many redirections error' do
+          expect(default_connection).to receive(:request)
+                  .with(
+                    :method => :get,
+                    :path => '/api/v1/',
+                    :headers => {
+                      'Content-Type' => 'application/json',
+                      'Accept' => 'application/json',
+                      'Authorization' => "Basic #{encoded}" })
+                  .and_return(response)
+
+          expect(redirect_connection).to receive(:request)
+            .with(
+              :method => :get,
+              :path => '/api/v1/',
+              :headers => {
+                'Content-Type' => 'application/json',
+                'Accept' => 'application/json',
+                'Authorization' => "Basic #{encoded}" })
+            .exactly(10).times
+            .and_return(response)
+
+          expect do
+            subject.request(:method => :get, :path => '/')
+          end.to raise_error 'Too many redirections.'
+        end
+      end
+    end
   end
 
   [:get, :post, :delete].each do |http_method|

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sumo-search
 version: !ruby/object:Gem::Version
-  version: 2.0.3
+  version: 2.1.0
 platform: ruby
 authors:
 - Swipely, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-10 00:00:00.000000000 Z
+date: 2015-09-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: excon