backstop-deploys 0.0.4 → 0.0.5

data/README.md

@@ -18,9 +18,25 @@ Or install it yourself as:
 
 ## Usage
 
-Run `Backstop::Deploys::Web` in your rack application.
+This is generally meant to be coupled with your `backstop` Rack app, but doesn't necessarily have to be.  An example `config.ru`:
 
-Assumes the pressence of `LIBRATO_EMAIL` and `LIBRATO_KEY` in `ENV`.
+```
+$:.unshift File.dirname(__FILE__) + '/lib'
+require "backstop/web"
+require "backstop-deploys"
+
+run Rack::Cascade.new [Backstop::Application, Backstop::Deploys::Web]
+```
+
+It assumes the pressence of `LIBRATO_EMAIL` and `LIBRATO_KEY` in `ENV`.
+
+Example curl interaction:
+
+```bash
+$ curl -X PUT localhost:5000/deploys/my_app.v73.1350581323 -d 'source=production&end_time=1350581423'
+```
+
+The resource id is broken down into `component.version.epoch_time`.  `source` is required in the body and represents the environment that is reporting the deploy, `end_time` is optional.
 
 ## Contributing
 

data/lib/backstop-deploys/version.rb

@@ -1,5 +1,5 @@
 module Backstop
   module Deploys
-    VERSION = '0.0.4'
+    VERSION = '0.0.5'
   end
 end

data/lib/backstop-deploys/web.rb

@@ -38,12 +38,12 @@ module Backstop
           # events already exists, we just need to update
           event = events.first
           event_id = event['id']
-          payload = { :title => "#{app}.#{version}" }
+          payload = { :title => "#{source}.#{app}.#{version}" }
           payload[:end_time] = params[:end_time] if params[:end_time]
           RestClient.put "#{api_endpoint}/annotations/deploys/#{event_id}", payload
         else
           # new event needs to be created
-          payload = { :start_time => start_time, :title => "#{app}.#{version}", :source => source }
+          payload = { :start_time => start_time, :title => "#{source}.#{app}.#{version}", :source => source }
           payload[:end_time] = end_time if end_time
           q = payload.map { |k,v| "#{k}=#{v}" }.sort.join("&")
           RestClient.post "#{api_endpoint}/annotations/deploys", q

data/spec/backstop-deploys/web_spec.rb

@@ -13,10 +13,10 @@ describe Backstop::Deploys::Web do
   let(:api_endpoint) { "https://#{CGI.escape(librato_email)}:#{librato_key}@metrics-api.librato.com/v1" }
   let(:app_name) { 'foo' }
   let(:version) { 'v75' }
+  let(:source) { 'test' }
   let(:t) { Time.now }
   let(:id) { "#{app_name}.#{version}.#{t.to_i}" }
-  let(:title) { "#{app_name}.#{version}" }
-  let(:source) { 'test' }
+  let(:title) { "#{source}.#{app_name}.#{version}" }
   let(:params) { {:source => source} }
 
   before(:each) do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: backstop-deploys
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2012-10-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack-test
-  requirement: &70282066218840 !ruby/object:Gem::Requirement
+  requirement: &70193935516580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70282066218840
+  version_requirements: *70193935516580
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70282066217880 !ruby/object:Gem::Requirement
+  requirement: &70193935530040 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70282066217880
+  version_requirements: *70193935530040
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70282066217260 !ruby/object:Gem::Requirement
+  requirement: &70193935524160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70282066217260
+  version_requirements: *70193935524160
 - !ruby/object:Gem::Dependency
   name: webmock
-  requirement: &70282066216820 !ruby/object:Gem::Requirement
+  requirement: &70193935543080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70282066216820
+  version_requirements: *70193935543080
 - !ruby/object:Gem::Dependency
   name: rest-client
-  requirement: &70282066216280 !ruby/object:Gem::Requirement
+  requirement: &70193935561520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70282066216280
+  version_requirements: *70193935561520
 - !ruby/object:Gem::Dependency
   name: sinatra
-  requirement: &70282066215580 !ruby/object:Gem::Requirement
+  requirement: &70193935557720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,7 +76,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70282066215580
+  version_requirements: *70193935557720
 description: An extension to backstop to allow submission to Librato Metrics
 email:
 - michael.gorsuch@gmail.com