rack-ok 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 186f17bd5884836db3154ad685eb15daeb1ba76c2ffc79b387c99ca6b98a6883
+  data.tar.gz: 5b5cde7d8f1017d14eab7d1fea9c122929bf6c8bfdb14b4eba03e28e53f768fe
+SHA512:
+  metadata.gz: 25073bc85b845eced7291a4964c79029659737650f7aa1a6eb84c63cd6d2076e2487e3ec9cba7ba6b3d2310a7f8b146aa5e5df9dc04fd44b8ead99ba3e26be86
+  data.tar.gz: 240bdfd4ae10450fa4d4ae131637e760f55ac3f7ece37daeeea0e22938a5fbc87c8a35cd07aec198fa10641a9e8c8ef73c12b4a9db7bc7f313308198f0c7af3f

data/.github/workflows/test.yml

@@ -0,0 +1,18 @@
+on:
+  pull_request:
+  push:
+    branches:
+      - master
+jobs:
+  build:
+    runs-on: ubuntu-18.04
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-ruby@v1
+        with:
+          ruby-version: '2.7.2'
+      - run: bundle install --jobs=$(($(nproc) - 1)) --retry=3
+      - run: bundle exec rubocop --color --parallel
+      - run: bundle exec rspec --force-color
+
+

data/.gitignore

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

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,5 @@
+Metrics:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.1
+before_install: gem install bundler -v 2.1.4

data/CHANGELOG.md

@@ -0,0 +1,14 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## 0.1.0
+
+### Added
+
+- Add Rack::Ok.

data/Gemfile

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rack-ok.gemspec
+gemspec
+
+gem 'rack-test'
+gem 'rake', '~> 12.0'
+gem 'rspec', '~> 3.0'
+gem 'rubocop'

data/Gemfile.lock

@@ -0,0 +1,59 @@
+PATH
+  remote: .
+  specs:
+    rack-ok (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.1)
+    diff-lcs (1.4.4)
+    parallel (1.19.2)
+    parser (2.7.2.0)
+      ast (~> 2.4.1)
+    rack (2.2.3)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rainbow (3.0.0)
+    rake (12.3.3)
+    regexp_parser (1.8.2)
+    rexml (3.2.4)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.3)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.4)
+    rubocop (1.0.0)
+      parallel (~> 1.10)
+      parser (>= 2.7.1.5)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8)
+      rexml
+      rubocop-ast (>= 0.6.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (1.1.0)
+      parser (>= 2.7.1.5)
+    ruby-progressbar (1.10.1)
+    unicode-display_width (1.7.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rack-ok!
+  rack-test
+  rake (~> 12.0)
+  rspec (~> 3.0)
+  rubocop
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Ryo Nakamura
+
+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,87 @@
+# Rack::Ok
+
+[![](https://github.com/r7kamura/rack-ok/workflows/.github/workflows/test.yml/badge.svg)](https://github.com/r7kamura/rack-ok/actions?query=workflow%3A.github%2Fworkflows%2Ftest.yml)
+
+Rack middleware to return OK.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rack-ok'
+```
+
+And then execute:
+
+```sh
+bundle install
+```
+
+Or install it yourself as:
+
+```sh
+gem install rack-ok
+```
+
+## Usage
+
+Insert `Rack::Ok` to your rack middleware, and the app will respond to `GET /health` with 200 OK.
+
+### For Rails
+
+Insert this before at least ActionDispatch::SSL (enabled by config.force_ssl) to prevent request from being redirected.
+
+```ruby
+# config/initializers/ok.rb
+Rails.configuration.middleware.insert(0, Rack::Ok)
+```
+
+### For Rack
+
+```ruby
+# config.ru
+require 'rack/ok'
+use Rack::Ok
+```
+
+### Customization
+
+Supports these options:
+
+- `:body` (default: `"OK"`)
+- `:path` (default: `"/health"`)
+
+```ruby
+use(
+  Rack::Ok,
+  body: 'Custom response body',
+  path: '/custom_ok_path',
+)
+```
+
+## Development
+
+### Setup
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+### Local installation
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+### Release
+
+To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/r7kamura/rack-ok.
+
+## Acknowledgements
+
+This gem is heavily inspired by [rack-health](https://github.com/mirakui/rack-health).
+
+## 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,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'rack/ok'
+
+# 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/lib/rack/ok.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require 'rack/ok/version'
+
+module Rack
+  class Ok
+    DEFAULT_REQUEST_PATH = '/health'
+
+    DEFAULT_RESPONSE_BODY = 'OK'
+
+    # @param [#call] app
+    # @param [String] body
+    # @param [String] path
+    def initialize(
+      app,
+      body: DEFAULT_RESPONSE_BODY,
+      path: DEFAULT_REQUEST_PATH
+    )
+      @app = app
+      @body = body
+      @path = path
+    end
+
+    # @param [Hash] env Rack env.
+    # @return [Array] Rack response.
+    def call(env)
+      if env['PATH_INFO'] == @path
+        [
+          '200',
+          {
+            'Content-Length' => @body.bytesize.to_s,
+            'Content-Type' => 'text/plain'
+          },
+          [@body]
+        ]
+      else
+        @app.call(env)
+      end
+    end
+  end
+end

data/lib/rack/ok/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Rack
+  class Ok
+    VERSION = '0.1.0'
+  end
+end

data/rack-ok.gemspec

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require_relative 'lib/rack/ok/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'rack-ok'
+  spec.version       = Rack::Ok::VERSION
+  spec.authors       = ['Ryo Nakamura']
+  spec.email         = ['r7kamura@gmail.com']
+
+  spec.summary       = 'Rack middleware to return OK.'
+  spec.homepage      = 'https://github.com/r7kamura/rack-ok'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.4.0')
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+  spec.metadata['changelog_uri'] = "#{spec.homepage}/blob/master/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.require_paths = ['lib']
+end

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification
+name: rack-ok
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ryo Nakamura
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-10-29 00:00:00.000000000 Z
+dependencies: []
+description: 
+email:
+- r7kamura@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/test.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/rack/ok.rb
+- lib/rack/ok/version.rb
+- rack-ok.gemspec
+homepage: https://github.com/r7kamura/rack-ok
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/r7kamura/rack-ok
+  source_code_uri: https://github.com/r7kamura/rack-ok
+  changelog_uri: https://github.com/r7kamura/rack-ok/blob/master/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Rack middleware to return OK.
+test_files: []