badgerkit

Gem Version Build Status Coverage Status Code Climate Dependency Status

Simple api wrapper for submitting data to https://badgerhq.com

Installation

Add this line to your application's Gemfile:

gem 'badgerkit', :group => [:development, :test]

And then execute:

$ bundle

Usage

Without environment variables:

client = Badgerkit.new(
  :access_token => '0dbce1478e94053d4282ccd4ace154c82a3475d5',
  :source       => 'github',
  :repo         => 'badgerhq/badgerkit.rb'
)

client.post('Documentation',
  :value       => 80,
  :commit_sha1 => '0dbce1478e94053d4282ccd4ace154c82a3475d5',
  :branch      => 'master',
  :archive     => Badgerkit.archive('doc/')
)

With the following environment variables:

ENV['BADGER_ACCESS_TOKEN'] = '0dbce1478e94053d4282ccd4ace154c82a3475d5'
ENV['BADGER_SOURCE']       = 'github'
ENV['BADGER_REPO']         = 'badgerhq/badgerkit.rb'

Badgerkit.post('Documentation',
  :value       => 80,
  :commit_sha1 => '0dbce1478e94053d4282ccd4ace154c82a3475d5',
  :branch      => 'master',
  :archive     => Badgerkit.archive('doc/')
)

Supported Ruby Versions

This library is tested against Travis and aims to support the following Ruby implementations:

  • Ruby 1.9.3
  • Ruby 2.0.0
  • Ruby 2.1.1

Contributing

  1. Fork it ( http://github.com//badgekit/fork )
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request