riemann-client 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d87901a4f9a48ce3fcae0940d204c36cdabd949d4495b99f2445735fb2deddd8
-  data.tar.gz: d64e574731d1a1dce475fb2227eaf2fdd4f3bf581bd20bae33fb92a22321adb2
+  metadata.gz: 33657c1dcec6dce903bd90154f17f3a31174b6e0fa146609941dc36960c2b6e2
+  data.tar.gz: 372a73585a2046e5af3a16ddd84254af64e6f6d17c6911183cf6c408eb22ac07
 SHA512:
-  metadata.gz: b75e2bd1256a168dc185ceaf53c80f045e2011fa1fa2e2717147e48c35d65b767df60182884a154575e09598b4305cda0e9cc16c0f5a2d3e0ab3218fc6d4380f
-  data.tar.gz: 1b5d7a51402e65c7994b91bd903f2dae9881390ee890058a881311c3bb57bfb12139065c1a0d466c76f2438677789ad8f3347351e26d1005f704f673f8c06025
+  metadata.gz: 694404b98fe75bb304f8d8da0903eb128d2600ecd83bc3b6c3d4e2b41eef2695a82e6df00c0f9c3a59115837e58314e6cdb88d56c1b10c959bd912d69ace479c
+  data.tar.gz: 874fdd45638f808e1bf9641616fe5342c01c3a51245f9d66542a9aec60751a093462e70c123e027a463dcedfcb608dfc98087ae4ad189fd02aa97210b8e90fdd

data/.github/dependabot.yml

@@ -0,0 +1,11 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+  - package-ecosystem: "bundler" # See documentation for possible values
+    directory: "/" # Location of package manifests
+    schedule:
+      interval: "daily"

data/.github/workflows/ci.yml

@@ -10,16 +10,30 @@ on:
       - main
 
 jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Setup ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '2.7'
+          bundler-cache: true
+      - name: Run rubocop
+        run: bundle exec rubocop
   test:
+    needs: lint
     runs-on: ubuntu-latest
     strategy:
       matrix:
         ruby-version:
-          - 2.7
-          - 3.0
-          - 3.1
+          - '2.6'
+          - '2.7'
+          - '3.0'
+          - '3.1'
+          - '3.2'
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - name: Setup Ruby
         uses: ruby/setup-ruby@v1
         with:
@@ -42,4 +56,4 @@ jobs:
 
           while ! nc -z localhost 5555; do sleep 1; done
       - name: Run the test suite
-        run: bundle exec bacon spec/*.rb
+        run: bundle exec rspec

data/.github/workflows/codeql-analysis.yml

@@ -0,0 +1,72 @@
+# For most projects, this workflow file will not need changing; you simply need
+# to commit it to your repository.
+#
+# You may wish to alter this file to override the set of languages analyzed,
+# or to provide custom queries or build logic.
+#
+# ******** NOTE ********
+# We have attempted to detect the languages in your repository. Please check
+# the `language` matrix defined below to confirm you have the correct set of
+# supported CodeQL languages.
+#
+name: "CodeQL"
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: [ "main" ]
+  schedule:
+    - cron: '33 17 * * 6'
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: [ 'ruby' ]
+        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
+        # Learn more about CodeQL language support at https://aka.ms/codeql-docs/language-support
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v3
+
+    # Initializes the CodeQL tools for scanning.
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v2
+      with:
+        languages: ${{ matrix.language }}
+        # If you wish to specify custom queries, you can do so here or in a config file.
+        # By default, queries listed here will override any specified in a config file.
+        # Prefix the list here with "+" to use these queries and those in the config file.
+        
+        # Details on CodeQL's query packs refer to : https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
+        # queries: security-extended,security-and-quality
+
+        
+    # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
+    # If this step fails, then you should remove it and run the build manually (see below)
+    - name: Autobuild
+      uses: github/codeql-action/autobuild@v2
+
+    # ℹ️ Command-line programs to run using the OS shell.
+    # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
+
+    #   If the Autobuild fails above, remove it and uncomment the following three lines. 
+    #   modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance.
+
+    # - run: |
+    #   echo "Run, Build Application using script"
+    #   ./location_of_script_within_repo/buildscript.sh
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v2

data/.rspec

@@ -0,0 +1,2 @@
+--require spec_helper
+--format doc

data/.rubocop.yml

@@ -0,0 +1,20 @@
+---
+require:
+- rubocop-rspec
+Metrics/AbcSize:
+  Enabled: false
+Metrics/BlockLength:
+  Enabled: false
+Metrics/ClassLength:
+  Enabled: false
+Metrics/CyclomaticComplexity:
+  Enabled: false
+Metrics/MethodLength:
+  Enabled: false
+Metrics/PerceivedComplexity:
+  Enabled: false
+Naming/VariableNumber:
+  AllowedIdentifiers:
+  - TLSv1_2
+Style/Documentation:
+  Enabled: false

data/CHANGELOG.md

@@ -1,8 +1,34 @@
 # Changelog
 
-## [1.0.0](https://github.com/riemann/riemann-ruby-client/tree/1.0.0) (2022-06-16)
+## [v1.1.0](https://github.com/riemann/riemann-ruby-client/tree/v1.1.0) (2023-01-23)
 
-[Full Changelog](https://github.com/riemann/riemann-ruby-client/compare/0.2.6...1.0.0)
+[Full Changelog](https://github.com/riemann/riemann-ruby-client/compare/v1.0.1...v1.1.0)
+
+**Implemented enhancements:**
+
+- Add support for sending events in bulk [\#44](https://github.com/riemann/riemann-ruby-client/pull/44) ([smortex](https://github.com/smortex))
+
+**Fixed bugs:**
+
+- Fix UDP fallback to TCP on large messages [\#46](https://github.com/riemann/riemann-ruby-client/pull/46) ([smortex](https://github.com/smortex))
+
+**Merged pull requests:**
+
+- Modernize unit tests [\#45](https://github.com/riemann/riemann-ruby-client/pull/45) ([smortex](https://github.com/smortex))
+- Switch from Bacon to RSpec [\#43](https://github.com/riemann/riemann-ruby-client/pull/43) ([smortex](https://github.com/smortex))
+- Create codeql-analysis.yml [\#40](https://github.com/riemann/riemann-ruby-client/pull/40) ([jamtur01](https://github.com/jamtur01))
+
+## [v1.0.1](https://github.com/riemann/riemann-ruby-client/tree/v1.0.1) (2022-06-25)
+
+[Full Changelog](https://github.com/riemann/riemann-ruby-client/compare/v1.0.0...v1.0.1)
+
+**Merged pull requests:**
+
+- Setup Rubocop and lower required Ruby version [\#37](https://github.com/riemann/riemann-ruby-client/pull/37) ([smortex](https://github.com/smortex))
+
+## [v1.0.0](https://github.com/riemann/riemann-ruby-client/tree/v1.0.0) (2022-06-16)
+
+[Full Changelog](https://github.com/riemann/riemann-ruby-client/compare/0.2.6...v1.0.0)
 
 **Implemented enhancements:**
 

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 gemspec

data/README.markdown

@@ -1,12 +1,16 @@
-Installing
-==========
+# Riemann Ruby Client
 
-    gem install riemann-client
+[![CI](https://github.com/riemann/riemann-ruby-client/actions/workflows/ci.yml/badge.svg)](https://github.com/riemann/riemann-ruby-client/actions/workflows/ci.yml)
 
-Use
-===
+## Installing
 
-``` ruby
+```shell
+gem install riemann-client
+```
+
+## Use
+
+```ruby
 require 'riemann/client'
 
 # Create a client. Host, port and timeout are optional.
@@ -38,8 +42,8 @@ c['host =~ "%.dc1" and (state = "critical" or state = "warning")']
 
 ```
 
-Transports
-==========
+## Transports
+
 
 Riemann::Client sends small events over UDP by default, and uses TCP for
 queries and large events. UDP sends are essentially "shouting into the void".
@@ -54,8 +58,7 @@ c.tcp["true"]            # => [#<Event ... >, ...]
 c.udp["true"]            # => raise Riemann::Client::Unsupported
 ```
 
-Client state management
-=======================
+## Client state management
 
 Riemann::Client provides some classes to make managing state updates easier.
 
@@ -64,3 +67,9 @@ be used to flush an accumulated value to ustate at regular intervals.
 
 Riemann::AutoState bundles a state and a client together. Any changes to the
 AutoState automatically send the new state to the client.
+
+## License
+
+The MIT License
+
+Copyright (c) 2011-2022 Kyle Kingsbury

data/Rakefile

@@ -1,12 +1,15 @@
+# frozen_string_literal: true
+
 require 'riemann'
 
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
 
 require 'github_changelog_generator/task'
 
 GitHubChangelogGenerator::RakeTask.new :changelog do |config|
   config.user = 'riemann'
   config.project = 'riemann-ruby-client'
-  config.future_release = Riemann::VERSION
+  config.exclude_labels = ['skip-changelog']
+  config.future_release = "v#{Riemann::VERSION}"
   config.add_issues_wo_labels = false
 end

data/SECURITY.md

@@ -0,0 +1,42 @@
+# Riemann Security and Disclosure Information
+This page describes Riemann security and disclosure information.
+
+## Supported Versions
+
+The currently supported version of Riemann for security-patching purposes is always the latest version.
+
+## Security Announcements
+
+Will be made on the [Riemann mailing list](https://groups.google.com/g/riemann-users?pli=1).
+
+## Report a Vulnerability
+
+We're extremely grateful for security researchers and users that report vulnerabilities to Riemann. All reports are thoroughly investigated by the maintainers.
+
+To make a report, you should email the private security@riemann.io list with the details.
+
+## When Should I Report a Vulnerability?
+
+* You think you discovered a potential security vulnerability in Riemann.
+* You are unsure how a vulnerability affects Riemann.
+* You think you discovered a vulnerability in another project that Riemann depends on
+
+For projects with their own vulnerability reporting and disclosure process, please report it directly there.
+
+## When Should I NOT Report a Vulnerability?
+
+* You need help tuning Riemann components for security
+* You need help applying security related updates
+* Your issue is not security related
+
+## Security Vulnerability Response
+
+Each report is acknowledged and analyzed within 5 working days.
+
+Any vulnerability information shared stays within Riemann project and will not be disseminated to other projects unless it is necessary to get the issue fixed.
+
+As the security issue moves from triage, to identified fix, to release planning we will keep the reporter updated.
+
+## Public Disclosure Timing
+
+A public disclosure date is negotiated by the Riemann maintainers nd the bug submitter. We prefer to fully disclose the bug as soon as possible once a user mitigation is available. It is reasonable to delay disclosure when the bug or the fix is not yet fully understood, the solution is not well-tested, or for vendor coordination. The timeframe for disclosure is from immediate (especially if it's already publicly known) to a few weeks. For a vulnerability with a straightforward mitigation, we expect report date to disclosure date to be on the order of 7 days. The Riemann maintainers hold the final say when setting a disclosure date.

data/lib/riemann/attribute.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Riemann
   class Attribute
     include Beefcake::Message

data/lib/riemann/auto_state.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Riemann
   class AutoState
     # Binds together a state hash and a Client. Any change made here
@@ -40,7 +42,7 @@ module Riemann
     #     @state.state = 'heavy lifting b'
     #     ...
     #   end
-    
+
     def initialize(client = Client.new, state = {})
       @client = client
       @state = state
@@ -95,7 +97,11 @@ module Riemann
     def once(opts)
       o = @state.merge opts
       o[:time] = Time.now.to_i
-      o[:tags] = ((o[:tags] | ["once"]) rescue ["once"])
+      o[:tags] = begin
+        (o[:tags] | ['once'])
+      rescue StandardError
+        ['once']
+      end
       @client << o
     end
 
@@ -111,7 +117,7 @@ module Riemann
     def service=(service)
       @state[:service] = service
       flush
-    end 
+    end
 
     def service
       @state[:service]

data/lib/riemann/client/ssl_socket.rb

@@ -1,11 +1,12 @@
+# frozen_string_literal: true
+
 require 'openssl'
 require_relative 'tcp_socket'
 
 module Riemann
   class Client
-  # Socket: A specialized socket that has been configure
+    # Socket: A specialized socket that has been configure
     class SSLSocket < TcpSocket
-
       def initialize(options = {})
         super(options)
         @key_file = options[:key_file]
@@ -16,11 +17,11 @@ module Riemann
 
       def ssl_context
         @ssl_context ||= OpenSSL::SSL::SSLContext.new.tap do |ctx|
-            ctx.key = OpenSSL::PKey::RSA.new(open(@key_file) {|f| f.read})
-            ctx.cert = OpenSSL::X509::Certificate.new(open(@cert_file) {|f| f.read})
-            ctx.ca_file = @ca_file if @ca_file
-            ctx.ssl_version = :TLSv1_2
-            ctx.verify_mode = OpenSSL::SSL::VERIFY_PEER if @ssl_verify
+          ctx.key = OpenSSL::PKey::RSA.new(File.read(@key_file))
+          ctx.cert = OpenSSL::X509::Certificate.new(File.read(@cert_file))
+          ctx.ca_file = @ca_file if @ca_file
+          ctx.ssl_version = :TLSv1_2
+          ctx.verify_mode = OpenSSL::SSL::VERIFY_PEER if @ssl_verify
         end
       end
 
@@ -30,7 +31,7 @@ module Riemann
       #
       # Return the ::Socket when it is connected, or raise an Error if no
       # connection was possible.
-      def connect_nonblock( addr, timeout )
+      def connect_nonblock(addr, timeout)
         sock = super(addr, timeout)
         ssl_socket = OpenSSL::SSL::SSLSocket.new(sock, ssl_context)
         ssl_socket.sync = true
@@ -38,17 +39,17 @@ module Riemann
         begin
           ssl_socket.connect_nonblock
         rescue IO::WaitReadable
-          if IO.select([ssl_socket], nil, nil, timeout)
-            retry
-          else
+          unless IO.select([ssl_socket], nil, nil, timeout)
             raise Timeout, "Could not read from #{host}:#{port} in #{timeout} seconds"
           end
+
+          retry
         rescue IO::WaitWritable
-          if IO.select(nil, [ssl_socket], nil, timeout)
-            retry
-          else
+          unless IO.select(nil, [ssl_socket], nil, timeout)
             raise Timeout, "Could not write to #{host}:#{port} in #{timeout} seconds"
           end
+
+          retry
         end
         ssl_socket
       end
@@ -60,13 +61,13 @@ module Riemann
       #
       # Returns the bytes read
       def readpartial(maxlen, outbuf = nil)
-        return super(maxlen, outbuf)
+        super(maxlen, outbuf)
       rescue OpenSSL::SSL::SSLErrorWaitReadable
-        if wait_readable(read_timeout)
-          retry
-        else
+        unless wait_readable(read_timeout)
           raise Timeout, "Could not read from #{host}:#{port} in #{read_timeout} seconds"
         end
+
+        retry
       end
 
       # Internal: Write the given data to the socket
@@ -80,11 +81,11 @@ module Riemann
       def write(buf)
         super(buf)
       rescue OpenSSL::SSL::SSLErrorWaitWritable
-        if wait_writable(write_timeout)
-          retry
-        else
+        unless wait_writable(write_timeout)
           raise Timeout, "Could not write to #{host}:#{port} in #{write_timeout} seconds"
         end
+
+        retry
       end
     end
   end

data/lib/riemann/client/tcp.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'monitor'
 require 'riemann/client/tcp_socket'
 require 'riemann/client/ssl_socket'
@@ -5,12 +7,12 @@ require 'riemann/client/ssl_socket'
 module Riemann
   class Client
     class TCP < Client
-      attr_accessor :host, :port, :socket
+      attr_accessor :host, :port
 
       # Public: Set a socket factory -- an object responding
       # to #call(options) that returns a Socket object
-      def self.socket_factory=(factory)
-        @socket_factory = factory
+      class << self
+        attr_writer :socket_factory
       end
 
       # Public: Return a socket factory
@@ -24,16 +26,14 @@ module Riemann
         }
       end
 
-      def initialize(options = {})
+      def initialize(options = {}) # rubocop:disable Lint/MissingSuper
         @options = options
         @locket  = Monitor.new
       end
 
       def socket
         @locket.synchronize do
-          if @pid && @pid != Process.pid
-            close
-          end
+          close if @pid && @pid != Process.pid
 
           return @socket if connected?
 
@@ -58,32 +58,32 @@ module Riemann
       end
 
       # Read a message from a stream
-      def read_message(s)
-        if buffer = s.read(4) and buffer.size == 4
-          length = buffer.unpack('N').first
-          begin
-            str = s.read length
-            message = Riemann::Message.decode str
-          rescue => e
-            puts "Message was #{str.inspect}"
-            raise
-          end
+      def read_message(socket)
+        unless (buffer = socket.read(4)) && (buffer.size == 4)
+          raise InvalidResponse, 'unexpected EOF'
+        end
 
-          unless message.ok
-            puts "Failed"
-            raise ServerError, message.error
-          end
+        length = buffer.unpack1('N')
+        begin
+          str = socket.read length
+          message = Riemann::Message.decode str
+        rescue StandardError
+          puts "Message was #{str.inspect}"
+          raise
+        end
 
-          message
-        else
-          raise InvalidResponse, "unexpected EOF"
+        unless message.ok
+          puts 'Failed'
+          raise ServerError, message.error
         end
+
+        message
       end
 
       def send_recv(message)
-        with_connection do |s|
-          s.write(message.encode_with_length)
-          read_message(s)
+        with_connection do |socket|
+          socket.write(message.encode_with_length)
+          read_message(socket)
         end
       end
 
@@ -94,17 +94,17 @@ module Riemann
         tries = 0
 
         @locket.synchronize do
-          begin
-            tries += 1
-            yield(socket)
-          rescue IOError, Errno::EPIPE, Errno::ECONNREFUSED, InvalidResponse, Timeout::Error, Riemann::Client::TcpSocket::Error
-            close
-            raise if tries > 3
-            retry
-          rescue Exception
-            close
-            raise
-          end
+          tries += 1
+          yield(socket)
+        rescue IOError, Errno::EPIPE, Errno::ECONNREFUSED, InvalidResponse, Timeout::Error,
+               Riemann::Client::TcpSocket::Error
+          close
+          raise if tries > 3
+
+          retry
+        rescue StandardError
+          close
+          raise
         end
       end
     end