airbrake_proxy 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 217de27ac0dbe6950a84b4d67b65c3b0ce299b38
+  data.tar.gz: 16a0c84c604efb79377bb7a74a1ee1ab1c7b17aa
+SHA512:
+  metadata.gz: a9be86792f14fe6a2b13c5c3d8466c0a0dd1ed9f8a1f157261f2e0a460084502760ad79c543607439be18080aebc83117dcdbe18d142b3f20b8b425291b47534
+  data.tar.gz: d15952b3dab5a36d14e9cd54310ba588ce036cd4113817f8b59f2f21834dd48884018265332d339885f14f6d6840fff664977fbfb9d68bf505f657c6366c1351

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1 @@
+--color --fail-fast

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+script: bundle exec rspec
+rvm:
+  - 2.3.1
+  - 2.4.0
+  - ruby-head
+matrix:
+  allow_failures:
+    - rvm: ruby-head

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+### VERSION 0.0.1
+
+* nothing

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+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.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at joel.azemar@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in airbrake_proxy.gemspec
+gemspec
+
+group :test do
+  gem 'mock_redis'
+  gem 'coveralls', require: false
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Joel AZEMAR
+
+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,47 @@
+# AirbrakeProxy
+
+[![Gem Version](https://badge.fury.io/rb/airbrake_proxy.svg)](http://badge.fury.io/rb/airbrake_proxy)
+
+[![Code Climate](https://codeclimate.com/github/FinalCAD/airbrake_proxy.png)](https://codeclimate.com/github/FinalCAD/airbrake_proxy)
+
+[![Dependency Status](https://gemnasium.com/FinalCAD/airbrake_proxy.png)](https://gemnasium.com/FinalCAD/airbrake_proxy)
+
+[![Build Status](https://travis-ci.org/FinalCAD/airbrake_proxy.png?branch=master)](https://travis-ci.org/FinalCAD/airbrake_proxy) (Travis CI)
+
+[![Coverage Status](https://coveralls.io/repos/FinalCAD/airbrake_proxy/badge.png)](https://coveralls.io/r/FinalCAD/airbrake_proxy)
+
+Basic Circuit Breaker to attempt not reach Airbrake limit for the same exception
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'airbrake_proxy'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install airbrake_proxy
+
+## Usage
+
+
+## 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/[USERNAME]/airbrake_proxy. 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](http://opensource.org/licenses/MIT).

data/Rakefile

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

data/UPGRADE.md

@@ -0,0 +1 @@
+# Upgrading

data/airbrake_proxy.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'airbrake_proxy/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "airbrake_proxy"
+  spec.version       = AirbrakeProxy::VERSION
+  spec.authors       = ["Joel AZEMAR"]
+  spec.email         = ["joel.azemar@gmail.com"]
+
+  spec.summary       = %q{Basic Circuit Breaker for Airbrake}
+  spec.description   = %q{Basic Circuit Breaker to attempt not reach Airbrake limit for the same exception}
+  spec.homepage      = "https://github.com/FinalCAD/airbrake_proxy"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "airbrake", "~> 5.6"
+  spec.add_development_dependency "activesupport", "~> 4.2"
+  spec.add_development_dependency "time_constants", "~> 0.2"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "airbrake_proxy"
+
+# 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

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/lib/airbrake_proxy/configuration.rb

@@ -0,0 +1,7 @@
+require 'securerandom'
+
+module AirbrakeProxy
+  class Configuration
+    attr_accessor :redis, :logger
+  end
+end

data/lib/airbrake_proxy/configure.rb

@@ -0,0 +1,17 @@
+require_relative 'configuration'
+
+module AirbrakeProxy
+  module Configure
+
+    attr_writer :configuration
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def configure
+      yield(configuration)
+    end
+
+  end
+end

data/lib/airbrake_proxy/redis_proxy.rb

@@ -0,0 +1,24 @@
+module RedisProxy
+  extend self
+
+  def method_missing method, *args
+    tries = 0
+    begin
+      redis.send method, *args
+    rescue Redis::TimeoutError, Redis::CannotConnectError
+      if (tries += 1) < 10
+        Rails.logger.warn '[RedisProxy] Retry a Redis call'
+        retry
+      else
+        Rails.logger.warn '[RedisProxy] Fail a Redis call after 10 tries'
+        raise
+      end
+    end
+  end
+
+  private
+
+  def redis
+    @redis ||= AirbrakeProxy.configuration.redis
+  end
+end

data/lib/airbrake_proxy/version.rb

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

data/lib/airbrake_proxy.rb

@@ -0,0 +1,88 @@
+require_relative 'airbrake_proxy/redis_proxy'
+require_relative 'airbrake_proxy/configure'
+require_relative 'airbrake_proxy/version'
+
+require 'active_support/inflector'
+require 'time_constants'
+
+require 'airbrake'
+
+module AirbrakeProxy
+  extend self
+  extend Configure
+
+  class TooManyNotification < StandardError; end
+
+  def notify(exception, params)
+    unless exception
+      logger.error("AirbrakeProxy#notify(#{exception}, #{params}) => called without exception")
+      return false
+    end
+
+    safe_notify(exception) { Airbrake.notify(exception, params) }
+    true
+  rescue TooManyNotification => e
+    logger.info("AirbrakeProxy => #{e.message}")
+  end
+
+  def keys
+    _keys.map { |key| [key, RedisProxy.get(key)] }
+  end
+
+  def clean!
+    _keys.each { |key| RedisProxy.del(key) }
+  end
+
+  def remove(key)
+    if key.match(KEY_PREFIX)
+      RedisProxy.del(key) == 1 ? true : false
+    else
+      false
+    end
+  end
+
+  protected
+
+  KEY_PREFIX = 'AIRBRAKE::'.freeze
+
+  private
+
+  def _keys
+    RedisProxy.keys.select { |key| key.match(KEY_PREFIX) }
+  end
+
+  THRESHOLD = 5
+
+  def safe_notify(exception)
+    redis_key = key(exception)
+
+    unless authorized_to_notify?(redis_key)
+      raise TooManyNotification.new("#{redis_key} was notified too many times")
+    end
+    yield
+  end
+
+  def key(exception)
+    "#{KEY_PREFIX}#{(exception&.message || exception.inspect).parameterize}"
+  end
+
+  def authorized_to_notify?(key)
+    return false if RedisProxy.get(key).to_i >= THRESHOLD # We won't hint Redis#incr(key) to not reset timelife of key
+    mark_as_notify(key) # return value is a true predicate
+  end
+
+  def mark_as_notify(key)
+    unless RedisProxy.exists(key)
+      RedisProxy.set(key, 0)
+      RedisProxy.expire(key, T_5_HOURS)
+    end
+    RedisProxy.incr(key)
+  end
+
+  private
+
+  def logger
+    @logger ||= AirbrakeProxy.configuration.logger
+  end
+
+end

metadata

@@ -0,0 +1,147 @@
+--- !ruby/object:Gem::Specification
+name: airbrake_proxy
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Joel AZEMAR
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-03-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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: airbrake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.6'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: time_constants
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+description: Basic Circuit Breaker to attempt not reach Airbrake limit for the same
+  exception
+email:
+- joel.azemar@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- UPGRADE.md
+- airbrake_proxy.gemspec
+- bin/console
+- bin/setup
+- lib/airbrake_proxy.rb
+- lib/airbrake_proxy/configuration.rb
+- lib/airbrake_proxy/configure.rb
+- lib/airbrake_proxy/redis_proxy.rb
+- lib/airbrake_proxy/version.rb
+homepage: https://github.com/FinalCAD/airbrake_proxy
+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.10
+signing_key: 
+specification_version: 4
+summary: Basic Circuit Breaker for Airbrake
+test_files: []