monzenbarai 0.0.2
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/.gitignore +8 -0
- data/.travis.yml +5 -0
- data/CODE_OF_CONDUCT.md +74 -0
- data/Gemfile +6 -0
- data/Gemfile.lock +22 -0
- data/LICENSE.txt +21 -0
- data/README.md +71 -0
- data/Rakefile +2 -0
- data/bin/console +14 -0
- data/bin/setup +8 -0
- data/example/Gemfile +8 -0
- data/example/Gemfile.lock +24 -0
- data/example/app.rb +19 -0
- data/exe/monzenbarai +23 -0
- data/lib/monzenbarai/configuration.rb +13 -0
- data/lib/monzenbarai/context.rb +31 -0
- data/lib/monzenbarai/version.rb +3 -0
- data/lib/monzenbarai.rb +20 -0
- data/monzenbarai.gemspec +35 -0
- metadata +107 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA1:
|
3
|
+
metadata.gz: dc45ab07d6e6fcd37543e8e352d82a57d4d6625b
|
4
|
+
data.tar.gz: 8e941ddc6dbd3694ac06c7841062eed7054f2f25
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: 3e886f4f532a986515f20b39af7cf9aae5ae14defa5c87c675df067e75323badf3d1e70471d19129379676ee460277f48c0f18d84858f38fecc299907e8e28dd
|
7
|
+
data.tar.gz: 0b2594f2c1b6fdfa4d4a506fe4bcbabe18378d8265c39a4b61aec9d931fcc196834177ed23a0542103ff25a87edd03df8a21262e9d8d1d7b9e662b23a34c64de
|
data/.gitignore
ADDED
data/.travis.yml
ADDED
data/CODE_OF_CONDUCT.md
ADDED
@@ -0,0 +1,74 @@
|
|
1
|
+
# Contributor Covenant Code of Conduct
|
2
|
+
|
3
|
+
## Our Pledge
|
4
|
+
|
5
|
+
In the interest of fostering an open and welcoming environment, we as
|
6
|
+
contributors and maintainers pledge to making participation in our project and
|
7
|
+
our community a harassment-free experience for everyone, regardless of age, body
|
8
|
+
size, disability, ethnicity, gender identity and expression, level of experience,
|
9
|
+
nationality, personal appearance, race, religion, or sexual identity and
|
10
|
+
orientation.
|
11
|
+
|
12
|
+
## Our Standards
|
13
|
+
|
14
|
+
Examples of behavior that contributes to creating a positive environment
|
15
|
+
include:
|
16
|
+
|
17
|
+
* Using welcoming and inclusive language
|
18
|
+
* Being respectful of differing viewpoints and experiences
|
19
|
+
* Gracefully accepting constructive criticism
|
20
|
+
* Focusing on what is best for the community
|
21
|
+
* Showing empathy towards other community members
|
22
|
+
|
23
|
+
Examples of unacceptable behavior by participants include:
|
24
|
+
|
25
|
+
* The use of sexualized language or imagery and unwelcome sexual attention or
|
26
|
+
advances
|
27
|
+
* Trolling, insulting/derogatory comments, and personal or political attacks
|
28
|
+
* Public or private harassment
|
29
|
+
* Publishing others' private information, such as a physical or electronic
|
30
|
+
address, without explicit permission
|
31
|
+
* Other conduct which could reasonably be considered inappropriate in a
|
32
|
+
professional setting
|
33
|
+
|
34
|
+
## Our Responsibilities
|
35
|
+
|
36
|
+
Project maintainers are responsible for clarifying the standards of acceptable
|
37
|
+
behavior and are expected to take appropriate and fair corrective action in
|
38
|
+
response to any instances of unacceptable behavior.
|
39
|
+
|
40
|
+
Project maintainers have the right and responsibility to remove, edit, or
|
41
|
+
reject comments, commits, code, wiki edits, issues, and other contributions
|
42
|
+
that are not aligned to this Code of Conduct, or to ban temporarily or
|
43
|
+
permanently any contributor for other behaviors that they deem inappropriate,
|
44
|
+
threatening, offensive, or harmful.
|
45
|
+
|
46
|
+
## Scope
|
47
|
+
|
48
|
+
This Code of Conduct applies both within project spaces and in public spaces
|
49
|
+
when an individual is representing the project or its community. Examples of
|
50
|
+
representing a project or community include using an official project e-mail
|
51
|
+
address, posting via an official social media account, or acting as an appointed
|
52
|
+
representative at an online or offline event. Representation of a project may be
|
53
|
+
further defined and clarified by project maintainers.
|
54
|
+
|
55
|
+
## Enforcement
|
56
|
+
|
57
|
+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
58
|
+
reported by contacting the project team at hisaki.kanno@litalico.co.jp. All
|
59
|
+
complaints will be reviewed and investigated and will result in a response that
|
60
|
+
is deemed necessary and appropriate to the circumstances. The project team is
|
61
|
+
obligated to maintain confidentiality with regard to the reporter of an incident.
|
62
|
+
Further details of specific enforcement policies may be posted separately.
|
63
|
+
|
64
|
+
Project maintainers who do not follow or enforce the Code of Conduct in good
|
65
|
+
faith may face temporary or permanent repercussions as determined by other
|
66
|
+
members of the project's leadership.
|
67
|
+
|
68
|
+
## Attribution
|
69
|
+
|
70
|
+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
|
71
|
+
available at [http://contributor-covenant.org/version/1/4][version]
|
72
|
+
|
73
|
+
[homepage]: http://contributor-covenant.org
|
74
|
+
[version]: http://contributor-covenant.org/version/1/4/
|
data/Gemfile
ADDED
data/Gemfile.lock
ADDED
@@ -0,0 +1,22 @@
|
|
1
|
+
PATH
|
2
|
+
remote: .
|
3
|
+
specs:
|
4
|
+
monzenbarai (0.0.1)
|
5
|
+
|
6
|
+
GEM
|
7
|
+
remote: https://rubygems.org/
|
8
|
+
specs:
|
9
|
+
rake (10.5.0)
|
10
|
+
thor (0.20.0)
|
11
|
+
|
12
|
+
PLATFORMS
|
13
|
+
ruby
|
14
|
+
|
15
|
+
DEPENDENCIES
|
16
|
+
bundler (~> 1.16)
|
17
|
+
monzenbarai!
|
18
|
+
rake (~> 10.0)
|
19
|
+
thor
|
20
|
+
|
21
|
+
BUNDLED WITH
|
22
|
+
1.16.2
|
data/LICENSE.txt
ADDED
@@ -0,0 +1,21 @@
|
|
1
|
+
The MIT License (MIT)
|
2
|
+
|
3
|
+
Copyright (c) 2018 hisaki-kanno
|
4
|
+
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
7
|
+
in the Software without restriction, including without limitation the rights
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
10
|
+
furnished to do so, subject to the following conditions:
|
11
|
+
|
12
|
+
The above copyright notice and this permission notice shall be included in
|
13
|
+
all copies or substantial portions of the Software.
|
14
|
+
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
21
|
+
THE SOFTWARE.
|
data/README.md
ADDED
@@ -0,0 +1,71 @@
|
|
1
|
+
# Monzenbarai
|
2
|
+
|
3
|
+
Monzenbarai is simple Rack middleware that allows you to easily put your app in maintenance mode.
|
4
|
+
|
5
|
+
## Installation
|
6
|
+
|
7
|
+
Add this line to your application's Gemfile:
|
8
|
+
|
9
|
+
```ruby
|
10
|
+
gem 'monzenbarai'
|
11
|
+
```
|
12
|
+
|
13
|
+
And then execute:
|
14
|
+
|
15
|
+
$ bundle
|
16
|
+
|
17
|
+
Or install it yourself as:
|
18
|
+
|
19
|
+
$ gem install monzenbarai
|
20
|
+
|
21
|
+
## Usage
|
22
|
+
|
23
|
+
### Configure
|
24
|
+
|
25
|
+
Sinatra
|
26
|
+
```ruby
|
27
|
+
require 'monzenbarai'
|
28
|
+
|
29
|
+
Monzenbarai.configure do |config|
|
30
|
+
config.expel = lambda do |env|
|
31
|
+
return false if env['PATH_INFO'] == '/allowed'
|
32
|
+
true
|
33
|
+
end
|
34
|
+
end
|
35
|
+
|
36
|
+
use Monzenbarai
|
37
|
+
```
|
38
|
+
|
39
|
+
Ruby on Rails
|
40
|
+
```ruby:config/application.rb
|
41
|
+
config.middleware.use Monzenbarai
|
42
|
+
```
|
43
|
+
|
44
|
+
```ruby:config/initializers/monzenbarai.rb
|
45
|
+
Monzenbarai.configure do |config|
|
46
|
+
config.expel = lambda do |env|
|
47
|
+
return false if env['PATH_INFO'] == '/allowed'
|
48
|
+
true
|
49
|
+
end
|
50
|
+
end
|
51
|
+
```
|
52
|
+
|
53
|
+
If `expel` block returns true, Monzenbarai renders maintenance page.
|
54
|
+
By default, `expel` always returns only `true`.
|
55
|
+
|
56
|
+
`env` argument is [Rack environment](https://www.rubydoc.info/github/rack/rack/master/file/SPEC).
|
57
|
+
|
58
|
+
### Start maintenance mode
|
59
|
+
Execute `monzenbarai start` command.
|
60
|
+
|
61
|
+
### End maintenance mode
|
62
|
+
Execute `monzenbarai end` command.
|
63
|
+
|
64
|
+
## Contributing
|
65
|
+
|
66
|
+
Bug reports and pull requests are welcome on GitHub at https://github.com/takuan-oishii/monzenbarai.
|
67
|
+
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.
|
68
|
+
|
69
|
+
## License
|
70
|
+
|
71
|
+
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
|
data/Rakefile
ADDED
data/bin/console
ADDED
@@ -0,0 +1,14 @@
|
|
1
|
+
#!/usr/bin/env ruby
|
2
|
+
|
3
|
+
require "bundler/setup"
|
4
|
+
require "monzenbarai"
|
5
|
+
|
6
|
+
# You can add fixtures and/or initialization code here to make experimenting
|
7
|
+
# with your gem easier. You can also use a different console, if you like.
|
8
|
+
|
9
|
+
# (If you use this, don't forget to add pry to your Gemfile!)
|
10
|
+
# require "pry"
|
11
|
+
# Pry.start
|
12
|
+
|
13
|
+
require "irb"
|
14
|
+
IRB.start(__FILE__)
|
data/bin/setup
ADDED
data/example/Gemfile
ADDED
@@ -0,0 +1,24 @@
|
|
1
|
+
GEM
|
2
|
+
remote: https://rubygems.org/
|
3
|
+
specs:
|
4
|
+
monzenbarai (0.0.1)
|
5
|
+
mustermann (1.0.3)
|
6
|
+
rack (2.0.5)
|
7
|
+
rack-protection (2.0.4)
|
8
|
+
rack
|
9
|
+
sinatra (2.0.4)
|
10
|
+
mustermann (~> 1.0)
|
11
|
+
rack (~> 2.0)
|
12
|
+
rack-protection (= 2.0.4)
|
13
|
+
tilt (~> 2.0)
|
14
|
+
tilt (2.0.8)
|
15
|
+
|
16
|
+
PLATFORMS
|
17
|
+
ruby
|
18
|
+
|
19
|
+
DEPENDENCIES
|
20
|
+
monzenbarai
|
21
|
+
sinatra
|
22
|
+
|
23
|
+
BUNDLED WITH
|
24
|
+
1.16.2
|
data/example/app.rb
ADDED
@@ -0,0 +1,19 @@
|
|
1
|
+
require 'sinatra'
|
2
|
+
require 'monzenbarai'
|
3
|
+
|
4
|
+
Monzenbarai.configure do |config|
|
5
|
+
config.expel = lambda do |env|
|
6
|
+
return false if env['PATH_INFO'] == '/allowed'
|
7
|
+
true
|
8
|
+
end
|
9
|
+
end
|
10
|
+
|
11
|
+
use Monzenbarai
|
12
|
+
|
13
|
+
get '/' do
|
14
|
+
'this path is not allowed'
|
15
|
+
end
|
16
|
+
|
17
|
+
get '/allowed' do
|
18
|
+
'this path is allowed'
|
19
|
+
end
|
data/exe/monzenbarai
ADDED
@@ -0,0 +1,23 @@
|
|
1
|
+
require 'monzenbarai'
|
2
|
+
require 'fileutils'
|
3
|
+
require 'thor'
|
4
|
+
|
5
|
+
module Monzenbarai
|
6
|
+
class CLI < Thor
|
7
|
+
desc 'start', 'start maintenance mode'
|
8
|
+
|
9
|
+
def start
|
10
|
+
FileUtils.touch Monzenbarai.configuration.trigger_file
|
11
|
+
puts 'monzenbarai maintenance was started'
|
12
|
+
end
|
13
|
+
|
14
|
+
desc 'end', 'end maintenance mode'
|
15
|
+
|
16
|
+
def end
|
17
|
+
FileUtils.rm Monzenbarai.configuration.trigger_file
|
18
|
+
puts 'monzenbarai maintenance was ended'
|
19
|
+
end
|
20
|
+
end
|
21
|
+
end
|
22
|
+
|
23
|
+
Monzenbarai::CLI.start(ARGV)
|
@@ -0,0 +1,13 @@
|
|
1
|
+
module Monzenbarai
|
2
|
+
class Configuration
|
3
|
+
attr_accessor :expel
|
4
|
+
attr_accessor :status_code
|
5
|
+
attr_accessor :trigger_file
|
6
|
+
|
7
|
+
def initialize
|
8
|
+
self.expel = lambda { |_env| true }
|
9
|
+
self.status_code = 503
|
10
|
+
self.trigger_file = './monzenbarai.trigger'
|
11
|
+
end
|
12
|
+
end
|
13
|
+
end
|
@@ -0,0 +1,31 @@
|
|
1
|
+
require 'fileutils'
|
2
|
+
|
3
|
+
module Monzenbarai
|
4
|
+
class Context
|
5
|
+
def initialize(app)
|
6
|
+
@app = app
|
7
|
+
end
|
8
|
+
|
9
|
+
def call(env)
|
10
|
+
if render_maintenance?(env)
|
11
|
+
[configuration.status_code, { 'Content-Type' => 'text/html' }, ['<h1>maintenance</h1>']]
|
12
|
+
else
|
13
|
+
@app.call env
|
14
|
+
end
|
15
|
+
end
|
16
|
+
|
17
|
+
private
|
18
|
+
|
19
|
+
def render_maintenance?(env)
|
20
|
+
maintenance_mode? && configuration.expel.call(env)
|
21
|
+
end
|
22
|
+
|
23
|
+
def maintenance_mode?
|
24
|
+
File.exist? configuration.trigger_file
|
25
|
+
end
|
26
|
+
|
27
|
+
def configuration
|
28
|
+
Monzenbarai.configuration
|
29
|
+
end
|
30
|
+
end
|
31
|
+
end
|
data/lib/monzenbarai.rb
ADDED
@@ -0,0 +1,20 @@
|
|
1
|
+
require 'monzenbarai/version'
|
2
|
+
|
3
|
+
module Monzenbarai
|
4
|
+
class << self
|
5
|
+
def new(app)
|
6
|
+
Context.new(app)
|
7
|
+
end
|
8
|
+
|
9
|
+
def configure
|
10
|
+
yield configuration
|
11
|
+
end
|
12
|
+
|
13
|
+
def configuration
|
14
|
+
@configuration ||= Monzenbarai::Configuration.new
|
15
|
+
end
|
16
|
+
end
|
17
|
+
|
18
|
+
autoload :Configuration, 'monzenbarai/configuration'
|
19
|
+
autoload :Context, 'monzenbarai/context'
|
20
|
+
end
|
data/monzenbarai.gemspec
ADDED
@@ -0,0 +1,35 @@
|
|
1
|
+
lib = File.expand_path('../lib', __FILE__)
|
2
|
+
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
|
3
|
+
require 'monzenbarai/version'
|
4
|
+
|
5
|
+
Gem::Specification.new do |spec|
|
6
|
+
spec.name = 'monzenbarai'
|
7
|
+
spec.version = Monzenbarai::VERSION
|
8
|
+
spec.authors = ['takuan-oishii']
|
9
|
+
spec.email = ['met.enkephalin@gmail.com']
|
10
|
+
|
11
|
+
spec.summary = %q{simple rack app maintenance gem}
|
12
|
+
spec.description = %q{Monzenbarai is simple Rack middleware that allows you to easily put your app in maintenance mode}
|
13
|
+
spec.homepage = 'https://github.com/takuan-oishii/monzenbarai'
|
14
|
+
spec.license = 'MIT'
|
15
|
+
|
16
|
+
# Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
|
17
|
+
# to allow pushing to a single host or delete this section to allow pushing to any host.
|
18
|
+
if spec.respond_to?(:metadata)
|
19
|
+
# spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
|
20
|
+
else
|
21
|
+
raise 'RubyGems 2.0 or newer is required to protect against public gem pushes.'
|
22
|
+
end
|
23
|
+
|
24
|
+
spec.files = `git ls-files -z`.split("\x0").reject do |f|
|
25
|
+
f.match(%r{^(test|spec|features)/})
|
26
|
+
end
|
27
|
+
spec.bindir = 'exe'
|
28
|
+
spec.executables = ['monzenbarai']
|
29
|
+
spec.require_paths = ['lib']
|
30
|
+
|
31
|
+
spec.add_development_dependency 'bundler', '~> 1.16'
|
32
|
+
spec.add_development_dependency 'rake', '~> 10.0'
|
33
|
+
spec.add_development_dependency 'thor'
|
34
|
+
# spec.add_development_dependency 'rspec', '~> '
|
35
|
+
end
|
metadata
ADDED
@@ -0,0 +1,107 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: monzenbarai
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.0.2
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- takuan-oishii
|
8
|
+
autorequire:
|
9
|
+
bindir: exe
|
10
|
+
cert_chain: []
|
11
|
+
date: 2018-10-06 00:00:00.000000000 Z
|
12
|
+
dependencies:
|
13
|
+
- !ruby/object:Gem::Dependency
|
14
|
+
name: bundler
|
15
|
+
requirement: !ruby/object:Gem::Requirement
|
16
|
+
requirements:
|
17
|
+
- - "~>"
|
18
|
+
- !ruby/object:Gem::Version
|
19
|
+
version: '1.16'
|
20
|
+
type: :development
|
21
|
+
prerelease: false
|
22
|
+
version_requirements: !ruby/object:Gem::Requirement
|
23
|
+
requirements:
|
24
|
+
- - "~>"
|
25
|
+
- !ruby/object:Gem::Version
|
26
|
+
version: '1.16'
|
27
|
+
- !ruby/object:Gem::Dependency
|
28
|
+
name: rake
|
29
|
+
requirement: !ruby/object:Gem::Requirement
|
30
|
+
requirements:
|
31
|
+
- - "~>"
|
32
|
+
- !ruby/object:Gem::Version
|
33
|
+
version: '10.0'
|
34
|
+
type: :development
|
35
|
+
prerelease: false
|
36
|
+
version_requirements: !ruby/object:Gem::Requirement
|
37
|
+
requirements:
|
38
|
+
- - "~>"
|
39
|
+
- !ruby/object:Gem::Version
|
40
|
+
version: '10.0'
|
41
|
+
- !ruby/object:Gem::Dependency
|
42
|
+
name: thor
|
43
|
+
requirement: !ruby/object:Gem::Requirement
|
44
|
+
requirements:
|
45
|
+
- - ">="
|
46
|
+
- !ruby/object:Gem::Version
|
47
|
+
version: '0'
|
48
|
+
type: :development
|
49
|
+
prerelease: false
|
50
|
+
version_requirements: !ruby/object:Gem::Requirement
|
51
|
+
requirements:
|
52
|
+
- - ">="
|
53
|
+
- !ruby/object:Gem::Version
|
54
|
+
version: '0'
|
55
|
+
description: Monzenbarai is simple Rack middleware that allows you to easily put your
|
56
|
+
app in maintenance mode
|
57
|
+
email:
|
58
|
+
- met.enkephalin@gmail.com
|
59
|
+
executables:
|
60
|
+
- monzenbarai
|
61
|
+
extensions: []
|
62
|
+
extra_rdoc_files: []
|
63
|
+
files:
|
64
|
+
- ".gitignore"
|
65
|
+
- ".travis.yml"
|
66
|
+
- CODE_OF_CONDUCT.md
|
67
|
+
- Gemfile
|
68
|
+
- Gemfile.lock
|
69
|
+
- LICENSE.txt
|
70
|
+
- README.md
|
71
|
+
- Rakefile
|
72
|
+
- bin/console
|
73
|
+
- bin/setup
|
74
|
+
- example/Gemfile
|
75
|
+
- example/Gemfile.lock
|
76
|
+
- example/app.rb
|
77
|
+
- exe/monzenbarai
|
78
|
+
- lib/monzenbarai.rb
|
79
|
+
- lib/monzenbarai/configuration.rb
|
80
|
+
- lib/monzenbarai/context.rb
|
81
|
+
- lib/monzenbarai/version.rb
|
82
|
+
- monzenbarai.gemspec
|
83
|
+
homepage: https://github.com/takuan-oishii/monzenbarai
|
84
|
+
licenses:
|
85
|
+
- MIT
|
86
|
+
metadata: {}
|
87
|
+
post_install_message:
|
88
|
+
rdoc_options: []
|
89
|
+
require_paths:
|
90
|
+
- lib
|
91
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
92
|
+
requirements:
|
93
|
+
- - ">="
|
94
|
+
- !ruby/object:Gem::Version
|
95
|
+
version: '0'
|
96
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
97
|
+
requirements:
|
98
|
+
- - ">="
|
99
|
+
- !ruby/object:Gem::Version
|
100
|
+
version: '0'
|
101
|
+
requirements: []
|
102
|
+
rubyforge_project:
|
103
|
+
rubygems_version: 2.6.14.1
|
104
|
+
signing_key:
|
105
|
+
specification_version: 4
|
106
|
+
summary: simple rack app maintenance gem
|
107
|
+
test_files: []
|