faultline 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f3efa54c758553253ba55d29ccda32d6f44f22c5
+  data.tar.gz: ca0394f97a2b0497bef5fbd1d4702d63dd6737f8
+SHA512:
+  metadata.gz: d9302843fb7eda0528e4597114f807da95776a00cc9cf39aab97288dd941bdd03c68cecade2e2a3ed6170322ed6cb059f485ac709fa2793139eb659416b2b51f
+  data.tar.gz: 42ccc04c6b826b2d751cc16e6e8af195c73309222ca112e932c313e52962843cae930fb9b93f2fecb4c7e51377bd8cf7e1db08030dd8796fbfc655da152c1280

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,11 @@
+Metrics/BlockLength:
+  Max: 120
+
+Metrics/LineLength:
+  Max: 110
+
+Metrics/MethodLength:
+  Max: 12
+
+Style/Documentation:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,10 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.0
+  - 2.3.3
+before_install:
+  - gem install bundler -v 1.14.4
+script:
+  - bundle exec rake
+

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 k1lowxb@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,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in faultline.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 k1LoW
+
+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,87 @@
+# faultline-ruby
+
+> [faultline](https://github.com/faultline/faultline) exception and error notifier for Ruby.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'faultline'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install faultline
+
+## Usage
+
+```ruby
+require 'faultline'
+
+# Every Faultline notifier must configure
+# 3 options: `project`, `api_key` and `endpoint`.
+# And `notifications` for notificatins (Slack, GitHub Issue)
+Faultline.configure do |c|
+  c.project = 'faultline-ruby'
+  c.api_key = 'xxxxXXXXXxXxXXxxXXXXXXXxxxxXXXXXX'
+  c.endpoint = 'https://xxxxxxxxx.execute-api.ap-northeast-1.amazonaws.com/v0'
+  c.notifications = [
+    {
+      type: 'slack',
+      endpoint: 'https://hooks.slack.com/services/XXXXXXXXXX/B2RAD9423/WC2uTs3MyGldZvieAtAA7gQq'
+      channel: '#random',
+      username: 'faultline-notify',
+      notifyInterval: 1,
+      threshold: 1,
+      timezone: 'Asia/Tokyo'
+    },
+    {
+      type: 'github',
+      userToken: 'XXXXXXXxxxxXXXXXXxxxxxXXXXXXXXXX',
+      owner: 'k1LoW',
+      repo: 'faultline',
+      labels: [
+        'faultline', 'bug'
+      ],
+      if_exist: 'reopen-and-comment',
+      notifyInterval: 1,
+      threshold: 1,
+      timezone: 'Asia/Tokyo'
+    }
+  ]
+end
+
+# Asynchronous error delivery.
+begin
+  1/0
+rescue ZeroDivisionError => ex
+  # Return value is always `nil`.
+  Faultline.notify(ex)
+end
+
+puts 'A ZeroDivisionError was sent to Faultline asynchronously!'
+
+# Synchronous error delivery.
+begin
+  1/0
+rescue ZeroDivisionError => ex
+  # Return value is a Hash.
+  response = Faultline.notify_sync(ex)
+end
+
+puts "\nAnother ZeroDivisionError was sent to Faultline, but this time synchronously."
+```
+
+## References
+
+- [airbrake/airbrake-ruby](https://github.com/airbrake/airbrake-ruby)
+    - Airbrake Ruby is licensed under [The MIT License (MIT)](https://github.com/airbrake/airbrake-ruby/LICENSE.md).
+
+## License
+
+MIT © Ken'ichiro Oyama

data/Rakefile

@@ -0,0 +1,8 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'octorelease'
+require 'rubocop/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new
+
+task default: %i(spec rubocop)

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'faultline'
+
+require 'pry'
+Pry.start

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/faultline.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'faultline/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'faultline'
+  spec.version       = Faultline::VERSION
+  spec.authors       = ['k1LoW']
+  spec.email         = ['k1lowxb@gmail.com']
+
+  spec.summary       = 'faultline exception and error notifier for Ruby'
+  spec.description   = 'faultline exception and error notifier for Ruby'
+  spec.homepage      = 'https://github.com/faultline/faultline-ruby'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |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_runtime_dependency 'airbrake-ruby', '~> 2.1'
+  spec.add_development_dependency 'bundler', '~> 1.14'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 0.47.0'
+  spec.add_development_dependency 'octorelease'
+  spec.add_development_dependency 'pry'
+end

data/lib/faultline/async_sender.rb

@@ -0,0 +1,13 @@
+module Faultline
+  class AsyncSender < Airbrake::AsyncSender
+    def initialize(config)
+      @config = config
+      @unsent = SizedQueue.new(config.queue_size)
+      @sender = SyncSender.new(config)
+      @closed = false
+      @workers = ThreadGroup.new
+      @mutex = Mutex.new
+      @pid = nil
+    end
+  end
+end

data/lib/faultline/config/validator.rb

@@ -0,0 +1,41 @@
+module Faultline
+  class Config
+    class Validator < Airbrake::Config::Validator
+      ##
+      # @return [String]
+      REQUIRED_PROJECT_MSG = ':project is required'.freeze
+
+      ##
+      # @return [String]
+      REQUIRED_API_KEY_MSG = ':api_key is required'.freeze
+
+      ##
+      # @return [String]
+      REQUIRED_ENDPOINT_MSG = ':endpoint is required'.freeze
+
+      ##
+      # @return [Boolean]
+      def valid_project?
+        valid = @config.project.is_a?(String) && !@config.project.empty?
+        @error_message = REQUIRED_PROJECT_MSG unless valid
+        valid
+      end
+
+      ##
+      # @return [Boolean]
+      def valid_api_key?
+        valid = @config.api_key.is_a?(String) && !@config.api_key.empty?
+        @error_message = REQUIRED_API_KEY_MSG unless valid
+        valid
+      end
+
+      ##
+      # @return [Boolean]
+      def valid_endpoint?
+        valid = @config.endpoint.is_a?(URI) && !@config.endpoint.to_s.empty?
+        @error_message = REQUIRED_ENDPOINT_MSG unless valid
+        valid
+      end
+    end
+  end
+end

data/lib/faultline/config.rb

@@ -0,0 +1,28 @@
+module Faultline
+  class Config < Airbrake::Config
+    attr_accessor :project
+    attr_accessor :api_key
+    attr_writer :endpoint
+    attr_accessor :notifications
+
+    def initialize(user_config = {})
+      super
+      @validator = Faultline::Config::Validator.new(self)
+    end
+
+    def endpoint
+      return nil if @endpoint.nil?
+      URI.parse(File.join(@endpoint, '/projects/', "/#{@project}/", '/errors'))
+    end
+
+    def valid?
+      return true if ignored_environment?
+      return false unless @validator.valid_project?
+      return false unless @validator.valid_api_key?
+      return false unless @validator.valid_endpoint?
+      return false unless @validator.valid_environment?
+
+      true
+    end
+  end
+end

data/lib/faultline/notice.rb

@@ -0,0 +1,47 @@
+module Faultline
+  class Notice < Airbrake::Notice
+    NOTIFIER = {
+      name: 'faultline-ruby'.freeze,
+      version: Faultline::VERSION,
+      url: 'https://github.com/faultline/faultline-ruby'.freeze
+    }.freeze
+
+    CONTEXT = {
+      os: RUBY_PLATFORM,
+      language: "#{RUBY_ENGINE}/#{RUBY_VERSION}".freeze,
+      notifier: NOTIFIER
+    }.freeze
+
+    def initialize(config, exception, params = {})
+      @config = config
+
+      @payload = {
+        errors: Airbrake::NestedException.new(exception, @config.logger).as_json,
+        context: context,
+        environment: {},
+        session: {},
+        params: params,
+        notifications: @config.notifications
+      }
+      @stash = {}
+
+      extract_custom_attributes(exception)
+
+      @truncator = Airbrake::PayloadTruncator.new(PAYLOAD_MAX_SIZE, @config.logger)
+    end
+
+    def context
+      {
+        version: @config.app_version,
+        # We ensure that root_directory is always a String, so it can always be
+        # converted to JSON in a predictable manner (when it's a Pathname and in
+        # Rails environment, it converts to unexpected JSON).
+        rootDirectory: @config.root_directory.to_s,
+        environment: @config.environment,
+
+        # Make sure we always send hostname.
+        hostname: HOSTNAME
+      }.merge(CONTEXT).delete_if { |_key, val| val.nil? || val.empty? }
+    end
+  end
+end

data/lib/faultline/notifier.rb

@@ -0,0 +1,34 @@
+module Faultline
+  class Notifier < Airbrake::Notifier
+    LOG_LABEL = '**Faultline:'.freeze
+
+    def initialize(user_config)
+      @config = (user_config.is_a?(Config) ? user_config : Config.new(user_config))
+
+      unless @config.valid?
+        raise Airbrake::Error, @config.validation_error_message
+      end
+
+      @filter_chain = Airbrake::FilterChain.new(@config)
+
+      add_filters_for_config_keys
+
+      @async_sender = AsyncSender.new(@config)
+      @sync_sender = SyncSender.new(@config)
+    end
+
+    def build_notice(exception, params = {})
+      if @async_sender.closed?
+        raise Airbrake::Error,
+              "attempted to build #{exception} with closed Airbrake instance"
+      end
+
+      if exception.is_a?(Faultline::Notice)
+        exception[:params].merge!(params)
+        exception
+      else
+        Faultline::Notice.new(@config, convert_to_exception(exception), params)
+      end
+    end
+  end
+end

data/lib/faultline/sync_sender.rb

@@ -0,0 +1,15 @@
+module Faultline
+  class SyncSender < Airbrake::SyncSender
+    def build_post_request(uri, notice)
+      Net::HTTP::Post.new(uri.request_uri).tap do |req|
+        req.body = notice.to_json
+
+        req['Content-Type'] = CONTENT_TYPE
+        req['X-Api-Key'] = @config.api_key
+        req['User-Agent'] =
+          "#{Faultline::Notice::NOTIFIER[:name]}/#{Faultline::VERSION}" \
+          " Ruby/#{RUBY_VERSION}"
+      end
+    end
+  end
+end

data/lib/faultline/version.rb

@@ -0,0 +1,3 @@
+module Faultline
+  VERSION = '0.1.0'.freeze
+end

data/lib/faultline.rb

@@ -0,0 +1,73 @@
+require 'airbrake-ruby'
+require 'faultline/version'
+require 'faultline/config'
+require 'faultline/config/validator'
+require 'faultline/notifier'
+require 'faultline/notice'
+require 'faultline/sync_sender'
+require 'faultline/async_sender'
+
+module Faultline
+  class NilNotifier
+    def notify(_exception, _params = {}); end
+
+    def notify_sync(_exception, _params); end
+
+    def add_filter(_filter = nil, &_block); end
+
+    def build_notice(_exception, _params); end
+
+    def close; end
+
+    def create_deploy(_deploy_params); end
+  end
+
+  Error = Class.new(StandardError)
+
+  LOG_LABEL = '**Faultline:'.freeze
+
+  RUBY_20 = RUBY_VERSION.start_with?('2.0')
+
+  @notifiers = Hash.new(NilNotifier.new)
+
+  class << self
+    def [](notifier_name)
+      @notifiers[notifier_name]
+    end
+
+    def configure(notifier_name = :default)
+      yield config = Faultline::Config.new
+
+      if @notifiers.key?(notifier_name)
+        raise Airbrake::Error,
+              "the '#{notifier_name}' notifier was already configured"
+      else
+        @notifiers[notifier_name] = Notifier.new(config)
+      end
+    end
+
+    def notify(exception, params = {})
+      @notifiers[:default].notify(exception, params)
+    end
+
+    def notify_sync(exception, params = {})
+      @notifiers[:default].notify_sync(exception, params)
+    end
+
+    def add_filter(filter = nil, &block)
+      @notifiers[:default].add_filter(filter, &block)
+    end
+
+    def build_notice(exception, params = {})
+      @notifiers[:default].build_notice(exception, params)
+    end
+
+    def close
+      @notifiers[:default].close
+    end
+
+    def create_deploy(deploy_params)
+      @notifiers[:default].create_deploy(deploy_params)
+    end
+  end
+end

metadata

@@ -0,0 +1,162 @@
+--- !ruby/object:Gem::Specification
+name: faultline
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- k1LoW
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-05-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: airbrake-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !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: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.47.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.47.0
+- !ruby/object:Gem::Dependency
+  name: octorelease
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: faultline exception and error notifier for Ruby
+email:
+- k1lowxb@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- faultline.gemspec
+- lib/faultline.rb
+- lib/faultline/async_sender.rb
+- lib/faultline/config.rb
+- lib/faultline/config/validator.rb
+- lib/faultline/notice.rb
+- lib/faultline/notifier.rb
+- lib/faultline/sync_sender.rb
+- lib/faultline/version.rb
+homepage: https://github.com/faultline/faultline-ruby
+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.6.12
+signing_key: 
+specification_version: 4
+summary: faultline exception and error notifier for Ruby
+test_files: []