rack-commithash-endpoint 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f8e8034f776ae71e00f9b2ab14f3d3a6f6a190d2809748bb6bed093b539066df
+  data.tar.gz: c6b4dd07ad39cd7d36a5ba9239618226b0269e15c52b022243089c156130fbf2
+SHA512:
+  metadata.gz: 44231e62a45e5b18685fd70c70b2805837ef90c1997ac2e7f25949efb25e57f5012b24bb29ad59cd86d811e964bc23dc0ffead042b955060205f3062b6752f33
+  data.tar.gz: f20e14edf6a84d7ce24b5ae8f0ac80ff8d0486af179ede410a2d00c3ee671d5a0ca24bec81b7b218217933778ad3040ac3cb64f4a80a6cf70e049f0ab4833133

data/.devcontainer/devcontainer.json

@@ -0,0 +1,22 @@
+// For format details, see https://aka.ms/devcontainer.json. For config options, see the
+// README at: https://github.com/devcontainers/templates/tree/main/src/ruby
+{
+	"name": "Ruby",
+	// Or use a Dockerfile or Docker Compose file. More info: https://containers.dev/guide/dockerfile
+	"image": "mcr.microsoft.com/devcontainers/ruby:1-3.1-bookworm"
+
+	// Features to add to the dev container. More info: https://containers.dev/features.
+	// "features": {},
+
+	// Use 'forwardPorts' to make a list of ports inside the container available locally.
+	// "forwardPorts": [],
+
+	// Use 'postCreateCommand' to run commands after the container is created.
+	// "postCreateCommand": "ruby --version",
+
+	// Configure tool-specific properties.
+	// "customizations": {},
+
+	// Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root.
+	// "remoteUser": "root"
+}

data/.rubocop.yml

@@ -0,0 +1,13 @@
+plugins:
+- rubocop-minitest
+- rubocop-rake
+
+AllCops:
+  TargetRubyVersion: 3.1
+  NewCops: enable
+
+Metrics:
+  Enabled: false
+
+Gemspec/AddRuntimeDependency: # new in 1.65
+  Enabled: true

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2025-05-08
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders 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, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Shirakawa Hiroyuki
+
+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,107 @@
+# Rack::Commithash::Endpoint
+
+Rack middleware to return git commit hash.
+
+A simple Rack middleware that exposes the current git commit hash of your application through an HTTP endpoint. This is useful for identifying which version of your application is deployed in various environments.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rack-commithash-endpoint'
+```
+
+And then execute:
+
+```bash
+bundle install
+```
+
+Or install it yourself as:
+
+```bash
+gem install rack-commithash-endpoint
+```
+
+## Usage
+
+### Basic Usage
+
+Add the middleware to your Rack application:
+
+```ruby
+# config.ru or similar
+require 'rack/commithash/endpoint'
+
+use Rack::Commithash::Endpoint
+run YourApp
+```
+
+This will make the `/__revision__` endpoint available in all environments where the initializer is loaded.
+
+
+With this configuration, the commit hash will be available at `/__revision__` and will be read from the `COMMIT_HASH` environment variable.
+
+By default, the response will be in JSON format:
+
+```
+GET /__revision__
+
+{"revision":"abc123"}
+Content-Type: application/json
+```
+
+#### Rails Integration
+
+If you're using Rails, you can add the middleware in an initializer to expose the commit hash endpoint for your app:
+
+```ruby
+# config/initializers/commithash_endpoint.rb
+Rails.configuration.middleware.insert(0, Rack::Commithash::Endpoint)
+```
+
+**Note:**  
+By inserting the middleware at position `0`, it is placed before all other middlewares, including `ActionDispatch::SSL` (which is automatically added when `config.force_ssl = true` is set).  
+This ensures that the commit hash endpoint is accessible even if SSL redirection is enabled, as requests to this endpoint will not be redirected to HTTPS before reaching the middleware.
+
+### Advanced Configuration
+
+You can customize both the endpoint path and the environment variable name:
+
+```ruby
+use Rack::Commithash::Endpoint, path: '/__version__', env_var: 'APP_REVISION'
+```
+
+You can also return the commit hash as plain text by setting `json_format: false`:
+
+```ruby
+use Rack::Commithash::Endpoint, json_format: false
+```
+
+This will return:
+
+```
+GET /__revision__
+
+abc123
+Content-Type: text/plain
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. 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 the created tag, 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/[USERNAME]/rack-commithash-endpoint. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/rack-commithash-endpoint/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Rack::Commithash::Endpoint project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/rack-commithash-endpoint/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'minitest/test_task'
+
+Minitest::TestTask.create
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/lib/rack/commithash/endpoint/version.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Rack
+  module Commithash
+    class Endpoint
+      VERSION = '0.1.0'
+    end
+  end
+end

data/lib/rack/commithash/endpoint.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+require_relative 'endpoint/version'
+
+module Rack
+  module Commithash
+    # Rack::Commithash provides a middleware that exposes the current Git commit hash
+    # through a configurable endpoint. This is useful for identifying the exact version
+    # of your application in production environments, facilitating debugging and deployment tracking.
+    class Endpoint
+      class Error < StandardError; end
+
+      DEFAULT_REQUEST_PATH = '/__revision__'
+      DEFAULT_ENV_VAR = 'COMMIT_HASH'
+
+      # @param [#call] app
+      # @param [String] env_var
+      # @param [String] path
+      # @param [Boolean] json_format
+      def initialize(
+        app,
+        env_var: DEFAULT_ENV_VAR,
+        path: DEFAULT_REQUEST_PATH,
+        json_format: true
+      )
+        @app = app
+        @path = path
+        commit_hash = ENV[env_var] || 'unknown'
+        @body, @length, @content_type = build_response(commit_hash, json_format)
+      end
+
+      # @param [Hash] env Rack env.
+      # @return [Array] Rack response.
+      def call(env)
+        if env['PATH_INFO'] == @path
+          [
+            200,
+            {
+              'content-length' => @length,
+              'content-type' => @content_type
+            },
+            [@body]
+          ]
+        else
+          @app.call(env)
+        end
+      end
+
+      private
+
+      # Builds the response body, length, and content type based on the commit hash and format.
+      # @param [String] commit_hash The commit hash to include in the response.
+      # @param [Boolean] json_format Whether to return the response in JSON format.
+      # @return [Array] An array containing the response body, its length, and content type.
+      def build_response(commit_hash, json_format)
+        if json_format
+          body = "{\"revision\":\"#{commit_hash}\"}"
+          content_type = 'application/json'
+        else
+          body = commit_hash
+          content_type = 'text/plain'
+        end
+        [body, body.bytesize.to_s, content_type]
+      end
+    end
+  end
+end

data/sig/rack/commithash/endpoint.rbs

@@ -0,0 +1,27 @@
+module Rack
+  module Commithash
+    class Endpoint
+      class Error < ::StandardError; end
+
+      DEFAULT_REQUEST_PATH: String
+      DEFAULT_ENV_VAR: String
+
+      def initialize: (
+        app: untyped,
+        env_var: String named 'env_var' = DEFAULT_ENV_VAR,
+        path: String named 'path' = DEFAULT_REQUEST_PATH,
+        json_format: bool named 'json_format' = true
+      ) -> void
+
+      def call: (env: Hash[String, untyped]) -> [String, Hash[String, String], Array[String]]
+
+      private
+      def build_response: (commit_hash: String, json_format: bool) -> [String, String, String]
+    end
+
+    module Endpoint
+      VERSION: String
+      # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+    end
+  end
+end

metadata

@@ -0,0 +1,58 @@
+--- !ruby/object:Gem::Specification
+name: rack-commithash-endpoint
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Shirakawa Hiroyuki
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2025-06-20 00:00:00.000000000 Z
+dependencies: []
+description: Rack middleware to return commit hash.
+email:
+- shrkwh@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".DS_Store"
+- ".devcontainer/devcontainer.json"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rack/commithash/endpoint.rb
+- lib/rack/commithash/endpoint/version.rb
+- sig/rack/commithash/endpoint.rbs
+homepage: https://github.com/shrkw/rack-commithash-endpoint
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/shrkw/rack-commithash-endpoint
+  source_code_uri: https://github.com/shrkw/rack-commithash-endpoint
+  changelog_uri: https://github.com/shrkw/rack-commithash-endpoint/blob/master/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.27
+signing_key:
+specification_version: 4
+summary: Rack middleware to return commit hash.
+test_files: []