jt-rails-toolbox 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 38a71b9807ecd4b975ac247304de52a4b07131cd
+  data.tar.gz: 8fcd255aafa1e5dcb417786881a7932be2d9c551
+SHA512:
+  metadata.gz: 42e5dfccb8453f47328d3f42ae34e6ab5474c2d8cac4be92f56a1ca02094cacb19cca45edd89155e2ab9d5d4af62d8b53d7f75457e0b2d9f61e70370198970d1
+  data.tar.gz: f6b475a03f55c622549ace0707795b01dbbacaec1e6a172ffe4120492caaee53e956fbd8cd0c7c1e02074bd87b2513c42a43e8d712381b8549f55f4f41d60dda

data/.gitignore

@@ -0,0 +1,2 @@
+*.gem
+.DS_Store

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2015 Jonathan Tribouharet
+
+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,70 @@
+# JTRailsToolboox
+
+JTRailsToolboox contains a list of common libs used for rails development.
+
+## Installation
+
+JTRailsToolboox is distributed as a gem, which is how it should be used in your app.
+
+Include the gem in your Gemfile:
+
+    gem 'jt-rails-toolboox', '~> 1.0'
+
+Create a `jt-toolbox.yml` file:
+
+	rails g rails_toolbox:install
+
+## What's in it?
+
+- [Exception Notification](https://github.com/smartinez87/exception_notification), send email notifications when errors occur
+- [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
+- [validates_email_format_of](https://github.com/validates-email-format-of/validates_email_format_of), who doesn't need to validate email format?
+- simplified configuration of hostnames and `ActionMailer` with YAML
+
+### Exception Notification
+
+If `exception` is not set in `jt-toolbox.yml` file, Exception Notification is disabled.
+In addition to the default ignored exceptions, the following exceptions are also muted:
+
+- `ActionController::InvalidCrossOriginRequest`
+- `ActionController::InvalidAuthenticityToken`
+
+### Paperclip
+
+- `convert_options` is set to `-strip`, which means all metadata of images are removed, this is used for reduced the weight of images.
+- `use_timestamp` is et to `false`, it's a good practice to have unique url for image and url without parameters, instead of using the timestamp we use the fingerprint of the image. [More informations here.](https://github.com/thoughtbot/paperclip#md5-checksum--fingerprint)
+- the default fodler of images is `upload` (in public folder)
+
+### Sidekiq
+
+- configured for `ActiveJob`
+- configured to send notification error with Exception Notification
+- redis url is by default `"redis://localhost:6379/#{name of your}"`
+
+#### Warning
+
+Don't forget to install redis server and to launch sidekiq with
+
+`bundle exec sidekiq -q default -q mailers`
+
+### Hostname
+
+- `host` is the hostname of your website, it's used for setting the host when you email
+- `asset_host` is the hostname of the assets server. By default equal to `host`.
+- `cdn_host` is the hostname for serving uploaded files with paperclip. By default equal to `asset_host`.
+
+It's a good practice to have a different domains for your web server and your file server (search "Cookieless Domain" on google for more informations).
+
+### ActionMailer
+
+ActionMailer can be configured easily just with `jt-toolbox.yml` file.
+
+## Author
+
+- [Jonathan Tribouharet](https://github.com/jonathantribouharet) ([@johntribouharet](https://twitter.com/johntribouharet))
+
+## License
+
+JTRailsToolboox is released under the MIT license. See the LICENSE file for more info.

data/jt-rails-toolbox.gemspec

@@ -0,0 +1,19 @@
+Gem::Specification.new do |s|
+	s.name = 'jt-rails-toolbox'
+	s.summary = "Common libs used for rails development."
+	s.description = "JTRailsToolboox contains a list of common libs used for rails development."
+	s.homepage = 'https://github.com/jonathantribouharet/jt-rails-toolbox'
+	s.version = '1.0.0'
+	s.files = `git ls-files`.split("\n")
+	s.require_paths = ['lib']
+	s.authors = ['Jonathan TRIBOUHARET']
+	s.email = 'jonathan@siu-soon.com'
+	s.license = 'MIT'
+	s.platform = Gem::Platform::RUBY
+
+	s.add_dependency('exception_notification', '~> 4.1')
+	s.add_dependency('paperclip', '~> 4.2')
+	s.add_dependency('quiet_assets', '~> 1.1')
+	s.add_dependency('sidekiq', '~> 3.3')
+	s.add_dependency('validates_email_format_of', '~> 1.6')
+end

data/lib/generators/rails_toolbox/USAGE

@@ -0,0 +1,3 @@
+Create a default configuration to your Rails App.
+
+  rails g rails_toolbox:install

data/lib/generators/rails_toolbox/install_generator.rb

@@ -0,0 +1,11 @@
+module RailsToolbox
+
+	class InstallGenerator < Rails::Generators::Base
+		source_root File.expand_path("../templates", __FILE__)
+
+		def create_initializer_file
+			copy_file "jt-toolbox.yml", "config/jt-toolbox.yml"
+		end
+	end
+
+end

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

@@ -0,0 +1,37 @@
+# default:
+#   files:
+#     folder: upload
+#   mail:
+#     delivery_method: test
+#   hosts:
+#     host: localhost
+#     asset_host: same as host
+#     cdn_host: same as host
+#   sidekiq:
+#     redis_url: redis://localhost:6379/nameoftheapp
+
+production:
+  exception:
+    email_prefix: '[ERROR]'
+    sender_address: "Your website <error@example.com>"
+    exception_recipients:
+     - my_email_for_errors@example.com
+  files:
+    folder: upload
+  mail:
+    from: "Your website <contact@example.com>"
+    delivery_method: smtp
+    smtp_settings:
+      address: smtp.gmail.com
+      port: 587
+      domain: example.com
+      user_name: username
+      password: password
+      authentication: plain
+      enable_starttls_auto: true
+  hosts:
+    host: https://www.example.com
+    asset_host: https://asset.example.com
+    cdn_host: https://cdn.example.com
+  sidekiq:
+    redis_url: redis://localhost:6379/my_app

data/lib/jt-rails-toolbox.rb

@@ -0,0 +1,120 @@
+require 'exception_notification'
+require 'paperclip'
+require 'sidekiq'
+require 'validates_email_format_of'
+
+require 'exception_notification/rails'
+require 'exception_notification/sidekiq'
+
+require 'yaml'
+
+module JTRailsToolbox
+
+	class Railtie < ::Rails::Railtie
+		
+		initializer "jt-rails-toolbox" do |app|
+			if ::File.exists?('config/jt-toolbox.yml')
+				load_params(app)
+
+				if Rails.env.development?
+					require 'quiet_assets'
+				end
+
+				configure_exception_notification(app)
+				configure_mail(app)
+				configure_paperclip(app)
+				configure_sidekiq(app)
+			end
+		end
+
+		def load_params(app)
+			@params = YAML.load_file('config/jt-toolbox.yml')[Rails.env.to_s] || {}
+
+			process_params
+		end
+
+		def process_params
+			@params['files'] ||= {}
+			if @params['files']['folder'].nil?
+				@params['files']['folder'] = '/upload'
+			else
+				# Remove end slash
+				@params['files']['folder'].sub!(/\/$/, '')
+
+				if !@params['files']['folder'].start_with?('/')
+					@params['files']['folder'] = "/#{@params['files']['folder']}"
+				end
+			end
+
+			@params['mail'] ||= {}
+			@params['mail']['delivery_method'] ||= :test
+
+			@params['mail']['delivery_method'] = @params['mail']['delivery_method'].to_sym
+
+			@params['mail']['smtp_settings'] ||= {}
+			settings = @params['mail']['smtp_settings'].dup
+			for key, value in settings
+				@params['mail']['smtp_settings'][key.to_sym] = value
+			end
+
+			@params['hosts'] ||= {}
+			@params['hosts']['host'] ||= 'http://localhost'
+			@params['hosts']['asset_host'] ||= @params['hosts']['host']
+			@params['hosts']['cdn_host'] ||= @params['hosts']['asset_host']
+
+			@params['sidekiq'] ||= {}
+			@params['sidekiq']['redis_url'] ||= "redis://localhost:6379/#{Rails.application.class.parent_name.parameterize}"
+		end
+
+		def configure_exception_notification(app)
+			return if @params['exception'].nil?
+
+			ExceptionNotification.configure do |config|
+				config.ignored_exceptions += ['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']
+				}
+			end
+		end
+
+		def configure_mail(app)
+			ActionMailer::Base.delivery_method = @params['mail']['delivery_method']
+			ActionMailer::Base.smtp_settings = @params['mail']['smtp_settings']
+			ActionMailer::Base.default_url_options[:host] = @params['hosts']['host']
+			ActionMailer::Base.default from: @params['mail']['from']
+		end
+
+		def configure_paperclip(app)
+			# Strip meta data from images
+			Paperclip::Attachment.default_options[:convert_options] = { all: '-strip' }
+
+			# Params in url are bad for SEO, it's better to use fingerprint for having a unique url
+			Paperclip::Attachment.default_options[:use_timestamp] = false
+
+			path = "#{@params['files']['folder']}/:class/:attachment/:id/:style/:fingerprint.:content_type_extension"
+
+			Paperclip::Attachment.default_options[:path] = ":rails_root/public/#{path}"
+			Paperclip::Attachment.default_options[:url] = "#{@params['hosts']['cdn_host']}#{path}"
+			app.config.action_controller.asset_host = @params['hosts']['asset_host']
+		end
+
+		def configure_sidekiq(app)
+			Sidekiq.configure_server do |config|
+				config.redis = { url: @params['sidekiq']['redis_url'] }
+
+				config.error_handlers << Proc.new {|ex, ctx_hash| ExceptionNotifier.notify_exception(ex, data: ctx_hash) }
+			end
+
+			Sidekiq.configure_client do |config|
+				config.redis = { url: @params['sidekiq']['redis_url'] }
+			end
+
+			ActiveJob::Base.queue_adapter = :sidekiq
+		end
+
+	end
+
+end

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: jt-rails-toolbox
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Jonathan TRIBOUHARET
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-05-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: exception_notification
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+- !ruby/object:Gem::Dependency
+  name: paperclip
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: quiet_assets
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: validates_email_format_of
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+description: JTRailsToolboox contains a list of common libs used for rails development.
+email: jonathan@siu-soon.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- LICENSE
+- README.md
+- jt-rails-toolbox.gemspec
+- lib/generators/rails_toolbox/USAGE
+- lib/generators/rails_toolbox/install_generator.rb
+- lib/generators/rails_toolbox/templates/jt-toolbox.yml
+- lib/jt-rails-toolbox.rb
+homepage: https://github.com/jonathantribouharet/jt-rails-toolbox
+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.0.14
+signing_key: 
+specification_version: 4
+summary: Common libs used for rails development.
+test_files: []