r7insight 2.7.6 → 3.0.0

data/test/region.rb

@@ -1,37 +1,58 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 require 'pathname'
 
-logger = Le.new('185a71d5-32a7-4007-a12d-3295c75a10e2', 'eu')
-logger.info("ssl")
-
-describe Le::Host::HTTP do
+logger = R7Insight.new('185a71d5-32a7-4007-a12d-3295c75a10e2', 'eu')
+logger.info('ssl')
 
+describe R7Insight::Host::CONNECTION do
   let(:token)              { '11111111-2222-3333-aaaa-bbbbbbbbbbbb' }
-  let(:region)             {'eu'}
+  let(:region)             { 'eu' }
   let(:local)              { false }
   let(:debug)              { false }
   let(:ssl)                { false }
   let(:udp)                { nil }
 
-  let(:datahub_endpoint)  { ["", 10000]}
-  let(:host_id)           {""}
-  let(:custom_host)       {[false, ""]}
-  let(:endpoint)          {false}
-
-
-  let(:host)               { Le::Host::HTTP.new(token, region, local, debug, ssl, datahub_endpoint, host_id, custom_host, udp, endpoint) }
-
-  let(:logger_console)     { host.instance_variable_get(:@logger_console) }
-  let(:logger_console_dev) { logger_console.instance_variable_get(:@logdev).dev }
-
-  specify { host.must_be_instance_of Le::Host::HTTP }
-  specify {host.region.must_equal 'eu'}
-  specify { host.local.must_equal false }
-  specify { host.debug.must_equal false }
-  specify { host.ssl.must_equal false }
-  specify { host.udp_port.must_equal nil }
-  specify {host_id.must_equal ""}
-  specify {custom_host.must_equal [false, ""]}
-
-
+  let(:datahub_endpoint)  { ['', 10_000] }
+  let(:host_id)           { '' }
+  let(:custom_host)       { [false, ''] }
+  let(:endpoint)          { false }
+
+  let(:host) do
+  R7Insight::Host::CONNECTION.new(token, region, local,
+                                  debug, ssl,
+                                  datahub_endpoint,
+                                  host_id, custom_host,
+                                  udp, endpoint)
+  end
+
+  let(:logger_console) { host.instance_variable_get(:@logger_console) }
+
+  describe 'host' do
+    it 'is an instance of CONNECTION' do
+      assert_instance_of(R7Insight::Host::CONNECTION, host)
+    end
+    it 'region is expected value' do
+      assert_equal(host.region, 'eu')
+    end
+    it 'local is expected value' do
+      refute(host.local)
+    end
+    it 'debug is expected value' do
+      refute(host.debug)
+    end
+    it 'ssl is expected value' do
+      refute(host.ssl)
+    end
+    it 'udp port is expected value' do
+      assert_nil(host.udp_port)
+    end
+    it 'id is expected value' do
+      assert_equal(host_id, '')
+    end
+    it 'custom_host is expected value' do
+      assert_equal(custom_host, [false, ''])
+    end
+  end
 end

data/test/spec_helper.rb

@@ -1,2 +1,4 @@
+# frozen_string_literal: true
+
 require 'minitest/autorun'
-require 'le'
+require 'r7_insight'

metadata

@@ -1,77 +1,94 @@
 --- !ruby/object:Gem::Specification
 name: r7insight
 version: !ruby/object:Gem::Version
-  version: 2.7.6
+  version: 3.0.0
 platform: ruby
 authors:
-- Mark Lacomber
-- Stephen Hynes
+- Rapid7
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-06 00:00:00.000000000 Z
+date: 2019-10-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 6.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 6.0.0
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.0.0
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.12.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.12.2
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 13.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-description: "\n\n"
+        version: 13.0.0
+description: "    Rapid7 Insight Platform Ruby library for logging\n"
 email: support@rapid7.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".travis.yml"
+- CONTRIBUTING.md
 - Gemfile
-- LE.gemspec
+- Gemfile.lock
 - LICENSE
+- Makefile
 - README.md
 - Rakefile
-- lib/le.rb
-- lib/le/host.rb
-- lib/le/host/connection.rb
+- lib/r7_insight.rb
+- lib/r7_insight/host.rb
+- lib/r7_insight/host/connection.rb
+- r7insight.gemspec
 - test/fixtures/log/.gitignore
 - test/host_spec.rb
 - test/http_spec.rb
-- test/le_spec.rb
+- test/r7insight_spec.rb
 - test/region.rb
 - test/spec_helper.rb
 homepage: https://github.com/rapid7/r7insight_ruby
@@ -94,14 +111,15 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.5.2.3
 signing_key: 
 specification_version: 4
-summary: InsightOps logging plugin
+summary: Rapid7 Insight Platform logging plugin
 test_files:
 - test/fixtures/log/.gitignore
 - test/host_spec.rb
 - test/http_spec.rb
-- test/le_spec.rb
+- test/r7insight_spec.rb
 - test/region.rb
 - test/spec_helper.rb
+has_rdoc: 

data/LE.gemspec

@@ -1,29 +0,0 @@
-# -*- encoding: utf-8 -*-
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'le'
-
-Gem::Specification.new do |gem|
-  gem.name	= "r7insight"
-  gem.version	= "2.7.6"
-  gem.date	= Time.now
-  gem.summary	= "InsightOps logging plugin"
-  gem.licenses    = ["MIT"]
-  gem.description	=<<EOD
-
-
-EOD
-
-  gem.authors	= ["Mark Lacomber", "Stephen Hynes"]
-  gem.email	= "support@rapid7.com"
-  gem.homepage    = "https://github.com/rapid7/r7insight_ruby"
-  gem.files         = `git ls-files`.split($/)
-  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
-  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
-  gem.require_paths = ["lib"]
-
-  gem.add_development_dependency "bundler"
-  gem.add_development_dependency "rake"
-  gem.add_development_dependency 'minitest'
-
-end

data/lib/le/host/connection.rb

@@ -1,315 +0,0 @@
-require 'socket'
-require 'openssl'
-require 'thread'
-require 'timeout'
-require 'uri'
-
-module Le
-  module Host
-    class CONNECTION
-      DATA_ENDPOINT = '.data.logs.insight.rapid7.com'
-      DATA_PORT_UNSECURE = 80
-      DATA_PORT_SECURE = 443
-      API_SSL_PORT = 20000
-      SHUTDOWN_COMMAND = "DIE!DIE!"  # magic command string for async worker to shutdown
-      SHUTDOWN_MAX_WAIT = 10         # max seconds to wait for queue to clear on shutdown
-      SHUTDOWN_WAIT_STEP = 0.2       # sleep duration (seconds) while waiting to shutdown
-
-
-      include Le::Host::InstanceMethods
-#!      attr_accessor :token, :queue, :started, :thread, :conn, :local, :debug, :ssl, :datahub_enabled, :dathub_ip, :datahub_port, :host_id, :custom_host, :host_name_enabled, :host_name
-      attr_accessor :token, :region,:queue, :started, :thread, :conn, :local, :debug, :ssl, :datahub_enabled, :datahub_ip, :datahub_port, :datahub_endpoint, :host_id, :host_name_enabled, :host_name, :custom_host, :udp_port, :use_data_endpoint
-
-
-      def initialize(token, region, local, debug, ssl, datahub_endpoint, host_id, custom_host, udp_port, use_data_endpoint)
-          if local
-            device = if local.class <= TrueClass
-              if defined?(Rails)
-                Rails.root.join("log","#{Rails.env}.log")
-              else
-                STDOUT
-              end
-            else
-            local
-            end
-          @logger_console = Logger.new(device)
-          end
-
-          @region = region
-          @local = !!local
-          @debug= debug
-          @ssl = ssl
-          @udp_port = udp_port
-          @use_data_endpoint = use_data_endpoint
-
-        @datahub_endpoint = datahub_endpoint
-        if !@datahub_endpoint[0].empty?
-          @datahub_enabled=true
-          @datahub_ip="#{@datahub_endpoint[0]}"
-          @datahub_port=@datahub_endpoint[1]
-        else
-          @datahub_enabled=false
-        end
-
-
-        if (@datahub_enabled && @ssl)
-          puts ("\n\nYou Cannot have DataHub and SSL enabled at the same time.  Please set SSL value to false in your environment.rb file or used Token-Based logging by leaving the Datahub IP address blank. Exiting application. \n\n")
-          exit
-        end
-
- #check if region was specified
-        if region.empty?
-          puts ("\n\nYou need to specify a region. Options: eu, us")
-        end
-
- #check if DataHub is enabled... if datahub is not enabled, set the token to the token's parameter.  If DH is enabled, make the token empty.
-        if (!datahub_enabled)
-           @token = token
-        else
-          @token = ''
-
- #! NOTE THIS @datahub_port conditional MAY NEED TO BE CHANGED IF SSL CAN'T WORK WITH DH
-          @datahub_port = @datahub_port.empty? ?  API_SSL_PORT : datahub_port
-          @datahub_ip = datahub_ip
-        end
-
-        @host_name_enabled=custom_host[0];
-        @host_name= custom_host[1];
-
-
-# Check if host_id is empty -- if not assign, if so, make it an empty string.
-       if !host_id.empty?
-          @host_id = host_id
-          @host_id = "host_id=#{host_id}"
-        else
-          @host_id=''
-        end
-
-
-
-#assign host_name, if no host name is given and host_name_enabled = true... assign a host_name based on the machine name.
-       if @host_name_enabled
-          if host_name.empty?
-            @host_name=Socket.gethostname
-          end
-
-          @host_name="host_name=#{@host_name}"
-        end
-
-
-        @queue = Queue.new
-        @started = false
-        @thread = nil
-
-        if @debug
-          self.init_debug
-        end
-        at_exit { shutdown! }
-      end
-
-      def init_debug
-        filePath = "r7insightGem.log"
-        if File.exist?('log/')
-          filePath = "log/r7insightGem.log"
-        end
-        @debug_logger = Logger.new(filePath)
-      end
-
-      def dbg(message)
-        if @debug
-          @debug_logger.add(Logger::Severity::DEBUG, message)
-        end
-      end
-
-      def write(message)
-
-        if !host_id.empty?
-          message = "#{message} #{ host_id }"
-        end
-
-        if host_name_enabled
-          message="#{message} #{ host_name }"
-        end
-
-        if @local
-          @logger_console.add(Logger::Severity::UNKNOWN, message)
-        end
-
-        if message.scan(/\n/).empty?
-          @queue << "#{ @token } #{ message } \n"
-        else
-          @queue << "#{ message.gsub(/^/, "#{ @token } [#{ random_message_id }]") }\n"
-        end
-
-
-        if @started
-          check_async_thread
-        else
-          start_async_thread
-        end
-      end
-
-      def start_async_thread
-        @thread = Thread.new { run() }
-        dbg "LE: Asynchronous socket writer started"
-        @started = true
-      end
-
-      def check_async_thread
-        if not(@thread && @thread.alive?)
-          @thread = Thread.new { run() }
-        end
-      end
-
-      def close
-        dbg "LE: Closing asynchronous socket writer"
-        @started = false
-      end
-
-      def openConnection
-        dbg "LE: Reopening connection to Logentries API server"
-
-
-        if @use_data_endpoint
-            host = @region + DATA_ENDPOINT
-
-            if @ssl
-              port = DATA_PORT_SECURE
-            else
-              port = DATA_PORT_UNSECURE
-            end
-        else
-          if @udp_port
-            host = @region + DATA_ENDPOINT
-            port = @udp_port
-          elsif @datahub_enabled
-            host = @datahub_ip
-            port = @datahub_port
-          else
-            host = @region + DATA_ENDPOINT
-            port = @ssl ? DATA_PORT_SECURE: DATA_PORT_UNSECURE
-          end
-        end
-
-        if @udp_port
-          @conn = UDPSocket.new
-          @conn.connect(host, port)
-        else
-          socket = TCPSocket.new(host, port)
-
-          if @ssl
-	    cert_store = OpenSSL::X509::Store.new
-	    cert_store.set_default_paths
-
-            ssl_context = OpenSSL::SSL::SSLContext.new()
-	    ssl_context.cert_store = cert_store
-
-            ssl_version_candidates = [:TLSv1_2, :TLSv1_1, :TLSv1]
-            ssl_version_candidates = ssl_version_candidates.select { |version| OpenSSL::SSL::SSLContext::METHODS.include? version }
-            if ssl_version_candidates.empty?
-                raise "Could not find suitable TLS version"
-            end
-	    # currently we only set the version when we have no choice
-            ssl_context.ssl_version = ssl_version_candidates[0] if ssl_version_candidates.length == 1
-            ssl_context.verify_mode = OpenSSL::SSL::VERIFY_PEER
-            ssl_socket = OpenSSL::SSL::SSLSocket.new(socket, ssl_context)
-            ssl_socket.hostname = host if ssl_socket.respond_to?(:hostname=)
-            ssl_socket.sync_close = true
-            Timeout::timeout(10) do
-              ssl_socket.connect
-            end
-            @conn = ssl_socket
-          else
-            @conn = socket
-          end
-        end
-
-        dbg "LE: Connection established"
-      end
-
-      def reopenConnection
-        closeConnection
-        root_delay = 0.1
-        loop do
-          begin
-            openConnection
-            break
-          rescue Timeout::Error, Errno::EHOSTUNREACH, Errno::ECONNREFUSED, Errno::ECONNRESET, Errno::ETIMEDOUT, EOFError
-            dbg "LE: Unable to connect to Logentries due to timeout(#{ $! })"
-          rescue
-            dbg "LE: Got exception in reopenConnection - #{ $! }"
-            raise
-          end
-          root_delay *= 2
-          if root_delay >= 10
-            root_delay = 10
-          end
-          wait_for = (root_delay + rand(root_delay)).to_i
-          dbg "LE: Waiting for #{ wait_for }ms"
-          sleep(wait_for)
-        end
-      end
-
-      def closeConnection
-        begin
-          if @conn.respond_to?(:sysclose)
-            @conn.sysclose
-          elsif @conn.respond_to?(:close)
-            @conn.close
-          end
-        rescue
-          dbg "LE: couldn't close connection, close with exception - #{ $! }"
-        ensure
-          @conn = nil
-        end
-      end
-
-      def run
-        reopenConnection
-
-        loop do
-          data = @queue.pop
-          break if data == SHUTDOWN_COMMAND
-          loop do
-            begin
-              @conn.write(data)
-            rescue Timeout::Error, Errno::EHOSTUNREACH, Errno::ECONNREFUSED, Errno::ECONNRESET, Errno::ETIMEDOUT, EOFError
-              dbg "LE: Connection timeout(#{ $! }), try to reopen connection"
-              reopenConnection
-              next
-            rescue
-              dbg("LE: Got exception in run loop - #{ $! }")
-              raise
-            end
-
-            break
-          end
-        end
-
-        dbg "LE: Closing Asynchronous socket writer"
-
-        closeConnection
-      end
-
-      private
-        def random_message_id
-          @random_message_id_sample_space ||= ('0'..'9').to_a.concat(('A'..'Z').to_a)
-          (0..5).map{ @random_message_id_sample_space.sample }.join
-        end
-
-        # at_exit handler.
-        # Attempts to clear the queue and terminate the async worker cleanly before process ends.
-        def shutdown!
-          return unless @started
-          dbg "LE: commencing shutdown, queue has #{queue.size} entries to clear"
-          queue << SHUTDOWN_COMMAND
-          SHUTDOWN_MAX_WAIT.div(SHUTDOWN_WAIT_STEP).times do
-            break if queue.empty?
-            sleep SHUTDOWN_WAIT_STEP
-          end
-          dbg "LE: shutdown complete, queue is #{queue.empty? ? '' : 'not '}empty with #{queue.size} entries"
-        end
-
-    end
-  end
-end