whats_up_doc 0.0.1

Sign up to get free protection for your applications and to get access to all the features.
data/.gitignore ADDED
@@ -0,0 +1,17 @@
1
+ *.gem
2
+ *.rbc
3
+ .bundle
4
+ .config
5
+ .yardoc
6
+ Gemfile.lock
7
+ InstalledFiles
8
+ _yardoc
9
+ coverage
10
+ doc/
11
+ lib/bundler/man
12
+ pkg
13
+ rdoc
14
+ spec/reports
15
+ test/tmp
16
+ test/version_tmp
17
+ tmp
data/.rspec ADDED
@@ -0,0 +1,2 @@
1
+ --format documentation
2
+ --color
data/Gemfile ADDED
@@ -0,0 +1,6 @@
1
+ source 'https://rubygems.org'
2
+
3
+ # Specify your gem's dependencies in whats_up_doc.gemspec
4
+ gemspec
5
+
6
+ gem 'pry-debugger'
data/LICENSE.txt ADDED
@@ -0,0 +1,22 @@
1
+ Copyright (c) 2014 Allen Madsen
2
+
3
+ MIT License
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining
6
+ a copy of this software and associated documentation files (the
7
+ "Software"), to deal in the Software without restriction, including
8
+ without limitation the rights to use, copy, modify, merge, publish,
9
+ distribute, sublicense, and/or sell copies of the Software, and to
10
+ permit persons to whom the Software is furnished to do so, subject to
11
+ the following conditions:
12
+
13
+ The above copyright notice and this permission notice shall be
14
+ included in all copies or substantial portions of the Software.
15
+
16
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
17
+ EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
18
+ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
19
+ NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
20
+ LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
21
+ OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
22
+ WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
data/README.md ADDED
@@ -0,0 +1,42 @@
1
+ # WhatsUpDoc
2
+
3
+ Responds with `200` for a specific path. Useful for load balancers to hit without needing to go through the whole rails
4
+ stack. Insert before logging middleware, so that a load balancer doesn't pollute your log with requests.
5
+
6
+ ## Installation
7
+
8
+ Add this line to your application's Gemfile:
9
+
10
+ gem 'whats_up_doc'
11
+
12
+ And then execute:
13
+
14
+ $ bundle
15
+
16
+ Or install it yourself as:
17
+
18
+ $ gem install whats_up_doc
19
+
20
+ ## Usage
21
+
22
+ In a rackup file:
23
+
24
+ ``` ruby
25
+ use WhatsUpDoc::Middleware, path: '/my-up-path'
26
+ ```
27
+
28
+ Or in Rails:
29
+
30
+ ``` ruby
31
+ config.middleware.use(WhatsUpDoc::Middleware, path: '/my-up-path')
32
+ ```
33
+
34
+ The default path is `/up`.
35
+
36
+ ## Contributing
37
+
38
+ 1. Fork it ( http://github.com/secondrotation/whats_up_doc/fork )
39
+ 2. Create your feature branch (`git checkout -b my-new-feature`)
40
+ 3. Commit your changes (`git commit -am 'Add some feature'`)
41
+ 4. Push to the branch (`git push origin my-new-feature`)
42
+ 5. Create new Pull Request
data/Rakefile ADDED
@@ -0,0 +1,6 @@
1
+ require "bundler/gem_tasks"
2
+ require "rspec/core/rake_task"
3
+
4
+ RSpec::Core::RakeTask.new(:spec)
5
+
6
+ task :default => :spec
@@ -0,0 +1,33 @@
1
+ require 'rack'
2
+
3
+ module WhatsUpDoc
4
+ class Middleware
5
+ DEFAULTS = {path: '/up'}
6
+
7
+ def initialize(app, options = {})
8
+ @app = app
9
+ @options = DEFAULTS.merge(options)
10
+ end
11
+
12
+ def call(env)
13
+ @env = env
14
+
15
+ if up_path?
16
+ [200, {}, []]
17
+ else
18
+ app.call(env)
19
+ end
20
+ end
21
+
22
+ private
23
+ attr_reader :app, :env, :options
24
+
25
+ def request
26
+ Rack::Request.new(env)
27
+ end
28
+
29
+ def up_path?
30
+ options[:path] == request.fullpath
31
+ end
32
+ end
33
+ end
@@ -0,0 +1,3 @@
1
+ module WhatsUpDoc
2
+ VERSION = "0.0.1"
3
+ end
@@ -0,0 +1,5 @@
1
+ require "whats_up_doc/version"
2
+ require "whats_up_doc/middleware"
3
+
4
+ module WhatsUpDoc
5
+ end
@@ -0,0 +1,2 @@
1
+ $LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
2
+ require 'whats_up_doc'
@@ -0,0 +1,31 @@
1
+ require 'spec_helper'
2
+
3
+ describe WhatsUpDoc::Middleware do
4
+ it 'should have a version number' do
5
+ WhatsUpDoc::VERSION.should_not be_nil
6
+ end
7
+
8
+
9
+ let(:app){->(env) { [200, env, "app"]}}
10
+ let(:middleware){WhatsUpDoc::Middleware.new(app, path: '/up')}
11
+
12
+ context 'when GET /up is called' do
13
+ let(:env){Rack::MockRequest.env_for('https://www.example.com/up', {})}
14
+
15
+ it 'responds to up with 200' do
16
+ code, _ = middleware.call(env)
17
+
18
+ expect(code).to eq(200)
19
+ end
20
+ end
21
+
22
+ context 'when another path is called' do
23
+ let(:env){Rack::MockRequest.env_for('https://www.example.com/somewhere-else', {})}
24
+
25
+ it 'delegates to the next app in the chain' do
26
+ expect(app).to receive(:call).with(env)
27
+
28
+ middleware.call(env)
29
+ end
30
+ end
31
+ end
@@ -0,0 +1,26 @@
1
+ # coding: utf-8
2
+ lib = File.expand_path('../lib', __FILE__)
3
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
+ require 'whats_up_doc/version'
5
+
6
+ Gem::Specification.new do |spec|
7
+ spec.name = "whats_up_doc"
8
+ spec.version = WhatsUpDoc::VERSION
9
+ spec.authors = ["Allen Madsen"]
10
+ spec.email = ["blatyo@gmail.com"]
11
+ spec.summary = %q{Provides a low-level up route for load balancers.}
12
+ spec.description = %q{Provides a low-level up route for load balancers. Useful for injecting before loggin, so load balancers don't pollute the log.}
13
+ spec.homepage = "https://github.com/secondrotation/whats_up_doc"
14
+ spec.license = "MIT"
15
+
16
+ spec.files = `git ls-files -z`.split("\x0")
17
+ spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
18
+ spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
19
+ spec.require_paths = ["lib"]
20
+
21
+ spec.add_runtime_dependency 'rack'
22
+
23
+ spec.add_development_dependency "bundler", "~> 1.5"
24
+ spec.add_development_dependency "rake"
25
+ spec.add_development_dependency "rspec"
26
+ end
metadata ADDED
@@ -0,0 +1,131 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: whats_up_doc
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.0.1
5
+ prerelease:
6
+ platform: ruby
7
+ authors:
8
+ - Allen Madsen
9
+ autorequire:
10
+ bindir: bin
11
+ cert_chain: []
12
+ date: 2014-03-27 00:00:00.000000000 Z
13
+ dependencies:
14
+ - !ruby/object:Gem::Dependency
15
+ name: rack
16
+ requirement: !ruby/object:Gem::Requirement
17
+ none: false
18
+ requirements:
19
+ - - ! '>='
20
+ - !ruby/object:Gem::Version
21
+ version: '0'
22
+ type: :runtime
23
+ prerelease: false
24
+ version_requirements: !ruby/object:Gem::Requirement
25
+ none: false
26
+ requirements:
27
+ - - ! '>='
28
+ - !ruby/object:Gem::Version
29
+ version: '0'
30
+ - !ruby/object:Gem::Dependency
31
+ name: bundler
32
+ requirement: !ruby/object:Gem::Requirement
33
+ none: false
34
+ requirements:
35
+ - - ~>
36
+ - !ruby/object:Gem::Version
37
+ version: '1.5'
38
+ type: :development
39
+ prerelease: false
40
+ version_requirements: !ruby/object:Gem::Requirement
41
+ none: false
42
+ requirements:
43
+ - - ~>
44
+ - !ruby/object:Gem::Version
45
+ version: '1.5'
46
+ - !ruby/object:Gem::Dependency
47
+ name: rake
48
+ requirement: !ruby/object:Gem::Requirement
49
+ none: false
50
+ requirements:
51
+ - - ! '>='
52
+ - !ruby/object:Gem::Version
53
+ version: '0'
54
+ type: :development
55
+ prerelease: false
56
+ version_requirements: !ruby/object:Gem::Requirement
57
+ none: false
58
+ requirements:
59
+ - - ! '>='
60
+ - !ruby/object:Gem::Version
61
+ version: '0'
62
+ - !ruby/object:Gem::Dependency
63
+ name: rspec
64
+ requirement: !ruby/object:Gem::Requirement
65
+ none: false
66
+ requirements:
67
+ - - ! '>='
68
+ - !ruby/object:Gem::Version
69
+ version: '0'
70
+ type: :development
71
+ prerelease: false
72
+ version_requirements: !ruby/object:Gem::Requirement
73
+ none: false
74
+ requirements:
75
+ - - ! '>='
76
+ - !ruby/object:Gem::Version
77
+ version: '0'
78
+ description: Provides a low-level up route for load balancers. Useful for injecting
79
+ before loggin, so load balancers don't pollute the log.
80
+ email:
81
+ - blatyo@gmail.com
82
+ executables: []
83
+ extensions: []
84
+ extra_rdoc_files: []
85
+ files:
86
+ - .gitignore
87
+ - .rspec
88
+ - Gemfile
89
+ - LICENSE.txt
90
+ - README.md
91
+ - Rakefile
92
+ - lib/whats_up_doc.rb
93
+ - lib/whats_up_doc/middleware.rb
94
+ - lib/whats_up_doc/version.rb
95
+ - spec/spec_helper.rb
96
+ - spec/whats_up_doc_spec.rb
97
+ - whats_up_doc.gemspec
98
+ homepage: https://github.com/secondrotation/whats_up_doc
99
+ licenses:
100
+ - MIT
101
+ post_install_message:
102
+ rdoc_options: []
103
+ require_paths:
104
+ - lib
105
+ required_ruby_version: !ruby/object:Gem::Requirement
106
+ none: false
107
+ requirements:
108
+ - - ! '>='
109
+ - !ruby/object:Gem::Version
110
+ version: '0'
111
+ segments:
112
+ - 0
113
+ hash: 1713955773353994232
114
+ required_rubygems_version: !ruby/object:Gem::Requirement
115
+ none: false
116
+ requirements:
117
+ - - ! '>='
118
+ - !ruby/object:Gem::Version
119
+ version: '0'
120
+ segments:
121
+ - 0
122
+ hash: 1713955773353994232
123
+ requirements: []
124
+ rubyforge_project:
125
+ rubygems_version: 1.8.23
126
+ signing_key:
127
+ specification_version: 3
128
+ summary: Provides a low-level up route for load balancers.
129
+ test_files:
130
+ - spec/spec_helper.rb
131
+ - spec/whats_up_doc_spec.rb