monzenbarai 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: dc45ab07d6e6fcd37543e8e352d82a57d4d6625b
+  data.tar.gz: 8e941ddc6dbd3694ac06c7841062eed7054f2f25
+SHA512:
+  metadata.gz: 3e886f4f532a986515f20b39af7cf9aae5ae14defa5c87c675df067e75323badf3d1e70471d19129379676ee460277f48c0f18d84858f38fecc299907e8e28dd
+  data.tar.gz: 0b2594f2c1b6fdfa4d4a506fe4bcbabe18378d8265c39a4b61aec9d931fcc196834177ed23a0542103ff25a87edd03df8a21262e9d8d1d7b9e662b23a34c64de

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at hisaki.kanno@litalico.co.jp. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in monzenbarai.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,22 @@
+PATH
+  remote: .
+  specs:
+    monzenbarai (0.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    rake (10.5.0)
+    thor (0.20.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  monzenbarai!
+  rake (~> 10.0)
+  thor
+
+BUNDLED WITH
+   1.16.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 hisaki-kanno
+
+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,71 @@
+# Monzenbarai
+
+Monzenbarai is simple Rack middleware that allows you to easily put your app in maintenance mode. 
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'monzenbarai'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install monzenbarai
+
+## Usage
+
+### Configure
+
+Sinatra 
+```ruby
+require 'monzenbarai'
+
+Monzenbarai.configure do |config|
+  config.expel = lambda do |env|
+    return false if env['PATH_INFO'] == '/allowed'
+    true
+  end
+end
+
+use Monzenbarai
+```
+
+Ruby on Rails
+```ruby:config/application.rb
+config.middleware.use Monzenbarai
+```
+
+```ruby:config/initializers/monzenbarai.rb
+Monzenbarai.configure do |config|
+  config.expel = lambda do |env|
+    return false if env['PATH_INFO'] == '/allowed'
+    true
+  end
+end
+```
+
+If `expel` block returns true, Monzenbarai renders maintenance page.  
+By default, `expel` always returns only `true`.
+
+`env` argument is [Rack environment](https://www.rubydoc.info/github/rack/rack/master/file/SPEC).
+
+### Start maintenance mode
+Execute `monzenbarai start` command.
+
+### End maintenance mode
+Execute `monzenbarai end` command.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/takuan-oishii/monzenbarai.  
+This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "monzenbarai"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/example/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+gem 'sinatra'
+gem 'monzenbarai'

data/example/Gemfile.lock

@@ -0,0 +1,24 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    monzenbarai (0.0.1)
+    mustermann (1.0.3)
+    rack (2.0.5)
+    rack-protection (2.0.4)
+      rack
+    sinatra (2.0.4)
+      mustermann (~> 1.0)
+      rack (~> 2.0)
+      rack-protection (= 2.0.4)
+      tilt (~> 2.0)
+    tilt (2.0.8)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  monzenbarai
+  sinatra
+
+BUNDLED WITH
+   1.16.2

data/example/app.rb

@@ -0,0 +1,19 @@
+require 'sinatra'
+require 'monzenbarai'
+
+Monzenbarai.configure do |config|
+  config.expel = lambda do |env|
+    return false if env['PATH_INFO'] == '/allowed'
+    true
+  end
+end
+
+use Monzenbarai
+
+get '/' do
+  'this path is not allowed'
+end
+
+get '/allowed' do
+  'this path is allowed'
+end

data/exe/monzenbarai

@@ -0,0 +1,23 @@
+require 'monzenbarai'
+require 'fileutils'
+require 'thor'
+
+module Monzenbarai
+  class CLI < Thor
+    desc 'start', 'start maintenance mode'
+
+    def start
+      FileUtils.touch Monzenbarai.configuration.trigger_file
+      puts 'monzenbarai maintenance was started'
+    end
+
+    desc 'end', 'end maintenance mode'
+
+    def end
+      FileUtils.rm Monzenbarai.configuration.trigger_file
+      puts 'monzenbarai maintenance was ended'
+    end
+  end
+end
+
+Monzenbarai::CLI.start(ARGV)

data/lib/monzenbarai/configuration.rb

@@ -0,0 +1,13 @@
+module Monzenbarai
+  class Configuration
+    attr_accessor :expel
+    attr_accessor :status_code
+    attr_accessor :trigger_file
+
+    def initialize
+      self.expel        = lambda { |_env| true }
+      self.status_code  = 503
+      self.trigger_file = './monzenbarai.trigger'
+    end
+  end
+end

data/lib/monzenbarai/context.rb

@@ -0,0 +1,31 @@
+require 'fileutils'
+
+module Monzenbarai
+  class Context
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      if render_maintenance?(env)
+        [configuration.status_code, { 'Content-Type' => 'text/html' }, ['<h1>maintenance</h1>']]
+      else
+        @app.call env
+      end
+    end
+
+    private
+
+    def render_maintenance?(env)
+      maintenance_mode? && configuration.expel.call(env)
+    end
+
+    def maintenance_mode?
+      File.exist? configuration.trigger_file
+    end
+
+    def configuration
+      Monzenbarai.configuration
+    end
+  end
+end

data/lib/monzenbarai/version.rb

@@ -0,0 +1,3 @@
+module Monzenbarai
+  VERSION = '0.0.2'
+end

data/lib/monzenbarai.rb

@@ -0,0 +1,20 @@
+require 'monzenbarai/version'
+
+module Monzenbarai
+  class << self
+    def new(app)
+      Context.new(app)
+    end
+
+    def configure
+      yield configuration
+    end
+
+    def configuration
+      @configuration ||= Monzenbarai::Configuration.new
+    end
+  end
+
+  autoload :Configuration, 'monzenbarai/configuration'
+  autoload :Context, 'monzenbarai/context'
+end

data/monzenbarai.gemspec

@@ -0,0 +1,35 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'monzenbarai/version'
+
+Gem::Specification.new do |spec|
+  spec.name    = 'monzenbarai'
+  spec.version = Monzenbarai::VERSION
+  spec.authors = ['takuan-oishii']
+  spec.email   = ['met.enkephalin@gmail.com']
+
+  spec.summary     = %q{simple rack app maintenance gem}
+  spec.description = %q{Monzenbarai is simple Rack middleware that allows you to easily put your app in maintenance mode}
+  spec.homepage    = 'https://github.com/takuan-oishii/monzenbarai'
+  spec.license     = 'MIT'
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    # spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against public gem pushes.'
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = ['monzenbarai']
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'thor'
+  # spec.add_development_dependency 'rspec', '~> '
+end

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification
+name: monzenbarai
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- takuan-oishii
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-10-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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: thor
+  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: Monzenbarai is simple Rack middleware that allows you to easily put your
+  app in maintenance mode
+email:
+- met.enkephalin@gmail.com
+executables:
+- monzenbarai
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- example/Gemfile
+- example/Gemfile.lock
+- example/app.rb
+- exe/monzenbarai
+- lib/monzenbarai.rb
+- lib/monzenbarai/configuration.rb
+- lib/monzenbarai/context.rb
+- lib/monzenbarai/version.rb
+- monzenbarai.gemspec
+homepage: https://github.com/takuan-oishii/monzenbarai
+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.6.14.1
+signing_key: 
+specification_version: 4
+summary: simple rack app maintenance gem
+test_files: []