stoplight-honeybadger 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 07ee52ce63031df39696cb4cc923766a2b9c072cc61d5bc2fefdc3aff40a6b17
+  data.tar.gz: 98b975287fe7d88deb2ed553f106ed83e1bcde93ac2cd82f9df1c00da4457e6e
+SHA512:
+  metadata.gz: fa9a5f936382c9f43fee95a35d7a5913679f3ff23c26bc1d767912e69e78618e40a66a0793f044403970d7bfdbffbe884e5c2f594e875f0c04399117210ab479
+  data.tar.gz: 91132d151c0c8a3d5af5a9c7e8ebc0e04e1d7eb10ae3a0c309c7c1e797c7e760ac3b9ef8797817a0d78ce6f4a248cd5aad3cc07e9dc3ca860e355ea478851955

data/LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 QoQa
+
+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,56 @@
+# Stoplight::Honeybadger
+Honeybadger notifier for Stoplight 
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```
+gem 'stoplight-honeybadger'
+```
+
+And then execute:
+```
+$ bundle install
+```
+
+Or install it yourself as:
+```
+$ gem install stoplight-honeybadger
+```
+
+## Usage
+
+Make sure you have the [honeybadger gem](https://github.com/honeybadger-io/honeybadger-ruby) installed before configuring Stoplight.
+
+```ruby
+require 'honeybadger'
+
+notifier = Stoplight::Honeybadger::Notifier.new(Honeybadger)
+# => #<Stoplight::Honeybadger::Notifier:...>
+Stoplight::Light.default_notifiers += [notifier]
+# => [#<Stoplight::Notifier::IO:...>, #<Stoplight::Honeybadger::Notifier:...>]
+```
+
+You can configure notifier to add custom option to the notification:
+
+```
+notifier = Stoplight::Honeybadger::Notifier.new(Honeybadger, tags: {foo: 'bar'})
+# => #<Stoplight::Honeybadger::Notifier:...>
+Stoplight::Light.default_notifiers += [notifier]
+# => [#<Stoplight::Notifier::IO:...>, #<Stoplight::Honeybadger::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.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/qoqa/stoplight-honeybadger
+
+## License
+
+The gem is available as open source under the terms of the MIT License.

data/lib/stoplight/honeybadger/notifier.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module Stoplight
+  module Honeybadger
+    # Usage:
+    #
+    #   notifier = Stoplight::Honeybadger::Notifier.new('api key')
+    #   Stoplight::Light.default_notifiers += [notifier]
+    #
+    class Notifier < ::Stoplight::Notifier::Base
+      DEFAULT_OPTIONS = {
+        parameters: {},
+        session: {},
+        context: {}
+      }.freeze
+
+      # @return [String]
+      attr_reader :api_key
+      # @return [Proc]
+      attr_reader :formatter
+      # @return [Hash{Symbol => Object}]
+      attr_reader :options
+
+      # rubocop:disable Lint/MissingSuper
+      # @param api_key [String]
+      # @param formatter [Proc, nil]
+      # @param options [Hash{Symbol => Object}]
+      # @option options [Hash] :parameters
+      # @option options [Hash] :session
+      # @option options [Hash] :context
+      def initialize(api_key, formatter = nil, options = {})
+        @api_key = api_key
+        @formatter = formatter || Stoplight::Default::FORMATTER
+        @options = DEFAULT_OPTIONS.merge(options)
+      end
+      # rubocop:enable Lint/MissingSuper
+
+      # @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)
+        message = formatter.call(light, from_color, to_color, error)
+        ::Honeybadger.notify(options.merge(
+                               api_key: api_key,
+                               error_message: message,
+                               backtrace: error&.backtrace
+                             ))
+        message
+      end
+    end
+  end
+end

data/lib/stoplight/honeybadger/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Stoplight
+  module Honeybadger
+    VERSION = '1.0.0'
+  end
+end

data/lib/stoplight/honeybadger.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'honeybadger'
+require 'stoplight'
+require_relative 'honeybadger/version'
+require_relative 'honeybadger/notifier'
+
+# Stoplight module
+module Stoplight
+end

metadata

@@ -0,0 +1,49 @@
+--- !ruby/object:Gem::Specification
+name: stoplight-honeybadger
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- QoQa
+bindir: bin
+cert_chain: []
+date: 2024-12-30 00:00:00.000000000 Z
+dependencies: []
+description: Honeybadger notifier for Stoplight
+email:
+- dev@qoqa.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- lib/stoplight/honeybadger.rb
+- lib/stoplight/honeybadger/notifier.rb
+- lib/stoplight/honeybadger/version.rb
+homepage: https://github.com/qoqa/stoplight-honeybadger
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/qoqa/stoplight-honeybadger
+  source_code_uri: https://github.com/qoqa/stoplight-honeybadger
+  changelog_uri: https://github.com/qoqa/stoplight-honeybadger/releases
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.3.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.2
+specification_version: 4
+summary: Honeybadger notifier for Stoplight
+test_files: []