Project

codeship

0.02
Repository is archived
No commit activity in last 3 years
No release in over 3 years
easily interact with Codeship.io
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

>= 0
>= 0
>= 0

Runtime

>= 0
 Project Readme

Codeship

⚠️⚠️⚠️ This gem only supports v1 of Codeship's API which is deprecated as of July 1st 2018. ⚠️⚠️⚠️

Interact with Codeship.

Codeship Status for codeship/codeship-ruby Gem Version

Contributing

See CONTRIBUTING.md

Installation

Add this line to your application's Gemfile:

gem 'codeship'

And then execute:

$ bundle

Or install it yourself as:

$ gem install codeship

Usage

Check the latest Build

project_status = Codeship::Status.new "my_project_uuid"
project_status.status #=> :success

Check the latest Build on a specific branch

project_status = Codeship::Status.new "my_project_uuid", branch: "development"
project_status.status #=> :error

Get a list of your available projects

projects = Codeship::Projects.new "my_api_key"
projects.list #=> [{"id"=>1, "builds"=>[], "repository_name"=>"abcd/repo-name"}, {"id"=>2, "builds"=>[], "repository_name"=>"abcd/another-repo-name"}]

Get a single project

projects = Codeship::Projects.new "my_api_key"
projects.project 1 #=> {"id"=>1, "builds"=>[], "repository_name"=>"abcd/repo-name"}

States

:branchnotfound, :error, :ignored, :projectnotfound, :success, :testing, :waiting, :stopped, :infrastructure_failure

Disclaimer

We cannot guarantee any compatibilty with upcoming versions of this Gem.

License

Copyright (c) 2017 Codeship.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.