libhoney 1.18.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 33a687ebf8ae87e69cf6a53b50c4e2cd926f9938af709635d42a209ec2e6c93e
-  data.tar.gz: fd3f558a15f872c9f63fc6451722c3e9e21b7cba5ebe8d7816ec0cb08064318b
+  metadata.gz: c346ba7e750c99063736cd641e10eb153f9a1326b1bf17231e7c89ad312d102a
+  data.tar.gz: 5f16185c3b43ce38f0323861244966ccc6df2404c5b7c05f712c530d25f193d6
 SHA512:
-  metadata.gz: 36efc5d9734e125cd141e21dd60edbc6cf23350334bf431dead264c375dfd11b54bcf286f5509d5e97633ee4ce2d4fc689ebf5033d472237d5b6e7e2f2d0cb81
-  data.tar.gz: 5d5147a6e9f3fc1055a94932943c5915c99f43ad550d4dd5f20955d2dad023c41a1939e6f8037b38856375a10dcdc51557b06e3d56b454296a1596c7dd62b74c
+  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
@@ -97,6 +98,8 @@ jobs:
       - run:
           name: run tests
           command: bundle exec rake test
+      - store_test_results:
+          path: test/reports
 
   build_artifacts:
     executor:

data/.github/CODEOWNERS

@@ -2,4 +2,4 @@
 # This file controls who is tagged for review for any given pull request.
 
 # For anything not explicitly taken by someone else:
-* @honeycombio/integrations-team @martin308
+* @honeycombio/telemetry-team

data/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,27 @@
+---
+name: Bug report
+about: Let us know if something is not working as expected
+title: ''
+labels: 'type: bug'
+assignees: ''
+
+---
+
+<!---
+Thank you for taking the time to report bugs!
+
+We love code snippets and links to repositories that reproduce the issue, but understand if you don't have the time to add them. We'll do our best with the info you provide, and might ask follow-up questions.
+
+Please see our [OSS process document](https://github.com/honeycombio/home/blob/main/honeycomb-oss-lifecycle-and-practices.md#) to get an idea of how we operate.
+--->
+
+**Versions**
+
+- Ruby:
+- Libhoney:
+
+**Steps to reproduce**
+
+1.
+
+**Additional context**

data/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,25 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: 'type: enhancement'
+assignees: ''
+
+---
+
+<!---
+Thank you for contributing an idea to this project!
+
+Please see our [OSS process document](https://github.com/honeycombio/home/blob/main/honeycomb-oss-lifecycle-and-practices.md#) to get an idea of how we operate.
+--->
+
+**Is your feature request related to a problem? Please describe.**
+
+
+**Describe the solution you'd like**
+
+
+**Describe alternatives you've considered**
+
+
+**Additional context**

data/.github/ISSUE_TEMPLATE/question-discussion.md

@@ -0,0 +1,14 @@
+---
+name: Question/Discussion
+about: General question about how things work or a discussion
+title: ''
+labels: 'type: discussion'
+assignees: ''
+
+---
+
+<!---
+Thank you for taking the time to say hello!
+
+Please see our [OSS process document](https://github.com/honeycombio/home/blob/main/honeycomb-oss-lifecycle-and-practices.md#) to get an idea of how we operate.
+--->

data/.github/ISSUE_TEMPLATE/security-vulnerability-report.md

@@ -0,0 +1,22 @@
+---
+name: Security vulnerability report
+about: Let us know if you discover a security vulnerability
+title: ''
+labels: 'type: security'
+assignees: ''
+
+---
+
+<!---
+Thank you for taking the time to report security vulnerabilities!
+
+Please see our [OSS process document](https://github.com/honeycombio/home/blob/main/honeycomb-oss-lifecycle-and-practices.md#) to get an idea of how we operate.
+--->
+**Versions**
+
+- Ruby:
+- Libhoney:
+
+**Description**
+
+(Please include any relevant CVE advisory links)

data/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,20 @@
+<!--
+Thank you for contributing to the project! 💜
+Please make sure to:
+- Chat with us first if this is a big change
+  - Open a new issue (or comment on an existing one)
+  - We want to make sure you don't spend time implementing something we might have to say No to
+- Add unit tests
+- Mention any relevant issues in the PR description (e.g. "Fixes #123")
+
+Please see our [OSS process document](https://github.com/honeycombio/home/blob/main/honeycomb-oss-lifecycle-and-practices.md#) to get an idea of how we operate.
+-->
+
+## Which problem is this PR solving?
+
+-
+
+## Short description of the changes
+
+-
+

data/.github/dependabot.yml

@@ -0,0 +1,15 @@
+# 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://help.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: "weekly"
+    labels:
+      - "type: dependencies"
+    reviewers:
+      - "honeycombio/telemetry-team"

data/.github/workflows/add-to-project.yml

@@ -0,0 +1,14 @@
+name: Apply project management flow
+on:
+  issues:
+    types: [opened]
+  pull_request_target:
+    types: [opened]
+jobs:
+  project-management:
+    runs-on: ubuntu-latest
+    name: Apply project management flow
+    steps:
+      - uses: honeycombio/oss-management-actions/projects@v1
+        with:
+          ghprojects-token: ${{ secrets.GHPROJECTS_TOKEN }}

data/.github/workflows/apply-labels.yml

@@ -0,0 +1,10 @@
+name: Apply project labels
+on: [issues, pull_request, label]
+jobs:
+  apply-labels:
+    runs-on: ubuntu-latest
+    name: Apply common project labels
+    steps:
+      - uses: honeycombio/oss-management-actions/labels@v1
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}

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/.gitignore

@@ -7,6 +7,7 @@
 /pkg/
 /spec/reports/
 /spec/examples.txt
+/test/reports/
 /test/tmp/
 /test/version_tmp/
 /tmp/

data/.rubocop.yml

@@ -1,31 +1,54 @@
 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'
+    - 'lib/libhoney/experimental_transmission.rb'
 
 Metrics/BlockLength:
   Max: 35
 
 Metrics/ClassLength:
-  Max: 200
+  Max: 300
   Exclude:
     - lib/libhoney/transmission.rb # Should this remain so large?
     - test/*
 
 Metrics/MethodLength:
-  Max: 40
+  Max: 45
   Exclude:
     - 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,6 +1,47 @@
-# libhoney-rb changelog
+## [2.0.0] - 2021-10-07
 
-## changes pending release
+### 💥 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
+
+### Added
+
+- Include Ruby runtime info in user agent (#105) | [robbkidd](https://github.com/robbkidd)
+
+### Maintenance
+
+- Update http requirement from >= 2.0, < 5.0 to >= 2.0, < 6.0 (#100)
+- Update spy requirement to accept any 1.x release (#102)
+- Update rake requirement from ~> 12.3 to ~> 13.0 (#101)
+- Add issue and PR templates (#99)
+- Add OSS lifecycle badge (#98)
+- Add community health files (#97)
+
+## 1.20.0
+
+### Fixes
+
+- Handle Timeout::Error in TransmissionClient (#95) | [Adam Pohorecki](https://github.com/psyho)
+
+## 1.19.0
+
+### Improvements
+
+- add a test_helper, Minitest reporters, & store test results in CI (#88)
+- add experimental transmission with new sized-and-timed queue (#87)
+
+### Fixes
+
+- Process single-error responses from the Batch API (#89)
 
 ## 1.18.0
 

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,5 @@
+# Code of Conduct
+
+This project has adopted the Honeycomb User Community Code of Conduct to clarify expected behavior in our community.
+
+https://www.honeycomb.io/honeycomb-user-community-code-of-conduct/

data/CONTRIBUTING.md

@@ -0,0 +1,3 @@
+# Contributing Guide
+
+Please see our [general guide for OSS lifecycle and practices.](https://github.com/honeycombio/home/blob/main/honeycomb-oss-lifecycle-and-practices.md)

data/CONTRIBUTORS

@@ -10,3 +10,4 @@ Eben Freeman <eben@honeycomb.io>
 Ryan King <ryan@theryanking.com>
 Paul Sadauskas <psadauskas@gmail.com>
 Shane Becker <veganstraightedge@gmail.com>
+Adam Pohorecki <adam@pohorecki.pl>

data/OSSMETADATA

@@ -0,0 +1 @@
+osslifecycle=maintained

data/README.md

@@ -1,8 +1,12 @@
-# libhoney [![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)
+# libhoney
+
+[![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)
@@ -16,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

@@ -0,0 +1,12 @@
+# Releasing
+
+- Update the version number in `lib/libhoney/version.rb`.
+  - 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.
+- Apply a tag for the new version on the merged commit: vX.Y.Z, for example v1.1.2.
+- Push the new version tag up to the project repository to kick off build and artifact publishing to GitHub and the Gems registry.
+- Publish the draft release in GitHub.

data/SECURITY.md

@@ -0,0 +1,3 @@
+# Reporting Security Issues
+
+If you discover a security vulnerability, please open an issue with label `type: security`.

data/SUPPORT.md

@@ -0,0 +1,3 @@
+# How to Get Help
+
+This project uses GitHub issues to track bugs, feature requests, and questions about using the project. Please search for existing issues before filing a new one.

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