logplex 0.0.6 → 1.0.0

data/spec/logplex/publisher_spec.rb

@@ -1,106 +1,195 @@
-require 'spec_helper'
-require 'logplex/publisher'
-require 'logplex/message'
+# frozen_string_literal: true
+
+require "spec_helper"
+require "logplex/publisher"
+require "logplex/message"
 
 describe Logplex::Publisher do
-  describe '#publish' do
+  describe "#publish" do
     before do
-      Excon.defaults[:mock] = true
       Logplex.configure do |config|
         config.process = "postgres"
         config.host = "host"
       end
     end
 
-    after do
-      Excon.stubs.clear
-    end
-
-    context 'with a working logplex' do
+    context "with a working logplex" do
       after do
         restore_default_config
       end
 
-      it 'encodes a message and publishes it' do
-        Excon.stub({ method: :post, password: "t.some-token", body: /message for you/ }, status: 204)
-        message = 'I have a message for you'
-        publisher = Logplex::Publisher.new('https://token:t.some-token@logplex.example.com')
+      it "encodes a message and publishes it" do
+        stub = WebMock.stub_request(:post, "https://logplex.example.com")
+          .with(body: /message for you/, basic_auth: ["token", "t.some-token"])
+          .to_return(status: 204)
+        message = "I have a message for you"
+        publisher = described_class.new("https://token:t.some-token@logplex.example.com")
         publisher.publish(message)
+        expect(stub).to have_been_requested
       end
 
-      it 'sends many messages in one request when passed an array' do
-        Excon.stub({ method: :post, password: "t.some-token", body: /message for you.+here is another.+some final thoughts/ }, status: 204)
-        messages = ['I have a message for you', 'here is another', 'some final thoughts']
-        publisher = Logplex::Publisher.new('https://token:t.some-token@logplex.example.com')
+      it "sends many messages in one request when passed an array" do
+        stub = WebMock.stub_request(:post, "https://logplex.example.com")
+          .with(body: /message for you.+here is another.+some final thoughts/, basic_auth: ["token", "t.some-token"])
+          .to_return(status: 204)
+        messages = ["I have a message for you", "here is another", "some final thoughts"]
+        publisher = described_class.new("https://token:t.some-token@logplex.example.com")
         publisher.publish(messages)
+        expect(stub).to have_been_requested
       end
 
-      it 'uses the token if app_name is not given' do
-        Excon.stub({ method: :post, password: "t.some-token", body: /t.some-token/ }, status: 204)
-        message = 'I have a message for you'
-        publisher = Logplex::Publisher.new('https://token:t.some-token@logplex.example.com')
+      it "uses the token if app_name is not given" do
+        stub = WebMock.stub_request(:post, "https://logplex.example.com")
+          .with(body: /t.some-token/, basic_auth: ["token", "t.some-token"])
+          .to_return(status: 204)
+        message = "I have a message for you"
+        publisher = described_class.new("https://token:t.some-token@logplex.example.com")
         publisher.publish(message)
+        expect(stub).to have_been_requested
       end
 
-      it 'uses the given app_name' do
-        Excon.stub({ method: :post, password: "t.some-token", body: /foo/ }, status: 204)
-        message = 'I have a message for you'
-        publisher = Logplex::Publisher.new('https://token:t.some-token@logplex.example.com')
-        publisher.publish(message, app_name: 'foo')
+      it "uses the given app_name" do
+        stub = WebMock.stub_request(:post, "https://logplex.example.com")
+          .with(body: /foo/, basic_auth: ["token", "t.some-token"])
+          .to_return(status: 204)
+        message = "I have a message for you"
+        publisher = described_class.new("https://token:t.some-token@logplex.example.com")
+        publisher.publish(message, app_name: "foo")
+        expect(stub).to have_been_requested
       end
 
-      it 'does the thing' do
-        Excon.stub({ method: :post, password: "t.some-token", body: /hi\="there\"/ }, status: 204)
-        message = { hi: 'there' }
-        publisher = Logplex::Publisher.new('https://token:t.some-token@logplex.example.com')
+      it "does the thing" do
+        WebMock.stub_request(:post, "https://logplex.example.com")
+          .with(body: /hi="there"/, basic_auth: ["token", "t.some-token"])
+          .to_return(status: 204)
+        message = { hi: "there" }
+        publisher = described_class.new("https://token:t.some-token@logplex.example.com")
         expect(publisher.publish(message)).to be_truthy
       end
 
-      it 'does the thing with a 202' do
-        Excon.stub({ method: :post, password: "t.some-token", body: /hi\="there\"/ }, status: 202)
-        message = { hi: 'there' }
-        publisher = Logplex::Publisher.new('https://token:t.some-token@logplex.example.com')
+      it "does the thing with a 202" do
+        WebMock.stub_request(:post, "https://logplex.example.com")
+          .with(body: /hi="there"/, basic_auth: ["token", "t.some-token"])
+          .to_return(status: 202)
+        message = { hi: "there" }
+        publisher = described_class.new("https://token:t.some-token@logplex.example.com")
         expect(publisher.publish(message)).to be_truthy
       end
 
-      it 'returns true' do
-        Excon.stub({ method: :post, password: "t.some-token" }, status: 204)
-        message = 'I have a message for you'
-        publisher = Logplex::Publisher.new('https://token:t.some-token@logplex.example.com')
+      it "returns true" do
+        WebMock.stub_request(:post, "https://logplex.example.com")
+          .with(basic_auth: ["token", "t.some-token"])
+          .to_return(status: 204)
+        message = "I have a message for you"
+        publisher = described_class.new("https://token:t.some-token@logplex.example.com")
         expect(publisher.publish(message)).to be_truthy
       end
 
-      it "returns false when there's an auth error" do
-        Excon.stub({ method: :post, password: "t.some-token" }, status: 401)
-        message = 'I have a message for you'
-        publisher = Logplex::Publisher.new('https://token:t.some-token@logplex.example.com')
-        expect(publisher.publish(message)).to be_falsey
+      it "raises ClientError when there's an auth error" do
+        WebMock.stub_request(:post, "https://logplex.example.com")
+          .with(basic_auth: ["token", "t.some-token"])
+          .to_return(status: 401)
+        message = "I have a message for you"
+        publisher = described_class.new("https://token:t.some-token@logplex.example.com")
+        expect { publisher.publish(message) }.to raise_error(Logplex::HTTP::ClientError)
       end
     end
 
-    context 'when the logplex service is acting up' do
-      it 'returns false' do
-        Excon.stub({ method: :post, password: "t.some-token" }, status: 500)
-        publisher = Logplex::Publisher.new('https://token:t.some-token@logplex.example.com')
-        expect(publisher.publish('hi')).to be_falsey
+    context "when the logplex service is acting up" do
+      it "raises ServerError on 500" do
+        WebMock.stub_request(:post, "https://logplex.example.com")
+          .with(basic_auth: ["token", "t.some-token"])
+          .to_return(status: 500)
+        publisher = described_class.new("https://token:t.some-token@logplex.example.com")
+        expect { publisher.publish("hi") }.to raise_error(Logplex::HTTP::ServerError)
+      end
+
+      it "raises ServiceUnavailableError on 503" do
+        WebMock.stub_request(:post, "https://logplex.example.com")
+          .with(basic_auth: ["token", "t.some-token"])
+          .to_return(status: 503)
+        publisher = described_class.new("https://token:t.some-token@logplex.example.com")
+        expect { publisher.publish("hi") }.to raise_error(Logplex::HTTP::ServiceUnavailableError)
+      end
+
+      it "ServiceUnavailableError is rescuable as ServerError" do
+        WebMock.stub_request(:post, "https://logplex.example.com")
+          .with(basic_auth: ["token", "t.some-token"])
+          .to_return(status: 503)
+        publisher = described_class.new("https://token:t.some-token@logplex.example.com")
+        expect { publisher.publish("hi") }.to raise_error(Logplex::HTTP::ServerError)
+      end
+
+      it "raises SeeOtherError on 303" do
+        WebMock.stub_request(:post, "https://logplex.example.com")
+          .with(basic_auth: ["token", "t.some-token"])
+          .to_return(status: 303)
+        publisher = described_class.new("https://token:t.some-token@logplex.example.com")
+        expect { publisher.publish("hi") }.to raise_error(Logplex::HTTP::SeeOtherError)
       end
     end
 
-    it "handles timeouts" do
-      expect(Excon).to receive(:post).and_raise(Timeout::Error)
-      publisher = Logplex::Publisher.new('https://token:t.some-token@logplex.example.com')
-      expect(publisher.publish('hi')).to be_falsey
+    context "when there are client errors" do
+      it "raises ClientError on 401" do
+        WebMock.stub_request(:post, "https://logplex.example.com")
+          .with(basic_auth: ["token", "t.some-token"])
+          .to_return(status: 401)
+        publisher = described_class.new("https://token:t.some-token@logplex.example.com")
+        expect { publisher.publish("hi") }.to raise_error(Logplex::HTTP::ClientError)
+      end
+    end
+
+    context "when there are network errors" do
+      it "raises TimeoutError on timeout" do
+        WebMock.stub_request(:post, "https://logplex.example.com")
+          .to_timeout
+        publisher = described_class.new("https://token:t.some-token@logplex.example.com")
+        expect { publisher.publish("hi") }.to raise_error(Logplex::HTTP::TimeoutError)
+      end
+
+      it "raises ConnectionResetError on ECONNRESET" do
+        WebMock.stub_request(:post, "https://logplex.example.com")
+          .to_raise(Errno::ECONNRESET)
+        publisher = described_class.new("https://token:t.some-token@logplex.example.com")
+        expect { publisher.publish("hi") }.to raise_error(Logplex::HTTP::ConnectionResetError)
+      end
+
+      it "raises SocketError on connection refused" do
+        WebMock.stub_request(:post, "https://logplex.example.com")
+          .to_raise(Errno::ECONNREFUSED)
+        publisher = described_class.new("https://token:t.some-token@logplex.example.com")
+        expect { publisher.publish("hi") }.to raise_error(Logplex::HTTP::SocketError)
+      end
     end
 
     it "includes the correct headers" do
-      message = 'hello-harold'
-      headers = {
-        "Content-Type" => 'application/logplex-1',
-        "Content-Length" => 79,
-        "Logplex-Msg-Count" => 1
-      }
-      expect(Excon).to receive(:post).with(any_args, hash_including(:headers => headers))
-      Logplex::Publisher.new('https://token:t.some-token@logplex.example.com').publish(message)
+      stub = WebMock.stub_request(:post, "https://logplex.example.com")
+        .with(
+          basic_auth: ["token", "t.some-token"],
+          headers: {
+            "Content-Type" => "application/logplex-1",
+            "Content-Length" => 79,
+            "Logplex-Msg-Count" => 1,
+          },
+        ).to_return(status: 204)
+      message = "hello-harold"
+      described_class.new("https://token:t.some-token@logplex.example.com").publish(message)
+      expect(stub).to have_been_requested
+    end
+
+    it "supports bearer authentication" do
+      stub = WebMock.stub_request(:post, "https://logplex-next.example.com")
+        .with(
+          headers: {
+            "Authorization" => "Bearer test-bearer-token",
+            "Content-Type" => "application/logplex-1",
+            "Content-Length" => 70,
+            "Logplex-Msg-Count" => 1,
+          },
+        ).to_return(status: 204)
+      message = "hello-bearer"
+      described_class.new("https://logplex-next.example.com", bearer_token: "test-bearer-token").publish(message)
+      expect(stub).to have_been_requested
     end
   end
 end

data/spec/spec_helper.rb

@@ -1,7 +1,11 @@
+# frozen_string_literal: true
+
+require "webmock/rspec"
+
 RSpec.configure do |config|
   config.run_all_when_everything_filtered = true
   config.filter_run :focus
-  config.order = 'random'
+  config.order = "random"
 end
 
 def restore_default_config

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: logplex
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 1.0.0
 platform: ruby
 authors:
 - Harold Giménez
 - Heroku
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-03-03 00:00:00.000000000 Z
+date: 2026-05-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: valcro
@@ -25,52 +25,28 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: excon
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-description: Publish and Consume Logplex messages
+description: Logplex client
 email:
 - harold.gimenez@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".circleci/config.yml"
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
+- ".rubocop_standardrb.yml"
+- ".rubocop_standardrb_overrides.yml"
+- CHANGELOG.md
 - CODEOWNERS
 - Gemfile
 - LICENSE
-- LICENSE.txt
 - README.md
 - Rakefile
 - lib/logplex.rb
 - lib/logplex/configuration.rb
+- lib/logplex/errors.rb
 - lib/logplex/message.rb
 - lib/logplex/publisher.rb
 - lib/logplex/version.rb
@@ -80,9 +56,13 @@ files:
 - spec/logplex/publisher_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/heroku/logplex-gem
-licenses: []
-metadata: {}
-post_install_message: 
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/heroku/logplex-gem
+  source_code_uri: https://github.com/heroku/logplex-gem
+  changelog_uri: https://github.com/heroku/logplex-gem/blob/main/CHANGELOG.md
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -90,19 +70,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 3.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.4
-signing_key: 
+rubygems_version: 3.5.22
+signing_key:
 specification_version: 4
 summary: Publish and Consume Logplex messages
-test_files:
-- spec/logplex/configuration_spec.rb
-- spec/logplex/message_spec.rb
-- spec/logplex/publisher_spec.rb
-- spec/spec_helper.rb
+test_files: []

data/.circleci/config.yml

@@ -1,15 +0,0 @@
-version: 2.1
-
-jobs:
-  test:
-    docker:
-      - image: cimg/ruby:2.7.4
-    steps:
-      - checkout
-      - run: bundle install
-      - run: bundle exec rspec
-
-workflows:
-  test:
-    jobs:
-      - test

data/LICENSE.txt

@@ -1,22 +0,0 @@
-Copyright (c) 2013 Harold Giménez
-
-MIT License
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.