telebugs-rails 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 15609190b1e309d4d65732c004d56e0e7ae5d771db1493998c6344a39635e4d0
+  data.tar.gz: aafe04c4d55f77bb15a1a308a8075eca723af719ec82ed2517ac0ca73d5b4f7d
+SHA512:
+  metadata.gz: 1b0170dc19d1467e0159ffea1c2ab2db010a55096c19e9a333437df70ee8c2a6f338ca6c87fdc22cd5978edfa4196a5ba97e101c33eadded1b3f466fb99d7841
+  data.tar.gz: e5a5c3e442d8c5b1872cfa12df697bab5515ccec2937b1b1c485586255cd66699633c18cc3ff30cef2772fa9715ec0abef190915f47ebf819d7454dc57d568d8

data/.standard.yml

@@ -0,0 +1 @@
+ruby_version: 3.0

data/LICENSE.md

@@ -0,0 +1,20 @@
+# The MIT License
+
+Copyright © 2024 Telebugs
+
+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,40 @@
+# Telebugs for Rails
+
+Simple error monitoring for developers. Monitor production errors in real-time
+and get them reported to Telegram with Telebugs.
+
+- [FAQ](https://telebugs.com/faq)
+- [Telebugs News](https://t.me/TelebugsNews)
+- [Telebugs Community](https://t.me/TelebugsCommunity)
+
+## Introduction
+
+Any Ruby on Rails application can be integrated with
+[Telebugs](https://telebugs.com) using the `telebugs-rails` gem. The gem is
+designed to be simple and easy to use. It integrates the `telebugs` gem with
+Rails application, so that any unhandled error occurring in your app will be
+reported to Telebugs.
+
+## Installation
+
+For the integration details, please refer to the
+[Telebugs documentation](https://telebugs.com/new/docs/integrations/rails).
+
+## Rails support policy
+
+Telebugs for Rails supports the following Rails versions:
+
+- Rails 6.1+
+
+If you need support older Rails versions, please contact us at
+[help@telebugs.com](mailto:help@telebugs.com).
+
+## Development
+
+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 the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/kyrylo/telebugs-rails.

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "minitest/test_task"
+
+Minitest::TestTask.create
+
+task default: :test

data/lib/generators/telebugs_generator.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+class TelebugsGenerator < Rails::Generators::Base
+  def create_initializer_file
+    create_file "config/initializers/telebugs.rb", <<~RUBY
+      # frozen_string_literal: true
+      #
+      # Telebugs error monitoring.
+      #
+      # Rails integration guide:
+      # https://telebugs.com/docs/integrations/rails
+      #
+      # Telebugs library guide:
+      # https://telebugs.com/docs/integrations/ruby
+
+      Telebugs.configure do |c|
+        c.api_key = ENV["TELEBUGS_API_KEY"] || Rails.application.credentials.telebugs_api_key
+      end
+    RUBY
+  end
+end

data/lib/telebugs/rails/error_subscriber.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Telebugs::Rails
+  class ErrorSubscriber
+    def report(error, handled:, severity:, context:, source: nil)
+      Telebugs.report(error)
+    end
+  end
+end

data/lib/telebugs/rails/middleware/ignore_dev_env.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Telebugs::Rails::Middleware
+  class IgnoreDevEnv < Telebugs::Middleware
+    def initialize(rails_env)
+      @rails_env = rails_env.to_s
+    end
+
+    def call(report)
+      report.ignored = (@rails_env == "development" || @rails_env == "test")
+    end
+
+    def weight
+      -1000
+    end
+  end
+end

data/lib/telebugs/rails/railtie.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Telebugs::Rails
+  class Railtie < ::Rails::Railtie
+    initializer "telebugs.rack_middleware" do |app|
+      app.config.middleware.insert_after ActionDispatch::DebugExceptions, Telebugs::Rails::ReportErrors
+    end
+
+    # https://guides.rubyonrails.org/error_reporting.html
+    initializer "telebugs.error_subscribe" do
+      # Error reporting is only available in Rails 7.0 and later.
+      next unless ::Rails.version.to_f >= 7.0
+
+      require "telebugs/rails/error_subscriber"
+      ::Rails.error.subscribe(Telebugs::Rails::ErrorSubscriber.new)
+    end
+
+    initializer "telebugs.configure" do
+      Telebugs.configure do |c|
+        c.root_directory = Rails.root.to_s
+        c.middleware.use Middleware::IgnoreDevEnv.new(Rails.env)
+      end
+    end
+  end
+end

data/lib/telebugs/rails/report_errors.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Telebugs::Rails
+  # Telebugs middleware for Rails. Any errors raised by the upstream application
+  # will be delivered to Telebugs and re-raised.
+  class ReportErrors
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      dup.call!(env)
+    end
+
+    def call!(env)
+      response = call_app(env)
+
+      # The exceptions app should be passed as a parameter on initialization of
+      # ShowExceptions. Every time there is an exception, ShowExceptions will
+      # store the exception in env["action_dispatch.exception"], rewrite the
+      # PATH_INFO to the exception status code, and call the Rack app.
+      # See: https://api.rubyonrails.org/classes/ActionDispatch/ShowExceptions.html
+      return response unless env["action_dispatch.exception"]
+
+      Telebugs.report(env["action_dispatch.exception"])
+
+      response
+    end
+
+    private
+
+    def call_app(env)
+      @app.call(env)
+    rescue Exception => e # rubocop:disable Lint/RescueException
+      Telebugs.report(e)
+      raise
+    end
+  end
+end

data/lib/telebugs/rails/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Telebugs
+  module Rails
+    VERSION = "0.1.0"
+  end
+end

data/lib/telebugs/rails.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require "rails"
+require "telebugs"
+
+require_relative "rails/version"
+require_relative "rails/railtie"
+
+require_relative "rails/middleware/ignore_dev_env"
+require_relative "rails/report_errors"
+
+module Telebugs
+  module Rails
+    class Error < StandardError; end
+    # Your code goes here...
+  end
+end

data/sig/telebugs/rails.rbs

@@ -0,0 +1,6 @@
+module Telebugs
+  module Rails
+    VERSION: String
+    # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+  end
+end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: telebugs-rails
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Kyrylo Silin
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-06-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: telebugs
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.1'
+description: |
+  Telebugs Rails is an integration for Rails applications with Telebugs.
+  Telebugs is 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: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".standard.yml"
+- LICENSE.md
+- README.md
+- Rakefile
+- lib/generators/telebugs_generator.rb
+- lib/telebugs/rails.rb
+- lib/telebugs/rails/error_subscriber.rb
+- lib/telebugs/rails/middleware/ignore_dev_env.rb
+- lib/telebugs/rails/railtie.rb
+- lib/telebugs/rails/report_errors.rb
+- lib/telebugs/rails/version.rb
+- sig/telebugs/rails.rbs
+homepage: https://telebugs.com
+licenses: []
+metadata:
+  homepage_uri: https://telebugs.com
+  source_code_uri: https://github.com/telebugs/telebugs-rails
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.3
+signing_key:
+specification_version: 4
+summary: Report errors to Telebugs from Rails applications.
+test_files: []