The public Travis API

Go to file

Piotr Sarnacki 2f87153df9 Move CORS middleware in front of the stack If there is an error somewhere along the line (like in DB connection management), it should not interfere with returning proper result for OPTIONS request. Otherwise it's hard to guess why the actual request in the browser was not properly sent.		2012-11-05 21:48:13 +01:00
config	try syncing stdout	2012-10-07 20:52:25 +02:00
docs	more documentation	2012-09-22 19:22:43 +02:00
lib/travis/api	Move CORS middleware in front of the stack	2012-11-05 21:48:13 +01:00
public/images/result	moar work on acceptance tests	2012-10-02 19:10:29 +02:00
script	add missing file	2012-10-23 00:27:06 +02:00
spec	Move CORS middleware in front of the stack	2012-11-05 21:48:13 +01:00
.gitignore	ignore config/travis.yml	2012-08-10 15:28:23 +02:00
.travis.yml	Update .travis.yml	2012-10-11 15:51:47 -07:00
config.ru	try syncing stdout	2012-10-07 20:52:25 +02:00
Gemfile	use travis-core/master	2012-11-02 20:56:16 +01:00
Gemfile.lock	bump travis-core	2012-11-05 16:11:23 +01:00
Procfile	add console	2012-10-23 00:24:23 +02:00
Rakefile	actually use gemspec	2012-08-05 14:42:05 +02:00
README.md	update readme	2012-08-15 02:25:30 +02:00
travis-api.gemspec	move helpers around	2012-09-28 16:54:29 +02: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