erorr 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b45b6f5b43832b233cb767226101f54da953033a12c06009c9a0132de238321e
+  data.tar.gz: 455e3ba9f73509ef19d8a7b5a83e3823fe3a235ed0e9277f37afb72c95be5bbe
+SHA512:
+  metadata.gz: 2168fbc44040862030430a8e5123dfedb4442db8ed35e8a7d30b8b6775d82f9247cabbf3d83dd7bf3fd1d441d0d1a1875942b4e5e5b031b791b1dc28fad4a7f5
+  data.tar.gz: ee5fe808e8105269bdf48b56c1c6c3b5255eb167adbc7ac22ab58dba5cf8c06c21d22597e5d07c0556a873c8ddf6838022a4b1624a1471347b0a088ab98b71ee

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.3
+before_install: gem install bundler -v 1.17.3

data/Gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,59 @@
+PATH
+  remote: .
+  specs:
+    erorr (0.1.0)
+      commander (~> 4.4)
+      concurrent-ruby (~> 1.0)
+      http
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.6.0)
+      public_suffix (>= 2.0.2, < 4.0)
+    commander (4.4.7)
+      highline (~> 2.0.0)
+    concurrent-ruby (1.1.4)
+    diff-lcs (1.3)
+    domain_name (0.5.20180417)
+      unf (>= 0.0.5, < 1.0.0)
+    highline (2.0.1)
+    http (4.0.5)
+      addressable (~> 2.3)
+      http-cookie (~> 1.0)
+      http-form_data (~> 2.0)
+      http_parser.rb (~> 0.6.0)
+    http-cookie (1.0.3)
+      domain_name (~> 0.5)
+    http-form_data (2.1.1)
+    http_parser.rb (0.6.0)
+    public_suffix (3.0.3)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.5)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.17)
+  erorr!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.17.3

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Georgi Mitrev
+
+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,43 @@
+# Erorr Ruby client
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/erorr/rb`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'erorr-rb'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install erorr-rb
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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/gmitrev/erorr-rb. 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 Erorr::Rb project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/gmitrev/erorr-rb/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,14 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+task :console do
+  require 'irb'
+  require 'irb/completion'
+  require 'erorr'
+  ARGV.clear
+  IRB.start
+end

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require_relative '../lib/erorr'
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/erorr

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../lib/erorr/cli'
+
+Erorr::CLI.new.run

data/erorr.gemspec

@@ -0,0 +1,31 @@
+lib = File.expand_path 'lib', __dir__
+$LOAD_PATH.unshift lib unless $LOAD_PATH.include? lib
+
+require 'erorr/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'erorr'
+  spec.version       = Erorr::VERSION
+  spec.authors       = ['Georgi Mitrev']
+  spec.email         = ['gvmitrev@gmail.com']
+  spec.summary       = %q{Ruby library for erorr.app}
+  spec.description   = %q{A client library for erorr.app integration}
+  spec.homepage      = 'https://github.com/gmitrev/erorr-rb'
+  spec.license       = 'MIT'
+
+  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.require_paths = ['lib']
+  spec.bindir        = 'bin'
+  spec.executables   << 'erorr'
+
+  spec.add_dependency 'http'
+  spec.add_dependency 'concurrent-ruby', '~> 1.0'
+  spec.add_dependency 'commander', '~> 4.4'
+
+  spec.add_development_dependency 'bundler', '~> 1.17'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

data/lib/erorr/cli.rb

@@ -0,0 +1,89 @@
+require 'commander'
+
+module Erorr
+  class ErorrTestException < StandardError; end
+  class CLI
+    include Commander::Methods
+
+    def run
+      program :name, 'erorr'
+      program :version, Erorr::VERSION
+      program :description, 'Ruby/Rails client for erorr.app'
+
+      never_trace!
+
+      command 'setup' do |c|
+        c.syntax = 'erorr setup API-KEY'
+        c.description = 'Creates erorr.app\'s configuration file config/erorr.yml and populates it with the provided API-KEY.'
+        c.action do |args, _options|
+          api_key = args[0]
+
+          if File.exist? config_file_path
+            say_error 'Erorr config file already exists.'
+
+            exit(0)
+          end
+
+          unless api_key
+            say_error 'Please provide an API KEY.'
+
+            exit(0)
+          end
+
+          configuration_file = <<~YAML
+          ---
+          api_key: #{api_key}
+          YAML
+
+          File.open(config_file_path, 'w') { |file| file.write(configuration_file) }
+
+          say_success <<~MSG
+          erorr.app client configured successfully!
+
+          Test the integration by sending a test notification:
+
+              bundle exec erorr test-notify
+
+          If all is well, you'll see the test notification in https://erorr.app.
+          MSG
+        end
+      end
+
+      command 'test-notify' do |c|
+        c.syntax = 'erorr test-notify'
+        c.description = 'Send a test notification to erorr.app'
+        c.action do |args, _options|
+          require File.expand_path('config/environment')
+
+          Erorr.configure do |config|
+            config.enabled_for << 'development'
+          end
+
+          begin
+            raise ErorrTestException.new('Test message')
+          rescue ErorrTestException => e
+            if Erorr.notify e, location: 'erorr test-notify'
+              say_success 'Test notification sent successfully.'
+            else
+              say_error 'Test notification could not be delivered.'
+            end
+          end
+        end
+      end
+
+      run!
+    end
+
+    def config_file_path
+      File.expand_path 'config/erorr.yml'
+    end
+
+    def say_success(message)
+      say color(message, :green)
+    end
+
+    def say_error(message)
+      say color(message, :red)
+    end
+  end
+end

data/lib/erorr/config.rb

@@ -0,0 +1,50 @@
+require 'yaml'
+
+module Erorr
+  class Config
+    attr_accessor :api_key,
+                  :api_url,
+                  :env,
+                  :logger,
+                  :root,
+                  :enabled_for
+
+    def initialize
+      @env         = ENV['ERORR_ENV'] || ENV['RAILS_ENV'] || ENV['RACK_ENV']
+      @api_key     = ENV['ERORR_API_KEY']
+      @api_url     = 'https://erorr.app/api'.freeze
+      @enabled_for = %w(production staging)
+
+      @logger      = Logger.new(STDOUT)
+    end
+
+    def validate
+      unless @api_key
+        logger.warn '[erorr] API-KEY not set, skipping notifications.'
+
+        return false
+      end
+
+      unless @enabled_for.include? @env.to_s
+        logger.warn "[erorr] Reporting disabled for environment '#{@env}', skipping notification."
+
+        return false
+      end
+
+      true
+    end
+
+    def load_for(app)
+      @env  ||= Rails.env
+      @root   = app.root
+
+      config_file = @root.join 'config/erorr.yml'
+
+      file_config = YAML.safe_load File.read config_file
+
+      @api_key     = file_config['api_key'] if file_config['api_key']
+      @api_url     = file_config['api_url'] if file_config['api_url']
+      @enabled_for = file_config['enabled_for'] if file_config['enabled_for']
+    end
+  end
+end

data/lib/erorr/middleware/rack.rb

@@ -0,0 +1,31 @@
+module Erorr
+  module Middleware
+    class Rack
+      def initialize(app)
+        @app = app
+      end
+
+      def call(env)
+        begin
+          response = @app.call(env)
+        rescue Exception => exception
+          request = ActionDispatch::Request.new env
+
+          location = request.parameters.values_at('controller', 'action').join('#')
+          request_params = {
+            params: request.parameters,
+            remote_ip: request.remote_ip,
+          }
+
+          Erorr.notify exception, location: location, request: request_params
+
+          raise
+        end
+
+        response
+      ensure
+        # Erorr.clear_request_data
+      end
+    end
+  end
+end

data/lib/erorr/notification.rb

@@ -0,0 +1,54 @@
+module Erorr
+  class Notification
+    def initialize(exception, params = {})
+      @exception = exception
+      @params = params
+    end
+
+    def to_params
+      {
+        class: @exception.class.name,
+        message: @exception.message,
+        location: location,
+        backtrace: backtrace.join("\n"),
+        environment: Erorr.config.env,
+        timestamp: Time.current,
+        fingerprint: fingerprint,
+        host: Socket.gethostname,
+        pid: Process.pid,
+        request_params: @params.dig(:request, :params),
+        request_remote_ip: @params.dig(:request, :remote_ip),
+      }
+    end
+
+    private
+
+    def location
+      @params[:location] || $PROGRAM_NAME
+    end
+
+    def backtrace
+      @_backtrace ||=
+        begin
+          cleaner = ActiveSupport::BacktraceCleaner.new
+          gem_paths.each { |gem_path| cleaner.add_filter { |line| line.sub(gem_path, '') } }
+          cleaner.add_filter { |line| line.sub(Erorr.config.root.to_s, '') }
+          cleaner.add_filter { |line| line.sub('/', '') }
+
+          cleaner.clean(@exception.backtrace)
+        end
+    end
+
+    def fingerprint
+      first_backtrace_line = backtrace.find { |trace| trace !~ /pry|irb/ }
+      checksum = [first_backtrace_line, @exception.class].join('|')
+
+      Digest::SHA1.hexdigest checksum
+    end
+
+    def gem_paths
+      @gem_paths ||= Gem.path | [Gem.default_dir]
+    end
+  end
+end
+

data/lib/erorr/plugins/rails.rb

@@ -0,0 +1,15 @@
+module Erorr
+  class Railtie < Rails::Railtie
+    initializer 'erorr.use_rack_middleware' do |app|
+      if defined? ActionDispatch::DebugExceptions
+        app.middleware.insert_after ActionDispatch::DebugExceptions, Erorr::Middleware::Rack
+      else
+        app.middleware.use Erorr::Middleware::Rack
+      end
+    end
+
+    initializer 'erorr.configuration' do |app|
+      Erorr.config.load_for app
+    end
+  end
+end

data/lib/erorr/transport/http_async.rb

@@ -0,0 +1,19 @@
+require 'http'
+require 'concurrent'
+
+module Erorr
+  module Transport
+    class HTTPAsync
+      def initialize
+        @api_key = Erorr.config.api_key
+        @api_url = Erorr.config.api_url
+      end
+
+      def deliver(params)
+        # Concurrent::Promises.future do
+        HTTP.post "#{@api_url}/faults", json: {fault: params, api_key: @api_key}
+        # end.rescue { |error| log_error error}
+      end
+    end
+  end
+end

data/lib/erorr/version.rb

@@ -0,0 +1,3 @@
+module Erorr
+  VERSION = '0.1.0'
+end

data/lib/erorr.rb

@@ -0,0 +1,43 @@
+require 'erorr/config'
+require 'erorr/middleware/rack'
+require 'erorr/notification'
+require 'erorr/transport/http_async'
+require 'erorr/version'
+
+module Erorr
+  extend self
+
+  def config
+    @config ||= Config.new
+  end
+
+  def configure
+    yield config if block_given?
+  end
+
+  def logger
+    config.logger
+  end
+
+  def notify(exception, params = {})
+    return false unless config.validate
+
+    notification = Notification.new exception, params
+
+    transport.deliver notification.to_params
+
+    true
+  rescue => e
+    logger.error "[erorr] Internal error: #{e.inspect}"
+
+    false
+  end
+
+  private
+
+  def transport
+    @_transport ||= Erorr::Transport::HTTPAsync.new
+  end
+end
+
+require 'erorr/plugins/rails' if defined? Rails::Railtie

metadata

@@ -0,0 +1,148 @@
+--- !ruby/object:Gem::Specification
+name: erorr
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Georgi Mitrev
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-03-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: concurrent-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: commander
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.4'
+- !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'
+description: A client library for erorr.app integration
+email:
+- gvmitrev@gmail.com
+executables:
+- erorr
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/erorr
+- erorr.gemspec
+- lib/erorr.rb
+- lib/erorr/cli.rb
+- lib/erorr/config.rb
+- lib/erorr/middleware/rack.rb
+- lib/erorr/notification.rb
+- lib/erorr/plugins/rails.rb
+- lib/erorr/transport/http_async.rb
+- lib/erorr/version.rb
+homepage: https://github.com/gmitrev/erorr-rb
+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.6
+signing_key: 
+specification_version: 4
+summary: Ruby library for erorr.app
+test_files: []