Skip to content

Commit

Permalink
Initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
k1LoW committed May 1, 2017
0 parents commit 39a152a
Show file tree
Hide file tree
Showing 21 changed files with 614 additions and 0 deletions.
12 changes: 12 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
/.bundle/
/.yardoc
/Gemfile.lock
/_yardoc/
/coverage/
/doc/
/pkg/
/spec/reports/
/tmp/

# rspec failure tracking
.rspec_status
2 changes: 2 additions & 0 deletions .rspec
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
--format documentation
--color
11 changes: 11 additions & 0 deletions .rubocop.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
Metrics/BlockLength:
Max: 120

Metrics/LineLength:
Max: 110

Metrics/MethodLength:
Max: 12

Style/Documentation:
Enabled: false
9 changes: 9 additions & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
sudo: false
language: ruby
rvm:
- 2.4.0
- 2.3.3
before_install:
- gem install bundler -v 1.14.6
script:
- bundle exec rake
74 changes: 74 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -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 [email protected]. 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/
4 changes: 4 additions & 0 deletions Gemfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
source 'https://rubygems.org'

# Specify your gem's dependencies in faultline-rack.gemspec
gemspec
21 changes: 21 additions & 0 deletions LICENSE.txt
Original file line number Diff line number Diff line change
@@ -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.
34 changes: 34 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# Faultline::Rack

> [faultline](https://github.com/faultline/faultline) exception and error notifier for Rack application.
## Installation

Add this line to your application's Gemfile:

```ruby
gem 'faultline-rack'
```

And then execute:

$ bundle

Or install it yourself as:

$ gem install faultline-rack

## Usage

```ruby

```

## References

- [airbrake/airbrake](https://github.com/airbrake/airbrake)
- Airbrake is licensed under [The MIT License (MIT)](https://github.com/airbrake/airbrake/LICENSE.md).

## License

MIT © Ken'ichiro Oyama
8 changes: 8 additions & 0 deletions Rakefile
Original file line number Diff line number Diff line change
@@ -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)
7 changes: 7 additions & 0 deletions bin/console
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
#!/usr/bin/env ruby

require 'bundler/setup'
require 'faultline/rack'

require 'pry'
Pry.start
8 changes: 8 additions & 0 deletions bin/setup
Original file line number Diff line number Diff line change
@@ -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
38 changes: 38 additions & 0 deletions faultline-rack.gemspec
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
# coding: utf-8

lib = File.expand_path('../lib', __FILE__)
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
require 'faultline/rack/version'

Gem::Specification.new do |spec|
spec.name = 'faultline-rack'
spec.version = Faultline::Rack::VERSION
spec.authors = ['k1LoW']
spec.email = ['[email protected]']

spec.summary = 'faultline exception and error notifier for Rack application'
spec.description = 'faultline exception and error notifier for Rack application'
spec.homepage = 'https://github.com/faultline/faultline-rack'
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 'faultline', '~> 0.1'
spec.add_runtime_dependency 'airbrake', '~> 6.0'
spec.add_runtime_dependency 'rack', '~> 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 'rspec-wait', '~> 0'
spec.add_development_dependency 'webmock', '~> 2'
spec.add_development_dependency 'rack-test', '~> 0'
spec.add_development_dependency 'warden', '~> 1.2.6'
spec.add_development_dependency 'rubocop', '~> 0.47.0'
spec.add_development_dependency 'octorelease'
spec.add_development_dependency 'pry'
end
10 changes: 10 additions & 0 deletions lib/faultline/rack.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
require 'faultline'
require 'rack'
require 'airbrake'
require 'faultline/rack/version'
require 'faultline/rack/middleware'

module Faultline
module Rack
end
end
19 changes: 19 additions & 0 deletions lib/faultline/rack/middleware.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
module Faultline
module Rack
class Middleware < Airbrake::Rack::Middleware
def initialize(app, notifier_name = :default)
@app = app
@notifier = Faultline[notifier_name]

# Prevent adding same filters to the same notifier.
return if @@known_notifiers.include?(notifier_name)
@@known_notifiers << notifier_name

return unless @notifier
RACK_FILTERS.each do |filter|
@notifier.add_filter(filter.new)
end
end
end
end
end
5 changes: 5 additions & 0 deletions lib/faultline/rack/version.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
module Faultline
module Rack
VERSION = '0.1.0'.freeze
end
end
17 changes: 17 additions & 0 deletions spec/apps/rack/dummy_app.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
DummyApp = Rack::Builder.new do
use Rack::ShowExceptions
use Faultline::Rack::Middleware
use Warden::Manager

map '/' do
run(
proc do |_env|
[200, { 'Content-Type' => 'text/plain' }, ['Hello from index']]
end
)
end

map '/crash' do
run proc { |_env| raise FaultlineTestError }
end
end
Loading

0 comments on commit 39a152a

Please sign in to comment.