Service Skeleton

Service skeleton application that provides all necessary tools to build an API service or even more.

Components

• Sinatra - Web framework
• JSON - Parse and generate JSON data
• Foreman - Process manager, integrates with updates, supervisord
• Puma - Web server, similar to Unicorn
• Dotenv - Environment variables loader
• Rspec - Testing framework
• Active Record 4 - Database adapter
• Postgres Adapter - PostgreSQL database connector for AR
• Sentry - Exception notifications
• Capistrano - Deployment automation

Getting Started

Clone repository and install dependencies:

git clone https://github.com/doejo/service-skeleton.git myapp
cd myapp
bundle install

Copy sample configuration files:

cp .env.sample .env
cp config/database.yml.sample config/database.yml

Create and migrate database:

rake db:create db:migrate

Re-initialize git repository (optional):

rake init

Start development server:

foreman start

By default, the service will be available at http://localhost:5000

Rake tasks

rake console                # Start application console
rake db:create              # Creates the database from DATABASE_URL or config/database.yml for the current RAILS_ENV (use db:create:all to create all databases in the config)
rake db:create_migration    # Create a migration (parameters: NAME, VERSION)
rake db:drop                # Drops the database from DATABASE_URL or config/database.yml for the current RAILS_ENV (use db:drop:all to drop all databases in the config)
rake db:fixtures:load       # Load fixtures into the current environment's database
rake db:migrate             # Migrate the database (options: VERSION=x, VERBOSE=false, SCOPE=blog)
rake db:migrate:status      # Display status of migrations
rake db:rollback            # Rolls the schema back to the previous version (specify steps w/ STEP=n)
rake db:schema:cache:clear  # Clear a db/schema_cache.dump file
rake db:schema:cache:dump   # Create a db/schema_cache.dump file
rake db:schema:dump         # Create a db/schema.rb file that is portable against any DB supported by AR
rake db:schema:load         # Load a schema.rb file into the database
rake db:seed                # Load the seed data from db/seeds.rb
rake db:setup               # Create the database, load the schema, and initialize with the seed data (use db:reset to also drop the database first)
rake db:structure:dump      # Dump the database structure to db/structure.sql
rake db:structure:load      # Recreate the databases from the structure.sql file
rake db:version             # Retrieves the current schema version number
rake init                   # Reinitialize git repository
rake raven:test[dsn]        # Send a test event to the remote Sentry server
rake test                   # Run RSpec code examples

Background jobs

If you want to run background jobs, use sidekiq. First step, add sidekiq gem into Gemfile:

# Lastest sidekiq version at the time
gem "sidekiq", "3.2.1"

Then uncomment code in config/initializers/sidekiq.rb file. Initializer specifies server and client connection settings. These are pretty much defaults from sidekiq's wiki.

Last step is to enable sidekiq in Procfile:

worker: bundle exec sidekiq

Middleware

Skeleton application includes a few useful middleware modules:

• Exception notifications (via Sentry)
• Exception handling (respond with json on crashes)
• Request logger (dumps request data into log in dev mode)
• Revision header injection (adds X-Revision)
• Runtime header injection (adds X-Runtime)

Deployment

Deployment is done via Capistrano.

Check config/deploy.rb for generic deployment steps. Deployment stages are located under config/deploy directory.

Deployment tasks:

cap [stage] deploy:setup # Setup deployment structure on the server
cap [stage] deploy       # Execute deployment

If you plan on using Sentry for exceptions tracking, make sure to test your configuration. You can do that by running a rake task:

SENTRY_URL=your_sentry_url rake raven:test

Testing

Prepare test database first:

rake db:create RACK_ENV=test
rake db:schema:load RACK_ENV=test

Execute test suite:

rake test

License

The MIT License

Copyright (c) 2014-2015 Doejo LLC