Skip to content
Branch: master
Clone or download
iridakos Merge pull request #42 from eManPrague/add-compose-and-postgresql-sup…
…port

Add docker-compose for single (sqlite3) or with DB (postgresql), upda…
Latest commit 25665ef Jan 8, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
app Add per parameter in index of mocks. Refs #25. Dec 13, 2017
bin Update spring file. Nov 5, 2017
config Add docker-compose for single (sqlite3) or with DB (postgresql), upda… Jan 8, 2019
db
documentation
features Fix cucumber step. Nov 5, 2017
lib
public Change logo. Nov 18, 2017
script Add basic cucumber configuration. Mar 26, 2016
spec Add per parameter in index of mocks. Refs #25. Dec 13, 2017
vendor/assets/javascript Add html sortable support. Apr 10, 2016
.dockerignore
.gitignore Configure ruby version & gemset. Nov 5, 2017
.rspec
.ruby-gemset
.ruby-version Update Dockerfile and remove hardcoded SECRET_KEY_BASE Mar 9, 2018
.travis.yml Update Dockerfile and remove hardcoded SECRET_KEY_BASE Mar 9, 2018
Dockerfile Add docker-compose for single (sqlite3) or with DB (postgresql), upda… Jan 8, 2019
Gemfile
Gemfile.lock Add docker-compose for single (sqlite3) or with DB (postgresql), upda… Jan 8, 2019
LICENSE
README.md Update README.md Sep 25, 2018
Rakefile
config.ru Initial commit. Mar 5, 2016
docker-compose-single.yml
docker-compose.yml
docker-entrypoint.sh

README.md

DuckRails GitHub version Build Status

DuckRails is a development tool.

Its main purpose is to allow developers to quickly mock API endpoints that for many possible reasons they can't reach at a specific time.

If it looks like a duck, walks like a duck and quacks like a duck, then it's a duck 🦆

Home Page

How it works

The application allows creating new routes dynamically to which developers can assign static or dynamic responses:

  • body
  • headers
  • content type
  • status code

or even cause delays, timeouts etc.

Guides

The repository's wiki pages contain all you need to know.

You can find the old DuckRails' guides at my blog.

Example

Mocks index page

Mocks index page

Changing mocks order

Change mocks order

Setting general mock properties

General mock properties

Defining the response body

Defining the response body

Setting response headers

Setting response headers

Setting some advanced configuration (delays, dynamic headers, content type & status)

Advanced configuration

Upon save the route becomes available to the application and you can use the endpoint:

Request Headers

Supported response functionality

You can define static or dynamic responses for a mock.

Currently supported dynamic types are:

  • Embedded Ruby
  • JavaScript

Embedded Ruby

When specifying dynamic content of embedded Ruby (more options to be added), you can read as local variables:

  • @parameters: The parameters of the request
  • @request: The request
  • @response: The response

JavaScript

When specifying dynamic content of JavaScript type, you can read as local variables:

  • parameters: The parameters of the request
  • headers: The request headers

The script should always return a string (for JSON use JSON.stringify(your_variable))

Route paths

You can specify routes and access their parts in the @parameters variable, for example:

/authors/:author_id/posts/:post_id

give you access to the parameters with:

@parameters[:author_id]

@parameters[:post_id]

Quick setup (development environment)

  • Clone the repository.
  • Copy the sample database configuration file (config/database.yml.sample) under config/database.yml and edit it to reflect your preferred db configuration (defaults to sqlite3). If you change the database adapter, make sure you include the appropriate gem in your Gemfile (ex. for mysql gem 'mysql2')
  • Execute bundle install to install the required gems.
  • Execute rake db:setup to setup the database.
  • Execute rails server to start the application on the default port.
  • Duckrails can be run concurrently and in parallelism, thus instead of the default rails server, you may start the puma server with something like: bundle exec puma -t 8:16 -w 3

Better setup (production environment)

  • Clone the repository.
  • Copy the sample database configuration file (config/database.yml.sample) under config/database.yml and edit it to reflect your preferred db configuration (defaults to sqlite3). If you change the database adapter, make sure you include the appropriate gem in your Gemfile (ex. for mysql gem 'mysql2')
  • Execute bundle install to install the required gems.
  • Export an env variable for your secret key base: export SECRET_KEY_BASE="your_secret_key_base_here"
  • Execute RAILS_ENV=production rake db:setup to setup the database.
  • Execute RAILS_ENV=production rake assets:precompile to generate the assets.
  • Execute bundle exec rails s -e production to start the application on the default port.
  • Duckrails can be run concurrently and in parallelism, thus instead of the default rails server, you may start the puma server with something like: RAILS_ENV=production bundle exec puma -t 8:16 -w 3

Database configuration

The application is by default configured to use sqlite3. If you want to use another configuration, update the config/database.yml accordingly to match your setup.

Docker

A docker image is available at docker hub under iridakos/duckrails.

To obtain the image use:

docker pull iridakos/duckrails

To start the application and bind it to a port (ex. 4000) use:

docker run -p 4000:80 iridakos/duckrails:latest

Contributing

  1. Fork it ( https://github.com/iridakos/duckrails/fork )
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request

License

This application is open source under the MIT License terms.

You can’t perform that action at this time.