libhoney 1.21.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e193211937c61bf221e8610d7324c173d90aefa2f5d08f706c0ea56dcbb1d971
-  data.tar.gz: d235e368e4f1dc9b11a5a489fdff04c734a7804d57925394f515ac92a11ef0bf
+  metadata.gz: c346ba7e750c99063736cd641e10eb153f9a1326b1bf17231e7c89ad312d102a
+  data.tar.gz: 5f16185c3b43ce38f0323861244966ccc6df2404c5b7c05f712c530d25f193d6
 SHA512:
-  metadata.gz: 7cbf429690cb10522b488f631be5b726e6973e3b1d73b660ac28f3d8186e7b88b392c6736252dc9e2a77bb2fb78a70bf8e678653edb12c8405a45bd693ec0e28
-  data.tar.gz: 9b318c534cdeac671ea52e880ce9e8e047bc2b730eb9ab7e020c111dbfaedc19083cd152e8e506b3422ef36c3d9e719b87ac661d871bf8cd13d5c24d5b5d19fb
+  metadata.gz: 5c4ebb204f1f7fa8cbc602442d6672753d2395b53a9cbae3f4ca61e2a96fa17e54c2206c55cfdb7ec32e1349daa64f70cfffd755e957f2060ab7231791420bc5
+  data.tar.gz: 07be9a04ccb025acc0b9e05e0e1fea17a1bd5b694ef9ec0443b0e5638d3b9a024502e05d7d677d752920c81d36249008ed4f226f293c8f5b3dfa469c7ac5b528

data/.circleci/config.yml

@@ -19,10 +19,10 @@ filters_publish: &filters_publish
 matrix_rubyversions: &matrix_rubyversions
   matrix:
     parameters:
-      rubyversion: ["2.2", "2.3", "2.4", "2.5", "2.6", "2.7"]
+      rubyversion: ["2.4", "2.5", "2.6", "2.7", "3.0"]
 
 # Default version of ruby to use for lint and publishing
-default_rubyversion: &default_rubyversion "2.7"
+default_rubyversion: &default_rubyversion "3.0"
 
 executors:
   ruby:
@@ -31,7 +31,7 @@ executors:
         type: string
         default: *default_rubyversion
     docker:
-      - image: circleci/ruby:<< parameters.rubyversion >>
+      - image: cimg/ruby:<< parameters.rubyversion >>
   github:
     docker:
       - image: cibuilds/github:0.13.0
@@ -86,7 +86,8 @@ jobs:
       - run:
           name: install dependencies
           command: |
-            bundle install --jobs=4 --retry=3 --path vendor/bundle
+            bundle config set --local path 'vendor/bundle'
+            bundle install --jobs=4 --retry=3
       - save_cache:
           paths:
             - ./vendor/bundle

data/.github/workflows/stale.yml

@@ -0,0 +1,26 @@
+name: 'Close stale issues and PRs'
+on:
+  schedule:
+    - cron: '30 1 * * *'
+
+jobs:
+  stale:
+    name: 'Close stale issues and PRs'
+    runs-on: ubuntu-latest
+    permissions:
+      issues: write
+      pull-requests: write
+
+    steps:
+      - uses: actions/stale@v4
+        with:
+          start-date: '2021-09-01T00:00:00Z'
+          stale-issue-message: 'Marking this issue as stale because it has been open 14 days with no activity. Please add a comment if this is still an ongoing issue; otherwise this issue will be automatically closed in 7 days.'
+          stale-pr-message: 'Marking this PR as stale because it has been open 30 days with no activity. Please add a comment if this PR is still relevant; otherwise this PR will be automatically closed in 7 days.'
+          close-issue-message: 'Closing this issue due to inactivity. Please see our [Honeycomb OSS Lifecyle and Practices](https://github.com/honeycombio/home/blob/main/honeycomb-oss-lifecycle-and-practices.md).'
+          close-pr-message: 'Closing this PR due to inactivity. Please see our [Honeycomb OSS Lifecyle and Practices](https://github.com/honeycombio/home/blob/main/honeycomb-oss-lifecycle-and-practices.md).'
+          days-before-issue-stale: 14
+          days-before-pr-stale: 30
+          days-before-issue-close: 7
+          days-before-pr-close: 7
+          any-of-labels: 'status: info needed,status: revision needed'

data/.rubocop.yml

@@ -1,11 +1,33 @@
 inherit_from: .rubocop_todo.yml
 
 AllCops:
-  TargetRubyVersion: 2.2
+  TargetRubyVersion: 2.4
+  NewCops: enable
 
 Style/Documentation:
   Enabled: false
 
+Layout/BeginEndAlignment:
+  EnforcedStyleAlignWith: begin
+
+Layout/EmptyLineBetweenDefs:
+  AllowAdjacentOneLineDefs: true
+
+Lint/RaiseException:
+  Enabled: true
+
+Lint/StructNewOverride:
+  Enabled: true
+
+Style/HashEachMethods:
+  Enabled: true
+
+Style/HashTransformKeys:
+  Enabled: true
+
+Style/HashTransformValues:
+  Enabled: true
+
 Lint/RescueException:
   Exclude:
     - 'lib/libhoney/transmission.rb'
@@ -26,7 +48,7 @@ Metrics/MethodLength:
     - lib/libhoney/transmission.rb
     - test/*
 
-Metrics/LineLength:
+Layout/LineLength:
   Max: 115
   Exclude:
     - lib/libhoney/client.rb

data/.rubocop_todo.yml

@@ -1,36 +1,42 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2018-09-24 20:37:04 -0700 using RuboCop version 0.59.2.
+# on 2021-09-10 20:37:20 UTC using RuboCop version 1.12.1.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
-# Offense count: 3
-Lint/HandleExceptions:
+# Offense count: 2
+# Configuration parameters: AllowComments, AllowNil.
+Lint/SuppressedException:
   Exclude:
-    - 'lib/libhoney/client.rb'
     - 'lib/libhoney/transmission.rb'
 
-# Offense count: 7
+# Offense count: 12
+# Configuration parameters: IgnoredMethods, CountRepeatedAttributes.
 Metrics/AbcSize:
-  Max: 40
-
-# Offense count: 1
-# Configuration parameters: CountComments, ExcludedMethods.
-# ExcludedMethods: refine
-Metrics/BlockLength:
-  Max: 30
+  Max: 38
 
-# Offense count: 2
+# Offense count: 6
+# Configuration parameters: IgnoredMethods.
 Metrics/CyclomaticComplexity:
   Max: 12
 
-# Offense count: 2
-# Configuration parameters: CountKeywordArgs.
+# Offense count: 1
+# Configuration parameters: CountKeywordArgs, MaxOptionalParameters.
 Metrics/ParameterLists:
-  Max: 12
+  Max: 10
 
-# Offense count: 1
+# Offense count: 4
+# Configuration parameters: IgnoredMethods.
 Metrics/PerceivedComplexity:
-  Max: 10
+  Max: 11
+
+# Offense count: 31
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: always, always_true, never
+# Disabled after setting target version to 2.3
+# Consider later.
+Style/FrozenStringLiteralComment:
+  Enabled: false

data/CHANGELOG.md

@@ -1,4 +1,15 @@
-# libhoney-rb changelog
+## [2.0.0] - 2021-10-07
+
+### 💥 Breaking Changes
+
+- support dropped for Ruby 2.2 (#104) | [robbkidd](https://github.com/robbkidd)
+- support dropped for Ruby 2.3 (#106) | [robbkidd](https://github.com/robbkidd)
+- remove deprecated support for accepting an Array for client proxy_config (#112) | [robbkidd](https://github.com/robbkidd)
+
+### 🛠 Maintenance
+
+- Change maintenance badge to maintained (#109) | [JamieDanielson](https://github.com/JamieDanielson)
+- Adds Stalebot (#110) | [JamieDanielson](https://github.com/JamieDanielson)
 
 ## [1.21.0] - 2021-09-23
 

data/OSSMETADATA

@@ -1 +1 @@
-osslifecycle=maintenance
+osslifecycle=maintained

data/README.md

@@ -1,12 +1,12 @@
 # libhoney
 
-[![OSS Lifecycle](https://img.shields.io/osslifecycle/honeycombio/libhoney-rb)](https://github.com/honeycombio/home/blob/main/honeycomb-oss-lifecycle-and-practices.md)
+[![OSS Lifecycle](https://img.shields.io/osslifecycle/honeycombio/libhoney-rb?color=success)](https://github.com/honeycombio/home/blob/main/honeycomb-oss-lifecycle-and-practices.md)
 [![CircleCI Build Status](https://circleci.com/gh/honeycombio/libhoney-rb.svg?style=svg)](https://circleci.com/gh/honeycombio/libhoney-rb)
 [![Gem Version](https://badge.fury.io/rb/libhoney.svg)](https://badge.fury.io/rb/libhoney)
 
 Ruby gem for sending events to [Honeycomb](https://www.honeycomb.io), a service for debugging your software in production.
 
-Requires Ruby 2.2 or greater.
+Requires Ruby 2.3 or greater.
 
 -   [Usage and Examples](https://docs.honeycomb.io/sdk/ruby/)
 -   [API Reference](https://www.rubydoc.info/gems/libhoney)
@@ -20,15 +20,3 @@ open issues or a pull request with your change. Remember to add your name to the
 CONTRIBUTORS file!
 
 All contributions will be released under the Apache License 2.0.
-
-### Releasing a new version
-
-CircleCI will automatically upload tagged releases to Rubygems. To release a new
-version, update the version using `bump`.
-
-```
-bump patch # Or bump minor, etc.
-```
-
-Then, after the version change has been merged into `main`, follow our usual instructions
-for tagging and updating the github release.

data/RELEASING.md

@@ -1,8 +1,9 @@
 # Releasing
 
 - Update the version number in `lib/libhoney/version.rb`.
-- Run `bundle lock`.
-- Confirm the version number update appears in `Gemfile.lock`
+  - For convenience, you can run `bump --no-commit --changelog (major|minor|patch)` to perform
+    the version bump and to add the new version's header to the CHANGELOG. `--no-commit` because
+    there are more changes to make that we do manually.
 - Update `CHANGELOG.md` with the changes since the last release.
 - Commit changes, push, and open a release preparation pull request for review.
 - Once the pull request is merged, fetch the updated `main` branch.

data/example/factorial.rb

@@ -8,7 +8,7 @@ writekey = '7aefa39399a474bd9f414a8e3f8d9691'
 dataset  = 'factorial'
 
 def factorial(number)
-  return -1 * factorial(abs(number)) if number < 0
+  return -1 * factorial(abs(number)) if number.negative?
   return 1 if number.zero?
 
   number * factorial(number - 1)

data/lib/libhoney/builder.rb

@@ -2,8 +2,7 @@ require 'libhoney/event'
 
 module Libhoney
   class Builder
-    attr_accessor :writekey, :dataset, :sample_rate, :api_host
-    attr_accessor :fields, :dyn_fields
+    attr_accessor :writekey, :dataset, :sample_rate, :api_host, :fields, :dyn_fields
 
     # @api private
     # @see Client#builder

data/lib/libhoney/client.rb

@@ -55,13 +55,10 @@ module Libhoney
     # @param block_on_responses [Boolean] if true, block if there is no thread reading from the response queue
     # @param pending_work_capacity [Fixnum] defaults to 1000. If the queue of
     #   pending events exceeds 1000, this client will start dropping events.
-    # @param proxy_config [String, Array, nil] proxy connection information
+    # @param proxy_config [String, nil] proxy connection information
     #   nil: (default, recommended) connection proxying will be determined from any http_proxy, https_proxy, and no_proxy environment
     #     variables set for the process.
     #   String: the value must be the URI for connecting to a forwarding web proxy. Must be parsable by stdlib URI.
-    #   Array: (deprecated, removal in v2.0) the value must have one and at most four elements: e.g. ['host', port, 'username', 'password'].
-    #     The assumption is that the TCP connection will be tunneled via HTTP, so the assumed scheme is 'http://'
-    #     'host' is required. 'port' is optional (default:80), unless a 'username' is included. 'password' is optional.
     # rubocop:disable Metrics/ParameterLists
     def initialize(writekey: nil,
                    dataset: nil,
@@ -78,12 +75,8 @@ module Libhoney
                    proxy_config: nil)
       # rubocop:enable Metrics/ParameterLists
       # check for insanity
-      raise Exception, 'libhoney:  max_concurrent_batches must be greater than 0' if max_concurrent_batches < 1
-      raise Exception, 'libhoney:  sample rate must be greater than 0'            if sample_rate < 1
-
-      unless Gem::Dependency.new('ruby', '>= 2.2').match?('ruby', RUBY_VERSION)
-        raise Exception, 'libhoney:  Ruby versions < 2.2 are not supported'
-      end
+      raise 'libhoney:  max_concurrent_batches must be greater than 0' if max_concurrent_batches < 1
+      raise 'libhoney:  sample rate must be greater than 0'            if sample_rate < 1
 
       @builder = Builder.new(self, nil)
 
@@ -114,7 +107,7 @@ module Libhoney
 
     # Nuke the queue and wait for inflight requests to complete before returning.
     # If you set drain=false, all queued requests will be dropped on the floor.
-    def close(drain = true)
+    def close(drain = true) # rubocop:disable Style/OptionalBooleanParameter
       return @transmission.close(drain) if @transmission
 
       0
@@ -244,18 +237,20 @@ module Libhoney
       end
 
       case transmission
+      # rubocop:disable Style/GuardClause, Style/RedundantReturn
       when NilClass # the default value for new clients
         return TransmissionClient.new(**transmission_client_params)
       when Class
         # if a class has been provided, attempt to instantiate it with parameters given to the client
         t = transmission.new(**transmission_client_params)
-        if quacks_like_a_transmission?(t) # rubocop:disable Style/GuardClause
+        if quacks_like_a_transmission?(t)
           return t
         else
           warn "#{t.class.name}: does not appear to behave like a transmission, disabling sending events"
           return NullTransmissionClient.new
         end
       end
+      # rubocop:enable Style/GuardClause, Style/RedundantReturn
     end
 
     def quacks_like_a_transmission?(transmission)
@@ -269,22 +264,13 @@ module Libhoney
       when String
         URI.parse(config)
       when Array
-        warn <<-WARNING
-        DEPRECATION WARNING: #{self.class.name} the proxy_config parameter will require a String value, not an Array in libhoney 2.0.
-        To resolve:
-          + recommended: set http/https_proxy environment variables, which take precedence over any option set here, then remove proxy_config parameter from client initialization
-          + set proxy_config to a String containing the forwarding proxy URI (only used if http/https_proxy are not set)
-        WARNING
-        host, port, user, password = config
-
-        parsed_config = URI::HTTP.build(host: host, port: port).tap do |uri|
-          uri.userinfo = "#{user}:#{password}" if user
-        end
-        redacted_config = parsed_config.dup.tap do |uri|
-          uri.password = 'REDACTED' unless uri.password.nil? || uri.password.empty?
-        end
-        warn "The array config given has been assumed to mean: #{redacted_config}"
-        parsed_config
+        error_message = <<~MESSAGE
+          #{self.class.name}: the optional proxy_config parameter requires a String value; Array is no longer supported.
+          To resolve:
+            + recommended: set http/https_proxy environment variables, which take precedence over any option set here, then remove proxy_config parameter from client initialization
+            + set proxy_config to a String containing the forwarding proxy URI (only used if http/https_proxy environment variables are not set)
+        MESSAGE
+        raise error_message
       end
     rescue URI::Error => e
       warn "#{self.class.name}: unable to parse proxy_config. Detail: #{e.class}: #{e.message}"

data/lib/libhoney/log_client.rb

@@ -10,7 +10,7 @@ module Libhoney
   #       to verify what events your instrumented code is sending. Use in
   #       production is not recommended.
   class LogClient < Client
-    def initialize(*args, output: ::STDERR, verbose: false, **kwargs)
+    def initialize(*args, output: $stderr, verbose: false, **kwargs)
       super(*args,
             transmission: LogTransmissionClient.new(output: output, verbose: verbose),
             **kwargs)

data/lib/libhoney/queueing/sized_queue_with_timeout.rb

@@ -115,7 +115,7 @@ module Libhoney
       # @param timeout [:never, Numeric] the amount of time in (seconds?) to wait, or :never to wait forever
       # @param timeout_policy [#call] a callable, what to do when a timeout occurs? Return a default? Raise an
       #   exception? You decide.
-      def wait_for_condition(condition, condition_predicate, timeout = :never, timeout_policy = -> { nil })
+      def wait_for_condition(condition, condition_predicate, timeout = :never, timeout_policy = -> {})
         deadline = timeout == :never ? :never : trustworthy_current_time + timeout
         @lock.synchronize do
           loop do

data/lib/libhoney/transmission.rb

@@ -124,10 +124,7 @@ module Libhoney
         end
 
         @batch_queue.enq(nil)
-        if @batch_thread.nil?
-        else
-          @batch_thread.join(1.0) # limit the amount of time we'll wait for the thread to end
-        end
+        @batch_thread&.join(1.0) # limit the amount of time we'll wait for the thread to end
 
         # send @threads.length number of nils so each thread will fall out of send_loop
         @threads.length.times { @send_queue << nil }
@@ -305,7 +302,7 @@ module Libhoney
 
     def ensure_threads_running
       @lock.synchronize do
-        @batch_thread = Thread.new { batch_loop } unless @batch_thread && @batch_thread.alive?
+        @batch_thread = Thread.new { batch_loop } unless @batch_thread&.alive?
         @threads.select!(&:alive?)
         @threads << Thread.new { send_loop } while @threads.length < @max_concurrent_batches
       end

data/lib/libhoney/version.rb

@@ -1,3 +1,3 @@
 module Libhoney
-  VERSION = '1.21.0'.freeze
+  VERSION = '2.0.0'.freeze
 end

data/libhoney.gemspec

@@ -20,7 +20,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.required_ruby_version = '>= 2.2.0'
+  spec.required_ruby_version = '>= 2.4.0'
 
   spec.add_development_dependency 'bump', '~> 0.5'
   spec.add_development_dependency 'bundler'
@@ -28,7 +28,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'minitest', '~> 5.0'
   spec.add_development_dependency 'minitest-reporters'
   spec.add_development_dependency 'rake', '~> 13.0'
-  spec.add_development_dependency 'rubocop', '< 0.69'
+  spec.add_development_dependency 'rubocop', '1.12.1'
   spec.add_development_dependency 'sinatra'
   spec.add_development_dependency 'sinatra-contrib'
   spec.add_development_dependency 'spy', '~> 1.0'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: libhoney
 version: !ruby/object:Gem::Version
-  version: 1.21.0
+  version: 2.0.0
 platform: ruby
 authors:
 - The Honeycomb.io Team
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-09-23 00:00:00.000000000 Z
+date: 2021-10-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bump
@@ -98,16 +98,16 @@ dependencies:
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "<"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0.69'
+        version: 1.12.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "<"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0.69'
+        version: 1.12.1
 - !ruby/object:Gem::Dependency
   name: sinatra
   requirement: !ruby/object:Gem::Requirement
@@ -258,6 +258,7 @@ files:
 - ".github/dependabot.yml"
 - ".github/workflows/add-to-project.yml"
 - ".github/workflows/apply-labels.yml"
+- ".github/workflows/stale.yml"
 - ".gitignore"
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
@@ -306,14 +307,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.2.0
+      version: 2.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.2.22
 signing_key: 
 specification_version: 4
 summary: send data to Honeycomb