mini_check 0.2.0 → 0.3.0

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    MTNjYTk4MjlmODFmYzMwNjhhNTE5MzA5MGJjNTg5MTBlMmVkNzQ4Yw==
-  data.tar.gz: !binary |-
-    MGNjNDMwMmNmYTM2NWNhYWNhMDUxMmQ1NmM5ZGRiYWEwOTk2MzlhYg==
+SHA1:
+  metadata.gz: 20ef9ea5afbc7e220b1e81163a628c15267ae813
+  data.tar.gz: 5d4cdbf4c58aaa06595f0d3a7e239a3a8fee0de2
 SHA512:
-  metadata.gz: !binary |-
-    MTUwNmZjYTY3YmE0NmIxMzJjN2IyOTVjYjAwMzBkMGExOWMzYjU2Y2Y5NGU1
-    YTE1NDFmNGQ2MTRjZDgwOTVmYjkxOGRmMWFmMzk3YTc1YjI3MjQ1N2U0NjYx
-    NWVjZTA5MmRkYzA4ODFkOWU4N2NhMjE1ODg4YThjMmNjOTA5Njg=
-  data.tar.gz: !binary |-
-    ODJmZmZlNWI3ODc0YjM1Y2E3NTE5NDg5MGU4NzNlMzlhOGNjZGMwYTg0NGU0
-    ZWRkNDAzYmZkNzAxMTk0ODZkNDVmMGRmNWY1YWMxN2M2YTllNTQ1NWIwZmQy
-    ODJlMTJlMTE3YTFjZjc4ODNiYmY1MTNlYWRlZjA5MDE2ODI3MDA=
+  metadata.gz: e5c6612eb00859f651ac8c40caeda10379651e323dd88ab6ebbca6e15223ab9dc72c45aeae31995990284ecc39951b964c60d370377ac10c623aa3c8148d5f59
+  data.tar.gz: 35521fa95e56d56b3ba71fd8dde9ac053a660369cba356c2909a6b7ab89fdd370b7215f68361f3e01d11f97bb2fd4f81a1f619f4965fa299f54165113b7c6a3d

data/Gemfile

@@ -4,7 +4,7 @@ gemspec
 
 group :test, :development do
   gem 'rake'
-  gem 'rspec'
+  gem 'rspec', '~> 2.14.0'
   gem 'pry'
   gem 'rack-test'
   gem 'codeclimate-test-reporter', require: false

data/README.md

@@ -67,6 +67,37 @@ The registered lambdas should do any of the following things:
 
 The http status code will be 200 if all checks are healthy and 500 otherwise.
 
+## Version
+
+```ruby
+MyVersionCheck = MiniCheck::VersionRackApp.new(name: 'Cards', path: '/admin/version', build_file: './config/build.yml').tap do |app|
+    app.metadata["Whatever Here"] = "Bla Bla"
+    ...
+end
+```
+
+The build_file can be a YML or a plain text file. It needs to have pairs key-values.
+
+If you now visit `http://localhost:XXXX/admin/version.json` you should get something like:
+
+```json
+{
+  "Application Name": "Cards",
+  "Whatever Here": "Bla Bla"
+}
+```
+
+If you now visit `http://localhost:XXXX/admin/version` you should get something like:
+
+```
+  Application Name=Cards
+  Whatever Here=Bla Bla
+```
+
+## Maintaining
+
+Here is a good tutorial on this: 
+[Developing a RubyGem using Bundler](https://github.com/radar/guides/blob/master/gem-development.md).
 
 ## License
 

data/lib/mini_check/version.rb

@@ -1,3 +1,3 @@
 module MiniCheck
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'
 end

data/lib/mini_check/version_rack_app.rb

@@ -0,0 +1,88 @@
+require 'yaml'
+
+module MiniCheck
+  class VersionRackApp
+    attr_accessor :path, :build_file
+
+    def initialize args = {}
+      set_attributes args
+    end
+    
+    def metadata
+      @metadata ||= Hash.new
+    end
+    
+    def call env
+      case "#{env['REQUEST_METHOD']} #{env['PATH_INFO']}"
+      when "GET #{path}.json"
+        JsonResponse.render(output_hash)
+      when "GET #{path}"
+        PlainTextResponse.render(output_hash)
+      else
+        host_app.call(env)
+      end
+    end
+
+    def new(app)
+      copy = self.dup
+      copy.host_app = app
+      copy
+    end
+
+
+    private
+
+    def name= name
+      metadata["Application Name"] = name
+    end
+
+    def set_attributes args = {}
+      args.each do |k,v|
+        send("#{k}=", v)
+      end
+    end
+    
+    def output_hash
+      metadata.merge(file_hash)
+    end
+    
+    def file_hash
+      if (content = YAML.load_file(build_file)).instance_of?(Hash)
+        content
+      else
+        content = IO.read(build_file).split("\n")
+        Hash[content.map{ |pair| pair.split("=") }]
+      end
+    rescue => ex
+      { error: ex.message }
+    end
+    
+    
+    protected
+
+    attr_accessor :host_app
+
+    def host_app
+      @host_app ||= lambda{|env|  [404, {}, []]}
+    end
+    
+    
+    class JsonResponse
+      def self.render hash
+        [200, {'Content-Type' => 'application/json'}, [hash.to_json]]
+      end
+    end
+    
+    class PlainTextResponse
+      def self.render hash
+        [200, {'Content-Type' => 'text/plain'}, [parse(hash)]]
+      end
+      
+      private
+      
+      def self.parse hash
+        hash.map{ |key,value| "#{key}=#{value}" }.join("\n")
+      end
+    end
+  end
+end

data/lib/mini_check.rb

@@ -5,4 +5,5 @@ module MiniCheck
   autoload :Check, 'mini_check/check'
   autoload :ChecksCollection, 'mini_check/checks_collection'
   autoload :RackApp, 'mini_check/rack_app'
+  autoload :VersionRackApp, 'mini_check/version_rack_app'
 end

data/spec/mini_check/version_rack_app_spec.rb

@@ -0,0 +1,98 @@
+require_relative '../helper'
+require 'rack/test'
+
+describe MiniCheck::VersionRackApp do
+  include Rack::Test::Methods
+
+  subject{ MiniCheck::VersionRackApp.new path: '/version', build_file: './spec/support/build.yml', name: "Paquito"}
+  let(:version_hash) { {"Application Name" => "Paquito"} }
+  let(:version_text) { "Application Name=Paquito" }
+  let(:app){ subject }
+
+  def status
+    last_response.status
+  end
+
+  def headers
+    last_response.headers
+  end
+
+  def body
+    last_response.body
+  end
+
+  def body_json
+    JSON.parse(body)
+  end
+
+  describe :call do
+    it 'returns status, headers, body' do
+      get '/'
+      expect(status).to be_a(Fixnum)
+      expect(headers).to be_a(Hash)
+      expect(body).to be_a(String)
+    end
+
+    context 'unknown path' do
+      it 'returns status 404 when no host app is given' do
+        get '/blahblah'
+        expect(status).to eq(404)
+      end
+
+      it 'delegates to the host app if given' do
+        app.send(:host_app=, lambda{|env| [999, {}, []] })
+        get '/blahblah'
+        expect(status).to eq(999)
+      end
+    end
+
+    context 'unknown verb' do
+      it 'returns status 404' do
+        post '/version'
+        expect(status).to eq(404)
+      end
+    end
+
+    context 'GET /version.json' do
+      def do_request
+        get '/version.json'
+      end
+
+      it 'returns status 200' do
+        do_request
+        expect(status).to eq(200)
+      end
+
+      it 'returns content type json' do
+        do_request
+        expect(headers['Content-Type']).to eq('application/json')
+      end
+
+      it 'returns JSON body' do
+        do_request
+        expect(JSON.parse(body)).to eq(version_hash)
+      end
+    end
+    
+    context 'GET /version' do
+      def do_request
+        get '/version'
+      end
+
+      it 'returns status 200' do
+        do_request
+        expect(status).to eq(200)
+      end
+
+      it 'returns content type plain text' do
+        do_request
+        expect(headers['Content-Type']).to eq('text/plain')
+      end
+
+      it 'returns text body' do
+        do_request
+        expect(body).to eq(version_text)
+      end
+    end
+  end
+end

metadata

@@ -1,41 +1,41 @@
 --- !ruby/object:Gem::Specification
 name: mini_check
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Manuel Morales
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-13 00:00:00.000000000 Z
+date: 2015-02-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
   name: json
   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'
 description: MiniCheck provides a simple Rack application for adding simple health
@@ -46,8 +46,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .travis.yml
+- ".gitignore"
+- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.md
@@ -58,12 +58,15 @@ files:
 - lib/mini_check/checks_collection.rb
 - lib/mini_check/rack_app.rb
 - lib/mini_check/version.rb
+- lib/mini_check/version_rack_app.rb
 - mini_check.gemspec
 - spec/helper.rb
 - spec/mini_check/check_spec.rb
 - spec/mini_check/checks_collection_spec.rb
 - spec/mini_check/rack_app_spec.rb
+- spec/mini_check/version_rack_app_spec.rb
 - spec/mini_check_spec.rb
+- spec/support/build.yml
 homepage: https://github.com/workshare/mini-check
 licenses:
 - MIT
@@ -74,17 +77,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.1.11
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: MiniCheck provides a simple Rack application for adding simple health checks
@@ -94,4 +97,7 @@ test_files:
 - spec/mini_check/check_spec.rb
 - spec/mini_check/checks_collection_spec.rb
 - spec/mini_check/rack_app_spec.rb
+- spec/mini_check/version_rack_app_spec.rb
 - spec/mini_check_spec.rb
+- spec/support/build.yml
+has_rdoc: