rack-revision 1.0.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 572e54825a1905f7d369a997922a7d6c3d9031f7
-  data.tar.gz: a5411935f6ae46862d16ddcee5efc3c0643325f7
+SHA256:
+  metadata.gz: 2284692d25fe68e54b0842fbeed953ea7727cebe427bc1027ac18ca2329b2ff7
+  data.tar.gz: 40319f9c5ca70b8edf3c610846575e3a5b83862bcadccbbc87a1d175a08d8f6c
 SHA512:
-  metadata.gz: f771123d5a308206c920696f2c152d22cc40b99f7f13ea977a071edeb8d5dc0de42b160dd8b19a9b0f467fd643c579d5eb416b65a121221b804d10a86b1bd901
-  data.tar.gz: 5dbd53b2ecc0322bbe2cce1a62b2d6736f20a8b5a59bdba61480e2e7aab5f900e7fb2b07a01b3644c9b83264e1e8e0769ef08f4a96ace13a60e1b8ad4f351817
+  metadata.gz: f2346818a69159a398f0be3d81104841f43b183b7609ba0a9c21f6bb7b3a070f40ad7c85bfda185388c81a4a4313247c8bc568e68253e20ff34ca8b20a8deef1
+  data.tar.gz: 6aff733c7f9fdca284c41af3545ee8d51997972afa018bba66441e79169bb37b580cc27e4d9928dbf15ba6636110973d0f003839b2cf9c9d84722b930ebd342a

data/.travis.yml

@@ -1,6 +1,7 @@
 language: ruby
 rvm:
-  - 1.8.7
-  - 1.9.2
-  - 1.9.3
-  - 2.0.0
+  - 2.3
+  - 2.4
+  - 2.5
+  - 2.6
+  - 2.7

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License
+
+Copyright (c) 2012-2020 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

@@ -3,7 +3,8 @@
 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 Status](https://travis-ci.org/sosedoff/rack-revision.png?branch=master)](https://travis-ci.org/sosedoff/rack-revision)
+[![Build Status](https://img.shields.io/travis/sosedoff/rack-revision.svg)](https://travis-ci.org/sosedoff/rack-revision)
+[![Gem Version](https://img.shields.io/gem/v/rack-revision.svg)](http://badge.fury.io/rb/rack-revision)
 
 ## Installation
 
@@ -43,10 +44,35 @@ 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
 
@@ -58,21 +84,6 @@ rake test
 
 ## License
 
-Copyright (c) 2012-2013 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-2020 Dan Sosedoff <dan.sosedoff@gmail.com>

data/lib/rack/revision.rb

@@ -32,17 +32,23 @@ module Rack
     protected
  
     def revision
-      @@revision ||= read_revision
+      @@revision ||= (fetch_from_env || fetch_from_file || fetch_default)
     end
  
-    def read_revision
-      if File.exists?(detected_filename)
-        File.read(detected_filename).strip
-      else
-        @options[:default]
+    def fetch_from_env
+      ENV[@options[:env_var]]
+    end
+
+    def fetch_from_file
+      if ::File.exists?(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]))
     end
@@ -51,6 +57,7 @@ module Rack
       @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"
       }

data/lib/rack/revision/version.rb

@@ -1,5 +1,5 @@
 module Rack
   class Revision
-    VERSION = "1.0.2"
+    VERSION = "1.1.0"
   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,44 @@ 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_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 +123,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,41 +1,83 @@
 --- !ruby/object:Gem::Specification
 name: rack-revision
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.0
 platform: ruby
 authors:
 - Dan Sosedoff
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-19 00:00:00.000000000 Z
+date: 2020-02-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.0'
   type: :runtime
   prerelease: false
   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: !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'
+- !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,
@@ -46,9 +88,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .travis.yml
+- ".gitignore"
+- ".travis.yml"
 - Gemfile
+- LICENSE
 - README.md
 - Rakefile
 - lib/rack/revision.rb
@@ -64,17 +107,16 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.0.5
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: Code ravision rack middleware