riemann-client 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 395c52ac148f9988953268a74e1e747c415e3b80c75e7e0cfef536d7f44a2d36
-  data.tar.gz: 81051904aef015898e9abde73a6bdf2cde446cec0ed8712b0a2cd569d1a62f50
+  metadata.gz: 33657c1dcec6dce903bd90154f17f3a31174b6e0fa146609941dc36960c2b6e2
+  data.tar.gz: 372a73585a2046e5af3a16ddd84254af64e6f6d17c6911183cf6c408eb22ac07
 SHA512:
-  metadata.gz: d016e54a3881d70914163c88506da3936f47c6c3390f092eb1a2a179c1cd1034984337d81ecbbefdcef01019efa168f8d93662918c67125f31245cffa471b1f5
-  data.tar.gz: 330ea26290403c97dd44ac1b0d04b72ea9bebd27a147f00c0135ce9d46a09c01c4f8271daaa3c118a2feeebb84603d6dde77066ee5a994e6c7c32e8e2eb1c89a
+  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

@@ -13,7 +13,7 @@ jobs:
   lint:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - name: Setup ruby
         uses: ruby/setup-ruby@v1
         with:
@@ -27,12 +27,13 @@ jobs:
     strategy:
       matrix:
         ruby-version:
-          - 2.6
-          - 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:
@@ -55,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

@@ -1,4 +1,6 @@
 ---
+require:
+- rubocop-rspec
 Metrics/AbcSize:
   Enabled: false
 Metrics/BlockLength:

data/CHANGELOG.md

@@ -1,8 +1,26 @@
 # Changelog
 
-## [1.0.1](https://github.com/riemann/riemann-ruby-client/tree/1.0.1) (2022-06-25)
+## [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/v1.0.0...1.0.1)
+[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:**
 

data/Rakefile

@@ -10,6 +10,6 @@ GitHubChangelogGenerator::RakeTask.new :changelog do |config|
   config.user = 'riemann'
   config.project = 'riemann-ruby-client'
   config.exclude_labels = ['skip-changelog']
-  config.future_release = Riemann::VERSION
+  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/client/tcp_socket.rb

@@ -328,7 +328,7 @@ module Riemann
       #
       # returns nothing
       def write(buf)
-        until buf.nil? || buf.length.zero?
+        until buf.nil? || buf.empty?
           written = socket.write_nonblock(buf)
           buf = buf[written, buf.length]
         end

data/lib/riemann/client.rb

@@ -52,22 +52,42 @@ module Riemann
     end
 
     # Send a state
-    def <<(event_opts)
+    def <<(event)
       # Create state
-      case event_opts
-      when Riemann::State
-        event = event_opts
-      when Riemann::Event
-        event = event_opts
+      case event
+      when Riemann::State, Riemann::Event, Hash
+        # Noop
       else
-        event_opts[:host] = Socket.gethostname unless event_opts.include? :host
-        event = Riemann::Event.new(event_opts)
+        raise(ArgumentError, "Unsupported event class: #{event.class.name}")
       end
 
-      message = Riemann::Message.new events: [event]
+      bulk_send([event])
+    end
+
+    def bulk_send(events)
+      raise ArgumentError unless events.is_a?(Array)
+
+      message = Riemann::Message.new(events: normalize_events(events))
 
-      # Transmit
-      send_maybe_recv message
+      send_maybe_recv(message)
+    end
+
+    def normalize_events(events)
+      events.map do |event|
+        case event
+        when Riemann::State, Riemann::Event
+          event
+        when Hash
+          e = if event.include?(:host)
+                event
+              else
+                event.dup.merge(host: Socket.gethostname)
+              end
+          Riemann::Event.new(e)
+        else
+          raise(ArgumentError, "Unsupported event class: #{event.class.name}")
+        end
+      end
     end
 
     # Returns an array of states matching query.
@@ -104,7 +124,7 @@ module Riemann
     def send_maybe_recv(message)
       @udp.send_maybe_recv(message)
     rescue TooBig
-      @tcp.send_maybe_recv(*a)
+      @tcp.send_maybe_recv(message)
     end
   end
 end

data/lib/riemann/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Riemann
-  VERSION = '1.0.1'
+  VERSION = '1.1.0'
 end

data/riemann-client.gemspec

@@ -24,9 +24,10 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = '>= 2.6.0'
 
-  spec.add_development_dependency 'bacon'
   spec.add_development_dependency 'bundler', '>= 1.3'
+  spec.add_development_dependency 'rspec'
   spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'rubocop-rspec'
   spec.add_development_dependency 'timecop'
 
   spec.add_dependency 'beefcake', ['>= 1.0.0 ']

data/spec/client_spec.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+require 'riemann'
+require 'riemann/client'
+
+require 'spec_helper'
+require 'shared_examples'
+
+RSpec.describe 'Riemann::Client' do
+  let(:client) do
+    Riemann::Client.new(host: 'localhost', port: 5555)
+  end
+
+  let(:expected_rate) { 100 }
+
+  context('with TLS transport') do
+    let(:client) do
+      Riemann::Client.new(host: 'localhost', port: 5554, ssl: true,
+                          key_file: '/etc/riemann/riemann_server.pkcs8',
+                          cert_file: '/etc/riemann/riemann_server.crt',
+                          ca_file: '/etc/riemann/riemann_server.crt',
+                          ssl_verify: true)
+    end
+    let(:client_with_transport) { client.tcp }
+
+    it_behaves_like 'a riemann client'
+    it_behaves_like 'a riemann client that acknowledge messages'
+  end
+
+  context 'with TCP transport' do
+    let(:client_with_transport) { client.tcp }
+
+    it_behaves_like 'a riemann client'
+    it_behaves_like 'a riemann client that acknowledge messages'
+  end
+
+  context('with UDP transport') do
+    let(:client_with_transport) { client.udp }
+    let(:expected_rate) { 1000 }
+
+    it_behaves_like 'a riemann client'
+    it_behaves_like 'a riemann client that does not acknowledge messages'
+
+    context 'when sending a message too large for UDP transport' do
+      let(:large_message) do
+        {
+          data: 'X' * (Riemann::Client::UDP::MAX_SIZE + 10)
+        }
+      end
+
+      before do
+        allow(client.udp).to receive(:send_maybe_recv).and_call_original
+        allow(client.tcp).to receive(:send_maybe_recv).and_call_original
+        client << large_message
+      end
+
+      it 'has tried to send the message using UDP' do
+        expect(client.udp).to have_received(:send_maybe_recv)
+      end
+
+      it 'has retried to send the message using TCP' do
+        expect(client.tcp).to have_received(:send_maybe_recv)
+      end
+    end
+  end
+end