jt-rails-toolbox 1.2.4 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: eff5152abcc01c7e0debdc49f6c2f3457f5f1a49
-  data.tar.gz: d8e377177778f27d9368bcdccfdc408bdc880efa
+  metadata.gz: a45f1dfd078655bd41b9d50cd255a8f555634517
+  data.tar.gz: 2cd6dd09ad2b11d32028ff2401015ea4443b0ffc
 SHA512:
-  metadata.gz: 713555745af64e4299e7ef09c54f7e23badd6f6f47b1711564de35eec1e9ff49bd880c3253cde8281c710192050c5dd6f23d779f59aebb367a9546809483c831
-  data.tar.gz: 73daaf71a69f27ef11037b481aa9bdb4bbc5d4761616783ff978bd486966e970d453f68fa1bad4ec56e9501de4b7cb50d63ecdc2be00345ce9ee3e45b4194883
+  metadata.gz: 5723b4572f6d42a438399a7cce0d12190d813cd28a02dc2ed2dee64c65dd3e3c1bd7430571b5382633d5f8b7d5782177befccbe99b22b5a685b39fb18f641487
+  data.tar.gz: 54fbfdb5fab2546e7454c9cc5e0f7ed2d6b8df40b0c309b884f0ba2b806c0499d967ad3b30242bd9a507162b55f9f911b66944d37d4ea7ff5115041b0c62adc8

data/README.md

@@ -21,6 +21,12 @@ A simple configuration of `jt-toolbox.yml` file:
 ```yml
  production:
    exception:
+     airbrake:
+       project_host: "https://errbit.example.com"
+       project_id: 1
+       project_key: 12345678901234567890
+     slack:
+       webhook_url: https://hooks.slack.com/services/XXXXXXXX
      email_prefix: '[ERROR]'
      sender_address: "Your website <error@example.com>"
      exception_recipients:
@@ -48,7 +54,11 @@ A simple configuration of `jt-toolbox.yml` file:
 
 ## What's in it?
 
-- [Exception Notification](https://github.com/smartinez87/exception_notification), send email notifications when errors occur
+- [http_accept_language](https://github.com/iain/http_accept_language), helps you detect the users preferred language, as sent by the "Accept-Language" HTTP header
+- [dotenv](https://github.com/bkeepers/dotenv), load environment variables from .env file
+- [Exception Notification](https://github.com/smartinez87/exception_notification), 
+send notifications when errors occur (email, slack)
+- [Airbrake](https://github.com/airbrake/airbrake), send notifications when errors occur to [Airbrake](https://airbrake.io/) or [Errbit](http://errbit.com/)
 - [paperclip](https://github.com/thoughtbot/paperclip), manage file upload
 - [quiet_assets](https://github.com/evrone/quiet_assets), silence assets in log
 - [sidekiq](https://github.com/mperham/sidekiq), manage background jobs
@@ -59,6 +69,21 @@ A simple configuration of `jt-toolbox.yml` file:
 - [jt-rails-tokenizable](https://github.com/jonathantribouharet/jt-rails-tokenizable) Generate tokens for ActiveRecord models
 - simplified configuration of hostnames and `ActionMailer` with a YAML file
 
+### http_accept_language
+
+To install `http_accept_language` you just have to add a line in your `ApplicationController`
+
+```ruby
+class ApplicationController < ActionController::Base
+  include HttpAcceptLanguage::AutoLocale
+
+end
+```
+
+### Dotenv
+
+It's a good practice to not include credentials for third party services in your code. You can defined it in a `.env` file which I recommend to not include in your git repository.
+
 ### Exception Notification
 
 If `exception` is not set in `jt-toolbox.yml` file, Exception Notification is disabled.
@@ -67,6 +92,10 @@ In addition to the default ignored exceptions, the following exceptions are also
 - `ActionController::InvalidCrossOriginRequest`
 - `ActionController::InvalidAuthenticityToken`
 
+### Airbrake
+
+If `airbrake` is not set in `jt-toolbox.yml` file, Airbrake is disabled.
+
 ### Paperclip
 
 - `convert_options` is set to `-strip`, which means all metadata of images are removed, this is used for reduced the weight of images.

data/jt-rails-toolbox.gemspec

@@ -3,7 +3,7 @@ Gem::Specification.new do |s|
 	s.summary = "Common libs used for Ruby On Rails development."
 	s.description = "JTRailsToolbox contains a list of common libs used for Ruby On Rails development."
 	s.homepage = 'https://github.com/jonathantribouharet/jt-rails-toolbox'
-	s.version = '1.2.4'
+	s.version = '1.3.0'
 	s.files = `git ls-files`.split("\n")
 	s.require_paths = ['lib']
 	s.authors = ['Jonathan TRIBOUHARET']
@@ -11,7 +11,12 @@ Gem::Specification.new do |s|
 	s.license = 'MIT'
 	s.platform = Gem::Platform::RUBY
 
+	s.add_dependency('dotenv-rails')
+	s.add_dependency('http_accept_language')
+
 	s.add_dependency('exception_notification', '~> 4.1')
+	s.add_dependency('airbrake', '~> 5.0')
+
 	s.add_dependency('paperclip', '~> 4.2')
 	s.add_dependency('quiet_assets', '~> 1.1')
 	s.add_dependency('validates_email_format_of', '~> 1.6')

data/lib/generators/jt/toolbox/templates/jt-toolbox.yml

@@ -12,10 +12,16 @@
 #
 # production:
 #   exception:
+#     airbrake:
+#       project_host: "https://errbit.example.com"
+#       project_id: 1
+#       project_key: 12345678901234567890
+#     slack:
+#       webhook_url: https://hooks.slack.com/services/XXXXXXXX
 #     email_prefix: '[ERROR]'
 #     sender_address: "Your website <error@example.com>"
 #     exception_recipients:
-#      - my_email_for_errors@example.com
+#       - my_email_for_errors@example.com
 #   files:
 #     folder: upload
 #   mail:

data/lib/jt-rails-toolbox.rb

@@ -1,4 +1,5 @@
-require 'exception_notification'
+require 'dotenv/rails-now'
+require 'http_accept_language'
 require 'paperclip'
 require 'sidekiq'
 require 'validates_email_format_of'
@@ -7,18 +8,19 @@ require 'jt-rails-meta'
 require 'jt-rails-generator-user'
 require 'jt-rails-tokenizable'
 
+require 'yaml'
+
 if Rails.env.development?
 	require 'quiet_assets'
 end
 
-require 'exception_notification/rails'
-require 'exception_notification/sidekiq'
-
-require 'yaml'
+# Don't move this require
+require 'airbrake'
+require 'airbrake/sidekiq/error_handler'
 
 module JTRailsToolbox
 
-	class Railtie < ::Rails::Railtie
+	class Engine < ::Rails::Engine
 		
 		initializer "jt-rails-toolbox" do |app|
 			@params = {}
@@ -76,14 +78,58 @@ module JTRailsToolbox
 		def configure_exception_notification(app)
 			return if @params['exception'].nil?
 
+			if @params['exception']['airbrake']
+
+				Airbrake.configure do |c|
+					if @params['exception']['airbrake']['host']
+						c.host = @params['exception']['airbrake']['host']
+					end
+
+					c.project_id = @params['exception']['airbrake']['project_id']
+					c.project_key = @params['exception']['airbrake']['project_key']
+
+					c.environment = Rails.env
+
+					if @params['exception']['airbrake']['ignore_environments']
+						c.ignore_environments = @params['exception']['airbrake']['ignore_environments']
+					else
+						c.ignore_environments = %w(development test)
+					end
+				end
+
+				# Default ignored exceptions in Exception Notification
+				exceptions_to_ignore = %w{ActiveRecord::RecordNotFound Mongoid::Errors::DocumentNotFound AbstractController::ActionNotFound ActionController::RoutingError ActionController::UnknownFormat ActionController::UrlGenerationError}
+
+				# Additionnal exceptions to ignore
+				exceptions_to_ignore.push *%w{ActionController::InvalidCrossOriginRequest ActionController::InvalidAuthenticityToken}
+
+				Airbrake.add_filter do |notice|
+					if notice[:errors].any? { |error| exceptions_to_ignore.include?(error[:type]) }
+						notice.ignore!
+					end
+				end
+			end
+
+			require 'exception_notification'
+			require 'exception_notification/rails'
+			require 'exception_notification/sidekiq'
+
 			ExceptionNotification.configure do |config|
-				config.ignored_exceptions += ['ActionController::InvalidCrossOriginRequest', 'ActionController::InvalidAuthenticityToken']
+				config.ignored_exceptions += %w{ActionController::InvalidCrossOriginRequest ActionController::InvalidAuthenticityToken}
 
-				config.add_notifier :email, {
-					email_prefix: @params['exception']['email_prefix'],
-					sender_address: @params['exception']['sender_address'],
-					exception_recipients: @params['exception']['exception_recipients']
-				}
+				if @params['exception']['slack']
+					config.add_notifier :slack, {
+						webhook_url: params['exception']['slack']['webhook_url'],
+					}
+				end
+
+				if @params['exception']['exception_recipients']
+					config.add_notifier :email, {
+						email_prefix: @params['exception']['email_prefix'],
+						sender_address: @params['exception']['sender_address'],
+						exception_recipients: @params['exception']['exception_recipients']
+					}
+				end
 			end
 		end
 
@@ -114,8 +160,6 @@ module JTRailsToolbox
 		def configure_sidekiq(app)
 			Sidekiq.configure_server do |config|
 				config.redis = { url: @params['sidekiq']['redis_url'], namespace: @params['sidekiq']['namespace'] }
-
-				config.error_handlers << Proc.new {|ex, ctx_hash| ExceptionNotifier.notify_exception(ex, data: ctx_hash) }
 			end
 
 			Sidekiq.configure_client do |config|
@@ -126,5 +170,5 @@ module JTRailsToolbox
 		end
 
 	end
-
+		
 end

metadata

@@ -1,15 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: jt-rails-toolbox
 version: !ruby/object:Gem::Version
-  version: 1.2.4
+  version: 1.3.0
 platform: ruby
 authors:
 - Jonathan TRIBOUHARET
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-19 00:00:00.000000000 Z
+date: 2016-11-28 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: dotenv-rails
+  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: http_accept_language
+  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: exception_notification
   requirement: !ruby/object:Gem::Requirement
@@ -24,6 +52,20 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '4.1'
+- !ruby/object:Gem::Dependency
+  name: airbrake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: paperclip
   requirement: !ruby/object:Gem::Requirement