ZeCollector

ZeCollector collects data related to the app's git repo current state upon application start and sends it using a POST request to any uri of your choice. ZeCollector has been designed to work best with ARMA.

Installation

gem 'zecollector', :git => "https://github.com/semiweb/zecollector.git"

Usage

Create an initializer like so:

Collector.setup do |config|
  config.application       = 'App Name'
  config.installation      = 'Installation Name'
  config.location          = 'Installation Location'
  config.uri               = 'http://[url]'
  config.authorization_key = 'betchaCantFindThis'

  config.on_exception do |exception|
    log_exception(exception)
  end
end

Calling setup will make sure no data is sent if the initializer is loaded with a Rails console or a rake task. If you want always want to send data, use setup! instead.

log_exception will be a custom method of yours that's being called upon exception raising by ZeCollector.

uri: replace [url] with the place where you want to post this data to.

authorization_key: by setting an authorization key to be sent with the data you can check the authenticity of the request in your other application.

And you're done ; )

Here is the data structure of what will be sent:

{
  state: {
    ref:           ref,
    message        message,
    local_commits: number,
    branch:        branch,
    diff:          diff,
    github_repo:   name
  },
  application:       { name: application },
  installation:      { name: installation, location: location, env: Rails.env },
  authorization_key: authorization_key
}

ref: last commit sha that is also present on remote (origin)

message: last commit message that is also present on remote (origin)

local_commits: the number of commits after this one that are not on remote

branch: the current git branch

diff: result of the git diff command

github_repo: name of your applications's github repository

application: name contains the name of your app

installation: we consider that an application can be installed at different places (multiple clients) hence these fields