ops 0.5.0 → 0.5.1

data/Gemfile

@@ -8,6 +8,7 @@ group :development, :test do
   gem 'rails-api'
   gem 'rspec'
   gem 'rack-test'
+  gem 'pry'
 end
 
 group :test do

data/Gemfile.lock

@@ -35,6 +35,7 @@ GEM
     arel (4.0.0)
     atomic (1.1.10)
     builder (3.1.4)
+    coderay (1.1.0)
     diff-lcs (1.2.4)
     erubis (2.7.0)
     hike (1.2.3)
@@ -42,10 +43,15 @@ GEM
     mail (2.5.4)
       mime-types (~> 1.16)
       treetop (~> 1.4.8)
+    method_source (0.8.2)
     mime-types (1.23)
     minitest (4.7.5)
     multi_json (1.7.7)
     polyglot (0.3.3)
+    pry (0.9.12.6)
+      coderay (~> 1.0)
+      method_source (~> 0.8)
+      slop (~> 3.4)
     rack (1.5.2)
     rack-protection (1.5.1)
       rack
@@ -87,6 +93,7 @@ GEM
       tilt (~> 1.3, >= 1.3.4)
     sinatra-respond_to (0.9.0)
       sinatra (~> 1.3)
+    slop (3.5.0)
     sprockets (2.10.0)
       hike (~> 1.2)
       multi_json (~> 1.0)
@@ -110,6 +117,7 @@ PLATFORMS
 
 DEPENDENCIES
   ops!
+  pry
   rack-test
   rails
   rails-api

data/README.md

@@ -3,7 +3,14 @@ Ops
 
 [![Code Climate](https://codeclimate.com/github/primedia/ops.png)](https://codeclimate.com/github/primedia/ops)
 
-This gem provides standardized support for obtaining version and heartbeat information from Sinatra or Rails-based web applications.
+This gem provides standardized support for obtaining environment, version, and heartbeat information from Sinatra or Rails-based web applications.
+
+**You will likely want to block or restrict access to the following routes:**
+
+Route         | Notes
+--------------| -----
+`/ops/env`    | Exposes all of your environment variables (e.g. any API keys set as environment variables) to the public
+`/ops/config` | Exposes all of your configuration keys and values to the public (if you're using a configuration service).
 
 Typical usage:
 
@@ -11,6 +18,8 @@ Typical usage:
 /ops/version      - displays version info as HTML
 /ops/version.json - displays version info as JSON
 /ops/heartbeat    - returns 'OK' if the app is alive
+/ops/env          - display the currently set environment variables
+/ops/config       - display all configuration values as JSON (optional)
 ```
 
 This gem replaces the now-deprecated [ops_routes](https://github.com/primedia/ops_routes).
@@ -31,6 +40,7 @@ Installation
     Ops.setup do |config|
       config.file_root = Rails.root
       config.environment = Rails.env
+      config.config_service_adapter = something_that_responds_to_call # optional
     end
     ```
 
@@ -58,6 +68,7 @@ Installation
     Ops.setup do |config|
       config.file_root = File.dirname __FILE__
       config.environment = ENV['RACK_ENV']
+      config.config_service_adapter = something_that_responds_to_call # optional
     end
 
     run Rack::URLMap.new \
@@ -82,9 +93,34 @@ Additionally, you can specify custom heartbeat monitoring pages as follows:
 ```ruby
 Ops.add_heartbeat :mysql do
   conn = ActiveRecord::Base.connection
-  migrations = conn.select_all("SELECT COUNT(1) FROM schema_migrations;") 
+  migrations = conn.select_all("SELECT COUNT(1) FROM schema_migrations;")
   conn.disconnect!
 end
 ```
 
 The mysql example shown above would be accessed at ops/heartbeat/mysql. The heartbeat page will return a `200 ‘OK’` as long as the provided block returns true. If an error is raised, the heartbeat does not exist, or the block returns a falsey value, a `500` will be returned instead.
+
+
+## The Configuration Service Adapter (Optional)
+
+If you wish to use the optional configuration service, you must provide
+something that responds to `#call` with an optional `Hash` argument.
+
+For example:
+
+```ruby
+class MyConfigurationService
+  def call(options = {})
+    { key: 'value' }
+  end
+end
+```
+
+or
+
+```ruby
+Proc.new { |_| { key: 'value' } }
+```
+
+Then just provide your "callable" per the installation instructions above.
+

data/examples/rails3/config/application.rb

@@ -28,6 +28,9 @@ module Rails3
     Ops.setup do |config|
       config.file_root = File.join(Rails.root,'/../sample_deploys/4123')
       config.environment = Rails.env
+
+      # Optionally use a configuration service
+      # config.config_service_adapter = something_that_responds_to_call
     end
 
   end

data/examples/sinatra/config.ru

@@ -10,6 +10,9 @@ use Rack::ShowExceptions
 Ops.setup do |config|
   config.file_root = '../sample_deploys/4123'
   config.environment = ENV['RACK_ENV']
+
+  # Optionally use a configuration service
+  # config.config_service_adapter = something_that_responds_to_call
 end
 
 run Rack::URLMap.new \

data/lib/ops/revision.rb

@@ -1,5 +1,7 @@
 module Ops
   class Revision
+    attr_writer :branch_source
+
     def initialize(new_headers={}, opts = Ops.config)
       @file_root = opts.file_root.to_s # convert to string in case they pass us a Pathname
       @environment = opts.environment
@@ -9,7 +11,7 @@ module Ops
     def version_or_branch
       @version ||= if version_file?
                      chomp(version_file).gsub('^{}', '')
-                   elsif development? && `git branch` =~ /^\* (.*)$/
+                   elsif development? && branch_source.call =~ /^\* (.*)$/
                      $1
                    else
                      'Unknown (VERSION file is missing)'
@@ -113,5 +115,11 @@ module Ops
     def headers
       @headers.select{|k,v| k.match(/^[-A-Z_].*$/) }
     end
+
+    private
+
+    def branch_source
+      @branch_source ||= ->{ `git branch` }
+    end
   end
 end

data/lib/ops/server.rb

@@ -52,6 +52,19 @@ module Ops
         "#{name} does not have a heartbeat"
       end
     end
+
+    get '/config/?' do
+      if config_adapter = Ops.config.config_service_adapter
+        begin
+          body config_adapter.call(params).to_json
+        rescue StandardError => e
+          status 422
+          body({ 'error' => e.message }.to_json)
+        end
+      else
+        status 501
+      end
+    end
   end
 end
 

data/lib/ops/version.rb

@@ -1,3 +1,3 @@
 module Ops
-  VERSION = '0.5.0'
+  VERSION = '0.5.1'
 end

data/spec/ops/revision_spec.rb

@@ -26,7 +26,8 @@ describe Ops::Revision do
   it "development env should have branch" do
     dev_settings = double("settings", {:file_root => @root, :environment => 'development'})
     dev_version = Ops::Revision.new({}, dev_settings)
-    dev_version.version_or_branch.should eq("master")
+    dev_version.branch_source = ->{ "* dev\nsome-topic-branch\nother-topic-branch" }
+    dev_version.version_or_branch.should eq('dev')
   end
 
   it "should have request headers" do
@@ -38,4 +39,4 @@ describe Ops::Revision do
 
   # TODO: add tests for json and previous_version
 
-end
+end

data/spec/ops/server_spec.rb

@@ -0,0 +1,66 @@
+require 'spec_helper'
+require 'rack/test'
+require 'ops/server'
+
+class ReliableConfigService
+  def call(options = {})
+    { foo: 'bar' }
+  end
+end
+
+class ErrorProneConfigService
+  def call(options = {})
+    raise StandardError, 'oops'
+  end
+end
+
+describe Ops::Server do
+  include Rack::Test::Methods
+
+  def app
+    Ops::Server
+  end
+
+  def enable_config_service(adapter)
+    Ops.setup do |config|
+      config.config_service_adapter = adapter
+    end
+  end
+
+  def disable_config_service
+    Ops.setup do |config|
+      config.config_service_adapter = nil
+    end
+  end
+
+  describe 'GET /config' do
+    describe 'when config service is enabled' do
+      it 'responds with response from config service' do
+        enable_config_service(ReliableConfigService.new)
+        get '/config'
+        last_response.status.should == 200
+        body = JSON.parse(last_response.body)
+        body.should == { 'foo' => 'bar' }
+      end
+
+      it 'responds with an error from config service' do
+        enable_config_service(ErrorProneConfigService.new)
+        get '/config'
+        last_response.status.should == 422
+        body = JSON.parse(last_response.body)
+        body.should == { 'error' => 'oops' }
+      end
+    end
+
+    describe 'when config service is disabled' do
+      before do
+        disable_config_service
+      end
+
+      it 'responds with an error' do
+        get '/config'
+        last_response.status.should == 501
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ops
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.1
   prerelease: 
 platform: ruby
 authors:
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-13 00:00:00.000000000 Z
+date: 2014-05-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra
@@ -137,9 +137,6 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -4276810147624476791
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
@@ -147,3 +144,4 @@ signing_key:
 specification_version: 3
 summary: Provide ops info endpoints.
 test_files: []
+has_rdoc: