stoplight-sentry 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c1fac56cd801c5b8be0848bee64cbcbaa5976b6b3c05ab3621592130d412daa0
-  data.tar.gz: 45743013be1f9faaba15ac0370e827b14314d46a4cb1259e6f637605d00a1468
+  metadata.gz: e87b4206c4ce27888e5a3cdd74d93bf69fef50ecc1d5ddac52c517e46afe3324
+  data.tar.gz: d139bcb9189c6f4283586f2e4f9d0a1505f193d2c39f755027c18950ad917dc4
 SHA512:
-  metadata.gz: 3877d10ea9d2001f23da0712ef822744476c1d51f8feffc2673a8a2cc95133905b86ee15660bbe5c9e891fe89ab3ea13e0a280ac50bec7794f6e4abf5650d138
-  data.tar.gz: d4fdaeaddcf2a50a44d5496de33adf374f526876c93ac00b2093d9f7c572b25214ffbbe27dfe8269a653ee768131c6171b4ff5ce131e217bdfa290d7cde9befa
+  metadata.gz: 2b07f61e009db1a58ec8b436d907128cf5bc3672376a54cf28d9db00be3dcc06a7210069dcded65b5ac213be58e2bece90ca6c1c6a96b925bba1059b0e1ca8a8
+  data.tar.gz: 67072c6221ddb5c4fdff6d5e40e7025fa1d57150991d8a57e229614e81481d7df54cee5ac76c741f205874b46310ccaa35ff35b76b0f541a2470068d3b34d255

data/README.md

@@ -26,18 +26,20 @@ Make sure you have the [sentry-ruby] gem installed before configuring Stoplight.
 require 'sentry-ruby'
 
 notifier = Stoplight::Sentry::Notifier.new(Sentry)
-# => #<Stoplight::Sentry::Notifier:...>
-Stoplight::Light.default_notifiers += [notifier]
-# => [#<Stoplight::Notifier::IO:...>, #<Stoplight::Sentry::Notifier:...>]
+
+Stoplight.configure do |config|
+  config.notifiers += [notifier]
+end
 ```
 
 you can configure notifier to add custom option to the notification:
 
 ```ruby
 notifier = Stoplight::Sentry::Notifier.new(Sentry, tags: {foo: 'bar'})
-# => #<Stoplight::Sentry::Notifier:...>
-Stoplight::Light.default_notifiers += [notifier]
-# => [#<Stoplight::Notifier::IO:...>, #<Stoplight::Sentry::Notifier:...>]
+
+Stoplight.configure do |config|
+  config.notifiers += [notifier]
+end
 ```
 
 ## Development

data/lib/stoplight/sentry/notifier.rb

@@ -20,12 +20,19 @@ module Stoplight
       #   @return [Hash]
       attr_reader :options
 
+      DEFAULT_FORMATTER = lambda do |light, from_color, to_color, error|
+        words = ["Switching", light.name, "from", from_color, "to", to_color]
+        words += ["because", error.class, error.message] if error
+        words.join(" ")
+      end
+      private_constant :DEFAULT_FORMATTER
+
       # @param sentry [::Sentry]
-      # @param formatter [Proc, nil] (Stoplight::Default::FORMATTER)
+      # @param formatter [Proc, nil]
       # @param options [Hash] custom options for the +Sentry#capture_message+ method
       def initialize(sentry, formatter = nil, **options)
         @sentry = sentry
-        @formatter = formatter || Stoplight::Default::FORMATTER
+        @formatter = formatter || DEFAULT_FORMATTER
         @options = options
       end
 
@@ -35,7 +42,7 @@ module Stoplight
       # @param error []StandardError]
       # @return [String]
       def notify(light, from_color, to_color, error)
-        formatter.(light, from_color, to_color, error).tap do |message|
+        formatter.call(light, from_color, to_color, error).tap do |message|
           options.merge(backtrace: error&.backtrace).then do |sentry_options|
             sentry.capture_message(message, **sentry_options)
           end

data/lib/stoplight/sentry/version.rb

@@ -2,7 +2,7 @@
 
 module Stoplight
   module Sentry
-    VERSION = "0.1.0"
+    VERSION = "1.0.0"
     public_constant :VERSION
   end
 end

metadata

@@ -1,57 +1,42 @@
 --- !ruby/object:Gem::Specification
 name: stoplight-sentry
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Tëma Bolshakov
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-12-24 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: stoplight
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '5'
 - !ruby/object:Gem::Dependency
   name: sentry-ruby
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '5.7'
+        version: '5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '5.7'
-- !ruby/object:Gem::Dependency
-  name: ruby_coding_standard
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 0.4.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 0.4.0
+        version: '5'
 description: Sentry notifier for Stoplight
 email:
 - either.free@gmail.com
@@ -64,9 +49,6 @@ files:
 - lib/stoplight/sentry.rb
 - lib/stoplight/sentry/notifier.rb
 - lib/stoplight/sentry/version.rb
-- spec/spec_helper.rb
-- spec/stoplight/sentry/notifier_spec.rb
-- spec/stoplight/sentry_spec.rb
 homepage: https://github.com/bolshakov/stoplight-sentry
 licenses:
 - MIT
@@ -74,7 +56,6 @@ metadata:
   homepage_uri: https://github.com/bolshakov/stoplight-sentry
   source_code_uri: https://github.com/bolshakov/stoplight-sentry
   changelog_uri: https://github.com/bolshakov/stoplight-sentry/releases
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -82,18 +63,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.7'
+      version: '3.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Sentry notifier for Stoplight
-test_files:
-- spec/spec_helper.rb
-- spec/stoplight/sentry/notifier_spec.rb
-- spec/stoplight/sentry_spec.rb
+test_files: []

data/spec/spec_helper.rb

@@ -1,15 +0,0 @@
-# frozen_string_literal: true
-
-require "stoplight/sentry"
-
-RSpec.configure do |config|
-  # Enable flags like --only-failures and --next-failure
-  config.example_status_persistence_file_path = ".rspec_status"
-
-  # Disable RSpec exposing methods globally on `Module` and `main`
-  config.disable_monkey_patching!
-
-  config.expect_with :rspec do |c|
-    c.syntax = :expect
-  end
-end

data/spec/stoplight/sentry/notifier_spec.rb

@@ -1,62 +0,0 @@
-# frozen_string_literal: true
-
-require "securerandom"
-
-RSpec.describe Stoplight::Sentry::Notifier do
-  subject(:notify) { notifier.notify(light, from_color, to_color, error) }
-
-  let(:notifier) { described_class.new(sentry, formatter, **options) }
-  let(:sentry) { class_double(Sentry) }
-  let(:light) { instance_double(Stoplight::Light, name: "light-name") }
-  let(:from_color) { Stoplight::Color::GREEN }
-  let(:to_color) { Stoplight::Color::RED }
-  let(:error) { StandardError.new("something went wrong").tap { _1.set_backtrace(backtrace) } }
-  let(:backtrace) { ["foo", "bar"] }
-  let(:options) { {} }
-
-  context "when formatter is provided" do
-    let(:formatter) { instance_double(Proc) }
-    let(:message) { SecureRandom.uuid }
-
-    before do
-      expect(formatter).to receive(:call).with(light, from_color, to_color, error) { message }
-    end
-
-    it "notifies sentry" do
-      expect(sentry).to receive(:capture_message).with(message, backtrace: backtrace)
-
-      expect(notify).to eq(message)
-    end
-
-    context "with custom options" do
-      let(:options) { { tags: { foo: "bar" }} }
-
-      it "notifies sentry" do
-        expect(sentry).to receive(:capture_message).with(message, backtrace: backtrace, tags: { foo: "bar" })
-
-        expect(notify).to eq(message)
-      end
-    end
-  end
-
-  context "when formatter is not provided" do
-    let(:formatter) { nil }
-    let(:message) { "Switching light-name from green to red because StandardError something went wrong" }
-
-    it "notifies sentry" do
-      expect(sentry).to receive(:capture_message).with(message, backtrace: backtrace)
-
-      notify
-    end
-
-    context "with custom options" do
-      let(:options) { { tags: { foo: "bar" }} }
-
-      it "notifies sentry" do
-        expect(sentry).to receive(:capture_message).with(message, backtrace: backtrace, tags: { foo: "bar" })
-
-        expect(notify).to eq(message)
-      end
-    end
-  end
-end

data/spec/stoplight/sentry_spec.rb

@@ -1,7 +0,0 @@
-# frozen_string_literal: true
-
-RSpec.describe Stoplight::Sentry do
-  it "has a version number" do
-    expect(Stoplight::Sentry::VERSION).not_to be_nil
-  end
-end