telebugs 0.7.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fcdd2da95dea7cff1e8e90761d19258da064ca26c88feacf218107878e7867c0
-  data.tar.gz: a094bb5882fb527d00be117a18fe9da8543c6e0e85aed80daf1f554c4dfb1a04
+  metadata.gz: aa8891b6ca7665271200ac99930e2e44eaa4a23225996650b794ab3561e2d9c0
+  data.tar.gz: a1a4ff3942f1a68b544040589653ee7355e0daea98d23b114dbaea2de7150b04
 SHA512:
-  metadata.gz: ea4f4760d4de5182bbce41cb5f90a1f0171281c1d341cf18f47c8a8cd2e9e4fb20eea712f7acf1c145f63a01109a0861ad601ea88a6ba18e06d7fad6dd8a7c5c
-  data.tar.gz: 02706c551ab96f3774e26875dde6a807c9a917bdbb2aa4613aa4427c1af4963dcc28c1e158be75bcd45564027e46dc972a01271267676a9a4d29c981a9e80f38
+  metadata.gz: e65e6264b1bd55c51c81d43d64cb684d7ded53cb97e607a73820bf129d99f6c6c04cbb089e32af538a82490d5387c6bc32650b259b52dbe4abd79324ab9bbac0
+  data.tar.gz: 3cdf9ef3c6f5a3d0851124ee546fc3507648ca453684463e4d71c8c375de042b28660b645c5097dc2034ed82238a3bc3019367230a440b26f0602f8d7b0b8f8a

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/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/ignore_environments.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Telebugs
+  class Middleware
+    class IgnoreEnvironments < Telebugs::Middleware
+      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_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/report.rb

@@ -19,6 +19,11 @@ module Telebugs
     # The maximum size of hashes, arrays and strings in the report.
     DATA_MAX_SIZE = 10000
 
+    REPORTER = {
+      library: {name: "telebugs", version: Telebugs::VERSION}.freeze,
+      platform: {name: "Ruby", version: RUBY_VERSION}.freeze
+    }.freeze
+
     attr_reader :data
     attr_accessor :ignored
 
@@ -27,7 +32,8 @@ module Telebugs
       @truncator = Truncator.new(DATA_MAX_SIZE)
 
       @data = {
-        errors: errors_as_json(error)
+        errors: errors_as_json(error),
+        reporters: [REPORTER]
       }
     end
 

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.7.0"
+  VERSION = "0.9.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

@@ -21,6 +21,7 @@ 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.7.0
+  version: 0.9.0
 platform: ruby
 authors:
 - Kyrylo Silin
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-06-20 00:00:00.000000000 Z
+date: 2024-07-30 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: []
@@ -59,6 +59,7 @@ files:
 - 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: []