The public Travis API

Go to file

Konstantin Haase 9e98c3b1f0 Merge branch 'sf-use-services' Conflicts: Gemfile.lock lib/travis/api/app/endpoint/authorization.rb		2012-09-22 18:06:05 +02:00
config	add database.yml	2012-08-05 14:48:19 +02:00
docs	moar typos	2012-09-20 17:16:12 +02:00
lib/travis/api	better origin check	2012-09-22 17:39:42 +02:00
script	disable threaded mode for now	2012-09-18 17:02:01 +02:00
spec	fix test	2012-09-20 14:23:18 +02:00
.gitignore	ignore config/travis.yml	2012-08-10 15:28:23 +02:00
.travis.yml	no jruby for now	2012-08-05 15:20:09 +02:00
config.ru	rewrite all the things	2012-07-27 15:55:57 +02:00
Gemfile	bump deps	2012-09-22 00:48:13 +02:00
Gemfile.lock	Merge branch 'sf-use-services' of github.com:travis-ci/travis-api into sf-use-services	2012-09-22 17:45:49 +02:00
Procfile	rewrite all the things	2012-07-27 15:55:57 +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	add jsonp	2012-09-20 14:53:16 +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