ruby_build_info 1.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ODEwN2I1YjZiMmQ3YzZkOTgwZDE2Mjc0OTgwYzlmYzg1MjliY2EzYw==
+  data.tar.gz: !binary |-
+    MzlkMzY1OWI3MjM4NDdjOGRkMmIwOTQ0Mzc4MjlhMjJiN2MzYTI5Ng==
+SHA512:
+  metadata.gz: !binary |-
+    NGI0ZjRlYmUxM2E1NWIwZjM4MmRmNmEzMTFiNGY1NzE1ODVmYjc3OGFhZTFi
+    NTNkZTg5NThiN2E5ZmQ2NjZiNzNhMzI1N2YyZWNkNDM5ZTA5MmUyZTFhZDEy
+    OGI3YjJlZmFjODg5OTgyZmE0MGEyZDU2MDliNWYxMzRkMTc2NmY=
+  data.tar.gz: !binary |-
+    ZmFiOWM3YjdmNTVjOTc3NjAzMDA2ZDc4NmRiNWYxNjMyMWI3MTM5ZWU0MjU4
+    N2E0ODQxM2U4NmRjZjdiN2MxYjk4MzUyYTg5OWUyMjk4ODc4MzJmYzg4Zjk2
+    MzcxZmZiZTIxMTlhYzJjMjZkNmNmNTVhYmVkYjQ0MzM4M2I0YzU=

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ruby_build_info.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Adam Georgeson
+
+MIT License
+
+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,39 @@
+# BuildInfo
+
+Rack middleware to output build information such as version control, bundled gems, and specified files to a webpage.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'ruby_build_info'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ruby_build_info
+
+## Usage
+
+In your `config\environment\development.rb` or environment file of your choosing*:
+    
+    config.middleware.use(RubyBuildInfo::Middleware)
+
+By default this will output Git revision, and output of `bundle show`.
+
+You can specify an array optional file paths, such as version files.
+
+    config.middleware.use(RubyBuildInfo::Middleware, file_paths: ['../custom_file_1', '../custom_file_2'])
+
+*Unless it's production.rb - then I don't condone that.
+
+## Contributing
+
+1. Fork it ( https://github.com/adamgeorgeson/ruby_build_info/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/RELEASENOTES.md

@@ -0,0 +1,5 @@
+# 1.0.0
+
+### Changes
+  * Initial release
+  * Output git revision info, bundle show and optional files to a webpage when user goes to `/build_info`.

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/ruby_build_info.rb

@@ -0,0 +1,6 @@
+require 'ruby_build_info/version'
+require 'rack'
+
+module RubyBuildInfo
+  autoload :Middleware, 'ruby_build_info/middleware'
+end

data/lib/ruby_build_info/middleware.rb

@@ -0,0 +1,50 @@
+module RubyBuildInfo
+  class Middleware
+    require 'json'
+
+    def initialize(app, options = {})
+      @app = app
+      @file_paths = options[:file_paths]
+    end
+
+    def call(env)
+      if env['PATH_INFO'] == '/build_info'
+        @build_info = {}
+        @build_info[:git] = git_revision if git_revision
+        read_file_paths
+        rails_info
+        @build_info[:gems] = bundle_show
+        output = JSON.pretty_generate(@build_info)
+        [200, {'Content-Type' => 'application/json'}, [output]]
+      else
+        @app.call(env)
+      end
+    end
+
+    private
+
+    def bundle_show
+      `bundle show`.gsub(/\n /, '').gsub(/\n/, '').split(' * ')
+    end
+
+    def git_revision
+      `git log --pretty=format:'%ad %h %d' --abbrev-commit --date=short -1`
+    end
+
+    def read_file_paths
+      unless @file_paths.nil?
+        @file_paths.each do |file|
+          raise "File does not exist: #{file}" unless File.exist? file
+          @build_info[file] = `less #{file}`
+        end
+      end
+    end
+
+    def rails_info
+      if defined? Rails
+        result = Rails::Info.properties
+        @build_info['Rails::Info'] = Hash[result]
+      end
+    end
+  end
+end

data/lib/ruby_build_info/version.rb

@@ -0,0 +1,3 @@
+module RubyBuildInfo
+  VERSION = "1.0.1"
+end

data/ruby_build_info.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ruby_build_info/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'ruby_build_info'
+  spec.version       = RubyBuildInfo::VERSION
+  spec.authors       = ['Adam Georgeson']
+  spec.email         = ['adamgeorgeson89@gmail.com']
+  spec.summary       = %q{Rack middleware to output build information such as version control, bundled gems, and specified files to json.}
+  spec.description   = %q{Rack middleware to output build information such as version control, bundled gems, and specified files to json.}
+  spec.homepage      = 'https://github.com/adamgeorgeson/ruby_build_info'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'rack'
+
+  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+end

data/spec/middleware_spec.rb

@@ -0,0 +1,91 @@
+require 'spec_helper'
+
+describe RubyBuildInfo::Middleware do
+  subject{ described_class.new(app) }
+
+  let(:app) do
+    lambda do |env|
+      [200, {'Content-Type' => 'text/html'}, 'Foo']
+    end
+  end
+
+  let(:server){ Rack::MockRequest.new(subject) }
+
+  before do
+    allow(subject).to receive(:bundle_show).and_return('bundle show')
+    allow(subject).to receive(:git_revision).and_return('git revision')
+  end
+
+  describe 'unrecognized path' do
+    it 'outputs app content' do
+      response = server.get('/foo')
+      expect(response.body).to eq 'Foo'
+    end
+  end
+
+  describe '/build_info' do
+    before do
+      @response = server.get('/build_info')
+    end
+
+    it 'outputs build info' do
+      expect(@response.body).to_not eq 'Foo'
+      expect(@response.body).to eq "{\n  \"git\": \"git revision\",\n  \"gems\": \"bundle show\"\n}"
+    end
+
+    it 'returns HTTP status 200' do
+      expect(@response.status). to eq 200
+    end
+  end
+
+  describe 'read_file_paths' do
+    context 'when an invalid file path is specified' do
+      subject{ described_class.new(app, file_paths: ['./foo']) }
+      let(:server){ Rack::MockRequest.new(subject) }
+
+      it 'raises an exception' do
+        expect{ server.get('/build_info') }.to raise_exception
+      end
+    end
+
+    context 'when file_paths is not an array' do
+      subject{ described_class.new(app, file_paths: './spec/support/platform_version') }
+      let(:server){ Rack::MockRequest.new(subject) }
+
+      it 'raises an exception' do
+        expect{ server.get('/build_info') }.to raise_exception
+      end
+    end
+
+    context 'when a valid file path is specified' do
+      subject{ described_class.new(app, file_paths: ['./spec/support/platform_version']) }
+      let(:server){ Rack::MockRequest.new(subject) }
+
+      it 'returns content of the file' do
+        @response = server.get('/build_info')
+        expect(@response.body).to eq "{\n  \"git\": \"git revision\",\n  \"./spec/support/platform_version\": \"1.2.3\\n\",\n  \"gems\": \"bundle show\"\n}"
+      end
+    end
+  end
+
+  describe 'Rails::Info' do
+    before do
+      @response = server.get('/build_info')
+    end
+
+    context 'when rails is not defined' do
+      it 'does not output rails info' do
+        expect(@response.body).to_not include "Rails::Info"
+      end
+    end
+
+    context 'when rails is defined' do
+      xit 'outputs rails info' do
+        rails = double('Rails', :env => :production)
+        Object.send(:const_set, :Rails, rails)
+        expect(Rails).to receive(:env).and_return('production')
+        expect(@response.body).to include "Rails::Info"
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,93 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.requires = ['ruby_build_info']
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+
+=end
+end

data/spec/support/platform_version

@@ -0,0 +1 @@
+1.2.3

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: ruby_build_info
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Adam Georgeson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: rspec
+  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: Rack middleware to output build information such as version control,
+  bundled gems, and specified files to json.
+email:
+- adamgeorgeson89@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- RELEASENOTES.md
+- Rakefile
+- lib/ruby_build_info.rb
+- lib/ruby_build_info/middleware.rb
+- lib/ruby_build_info/version.rb
+- ruby_build_info.gemspec
+- spec/middleware_spec.rb
+- spec/spec_helper.rb
+- spec/support/platform_version
+homepage: https://github.com/adamgeorgeson/ruby_build_info
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Rack middleware to output build information such as version control, bundled
+  gems, and specified files to json.
+test_files:
+- spec/middleware_spec.rb
+- spec/spec_helper.rb
+- spec/support/platform_version