0.0
No commit activity in last 3 years
No release in over 3 years
interact with wercker API, Deeper integration with wercker.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

~> 1.15
~> 9.0.6
~> 1.0.0
~> 10.0
~> 3.0
~> 0.49.1
~> 0.14.1
~> 3.0.3
~> 3.0.1

Runtime

~> 1.0.5
 Project Readme

wercker status

WerckerAPI

Thin ruby wrapper around wercker API

Installation

Add this line to your application's Gemfile:

gem 'wercker_api'

And then execute:

$ bundle

Or install it yourself as:

$ gem install wercker_api

Usage

Generate an API token and either pass it as an argument to the WerckerAPI::Client or use the environment variable WERCKER_API_TOKEN

    client = WerckerAPI::Client.new(token)
    client.applications('StupidCodeFactory') # => ApplicationCollection

Trigger a pipeline run PipelineRunner

    client = WerckerAPI::Client.new(token)

    # Will poll the build every 60 seconds for 5 times maximum
    runner = WerckerAPI::PipelineRunner.new(client, max_attempts: 5, delay: 60)

    # Blocking call that polls the pipeline and returns a WorkerAPI::Run instance
    # or raise a WerckerAPI::PipelineRunner::Timeout
    run = runner.run # => #<0x007fa4b509bcd8 WorkerAPI::Run id: '125344f34v34'...>
    run.result       # => 'passed'

API Documentation

Full gem documentation on rubydoc.info and API reference at wercker.com

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/wercker_api.

License

The gem is available as open source under the terms of the MIT License.