turnout2024 3.0.0

data/lib/turnout/maintenance_file.rb

@@ -0,0 +1,119 @@
+require 'yaml'
+require 'fileutils'
+
+module Turnout
+  class MaintenanceFile
+    attr_reader :path
+
+    SETTINGS = [:reason, :allowed_paths, :allowed_ips, :response_code, :retry_after]
+    attr_reader(*SETTINGS)
+
+    def initialize(path)
+      @path = path
+      @reason = Turnout.config.default_reason
+      @allowed_paths = Turnout.config.default_allowed_paths
+      @allowed_ips = Turnout.config.default_allowed_ips
+      @response_code = Turnout.config.default_response_code
+      @retry_after = Turnout.config.default_retry_after
+
+      import_yaml if exists?
+    end
+
+    def exists?
+      File.exist? path
+    end
+
+    def to_h
+      SETTINGS.each_with_object({}) do |att, hash|
+        hash[att] = send(att)
+      end
+    end
+
+    def to_yaml(key_mapper = :to_s)
+      to_h.each_with_object({}) { |(key, val), hash|
+        hash[key.send(key_mapper)] = val
+      }.to_yaml
+    end
+
+    def write
+      FileUtils.mkdir_p(dir_path) unless Dir.exist? dir_path
+
+      File.open(path, 'w') do |file|
+        file.write to_yaml
+      end
+    end
+
+    def delete
+      File.delete(path) if exists?
+    end
+
+    def import(hash)
+      SETTINGS.map(&:to_s).each do |att|
+        self.send(:"#{att}=", hash[att]) unless hash[att].nil?
+      end
+
+      true
+    end
+    alias :import_env_vars :import
+
+    # Find the first MaintenanceFile that exists
+    def self.find
+      path = named_paths.values.find { |p| File.exist? p }
+      self.new(path) if path
+    end
+
+    def self.named(name)
+      path = named_paths[name.to_sym]
+      self.new(path) unless path.nil?
+    end
+
+    def self.default
+      self.new(named_paths.values.first)
+    end
+
+    private
+
+    def retry_after=(value)
+      @retry_after = value
+    end
+
+    def reason=(reason)
+      @reason = reason.to_s
+    end
+
+    # Splits strings on commas for easier importing of environment variables
+    def allowed_paths=(paths)
+      if paths.is_a? String
+        # Grab everything between commas that aren't escaped with a backslash
+        paths = paths.to_s.split(/(?<!\\),\ ?/).map do |path|
+          path.strip.gsub('\,', ',') # remove the escape characters
+        end
+      end
+
+      @allowed_paths = paths
+    end
+
+    # Splits strings on commas for easier importing of environment variables
+    def allowed_ips=(ips)
+      ips = ips.to_s.split(',') if ips.is_a? String
+
+      @allowed_ips = ips
+    end
+
+    def response_code=(code)
+      @response_code = code.to_i
+    end
+
+    def dir_path
+      File.dirname(path)
+    end
+
+    def import_yaml
+      import YAML::load(File.open(path)) || {}
+    end
+
+    def self.named_paths
+      Turnout.config.named_maintenance_file_paths
+    end
+  end
+end

data/lib/turnout/maintenance_page/base.rb

@@ -0,0 +1,79 @@
+module Turnout
+  module MaintenancePage
+    class Base
+      attr_reader :reason
+
+      def initialize(reason = nil, options = {})
+        @options = options.is_a?(Hash) ? options : {}
+        @reason = reason
+      end
+
+      def rack_response(code = nil, retry_after = nil)
+        code ||= Turnout.config.default_response_code
+        [code, headers(retry_after), body]
+      end
+
+      # Override with an array of media type strings. i.e. text/html
+      def self.media_types
+        raise NotImplementedError, '.media_types must be overridden in subclasses'
+      end
+      def media_types() self.class.media_types end
+
+      # Override with a file extension value like 'html' or 'json'
+      def self.extension
+        raise NotImplementedError, '.extension must be overridden in subclasses'
+      end
+      def extension() self.class.extension end
+
+      def custom_path
+        Pathname.new(Turnout.config.maintenance_pages_path).join(filename)
+      end
+
+      protected
+
+      def self.inherited(subclass)
+        MaintenancePage.all << subclass
+      end
+
+      def headers(retry_after = nil)
+        headers = {'Content-Type' => media_types.first, 'Content-Length' => length}
+        # Include the Retry-After header unless it wasn't specified
+        headers['Retry-After'] = retry_after.to_s unless retry_after.nil?
+        headers
+      end
+
+      def length
+        content.bytesize.to_s
+      end
+
+      def body
+        [content]
+      end
+
+      def content
+         file_content.gsub(/{{\s?reason\s?}}/, reason)
+      end
+
+      def file_content
+        File.read(path)
+      end
+
+      def path
+        if File.exist? custom_path
+          custom_path
+        else
+          default_path
+        end
+      end
+
+      def default_path
+        File.expand_path("../../../../public/#{filename}", __FILE__)
+      end
+
+
+      def filename
+        "maintenance.#{extension}"
+      end
+    end
+  end
+end

data/lib/turnout/maintenance_page/erb.rb

@@ -0,0 +1,22 @@
+require 'erb'
+require 'tilt'
+require 'tilt/erb'
+require_relative './html'
+require_relative '../i18n/internationalization'
+
+module Turnout
+  module MaintenancePage
+    class Erb < Turnout::MaintenancePage::HTML
+
+      def content
+        Turnout::Internationalization.initialize_i18n(@options[:env])
+        Tilt.new(File.expand_path(path)).render(self, {reason: reason}.merge(@options))
+      end
+      
+      def self.extension
+        'html.erb'
+      end
+
+    end
+  end
+end

data/lib/turnout/maintenance_page/html.rb

@@ -0,0 +1,21 @@
+require_relative './base'
+module Turnout
+  module MaintenancePage
+    class HTML < Base
+      def reason
+        super.to_s.split("\n").map{|txt| "<p>#{txt}</p>" }.join("\n")
+      end
+
+      def self.media_types
+        %w{
+          text/html
+          application/xhtml+xml
+        }
+      end
+
+      def self.extension
+        'html'
+      end
+    end
+  end
+end

data/lib/turnout/maintenance_page/json.rb

@@ -0,0 +1,26 @@
+require 'json'
+
+module Turnout
+  module MaintenancePage
+    class JSON < Base
+      def reason
+        super.to_s.to_json
+      end
+
+      def self.media_types
+        %w{
+          application/json
+          text/json
+          application/x-javascript
+          text/javascript
+          text/x-javascript
+          text/x-json
+        }
+      end
+
+      def self.extension
+        'json'
+      end
+    end
+  end
+end

data/lib/turnout/maintenance_page.rb

@@ -0,0 +1,24 @@
+require 'pathname'
+module Turnout
+  module MaintenancePage
+    require 'rack/accept'
+
+    def self.all
+      @all ||= []
+    end
+
+    def self.best_for(env)
+      request = Rack::Accept::Request.new(env)
+
+      all_types = all.map(&:media_types).flatten
+      best_type = request.best_media_type(all_types)
+      best = all.find { |page| page.media_types.include?(best_type) && File.exist?(page.new.custom_path) }
+      best || Turnout.config.default_maintenance_page
+    end
+
+    require 'turnout/maintenance_page/base'
+    require 'turnout/maintenance_page/erb'
+    require 'turnout/maintenance_page/html'
+    require 'turnout/maintenance_page/json'
+  end
+end

data/lib/turnout/ordered_options.rb

@@ -0,0 +1,98 @@
+module Turnout
+  class OrderedOptions < Hash
+    alias_method :_get, :[] # preserve the original #[] method
+    protected :_get # make it protected
+
+    def initialize(constructor = {}, &block)
+      if constructor.respond_to?(:to_hash)
+        super()
+        update(constructor, &block)
+        hash = constructor.to_hash
+
+        self.default = hash.default if hash.default
+        self.default_proc = hash.default_proc if hash.default_proc
+      else
+        super()
+      end
+    end
+
+    def update(other_hash)
+      if other_hash.is_a? Hash
+        super(other_hash)
+      else
+        other_hash.to_hash.each_pair do |key, value|
+          if block_given?
+            value = yield(key, value)
+          end
+          self[key] = value
+        end
+        self
+      end
+    end
+
+    def []=(key, value)
+      super(key.to_sym, value)
+    end
+
+    def [](key)
+      super(key.to_sym)
+    end
+
+    def method_missing(name, *args)
+      name_string = name.to_s
+      if name_string.chomp!('=')
+        self[name_string] = args.first
+      else
+        bangs = name_string.chomp!('!')
+
+        if bangs
+          value = fetch(name_string.to_sym)
+          raise(RuntimeError.new("#{name_string} is blank.")) if value.nil? || value.empty?
+          value
+        else
+          self[name_string]
+        end
+      end
+    end
+
+    def except(*keys)
+      dup.except!(*keys)
+    end
+
+    def except!(*keys)
+      keys.each { |key| delete(key) }
+      self
+    end
+
+
+    def respond_to_missing?(name, include_private)
+      true
+    end
+  end
+
+
+  # +InheritableOptions+ provides a constructor to build an +OrderedOptions+
+  # hash inherited from another hash.
+  #
+  # Use this if you already have some hash and you want to create a new one based on it.
+  #
+  #   h = ActiveSupport::InheritableOptions.new({ girl: 'Mary', boy: 'John' })
+  #   h.girl # => 'Mary'
+  #   h.boy  # => 'John'
+  class InheritableOptions < Turnout::OrderedOptions
+    def initialize(parent = nil)
+      if parent.kind_of?(Turnout::OrderedOptions)
+        # use the faster _get when dealing with OrderedOptions
+        super(parent) {|key,value| parent._get(key) }
+      elsif parent
+        super(parent) { |key, value| parent[key] }
+      else
+        super(parent)
+      end
+    end
+
+    def inheritable_copy
+      self.class.new(self)
+    end
+  end
+end

data/lib/turnout/rake_tasks.rb

@@ -0,0 +1,3 @@
+# This file is meant to be used to include rake tasks in a Rakefile by adding
+# require 'turnout/rake_tasks'
+Dir[File.expand_path('../../tasks/*.rake', __FILE__)].each { |ext| import ext }

data/lib/turnout/request.rb

@@ -0,0 +1,35 @@
+require 'ipaddr'
+
+module Turnout
+  class Request
+    def initialize(env)
+      @rack_request = Rack::Request.new(env)
+    end
+
+    def allowed?(settings)
+      path_allowed?(settings.allowed_paths) || ip_allowed?(settings.allowed_ips)
+    end
+
+    private
+
+    attr_reader :rack_request
+
+    def path_allowed?(allowed_paths)
+      allowed_paths.any? do |allowed_path|
+        rack_request.path =~ Regexp.new(allowed_path)
+      end
+    end
+
+    def ip_allowed?(allowed_ips)
+      begin
+        ip = IPAddr.new(rack_request.ip.to_s)
+      rescue ArgumentError
+        return false
+      end
+
+      allowed_ips.any? do |allowed_ip|
+        IPAddr.new(allowed_ip).include? ip
+      end
+    end
+  end
+end

data/lib/turnout/version.rb

@@ -0,0 +1,3 @@
+module Turnout
+  VERSION = '3.0.0'.freeze
+end

data/lib/turnout.rb

@@ -0,0 +1,15 @@
+module Turnout
+  require 'turnout/configuration'
+  require 'turnout/maintenance_file'
+  require 'turnout/maintenance_page'
+  require 'turnout/request'
+  require 'turnout/engine' if defined? Rails
+
+  def self.configure
+    yield config
+  end
+
+  def self.config
+    @config ||= Configuration.new
+  end
+end

data/public/maintenance.html

@@ -0,0 +1,69 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="UTF-8">
+    <title>Down for Maintenance</title>
+
+    <style type="text/css">
+
+      *{
+        font-family: Arial, Helvetica, sans-serif;
+      }
+
+      body{
+        margin: 0;
+        background-color: #fff;
+      }
+
+      #page{
+        position: relative;
+        width: 550px;
+        margin: 200px auto;
+        padding: 75px 0;
+        text-align: center;
+        background-color: #eaeaea;
+        border: solid 1px #ccc;
+        border-top: solid 10px #666;
+        -moz-box-shadow: inset 0 2px 10px #ccc;
+        -webkit-box-shadow: inset 0 2px 10px #ccc;
+        box-shadow: inset 0 2px 10px #ccc;
+      }
+
+      header, #body{
+        width: 400px;
+        margin: 0 auto;
+      }
+
+      h1{
+        margin: 0;
+        color: #CC3601;
+        font-size: 26pt;
+        border-bottom: solid 4px #666;
+      }
+
+      #reason{
+        margin: 10px 0;
+        color: #333;
+      }
+
+    </style>
+
+  </head>
+  <body>
+
+    <section id="page">
+
+      <header>
+        <h1>Down for Maintenance</h1>
+      </header>
+
+      <section id="body">
+        <div>
+          {{ reason }}
+        </div>
+      </section>
+
+    </section>
+
+  </body>
+</html>

data/public/maintenance.html.erb

@@ -0,0 +1,69 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="UTF-8">
+    <title>Down for Maintenance</title>
+
+    <style type="text/css">
+
+      *{
+        font-family: Arial, Helvetica, sans-serif;
+      }
+
+      body{
+        margin: 0;
+        background-color: #fff;
+      }
+
+      #page{
+        position: relative;
+        width: 550px;
+        margin: 200px auto;
+        padding: 75px 0;
+        text-align: center;
+        background-color: #eaeaea;
+        border: solid 1px #ccc;
+        border-top: solid 10px #666;
+        -moz-box-shadow: inset 0 2px 10px #ccc;
+        -webkit-box-shadow: inset 0 2px 10px #ccc;
+        box-shadow: inset 0 2px 10px #ccc;
+      }
+
+      header, #body{
+        width: 400px;
+        margin: 0 auto;
+      }
+
+      h1{
+        margin: 0;
+        color: #CC3601;
+        font-size: 26pt;
+        border-bottom: solid 4px #666;
+      }
+
+      #reason{
+        margin: 10px 0;
+        color: #333;
+      }
+
+    </style>
+
+  </head>
+  <body>
+
+    <section id="page">
+
+      <header>
+        <h1>Down for Maintenance</h1>
+      </header>
+
+      <section id="body">
+        <div>
+          <%= reason %>
+        </div>
+      </section>
+
+    </section>
+
+  </body>
+</html>

data/public/maintenance.json

@@ -0,0 +1 @@
+{"error":"Service Unavailable","message":{{ reason }}}