sentry-gruf 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c6b92dcb88ee23c7a5ac67f55bc00b27116558e4135bc7b5958179756702f2f5
+  data.tar.gz: f3c6a5b296ec64663e3bff39ff6959a72562ef9cd9598d5052e6791fae7fa3dc
+SHA512:
+  metadata.gz: d0532e245aaf46a75e95407713625942288b3a9199883b039b7ba12a50e80f0e29c1ded8a6bbdf0bde4f7de764fcde9ea974627bb53fa4d4eff7fee711219ee9
+  data.tar.gz: 45358ef5814848e11490f2801c362786e002364c182f60353bebcf26cd898fbcec843125d0643c384af61a63414f3af72b453853a21b2961c80aaef70cb40c9f

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,29 @@
+inherit_gem:
+  rubocop-config-umbrellio: lib/rubocop.yml
+
+AllCops:
+  DisplayCopNames: true
+  TargetRubyVersion: 2.6
+
+Naming/MethodParameterName:
+  AllowedNames: ["x", "y", "z"]
+
+RSpec/EmptyLineAfterHook:
+  Enabled: false
+
+Naming/FileName:
+  Exclude:
+    - lib/sentry-gruf.rb
+
+Lint/RescueException:
+  Enabled: false
+
+Style/NilLambda:
+  Enabled: false
+
+Naming/RescuedExceptionsVariableName:
+  PreferredName: e
+
+Style/HashConversion:
+  Exclude:
+    - spec/**/*_spec.rb

data/Gemfile

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in sentry_gruf.gemspec
+gemspec
+
+gem "activesupport", "< 7.0.0"
+gem "bundler"
+gem "bundler-audit"
+gem "ci-helper"
+gem "pry"
+gem "rake"
+gem "rspec"
+gem "rspec-json_matcher"
+gem "rubocop-config-umbrellio"
+gem "simplecov"
+gem "simplecov-lcov"
+gem "yard"

data/Gemfile.lock

@@ -0,0 +1,181 @@
+PATH
+  remote: .
+  specs:
+    sentry-gruf (1.0.0)
+      gruf (~> 2.10.0)
+      sentry-ruby-core (~> 4.8.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (6.1.4.4)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    ast (2.4.2)
+    awesome_print (1.9.2)
+    bundler-audit (0.9.0.1)
+      bundler (>= 1.2.0, < 3)
+      thor (~> 1.0)
+    ci-helper (0.4.2)
+      colorize (~> 0.8)
+      dry-inflector (~> 0.2)
+      umbrellio-sequel-plugins (~> 0.4)
+    coderay (1.1.3)
+    colorize (0.8.1)
+    concurrent-ruby (1.1.9)
+    diff-lcs (1.4.4)
+    docile (1.4.0)
+    dry-inflector (0.2.1)
+    e2mmap (0.1.0)
+    faraday (1.8.0)
+      faraday-em_http (~> 1.0)
+      faraday-em_synchrony (~> 1.0)
+      faraday-excon (~> 1.1)
+      faraday-httpclient (~> 1.0.1)
+      faraday-net_http (~> 1.0)
+      faraday-net_http_persistent (~> 1.1)
+      faraday-patron (~> 1.0)
+      faraday-rack (~> 1.0)
+      multipart-post (>= 1.2, < 3)
+      ruby2_keywords (>= 0.0.4)
+    faraday-em_http (1.0.0)
+    faraday-em_synchrony (1.0.0)
+    faraday-excon (1.1.0)
+    faraday-httpclient (1.0.1)
+    faraday-net_http (1.0.1)
+    faraday-net_http_persistent (1.2.0)
+    faraday-patron (1.0.0)
+    faraday-rack (1.0.0)
+    google-protobuf (3.19.1-x86_64-linux)
+    googleapis-common-protos-types (1.3.0)
+      google-protobuf (~> 3.14)
+    grpc (1.42.0-x86_64-linux)
+      google-protobuf (~> 3.18)
+      googleapis-common-protos-types (~> 1.0)
+    grpc-tools (1.42.0)
+    gruf (2.10.0)
+      activesupport (> 4)
+      concurrent-ruby (> 1)
+      e2mmap (~> 0.1)
+      grpc (~> 1.10)
+      grpc-tools (~> 1.10)
+      json (>= 2.3)
+      slop (~> 4.6)
+      thwait (~> 0.1)
+    i18n (1.8.11)
+      concurrent-ruby (~> 1.0)
+    json (2.6.1)
+    method_source (1.0.0)
+    minitest (5.15.0)
+    multipart-post (2.1.1)
+    parallel (1.21.0)
+    parser (3.0.3.2)
+      ast (~> 2.4.1)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rack (2.2.3)
+    rainbow (3.0.0)
+    rake (13.0.6)
+    regexp_parser (2.2.0)
+    rexml (3.2.5)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-json_matcher (0.1.6)
+      awesome_print
+      json
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.3)
+    rubocop (1.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.7.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.15.0)
+      parser (>= 3.0.1.1)
+    rubocop-config-umbrellio (1.17.0.53)
+      rubocop (= 1.17.0)
+      rubocop-performance (= 1.10.0)
+      rubocop-rails (= 2.9.1)
+      rubocop-rake (= 0.5.1)
+      rubocop-rspec (= 2.2.0)
+      rubocop-sequel (= 0.2.0)
+    rubocop-performance (1.10.0)
+      rubocop (>= 0.90.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    rubocop-rails (2.9.1)
+      activesupport (>= 4.2.0)
+      rack (>= 1.1)
+      rubocop (>= 0.90.0, < 2.0)
+    rubocop-rake (0.5.1)
+      rubocop
+    rubocop-rspec (2.2.0)
+      rubocop (~> 1.0)
+      rubocop-ast (>= 1.1.0)
+    rubocop-sequel (0.2.0)
+      rubocop (~> 1.0)
+    ruby-progressbar (1.11.0)
+    ruby2_keywords (0.0.5)
+    sentry-ruby-core (4.8.1)
+      concurrent-ruby
+      faraday
+    sequel (5.51.0)
+    simplecov (0.21.2)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov-lcov (0.8.0)
+    simplecov_json_formatter (0.1.3)
+    slop (4.9.1)
+    symbiont-ruby (0.7.0)
+    thor (1.1.0)
+    thwait (0.2.0)
+      e2mmap
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    umbrellio-sequel-plugins (0.5.1.27)
+      sequel
+      symbiont-ruby
+    unicode-display_width (2.1.0)
+    webrick (1.7.0)
+    yard (0.9.27)
+      webrick (~> 1.7.0)
+    zeitwerk (2.5.1)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  activesupport (< 7.0.0)
+  bundler
+  bundler-audit
+  ci-helper
+  pry
+  rake
+  rspec
+  rspec-json_matcher
+  rubocop-config-umbrellio
+  sentry-gruf!
+  simplecov
+  simplecov-lcov
+  yard
+
+BUNDLED WITH
+   2.3.0

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 JustAnotherDude
+
+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,73 @@
+# Sentry-Gruf &middot; <a target="_blank" href="https://github.com/Cado-Labs"><img src="https://github.com/Cado-Labs/cado-labs-logos/raw/main/cado_labs_badge.svg" alt="Supported by Cado Labs" style="max-width: 100%; height: 20px"></a>
+
+Gruf both client and server interceptors, which report bugs to the Sentry.
+
+## Installation
+
+```ruby
+gem "sentry-gruf"
+```
+
+```shell
+bundle install
+# --- or ---
+gem install sentry-gruf
+```
+
+```ruby
+require "sentry-gruf"
+```
+
+## Usage
+
+After you install the gem, you need to set up the Sentry. You can read about Sentry
+configuration [here](https://docs.sentry.io/platforms/ruby/).
+
+Gem provides two interceptors for both client and server sides. All you need to add this interceptor
+at the beginning of interceptors stack.
+
+For the server side, the installation will look something like this:
+
+```ruby
+Gruf.configure do |config|
+  config.interceptors.clear # Like config.use_default_interceptors = false
+  config.interceptors.use(Sentry::Gruf::ServerInterceptor)
+  # Other interceptors go below.
+end
+```
+
+And for the client side:
+
+```ruby
+client = ::Gruf::Client.new(
+  service: Some::Service,
+  client_options: {
+    interceptors: [Sentry::Gruf::ClientInterceptor.new, OtherInterceptors.new]
+  }
+)
+```
+
+Please note that the interceptor for the client itself does not send errors to Sentry.
+It simply tags some information about the last request made through the client.
+
+### Contributing
+
+ - Fork it ( https://github.com/Cado-Labs/sentry-gruf )
+ - Create your feature branch (`git checkout -b feature/my-new-feature`)
+ - Commit your changes (`git commit -am '[feature_context] Add some feature'`)
+ - Push to the branch (`git push origin feature/my-new-feature`)
+ - Create new Pull Request
+
+## License
+
+Released under MIT License.
+
+## Supporting
+
+<a href="https://github.com/Cado-Labs">
+  <img src="https://github.com/Cado-Labs/cado-labs-resources/blob/main/cado_labs_supporting_rounded.svg" alt="Supported by Cado Labs" />
+</a>
+
+## Authors
+
+Created by [Ivan Chernov](https://github.com/AnotherRegularDude).

data/Rakefile

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require "rubocop/rake_task"
+require "yard"
+
+ROOT = Pathname.new(__FILE__).join("..")
+
+RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new(:lint)
+
+YARD::Rake::YardocTask.new(:doc) do |t|
+  t.files = Dir[ROOT.join("lib/**/*.rb")]
+  t.options = %w[--private]
+end
+
+namespace :doc do
+  desc "Check documentation coverage"
+  task coverage: :doc do
+    YARD::Registry.load
+    objs = YARD::Registry.select do |o|
+      puts "pending #{o}" if /TODO|FIXME|@pending/.match?(o.docstring)
+      o.docstring.blank?
+    end
+
+    next if objs.empty?
+    puts "No documentation found for:"
+    objs.each { |x| puts "\t#{x}" }
+
+    raise "100% document coverage required"
+  end
+end
+
+task default: %i[lint spec]

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "pry"
+require "sentry-gruf"
+
+Pry.start

data/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

data/lib/sentry/gruf/client_interceptor.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Sentry
+  module Gruf
+    # Interceptor for the Gruf client.
+    # Please note that the interceptor itself does not send errors to Sentry.
+    # It simply tags some information about the last request made through the client.
+    # Just add this interceptor to the array of used interceptors as the first element.
+    # @example Use client interceptor
+    #   client = ::Gruf::Client.new(
+    #     service: Some::Service,
+    #     client_options: {
+    #       interceptors: [Sentry::Gruf::ClientInterceptor.new, OtherInterceptors.new]
+    #     }
+    #   )
+    class ClientInterceptor < ::Gruf::Interceptors::ClientInterceptor
+      # @param request_context [Gruf::Outbound::RequestContext]
+      def call(request_context:)
+        ::Sentry.configure_scope do |scope|
+          scope.set_tags(
+            grpc_method_name: request_context.method_name,
+            grpc_route_key: request_context.route_key,
+            grpc_call_type: request_context.type,
+          )
+        end
+
+        yield
+      end
+    end
+  end
+end

data/lib/sentry/gruf/server_interceptor.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Sentry
+  module Gruf
+    # Interceptor for Gruf wrapper of gRPC server.
+    # It handles all uncaught exceptions and sent them to the Sentry.
+    # Add this interceptor to the begining of interceptors stack.
+    # @example Use server interceptor
+    #   Gruf.configure do |config|
+    #     config.interceptors.clear
+    #     config.interceptors.use(Sentry::Gruf::ServerInterceptor)
+    #   end
+    class ServerInterceptor < ::Gruf::Interceptors::ServerInterceptor
+      # Required method by Gruf interceptor specification.
+      # @see https://rubydoc.info/gems/gruf/Gruf/Interceptors/ServerInterceptor Gruf documentation
+      # @yield Perform request logic
+      def call
+        yield
+      rescue Exception => e
+        ::Sentry.configure_scope do |scope|
+          scope.set_transaction_name(request.service_key)
+          scope.set_tags(
+            grpc_method: request.method_key,
+            grpc_request_class: request.request_class.name,
+            grpc_service_key: request.service_key,
+          )
+        end
+
+        ::Sentry::Gruf.capture_exception(e)
+
+        raise
+      end
+    end
+  end
+end

data/lib/sentry/gruf/version.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Sentry
+  module Gruf
+    # Current gruf-sentry version
+    #
+    # format: 'a.b.c' with possible suffixes such as alpha
+    # * a is for major version, it is guaranteed to be changed
+    #   if back-compatibility of public API is broken
+    # * b is for minor version, it is guaranteed to be changed
+    #   on public API changes and also if private API
+    #   back-compatibility is broken
+    # * c is for incremental version, it is updated in other cases
+    # According to this, it is enough to specify '~> a.b'
+    # if private API was not used and to specify '~> a.b.c' if it was
+    VERSION = "1.0.0"
+  end
+end

data/lib/sentry/gruf.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require "gruf"
+
+require "sentry-ruby"
+require "sentry/integrable"
+
+# Namespace, used by the `sentry-ruby-core` gem.
+# @see https://rubydoc.info/gems/sentry-ruby-core Sentry documentation
+module Sentry
+  # gruf-sentry is a library that provides both client-side and server-side interceptors
+  # that send uncaught error data to Sentry.
+  module Gruf
+    extend Integrable
+    register_integration name: "gruf", version: Sentry::Gruf::VERSION
+  end
+end
+
+require_relative "gruf/version"
+require_relative "gruf/server_interceptor"
+require_relative "gruf/client_interceptor"

data/lib/sentry-gruf.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative "sentry_gruf"

data/lib/sentry_gruf.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative "sentry/gruf"

data/sentry_gruf.gemspec

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require_relative "lib/sentry/gruf/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "sentry-gruf"
+  spec.version = Sentry::Gruf::VERSION
+  spec.authors = ["JustAnotherDude"]
+  spec.email = ["vanyaz158@gmail.com"]
+
+  spec.summary = "Gruf both client and server interceptors, which report bugs to the Sentry."
+  spec.description = "Gruf both client and server interceptors, which report bugs to the Sentry."
+  spec.homepage = "https://github.com/orgs/Cado-Labs"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/orgs/Cado-Labs"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) ||
+        f.match(%r{\A(?:(?:test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "gruf", "~> 2.10.0"
+  spec.add_dependency "sentry-ruby-core", "~> 4.8.1"
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: sentry-gruf
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- JustAnotherDude
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-12-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: gruf
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.10.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.10.0
+- !ruby/object:Gem::Dependency
+  name: sentry-ruby-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.8.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.8.1
+description: Gruf both client and server interceptors, which report bugs to the Sentry.
+email:
+- vanyaz158@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/sentry-gruf.rb
+- lib/sentry/gruf.rb
+- lib/sentry/gruf/client_interceptor.rb
+- lib/sentry/gruf/server_interceptor.rb
+- lib/sentry/gruf/version.rb
+- lib/sentry_gruf.rb
+- sentry_gruf.gemspec
+homepage: https://github.com/orgs/Cado-Labs
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/orgs/Cado-Labs
+  source_code_uri: https://github.com/orgs/Cado-Labs
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.0
+signing_key:
+specification_version: 4
+summary: Gruf both client and server interceptors, which report bugs to the Sentry.
+test_files: []