honeycomb-beeline 2.11.1.pre.dev → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 52fb2200e25db002d4e9c2570c95a786fa2b8f43990363d2ff24c3d4eff15a51
-  data.tar.gz: 40854a97dfc2ef9a71729c6ffc6af0a6732c877b2faacaf417a5c4b72ff87c51
+  metadata.gz: c117f411dfa05f94d94ae9d313afdc11e1f6c99395b64c4ba6cd5b064e0f5495
+  data.tar.gz: 1379c608d00c04e6ab065f68710c77ce298f081336dbf0291585523343ef0ef1
 SHA512:
-  metadata.gz: cca4d89088d60d01d98a3e499e0ca53f226dea09b9e9575ccac8618545a50e5fdf9fff108ccd2a24bef551aa286add0ef2a69d57d238831535bf9e95950229b5
-  data.tar.gz: d4f28f8de6b59d88eed5fc54a441051003c966a29ac542581dab5a937fac8d7008e9e855033e56cc87e160bc059e8cb765d4884b08ff0962b48db8575e52a977
+  metadata.gz: f018311206155ca7155cc737a04e8f72bfea03447647ae7688e834a99dc41a93d8045014e7cba6c1c337779feff9f07ad40301a82eccfe3c677e5868747701ac
+  data.tar.gz: c653b95ca53f6aef8abbdc056d32cd51bf663b0e4960ae8d1d111b60f5f55adf63bd6e9ffbdb79bd8ead78dc399509006851c0f23df2263f550bfbb229b32a7d

data/.circleci/config.yml

@@ -89,27 +89,6 @@ jobs:
           ruby-version: << parameters.ruby-version >>
           gemfile: root
           command: bundle exec rake rubocop
-  test-older-versions: # need to use deprecated circleci/ruby images for older ruby versions
-    parameters:
-      gemfile:
-        type: string
-      ruby-version:
-        type: string
-    docker:
-        - image: circleci/ruby:<< parameters.ruby-version >>
-    environment:
-      BUNDLE_GEMFILE: gemfiles/<< parameters.gemfile >>.gemfile
-    steps:
-      - ruby:
-          ruby-version: << parameters.ruby-version >>
-          gemfile: << parameters.gemfile >>
-          command: bundle exec rake test
-      - store_test_results:
-          path: test/reports
-      - persist_to_workspace:
-          root: ./
-          paths:
-            - coverage
   test:
     parameters:
       gemfile:
@@ -163,68 +142,13 @@ workflows:
                 - main
     jobs:
       - lint
-      - test-older-versions: &test-older-versions # need to use deprecated circleci/ruby images for older ruby versions
-          name: test-<< matrix.gemfile >>-ruby_<< matrix.ruby-version >>
-          requires:
-            - lint
-          matrix:
-            parameters:
-              ruby-version: ["2.2", "2.3", "2.4", "2.5", "2.6"]
-              gemfile:
-                - aws_2
-                - aws_3
-                - faraday_0
-                - faraday_1
-                - sequel4
-                - sequel5
-                - sinatra
-                - rack_2
-                - rack_3
-                - rails_41
-                - rails_42
-                - rails_5
-                - rails_51
-                - rails_52
-                - rails_6
-                - rails_61
-                - redis_3
-                - redis_4
-            exclude:
-              - ruby-version: "2.2"
-                gemfile: faraday_0
-              - ruby-version: "2.2"
-                gemfile: faraday_1
-              - ruby-version: "2.2"
-                gemfile: rails_52
-              - ruby-version: "2.2"
-                gemfile: rails_6
-              - ruby-version: "2.2"
-                gemfile: rails_61
-              - ruby-version: "2.3"
-                gemfile: rails_6
-              - ruby-version: "2.3"
-                gemfile: rails_61
-              - ruby-version: "2.4"
-                gemfile: rails_6
-              - ruby-version: "2.4"
-                gemfile: rails_61
-              - ruby-version: "2.4"
-                gemfile: rails_41
-              - ruby-version: "2.5"
-                gemfile: rails_41
-              - ruby-version: "2.6"
-                gemfile: rails_41
-              - ruby-version: "2.2"
-                gemfile: rack_3
-              - ruby-version: "2.3"
-                gemfile: rack_3
       - test: &test
           name: test-<< matrix.gemfile >>-ruby_<< matrix.ruby-version >>
           requires:
             - lint
           matrix:
             parameters:
-              ruby-version: ["2.7", "3.0", "3.1"]
+              ruby-version: ["2.5","2.6", "2.7", "3.0", "3.1"]
               gemfile:
                 - aws_2
                 - aws_3
@@ -266,9 +190,6 @@ workflows:
           filters: &regular_filters
               tags:
                 only: /.*/
-      - test-older-versions: # need to use deprecated circleci/ruby images for older ruby versions
-          <<: *test-older-versions
-          filters: *regular_filters
       - test:
           <<: *test
           filters: *regular_filters
@@ -276,7 +197,6 @@ workflows:
           filters: *regular_filters
           requires:
             - test
-            - test-older-versions
       - build_artifacts:
           filters: &tag_filters
               tags:
@@ -286,7 +206,6 @@ workflows:
           requires:
             - lint
             - test
-            - test-older-versions
       - publish_rubygems: &publish
           filters: *tag_filters
           requires:

data/.rubocop.yml

@@ -1,7 +1,7 @@
 require: rubocop-performance
 
 AllCops:
-  TargetRubyVersion: 2.2
+  TargetRubyVersion: 2.5
   Exclude:
     - "examples/**/*"
     - "vendor/**/*"

data/Appraisals

@@ -44,20 +44,6 @@ appraise "rack-3" do
   gem "warden"
 end
 
-appraise "rails-41" do
-  gem "rack-test"
-  gem "rails", "~> 4.1.0"
-  gem "sprockets", "~> 3"
-  gem "warden"
-end
-
-appraise "rails-42" do
-  gem "rack-test"
-  gem "rails", "~> 4.2.0"
-  gem "sprockets", "~> 3"
-  gem "warden"
-end
-
 appraise "rails-5" do
   gem "rack-test"
   gem "rails", "~> 5.0.0"
@@ -85,6 +71,12 @@ appraise "rails-6" do
   gem "warden"
 end
 
+appraise "rails-61" do
+  gem "rack-test"
+  gem "rails", "~> 6.1.0"
+  gem "warden"
+end
+
 appraise "redis-3" do
   gem "redis", "~> 3"
 end

data/CHANGELOG.md

@@ -1,5 +1,33 @@
 # beeline-ruby changelog
 
+## 3.0.0 2023-06-08
+
+### ⚠️ Breaking Changes ⚠️
+
+Minimum Ruby version is 2.5 and minimum Rails version is 5.0.
+
+### Fixed
+
+- fix: set min rubocop to avoid false positive lint error (#218) | @robbkidd
+
+### Maintenance
+
+- chore: give dependabot PRs better title (#217) | @vreynolds
+- ci: use context for publishing ruby gem (#219) | @JamieDanielson
+- ci: update validate PR title workflow (#216) | @pkanal
+- ci: validate PR title (#214) | @pkanal
+- docs: update readme (#225) | @pkanal
+- docs: add otel recommendation to readme (#222) | @pkanal
+- maint: drop support for Ruby < 2.5 and Rails < 5.0 (#227) | @robbkidd
+- maint: update author to honeycomb (#220) | @JamieDanielson
+- maint: delete workflows for old board (#212) | @vreynolds
+- maint: add release file (#211) | @vreynolds
+- maint: add new project workflow (#210) | @vreynolds
+- maint: handle recent Rack v3 changes in tests & example (#209) | @emilyashley
+- maint: add ruby 3.1 to CI matrix (#206) | @vreynolds
+- maint: fix nightly build (#205) | @vreynolds
+- maint: drop testing for Faraday 0 under Ruby 2.2 (#204) | @robbkidd
+
 ## 2.11.0 2022-06-01
 
 ### Improvements

data/README.md

@@ -4,6 +4,8 @@
 [![Build Status](https://circleci.com/gh/honeycombio/beeline-ruby.svg?style=svg)](https://circleci.com/gh/honeycombio/beeline-ruby)
 [![Gem Version](https://badge.fury.io/rb/honeycomb-beeline.svg)](https://badge.fury.io/rb/honeycomb-beeline)
 
+⚠️**Note**: Beelines are Honeycomb's legacy instrumentation libraries. We embrace OpenTelemetry as the effective way to instrument applications. For any new observability efforts, we recommend [instrumenting with OpenTelemetry](https://docs.honeycomb.io/getting-data-in/opentelemetry/ruby/).
+
 This package makes it easy to instrument your Ruby web app to send useful events to [Honeycomb](https://www.honeycomb.io), a service for debugging your software in production.
 - [Usage and Examples](https://docs.honeycomb.io/getting-data-in/beelines/ruby-beeline/)
 
@@ -12,7 +14,7 @@ trial](https://ui.honeycomb.io/signup) to obtain an API key before starting.
 
 ## Compatible with
 
-Requires Ruby version 2.3 or later
+Requires Ruby version 2.5 or later
 
 Built in instrumentation for:
 

data/honeycomb-beeline.gemspec

@@ -15,7 +15,7 @@ Gem::Specification.new do |spec|
 
   spec.license = "Apache-2.0"
 
-  spec.required_ruby_version = ">= 2.2.0"
+  spec.required_ruby_version = ">= 2.5.0"
 
   if spec.respond_to?(:metadata)
     spec.metadata["homepage_uri"] = spec.homepage
@@ -43,8 +43,8 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bump"
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "overcommit", "~> 0.46.0"
-  spec.add_development_dependency "pry", "< 0.13.0"
-  spec.add_development_dependency "pry-byebug", "~> 3.6.0"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "pry-byebug"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "rspec_junit_formatter", ">= 0.5.1"
@@ -52,9 +52,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rubocop-performance", "< 1.3.0"
   spec.add_development_dependency "simplecov"
   spec.add_development_dependency "simplecov-console"
-  if RUBY_VERSION < "2.3.0"
-    spec.add_development_dependency "webmock", "< 3.15.0"
-  else
-    spec.add_development_dependency "webmock"
-  end
+  spec.add_development_dependency "webmock"
 end

data/lib/honeycomb/beeline/version.rb

@@ -2,8 +2,8 @@
 
 module Honeycomb
   module Beeline
-    NAME = "honeycomb-beeline".freeze
-    VERSION = "2.11.1-dev".freeze
-    USER_AGENT_SUFFIX = "#{NAME}/#{VERSION}".freeze
+    NAME = "honeycomb-beeline"
+    VERSION = "3.0.0"
+    USER_AGENT_SUFFIX = "#{NAME}/#{VERSION}"
   end
 end

data/lib/honeycomb/deterministic_sampler.rb

@@ -15,7 +15,7 @@ module Honeycomb
 
       upper_bound = MAX_INT32 / rate
       digest = Digest::SHA1.digest(value)[0, 4]
-      value = digest.unpack("I!>").first
+      value = digest.unpack1("I!>")
       value <= upper_bound
     end
   end

data/lib/honeycomb/integrations/aws.rb

@@ -108,7 +108,7 @@ module Honeycomb
           "aws.operation" => context.operation_name,
         }
 
-        context.params && context.params.each do |key, value|
+        context.params&.each do |key, value|
           context[:honeycomb_aws_sdk_data]["aws.params.#{key}"] = value
         end
 

data/lib/honeycomb/integrations/redis.rb

@@ -199,7 +199,7 @@ module Honeycomb
         pretty.encode!("UTF-8", "binary", fallback: ->(c) { hex(c) })
         pretty.gsub!(NEEDS_BACKSLASH, BACKSLASH)
         pretty.gsub!(NEEDS_HEX) { |c| hex(c) }
-        pretty =~ NEEDS_QUOTES ? "\"#{pretty}\"" : pretty
+        NEEDS_QUOTES.match?(pretty) ? "\"#{pretty}\"" : pretty
       end
 
       # A regular expression matching characters that need to be hex-encoded.

data/lib/honeycomb/propagation/aws.rb

@@ -52,10 +52,8 @@ module Honeycomb
     module MarshalTraceContext
       def to_trace_header
         context = [""]
-        unless trace.fields.keys.nil?
-          trace.fields.keys.each do |key|
-            context.push("#{key}=#{trace.fields[key]}")
-          end
+        trace.fields.keys&.each do |key|
+          context.push("#{key}=#{trace.fields[key]}")
         end
 
         data_to_propagate = [
@@ -68,10 +66,8 @@ module Honeycomb
       def self.to_trace_header(propagation_context)
         context = [""]
         fields = propagation_context.trace_fields
-        unless fields.keys.nil?
-          fields.keys.each do |key|
-            context.push("#{key}=#{fields[key]}")
-          end
+        fields.keys&.each do |key|
+          context.push("#{key}=#{fields[key]}")
         end
 
         data_to_propagate = [

data/lib/honeycomb/propagation/honeycomb.rb

@@ -42,11 +42,9 @@ module Honeycomb
             parent_span_id = value
           when "context"
             Base64.decode64(value).tap do |json|
-              begin
-                trace_fields = JSON.parse json
-              rescue JSON::ParserError
-                trace_fields = {}
-              end
+              trace_fields = JSON.parse json
+            rescue JSON::ParserError
+              trace_fields = {}
             end
           end
         end

data/lib/honeycomb/propagation/honeycomb_modern.rb

@@ -40,11 +40,9 @@ module Honeycomb
             parent_span_id = value
           when "context"
             Base64.decode64(value).tap do |json|
-              begin
-                trace_fields = JSON.parse json
-              rescue JSON::ParserError
-                trace_fields = {}
-              end
+              trace_fields = JSON.parse json
+            rescue JSON::ParserError
+              trace_fields = {}
             end
           end
         end

data/lib/honeycomb/propagation/w3c.rb

@@ -5,8 +5,8 @@ module Honeycomb
   module W3CPropagation
     # Parse trace headers
     module UnmarshalTraceContext
-      INVALID_TRACE_ID = "00000000000000000000000000000000".freeze
-      INVALID_SPAN_ID = "0000000000000000".freeze
+      INVALID_TRACE_ID = "00000000000000000000000000000000"
+      INVALID_SPAN_ID = "0000000000000000"
 
       def parse_rack_env(env)
         parse env["HTTP_TRACEPARENT"]
@@ -16,7 +16,7 @@ module Honeycomb
         unless serialized_trace.nil?
           version, payload = serialized_trace.split("-", 2)
           # version should be 2 hex characters
-          if version =~ /^[A-Fa-f0-9]{2}$/
+          if /^[A-Fa-f0-9]{2}$/.match?(version)
             trace_id, parent_span_id = parse_v1(payload)
 
             if !trace_id.nil? && !parent_span_id.nil?

data/lib/honeycomb/span.rb

@@ -149,13 +149,13 @@ module Honeycomb
       end
 
       if sample
-        presend_hook && presend_hook.call(event.data)
+        presend_hook&.call(event.data)
         event.send_presampled
       end
       @sent = true
       context.span_sent(self)
 
-      parent && parent.remove_child(self)
+      parent&.remove_child(self)
     end
 
     def add_additional_fields

data/lib/honeycomb-beeline.rb

@@ -40,10 +40,8 @@ module Honeycomb
 
     def load_integrations
       integrations_to_load.each do |integration|
-        begin
-          require "honeycomb/integrations/#{integration}"
-        rescue LoadError
-        end
+        require "honeycomb/integrations/#{integration}"
+      rescue LoadError
       end
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: honeycomb-beeline
 version: !ruby/object:Gem::Version
-  version: 2.11.1.pre.dev
+  version: 3.0.0
 platform: ruby
 authors:
 - The Honeycomb.io Team
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-01-26 00:00:00.000000000 Z
+date: 2023-06-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: libhoney
@@ -84,30 +84,30 @@ dependencies:
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "<"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.13.0
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "<"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.13.0
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 3.6.0
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 3.6.0
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -317,14 +317,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.2.0
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
-rubygems_version: 3.3.26
+rubygems_version: 3.4.10
 signing_key: 
 specification_version: 4
 summary: Instrument your Ruby apps with Honeycomb