telebugs 0.8.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ece3ebc75dc41f4d196b0c6080a970b0fd66c35b8c6ae494542a84f0989e5c4e
-  data.tar.gz: 44c0627c1e634d1e3618843d7d2c2df9344b4e9d75cccf9b9e86c345c1e84dd2
+  metadata.gz: 4ac26c242c70bb68865a22619ab11bf4a6ea87a8916419d7c23b61a8e177c6f4
+  data.tar.gz: '082d97785ef062ccea94556aeaa80a0611e89bf0c185064177f470e4ad9dd2f7'
 SHA512:
-  metadata.gz: 2fe739be52b05fa197e49f2cb700dd412d30d8cba7dc1d5d5a28bd7891cd25aba11ae33d05bf5388c5aae48b757bc5064d6c462186116dd546aa14730dde4e8f
-  data.tar.gz: 44fe0d4e8acf1adb5738b96bf1f60c7ae2fbd057326256d1ccfc55b057e0deb4e44c78f98cb4336656e549699c16f4324b03a0621f49edcc77357149d0de3923
+  metadata.gz: c1d605be920edfa515e901a9fbcdd30291722e789b88db3c9feff628ad221cff0954ab8b945dba3a3c678127678ee1e15193c2c1ca138e6c6bcc4a6beebd39a9
+  data.tar.gz: 3e36a26d7e450f141ad1f8926e1e6bf934cccce0eb8620df4c37c791a070fdb5491b56bb45d22da9e975bc665812b24cc208023abd9c5e5f3714be4b911693ec

data/README.md

@@ -1,8 +1,11 @@
 # Telebugs for Ruby
 
+[![Gem Version](https://badge.fury.io/rb/telebugs.svg)](https://badge.fury.io/rb/telebugs)
+
 Simple error monitoring for developers. Monitor production errors in real-time
 and get them reported to Telegram with Telebugs.
 
+- [Official Documentation](https://telebugs.com/docs/integrations/ruby)
 - [FAQ](https://telebugs.com/faq)
 - [Telebugs News](https://t.me/TelebugsNews)
 - [Telebugs Community](https://t.me/TelebugsCommunity)
@@ -10,12 +13,13 @@ and get them reported to Telegram with Telebugs.
 ## Introduction
 
 Any Ruby application or script can be integrated with
-[Telebugs](https://telebugs.com) using the `telebugs` gem. The gem is designed
-to be simple and easy to use. It provides a simple API to send errors to
-Telebugs, which will then be reported to your Telegram project. This guide will
-help you get started with Telebugs for Ruby.
+[Telebugs](https://telebugs.com) using the
+[`telebugs`](https://rubygems.org/gems/telebugs) gem. The gem is designed to be
+simple and easy to use. It provides a simple API to send errors to Telebugs,
+which will then be reported to your Telegram project. This guide will help you
+get started with Telebugs for Ruby.
 
-For full details, please refer to the [Telebugs documentation](https://telebugs.com/new/docs/integrations/ruby).
+For full details, please refer to the [Telebugs documentation](https://telebugs.com/docs/integrations/ruby).
 
 ## Installation
 

data/lib/telebugs/{middleware.rb → base_middleware.rb}

@@ -3,7 +3,7 @@
 module Telebugs
   # Represents a middleware that can be used to filter out errors.
   # You must inherit from this class and implement the #call method.
-  class Middleware
+  class BaseMiddleware
     DEFAULT_WEIGHT = 0
 
     def weight

data/lib/telebugs/config.rb

@@ -8,7 +8,9 @@ module Telebugs
       :middleware
 
     attr_reader :api_url,
-      :root_directory
+      :root_directory,
+      :ignore_environments,
+      :environment
 
     class << self
       attr_writer :instance
@@ -22,6 +24,18 @@ module Telebugs
       reset
     end
 
+    def reset
+      self.api_key = nil
+      self.api_url = ERROR_API_URL
+
+      @middleware = MiddlewareStack.new
+      @middleware.use Middleware::GemRootFilter.new
+
+      self.root_directory = (defined?(Bundler) && Bundler.root) || Dir.pwd
+      self.environment = ""
+      self.ignore_environments = []
+    end
+
     def api_url=(url)
       @api_url = URI(url)
     end
@@ -29,23 +43,22 @@ module Telebugs
     def root_directory=(directory)
       @root_directory = File.realpath(directory)
 
-      if @middleware
-        @middleware.delete(Middleware::RootDirectoryFilter)
-        @middleware.use Middleware::RootDirectoryFilter.new(@root_directory)
-      end
+      @middleware.delete(Middleware::RootDirectoryFilter)
+      @middleware.use Middleware::RootDirectoryFilter.new(@root_directory)
     end
 
-    def reset
-      self.api_key = nil
-      self.api_url = ERROR_API_URL
-      self.root_directory = File.realpath(
-        (defined?(Bundler) && Bundler.root) ||
-        Dir.pwd
-      )
+    def environment=(environment)
+      @environment = environment
 
-      @middleware = MiddlewareStack.new
-      @middleware.use Middleware::GemRootFilter.new
-      @middleware.use Middleware::RootDirectoryFilter.new(root_directory)
+      @middleware.delete(Middleware::IgnoreEnvironments)
+      @middleware.use Middleware::IgnoreEnvironments.new(@environment, @ignore_environments)
+    end
+
+    def ignore_environments=(ignore_environments)
+      @ignore_environments = ignore_environments
+
+      @middleware.delete(Middleware::IgnoreEnvironments)
+      @middleware.use Middleware::IgnoreEnvironments.new(@environment, @ignore_environments)
     end
   end
 end

data/lib/telebugs/middleware/gem_root_filter.rb

@@ -4,7 +4,7 @@ module Telebugs
   class Middleware
     # GemRootFilter is a middleware that filters out the root path of the gems.
     # It replaces the root path with the gem name and version.
-    class GemRootFilter < Telebugs::Middleware
+    class GemRootFilter < Telebugs::BaseMiddleware
       def initialize
         @gem_paths = Gem.path.map { |path| /\A#{Regexp.escape(path)}\/gems\// }
       end

data/lib/telebugs/middleware/ignore_environments.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Telebugs
+  class Middleware
+    class IgnoreEnvironments < Telebugs::BaseMiddleware
+      def initialize(current_env, ignore_envs)
+        @current_env = current_env
+        @ignore_envs = ignore_envs
+      end
+
+      def call(report)
+        report.ignored = @ignore_envs.include?(@current_env)
+      end
+
+      def weight
+        -1000
+      end
+    end
+  end
+end

data/lib/telebugs/middleware/root_directory_filter.rb

@@ -3,7 +3,7 @@
 module Telebugs
   class Middleware
     # Filters out the root directory from the backtrace paths.
-    class RootDirectoryFilter < Telebugs::Middleware
+    class RootDirectoryFilter < Telebugs::BaseMiddleware
       def initialize(root_directory)
         @root_directory = root_directory
       end

data/lib/telebugs/middleware_stack.rb

@@ -18,7 +18,7 @@ module Telebugs
     end
 
     def use(new_middleware)
-      @middlewares = (@middlewares << new_middleware).sort_by(&:weight).reverse
+      @middlewares = (@middlewares << new_middleware).sort_by(&:weight)
     end
 
     def delete(middleware_class)

data/lib/telebugs/reporter.rb

@@ -13,14 +13,14 @@ module Telebugs
 
     def initialize
       @sender = Sender.new
-      @middleware = Config.instance.middleware
+      @config = Config.instance
     end
 
     def report(error)
       Telebugs::Promise.new(error) do
         report = Report.new(error)
 
-        @middleware.call(report)
+        @config.middleware.call(report)
         next if report.ignored
 
         @sender.send(report)

data/lib/telebugs/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Telebugs
-  VERSION = "0.8.0"
+  VERSION = "0.10.0"
 end

data/lib/telebugs/wrapped_error.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Telebugs
   # WrappedError unwraps an error and its causes up to a certain depth.
   class WrappedError

data/lib/telebugs.rb

@@ -15,12 +15,13 @@ require_relative "telebugs/error_message"
 require_relative "telebugs/backtrace"
 require_relative "telebugs/file_cache"
 require_relative "telebugs/code_hunk"
-require_relative "telebugs/middleware"
+require_relative "telebugs/base_middleware"
 require_relative "telebugs/middleware_stack"
 require_relative "telebugs/truncator"
 
 require_relative "telebugs/middleware/gem_root_filter"
 require_relative "telebugs/middleware/root_directory_filter"
+require_relative "telebugs/middleware/ignore_environments"
 
 module Telebugs
   # The general error that this library uses when it wants to raise.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: telebugs
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.10.0
 platform: ruby
 authors:
 - Kyrylo Silin
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-06-21 00:00:00.000000000 Z
+date: 2024-07-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -39,8 +39,8 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.23'
 description: |
-  Telebugs Ruby is an SDK for Telebugs (https://telebugs.com/), a simple error monitoring tool for developers. With
-  Telebugs, you can track production errors in real-time and report them to Telegram.
+  Telebugs for Ruby is an error reporting library for Telebugs (https://telebugs.com/), a simple error monitoring tool
+  for developers. With Telebugs, you can track production errors in real-time and report them to Telegram.
 email:
 - help@telebugs.com
 executables: []
@@ -53,12 +53,13 @@ files:
 - Rakefile
 - lib/telebugs.rb
 - lib/telebugs/backtrace.rb
+- lib/telebugs/base_middleware.rb
 - lib/telebugs/code_hunk.rb
 - lib/telebugs/config.rb
 - lib/telebugs/error_message.rb
 - lib/telebugs/file_cache.rb
-- lib/telebugs/middleware.rb
 - lib/telebugs/middleware/gem_root_filter.rb
+- lib/telebugs/middleware/ignore_environments.rb
 - lib/telebugs/middleware/root_directory_filter.rb
 - lib/telebugs/middleware_stack.rb
 - lib/telebugs/promise.rb
@@ -90,8 +91,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.3
+rubygems_version: 3.5.11
 signing_key:
 specification_version: 4
-summary: Report errors to Telebugs with the offical Ruby SDK
+summary: Report errors to Telebugs with the offical library for Ruby.
 test_files: []