stoplight-sentry 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c1fac56cd801c5b8be0848bee64cbcbaa5976b6b3c05ab3621592130d412daa0
+  data.tar.gz: 45743013be1f9faaba15ac0370e827b14314d46a4cb1259e6f637605d00a1468
+SHA512:
+  metadata.gz: 3877d10ea9d2001f23da0712ef822744476c1d51f8feffc2673a8a2cc95133905b86ee15660bbe5c9e891fe89ab3ea13e0a280ac50bec7794f6e4abf5650d138
+  data.tar.gz: d4fdaeaddcf2a50a44d5496de33adf374f526876c93ac00b2093d9f7c572b25214ffbbe27dfe8269a653ee768131c6171b4ff5ce131e217bdfa290d7cde9befa

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Tëma Bolshakov
+
+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.

data/README.md

@@ -0,0 +1,58 @@
+# Stoplight::Sentry
+
+Sentry notifier for [Stoplight].
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'stoplight-sentry'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install stoplight-sentry
+
+## Usage
+
+Make sure you have the [sentry-ruby] gem installed before configuring Stoplight.
+
+```ruby
+require 'sentry-ruby'
+
+notifier = Stoplight::Sentry::Notifier.new(Sentry)
+# => #<Stoplight::Sentry::Notifier:...>
+Stoplight::Light.default_notifiers += [notifier]
+# => [#<Stoplight::Notifier::IO:...>, #<Stoplight::Sentry::Notifier:...>]
+```
+
+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:...>]
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/bolshakov/stoplight-sentry. 
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+[sentry-ruby]: https://github.com/getsentry/sentry-ruby
+[Stoplight]: https://github.com/bolshakov/stoplight

data/lib/stoplight/sentry/notifier.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Stoplight
+  module Sentry
+    # Usage:
+    #
+    #   notifier = Stoplight::Sentry::Notifier.new(Sentry)
+    #   Stoplight::Light.default_notifiers += [notifier]
+    #
+    class Notifier < ::Stoplight::Notifier::Base
+      # @!attribute sentry
+      #   @return [::Sentry]
+      attr_reader :sentry
+
+      # @!attribute formatter
+      #   @return [Proc]
+      attr_reader :formatter
+
+      # @!attribute options
+      #   @return [Hash]
+      attr_reader :options
+
+      # @param sentry [::Sentry]
+      # @param formatter [Proc, nil] (Stoplight::Default::FORMATTER)
+      # @param options [Hash] custom options for the +Sentry#capture_message+ method
+      def initialize(sentry, formatter = nil, **options)
+        @sentry = sentry
+        @formatter = formatter || Stoplight::Default::FORMATTER
+        @options = options
+      end
+
+      # @param light [Stoplight::Light]
+      # @param from_color [String]
+      # @param to_color [String]
+      # @param error []StandardError]
+      # @return [String]
+      def notify(light, from_color, to_color, error)
+        formatter.(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
+        end
+      end
+    end
+  end
+end

data/lib/stoplight/sentry/version.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Stoplight
+  module Sentry
+    VERSION = "0.1.0"
+    public_constant :VERSION
+  end
+end

data/lib/stoplight/sentry.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require "sentry-ruby"
+require "stoplight"
+require_relative "sentry/version"
+require_relative "sentry/notifier"
+
+module Stoplight
+end

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+# 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

@@ -0,0 +1,62 @@
+# 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

@@ -0,0 +1,7 @@
+# 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

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: stoplight-sentry
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tëma Bolshakov
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-12-24 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'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: sentry-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.7'
+  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
+description: Sentry notifier for Stoplight
+email:
+- either.free@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- 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
+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
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.7'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+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