jeremycrussell / capitoshka

Simple web API in front of capistrano that translates requests into cap commands.

Capitoshka

Simple web API in front of capistrano that translates requests into cap commands.

Installation

Clone repository:

git clone git://github.com/yevgenko/capitoshka.git

Grab dependencies:

bundle install

Copy capistrano recipes or entire projects as subfolder under .projects directory, e.g.: .projects/foo-bar where foo-bar is a particular project.

Alternatively you can create new recipes as usually with capistrano:

mkdir -p .projects/new-foo-bar
cd .projects/new-foo-bar
capify .

NOTE: the .projects directory can be anywhere on the same server, but defaults to the current path, see Usage section.

Usage

bundle exec ruby app.rb

By default capistrano recipes must be located in .projects directory, but you can change that with CAP_PROJECTS_PATH environment variable, e.g.:

CAP_PROJECTS_PATH="/home/my/.projects" bundle exec ruby app.rb

API

• List projects
• Execute cap command

List projects

GET /projects

Response

{
    "projects": [
        {
            "name": "a"
        },
        {
            "name": "cap-foobar"
        },
        {
            "name": "b"
        }
    ]
}

Execute cap command

POST /projects/:name/cap

Input

• name, required string - The name of project/directory where specific recipes persists;
• args, required array - The command-line parameters to pass to cap command.

Example:

{
    "args":["deploy:check"]
}

Response

{
    "ok"
}

Contributing

1. Fork it
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Added some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create new Pull Request