libhoney 1.14.4 → 1.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9e15c0084830c651747cb2afad99a8ab978f1597be658822e5dbb6683fc8112a
-  data.tar.gz: 20aaee180182ff1e5639445d415a56b423f7561c5e2e5ffb7f409051ae0f1ae5
+  metadata.gz: 26ab54ab7ffb098ee3f1b41b211ca8a1295de834e00c296711fc049a6a9b858e
+  data.tar.gz: 695db353c2c36287e60db383567021b0f35ed11a7472ab0698d8d74832eaf906
 SHA512:
-  metadata.gz: a7d1a9d001a00fdb5956f4e533a6a11b29e8c03fbdb790bb7a6813b9a0ab1fd3af233a3d234dac57c43e0841a0748fe7fdceb9259deced23776750a89c3c3da7
-  data.tar.gz: f9c34581ea811207f7cd8308be4579b1c9f582c5c281153179121c5481236b2fa853ec774525075297eee86affcf8448eadbe04b38ae1bdc55ceb81dd427e9c4
+  metadata.gz: 618e014df070b756a691879c2fb10412ddff2a8224fbfc853983fc0c9b38546366abe23c869c9bc9b65acf9178751ca352bfe331c9904dbec733483c82711ece
+  data.tar.gz: 40f9950ceb87f8512c60cf4328aa90421b3242068826aab54ee858717529de348d34a9d862854e00ca36c384cc0ed6c7e9f4fdec51af1c51c8bff7e3d5b1bcf3

data/.circleci/config.yml

@@ -1,56 +1,63 @@
-version: 2.0
+version: 2.1
 
-test_steps: &test_steps
-  - checkout
-  - restore_cache:
-      keys:
-        - v1-dependencies-{{ checksum "Gemfile.lock" }}
-        # fallback to using the latest cache if no exact match is found
-        - v1-dependencies-
-  - run:
-      name: install dependencies
-      command: |
-        bundle install --jobs=4 --retry=3 --path vendor/bundle
-  - save_cache:
-      paths:
-        - ./vendor/bundle
-      key: v1-dependencies-{{ checksum "Gemfile.lock" }}
-  - run:
-      name: run rubocop
-      command: bundle exec rake rubocop
-  - run:
-      name: run tests
-      command: bundle exec rake test
+# YAML Anchors to reduce copypasta
 
-# required as all of the jobs need to have a tag filter for some reason
-tag_filters: &tag_filters
+# This is necessary for job to run when a tag is created
+filters_always: &filters_always
   filters:
-      tags:
-        only: /.*/
+    tags:
+      only: /.*/
 
-jobs:
-  ruby-2.3:
-    docker:
-      - image: circleci/ruby:2.3
-    steps: *test_steps
-  ruby-2.4:
-    docker:
-      - image: circleci/ruby:2.4
-    steps: *test_steps
-  ruby-2.5:
-    docker:
-      - image: circleci/ruby:2.5
-    steps: *test_steps
-  ruby-2.6:
+# Restrict running to only be on tags starting with vNNNN
+filters_publish: &filters_publish
+  filters:
+    tags:
+      only: /^v[0-9].*/
+    branches:
+      ignore: /.*/
+
+matrix_rubyversions: &matrix_rubyversions
+  matrix:
+    parameters:
+      rubyversion: ["2.2", "2.3", "2.4", "2.5", "2.6", "2.7"]
+
+# Default version of ruby to use for lint and publishing
+default_rubyversion: &default_rubyversion "2.7"
+
+executors:
+  ruby:
+    parameters:
+      rubyversion:
+        type: string
+        default: *default_rubyversion
     docker:
-      - image: circleci/ruby:2.6
-    steps: *test_steps
-  publish:
+      - image: circleci/ruby:<< parameters.rubyversion >>
+  github:
     docker:
-      # Just randomly pick one recent ruby version
-      - image: circleci/ruby:2.6
-    working_directory: ~/repo
+      - image: cibuilds/github:0.13.0
+
+commands:
+  publish_github:
     steps:
+      - attach_workspace:
+          at: ~/
+      - run:
+          name: "Artifacts being published"
+          command: |
+            echo "about to publish to tag ${CIRCLE_TAG}"
+            ls -l ~/artifacts/*
+      - run:
+          name: "GHR Draft"
+          command: ghr -draft -n ${CIRCLE_TAG} -t ${GITHUB_TOKEN} -u ${CIRCLE_PROJECT_USERNAME} -r ${CIRCLE_PROJECT_REPONAME} -c ${CIRCLE_SHA1} ${CIRCLE_TAG} ~/artifacts
+  publish_rubygems:
+    steps:
+      - attach_workspace:
+          at: ~/
+      - run:
+          name: "Artifacts being published"
+          command: |
+            echo "about to publish to tag ${CIRCLE_TAG}"
+            ls -l ~/artifacts/*
       - checkout
       - run:
           name: Setup Rubygems
@@ -58,25 +65,93 @@ jobs:
       - run:
           name: Publish to Rubygems
           command: |
-            gem build libhoney.gemspec
-            gem push "libhoney-$(git describe --tags | cut -d "v" -f 2).gem"
+            gem push ~/artifacts/*.gem
+
+jobs:
+  test:
+    parameters:
+      rubyversion:
+        type: string
+        default: *default_rubyversion
+    executor:
+      name: ruby
+      rubyversion: "<< parameters.rubyversion >>"
+    steps:
+      - checkout
+      - restore_cache:
+          keys:
+            - v1-dependencies-{{ checksum "libhoney.gemspec" }}
+            # fallback to using the latest cache if no exact match is found
+            - v1-dependencies-
+      - run:
+          name: install dependencies
+          command: |
+            bundle install --jobs=4 --retry=3 --path vendor/bundle
+      - save_cache:
+          paths:
+            - ./vendor/bundle
+          key: v1-dependencies-{{ checksum "libhoney.gemspec" }}
+      - run:
+          name: run rubocop
+          command: bundle exec rake rubocop
+      - run:
+          name: run tests
+          command: bundle exec rake test
+
+  build_artifacts:
+    executor:
+      name: ruby
+    steps:
+      - checkout
+      - run: mkdir -p ~/artifacts
+      - run: gem build libhoney.gemspec
+      - run: cp libhoney-*.gem ~/artifacts/
+      - persist_to_workspace:
+          root: ~/
+          paths:
+            - artifacts
+      - store_artifacts:
+          path: ~/artifacts
+
+  publish_github:
+    executor: github
+    steps:
+      - publish_github
+
+  publish_rubygems:
+    executor:
+      name: ruby
+    steps:
+      - publish_rubygems
 
 workflows:
-  version: 2
+  nightly:
+    triggers:
+      - schedule:
+          cron: "0 0 * * *"
+          filters:
+            branches:
+              only:
+                - main
+    jobs:
+      - test:
+          <<: *matrix_rubyversions
   build:
     jobs:
-      - ruby-2.3: *tag_filters
-      - ruby-2.4: *tag_filters
-      - ruby-2.5: *tag_filters
-      - ruby-2.6: *tag_filters
-      - publish:
+      - test:
+          <<: *filters_always
+          <<: *matrix_rubyversions
+      - build_artifacts:
+          <<: *filters_always
           requires:
-            - ruby-2.3
-            - ruby-2.4
-            - ruby-2.5
-            - ruby-2.6
-          filters:
-            tags:
-              only: /^v.*/
-            branches:
-              ignore: /.*/
+            - test
+      - publish_github:
+          <<: *filters_publish
+          context: Honeycomb Secrets
+          requires:
+            - build_artifacts
+      - publish_rubygems:
+          <<: *filters_publish
+          context: Honeycomb Secrets
+          requires:
+            - build_artifacts

data/.editorconfig

@@ -0,0 +1,12 @@
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.md]
+indent_size = 4
+trim_trailing_whitespace = false

data/.github/CODEOWNERS

@@ -0,0 +1,5 @@
+# Code owners file.
+# 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

data/CHANGELOG.md

@@ -0,0 +1,18 @@
+# libhoney-rb changelog
+
+## 1.15.0
+
+Improvements:
+
+- Do not attempt to send invalid events (#67)
+
+Maintenance:
+
+- Modernize circle, include github publishing (#64)
+- Update .editorconfig to add new lines to end of files (#68)
+
+### Misc
+
+-   Added CHANGELOG.md
+-   Updates to CI configuration and documentation
+-   Updated version management.

data/README.md

@@ -4,8 +4,8 @@ Ruby gem for sending events to [Honeycomb](https://www.honeycomb.io), a service
 
 Requires Ruby 2.2 or greater.
 
-- [Usage and Examples](https://docs.honeycomb.io/sdk/ruby/)
-- [API Reference](https://www.rubydoc.info/gems/libhoney)
+-   [Usage and Examples](https://docs.honeycomb.io/sdk/ruby/)
+-   [API Reference](https://www.rubydoc.info/gems/libhoney)
 
 For tracing support and automatic instrumentation of Rails, Sinatra, Rack, ActiveRecord, and other frameworks, check out our [Beeline for Ruby](https://github.com/honeycombio/beeline-ruby).
 
@@ -20,8 +20,11 @@ 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, run
+version, update the version using `bump`.
+
 ```
-bump patch --tag   # Or bump minor --tag, etc.
-git push --follow-tags
+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/lib/libhoney/client.rb

@@ -229,7 +229,7 @@ module Libhoney
           proxy_config: @proxy_config
         }
 
-        @transmission ||= TransmissionClient.new(transmission_client_params)
+        @transmission ||= TransmissionClient.new(**transmission_client_params)
       end
 
       @transmission.add(event)

data/lib/libhoney/transmission.rb

@@ -40,6 +40,8 @@ module Libhoney
     end
 
     def add(event)
+      return unless event_valid(event)
+
       begin
         @batch_queue.enq(event, !@block_on_send)
       rescue ThreadError
@@ -49,6 +51,26 @@ module Libhoney
       ensure_threads_running
     end
 
+    def event_valid(event)
+      invalid = []
+      invalid.push('api host') if event.api_host.nil? || event.api_host.empty?
+      invalid.push('write key') if event.writekey.nil? || event.writekey.empty?
+      invalid.push('dataset') if event.dataset.nil? || event.dataset.empty?
+
+      unless invalid.empty?
+        e = StandardError.new("#{self.class.name}: nil or empty required fields (#{invalid.join(', ')})"\
+          '. Will not attempt to send.')
+        Response.new(error: e).tap do |error_response|
+          error_response.metadata = event.metadata
+          enqueue_response(error_response)
+        end
+
+        return false
+      end
+
+      true
+    end
+
     def send_loop
       http_clients = build_http_clients
 
@@ -135,9 +157,11 @@ module Libhoney
 
       loop do
         begin
-          while (event = Timeout.timeout(@send_frequency) { @batch_queue.pop })
-            key = [event.api_host, event.writekey, event.dataset]
-            batched_events[key] << event
+          Thread.handle_interrupt(Timeout::Error => :on_blocking) do
+            while (event = Timeout.timeout(@send_frequency) { @batch_queue.pop })
+              key = [event.api_host, event.writekey, event.dataset]
+              batched_events[key] << event
+            end
           end
 
           break

data/lib/libhoney/version.rb

@@ -1,3 +1,3 @@
 module Libhoney
-  VERSION = '1.14.4'.freeze
+  VERSION = '1.15.0'.freeze
 end

data/libhoney.gemspec

@@ -29,7 +29,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rubocop', '< 0.69'
   spec.add_development_dependency 'sinatra'
   spec.add_development_dependency 'sinatra-contrib'
-  spec.add_development_dependency 'spy'
+  spec.add_development_dependency 'spy', '1.0.0'
   spec.add_development_dependency 'webmock', '~> 3.4'
   spec.add_development_dependency 'yard'
   spec.add_development_dependency 'yardstick', '~> 0.9'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: libhoney
 version: !ruby/object:Gem::Version
-  version: 1.14.4
+  version: 1.15.0
 platform: ruby
 authors:
 - The Honeycomb.io Team
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-02-03 00:00:00.000000000 Z
+date: 2020-11-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bump
@@ -112,16 +112,16 @@ dependencies:
   name: spy
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
@@ -206,12 +206,14 @@ extra_rdoc_files: []
 files:
 - ".circleci/config.yml"
 - ".circleci/setup-rubygems.sh"
+- ".editorconfig"
+- ".github/CODEOWNERS"
 - ".gitignore"
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
+- CHANGELOG.md
 - CONTRIBUTORS
 - Gemfile
-- Gemfile.lock
 - LICENSE
 - NOTICE
 - README.md
@@ -251,7 +253,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: send data to Honeycomb

data/Gemfile.lock

@@ -1,101 +0,0 @@
-PATH
-  remote: .
-  specs:
-    libhoney (1.14.4)
-      addressable (~> 2.0)
-      http (>= 2.0, < 5.0)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    addressable (2.6.0)
-      public_suffix (>= 2.0.2, < 4.0)
-    ast (2.4.0)
-    backports (3.15.0)
-    bump (0.8.0)
-    crack (0.4.3)
-      safe_yaml (~> 1.0.0)
-    domain_name (0.5.20190701)
-      unf (>= 0.0.5, < 1.0.0)
-    ffi (1.12.1)
-    ffi-compiler (1.0.1)
-      ffi (>= 1.0.0)
-      rake
-    hashdiff (1.0.0)
-    http (4.2.0)
-      addressable (~> 2.3)
-      http-cookie (~> 1.0)
-      http-form_data (~> 2.0)
-      http-parser (~> 1.2.0)
-    http-cookie (1.0.3)
-      domain_name (~> 0.5)
-    http-form_data (2.1.1)
-    http-parser (1.2.1)
-      ffi-compiler (>= 1.0, < 2.0)
-    jaro_winkler (1.5.3)
-    minitest (5.11.3)
-    multi_json (1.13.1)
-    mustermann (1.0.3)
-    parallel (1.17.0)
-    parser (2.6.3.0)
-      ast (~> 2.4.0)
-    public_suffix (3.1.1)
-    rack (2.0.8)
-    rack-protection (2.0.5)
-      rack
-    rainbow (3.0.0)
-    rake (12.3.3)
-    rubocop (0.68.1)
-      jaro_winkler (~> 1.5.1)
-      parallel (~> 1.10)
-      parser (>= 2.5, != 2.5.1.1)
-      rainbow (>= 2.2.2, < 4.0)
-      ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 1.6)
-    ruby-progressbar (1.10.1)
-    safe_yaml (1.0.5)
-    sinatra (2.0.5)
-      mustermann (~> 1.0)
-      rack (~> 2.0)
-      rack-protection (= 2.0.5)
-      tilt (~> 2.0)
-    sinatra-contrib (2.0.5)
-      backports (>= 2.8.2)
-      multi_json
-      mustermann (~> 1.0)
-      rack-protection (= 2.0.5)
-      sinatra (= 2.0.5)
-      tilt (>= 1.3, < 3)
-    spy (1.0.0)
-    tilt (2.0.9)
-    unf (0.1.4)
-      unf_ext
-    unf_ext (0.0.7.6)
-    unicode-display_width (1.5.0)
-    webmock (3.6.2)
-      addressable (>= 2.3.6)
-      crack (>= 0.3.2)
-      hashdiff (>= 0.4.0, < 2.0.0)
-    yard (0.9.20)
-    yardstick (0.9.9)
-      yard (~> 0.8, >= 0.8.7.2)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bump (~> 0.5)
-  bundler
-  libhoney!
-  minitest (~> 5.0)
-  rake (~> 12.3)
-  rubocop (< 0.69)
-  sinatra
-  sinatra-contrib
-  spy
-  webmock (~> 3.4)
-  yard
-  yardstick (~> 0.9)
-
-BUNDLED WITH
-   1.17.3