papertrail 0.10.0 → 0.11.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: ea790fef3b0c4239577138618f98b3aa12d4c366
-  data.tar.gz: bde482d33ce1b144314af54f01fe4f334924b59a
+SHA256:
+  metadata.gz: ffe54b3afcb866c1d80ccadf5deff840bbc2d8e9fb851ec2054f0869160eb565
+  data.tar.gz: 13e987776d80aedee04422b2490a09123e2045bdc0a220069931a2047e354009
 SHA512:
-  metadata.gz: 17ed6f10ebd3ba1e8cfb4b4d1fee258314ac62293cbc9d8c31ba71e079724ce61188b22dd64ef5046ffe2756e3db385b4c05cca58f77636de60d47e3ffe5a7b2
-  data.tar.gz: d33c5d61a76d488afb1404aaa30740a082184c40ba6b75e6beeaa00db2ccadcff3302702c4f79986c2383f14eb946e6819364fc9fdaf0f8fdd123a940fb37237
+  metadata.gz: 13122c148a5417fe71ab68baf78c689ed52178d7c5176b7d194684167f0d1a95ada468666bef37d8a5bf3dccedacbaab93e5c40d44642af2f670b1f7580ddd8c
+  data.tar.gz: e5afab539b26cc93d45d3d44da399efa4d3547f2071451f5c765cdff093e4a212338b20c26ae402cee521e7158f27792cd26558dd07a3305b5f5bb59ea532bc3

data/README.md

@@ -298,7 +298,7 @@ to your enhancement.
 [Papertrail]: http://papertrailapp.com/
 [Connection]: https://github.com/papertrail/papertrail-cli/blob/master/lib/papertrail/connection.rb
 [HTTP API]: http://help.papertrailapp.com/kb/how-it-works/http-api
-[User Profile]: https://papertrailapp.com/user/edit
+[User Profile]: https://papertrailapp.com/account/profile
 [RubyGems]: https://rubygems.org/gems/papertrail-cli
 [lnav]: http://lnav.org/
 [escape characters]: http://en.wikipedia.org/wiki/ANSI_escape_code#Colors

data/bin/papertrail-add-group

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+require 'papertrail'
 require 'papertrail/cli_add_group'
 
 begin

data/bin/papertrail-add-system

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+require 'papertrail'
 require 'papertrail/cli_add_system'
 
 begin

data/bin/papertrail-join-group

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+require 'papertrail'
 require 'papertrail/cli_join_group'
 
 begin

data/bin/papertrail-leave-group

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+require 'papertrail'
 require 'papertrail/cli_leave_group'
 
 begin

data/bin/papertrail-remove-system

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+require 'papertrail'
 require 'papertrail/cli_remove_system'
 
 begin

data/lib/papertrail.rb

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

data/lib/papertrail/cli.rb

@@ -95,6 +95,9 @@ module Papertrail
 
       @connection = Papertrail::Connection.new(options)
 
+      # Use HTTP Keep-Alive unless delay is too long
+      connection.start if options[:delay] < 10
+
       if options[:system]
         query_options[:system_id] = connection.find_id_for_source(options[:system])
         unless query_options[:system_id]
@@ -166,7 +169,7 @@ module Papertrail
 
       idx = attribs.hash % 5
       color = COLORS[idx]
-      pre  = "#{event.received_at.strftime('%b %e %X')} #{event.data['hostname']} #{event.data['program']}:"
+      pre  = "#{event.received_at.strftime('%b %d %X')} #{event.data['hostname']} #{event.data['program']}:"
       post = " #{event.data['message']}"
       pre.ansi(color) + post
     end

data/lib/papertrail/cli_add_group.rb

@@ -46,15 +46,16 @@ module Papertrail
 
       raise OptionParser::MissingArgument, 'group' if options[:group].nil?
 
-      connection = Papertrail::Connection.new(options)
-
-      # Bail if group already exists
-      if connection.show_group(options[:group])
-        exit 0
-      end
+      Papertrail::Connection.new(options).start do |connection|
+        # Bail if group already exists
+        existing = connection.show_group(options[:group])
+        if existing && existing['name'].upcase == options[:group].upcase
+          exit 0
+        end
 
-      if connection.create_group(options[:group], options[:wildcard])
-        exit 0
+        if connection.create_group(options[:group], options[:wildcard])
+          exit 0
+        end
       end
 
       exit 1

data/lib/papertrail/cli_add_system.rb

@@ -84,19 +84,20 @@ module Papertrail
         error 'Either --ip-address or --destination-port most be provided'
       end
 
-      connection = Papertrail::Connection.new(options)
-
-      # Bail if system already exists
-      if connection.show_source(options[:system])
-        exit 0
-      end
+      Papertrail::Connection.new(options).start do |connection|
+        # Bail if system already exists
+        existing = connection.show_source(options[:system])
+        if existing && existing['name'].upcase == options[:system].upcase
+          exit 0
+        end
 
-      if options[:destination_port] && !options[:hostname]
-        options[:hostname] = options[:system]
-      end
+        if options[:destination_port] && !options[:hostname]
+          options[:hostname] = options[:system]
+        end
 
-      if connection.register_source(options[:system], options)
-        exit 0
+        if connection.register_source(options[:system], options)
+          exit 0
+        end
       end
 
       exit 1

data/lib/papertrail/connection.rb

@@ -38,19 +38,32 @@ module Papertrail
       end
     end
 
+    def start
+      if block_given?
+        @connection.start { yield self }
+      else
+        @connection.start
+        self
+      end
+    end
+
+    def finish
+      @connection.finish
+    end
+
     def find_id_for_source(name)
-      response = @connection.get('systems.json')
+      response = @connection.get('systems.json', :system_name => name)
 
       find_id_for_item(response.body, name)
     end
 
     def find_id_for_group(name)
-      response = @connection.get('groups.json')
+      response = @connection.get('groups.json', :group_name => name)
       find_id_for_item(response.body, name)
     end
 
     def find_search(name, group_id = nil)
-      response = @connection.get('searches.json')
+      response = @connection.get('searches.json', :search_name => name)
 
       candidates = find_items_by_name(response.body, name)
       return nil if candidates.empty?

data/lib/papertrail/event.rb

@@ -13,7 +13,7 @@ module Papertrail
     end
 
     def to_s
-      "#{received_at.strftime('%b %e %X')} #{data['hostname']} #{data['program']}: #{data['message']}"
+      "#{received_at.strftime('%b %d %X')} #{data['hostname']} #{data['program']}: #{data['message']}"
     end
   end
 end

data/lib/papertrail/http_client.rb

@@ -37,6 +37,19 @@ module Papertrail
       @headers = {}
     end
 
+    def start
+      if block_given?
+        https.start { yield self }
+      else
+        https.start
+        self
+      end
+    end
+
+    def finish
+      https.finish
+    end
+
     def basic_auth(login, pass)
       @headers['Authorization'] = 'Basic ' + ["#{login}:#{pass}"].pack('m').delete("\r\n")
     end
@@ -46,73 +59,62 @@ module Papertrail
     end
 
     def get(path, params = {})
-      if params.size > 0
-        path = "#{path}?cli_version=#{Papertrail::VERSION}&#{build_nested_query(params)}"
-      end
-      attempts = 0
-      begin
-        on_complete(https.get(request_uri(path), @headers))
-      rescue SystemCallError, Net::HTTPFatalError => e
-        sleep 5.0
-        attempts += 1
-        retry if (attempts < 3)
-        raise e
-      end
+      request(:get, path, params)
     end
 
     def put(path, params)
-      attempts = 0
-      begin
-        on_complete(https.put(request_uri(path), build_nested_query(params), @headers))
-      rescue SystemCallError, Net::HTTPFatalError => e
-        attempts += 1
-        retry if (attempts < 3)
-        raise e
-      end
+      request(:put, path, params)
     end
 
     def post(path, params)
-      attempts = 0
-      begin
-        on_complete(https.post(request_uri(path), build_nested_query(params), @headers))
-      rescue SystemCallError, Net::HTTPFatalError => e
-        attempts += 1
-        retry if (attempts < 3)
-        raise e
-      end
+      request(:post, path, params)
     end
 
     def delete(path)
+      request(:delete, path)
+    end
+
+    private
+
+    def request(http_method, path, params = {})
       attempts = 0
+      uri = "#{request_uri(path)}?cli_version=#{Papertrail::VERSION}&"
       begin
-        on_complete(https.delete(request_uri(path), @headers))
-      rescue SystemCallError, Net::HTTPFatalError => e
+        if http_method == :get || http_method == :delete
+          on_complete(https.send(http_method, uri + build_nested_query(params.merge(cli_version)), @headers))
+        else
+          on_complete(https.send(http_method, uri, build_nested_query(params), @headers))
+        end
+      rescue IOError, SystemCallError, Net::HTTPFatalError => e
         attempts += 1
         retry if (attempts < 3)
         raise e
       end
     end
 
-    private
-
     def request_uri(path)
       path.start_with?('/api/v1/') ? path : "/api/v1/#{path}"
     end
 
     def https
-      http = Net::HTTP.new('papertrailapp.com', 443)
-      http.use_ssl      = true
-      http.verify_mode  = ssl_verify_mode
-      http.cert_store   = ssl_cert_store
-
-      http.cert         = @ssl[:client_cert]  if @ssl[:client_cert]
-      http.key          = @ssl[:client_key]   if @ssl[:client_key]
-      http.ca_file      = @ssl[:ca_file]      if @ssl[:ca_file]
-      http.ca_path      = @ssl[:ca_path]      if @ssl[:ca_path]
-      http.verify_depth = @ssl[:verify_depth] if @ssl[:verify_depth]
-      http.ssl_version  = @ssl[:version]      if @ssl[:version]
-
-      http
+      @https ||= Net::HTTP.new('papertrailapp.com', 443).tap do |http|
+        http.use_ssl      = true
+        http.verify_mode  = ssl_verify_mode
+        http.cert_store   = ssl_cert_store
+
+        http.cert         = @ssl[:client_cert]  if @ssl[:client_cert]
+        http.key          = @ssl[:client_key]   if @ssl[:client_key]
+        http.ca_file      = @ssl[:ca_file]      if @ssl[:ca_file]
+        http.ca_path      = @ssl[:ca_path]      if @ssl[:ca_path]
+        http.verify_depth = @ssl[:verify_depth] if @ssl[:verify_depth]
+        http.ssl_version  = @ssl[:version]      if @ssl[:version]
+
+        http.keep_alive_timeout = 10 if http.respond_to?(:keep_alive_timeout=)
+      end
+    end
+
+    def cli_version
+      { :cli_version => Papertrail::VERSION }
     end
 
     def ssl_verify_mode

data/papertrail.gemspec

@@ -9,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.10.0'
-  s.date              = '2016-12-02'
+  s.version           = '0.11.1'
+  s.date              = '2021-05-27'
   s.rubyforge_project = 'papertrail'
 
   ## Make sure your summary is short. The description may be as long
@@ -55,6 +55,10 @@ Gem::Specification.new do |s|
   s.add_development_dependency('minitest')
   s.add_development_dependency('mocha')
 
+  if RUBY_VERSION > '1.9'
+    s.add_development_dependency('addressable',  '~> 2.4.0')
+    s.add_development_dependency('webmock',  '~> 1.24.6')
+  end
   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')
@@ -93,6 +97,7 @@ Gem::Specification.new do |s|
     lib/papertrail/search_result.rb
     papertrail.gemspec
     test/connection_test.rb
+    test/http_client_test.rb
     test/search_query_test.rb
     test/test_helper.rb
   ]

data/test/connection_test.rb

@@ -4,6 +4,17 @@ class ConnectionTest < Minitest::Test
   let(:connection_options) { { :token => 'dummy' } }
   let(:connection) { Papertrail::Connection.new(connection_options) }
 
+  def test_start_finish
+    assert_same connection, connection.start
+    assert_nil connection.finish
+
+    block_args = nil
+    connection.start {|*args| block_args = args}
+    assert_equal [connection], block_args
+
+    assert_raises { connection.finish }
+  end
+
   def test_each_event
     skip
   end

data/test/http_client_test.rb

@@ -0,0 +1,46 @@
+require 'test_helper'
+
+class HttpClientTest < Minitest::Test
+  let(:http) { Papertrail::HttpClient.new({}) }
+  describe 'http methods' do
+    def test_start_finish
+      assert_same http, http.start
+      assert_nil http.finish
+
+      block_args = nil
+      http.start {|*args| block_args = args}
+      assert_equal [http], block_args
+
+      assert_raises { http.finish }
+    end
+
+    def test_cli_version_present_in_http_methods
+      return if RUBY_VERSION < '2.0'
+      # if webmock.disable_net_connect intervenes with a stack trace,
+      # we know the http methods are not sending cli_version in params
+      stub_request(:get, "https://papertrailapp.com/api/v1/some-path?cli_version=#{Papertrail::VERSION}&").to_return(:status => 200, :body => '', :headers => {})
+      http.get('some-path')
+
+      stub_request(:post, "https://papertrailapp.com/api/v1/some-path?cli_version=#{Papertrail::VERSION}&").to_return(:status => 200, :body => '', :headers => {})
+      http.post('some-path', {})
+
+
+      stub_request(:put, "https://papertrailapp.com/api/v1/some-path?cli_version=#{Papertrail::VERSION}&").to_return(:status => 200, :body => '', :headers => {})
+      http.put('some-path', {})
+
+      stub_request(:delete, "https://papertrailapp.com/api/v1/some-path?cli_version=#{Papertrail::VERSION}&").to_return(:status => 200, :body => '', :headers => {})
+      http.delete('some-path')
+    end
+  end
+
+  describe 'build nested query' do
+    def test_value_accepts_hash
+      assert_equal(http.send(:build_nested_query, {}), "")
+      assert_equal(http.send(:build_nested_query, {:a => 1}), "a=1")
+    end
+    def test_value_accepts_array
+      assert_equal(http.send(:build_nested_query, []), "")
+      assert_equal(http.send(:build_nested_query, [1,2]), "%5B%5D=1&%5B%5D=2")
+    end
+  end
+end

data/test/test_helper.rb

@@ -1,6 +1,11 @@
+gem "minitest"
 require 'minitest/autorun'
 require 'minitest/pride' # Color!
-require 'mocha/mini_test'
+require 'mocha/minitest'
+unless RUBY_VERSION < '1.9'
+  require 'webmock/minitest'
+  WebMock.disable_net_connect!
+end
 
 require 'pp'
 
@@ -8,4 +13,4 @@ class Minitest::Test
   extend Minitest::Spec::DSL # Add let blocks
 end
 
-require './lib/papertrail'
+require './lib/papertrail'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: papertrail
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.11.1
 platform: ruby
 authors:
 - Papertrail
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-12-02 00:00:00.000000000 Z
+date: 2021-05-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: chronic
@@ -80,6 +80,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: addressable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.4.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.4.0
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.24.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.24.6
 - !ruby/object:Gem::Dependency
   name: guard
   requirement: !ruby/object:Gem::Requirement
@@ -150,13 +178,14 @@ files:
 - lib/papertrail/search_result.rb
 - papertrail.gemspec
 - test/connection_test.rb
+- test/http_client_test.rb
 - test/search_query_test.rb
 - test/test_helper.rb
 homepage: http://github.com/papertrail/papertrail-cli
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options:
 - "--charset=UTF-8"
 require_paths:
@@ -172,9 +201,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: papertrail
-rubygems_version: 2.4.8
-signing_key: 
+rubygems_version: 3.1.6
+signing_key:
 specification_version: 2
 summary: Command-line client for Papertrail hosted log management service.
 test_files: