jefferies_tube 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 28837049e119307ca0d578437fe643b85b0392ca
+  data.tar.gz: 8aa5841a30c82576ca60f8ffdb3b3b9be669b69a
+SHA512:
+  metadata.gz: 3041d592626f0a1e060b89b67b56122a303e755eb9a7f5bb356ddeb59bc7c207778ea7b285dc86cf06f99f58e0e16b12a69493f22e7b27f6b89609c525ebef11
+  data.tar.gz: 9c5f762135566c6e513e594ee0c0624f6538dfdfd6fee992982169c4fe2a5b54dc572fbd9b0914706c73c7eedf82d583335bfa45919c1c588d1238661c788acf

data/.gitignore

@@ -0,0 +1,20 @@
+*.gem
+*.rbc
+.bundle
+.config
+.DS_Store
+.rspec
+.yardoc
+_yardoc
+coverage
+doc/
+Gemfile.lock
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/examples.txt
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.ruby-gemset

@@ -0,0 +1 @@
+jefferies_tube

data/.ruby-version

@@ -0,0 +1 @@
+2.2.3

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in jeffries_tube.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Brian Samson
+
+MIT License
+
+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,148 @@
+# JefferiesTube
+
+A collection of useful tools used at Ten Forward Consulting
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'jefferies_tube'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install jefferies_tube
+
+## Usage
+
+### Error Handling
+
+#### 404 Handling
+
+JefferiesTube by default installs a catchall route that will render 404 for you and supress the rollbar error.  This also allows you to create super easy custom error pages.
+
+Simple put a template in the parent app in `app/views/errors/404.haml` (or html or erb, etc) and it will be rendered instead of the default Jefferies tube error.
+
+#### 500 handling
+
+In progress -- not sure if this is super useful.
+
+### Rake
+
+* `rake db:backup`
+
+Capture a database backup
+
+* `rake db:restore`
+
+Load most recent database backup. Can specify location of backup with `FILE`.
+
+### Capistrano
+
+Add this line *last* in your Capfile (it depends on rails/migrations and cap/deploy)
+```ruby
+require 'jefferies_tube/capistrano'
+```
+
+#### Tasks
+
+* `cap beta ssh`
+
+Open ssh session in `current` directory.
+
+* `cap beta rails:console`
+
+Open rails console.
+
+* `cap beta rails:dbconsole`
+
+Open database console.
+
+* `cap beta rails:log`
+
+Open log file. Can specify log file like so: `LOG=foobar cap beta rails:log`
+
+* `cap beta db:backup`
+
+Make a database backup.
+
+* `cap beta db:fetch`
+
+Fetches the latest database backup. Useful for getting production data locally.
+
+* `cap beta db:restore FILE=path/to/backup.dump`
+
+Nuke the server's database with one you give it. Don't do this on production for obvious reasons. Useful for putting a backup fetched from production onto a dev server.
+
+* `cap beta deploy:ensure_tag`
+
+Yells at you if there is not a tag for your code.
+
+* `cap beta deploy:create_tag`
+
+Creates a tag for your code and pushes it.
+
+#### Tagging
+
+To enforce that you tagged the code before deploying, inside `config/deploy/<stage>.rb`:
+```ruby
+before 'deploy', 'deploy:ensure_tag'
+```
+
+To automatically tag the code that is about to be released (lazy programmer solution), inside `config/deploy/<stage>.rb`:
+```ruby
+before 'deploy', 'deploy:create_tag'
+```
+
+### Enable/Disable Maintence Mode
+
+```
+cap production maintenance:enable MESSAGE="Site is down for maintenance, should be back shortly."
+cap production maintenance:disable
+```
+
+### Whenever
+
+JefferiesTube has backup functionality. To use it, add something like this to your `schedule.rb`:
+
+```ruby
+every 1.day, at: '12am' do
+  rake 'db:backup'
+end
+```
+
+For hourly backups:
+
+```ruby
+every :hour do
+  rake 'db:backup:hourly'
+end
+```
+
+Or for daily backups:
+
+```ruby
+every :day do
+  rake 'db:backup:daily'
+end
+```
+
+### Sass
+
+To get compass reset and box-sizing border-box to all elements:
+```sass
+# app/assets/stylesheets/application.sass
+
+@import jefferies_tube
+```
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/jefferies_tube/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/app/assets/stylesheets/jefferies_tube.sass

@@ -0,0 +1,7 @@
+@import compass/reset
+
+html
+  box-sizing: border-box
+
+*, *:before, *:after
+  box-sizing: inherit

data/app/controllers/jefferies_tube/errors_controller.rb

@@ -0,0 +1,64 @@
+class JefferiesTube::ErrorsController < ApplicationController
+  if Rails.version.start_with? "3"
+    before_filter :disable_pundit
+    skip_before_filter :verify_authenticity_token
+  else
+    before_action :disable_pundit
+    skip_before_action :verify_authenticity_token
+  end
+
+  def render_404
+    log_404
+    render_error_page 404
+  end
+
+  def additional_information
+    # TODO not implemented yet
+    render text: "Thanks!", layout: has_app_layout?
+  end
+
+  private
+  def render_error_page(code)
+    request.format = :html unless [:html, :json, :xml].include? request.format.to_sym
+    respond_to do |format|
+      format.any do
+        begin
+          render template: "/errors/#{code}", layout: has_app_layout?, status: code
+        rescue #ActionView::MissingTemplate
+          # Failsafe
+          render template: "/errors/#{code}", layout: false, status: code
+        end
+      end
+    end
+  end
+
+  def log_404
+    if defined?(Rollbar) && request.referrer.present?
+      Rollbar.warn("Got 404 with referrer", referrer: request.referrer, current_path: request.path)
+    end
+  end
+
+  def disable_pundit
+    if defined?(Pundit)
+      skip_authorization
+    end
+  end
+
+  def has_app_layout?
+    if Gem::Version.new(Rails.version) >= Gem::Version.new("5")
+      !!self.send(:_layout, [request.format.to_sym])
+    else
+      # boolean based on if there is a default layout for the current mime type
+      !!self.send(:_layout)
+    end
+  end
+
+  def html_layout
+    if Gem::Version.new(Rails.version) >= Gem::Version.new("5")
+      self.send(:_layout, ["html"]).virtual_path
+    else
+      # boolean based on if there is a default layout for the current mime type
+      "application"
+    end
+  end
+end

data/app/views/errors/404.html.haml

@@ -0,0 +1,7 @@
+:css
+  #jt-error { margin: 32px auto; padding: 32px; }
+
+#jt-error
+  %h1 Page not found (Error 404)
+
+  %p Sorry!  We couldn't find the page you were looking for :(

data/app/views/errors/404.json.jbuilder

@@ -0,0 +1,2 @@
+json.error "Page not Found"
+json.status 404

data/app/views/errors/404.xml

@@ -0,0 +1,4 @@
+<error>
+  <status>404</status>
+  <message>Page Not Found</message>
+</error>

data/app/views/errors/500.haml

@@ -0,0 +1,22 @@
+:css
+  #jt-error { margin: 32px auto; padding: 32px; }
+  #jt-error label { display: block; }
+  #jt-error input, textarea { font-size: 16px; margin-bottom: 16px; width: 300px; display: block; }
+
+#jt-error
+  %h1 Server Error
+
+  %p Sorry!  Something went wrong with our server. Our development team has been notified.
+  %p Error Code: 500 (#{@exception.class.name})
+
+  / = form_tag "/jefferies_tube_add_error_information", method: "post" do
+  /   %p Want to help us fix this?  Tell us what you were doing and we'll try to fix it asap
+  /   %label
+  /     Comments:
+  /     = text_area_tag :comments, nil, rows: 3
+  /   %label
+  /     Your email address (optional):
+  /     = text_field_tag :email
+  /   = submit_tag "Submit"
+
+

data/jefferies_tube.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'jefferies_tube/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "jefferies_tube"
+  spec.version       = JefferiesTube::VERSION
+  spec.authors       = ["Brian Samson"]
+  spec.email         = ["brian@tenforwardconsulting.com"]
+  spec.summary       = %q{Ten Forward Consulting useful tools.}
+  spec.description   = "Useful tools for Rails."
+  spec.homepage      = "https://github.com/tenforwardconsulting/jefferies_tube/"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "awesome_print"
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", '~> 3.0'
+
+  spec.add_dependency "bundler-audit", '~>0.5.0'
+  spec.add_dependency 'compass-rails'
+end

data/lib/jefferies_tube.rb

@@ -0,0 +1,6 @@
+require 'jefferies_tube/version'
+require 'jefferies_tube/engine'
+
+module JefferiesTube
+  require 'jefferies_tube/railtie' if defined?(Rails)
+end

data/lib/jefferies_tube/access_token.rb

@@ -0,0 +1,17 @@
+class JefferiesTube::AccessToken
+  def self.create(hash)
+    verifier.generate(hash.to_yaml)
+  end
+
+  def self.read(token)
+    YAML.load(verifier.verify token)
+  rescue ActiveSupport::MessageVerifier::InvalidSignature
+    {}
+  end
+
+  private
+
+  def self.verifier
+    ActiveSupport::MessageVerifier.new(Rails.configuration.secret_token)
+  end
+end

data/lib/jefferies_tube/capistrano.rb

@@ -0,0 +1,11 @@
+if !defined?(Capistrano::VERSION)
+  raise "Capistrano is not present."
+elsif !Capistrano::VERSION.start_with?("3")
+  raise "Capistrano support is limited to version 3"
+end
+
+require 'jefferies_tube/capistrano/db'
+require 'jefferies_tube/capistrano/deploy'
+require 'jefferies_tube/capistrano/maintenance'
+require 'jefferies_tube/capistrano/rails'
+require 'jefferies_tube/capistrano/ssh'

data/lib/jefferies_tube/capistrano/db.rb

@@ -0,0 +1,32 @@
+namespace :db do
+  desc "Capture a database snapshot"
+  task :backup do
+    on roles(:db), primary: true do |host|
+      unless fetch(:linked_dirs).include?("db/backups")
+        warn "'db/backups' is not in your capistrano linked_dirs; you should add it yo"
+      end
+      within release_path do
+        execute :rake, "db:backup", "RAILS_ENV=#{fetch(:rails_env)}"
+      end
+    end
+  end
+
+  desc "Fetch the latest database backup"
+  task :fetch do
+    on roles(:db), primary: true do |host|
+      FileUtils.mkdir_p 'db/backups'
+      download! "#{deploy_to}/shared/db/backups/latest.dump", "db/backups/latest-#{fetch(:stage)}.dump"
+    end
+  end
+
+  desc "Restore the database from a local file FILE=./local/file_path"
+  task :restore do
+    on roles(:app), primary: true do |host|
+      within release_path do
+        remote_path = "#{release_path}/db/backups/#{File.basename(ENV["FILE"])}"
+        upload! ENV["FILE"], remote_path
+        execute :rake, "db:restore", "RAILS_ENV=#{fetch(:rails_env)}", "FILE=#{remote_path}"
+      end
+    end
+  end
+end

data/lib/jefferies_tube/capistrano/deploy.rb

@@ -0,0 +1,53 @@
+namespace :deploy do
+  task :ensure_tag do
+    tagname = `git describe --exact-match HEAD`.chomp
+    if $? == 0
+      puts "Code is tagged as `#{tagname}`, proceeding with deployment"
+    else
+      abort "You need to tag the source before you can deploy production"
+    end
+  end
+
+  task :create_tag do
+    now = Time.now
+    tagname = "#{fetch(:stage)}-#{now.strftime('%Y-%m-%d-%H%M')}"
+    me = `whoami`.chomp
+    %x(git tag -a #{tagname} -m "Automated deploy tag by #{me}" && git push origin #{tagname})
+  end
+
+  task :backup_database do
+    if fetch(:skip_deploy_backups)
+      puts "Skipping database backup because :skip_deploy_backups is set"
+    else
+      invoke "db:backup"
+    end
+  end
+
+  task :scan_gems do
+    require 'bundler/audit/scanner'
+    require 'bundler/audit/database'
+
+    Bundler::Audit::Database.update!
+    scanner = Bundler::Audit::Scanner.new
+    vulnerable = false
+    scanner.scan do |result|
+      vulnerable = true
+      case result
+      when Bundler::Audit::Scanner::InsecureSource
+        print_warning "Insecure Source URI found: #{result.source}"
+      when Bundler::Audit::Scanner::UnpatchedGem
+        puts "#{result.gem} is not secure!"
+      end
+    end
+    if vulnerable && ENV["I_KNOW_GEMS_ARE_INSECURE"].blank?
+      abort """
+      Your Gemfile.lock contains unpatched gems -- refusing to deploy
+      Run `bundle-audit check --update` for full information
+      You can set 'I_KNOW_GEMS_ARE_INSECURE' if you really want to do this anyway
+      """
+    end
+  end
+end
+
+before 'deploy:migrate', 'deploy:backup_database'
+before 'deploy', 'deploy:scan_gems'

data/lib/jefferies_tube/capistrano/maintenance.rb

@@ -0,0 +1,22 @@
+namespace :maintenance do
+  desc "Enable maintenance: set MESSAGE='We should be back in approximately 2 hours'"
+  task :enable do
+    on roles(:web) do |host, user|
+      within current_path do
+        message = ENV["MESSAGE"] || ""
+        upload! StringIO.new(message), "#{current_path}/tmp/maintenance.txt"
+        invoke 'deploy:restart'
+      end
+    end
+  end
+
+  desc "Disable maintenance mode"
+  task :disable do
+    on roles(:web) do |host, user|
+      within current_path do
+        execute :rm, "#{current_path}/tmp/maintenance.txt"
+        invoke 'deploy:restart'
+      end
+    end
+  end
+end

data/lib/jefferies_tube/capistrano/rails.rb

@@ -0,0 +1,31 @@
+namespace :rails do
+  desc "Open the rails console on each of the remote servers"
+  task :console do
+    on roles(:app), primary: true do |host, user|
+      rails_env = fetch(:rails_env)
+      run_interactively "RAILS_ENV=#{rails_env} bundle exec rails console"
+    end
+  end
+
+  desc "Open the rails dbconsole on each of the remote servers"
+  task :dbconsole do
+    on roles(:db), primary: true do |host|
+      rails_env = fetch(:rails_env)
+      run_interactively "RAILS_ENV=#{rails_env} bundle exec rails dbconsole"
+    end
+  end
+
+  desc "Open the rails log"
+  task :log do
+    on roles(:app), primary: true do |host, user|
+      rails_env = ENV['LOG'] || fetch(:rails_env)
+      run_interactively "tail -f log/#{rails_env}.log"
+    end
+  end
+
+  def run_interactively(command)
+    port = host.port || 22
+    puts "ssh #{host.user}@#{host} -p #{port} -t 'cd #{deploy_to}/current; #{command}'"
+    exec "ssh #{host.user}@#{host} -p #{port} -t 'cd #{deploy_to}/current; #{command}'"
+  end
+end

data/lib/jefferies_tube/capistrano/ssh.rb

@@ -0,0 +1,8 @@
+desc "Open an ssh session"
+task :ssh do
+  on roles(:app), primary: true do |host|
+    port = host.port || 22
+    puts "ssh #{host.user}@#{host} -p #{port}"
+    exec "ssh #{host.user}@#{host} -p #{port}"
+  end
+end

data/lib/jefferies_tube/database_backup.rb

@@ -0,0 +1,130 @@
+class DatabaseBackup
+  BACKUP_DIR = 'db/backups'
+
+  module Frequency
+    DAILY = :daily
+    HOURLY = :hourly
+  end
+
+  attr_accessor :max_num_of_backups
+
+  def initialize(database_backup_adapter, max_num_of_backups: 10)
+    @database_backup_adapter = database_backup_adapter
+    @max_num_of_backups = max_num_of_backups
+    @rotate_frequency = nil
+  end
+
+  def create
+    FileUtils.mkdir_p backup_path
+    @latest_backup_file = create_backup
+    remove_symlink_to_old_backup
+    create_symlink_to_new_backup
+    delete_oldest_backup
+    compress_old_backups
+    @latest_backup_file
+  end
+
+  def create_rotated(frequency)
+    @rotate_frequency = frequency
+    create
+    cleanup
+  end
+
+  def restore(path)
+    @database_backup_adapter.restore path
+  end
+
+  def restore_most_recent
+    @database_backup_adapter.restore symlink_file
+  end
+
+  def symlink_file
+    File.join backup_path, 'latest.dump'
+  end
+
+  def backups
+    Dir.glob(File.join(backup_path, '*'))
+  end
+
+  def cleanup
+    # hourly - keep for 24 hours
+    sh "find #{storage_path}/backup.hourly/ -mmin +1440 -exec rm -rv {} \\;"
+    # daily - keep for 14 days
+    sh "find #{storage_path}/backup.daily/ -mtime +14 -exec rm -rv {} \\;"
+    # weekly - keep for 60 days
+    sh "find #{storage_path}/backup.weekly/ -mtime +60 -exec rm -rv {} \\;"
+    # monthly - keep for 300 days
+    sh "find #{storage_path}/backup.monthly/ -mtime +300 -exec rm -rv {} \\;"
+  end
+
+  private
+
+  # Procedural Methods
+  def create_backup
+    backup_filename = "#{Time.now.strftime('%Y%m%d%H%M%S')}.dump"
+    latest_backup_file = File.join backup_path, backup_filename
+    @database_backup_adapter.create_backup latest_backup_file
+    latest_backup_file
+  end
+
+  def remove_symlink_to_old_backup
+    File.delete(symlink_file) if File.exist?(symlink_file)
+  end
+
+  def create_symlink_to_new_backup
+    sh "ln -sf #{@latest_backup_file} #{symlink_file}"
+  end
+
+  def delete_oldest_backup
+    File.delete(old_backups.first) if old_backups.count >= max_num_of_backups
+  end
+
+  def compress_old_backups
+    old_backups.each do |backup_filename|
+      next if backup_filename =~ /.dump.gz/
+      sh "gzip #{backup_filename}"
+    end
+  end
+
+  # Helper Methods
+  def root_dir
+    Rails.root
+  end
+
+  def backup_path
+    if @rotate_frequency
+      rotated_backup_path(@rotate_frequency)
+    else
+      storage_path
+    end
+  end
+
+  def storage_path
+    File.join(root_dir, BACKUP_DIR)
+  end
+
+  def rotated_backup_path(frequency = Frequency::DAILY)
+    storage = File.join(root_dir, BACKUP_DIR)
+    now = Time.now
+    if now.day == 1
+      storage = File.join(storage, 'backup.monthly')
+    elsif now.wday == 0
+      storage = File.join(storage, 'backup.weekly')
+    elsif frequency == Frequency::DAILY || now.hour == 0
+      storage = File.join(storage, 'backup.daily')
+    elsif frequency == Frequency::HOURLY
+      storage = File.join(storage, 'backup.hourly')
+    end
+    storage
+  end
+
+  def old_backups
+    backups.sort.reject { |r|
+      r == @latest_backup_file || r == symlink_file
+    }
+  end
+
+  def sh(cmd)
+    `#{cmd}`
+  end
+end

data/lib/jefferies_tube/database_backup_adapter.rb

@@ -0,0 +1,9 @@
+class DatabaseBackupAdapter
+  def create_backup(file)
+    raise NotImplementedError
+  end
+
+  def restore(file)
+    raise NotImplementedError
+  end
+end

data/lib/jefferies_tube/engine.rb

@@ -0,0 +1,9 @@
+module JefferiesTube
+  module Rails
+    class Engine < ::Rails::Engine
+      initializer 'jefferies_tube.engine', :group => :all do |app|
+        app.config.assets.paths << root.join('assets', 'stylesheets')
+      end
+    end
+  end
+end

data/lib/jefferies_tube/postgresql_backup_adapter.rb

@@ -0,0 +1,52 @@
+require_relative 'database_backup_adapter'
+
+class PostgresqlBackupAdapter < DatabaseBackupAdapter
+  def create_backup(file)
+    `#{password_option} pg_dump --verbose -Fc \
+    #{host_option} #{username_option} --file #{file} \
+    #{database}
+    `
+  end
+
+  def restore(file)
+    `#{password_option} pg_restore --verbose --clean --no-acl --no-owner \
+    #{host_option} #{username_option} -d #{database} \
+    #{file}`
+  end
+
+  private
+
+  def db_option(name)
+    value = db_config(name)
+    if (value)
+      "--#{name}=#{value}"
+    else
+      ""
+    end
+  end
+
+  def username_option
+    db_option('username')
+  end
+
+  def password_option
+    password = db_config('password')
+    if password
+      password_option = "PGPASSWORD=\"#{password}\""
+    else
+      password_option = ""
+    end
+  end
+
+  def host_option
+    db_option('host')
+  end
+
+  def database
+    db_config "database"
+  end
+
+  def db_config(key)
+    Rails.configuration.database_configuration[Rails.env][key]
+  end
+end

data/lib/jefferies_tube/rack/maintenance.rb

@@ -0,0 +1,20 @@
+require 'rack'
+
+module JefferiesTube
+  module Rack
+    class Maintenance
+      attr_reader :app, :options
+
+      def initialize(app, options={})
+        @app     = app
+        @options = options
+      end
+
+      def call(env)
+        message = File.read('./tmp/maintenance.txt')
+        message = "Sorry, this site is down for maintenance." if message.empty?
+        [ 503, { "Content-Type" => "text/plain", "Content-Length" => message.bytesize.to_s }, [message] ]
+      end
+    end
+  end
+end

data/lib/jefferies_tube/railtie.rb

@@ -0,0 +1,39 @@
+require 'jefferies_tube'
+require 'rails'
+
+module JefferiesTube
+  class Railtie < ::Rails::Railtie
+    railtie_name :jefferies_tube
+
+    console do
+      ActiveRecord::Base.connection
+    end
+
+    config.after_initialize do |args|
+      begin
+        # if this route exists, it means the app already defined its own catchall route
+        # if not, this will raise an exception and we will install our catchall instead
+        ::Rails.application.routes.recognize_path("/jefferies_tube_404_test_route_test_supertest")
+      rescue ActionController::RoutingError
+        ::Rails.application.routes.append do
+          match "*a" => "jefferies_tube/errors#render_404", via: [:get, :post, :put, :options]
+        end
+      end
+    end
+
+    initializer "jefferies_tube.add_maintenance_middleware" do |config|
+      if File.exists? "tmp/maintenance.txt"
+        require 'jefferies_tube/rack/maintenance'
+        config.middleware.use 'JefferiesTube::Rack::Maintenance'
+      end
+    end
+
+
+    initializer "fix spring + figaro" do |config|
+      if defined?(Spring) && File.exists?("config/application.yml")
+        require 'spring/watcher'
+        Spring.watch "config/application.yml"
+      end
+    end
+  end
+end

data/lib/jefferies_tube/test_backup_adapter.rb

@@ -0,0 +1,10 @@
+require_relative 'database_backup_adapter'
+
+class TestBackupAdapter < DatabaseBackupAdapter
+  def create_backup(file)
+    FileUtils.touch file
+  end
+
+  def restore(file)
+  end
+end

data/lib/jefferies_tube/version.rb

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

data/lib/tasks/db.rake

@@ -0,0 +1,27 @@
+require_relative '../jefferies_tube/database_backup'
+require_relative '../jefferies_tube/postgresql_backup_adapter'
+
+namespace :db do
+  desc 'restore a backup. Defaults to "db/backups/latest.dump". options: FILE=path/to/backup.dump'
+  task :restore do
+    # Only supports Postgresql for now
+    file = ENV['FILE'] || "db/backups/latest.dump"
+    DatabaseBackup.new(PostgresqlBackupAdapter.new).restore(file)
+  end
+
+  desc 'Capture a database backup'
+  task :backup do
+    # Only supports Postgresql for now
+    DatabaseBackup.new(PostgresqlBackupAdapter.new).create
+  end
+
+  namespace :backup do
+    task :daily do
+      DatabaseBackup.new(PostgresqlBackupAdapter.new).create_rotated(DatabaseBackup::Frequency::DAILY)
+    end
+
+    task :hourly do
+      DatabaseBackup.new(PostgresqlBackupAdapter.new).create_rotated(DatabaseBackup::Frequency::HOURLY)
+    end
+  end
+end

data/spec/database_backup_spec.rb

@@ -0,0 +1,73 @@
+require 'tmpdir'
+require_relative '../lib/jefferies_tube/database_backup'
+require_relative '../lib/jefferies_tube/test_backup_adapter'
+
+RSpec.describe DatabaseBackup do
+  let(:database_backup_adapter) { TestBackupAdapter.new }
+  let(:database_backup) { DatabaseBackup.new database_backup_adapter, max_num_of_backups: 2 }
+  let(:root_dir) { Dir.mktmpdir }
+
+  before :each do
+    allow(database_backup).to receive(:root_dir).and_return root_dir
+  end
+
+  after :each do
+    FileUtils.remove_entry root_dir
+  end
+
+  describe '#create' do
+    it 'creates the backup directory' do
+      backup_dir = File.join(root_dir, DatabaseBackup::BACKUP_DIR)
+      expect {
+        database_backup.create
+      }.to change { Dir.exist? backup_dir }.from(false).to true
+    end
+
+    it 'creates a backup' do
+      latest_backup_file = database_backup.create
+      expect(File.exist? latest_backup_file).to eq true
+    end
+
+    it 'creates a symlink to the latest backup' do
+      expect {
+        database_backup.create
+      }.to change { File.symlink? database_backup.symlink_file }.from(false).to true
+    end
+
+    it 'compresses old backups' do
+      will_be_old_backup = database_backup.create
+      sleep 1 # To change the timestamp
+      database_backup.create
+      expect(File.exist? will_be_old_backup).to eq false
+      expect(File.exist? "#{will_be_old_backup}.gz").to eq true
+    end
+
+    it 'deletes oldest backups' do
+      will_be_deleted_backup = database_backup.create
+      sleep 1 # To change the timestamp
+      second_backup = database_backup.create
+      third_backup = database_backup.create
+      expect(File.exist? will_be_deleted_backup).to eq false
+      expect(File.exist? second_backup).to eq true
+      expect(File.exist? third_backup).to eq true
+      expect(database_backup.backups.size).to eq 3
+    end
+  end
+
+  describe '#created_rotated' do
+  end
+
+  describe '#restore' do
+    it 'restores using the database adapter' do
+      expect(database_backup_adapter).to receive(:restore).with 'db/backups/foobar.dump'
+      database_backup.restore 'db/backups/foobar.dump'
+    end
+  end
+
+  describe '#restore_most_recent' do
+    it 'restores latest.dump' do
+      expect(database_backup_adapter).to receive(:restore).with File.join(root_dir, 'db/backups/latest.dump')
+      database_backup.restore_most_recent
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,92 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Allows RSpec to persist some state between runs in order to support
+  # the `--only-failures` and `--next-failure` CLI options. We recommend
+  # you configure your source control system to ignore this file.
+  config.example_status_persistence_file_path = "spec/examples.txt"
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/
+  #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#zero-monkey-patching-mode
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  #config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+end

metadata

@@ -0,0 +1,178 @@
+--- !ruby/object:Gem::Specification
+name: jefferies_tube
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Brian Samson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-03-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  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: bundler
+  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'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: 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: bundler-audit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+- !ruby/object:Gem::Dependency
+  name: compass-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'
+description: Useful tools for Rails.
+email:
+- brian@tenforwardconsulting.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-gemset"
+- ".ruby-version"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- app/assets/stylesheets/jefferies_tube.sass
+- app/controllers/jefferies_tube/errors_controller.rb
+- app/views/errors/404.html.haml
+- app/views/errors/404.json.jbuilder
+- app/views/errors/404.xml
+- app/views/errors/500.haml
+- jefferies_tube.gemspec
+- lib/jefferies_tube.rb
+- lib/jefferies_tube/access_token.rb
+- lib/jefferies_tube/capistrano.rb
+- lib/jefferies_tube/capistrano/db.rb
+- lib/jefferies_tube/capistrano/deploy.rb
+- lib/jefferies_tube/capistrano/maintenance.rb
+- lib/jefferies_tube/capistrano/rails.rb
+- lib/jefferies_tube/capistrano/ssh.rb
+- lib/jefferies_tube/database_backup.rb
+- lib/jefferies_tube/database_backup_adapter.rb
+- lib/jefferies_tube/engine.rb
+- lib/jefferies_tube/postgresql_backup_adapter.rb
+- lib/jefferies_tube/rack/maintenance.rb
+- lib/jefferies_tube/railtie.rb
+- lib/jefferies_tube/test_backup_adapter.rb
+- lib/jefferies_tube/version.rb
+- lib/tasks/db.rake
+- spec/database_backup_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/tenforwardconsulting/jefferies_tube/
+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.4.5.1
+signing_key: 
+specification_version: 4
+summary: Ten Forward Consulting useful tools.
+test_files:
+- spec/database_backup_spec.rb
+- spec/spec_helper.rb