rack-revision 1.0.1 → 1.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 62a12f243a22cd037fa6506a704a1d94cfadd93327412558258ce327560a0b52
+  data.tar.gz: 3aae6d6d5b3e0c0ab0881c1926e5d4c33e1f81f38e54c9c58ee18da27b92f65c
+SHA512:
+  metadata.gz: 36f785c3e545dd733c9ba45bd3b050df65c1fd90065e4f047274820969655351a5e6425d9582426d092ddafb0659fbcd90ff6b44aafb5def60a995599d306b52
+  data.tar.gz: 4bc2a640b44ac615434a18bafe55236fc2327f97c845600420ca4afebd03d2cf6144a69fb0b2626a5daf99459a228564957aca0288aa7e39fa752533a7a14e62

data/.github/workflows/test.yml

@@ -0,0 +1,20 @@
+name: Build
+
+on: [push, pull_request]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby: ['2.6', '2.7', '3.0', '3.1']
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+    - name: Install dependencies
+      run: bundle install
+    - name: Run tests
+      run: bundle exec rake

data/Gemfile

@@ -1,4 +1,4 @@
-source 'http://rubygems.org'
+source 'https://rubygems.org'
 
 gemspec
 

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License
+
+Copyright (c) 2012-2022 Dan Sosedoff, dan.sosedoff@gmail.com
+
+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

@@ -1,51 +1,78 @@
 # Rack::Revision
 
-Rack::Revision is a quick drop-in component to enable code revision tracking. 
+Rack::Revision is a quick drop-in component to enable code revision tracking.
 It adds `X-Revision` header with the code revision from capistrano's REVISION file.
 
+[![Build](https://github.com/sosedoff/rack-revision/actions/workflows/test.yml/badge.svg)](https://github.com/sosedoff/rack-revision/actions/workflows/test.yml)
+[![Gem Version](https://img.shields.io/gem/v/rack-revision.svg)](http://badge.fury.io/rb/rack-revision)
+
 ## Installation
 
-From rubygems:
+Add dependency to your Gemfile:
 
 ```
-gem install rack-revision
+gem "rack-revision"
 ```
 
-Or install with bundler:
+Install gem:
 
 ```
-gem 'rack-revision'
+bundle install
 ```
 
-And run `bundle install`
-
 ## Usage
 
 Rack::Revision is implemented as a piece of Rack middleware and can be used with
-any Rack-based application. If you have a `config.ru` rackup file you can 
+any Rack-based application. If you have a `config.ru` rackup file you can
 drop the following snippet (for sinatra app):
 
 ```ruby
-require 'rack/revision'
+require "rack/revision"
 
 # Basic example
 use Rack::Revision
 
 # With custom revision header
-use Rack::Revision, :header => 'X-CODE-VERSION'
+use Rack::Revision, :header => "X-CODE-VERSION"
 
 # With custom filename and default value
-use Rack::Revision, :filename => '.version', :default => 'n/a'
+use Rack::Revision, :filename => ".version", :default => "n/a"
 
+# Execute application
 run Sinatra::Application
 ```
 
 Available options:
 
-- `:header`   - Sets a custom revision header. Default: `X-Revision`
-- `:filename` - Sets a filename with revision data. Default: `REVISION`
-- `:default`  - Sets a revision value if file does not exist. Default: UNDEFINED
-- `:rack_env` - Sets a revision value to Rack's `env` hash. Default: `env['rack.app_revision']`
+- `:header` - Changes revision header name. Default: `X-Revision`
+- `:filename` - Changes the revision filename. Default: `REVISION`
+- `:rack_env` - Changes Rack environment key for revision. Default: `env['rack.app_revision']`
+- `:env_var` - Sets revision value from an environment variable. Default: `RACK_REVISION`
+- `:default` - Sets revision value if env var or a file with revision does not exist. Default: `UNDEFINED`
+
+## Example
+
+To see what the header might look like, run a curl command:
+
+```
+curl -i -X HEAD "http://yourdomain.com"
+```
+
+Example response:
+
+```
+HTTP/1.1 200 OK
+Server: nginx/1.4.4
+Content-Type: text/html; charset=utf-8
+Connection: keep-alive
+X-UA-Compatible: IE=Edge,chrome=1
+ETag: "5e622b6dab40d3cb8ad8a4bd51627a59"
+Cache-Control: max-age=0, private, must-revalidate
+X-Request-Id: ae07ad30bd857788bebfa1421576f96e
+X-Runtime: 0.022007
+X-Rack-Cache: miss
+X-Revision: a3de2043d4cea6182e511c9c73f57f4f1e0dbc2b
+```
 
 ## Test
 
@@ -57,10 +84,6 @@ rake test
 
 ## License
 
-Copyright (c) 2012 Dan Sosedoff.
-
-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 MIT License
 
-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.
+Copyright (c) 2012-2022 Dan Sosedoff <dan.sosedoff@gmail.com>

data/lib/rack/revision/version.rb

@@ -1,5 +1,5 @@
 module Rack
   class Revision
-    VERSION = '1.0.1'
+    VERSION = "1.1.1"
   end
-end
+end

data/lib/rack/revision.rb

@@ -6,39 +6,62 @@ module Rack
     @@revision = nil
 
     def initialize(app, options={})
-      @options = {
-        :header   => options[:header].nil? ? 'X-Revision' : options[:header],
-        :filename => options[:filename] || 'REVISION',
-        :default  => options[:default]  || 'UNDEFINED',
-        :rack_env => options[:rack_env].nil? ? 'rack.app_revision' : options[:rack_env]
-      }
+      initialize_options(options)
 
       @app = app
+      @dir = Dir.pwd
     end
- 
+
     def call(env)
-      env[@options[:rack_env]] = revision if @options[:rack_env]
+      if @options[:rack_env]
+        env[@options[:rack_env]] = revision
+      end
+
       status, headers, body = @app.call(env)
-      headers[@options[:header]] = revision if @options[:header]
+
+      if @options[:header]
+        headers[@options[:header]] = revision
+      end
+
       [status, headers, body]
     end
 
     def reset_revision
       @@revision = nil
     end
- 
+
     protected
- 
+
     def revision
-      @@revision ||= read_revision
+      @@revision ||= (fetch_from_env || fetch_from_file || fetch_default)
     end
- 
-    def read_revision
-      File.exists?(detected_filename) ? File.read(detected_filename).strip : @options[:default]
+
+    def fetch_from_env
+      ENV[@options[:env_var]]
+    end
+
+    def fetch_from_file
+      if ::File.exist?(detected_filename)
+        ::File.read(detected_filename).strip
+      end
+    end
+
+    def fetch_default
+      @options[:default]
     end
 
     def detected_filename
-      @file ||= (@options[:filename] =~ /\A\// ? @options[:filename] : File.join(Dir.pwd, @options[:filename]))
+      @file ||= (@options[:filename] =~ /\A\// ? @options[:filename] : File.join(@dir, @options[:filename]))
+    end
+
+    def initialize_options(options)
+      @options = {
+        :header   => options[:header].nil? ? "X-Revision" : options[:header],
+        :rack_env => options[:rack_env].nil? ? "rack.app_revision" : options[:rack_env],
+        :env_var  => options[:env_var]  || "RACK_REVISION",
+        :filename => options[:filename] || "REVISION",
+        :default  => options[:default]  || "UNDEFINED"
+      }
     end
   end
 end

data/rack-revision.gemspec

@@ -10,7 +10,11 @@ Gem::Specification.new do |s|
   s.email       = ["dan.sosedoff@gmail.com"]
 
   s.add_runtime_dependency 'rack', '>= 1.0'
+
+  s.add_development_dependency 'rake',      '~> 10.0'
   s.add_development_dependency 'rack-test', '>= 0'
+  s.add_development_dependency 'simplecov', '~> 0.8'
+  s.add_development_dependency 'test-unit', '>= 0'
 
   s.files              = `git ls-files`.split("\n")
   s.test_files         = `git ls-files -- {test,spec,features}/*`.split("\n")

data/test/test_revision.rb

@@ -1,14 +1,17 @@
-require 'test/unit'
-require 'rack/test'
-require 'rack/revision'
-require 'fileutils'
+require "simplecov"
+SimpleCov.start
+
+require "test/unit"
+require "rack/test"
+require "rack/revision"
+require "fileutils"
 
 class TestRevision < Test::Unit::TestCase
   include Rack::Test::Methods
 
   def default_app
     lambda do |env|
-      headers = {'Content-Type' => "text/html"}
+      headers = {"Content-Type" => "text/html"}
       [200, headers, ["OK"]]
     end
   end
@@ -24,11 +27,11 @@ class TestRevision < Test::Unit::TestCase
   attr_writer :app
 
   def setup
-    FileUtils.mkdir('./test/tmp')
+    FileUtils.mkdir("./test/tmp")
   end
 
   def teardown
-    FileUtils.rm_rf('./test/tmp')
+    FileUtils.rm_rf("./test/tmp")
   end
 
   def test_revision_request
@@ -42,8 +45,8 @@ class TestRevision < Test::Unit::TestCase
     self.app.reset_revision
     get app_url
 
-    assert_not_nil last_response.headers['X-REVISION']
-    assert_not_nil last_response.headers['X-Revision']
+    assert_not_nil last_response.headers["X-REVISION"]
+    assert_not_nil last_response.headers["X-Revision"]
   end
 
   def test_blank
@@ -51,15 +54,15 @@ class TestRevision < Test::Unit::TestCase
     self.app.reset_revision
     get app_url
 
-    assert_nil last_response.headers['X-REVISION']
-    assert_nil last_response.headers['X-Revision']
+    assert_nil last_response.headers["X-REVISION"]
+    assert_nil last_response.headers["X-Revision"]
   end
 
   def test_default_value
     self.app.reset_revision
     get app_url
 
-    assert_equal "UNDEFINED", last_response.headers['X-Revision']
+    assert_equal "UNDEFINED", last_response.headers["X-Revision"]
   end
 
   def test_custom_value
@@ -67,7 +70,7 @@ class TestRevision < Test::Unit::TestCase
     self.app.reset_revision
 
     get app_url
-    assert_equal "FOOBAR", last_response.headers['X-Revision']
+    assert_equal "FOOBAR", last_response.headers["X-Revision"]
   end
 
   def test_custom_header
@@ -75,44 +78,61 @@ class TestRevision < Test::Unit::TestCase
     self.app.reset_revision
 
     get app_url
-    assert_not_nil last_response.headers['FOOBAR']
+    assert_not_nil last_response.headers["FOOBAR"]
   end
 
   def test_custom_filename
-    File.open('./test/tmp/REVISION', 'w') { |f| f.write('qwe123') }
+    File.open("./test/tmp/REVISION", "w") { |f| f.write("qwe123") }
 
-    self.app = Rack::Revision.new(default_app, :filename => './test/tmp/REVISION')
+    self.app = Rack::Revision.new(default_app, :filename => "./test/tmp/REVISION")
     self.app.reset_revision
 
     get app_url
-    assert_equal 'qwe123', last_response.headers['X-Revision']
+    assert_equal "qwe123", last_response.headers["X-Revision"]
   end
 
   def test_custom_filename_starting_from_root
-    File.open('./test/tmp/REVISION', 'w') { |f| f.write('qwe123') }
+    File.open("./test/tmp/REVISION", "w") { |f| f.write("qwe123") }
     filename = File.expand_path("./test/tmp/REVISION")
 
     self.app = Rack::Revision.new(default_app, :filename => filename)
     self.app.reset_revision
 
     get app_url
-    assert_equal 'qwe123', last_response.headers['X-Revision']
+    assert_equal "qwe123", last_response.headers["X-Revision"]
+  end
+
+  def test_dir_does_not_exist
+    File.write("./test/tmp/REVISION", "example")
+
+    Dir.chdir("./test/tmp") do
+      self.app.reset_revision
+
+      get app_url
+      assert_equal "example", last_response.headers["X-Revision"]
+
+      FileUtils.rm_rf("../tmp")
+      self.app.reset_revision
+
+      get app_url
+      assert_equal "UNDEFINED", last_response.headers["X-Revision"]
+    end
   end
 
   def test_env_is_present
     self.app.reset_revision
     get app_url
 
-    assert_not_nil last_request.env['rack.app_revision']
+    assert_not_nil last_request.env["rack.app_revision"]
   end
 
   def test_custom_env
-    self.app = Rack::Revision.new(default_app, :rack_env => 'rack.custom_env')
+    self.app = Rack::Revision.new(default_app, :rack_env => "rack.custom_env")
     self.app.reset_revision
     get app_url
 
-    assert_nil last_request.env['rack.app_revision']
-    assert_not_nil last_request.env['rack.custom_env']
+    assert_nil last_request.env["rack.app_revision"]
+    assert_not_nil last_request.env["rack.custom_env"]
   end
 
   def test_disable_env
@@ -120,6 +140,25 @@ class TestRevision < Test::Unit::TestCase
     self.app.reset_revision
     get app_url
 
-    assert_nil last_request.env['rack.app_revision']
+    assert_nil last_request.env["rack.app_revision"]
+  end
+
+  def test_from_env_var
+    self.app = Rack::Revision.new(default_app)
+    self.app.reset_revision
+
+    ENV["RACK_REVISION"] = "revision"
+    get app_url
+    assert_equal "revision", last_response.headers["X-Revision"]
+  end
+
+  def test_from_custom_env_var
+    self.app = Rack::Revision.new(default_app, env_var: "SERVICE_REVISION")
+    self.app.reset_revision
+
+    ENV["RACK_REVISION"] = "bad"
+    ENV["SERVICE_REVISION"] = "good"
+    get app_url
+    assert_equal "good", last_response.headers["X-Revision"]
   end
 end

metadata

@@ -1,38 +1,85 @@
 --- !ruby/object:Gem::Specification
 name: rack-revision
 version: !ruby/object:Gem::Version
-  version: 1.0.1
-  prerelease: 
+  version: 1.1.1
 platform: ruby
 authors:
 - Dan Sosedoff
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2012-12-17 00:00:00.000000000Z
+date: 2022-06-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
-  requirement: &2157761320 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.0'
   type: :runtime
   prerelease: false
-  version_requirements: *2157761320
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !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: rack-test
-  requirement: &2157759940 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2157759940
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  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: Adds an extra X-REVISION header with source code revision string (git,
   svn, etc)
 email:
@@ -41,9 +88,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .travis.yml
+- ".github/workflows/test.yml"
+- ".gitignore"
 - Gemfile
+- LICENSE
 - README.md
 - Rakefile
 - lib/rack/revision.rb
@@ -52,28 +100,25 @@ files:
 - test/test_revision.rb
 homepage: http://github.com/sosedoff/rack-revision
 licenses: []
-post_install_message: 
+metadata: {}
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 1.8.15
-signing_key: 
-specification_version: 3
+rubygems_version: 3.3.9
+signing_key:
+specification_version: 4
 summary: Code ravision rack middleware
 test_files:
 - test/test_revision.rb
-has_rdoc: 

data/.travis.yml

@@ -1,5 +0,0 @@
-language: ruby
-rvm:
-  - 1.8.7
-  - 1.9.2
-  - 1.9.3