nxt_support 0.3.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4df3922def5f3b704ce0d3f42851714bd63299f5acc4f3972049ce4015af3ad6
-  data.tar.gz: 7003d6c20622f4db12d7f039ff4a4bbaa8d114d11ad77a9b6e189db05bc01f1a
+  metadata.gz: ea9c53b87505a7b31250e050d6b4e4adb3c0504f520e5f552a484a1a450b551c
+  data.tar.gz: 97ae0e288c2ad44fc9ab163917f12d159a3ac3810c086ad7e65dcc4c5325e5c1
 SHA512:
-  metadata.gz: 3a8dc4b1e22b351d2ceee9918e299c0f17ed284956125168da3d6e932e00cff1512c7b827411aba7f32a2b3ee3c1face8a1c960f523e6d7b5dd10cc0ba1c5d52
-  data.tar.gz: 29edc7185ac167339ca1ac2a921cad40d620d1a0ee07a1037d92829a147e7d632469c4a9fec733586ca509b5e69a01e7bd83739df823e7a41fc2b5516d0b58be
+  metadata.gz: e16ed8f33f905dcd5825d2272900174eae43b96595d73f5abf8c153899d0438c88c22473eb158253f2f87d4d7934467a50e465686ad99927b33e5456c9aeb5d8
+  data.tar.gz: 8207471f7c5380671c1ff643cf32d438e30d79b8e5c674eaaa2df0688f63e224f3f4b2ba7229cc6473ec743deef0a88ca15d69374e33017f4071dcdb11a711ee

data/.circleci/config.yml

@@ -10,7 +10,9 @@ workflows:
       - build:
           matrix:
             parameters:
-              ruby-version: ["2.6.8", "2.7.4", "3.0.2"]
+              ruby-version: ["3.0.2", "3.1.2"]
+orbs:
+  ruby: circleci/ruby@2.0.0
 
 jobs:
   build:
@@ -20,39 +22,13 @@ jobs:
 
     docker:
       # specify the version you desire here
-      - image: circleci/ruby:<< parameters.ruby-version >>-node
+      - image: cimg/ruby:<< parameters.ruby-version >>
 
     working_directory: ~/repo
 
     steps:
       - checkout
-
-      - run:
-          name: Install apt dependencies
-          command: |
-            sudo apt update -q \
-            && sudo apt upgrade -q \
-            && sudo apt install -qy --no-install-recommends \
-              sqlite3 libsqlite3-dev
-
-      # Download and cache dependencies
-      - restore_cache:
-          keys:
-            - v1-dependencies-{{ checksum "Gemfile.lock" }}
-
-      - run: gem install bundler
-
-      - run:
-          name: install dependencies
-          command: |
-            bundle install --jobs=4 --retry=3 --path vendor/bundle
-
-      - save_cache:
-          paths:
-            - ./vendor/bundle
-          key: v1-dependencies-{{ checksum "Gemfile.lock" }}
-
-      # run tests!
+      - ruby/install-deps
       - run:
           name: run tests
           command: |

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+# v0.4.1 2022-11-18
+- Rename header to `Sentry-Error-Id` for consistency
+
+# v0.4.0 2022-11-14
+- Add `SentryErrorID` middleware
+- Drop support for Ruby 2.x
+
 # v0.3.0 2022-05-30
 - Support passing `with` to refinement
 - Call ambiguity handler with resolved collection rather than original collection, to avoid logging huge values

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    nxt_support (0.3.0)
+    nxt_support (0.4.1)
       activerecord
       activesupport
       nxt_init
@@ -10,24 +10,23 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activemodel (6.1.4.1)
-      activesupport (= 6.1.4.1)
-    activerecord (6.1.4.1)
-      activemodel (= 6.1.4.1)
-      activesupport (= 6.1.4.1)
-    activesupport (6.1.4.1)
+    activemodel (7.0.4)
+      activesupport (= 7.0.4)
+    activerecord (7.0.4)
+      activemodel (= 7.0.4)
+      activesupport (= 7.0.4)
+    activesupport (7.0.4)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
       tzinfo (~> 2.0)
-      zeitwerk (~> 2.3)
     coderay (1.1.3)
-    concurrent-ruby (1.1.9)
+    concurrent-ruby (1.1.10)
     diff-lcs (1.4.4)
-    i18n (1.8.10)
+    i18n (1.12.0)
       concurrent-ruby (~> 1.0)
     method_source (1.0.0)
-    minitest (5.14.4)
+    minitest (5.16.3)
     nxt_init (0.1.5)
       activesupport
     nxt_registry (0.3.10)
@@ -52,9 +51,8 @@ GEM
     rspec_junit_formatter (0.4.1)
       rspec-core (>= 2, < 4, != 2.12.0)
     sqlite3 (1.4.2)
-    tzinfo (2.0.4)
+    tzinfo (2.0.5)
       concurrent-ruby (~> 1.0)
-    zeitwerk (2.4.2)
 
 PLATFORMS
   ruby

data/README.md

@@ -24,6 +24,20 @@ Or install it yourself as:
 
 Here's an overview all the supporting features.
 
+### NxtSupport::Middleware::SentryErrorID
+A Rack middleware that adds a `Sentry-Error-ID` header to 5xx responses. 
+The header is only added if an error was reported during the request. 
+The error ID is gotten from [`sentry.error_event_id` in the Rack env](https://github.com/getsentry/sentry-ruby/pull/1849)).
+You can then visit `https://sentry.io/organizations/<org-slug>>?query=<error-event-id>`
+to go directly to the error (it may not show up immediately).
+
+Note that this middleware must be inserted before Sentry's own middleware. 
+You can run `rails middleware` to verify the order of your registered middleware.
+
+```rb
+config.middleware.insert_before 0, NxtSupport::Middleware::SentryErrorID
+```
+
 ### NxtSupport/Models
 
 Enjoy support for your models.
@@ -403,7 +417,22 @@ HomeBuilder.build(width: 20, length: 40, height: 15, roof_type: :pitched)
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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 tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To install this gem onto your local machine, run `bundle exec rake install`. 
+
+
+First, if you don't want to always log in with your RubyGems password, you can create an API key from the web, and then:
+
+```shell
+bundle config set gem.push_key rubygems
+```
+
+Add to `~/.gem/credentials` (create if it doesn't exist):
+
+```shell
+:rubygems: <your Rubygems API key>
+```
+
+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 tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 ## Contributing
 

data/lib/nxt_support/middleware/sentry_error_id.rb

@@ -0,0 +1,17 @@
+module NxtSupport
+  module Middleware
+    class SentryErrorID
+      def initialize(app)
+        @app = app
+      end
+
+      def call(env)
+        status, headers, body = @app.call(env)
+        if status >= 500 && env['sentry.error_event_id']
+          headers["Sentry-Error-Id"] = env['sentry.error_event_id']
+        end
+        [status, headers, body]
+      end
+    end
+  end
+end

data/lib/nxt_support/middleware.rb

@@ -0,0 +1 @@
+require_relative 'middleware/sentry_error_id'

data/lib/nxt_support/version.rb

@@ -1,3 +1,3 @@
 module NxtSupport
-  VERSION = "0.3.0".freeze
+  VERSION = "0.4.1".freeze
 end

data/lib/nxt_support.rb

@@ -8,6 +8,7 @@ require "nxt_support/serializers"
 require "nxt_support/util"
 require "nxt_support/services"
 require "nxt_support/refinements"
+require "nxt_support/middleware"
 
 module NxtSupport
 end

data/nxt_support.gemspec

@@ -26,6 +26,7 @@ Gem::Specification.new do |spec|
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
+  spec.required_ruby_version = '>= 3.0.0'
 
   spec.add_dependency "activerecord"
   spec.add_dependency "activesupport"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nxt_support
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Nils Sommer
@@ -11,7 +11,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-06-02 00:00:00.000000000 Z
+date: 2022-11-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -165,6 +165,8 @@ files:
 - bin/rspec
 - bin/setup
 - lib/nxt_support.rb
+- lib/nxt_support/middleware.rb
+- lib/nxt_support/middleware/sentry_error_id.rb
 - lib/nxt_support/models.rb
 - lib/nxt_support/models/assignable_values.rb
 - lib/nxt_support/models/duration_attribute_accessor.rb
@@ -206,7 +208,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="