papertrail 0.9.18 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 973d907611de02622b404c3fd7b1904e1158229c
-  data.tar.gz: 8286cef976ddf379f33b5bea083cfdfcc448e98c
+  metadata.gz: ea790fef3b0c4239577138618f98b3aa12d4c366
+  data.tar.gz: bde482d33ce1b144314af54f01fe4f334924b59a
 SHA512:
-  metadata.gz: 6b79a2b28652befee191d8415c879f3c92f7eecb3a92c1a4ba79ea37e871ce4baa21a57cb9cda3d9a6fe6e98b3bf38e5450c5c4e0bf676b1261c58c3fc3f5fac
-  data.tar.gz: 40a8d133cb3c17bb54eecec80ab9086f7c4c9e1edaa1fed9d521f97a3c598d3a2e52b2cc13c93f11e36e351d7b8f8b24153c9799542034adf788b96518049469
+  metadata.gz: 17ed6f10ebd3ba1e8cfb4b4d1fee258314ac62293cbc9d8c31ba71e079724ce61188b22dd64ef5046ffe2756e3db385b4c05cca58f77636de60d47e3ffe5a7b2
+  data.tar.gz: d33c5d61a76d488afb1404aaa30740a082184c40ba6b75e6beeaa00db2ccadcff3302702c4f79986c2383f14eb946e6819364fc9fdaf0f8fdd123a940fb37237

data/Gemfile

@@ -1,4 +1,3 @@
 source 'https://rubygems.org'
 
-gemspec
-
+gemspec

data/Guardfile

@@ -0,0 +1,5 @@
+guard :minitest do
+  watch(%r{^test/(.*)_test.rb$})
+  watch(%r{^lib/(.*/)?([^/]+)\.rb$})     { |m| "test/#{m[2]}_test.rb" }
+  watch(%r{^test/test_helper\.rb$})      { 'test' }
+end

data/README.md

@@ -1,5 +1,7 @@
 # papertrail command-line tail & search client for Papertrail log management service
 
+[![Build Status](https://travis-ci.org/papertrail/papertrail-cli.svg?branch=master)](https://travis-ci.org/papertrail/papertrail-cli)
+
 Small standalone [binary] to retrieve, search, and tail recent app
 server log and system syslog messages from [Papertrail].
 
@@ -271,6 +273,12 @@ To see usage, run any of these commands with `--help`: `papertrail-add-system`,
 
 ## Contribute
 
+Testing:
+
+Run all the tests with `rake`
+
+To run the tests when files save, run `bundle exec guard` (requires ruby version >= 2.2.5).
+
 Bug report:
 
 1. See whether the issue has already been reported:

data/Rakefile

@@ -52,26 +52,10 @@ task :default => :test
 require 'rake/testtask'
 Rake::TestTask.new(:test) do |test|
   test.libs << 'lib' << 'test'
-  test.pattern = 'test/**/test_*.rb'
+  test.pattern = 'test/*_test.rb'
   test.verbose = true
 end
 
-desc "Generate RCov test coverage and open in your browser"
-task :coverage do
-  require 'rcov'
-  sh "rm -fr coverage"
-  sh "rcov test/test_*.rb"
-  sh "open coverage/index.html"
-end
-
-require 'rdoc/task'
-Rake::RDocTask.new do |rdoc|
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "#{name} #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
-
 desc "Open an irb session preloaded with this library"
 task :console do
   sh "irb -rubygems -r ./lib/#{name}.rb"

data/lib/papertrail.rb

@@ -1,5 +1,5 @@
 module Papertrail
-  VERSION = '0.9.18'
+  VERSION = '0.10.0'
 end
 
 require 'papertrail/connection'

data/lib/papertrail/cli.rb

@@ -122,18 +122,18 @@ module Papertrail
       @query ||= ARGV.join ' '
 
       if options[:follow]
-        search_query = connection.query(@query, query_options)
+        search_query = Papertrail::SearchQuery.new(connection, @query, query_options)
 
         loop do
-          display_results(search_query.search)
+          display_results(search_query.next_results_page)
           sleep options[:delay]
         end
       elsif options[:min_time]
         query_time_range
       else
         set_min_max_time!(options, query_options)
-        search_query = connection.query(@query, query_options)
-        display_results(search_query.search)
+        search_query = Papertrail::SearchQuery.new(connection, @query, query_options)
+        display_results(search_query.next_results_page)
       end
     end
 

data/lib/papertrail/connection.rb

@@ -165,10 +165,6 @@ module Papertrail
       end
     end
 
-    def query(query = nil, options = {})
-      Papertrail::SearchQuery.new(self, query, options)
-    end
-
     def each_event(query_term = nil, options = {}, &block)
       # If there was no query but there were options, shuffle around
       # the parameters
@@ -177,7 +173,7 @@ module Papertrail
       end
 
       # Remove all of the options that shouldn't be in each query
-      options  = options.dup
+      options  = { :tail => false }.merge(options)
       min_id   = options.delete(:min_id)
       max_id   = options.delete(:max_id)
       min_time = options.delete(:min_time)
@@ -185,47 +181,39 @@ module Papertrail
 
       # Figure out where to start querying
       if min_id
-        search_results = query(query_term, options.merge(:min_id => min_id, :tail => false)).search
+        search = search_query(query_term, options.merge(:min_id => min_id))
       elsif min_time
-        search_results = query(query_term, options.merge(:min_time => min_time.to_i, :tail => false)).search
+        search = search_query(query_term, options.merge(:min_time => min_time.to_i))
       else
         raise ArgumentError, "Either :min_id or :min_time must be specified"
       end
 
       # Start processing events
       loop do
+        search_results = search.next_results_page
         search_results.events.each do |event|
           # If we've found an event beyond what we were looking for, we're done
-          if max_time && event.received_at > max_time
-            break
-          end
-
-          if max_id && event.id > max_id
-            break
-          end
+          break if max_time && event.received_at > max_time
+          break if max_id && event.id > max_id
 
           block.call(event)
         end
 
         # If we've found the end of what we're looking for, we're done
-        if max_time && search_results.max_time_at > max_time
-          break
-        end
-
-        if max_id && search_results.max_id > max_id
-          break
-        end
+        break if max_time && search_results.max_time_at > max_time
+        break if max_id && search_results.max_id > max_id
 
         # If we've reached the most current log message, we're done
-        if search_results.reached_end?
-          break
-        end
-
-        # Perform the next search
-        search_results = query(query_term, options.merge(:min_id => search_results.max_id, :tail => false)).search
+        break if search_results.reached_end?
       end
 
       nil
     end
+
+    private
+
+    def search_query(query = nil, options = {})
+      Papertrail::SearchQuery.new(self, query, options)
+    end
   end
 end

data/lib/papertrail/http_client.rb

@@ -47,7 +47,7 @@ module Papertrail
 
     def get(path, params = {})
       if params.size > 0
-        path = "#{path}?#{build_nested_query(params)}"
+        path = "#{path}?cli_version=#{Papertrail::VERSION}&#{build_nested_query(params)}"
       end
       attempts = 0
       begin

data/lib/papertrail/search_query.rb

@@ -1,21 +1,48 @@
 require 'papertrail/search_result'
 
+# SearchQuery manages pagination.
+# Once initialized, call `next_results_page` for a page of results
+# And call it again to get the next page, and again and again
 module Papertrail
   class SearchQuery
+    def self.api_url
+      '/api/v1/events/search.json'
+    end
+
+    def self.initial_search_limit
+      100
+    end
+
+    def self.subsequent_search_limit
+      1000
+    end
+
     def initialize(connection, query = nil, options = {})
       @connection = connection
       @query      = query
       @options    = options
     end
 
-    def search
+    attr_accessor :max_id, :subsequent_request
+
+    def next_results_page
       params = @options.dup
-      params[:q] = @query  if @query
+      params[:q] = @query if @query
       params[:min_id] = @max_id if @max_id
+      params[:limit] ||= default_request_limit
 
-      response = @connection.get('/api/v1/events/search.json', params)
+      response = @connection.get(self.class.api_url, params)
       @max_id = response.body['max_id']
       Papertrail::SearchResult.new(response.body)
     end
+
+    def default_request_limit
+      if subsequent_request
+        self.class.subsequent_search_limit
+      else
+        @subsequent_request = true
+        self.class.initial_search_limit
+      end
+    end
   end
 end

data/papertrail.gemspec

@@ -1,9 +1,5 @@
-## This is the rakegem gemspec template. Make sure you read and understand
-## all of the comments. Some sections require modification, and others can
-## be deleted if you don't need them. Once you understand the contents of
-## this file, feel free to delete any comments that begin with two hash marks.
-## You can find comprehensive Gem::Specification documentation, at
-## http://docs.rubygems.org/read/chapter/20
+## This is the rakegem gemspec template
+## Look at the Rakefile for additional information on packaging, building and validation
 Gem::Specification.new do |s|
   s.specification_version = 2 if s.respond_to? :specification_version=
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
@@ -13,8 +9,8 @@ Gem::Specification.new do |s|
   ## If your rubyforge_project name is different, then edit it and comment out
   ## the sub! line in the Rakefile
   s.name              = 'papertrail'
-  s.version           = '0.9.18'
-  s.date              = '2016-11-28'
+  s.version           = '0.10.0'
+  s.date              = '2016-12-02'
   s.rubyforge_project = 'papertrail'
 
   ## Make sure your summary is short. The description may be as long
@@ -56,6 +52,13 @@ Gem::Specification.new do |s|
   ## List your development dependencies here. Development dependencies are
   ## those that are only needed during development
   s.add_development_dependency('rake', '~> 10.4')
+  s.add_development_dependency('minitest')
+  s.add_development_dependency('mocha')
+
+  if RUBY_VERSION > '2.2.4' # ruby_dep dependency
+    s.add_development_dependency('guard', '~> 2.14.0')
+    s.add_development_dependency('guard-minitest', '~> 2.4.6')
+  end
 
   ## Leave this section as-is. It will be automatically generated from the
   ## contents of your Git repository via the gemspec task. DO NOT REMOVE
@@ -63,6 +66,7 @@ Gem::Specification.new do |s|
   # = MANIFEST =
   s.files = %w[
     Gemfile
+    Guardfile
     LICENSE
     README.md
     Rakefile
@@ -88,6 +92,9 @@ Gem::Specification.new do |s|
     lib/papertrail/search_query.rb
     lib/papertrail/search_result.rb
     papertrail.gemspec
+    test/connection_test.rb
+    test/search_query_test.rb
+    test/test_helper.rb
   ]
   # = MANIFEST =
 

data/test/connection_test.rb

@@ -0,0 +1,10 @@
+require 'test_helper'
+
+class ConnectionTest < Minitest::Test
+  let(:connection_options) { { :token => 'dummy' } }
+  let(:connection) { Papertrail::Connection.new(connection_options) }
+
+  def test_each_event
+    skip
+  end
+end

data/test/search_query_test.rb

@@ -0,0 +1,49 @@
+require 'test_helper'
+
+class SearchQueryTest < Minitest::Test
+  let(:connection_options) { { :token => 'dummy' } }
+  let(:connection) { Papertrail::Connection.new(connection_options) }
+  let(:api_url) { Papertrail::SearchQuery.api_url }
+  let(:default_initial_params) { { :limit => Papertrail::SearchQuery.initial_search_limit } }
+  let(:get_response) { OpenStruct.new(:body => { 'max_id' => 122, 'events' => [] }) }
+
+  describe 'default options' do
+    let(:search_query) { Papertrail::SearchQuery.new(connection) }
+    let(:target_params) do
+      {
+        :min_id => 122,
+        :limit => Papertrail::SearchQuery.subsequent_search_limit
+      }
+    end
+
+    def test_sets_min_id_for_initial_and_subsequent_requests
+      # Test that the first request happens with the default_initial_params
+      connection.expects(:get).with(api_url, default_initial_params).returns(get_response)
+      search_query.next_results_page
+      # And that subsequent requests use the updated min_id and limit
+      connection.expects(:get).with(api_url, target_params).returns(get_response)
+      search_query.next_results_page
+    end
+  end
+
+  describe 'passed options' do
+    let(:options) do
+      {
+        :group_id => 12,
+        :system_id => 22,
+        :min_id => 100,
+        :limit => 2
+      }
+    end
+    let(:search_query) { Papertrail::SearchQuery.new(connection, 'some search', options) }
+    let(:target_first_params) { options.merge(:q => 'some search') }
+    let(:target_subsequent_params) { target_first_params.merge(:min_id => 122) } # Max ID from get_response
+
+    def test_sets_options_from_passed_options_and_ups_min_id
+      connection.expects(:get).with(api_url, target_first_params).returns(get_response)
+      search_query.next_results_page
+      connection.expects(:get).with(api_url, target_subsequent_params).returns(get_response)
+      search_query.next_results_page
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,11 @@
+require 'minitest/autorun'
+require 'minitest/pride' # Color!
+require 'mocha/mini_test'
+
+require 'pp'
+
+class Minitest::Test
+  extend Minitest::Spec::DSL # Add let blocks
+end
+
+require './lib/papertrail'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: papertrail
 version: !ruby/object:Gem::Version
-  version: 0.9.18
+  version: 0.10.0
 platform: ruby
 authors:
 - Papertrail
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-28 00:00:00.000000000 Z
+date: 2016-12-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: chronic
@@ -52,6 +52,62 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.4'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  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: mocha
+  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: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.14.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.14.0
+- !ruby/object:Gem::Dependency
+  name: guard-minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.4.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.4.6
 description: Command-line client for Papertrail hosted log management service. Tails
   and searches app server logs and system syslog. Supports Boolean search and works
   with grep and pipe output (Unix).
@@ -67,6 +123,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - Gemfile
+- Guardfile
 - LICENSE
 - README.md
 - Rakefile
@@ -92,6 +149,9 @@ files:
 - lib/papertrail/search_query.rb
 - lib/papertrail/search_result.rb
 - papertrail.gemspec
+- test/connection_test.rb
+- test/search_query_test.rb
+- test/test_helper.rb
 homepage: http://github.com/papertrail/papertrail-cli
 licenses:
 - MIT
@@ -117,4 +177,5 @@ rubygems_version: 2.4.8
 signing_key: 
 specification_version: 2
 summary: Command-line client for Papertrail hosted log management service.
-test_files: []
+test_files:
+- test/test_helper.rb