ruby_build_info 1.0.1 → 1.1.1

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    ODEwN2I1YjZiMmQ3YzZkOTgwZDE2Mjc0OTgwYzlmYzg1MjliY2EzYw==
-  data.tar.gz: !binary |-
-    MzlkMzY1OWI3MjM4NDdjOGRkMmIwOTQ0Mzc4MjlhMjJiN2MzYTI5Ng==
+SHA1:
+  metadata.gz: 6f664f0fad026a58de5ab4471f4bb860186bf865
+  data.tar.gz: a7d8311cf396e390987e306c396e5d2fd1c2da7e
 SHA512:
-  metadata.gz: !binary |-
-    NGI0ZjRlYmUxM2E1NWIwZjM4MmRmNmEzMTFiNGY1NzE1ODVmYjc3OGFhZTFi
-    NTNkZTg5NThiN2E5ZmQ2NjZiNzNhMzI1N2YyZWNkNDM5ZTA5MmUyZTFhZDEy
-    OGI3YjJlZmFjODg5OTgyZmE0MGEyZDU2MDliNWYxMzRkMTc2NmY=
-  data.tar.gz: !binary |-
-    ZmFiOWM3YjdmNTVjOTc3NjAzMDA2ZDc4NmRiNWYxNjMyMWI3MTM5ZWU0MjU4
-    N2E0ODQxM2U4NmRjZjdiN2MxYjk4MzUyYTg5OWUyMjk4ODc4MzJmYzg4Zjk2
-    MzcxZmZiZTIxMTlhYzJjMjZkNmNmNTVhYmVkYjQ0MzM4M2I0YzU=
+  metadata.gz: deb863d152672d96f1351b3408b7fd93d1ceb7ed5aa5979b9756aefb006e6663b7947d029383707dadc57f01d7b340069921263da1ebde558897e9b4e71fd8df
+  data.tar.gz: 5ee808c131ece7f48e1c45af96f071e9c39f583748ee1894121f994aa35264a7a5b871382e647bbc7f400057a8006f91517550455d5f7f2a4cfc11eb59c68303

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.1.5

data/Gemfile

@@ -1,4 +1,8 @@
 source 'https://rubygems.org'
 
+group :development, :test do
+  gem 'pry-plus-byebug'
+end
+
 # Specify your gem's dependencies in ruby_build_info.gemspec
 gemspec

data/README.md

@@ -1,8 +1,8 @@
-# BuildInfo
+# RubyBuildInfo [![Gem Version](https://badge.fury.io/rb/ruby_build_info@2x.png)](http://badge.fury.io/rb/ruby_build_info) [![Build Status](https://travis-ci.org/adamgeorgeson/ruby_build_info.svg)](https://travis-ci.org/adamgeorgeson/ruby_build_info)
 
-Rack middleware to output build information such as version control, bundled gems, and specified files to a webpage.
+Rack middleware to output build information such as version control, bundled gems, and specified files to JSON.
 
-## Installation
+## Installation / Usage
 
 Add this line to your application's Gemfile:
 
@@ -16,19 +16,122 @@ Or install it yourself as:
 
     $ gem install ruby_build_info
 
-## Usage
+In your `config\environment\development.rb` or environment file of your choosing:
 
-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`.
+By default this will output Git revision if available, 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.
+You can also provide an optional token in your environment file. When provided, you must pass the token as a parameter to access the endpoint.
+
+    config.middleware.use(RubyBuildInfo::Middleware, token: 'foo')
+    http:://localhost:3000/build_info?token=foo
+
+Go to `/build_info` in your Ruby application to see output, supplying `token` paramater if configured.
+
+## Example Output
+
+```
+{
+  "git": "2015-02-09 a94bb12  (HEAD, tag: v9.9.9, testing_build_info)",
+  "Rails::Info": {
+    "Ruby version": "2.1.5-p273 (x86_64-darwin14.0)",
+    "RubyGems version": "2.2.2",
+    "Rack version": "1.5",
+    "Rails version": "4.1.8",
+    "JavaScript Runtime": "JavaScriptCore",
+    "Active Record version": "4.1.8",
+    "Action Pack version": "4.1.8",
+    "Action View version": "4.1.8",
+    "Action Mailer version": "4.1.8",
+    "Active Support version": "4.1.8",
+    "Middleware": [
+      "Rack::Sendfile",
+      "ActionDispatch::Static",
+      "Rack::Lock",
+      "#<ActiveSupport::Cache::Strategy::LocalCache::Middleware:0x007fb8b17f3228>",
+      "Rack::Runtime",
+      "Rack::MethodOverride",
+      "ActionDispatch::RequestId",
+      "Rails::Rack::Logger",
+      "ActionDispatch::ShowExceptions",
+      "ActionDispatch::DebugExceptions",
+      "ActionDispatch::RemoteIp",
+      "ActionDispatch::Reloader",
+      "ActionDispatch::Callbacks",
+      "ActiveRecord::Migration::CheckPending",
+      "ActiveRecord::ConnectionAdapters::ConnectionManagement",
+      "ActiveRecord::QueryCache",
+      "ActionDispatch::Cookies",
+      "ActionDispatch::Session::CookieStore",
+      "ActionDispatch::Flash",
+      "ActionDispatch::ParamsParser",
+      "Rack::Head",
+      "Rack::ConditionalGet",
+      "Rack::ETag",
+      "RubyBuildInfo::Middleware"
+    ],
+    "Application root": "/Users/adamgeorgeson/dev/git_app",
+    "Environment": "development",
+    "Database adapter": "sqlite3",
+    "Database schema version": 0
+  },
+  "gems": [
+    "Gems included by the bundle:",
+    "actionmailer (4.1.8)",
+    "actionpack (4.1.8)",
+    "actionview (4.1.8)",
+    "activemodel (4.1.8)",
+    "activerecord (4.1.8)",
+    "activesupport (4.1.8)",
+    "arel (5.0.1.20140414130214)",
+    "builder (3.2.2)",
+    "bundler (1.8.0)",
+    "coffee-rails (4.0.1)",
+    "coffee-script (2.3.0)",
+    "coffee-script-source (1.9.0)",
+    "erubis (2.7.0)",
+    "execjs (2.3.0)",
+    "hike (1.2.3)",
+    "i18n (0.7.0)",
+    "jbuilder (2.2.6)",
+    "jquery-rails (3.1.2)",
+    "json (1.8.2)",
+    "mail (2.6.3)",
+    "mime-types (2.4.3)",
+    "minitest (5.5.1)",
+    "multi_json (1.10.1)",
+    "rack (1.5.2)",
+    "rack-test (0.6.3)",
+    "rails (4.1.8)",
+    "railties (4.1.8)",
+    "rake (10.4.2)",
+    "rdoc (4.2.0)",
+    "ruby_build_info (1.0.1)",
+    "sass (3.2.19)",
+    "sass-rails (4.0.5)",
+    "sdoc (0.4.1)",
+    "spring (1.3.1)",
+    "sprockets (2.12.3)",
+    "sprockets-rails (2.2.4)",
+    "sqlite3 (1.3.10)",
+    "thor (0.19.1)",
+    "thread_safe (0.3.4)",
+    "tilt (1.4.1)",
+    "turbolinks (2.5.3)",
+    "tzinfo (1.2.2)",
+    "uglifier (2.7.0)"
+  ]
+}
+```
+
+## Viewing tools
+When viewing JSON in a browser, you can use a plugin for a prettier
+view. An example Chrome extension: https://github.com/gildas-lormeau/JSONView-for-Chrome
 
 ## Contributing
 

data/RELEASENOTES.md

@@ -1,4 +1,9 @@
-# 1.0.0
+# 1.1.0
+
+### Changes
+  * Support to protect endpoint by configuring a token.
+
+# 1.0.0 / 1.0.1
 
 ### Changes
   * Initial release

data/Rakefile

@@ -1,2 +1,5 @@
 require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+task :default => :spec
+RSpec::Core::RakeTask.new
 

data/lib/ruby_build_info/middleware.rb

@@ -5,12 +5,16 @@ module RubyBuildInfo
     def initialize(app, options = {})
       @app = app
       @file_paths = options[:file_paths]
+      @token = options[:token]
     end
 
     def call(env)
       if env['PATH_INFO'] == '/build_info'
+        @env = env
+        return @app.call(env) unless token_valid?
+
         @build_info = {}
-        @build_info[:git] = git_revision if git_revision
+        @build_info[:git] = git_revision unless git_revision.empty?
         read_file_paths
         rails_info
         @build_info[:gems] = bundle_show
@@ -32,7 +36,7 @@ module RubyBuildInfo
     end
 
     def read_file_paths
-      unless @file_paths.nil?
+      if @file_paths
         @file_paths.each do |file|
           raise "File does not exist: #{file}" unless File.exist? file
           @build_info[file] = `less #{file}`
@@ -40,11 +44,31 @@ module RubyBuildInfo
       end
     end
 
+    def params
+      query_string = @env['QUERY_STRING']
+      return nil if query_string.nil?
+      Hash[query_string.split('&').map{ |q| q.split('=') }]
+    end
+
+    def rails_defined?
+      defined? Rails
+    end
+
     def rails_info
-      if defined? Rails
+      if rails_defined?
         result = Rails::Info.properties
         @build_info['Rails::Info'] = Hash[result]
       end
     end
+
+    def token_param
+      params['token'] if params
+    end
+
+    def token_valid?
+      return true if @token.nil?
+      return false if token_param.nil?
+      token_param == @token
+    end
   end
 end

data/lib/ruby_build_info/version.rb

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

data/ruby_build_info.gemspec

@@ -18,9 +18,9 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'rack'
+  spec.add_dependency 'rack', '~> 1.0'
 
-  spec.add_development_dependency 'bundler', '~> 1.6'
-  spec.add_development_dependency 'rake'
-  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.4'
+  spec.add_development_dependency 'rspec', '~> 3.2'
 end

data/spec/middleware_spec.rb

@@ -1,4 +1,5 @@
 require 'spec_helper'
+require 'support/info'
 
 describe RubyBuildInfo::Middleware do
   subject{ described_class.new(app) }
@@ -14,6 +15,7 @@ describe RubyBuildInfo::Middleware do
   before do
     allow(subject).to receive(:bundle_show).and_return('bundle show')
     allow(subject).to receive(:git_revision).and_return('git revision')
+    allow(subject).to receive(:rails_defined?).and_return false
   end
 
   describe 'unrecognized path' do
@@ -24,17 +26,43 @@ describe RubyBuildInfo::Middleware do
   end
 
   describe '/build_info' do
-    before do
-      @response = server.get('/build_info')
-    end
+    let(:example_response) { "{\n  \"git\": \"git revision\",\n  \"gems\": \"bundle show\"\n}" }
+
+    context 'when a token configured' do
+      subject{ described_class.new(app, token: 'foo') }
+      let(:server){ Rack::MockRequest.new(subject) }
+
+      it 'outputs build info when token matches param' do
+        @response = server.get('/build_info?token=foo&param2=value2')
+        expect(@response.body).to_not eq 'Foo'
+        expect(@response.body).to eq example_response
+        expect(@response.status). to eq 200
+      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}"
+      it 'does not output build info when token does not match param' do
+        @response = server.get('/build_info?param1=value1&token=bar')
+        expect(@response.body).to eq 'Foo'
+        expect(@response.body).to_not eq example_response
+        expect(@response.status). to eq 200
+      end
     end
 
-    it 'returns HTTP status 200' do
-      expect(@response.status). to eq 200
+    context 'when a token is not configured' do
+      subject{ described_class.new(app) }
+      let(:server){ Rack::MockRequest.new(subject) }
+
+      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 example_response
+      end
+
+      it 'returns HTTP status 200' do
+        expect(@response.status). to eq 200
+      end
     end
   end
 
@@ -62,28 +90,27 @@ describe RubyBuildInfo::Middleware do
       let(:server){ Rack::MockRequest.new(subject) }
 
       it 'returns content of the file' do
+        expected_response = "{\n  \"git\": \"git revision\",\n  \"./spec/support/platform_version\": \"1.2.3\\n\",\n  \"gems\": \"bundle show\"\n}"
         @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}"
+        expect(@response.body).to eq expected_response
       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
+        @response = server.get('/build_info')
         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')
+      before do
+      end
+      it 'outputs rails info' do
+        allow(subject).to receive(:rails_defined?).and_return true
+        @response = server.get('/build_info')
         expect(@response.body).to include "Rails::Info"
       end
     end

data/spec/spec_helper.rb

@@ -16,6 +16,9 @@
 # users commonly want.
 #
 # See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+
+require 'pry-rescue/rspec'
+
 RSpec.configure do |config|
   config.requires = ['ruby_build_info']
   # rspec-expectations config goes here. You can use an alternate

data/spec/support/info.rb

@@ -0,0 +1,7 @@
+module Rails
+  module Info
+    def self.properties
+      {'key1' => 'value1'}
+    end
+  end
+end

metadata

@@ -1,71 +1,71 @@
 --- !ruby/object:Gem::Specification
 name: ruby_build_info
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.1
 platform: ruby
 authors:
 - Adam Georgeson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-12 00:00:00.000000000 Z
+date: 2015-05-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '1.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '1.7'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.4'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.2'
 description: Rack middleware to output build information such as version control,
   bundled gems, and specified files to json.
 email:
@@ -74,7 +74,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -86,6 +87,7 @@ files:
 - ruby_build_info.gemspec
 - spec/middleware_spec.rb
 - spec/spec_helper.rb
+- spec/support/info.rb
 - spec/support/platform_version
 homepage: https://github.com/adamgeorgeson/ruby_build_info
 licenses:
@@ -97,17 +99,17 @@ 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
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: Rack middleware to output build information such as version control, bundled
@@ -115,4 +117,6 @@ summary: Rack middleware to output build information such as version control, bu
 test_files:
 - spec/middleware_spec.rb
 - spec/spec_helper.rb
+- spec/support/info.rb
 - spec/support/platform_version
+has_rdoc: