rack-traffic-signal 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 40eb82af455e2ed57cffd1166baf1b1058cfe0f5
+  data.tar.gz: 5cac4ded4b7c77c1ac763e3e917bcb10a7ca79cc
+SHA512:
+  metadata.gz: 9fd40d70a8f47adff5c5b99b4284d6e6d4ca106f82146f1ba93f3649da019dc8ff95fb17244a811461576ae20061db1b04d5f42b114d085684f103127e0fe9bb
+  data.tar.gz: 05ffe11ec02523b1c9db0a2b8ced2fcb701491c359db7c56a27cc905357bc94a042767ee69f93221897094988473fd86f96e01736c2e598b5bf79fee0ab41833

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2.4
+before_install: gem install bundler -v 1.14.6

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 keigo_yamamoto
+
+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,127 @@
+# Rack::TrafficSignal
+
+Rack::TrafficSignal is a Rack middleware to make application in maintenance mode.
+You can make part of application in maintenance mode, and use different http status and response body.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rack-traffic-signal'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rack-traffic-signal
+
+If you are installing this gem to Rails application, run:
+
+    $ rails g rack_traffic_signal:install
+
+## Usage
+
+### Rails
+
+Generator places initializer template and sample maintenance page.
+
+Modify `config/initializers/rack_traffic_signal.rb` .
+
+And add below to your `application.rb`
+
+```ruby:application.rb
+require 'rack/traffic_signal'
+...
+  config.middleware.use(Rack::TrafficSignal::Middleware)
+...
+```
+
+### Not Rails
+
+Insert Rack::TrafficSignal::Middleware to Middleware stack manually, and create setting script.
+
+## Setting
+
+```ruby
+Rack::TrafficSignal.setup do |config|
+  # This config is used to internal_access? method.
+  # Only add path to this option, mantenance mode is not skipped.
+  config.internal_ips = ['192.168.1.1/25']
+
+  # This config is used to skip_path? method.
+  # Only add path to this option, mantenance mode is not skipped.
+  config.skip_paths = [/^\/users\/12345/]
+
+  # Default setting
+  config.default_status = 503
+  config.default_content_type = 'application/json'
+  config.default_body = { error: 'error' }.to_json
+
+  # Maintenance group settings
+  # Maintenance group defined as :<resource>_<action>
+
+  # If path defined by String, maintenance mode will be applied path is match rigidly.
+  # '/users' does not make maintenance mode '/users/foo'.
+
+  # If multiple setting is appliable, more general setting will be priored.
+  # %{/} has higher priority than %{/users/\/d+/foo/bar}
+  config.maintenance_group =   {
+    # <resource>: {
+    #   <action>: [
+    #     { methods: [:get, :post], path: <path_to_maintenance>}
+    #   ]
+    # }
+    users: {
+      register: [
+        { methods: [:get], path: "/users/new"},
+        { methods: [:post], path: "/users" }
+      ],
+      update: [
+        { methods: [:put], path: %r{/users/\d+}}
+      ]
+    }
+  }
+
+  # Block to judge whether requested page/api is under maintenance.
+  # Returns Array<Symbol>
+  # If status array include...
+  #   :all => all of maintenance groups are enabled.
+  #   :<resource>_all => maintenance groups under resource
+  #     ex) :users_all => users_register and users_update are in under maintenance
+  #  :<resource>_<action> => maintenance group matches is in under maintenance
+  config.maintenance_status_by do
+    ENV['MAINTENANCE_STATUS'] # [:users_register, :users_update]
+  end
+
+  # Block to judge whether maintenance mode should be skipped.
+  # For example, you can skip maintenance mode with specific path or internal access.
+  config.skip_by do |env|
+    Rack::TrafficSignal.skip_path?(env) || Rack::TrafficSignal.internal_access?
+  end
+
+  # Block to judge whether maintenance mode should be skipped with warning.
+  # For example, you can skip maintenance mode with specific path or internal access.
+  # Warn by add 'X-RACK-TRAFFIC-SIGNAL-MAINTENANCE' to response header.
+  config.skip_with_warning_by do |env|
+    Rack::TrafficSignal.skip_path?(env) || Rack::TrafficSignal.internal_access?
+  end
+end
+```
+
+## Contributing
+
+1. Fork it
+1. Create your feature branch (git checkout -b my-new-feature)
+1. Commit your changes (git commit -am 'Add some feature')
+1. Push to the branch (git push origin my-new-feature)
+1. Create new Pull Request
+
+## 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/lib/generators/rack_traffic_signal/install_generator.rb

@@ -0,0 +1,13 @@
+module RackTrafficSignal
+  module Generators
+    class InstallGenerator < ::Rails::Generators::Base
+      source_root File.expand_path('../../templates', __FILE__)
+      desc 'Install Rack::TrafficSignal to Rails application'
+
+      def install
+        template 'initializer.rb', 'config/initializers/rack_traffic_signal.rb'
+        template '503.html', 'public/503.html'
+      end
+    end
+  end
+end

data/lib/generators/templates/503.html

@@ -0,0 +1,9 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>This page is under maintenance</title>
+  </head>
+  <body>
+    This page is under maintenance
+  </body>
+</html>

data/lib/generators/templates/initializer.rb

@@ -0,0 +1,37 @@
+# -*- coding: utf-8 -*-
+
+Rack::TrafficSignal.setup do |config|
+  # config.internal_ips = []
+  # config.default_status = 503
+  # config.default_content_type = 'application/json'
+  # require 'json'
+  # config.default_body = '{}'.to_json
+  # config.maintenance_group = {
+  #     users: {
+  #       read: [
+  #         { methods: [:get], path: '/api/users', status: 404 },
+  #         { methods: [:get], path: %r{/api/users/\d+}, status: 404, content_type: 'application/json' },
+  #       ],
+  #       write: [
+  #         { methods: [:post], path: '/api/users' body: { error: 'maintenance mode' }.to_json },
+  #         { methods: [:put, :delete], path: '%r{/api/users/\d+}' }
+  #       ]
+  #     },
+  #     articles: {
+  #       read: [
+  #         { methods: [:get], path: '/api/articles' },
+  #         { methods: [:get], path: %r{/api/articles/\d+} },
+  #       ],
+  #       write: [
+  #         { methods: [:post], path: '/api/articles' },
+  #         { methods: [:put, :delete], path: '%r{/api/articles/\d+}' }
+  #       ]
+  #     },
+  #   }
+  # config.maintenance_status_by do
+  #   [:users_all, :articles_write]
+  # end
+  # config.skip_by do |env|
+  #   false
+  # end
+end

data/lib/rack/traffic_signal/config.rb

@@ -0,0 +1,82 @@
+require 'ipaddress'
+
+module Rack
+  module TrafficSignal
+    class Config
+
+      attr_reader   :maintenance_group
+      attr_accessor :internal_ips,
+                    :skip_paths,
+                    :default_status,
+                    :default_content_type,
+                    :default_body
+
+      def initialize
+        @internal_ips = []
+        @maintenance_group = { }
+        @default_status = 503
+        @default_content_type = 'application/json'
+        @default_body = ''
+        @skip_paths = [/^\/assets/]
+        @maintenance_status_proc = ->{ [] }
+        @skip_proc = ->(env){ false }
+        @skip_with_warning_proc = ->(env){ false }
+      end
+
+      def maintenance_group=(mg)
+        raise Rack::TrafficSignal::Exceptions::InvalidMaintenanceGroup unless valid_maintenance_group?(mg)
+        @maintenance_group = mg
+      end
+
+      def maintenance_status_by(&block)
+        @maintenance_status_proc = block
+      end
+
+      def maintenance_status
+        @maintenance_status_proc.call.tap do |status|
+          raise Rack::TrafficSignal::Exceptions::InvalidMaintenanceStatus unless status.is_a? Array
+          raise Rack::TrafficSignal::Exceptions::InvalidMaintenanceStatus unless status.all? do |state|
+            state.is_a?(Symbol) && (state == :all || state.to_s =~ /\A[A-Za-z0-9]+_[A-Za-z0-9]+\z/)
+          end
+        end
+      end
+
+      def skip_by(&block)
+        @skip_proc = block
+      end
+
+      def skip?(env)
+        @skip_proc.call(env)
+      end
+
+      def skip_with_warning_by(&block)
+        @skip_with_warning_proc = block
+      end
+
+      def skip_with_warning?(env)
+        @skip_with_warning_proc.call(env)
+      end
+
+      private
+      def valid_maintenance_group?(mg)
+        return false unless mg.is_a? Hash
+
+        mg.values.each do |group|
+          return false unless group.is_a? Hash
+          group.values.each do |igroup|
+            return false unless igroup.is_a? Array
+            igroup.each do |setting|
+              return false unless setting.key?(:methods)
+              return false unless setting.key? :path
+            end
+          end
+        end
+
+        true
+
+      rescue
+        false
+      end
+    end
+  end
+end

data/lib/rack/traffic_signal/exceptions.rb

@@ -0,0 +1,8 @@
+module Rack
+  module TrafficSignal
+    module Exceptions
+      class InvalidMaintenanceGroup < StandardError; end
+      class InvalidMaintenanceStatus < StandardError; end
+    end
+  end
+end

data/lib/rack/traffic_signal/middleware.rb

@@ -0,0 +1,100 @@
+require 'json'
+
+module Rack
+  module TrafficSignal
+    class Middleware
+      def initialize(app)
+        @app = app
+      end
+
+      def call(env)
+        return @app.call(env) if config.skip?(env)
+        method = env['REQUEST_METHOD'].downcase.to_sym
+        path = env['PATH_INFO']
+        path = path.chop if path != '/' && path[-1] == '/'
+
+        applied_config = maintenance_application(method, path)
+
+        if applied_config
+          if config.skip_with_warning?(env)
+            @app.call(env).tap do |status, headers, body|
+              headers['X-RACK-TRAFFIC-SIGNAL-MAINTENENCE'] = '1'
+            end
+          else
+            build_response(applied_config)
+          end
+        else
+          @app.call(env)
+        end
+      end
+
+      private
+
+      def build_response(applied_config)
+        status = applied_config[:status] ? applied_config[:status] : config.default_status
+        content_type = applied_config[:content_type] ? applied_config[:content_type] : config.default_content_type
+        body = applied_config[:body] ? applied_config[:body] : config.default_body
+        header = { "Content-Type" => content_type, 'Content-Length' => body.bytesize.to_s }
+
+        [status, header, [body]]
+      end
+
+      def config_appliable?(config, method, path)
+        path_match = if config[:path].is_a?(String)
+            path == config[:path]
+          elsif config[:path].is_a? Regexp
+            path.match(config[:path])
+          else
+            false
+          end
+
+        path_match && config[:methods].include?(method)
+      end
+
+      def path_length(path)
+        if path.is_a? String
+          path.split('/').length
+        elsif path.is_a? Regexp
+          path.source.split('/').length
+        end
+      end
+
+      def maintenance_application(method, path)
+        enabled_maintenance_mode = config.maintenance_status
+
+        enabled_cfg = if enabled_maintenance_mode.include? :all
+            config.maintenance_group.values.inject([]) do |a, p|
+              a + p.values
+            end
+          else
+            enabled_maintenance_mode.inject([]) do |a, mode|
+              resource, action = *mode.to_s.split('_').map(&:to_sym)
+              if action == :all
+                a + config.maintenance_group[resource].values
+              else
+                a + config.maintenance_group[resource][action]
+              end
+            end
+          end
+
+        enabled_cfg.flatten!
+
+        applied = enabled_cfg
+          .uniq
+          .select { |c| config_appliable?(c, method, path) }
+          .sort { |a, b| path_length(a[:path]) <=> path_length(b[:path]) }
+        if applied.length > 0
+          return applied[0]
+        else
+          return nil
+        end
+      rescue NoMethodError
+        raise Rack::TrafficSignal::Exceptions::InvalidMaintenanceGroup
+      end
+
+      def config
+        Rack::TrafficSignal.config
+      end
+    end
+  end
+end

data/lib/rack/traffic_signal/railtie.rb

@@ -0,0 +1,9 @@
+module Rack
+  module TrafficSignal
+    class Railtie < ::Rails::Railtie
+      initializer 'insert_middleware' do |app|
+        app.config.middleware.use Rack::TrafficSignal::Middleware
+      end
+    end
+  end
+end

data/lib/rack/traffic_signal/version.rb

@@ -0,0 +1,5 @@
+module Rack
+  module TrafficSignal
+    VERSION = "0.1.2"
+  end
+end

data/lib/rack/traffic_signal.rb

@@ -0,0 +1,44 @@
+require 'rack/traffic_signal/version'
+require 'rack/traffic_signal/config'
+require 'rack/traffic_signal/exceptions'
+require 'rack/traffic_signal/middleware'
+require 'rack/traffic_signal/railtie' if defined? Rails
+
+module Rack
+  module TrafficSignal
+    def self.setup
+      yield(config)
+    end
+
+    def self.config
+      @config ||= Config.new
+    end
+
+    def self.internal_access?(env)
+      remote_ip = IPAddress(request_from(env))
+      config.internal_ips
+        .map { |internal_ip| IPAddress(internal_ip) }
+        .any? { |internal_ip| internal_ip.include?(remote_ip) if remote_ip.class == internal_ip.class }
+    end
+
+    def self.skip_path?(env)
+      path = env['PATH_INFO']
+      path = path.chop if path[-1] == '/'
+      config.skip_paths.any? do |skip_path|
+        if skip_path.is_a? Regexp
+          path.match(skip_path)
+        elsif skip_path.is_a? String
+          path == skip_path
+        else
+          false
+        end
+      end
+    end
+
+    private
+    def self.request_from(env)
+      return env['REMOTE_ADDR'] unless env['HTTP_X_FORWARDED_FOR']
+      env['HTTP_X_FORWARDED_FOR'].split(/,/)[0].strip
+    end
+  end
+end

data/lib/rack-traffic_signal.rb

@@ -0,0 +1 @@
+require 'rack/traffic_signal'

data/rack-traffic-signal.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rack/traffic_signal/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rack-traffic-signal"
+  spec.version       = Rack::TrafficSignal::VERSION
+  spec.authors       = ["keigo yamamoto"]
+  spec.email         = ["k5.trismegistus@gmail.com"]
+
+  spec.summary       = 'Traffic signal of rack application'
+  spec.description   = 'Make your app maintenance mode. You can prohibit all/a part of external access'
+  spec.homepage      = "https://github.com/k5trismegistus/rack-traffic-signal"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "ipaddress"
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "rack-test"
+end

metadata

@@ -0,0 +1,147 @@
+--- !ruby/object:Gem::Specification
+name: rack-traffic-signal
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- keigo yamamoto
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-07-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ipaddress
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !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: 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: rack-test
+  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'
+description: Make your app maintenance mode. You can prohibit all/a part of external
+  access
+email:
+- k5.trismegistus@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/generators/rack_traffic_signal/install_generator.rb
+- lib/generators/templates/503.html
+- lib/generators/templates/initializer.rb
+- lib/rack-traffic_signal.rb
+- lib/rack/traffic_signal.rb
+- lib/rack/traffic_signal/config.rb
+- lib/rack/traffic_signal/exceptions.rb
+- lib/rack/traffic_signal/middleware.rb
+- lib/rack/traffic_signal/railtie.rb
+- lib/rack/traffic_signal/version.rb
+- rack-traffic-signal.gemspec
+homepage: https://github.com/k5trismegistus/rack-traffic-signal
+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: Traffic signal of rack application
+test_files: []