exception_notification_telegram 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3b12ecde6c8da572aae68af5c2a297b861e94c2bf192f7401269382e95f81403
+  data.tar.gz: 314ae01ea23de43955780c3bc3b90135a78c46d3321a35a10df9d59e06eb3fa0
+SHA512:
+  metadata.gz: ec0839595c9875e0e4e6e12f5ec02e50815440cab99b1e56a385bee8d7302c0e78667eaacbb9c731cd1c145a5e94fcffe0c1b19ac697059bf37a0774443dca7c
+  data.tar.gz: 3704ffa3c5a7003351077f6f63a874ef0946e71cc2a5705cb9d18dab3408a2b90739d87a42b548914602b3376a2722cc41fee2dc1322f00a4ecec02b3161f4a6

data/.gitignore

@@ -0,0 +1,14 @@
+.bundle
+bundle
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.log
+Gemfile.lock
+
+# rspec failure tracking
+.rspec_status

data/.travis.yml

@@ -0,0 +1,16 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.3.6
+  - 2.4.3
+  - 2.5.0
+before_install:
+  - gem uninstall -v '>= 2' -i $(rvm gemdir)@global -ax bundler || true
+  - gem install bundler -v 1.17.3
+
+install:
+  - bundle install --jobs=3 --retry=3
+
+script: bundle exec rake spec

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at zirion0@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in exception_notification_telegram.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Ignacio Aguirrezabal
+
+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,64 @@
+# Exception Notification - Telegram Notifier
+
+[![Build Status](https://travis-ci.com/iaguirre88/exception_notification_telegram.svg?branch=master)](https://travis-ci.com/iaguirre88/exception_notification_telegram)
+
+---
+
+The [Exception Notification](https://github.com/smartinez87/exception_notification) gem provides a set of notifiers for sending notifications when errors occur in a Rack/Rails application. This gem adds support for delivering notifications to Telegram.
+
+## Requirements
+* Ruby 2.3 or greater
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'exception_notification'
+gem 'exception_notification_telegram'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install exception_notification_telegram
+
+## Usage
+In order to receive exceptions in Telegram, you need to create a [Telegram Channel](https://telegram.org/tour/channels) and a [Telegram Bot](https://core.telegram.org/bots). Then, add the bot to the channel from the Telegram app.
+
+To configure it, you need to set the channel name and the bot token, like this:
+
+```ruby
+Rails.application.config.middleware.use ExceptionNotification::Rack,
+                                        email: {
+                                          email_prefix: '[PREFIX] ',
+                                          sender_address: %{"notifier" <notifier@example.com>},
+                                          exception_recipients: %w{exceptions@example.com}
+                                        },
+                                        telegram: {
+					  token: 'TELEGRAM-TOKEN',
+                                          channel: '@channel_name'
+                                        }
+```
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/iaguirre88/exception_notification_telegram. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the ExceptionNotificationTelegram project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/iaguirre88/exception_notification_telegram/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "exception_notification_telegram"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

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/example/sample_app.rb

@@ -0,0 +1,59 @@
+# -------------------------------------------
+# To run the application: ruby examples/sample_app.rb
+# -------------------------------------------
+
+require 'bundler/inline'
+
+gemfile do
+  source 'https://rubygems.org'
+
+  gem 'rails', '5.0.0'
+  gem 'exception_notification', '4.3.0'
+  gem 'exception_notification_telegram', path: '../../exception_notification_telegram'
+end
+
+class SampleApp < Rails::Application
+  config.middleware.use ExceptionNotification::Rack,
+                        telegram: {
+                          token: ENV['TOKEN'],
+                          channel: ENV['CHANNEL']
+                        }
+
+  config.secret_key_base = 'my secret key base'
+  file = File.open('sample_app.log', 'w')
+  logger = Logger.new(file)
+  Rails.logger = logger
+
+  routes.draw do
+    get 'raise_sample_exception', to: 'exceptions#raise_sample_exception'
+  end
+end
+
+require 'action_controller/railtie'
+require 'active_support'
+
+class ExceptionsController < ActionController::Base
+  include Rails.application.routes.url_helpers
+
+  def raise_sample_exception
+    puts 'Raising exception!'
+    raise 'Sample exception raised, you should receive a notification!'
+  end
+end
+
+require 'minitest/autorun'
+
+class Test < Minitest::Test
+  include Rack::Test::Methods
+
+  def test_raise_exception
+    get '/raise_sample_exception'
+    puts 'Working OK!'
+  end
+
+  private
+
+  def app
+    Rails.application
+  end
+end

data/exception_notification_telegram.gemspec

@@ -0,0 +1,31 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "exception_notification_telegram/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "exception_notification_telegram"
+  spec.version       = ExceptionNotificationTelegram::VERSION
+  spec.authors       = ["Ignacio Aguirrezabal"]
+  spec.email         = ["zirion0@gmail.com"]
+
+  spec.summary       = "Telegram notifier for exception notification gem"
+  spec.homepage      = "https://github.com/iaguirre88/exception_notification_telegram"
+  spec.license       = "MIT"
+
+  # 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('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+
+  spec.add_dependency "exception_notification", "~> 4.3"
+  spec.add_dependency "httparty", "~> 0.10.2"
+end

data/lib/exception_notification_telegram.rb

@@ -0,0 +1,114 @@
+require 'exception_notification_telegram/version'
+require 'httparty'
+require 'json'
+
+module ExceptionNotifier
+  class TelegramNotifier
+    def initialize(options)
+      @token = options.delete(:token)
+      @channel = options.delete(:channel)
+
+      raise ArgumentError, "You must provide 'token' and 'channel' option" unless @token && @channel
+    end
+
+    def call(exception, options = {})
+      @options = options
+      @exception = exception
+
+      url = "https://api.telegram.org/bot#{@token}/sendMessage"
+      HTTParty.post(url, httparty_options)
+    end
+
+    private
+
+    attr_reader :options, :exception
+
+    def httparty_options
+      payload = {
+        chat_id: @channel,
+        text: message,
+        parse_mode: 'Markdown'
+      }
+
+      httparty_options = {}
+      httparty_options[:headers] = { 'Content-Type' => 'application/json' }
+      httparty_options[:body] = payload.to_json
+      httparty_options
+    end
+
+    def message
+      text = [
+        header,
+        '',
+        "⚠️ Error 500 in #{defined?(Rails) ? Rails.env : 'N/A'} ⚠️",
+        "*#{exception.message.tr('`', "'")}*"
+      ]
+
+      text += message_request
+      text += message_backtrace
+
+      text.join("\n")
+    end
+
+    def header
+      text = ["\nApplication: *#{app_name}*"]
+
+      errors_text = errors_count > 1 ? errors_count : 'An'
+      text << "#{errors_text} *#{exception.class}* occured#{controller_text}."
+
+      text
+    end
+
+    def message_request
+      return [] unless (env = options[:env])
+
+      request = ActionDispatch::Request.new(env)
+
+      [
+        '',
+        '*Request:*',
+        '```',
+        "* url : #{request.original_url}",
+        "* http_method : #{request.method}",
+        "* ip_address : #{request.remote_ip}",
+        "* parameters : #{request.filtered_parameters}",
+        "* timestamp : #{Time.current}",
+        '```'
+      ]
+    end
+
+    def message_backtrace
+      backtrace = exception.backtrace
+
+      return [] unless backtrace
+
+      text = []
+
+      text << ''
+      text << '*Backtrace:*'
+      text << '```'
+      backtrace.first(3).each { |line| text << "* #{line}" }
+      text << '```'
+
+      text
+    end
+
+    def app_name
+      options[:app_name] || rails_app_name || 'N/A'
+    end
+
+    def errors_count
+      options[:accumulated_errors_count].to_i
+    end
+
+    def rails_app_name
+      Rails.application.class.name.underscore if defined?(Rails)
+    end
+
+    def controller_text
+      controller = options.dig(:env, 'action_controller.instance')
+
+      " in *#{controller.controller_name}##{controller.action_name}*" if controller
+    end
+  end
+end

data/lib/exception_notification_telegram/version.rb

@@ -0,0 +1,3 @@
+module ExceptionNotificationTelegram
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification
+name: exception_notification_telegram
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ignacio Aguirrezabal
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-04-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: exception_notification
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.3'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.2
+description: 
+email:
+- zirion0@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- example/sample_app.rb
+- exception_notification_telegram.gemspec
+- lib/exception_notification_telegram.rb
+- lib/exception_notification_telegram/version.rb
+homepage: https://github.com/iaguirre88/exception_notification_telegram
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.8
+signing_key: 
+specification_version: 4
+summary: Telegram notifier for exception notification gem
+test_files: []