rack-app_version 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0ac2759b5e3bbe7fb30e67b993d21bdc0229e285
+  data.tar.gz: 2d1a1a3817265648676acd68af429f59243e291b
+SHA512:
+  metadata.gz: c0a11cdcb9f3bfab9ba371ce33fc14fccca1309fb2c201c384a7275007270aa906db5e431d6a0f02642be6f27770c5c13cb5ca020ce1a59db65022fd5adbb3b9
+  data.tar.gz: 4ae36f1f7a71f28c9957689a57d06ed8c1b6e21dabcc4e9651c4236703ad88b217fd9d3b02a8a2289a44c0671641bdb5432ef6a9352094281fdf20b03fa554fe

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.idea

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,15 @@
+Style/Documentation:
+  Exclude:
+    - 'spec/**/*'
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Metrics/LineLength:
+  Enabled: false
+
+Style/BlockDelimiters:
+  Enabled: false
+
+Metrics/BlockLength:
+  Enabled: false

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers 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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at dofreewill22@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,14 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rack-app_version.gemspec
+gemspec
+
+gem 'activesupport'
+
+group :test, :development do
+  gem 'byebug'
+  gem 'codeclimate-test-reporter', '~> 1.0.0'
+  gem 'pry'
+  gem 'rubocop', require: false
+  gem 'simplecov', require: false
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Wilfrido T. Nuqui Jr.
+
+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,74 @@
+# Rack::AppVersion Middleware
+[![Build Status](https://semaphoreci.com/api/v1/wnuqui/rack-app_version/branches/master/badge.svg)](https://semaphoreci.com/wnuqui/rack-app_version) [![Ebert](https://ebertapp.io/github/wnuqui/rack-app_version.svg)](https://ebertapp.io/github/wnuqui/rack-app_version) <a href="https://codeclimate.com/github/wnuqui/rack-app_version"><img src="https://codeclimate.com/github/wnuqui/rack-app_version/badges/gpa.svg" /></a> <a href="https://codeclimate.com/github/wnuqui/rack-app_version"><img src="https://codeclimate.com/github/wnuqui/rack-app_version/badges/issue_count.svg" /></a> <a href="https://codeclimate.com/github/wnuqui/rack-app_version/coverage"><img src="https://codeclimate.com/github/wnuqui/rack-app_version/badges/coverage.svg" /></a>
+
+`Rack::AppVersion` is a middleware that sets the version of an app (Rack compatible web applications) via response header.
+
+## Setup
+
+### 1. In your Gemfile
+
+```ruby
+gem 'rack-app_version', git: 'git://github.com/wnuqui/rack-app_version.git', branch: 'master'
+```
+
+### 2. In `config/application.rb` of your Rails application, put the code below.
+
+```ruby
+module YourApp
+  class Application < Rails::Application
+
+    # ...
+
+    config.middleware.use Rack::AppVersion
+
+  end
+end
+```
+
+### 3. In `Rakefile` of your Rails application, put the code below.
+
+```ruby
+module Rack
+  class AppVersion
+    def self.generate_version
+      # Implement logic of getting application version here.
+    end
+  end
+end
+
+require 'rack/app_version/rake_task'
+Rack::AppVersion.load_tasks
+```
+
+Doing `bundle exec rake -T | grep app_version` will give you the following which you can use:
+
+```bash
+rake app_version:generate               # generate app version and write it in .app_version file
+rake app_version:init                   # generate .app_version file that will contain application version
+```
+
+### 4. Use `have_app_version` matcher to ensure everything is setup (optional).
+
+This rspec matcher can be used by the application to ensure that everything is properly configured.
+
+```ruby
+it 'has app version in response headers' do
+  expect(env).to have_app_version
+end
+```
+
+## Common Gotchas
+
+To determine where to put the `Rack::AppVersion` middleware in the Rack stack, run the following command:
+
+```bash
+bundle exec rake middleware
+```
+
+In many cases, the Rack stack will be different running in production environment. Run the following command to see the middleware stack in production:
+
+```bash
+RAILS_ENV=production bundle exec rake middleware
+```
+
+See The [Rails Guide to Rack](http://guides.rubyonrails.org/rails_on_rack.html) for more details on rack middlewares or watch the [railscast](http://railscasts.com/episodes/151-rack-middleware).

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/ebert.yml

@@ -0,0 +1,27 @@
+# This configuration was used Ebert to review the wnuqui/rack-app_version repository
+# on 64a63492b864a5da9523ce671065efcac9f0e0f1.
+# You can make this the default configuration for future reviews by moving this
+# file to your repository as `.ebert.yml` and pushing it to GitHub, and tweak
+# it as you wish - To know more on how to change this file to better review your
+# repository you can go to https://docs.ebertapp.io/configuration and see the configuration
+# details.
+---
+styleguide: plataformatec/linters
+engines:
+  reek:
+    enabled: true
+  fixme:
+    enabled: true
+  rubocop:
+    enabled: true
+  duplication:
+    config:
+      languages:
+      - ruby
+    enabled: true
+  remark-lint:
+    enabled: true
+exclude_paths:
+- bin
+- spec
+

data/lib/rack/app_version.rb

@@ -0,0 +1,23 @@
+require 'rack/app_version/version'
+
+module Rack
+  # AppVersion
+  class AppVersion
+    HEADER_KEY = 'X-App-Version'.freeze
+    APP_VERSION_PATH = '.app_version'.freeze
+
+    def initialize(app)
+      @app = app
+      @app_version = IO.readlines(APP_VERSION_PATH)[0].chomp
+    end
+
+    def call(env)
+      dup._call env
+    end
+
+    def _call(env)
+      @app.call(env).tap \
+        { |_s, headers, _b| headers[HEADER_KEY] = @app_version }
+    end
+  end
+end

data/lib/rack/app_version/have_app_version_matcher.rb

@@ -0,0 +1,23 @@
+# The application that needs to use `Rack::AppVersion` middleware needs to:
+#   1. include this gem in the Gemfile, and
+#   2. add `Rack::AppVersion` middleware in the list of middlewares
+#     the application is using
+#
+# The second step is easy to miss. This rspec matcher can be used
+# by the application to ensure that everything is properly configured.
+#
+# Sample use:
+#
+#   ```ruby
+#   it 'has app version in response headers' do
+#     expect(env).to have_app_version
+#   end
+#   ```
+require 'active_support/core_ext/object/blank'
+
+RSpec::Matchers.define :have_app_version do
+  match do
+    key = Rack::AppVersion::HEADER_KEY
+    actual.key?(key) && actual[key].is_a?(String) && actual[key].present?
+  end
+end

data/lib/rack/app_version/rake_task.rb

@@ -0,0 +1,39 @@
+require 'rake'
+
+module Rack
+  # :nodoc:
+  class AppVersion
+    class << self
+      include ::Rake::DSL if defined?(::Rake::DSL)
+
+      def load_tasks
+        load_init_task
+        load_generate_task
+      end
+
+      private
+
+      def load_init_task
+        namespace :app_version do
+          desc 'generate .app_version file that will contain application version'
+          task :init do
+            puts 'Creating file that will contain application version ...'
+            puts '      create .app_version'
+            FileUtils.touch APP_VERSION_PATH
+          end
+        end
+      end
+
+      def load_generate_task
+        namespace :app_version do
+          desc 'generate app version and write it in .app_version file'
+          task :generate do
+            puts 'Generating app version ...'
+            puts '      generate version '
+            IO.write APP_VERSION_PATH, Rack::AppVersion.generate_version
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rack/app_version/version.rb

@@ -0,0 +1,5 @@
+module Rack
+  class AppVersion
+    VERSION = '0.1.0'.freeze
+  end
+end

data/rack-app_version.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rack/app_version/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'rack-app_version'
+  spec.version       = Rack::AppVersion::VERSION
+  spec.authors       = ['Wilfrido T. Nuqui Jr.']
+  spec.email         = ['dofreewill22@gmail.com']
+
+  spec.summary       = 'Middleware that sets app version in response header.'
+  spec.description   = 'Middleware that sets app version in response header.'
+  spec.homepage      = 'https://github.com/wnuqui/rack-app_version'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.13'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: rack-app_version
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Wilfrido T. Nuqui Jr.
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-07-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Middleware that sets app version in response header.
+email:
+- dofreewill22@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- ebert.yml
+- lib/rack/app_version.rb
+- lib/rack/app_version/have_app_version_matcher.rb
+- lib/rack/app_version/rake_task.rb
+- lib/rack/app_version/version.rb
+- rack-app_version.gemspec
+homepage: https://github.com/wnuqui/rack-app_version
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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.5.2
+signing_key: 
+specification_version: 4
+summary: Middleware that sets app version in response header.
+test_files: []