iridakos / duckrails Goto Github PK

View Code? Open in Web Editor NEW

1.7K 37.0 112.0 3.75 MB

Development tool to mock API endpoints quickly and easily (docker image available)

Home Page: https://github.com/iridakos/duckrails/wiki

License: MIT License

Ruby 59.07% JavaScript 1.01% HTML 8.82% Gherkin 2.79% Shell 0.18% Dockerfile 0.53% SCSS 27.59%

mock developer-tools developers api api-server apis productivity webdev mocking docker

duckrails's Introduction

DuckRails

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 🦆

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

Changing mocks order

Setting general mock properties

Defining the response body

Setting response headers

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

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

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

Fork it ( https://github.com/iridakos/duckrails/fork )
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 a new Pull Request

License

This application is open source under the MIT License terms.

duckrails's People

Contributors

Stargazers

Watchers

Forkers

pakoito avenauche asp7bit azhao1981 donavan jamessmoore lvanhung vijayagrawal18 everpointer pap janusnic buooy uchagani niteshmobikasa anil-mobikasa josephan thesubr00t gustavocaso mkreyman mohammed90 jmh rubythonode thekoehl dotin digideskio intfrr bindulaxminarayan cedev zeff tlatsas atzorvas ruby-rails-dev montazze devenlu raviteja07 vijo karthisl26 libin mten mrphishxxx candidosales antonyr brasilct kevinjam neven7 arcanoid musajoemo allenbyerly phamdt ftvbftvbq farteen muhammadyana dwairi olleolleolle basavarajk yk-ms jackhanm biztrology-kd maniacs-oss w3mg orangesdots firefishy conoraag qwlong s2t2 zenmilan codemilan jchackdragon damenez paulstuartparker wagnerss baaart doctorogg maestrano c0debrain humanagencyorg emanprague aert russa19955 threadstonesecure fishergempage karlitxo cafonso panwar001 kalyanelordao petrosp a-abdellatif98 moocstudent renatovieiradesouza rubynix rheasunshine juniorgasparotto psycholein kananinirav standardgalactic bearerpipelinetest dishanti ravivmc geovanegodoi daivatjadav

duckrails's Issues

How to use query parameters?

Is there currently a way to use optional query parameters for an endpoint?

For example, I would like to be able to use

localhost/v1/route?optional=1&dynamic=1

and still be able to hit localhost/v1/route without the query parameters...

When I attempt to add a query parameter to a mock endpoint then it is automatically "required", or else the endpoint is no longer found when trying to hit it.

Getting request header dynamically using Javascript

Hello,

I'm trying to retrieve a value from a request header for using at body content section for my response. The request header the client sends looks like it:
Authorization: 123#abc

Then, at body content section at DuckRails, I tried to read that value this way:
var header = headers['Authorization'].split('#')[1];

But when I test the response I get a 200 Ok, but with this error:

Duckrails-Error: TypeError: Cannot read property 'split' of undefined

Am I reading the headers in a wrong way?

Create mock with return alternative

How to configure fot accept parameter empty? My ideia is return default value in case
I need create a mock example: /user/v1/user-credential
with params:
document = 123
with return:

{
   "document" : "123"
}

But, i need create same mock name /user/v1/user-credential with return alternative, example:
with params
document = 092
with return

{
   "document" : "092",
   "name" : "Renato"
}

How to make this? I look the documentation, but not found solution.

Request HTTP in ResponseBody

Is possible run request http with javascript into responseBody the of mock? I need to import other lib for decrypt content responseBody.

Please make more accessible

This looks really cool. Can you make a docker image out of it so I don't have to clone the repo?

Route Synchronizer is not multi-worker-safe

The route Synchronizer is not threadsafe and fails to consistently reload routes across threads.

Test case:

Run puma with many threads and a single worker (or low count): puma -t 16:16 -w 0
Add 2 basic mocks. Mock A and Mock B
Run apache bench against Mock A: ab -c 20 -n 200000 http://URL-FOR-MOCK-A
Toggle Mock B on and off a few times.

Expected:
Routes reload as expected.

Observed:
Routes do not load consistently across some app threads and app throws errors due to missing routes.

(PR brewing)

add proxy for get the url at mock.

Create a new page for list all call on Duckrails for list all call at mock.

How do "Creating a dynamic mock that wraps an existing API call" with JavaScript?

i see wiki "Creating a dynamic mock that wraps an existing API call".

But wiki just has ruby sample.I want to do it in JavaScript.Please add an JavaScript Sample

pass JSON values from request to response

Hello,
this is my first work with any mock server.
I am sending from client(via method POST) to duckrails json data.
Is possible pass the values from the clients request into response a return them back to the client?

Thank You

How better computer definition to run duckrails

I'm using an AWS instance of medium type (4gb ram and 2 vcpu), but when the mock is accessed by some cell phones, it is inoperative and sometimes after a few minutes it returns. Anybody can say me tell me something related to this? What is the ideal machine? Is there a different configuration to use?

support dummy-json templates

dummy-json is a useful template engine that lets you create dummy json data very easily

Allow users to clone mocks

Layout missing

After bundle install and rake db:setup, when I run my rails server, the layout is broken (missing). I get errors such as this one:

Started GET "/javascripts/vendor/modernizr.js" for ::1 at 2016-03-19 08:41:12 +0100

ActionController::RoutingError ((╯°□°）╯︵ ┻━┻ : No route matches [GET] "/javascripts/vendor/modernizr.js"):

Tool looks really useful and looking forward to use it!

Allow user to save response bodoy

Hi,

When developing, I'm using Duckrails to mock my API. Sometimes I'd like the same endpoint to respond with a different body (and/or a different status code).

Do you think this could make sense to add this feature?

It can wether be with a "special" query (e.g. ?duckrails_body_name=no_user) or on the web interface?

I'm happy to provide a PR if you are happy with this.

How to require javascript file?

i want to require some *.js file, how can i do.

i've try require('*.js'), but return empty page. i think there is some error with require method

Allow users to move mock under a scope

If I've a lot of mock, it might be nice to be able to prepend the route of all my mocks by something (e.g add /api/v1 to some mock).

I'd love to have a view with all my mocks and drag them to build my desired path.
It might also be interesting to use this feature to create a "common" configuration (e.g. common headers)

If you'd like this feature, I'm happy to propose an implementation.

Cheers :)

Multi-threading

Whenever you do a sleep or proxy data from another service, all mocks and the UI wait for the current operation to finish.

Overwriting headers in Advanced causes 500

DuckRails 2.1.9
Running on Docker

I was just playing around, and wanted to dynamically change responses headers. When I tried returning a JSON object with a headers key I get a 500: "We're sorry, but something went wrong".

To validate that I was writing the JS correctly, I just grabbed your example code for the response body, added the headers key and returned it.

Here is the code

var date = new Date();
date.setDate(date.getDate() -  Math.floor(Math.random() * 30 + 1) );

var obj = {
 "headers":{
       "current_page": Math.floor((Math.random() * 456) + 1),
        "started_reading": date.toDateString()
   }
}

return JSON.stringify(obj);

Expected: Headers would now have a current_page and started_reading key in my curl.

Actual: Return code 500, HTML with

<div class="dialog">
    <div>
      <h1>We're sorry, but something went wrong.</h1>
    </div>
    <p>If you are the application owner check the logs for more information.</p>
  </div>

Provide headers as a hash in the Javascript context

When evaluating Javascript code, provide the headers as a hash.

At the moment the headers are provided as array of two-element arrays making it hard to be accessed in the script.

Current state

[["Content-Type", "text/html"], ["header-name", "header-value"]]

Desired state

{
  "Content-Type": "text/html",
  "header-name": "header-value"
}

Overwrite status code return

How to change status code in return? I have 3 mock and need only one, more with status code different.

Im Try:

var ob = {"status_code": 500};
JSON.stringify(ob);

In Ruby ok:

<%=
{status_code: 500}.to_json
%>

Add titles to links in mocks index page

Add per option in mocks index.

User should be able to define how many mocks wants to view per page.

No route matches

Hi, I am following the github example. After creating a new mock and save the route, when I go to /posts on cloud9 or http://localhost:3000/posts on my local machine I get this error: No route matches [GET] "/posts". Is there something I am missing?

Docker absolute volume path and runtime error

docker run --name=example_iridakos.duckrails.release-v2.1.5 -v=/Users/krystian.panek/Projects/gradle-aem-multi/duckrails:/opt/duckrails/db -p=8080:80 --rm iridakos/duckrails:release-v2.1.5
WARNING: Environment variable SECRET_KEY_BASE has not been set - Setting a random SECRET_KEY_BASE
rake aborted!
ActiveRecord::StatementInvalid: Could not find table 'mocks'
/opt/duckrails/vendor/bundle/ruby/2.4.0/gems/activerecord-4.2.8/lib/active_record/connection_adapters/sqlite3_adapter.rb:501:in `table_structure'
/opt/duckrails/vendor/bundle/ruby/2.4.0/gems/activerecord-4.2.8/lib/active_record/connection_adapters/sqlite3_adapter.rb:375:in `columns'
/opt/duckrails/vendor/bundle/ruby/2.4.0/gems/activerecord-4.2.8/lib/active_record/connection_adapters/schema_cache.rb:43:in `columns'
/opt/duckrails/vendor/bundle/ruby/2.4.0/gems/activerecord-4.2.8/lib/active_record/attributes.rb:93:in `columns'
/opt/duckrails/vendor/bundle/ruby/2.4.0/gems/activerecord-4.2.8/lib/active_record/attributes.rb:98:in `columns_hash'
/opt/duckrails/vendor/bundle/ruby/2.4.0/gems/activerecord-4.2.8/lib/active_record/relation/delegation.rb:48:in `columns_hash'

but when I use just duckrails on the left side of volume it works.

docker run --name=example_iridakos.duckrails.release-v2.1.5 -v=duckrails:/opt/duckrails/db -p=8080:80 --rm iridakos/duckrails:release-v2.1.5

still when using absolute path or relative path, in both cases seems that volume is working / file duckrails/production.sqlite3 is created... so that seems that is is something wrong later on DuckRails runtime side.

this is blocking me in case of using Duckrails on Windows on which I need to support Docker Toolbox in which absolute volume paths usage is essential.

it would be nice to have it fixed :)

greetings, Krystian

Can embedded ruby read post data?

Can the embedded code under advance customization read post data?

feature request - RAML

Hi,
could you please add support for importing/exporting RAML (http://raml.org)?

possible styling issues

i've setup the application and so far it seems to be working, however the styling is definitely off. parts of the page, particularly the header and footer look like the css is mostly missing. my first guess is that it has to do with differences in the foundation-rails gem. what gem version works for you guys?

Provide a mock show page

Provide a mock show page that will allow users to view a mock configuration with a legit layout.

Use code formatting for body content & script
Description links should be rendered as link, not as text

How to export my mocks?

i install duckrails by docker. How can i export mocks data？

Allow export/import of mocks

That would help easy sharing of common mocks.

Allow activation & deactivation of mocks

Add flag to Mock model and don't register the route if it's deactivated.

Update vulnerable gems

Reported by Github:

rails-html-sanitizer ~> 1.0.4

Docker container should not ship with pre-defined SECRET_KEY_BASE

The docker iridakos/duckrails images ships with a static SECRET_KEY_BASE key. This is a security risk, the key should be supplied by user from an ENV when the user runs the container.

(PR brewing to fix)

View request body

Hi guys,

I'm wondering, if there is any way to log body of incomming requests?

Thank you in advance.

Dupplicating a mock

Hello,

I often dupplicate manually many endpoints containing long headers. Which takes very long to copy past to a new one.

It would be great to have a button in a "mock", allowing to "dupplicate a mock".
A modal would show asking which name we want to save the mock as.

Thanks !

How "Advanced mock configuration" writen by JavaScript?

Hello，wiki dosen't has "Advanced mock configuration" JavaScript sample. Could you give me a example？

Add ordering & allow overlapping in mocked routes

User should be allowed to define overlapping routes, for example:

/posts/123
/posts/:post_id

The ordering will allow to set the first one to be matched before the second one.

Where application logs are kept?

Does the app stores incoming requests? If so where does it store them?

Pagination resets after activating a mock

If I'm on the second page of results (e.g. mocks?page=10) and I click the to activate a mock, I am redirect without the page parameter thereby losing what page I'm on.

I need to configure postgres from aws

Is possible connect db postgres: aws, gcp or other?

Im try below:

 environment:
      DATABASE_ADAPTER: postgresql
      DATABASE_PORT: 5432
      DATABASE_NAME: postgres
      DATABASE_USERNAME: postgres
      DATABASE_HOSTNAME: "bd-mock-1.testeteste.us-east-1.rds.amazonaws.com"
      DATABASE_PASSWORD: passwd

log duck:
https://gist.github.com/renatovieiradesouza/6cf37210535cafb3f658d52bd9dc31f9

Where application Logs are?

Where do I find this log that the message says.

Image

Allow mock creation via API

Help execute Duckrails in Docker TTY

Hi Friends, i run Duckrails with docker, more i get error below:

mesg: ttyname failed: Inappropriate ioctl for device

Command executed:
docker run -p 8080:80 -v /Users/renato/duck:/opt/duckrails/db iridakos/duckrails:release-v2.1.0

The output the command above: https://gist.github.com/renasti/09046677fc35a45f4ace54be250a356f

Im using Mac OS X

Support more dynamic content types besides embedded ruby

Like JS.

Support python script as body type

It would be nice to have something like python script as available body type.

I was thinking of creating a template python script which would read from the stdin and then execute(evaluate?) the input.

Then, via ruby, we could start a process (using the childprocess gem) like python lib/python/template.py and send the mock's body to the process' stdin.

Is it possible to execute a python script isolated (in a safe context)?
How could we get the evaluated script's output?

Update Loofah

Dealing with CVE-2018-8048 - Loofah XSS Vulnerability

Validation parameter in advanced mode

Is possible verification in advanced mode:

Not work for me:

var status_code =500;
if (parameters['idOrigem'] == 64){
    var status_code = 200;
    return JSON.stringify(status_code);
} else if (parameters['idOrigem'] == "164") {
   var status_code = 400;
   return JSON.stringify(status_code);
} else {
return JSON.stringify(status_code);
}

Validating incoming data

Hi, this is a cool tool, but a little outside what I was hoping to use it for.

I'm building an XML API which is going to spend most of it's time receiving data rather than serving it - as such, the most important bit is the format in which the data is received - that is, does it match what I'll be expecting?

If something which allows for this type of validation could be added, that would make my life much easier.

Thank you.