The public Travis API

Go to file

Hiro Asari 30b60283f8 Construct build result URL from parts Currently, there is no easy way to grab this information from the Build model. So we need to construct it from various parts at our disposal.		2013-11-11 09:39:13 -05:00
bin	Add an empty bin/start-nginx wrapper, to allow running Procfile locally	2013-11-05 12:28:13 +01:00
config	Tune GC for unicorn	2013-09-10 11:56:59 +02:00
docs	Correct link to next.travis-ci.org, more Travis CI.	2013-11-07 15:27:07 +01:00
lib	Construct build result URL from parts	2013-11-11 09:39:13 -05:00
public	Add favicon	2013-04-15 02:17:08 -05:00
script	Switch to unicorn	2013-09-02 11:54:04 +02:00
spec	Require travis/testing explicitly	2013-11-08 11:05:55 +01:00
.buildpacks	Try nginx	2013-09-02 09:52:26 +02:00
.gitignore	Ignore log dir	2013-01-19 22:36:58 +01:00
.travis.yml	Use ruby 2.0.0	2013-11-08 13:33:41 +01:00
config.ru	Bump travis-core	2013-09-03 14:37:26 +02:00
CONTRIBUTING.md	First cut generic Contributing.md file for Travis	2013-03-18 23:07:55 -03:00
Gemfile	Use ruby 2.0.0	2013-11-08 13:33:41 +01:00
Gemfile.lock	update travis-core	2013-11-11 11:35:37 +01:00
Procfile	Try nginx	2013-09-02 09:52:26 +02:00
Rakefile	Don't error out on micro migrations on production	2013-03-27 15:13:19 +01:00
README.md	update readme	2012-08-15 02:25:30 +02:00
travis-api.gemspec	WIP: Atom feed for /repos/:owner_name/:name/builds	2013-11-11 09:03:23 -05:00

README.md

The public Travis API

This is the app running on https://api.travis-ci.org/

Installation

Setup:

$ bundle install

Run tests:

$ RAILS_ENV=test rake db:create db:schema:load
$ rake spec

Run the server:

$ rake db:create db:schema:load
$ foreman start

Contributing

Fork it
Create your feature branch (git checkout -b my-new-feature)
Commit your changes (git commit -am 'Add some feature')
Push to the branch (git push origin my-new-feature)
Create new Pull Request

API documentation

We use source code comments to add documentation. If the server is running, you can browse an HTML documenation at /docs.

Project architecture

lib
`-- travis
    `-- api
        `-- app
            |-- endpoint    # API endpoints
            |-- extensions  # Sinatra extensions
            |-- helpers     # Sinatra helpers
            `-- middleware  # Rack middleware

Classes inheriting from Endpoint or Middleware, they will automatically be set up properly.

Each endpoint class gets mapped to a prefix, which defaults to the snake-case class name (i.e. Travis::Api::App::Profile will map to /profile). It can be overridden by setting :prefix:

require 'travis/api/app'

class Travis::Api::App
  class MyRouts < Endpoint
    set :prefix, '/awesome'
  end
end