Merge pull request #1 from qoqa/Implement-v1

First release of the stoplight-honeybager gem

.gitignore

@@ -1,56 +1,12 @@
-*.gem
-*.rbc
-/.config
+/.bundle/
+/.yardoc
+/_yardoc/
 /coverage/
-/InstalledFiles
+/doc/
 /pkg/
 /spec/reports/
-/spec/examples.txt
-/test/tmp/
-/test/version_tmp/
 /tmp/
+/.idea/
 
-# Used by dotenv library to load environment variables.
-# .env
-
-# Ignore Byebug command history file.
-.byebug_history
-
-## Specific to RubyMotion:
-.dat*
-.repl_history
-build/
-*.bridgesupport
-build-iPhoneOS/
-build-iPhoneSimulator/
-
-## Specific to RubyMotion (use of CocoaPods):
-#
-# We recommend against adding the Pods directory to your .gitignore. However
-# you should judge for yourself, the pros and cons are mentioned at:
-# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
-#
-# vendor/Pods/
-
-## Documentation cache and generated files:
-/.yardoc/
-/_yardoc/
-/doc/
-/rdoc/
-
-## Environment normalization:
-/.bundle/
-/vendor/bundle
-/lib/bundler/man/
-
-# for a library or gem, you might want to ignore these files since the code is
-# intended to run in multiple environments; otherwise, check them in:
-# Gemfile.lock
-# .ruby-version
-# .ruby-gemset
-
-# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
-.rvmrc
-
-# Used by RuboCop. Remote config files pulled in from inherit_from directive.
-# .rubocop-https?--*
+# rspec failure tracking
+.rspec_status

.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

.rubocop.yml

@@ -0,0 +1,21 @@
+require:
+  - rubocop-performance
+  - rubocop-rspec
+  - rubocop-rake
+  - rubocop-thread_safety
+
+AllCops:
+  TargetRubyVersion: 3.3.3
+  NewCops: enable
+
+Metrics/MethodLength:
+  Max: 20
+
+Metrics/BlockLength:
+  Max: 50
+
+RSpec/ExampleLength:
+  Max: 10
+
+RSpec/MultipleExpectations:
+  Max: 2

.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 3.3.3
+before_install: gem install bundler -v 2.5.23

Changelog.md

@@ -0,0 +1,10 @@
+# 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.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [1.0.0]
+
+- First release of the stoplight-honeybager gem

Gemfile

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in stoplight-honeybadger.gemspec
+gemspec
+
+gem 'honeybadger', '>= 5.0.0'
+gem 'rake', '13.2.1'
+gem 'stoplight', '>= 3.0'
+
+group :test, :development do
+  gem 'rspec', '~> 3.13.0'
+
+  # Use Rubocop as a ruby static code analyzer
+  gem 'rubocop', '~> 1.69.2', require: false
+  gem 'rubocop-performance', '~> 1.23.0', require: false
+  gem 'rubocop-rake', '~> 0.6.0', require: false
+  gem 'rubocop-rspec', '~> 3.3.0', require: false
+  gem 'rubocop-thread_safety', '~> 0.6.0', require: false
+end

Gemfile.lock

@@ -0,0 +1,89 @@
+PATH
+  remote: .
+  specs:
+    stoplight-honeybadger (1.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    connection_pool (2.4.1)
+    diff-lcs (1.5.1)
+    honeybadger (5.26.1)
+      logger
+    json (2.9.1)
+    language_server-protocol (3.17.0.3)
+    logger (1.6.4)
+    parallel (1.26.3)
+    parser (3.3.6.0)
+      ast (~> 2.4.1)
+      racc
+    racc (1.8.1)
+    rainbow (3.1.1)
+    rake (13.2.1)
+    redis (5.3.0)
+      redis-client (>= 0.22.0)
+    redis-client (0.23.0)
+      connection_pool
+    redlock (1.3.2)
+      redis (>= 3.0.0, < 6.0)
+    regexp_parser (2.10.0)
+    rspec (3.13.0)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.2)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.2)
+    rubocop (1.69.2)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.3.0.2)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 2.9.3, < 3.0)
+      rubocop-ast (>= 1.36.2, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 4.0)
+    rubocop-ast (1.37.0)
+      parser (>= 3.3.1.0)
+    rubocop-performance (1.23.0)
+      rubocop (>= 1.48.1, < 2.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
+    rubocop-rspec (3.3.0)
+      rubocop (~> 1.61)
+    rubocop-thread_safety (0.6.0)
+      rubocop (>= 1.48.1)
+    ruby-progressbar (1.13.0)
+    stoplight (4.1.0)
+      redlock (~> 1.0)
+    unicode-display_width (3.1.3)
+      unicode-emoji (~> 4.0, >= 4.0.4)
+    unicode-emoji (4.0.4)
+
+PLATFORMS
+  ruby
+  x86_64-linux
+
+DEPENDENCIES
+  honeybadger (>= 5.0.0)
+  rake (= 13.2.1)
+  rspec (~> 3.13.0)
+  rubocop (~> 1.69.2)
+  rubocop-performance (~> 1.23.0)
+  rubocop-rake (~> 0.6.0)
+  rubocop-rspec (~> 3.3.0)
+  rubocop-thread_safety (~> 0.6.0)
+  stoplight (>= 3.0)
+  stoplight-honeybadger!
+
+BUNDLED WITH
+   2.5.19

Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

bin/console

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'stoplight-honeybadger'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

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

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

lib/stoplight/honeybadger/version.rb

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

spec/spec_helper.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'stoplight/honeybadger'
+
+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