logplex 0.0.6 → 1.0.0

data/.rubocop_standardrb_overrides.yml

@@ -0,0 +1,28 @@
+Layout/SpaceInsideHashLiteralBraces:
+  Enabled: true
+  EnforcedStyle: space
+  EnforcedStyleForEmptyBraces: no_space
+
+Style/FrozenStringLiteralComment:
+  Enabled: true
+
+Style/TrailingCommaInArguments:
+  Enabled: true
+  EnforcedStyleForMultiline: consistent_comma
+
+Style/TrailingCommaInArrayLiteral:
+  Enabled: true
+  EnforcedStyleForMultiline: consistent_comma
+
+Style/TrailingCommaInHashLiteral:
+  Enabled: true
+  EnforcedStyleForMultiline: consistent_comma
+
+Lint/NumberConversion:
+  Enabled: true
+
+RSpec/ExampleLength:
+  Max: 12
+
+RSpec/MultipleExpectations:
+  Max: 3

data/CHANGELOG.md

@@ -0,0 +1,113 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).
+
+## [Unreleased]
+
+### Added
+
+-
+
+### Changed
+
+-
+
+## [1.0.0]
+
+### Added
+
+- `Logplex::HTTP::Error` exception hierarchy. See: lib/logplex/errors.rb
+- RuboCop linting with StandardRB-based configuration
+- GitHub Actions CI workflow (Ruby 3.2, 3.3, 3.4, 4.0)
+
+### Changed
+
+- Migrated test stubs from Excon mocks to WebMock
+- Migrated CI from CircleCI to GitHub Actions
+
+### Removed
+
+- **Breaking Change:** Replace `Excon` with stdlib `Net::HTTP` - Gem-specific errors are raised rather than Excon-specific errors. See: lib/logplex/errors.rb
+- Duplicate license file
+
+## [0.0.7]
+
+### Added
+
+- Bearer authentication support via `bearer_token:` keyword argument on `Publisher`
+
+### Changed
+
+- N/A
+
+### Removed
+
+- CircleCI configuration
+- Duplicate license file
+
+## [0.0.6] - 2022-03-03
+
+### Added
+
+- Accept HTTP 202 responses from Logplex in addition to 200 and 204
+- CODEOWNERS file with ECCN classification
+
+### Changed
+
+- Migrated CI from Travis CI to CircleCI
+
+### Removed
+
+- Travis CI configuration
+
+## [0.0.5] - 2021-09-13
+
+### Changed
+
+- Updated gemspec metadata
+
+## [0.0.4] - 2021-07-13
+
+### Added
+
+- `Logplex-Msg-Count` header sent with each publish request
+- `app_name` option to override the default token-based app name on publish
+- Tests for header correctness and app name override
+
+### Fixed
+
+- Message number mismatch when publishing multiple messages
+- `app_name` from options now properly overrides the token default instead of the reverse
+
+## [0.0.1] - 2016-07-26
+
+### Changed
+
+- Modernized publisher to use `Excon.post` directly instead of persistent connections
+- Updated gemspec and dependencies
+
+## [0.0.1-pre] - 2013-05-01
+
+### Added
+
+- Initial logplex publisher and message formatting
+- Global configuration object with configurable `process`, `host`, and `publish_timeout`
+- Syslog-framed message encoding
+- Key/value pair formatting when messages are passed as a hash
+- Publish timeout (default 1 second) with configurable override
+- Return value from `publish` (true on success, false on failure)
+- Travis CI configuration
+
+### Fixed
+
+- Bug caused by invoking `Array()` on a hash
+
+[Unreleased]: https://github.com/heroku/logplex-gem/compare/v1.0.0...HEAD
+[1.0.0]: https://github.com/heroku/logplex-gem/compare/v0.0.7...v1.0.0
+[0.0.7]: https://github.com/heroku/logplex-gem/compare/v0.0.6...0.0.7
+[0.0.6]: https://github.com/heroku/logplex-gem/compare/v0.0.5...v0.0.6
+[0.0.5]: https://github.com/heroku/logplex-gem/compare/v0.0.4...v0.0.5
+[0.0.4]: https://github.com/heroku/logplex-gem/compare/v0.0.1...v0.0.4
+[0.0.1]: https://github.com/heroku/logplex-gem/compare/v0.0.1-pre...v0.0.1

data/CODEOWNERS

@@ -1,2 +1,4 @@
 # Comment line immediately above ownership line is reserved for related gus information. Please be careful while editing.
 #ECCN:Open Source
+#GUSINFO:Heroku Data Operations,Heroku Data Intake
+* @heroku/data

data/Gemfile

@@ -1,4 +1,11 @@
-source 'https://rubygems.org'
+# frozen_string_literal: true
+
+source "https://rubygems.org"
 
-# Specify your gem's dependencies in logplex.gemspec
 gemspec
+
+gem "rspec"
+gem "rubocop"
+gem "rubocop-performance"
+gem "rubocop-rspec"
+gem "webmock"

data/README.md

@@ -2,10 +2,9 @@
 
 Publish and Consume Logplex messages
 
-Logplex is the Heroku log router, and can be found
-[here](https://github.com/heroku/logplex).
+Logplex is the Heroku log router, and [can be found here](https://github.com/heroku/logplex).
 
-### Publishing messages
+## Publishing messages
 
 ```ruby
 publisher = Logplex::Publisher.new(logplex_url)
@@ -57,7 +56,34 @@ publisher = Logplex::Publisher.new
 publisher.publish "And she's buying a stairway to heaven"
 ```
 
-### License
+## Releasing
+
+1. **Bump the version** in `lib/logplex/version.rb`
+
+2. **Update `CHANGELOG.md`** — move entries from `[Unreleased]` into a new versioned section and update the comparison links at the bottom
+
+3. **Commit the changes**
+
+   ```shell
+   git add lib/logplex/version.rb CHANGELOG.md
+   git commit -m "version -> x.y.z"
+   ```
+
+4. **Create and push a git tag**
+
+   ```shell
+   git tag vx.y.z
+   git push origin main --tags
+   ```
+
+5. **Build and push the gem to RubyGems.org**
+
+   ```shell
+   gem build
+   gem push logplex-x.y.z.gem
+   ```
+
+## License
 
 Copyright (c) Harold Giménez. Released under the terms of the MIT License found
 in the LICENSE file.

data/Rakefile

@@ -1 +1,3 @@
+# frozen_string_literal: true
+
 require "bundler/gem_tasks"

data/lib/logplex/configuration.rb

@@ -1,16 +1,18 @@
+# frozen_string_literal: true
+
 module Logplex
   class Configuration
     attr_accessor :logplex_url,
-                  :app_name,
-                  :process,
-                  :host,
-                  :publish_timeout
+      :app_name,
+      :process,
+      :host,
+      :publish_timeout
 
     def initialize
-      @logplex_url     = 'https://east.logplex.io/logs'
-      @host            = 'localhost'
+      @logplex_url = "https://east.logplex.io/logs"
+      @host = "localhost"
       @publish_timeout = 1
-      @app_name        = 'app'
+      @app_name = "app"
     end
   end
 

data/lib/logplex/errors.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Logplex
+  module HTTP
+    class Error < StandardError; end
+    class ConnectionResetError < Error; end
+    class SocketError < Error; end
+    class TimeoutError < Error; end
+    class ServerError < Error; end
+    class ServiceUnavailableError < ServerError; end
+    class ClientError < Error; end
+    class SeeOtherError < Error; end
+  end
+end

data/lib/logplex/message.rb

@@ -1,6 +1,8 @@
-require 'valcro'
-require 'time'
-require 'logplex/configuration'
+# frozen_string_literal: true
+
+require "valcro"
+require "time"
+require "logplex/configuration"
 
 module Logplex
   class Message
@@ -8,16 +10,16 @@ module Logplex
 
     # facility = local0, priority = info, RFC5452 encoded
     # syslog version 1
-    FACILITY_AND_PRIORITY = '<134>1'.freeze
+    FACILITY_AND_PRIORITY = "<134>1"
 
-    FIELD_DISABLED = '-'.freeze
+    FIELD_DISABLED = "-"
 
     def initialize(message, opts = {})
-      @message    = message
-      @app_name   = opts[:app_name] || Logplex.configuration.app_name
-      @time       = opts[:time] || DateTime.now
-      @process    = opts[:process] || Logplex.configuration.process
-      @host       = opts[:host] || Logplex.configuration.host
+      @message = message
+      @app_name = opts[:app_name] || Logplex.configuration.app_name
+      @time = opts[:time] || DateTime.now
+      @process = opts[:process] || Logplex.configuration.process
+      @host = opts[:host] || Logplex.configuration.host
       @message_id = opts[:message_id] || FIELD_DISABLED
     end
 
@@ -48,8 +50,8 @@ module Logplex
     def formatted_message
       if @message.is_a?(Hash)
         @message.inject([]) do |res, (key, value)|
-          res << %{#{key}="#{value}"}
-        end.join(' ')
+          res << %(#{key}="#{value}")
+        end.join(" ")
       else
         @message
       end

data/lib/logplex/publisher.rb

@@ -1,20 +1,20 @@
-# encoding: UTF-8
-require 'excon'
-require 'logplex/message'
-require 'timeout'
+# frozen_string_literal: true
+
+require "net/http"
+require "uri"
+require "logplex/errors"
+require "logplex/message"
+require "timeout"
 
 module Logplex
   class Publisher
-    PUBLISH_ERRORS = [Excon::Errors::InternalServerError,
-                      Excon::Errors::Unauthorized,
-                      Timeout::Error].freeze
-
-    def initialize(logplex_url = nil)
+    def initialize(logplex_url = nil, bearer_token: nil)
       @logplex_url = logplex_url || Logplex.configuration.logplex_url
       @token = URI(@logplex_url).password || Logplex.configuration.app_name
+      @auth_headers = bearer_token ? { "Authorization" => "Bearer #{bearer_token}" } : {}
     end
 
-    def publish(messages, opts={})
+    def publish(messages, opts = {})
       message_list = messages.dup
       unless messages.is_a? Array
         message_list = [message_list]
@@ -22,25 +22,55 @@ module Logplex
       message_list.map! { |m| Message.new(m, { app_name: @token }.merge(opts)) }
       message_list.each(&:validate)
       if message_list.inject(true) { |accum, m| m.valid? }
-        begin
-          Timeout.timeout(Logplex.configuration.publish_timeout) do
-            api_post(message_list.map(&:syslog_frame).join(''), message_list.length)
-            true
-          end
-        rescue *PUBLISH_ERRORS
-          false
+        Timeout.timeout(Logplex.configuration.publish_timeout) do
+          api_post(message_list.map(&:syslog_frame).join(""), message_list.length)
+          true
         end
       end
+    rescue Errno::ECONNRESET => e
+      raise Logplex::HTTP::ConnectionResetError, e.message
+    rescue ::SocketError, Errno::ECONNREFUSED, Errno::EHOSTUNREACH, Errno::ENETUNREACH => e
+      raise Logplex::HTTP::SocketError, e.message
+    rescue Timeout::Error => e
+      raise Logplex::HTTP::TimeoutError, e.message
     end
 
     private
 
     def api_post(message, number_messages)
-      Excon.post(@logplex_url, body: message, headers: {
-        "Content-Type" => 'application/logplex-1',
-        "Content-Length" => message.length,
-        "Logplex-Msg-Count" => number_messages
-      }, expects: [200, 202, 204])
+      uri = URI(@logplex_url)
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = uri.scheme == "https"
+
+      request = Net::HTTP::Post.new(uri)
+      request.body = message
+      request["Content-Type"] = "application/logplex-1"
+      request["Content-Length"] = message.length
+      request["Logplex-Msg-Count"] = number_messages
+
+      if @auth_headers.key?("Authorization")
+        request["Authorization"] = @auth_headers["Authorization"]
+      elsif uri.password
+        request.basic_auth(uri.user, uri.password)
+      end
+
+      response = http.request(request)
+
+      code = Integer(response.code, 10)
+      return if [200, 202, 204].include?(code)
+
+      case code
+      when 303
+        raise Logplex::HTTP::SeeOtherError, "Unexpected response: #{response.code}"
+      when 503
+        raise Logplex::HTTP::ServiceUnavailableError, "Unexpected response: #{response.code}"
+      when 400..499
+        raise Logplex::HTTP::ClientError, "Unexpected response: #{response.code}"
+      when 500..599
+        raise Logplex::HTTP::ServerError, "Unexpected response: #{response.code}"
+      else
+        raise Logplex::HTTP::Error, "Unexpected response: #{response.code}"
+      end
     end
   end
 end

data/lib/logplex/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Logplex
-  VERSION = "0.0.6".freeze
+  VERSION = "1.0.0"
 end

data/lib/logplex.rb

@@ -1,4 +1,7 @@
+# frozen_string_literal: true
+
 require "logplex/version"
 require "logplex/configuration"
+require "logplex/errors"
 require "logplex/message"
 require "logplex/publisher"

data/logplex.gemspec

@@ -1,22 +1,25 @@
-# -*- encoding: utf-8 -*-
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'logplex/version'
+# frozen_string_literal: true
 
-Gem::Specification.new do |gem|
-  gem.name          = "logplex"
-  gem.version       = Logplex::VERSION
-  gem.authors       = ["Harold Giménez", "Heroku"]
-  gem.email         = ["harold.gimenez@gmail.com"]
-  gem.description   = "Publish and Consume Logplex messages"
-  gem.summary       = "Publish and Consume Logplex messages"
-  gem.homepage      = "https://github.com/heroku/logplex-gem"
+require_relative "lib/logplex/version"
 
-  gem.files         = `git ls-files`.split($/)
-  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
-  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
-  gem.require_paths = ["lib"]
-  gem.add_dependency "valcro"
-  gem.add_dependency "excon"
-  gem.add_development_dependency "rspec"
+Gem::Specification.new do |spec|
+  spec.name = "logplex"
+  spec.version = Logplex::VERSION
+  spec.authors = ["Harold Giménez", "Heroku"]
+  spec.email = ["harold.gimenez@gmail.com"]
+  spec.description = "Logplex client"
+  spec.summary = "Publish and Consume Logplex messages"
+  spec.homepage = "https://github.com/heroku/logplex-gem"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 3.2.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/heroku/logplex-gem"
+  spec.metadata["changelog_uri"] = "https://github.com/heroku/logplex-gem/blob/main/CHANGELOG.md"
+
+  spec.files = `git ls-files`.split($/)
+  spec.executables = spec.files.grep(%r{^bin/}).map { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "valcro"
 end

data/spec/logplex/configuration_spec.rb

@@ -1,14 +1,16 @@
-require 'spec_helper'
-require 'logplex/configuration'
+# frozen_string_literal: true
+
+require "spec_helper"
+require "logplex/configuration"
 
 describe Logplex::Configuration do
-  describe 'defaults' do
-    it 'defaults to the production heroku logplex url' do
+  describe "defaults" do
+    it "defaults to the production heroku logplex url" do
       Logplex.configure { |config| }
 
       expect(
-        Logplex.configuration.logplex_url
-      ).to eq('https://east.logplex.io/logs')
+        Logplex.configuration.logplex_url,
+      ).to eq("https://east.logplex.io/logs")
     end
   end
 end

data/spec/logplex/message_spec.rb

@@ -1,63 +1,66 @@
-require 'spec_helper'
-require 'logplex/message'
+# frozen_string_literal: true
+
+require "spec_helper"
+require "logplex/message"
 
 describe Logplex::Message do
   before { Logplex.configure {} }
   after { restore_default_config }
-  it 'fills out fields of a syslog message' do
-    message = Logplex::Message.new(
-      'my message here',
-      app_name: 't.some-token',
+
+  it "fills out fields of a syslog message" do
+    message = described_class.new(
+      "my message here",
+      app_name: "t.some-token",
       time: DateTime.parse("1980-08-23 05:31 00:00"),
-      process: 'heroku-postgres',
-      host: 'some-host',
-      message_id: '1'
+      process: "heroku-postgres",
+      host: "some-host",
+      message_id: "1",
     )
 
     expect(message.syslog_frame).to eq(
-      "91 <134>1 1980-08-23T05:31:00+00:00 some-host t.some-token heroku-postgres 1 - my message here"
+      "91 <134>1 1980-08-23T05:31:00+00:00 some-host t.some-token heroku-postgres 1 - my message here",
     )
   end
 
-  it 'is invalid for messages longer than 10240 bytes' do
-    short = Logplex::Message.new('a' * 10240, app_name:   'foo',
-                                              process: 'proc',
-                                              host:    'host')
-    long  = Logplex::Message.new('a' * 10241, app_name: 'foo',
-                                              process: 'proc',
-                                              host:    'host')
+  it "is invalid for messages longer than 10240 bytes" do
+    short = described_class.new("a" * 10240, app_name:   "foo",
+      process: "proc",
+      host:    "host",)
+    long = described_class.new("a" * 10241, app_name: "foo",
+      process: "proc",
+      host:    "host",)
     short.validate
     long.validate
 
-    expect(short.valid?).to be_truthy
-    expect(long.valid?).to be_falsey
+    expect(short).to be_valid
+    expect(long).not_to be_valid
   end
 
-  it 'is invalid with no process or host' do
+  it "is invalid with no process or host" do
     Logplex.configure do |conf|
-      conf.host    = nil
+      conf.host = nil
       conf.process = nil
     end
 
-    message = Logplex::Message.new("a message", app_name: 't.some-token')
+    message = described_class.new("a message", app_name: "t.some-token")
     message.validate
 
-    expect(message.valid?).to be_falsey
+    expect(message).not_to be_valid
     expect(message.errors[:process]).to eq ["can't be nil"]
     expect(message.errors[:host]).to eq ["can't be nil"]
   end
 
-  it 'formats logs as key/values when given a hash' do
-    message = Logplex::Message.new(
-      { vocals: 'Robert Plant', guitar: 'Jimmy Page' },
-      app_name: 't.some-token',
-      process: 'proc',
-      host:    'host',
-      time: DateTime.parse("1980-08-23 05:31 00:00")
+  it "formats logs as key/values when given a hash" do
+    message = described_class.new(
+      { vocals: "Robert Plant", guitar: "Jimmy Page" },
+      app_name: "t.some-token",
+      process: "proc",
+      host: "host",
+      time: DateTime.parse("1980-08-23 05:31 00:00"),
     )
 
     expect(message.syslog_frame).to eq(
-      %{101 <134>1 1980-08-23T05:31:00+00:00 host t.some-token proc - - vocals="Robert Plant" guitar="Jimmy Page"}
+      %(101 <134>1 1980-08-23T05:31:00+00:00 host t.some-token proc - - vocals="Robert Plant" guitar="Jimmy Page"),
     )
   end
 end