concrete

.docker-ignore

@@ -0,0 +1,12 @@
+Dockerfile
+docker-compose.yml
+out
+.gradle
+.idea
+build
+out
+.gitignore
+.travis.yml
+CONTRIBUTING.md
+LICENSE
+README.md

.gitignore

@@ -1,22 +1,36 @@
-# Compiled class file
-*.class
+target/
+.mvn/
 
-# Log file
-*.log
+application-*.yml
 
-# BlueJ files
-*.ctxt
+### STS ###
+.classpath
+.factorypath
+.project
+.settings
+.springBeans
 
-# Mobile Tools for Java (J2ME)
-.mtj.tmp/
+### IntelliJ IDEA ###
+.idea
+*.iws
+*.iml
+*.ipr
+*.DS_Store
 
-# Package Files #
-*.jar
-*.war
-*.ear
-*.zip
-*.tar.gz
-*.rar
+### NetBeans ###
+nbproject/private/
+build/
+nbbuild/
+dist/
+nbdist/
+.nb-gradle/
 
-# virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml
-hs_err_pid*
+.gradle/
+
+### Application ###
+backup-temp/
+mocks-prod
+fake-api-data
+out
+bin
+.vscode

.travis.yml

@@ -0,0 +1,18 @@
+language: java
+jdk:
+- oraclejdk8
+before_cache:
+- rm -f  $HOME/.gradle/caches/modules-2/modules-2.lock
+- rm -fr $HOME/.gradle/caches/*/plugin-resolution/
+cache:
+  directories:
+  - "$HOME/.gradle/caches/"
+  - "$HOME/.gradle/wrapper/"
+script:
+- gradle check
+#- gradle codeCoverageReport
+#after_success:
+#- bash <(curl -s https://codecov.io/bash) -t
+
+notifications:
+  email: false

CONTRIBUTING.md

@@ -0,0 +1,38 @@
+# Contributing
+:clap::tada: Thank you for taking the time to contribute! :tada::clap:
+
+We really value your willingness to contribute to this project. In order to higher the chances of your contribution being accepted, please refer to the following guidelines!
+
+## Steps
+
+1. Fork it!
+2. Create your feature branch: `git checkout -b feature/xyz develop`
+3. Commit your changes according to our commit message standards: `git commit -am 'feat(xyz) Added new functionality'`
+4. Push to your repo: `git push origin feature/xyz`
+5. Submit a pull request to `develop`
+
+## Workflow
+This repo uses Gitflow as its branch management system. You can learn more about Gitflow [here](https://www.atlassian.com/git/tutorials/comparing-workflows#gitflow-workflow).
+A few quick tips:
+* All feature branches should be based on `develop` and have the format `feature/branch_name`. 
+* Minor bug fixes should be based on `master` and have the format `hotfix/branch_name`.
+
+### Commit Conventions
+In order to make the changelog generation easier we recommend the use of messages based on [Conventional Commits](https://conventionalcommits.org/).
+
+Examples:
+```
+feat(orders): added `XYZ` helper function
+
+commit description
+
+footer notes
+```
+
+```
+refactor(orders): refactored `ABC` helper function
+
+The behaviour of `ABC` was inconsistent and (...)
+
+BREAKING CHANGE: return type of `ABC` is now `String`
+```

Dockerfile

@@ -0,0 +1,43 @@
+FROM openjdk:8-jdk as build
+
+ENV BUILD_PATH /building
+WORKDIR $BUILD_PATH
+
+COPY gradlew $BUILD_PATH/
+COPY gradle $BUILD_PATH/gradle
+# download gradle
+RUN ./gradlew --continue
+
+COPY build.gradle $BUILD_PATH
+
+# download dependencies
+RUN ./gradlew build; exit 0
+
+COPY src $BUILD_PATH/src
+COPY mocks-test $BUILD_PATH/mocks-test
+RUN mkdir $BUILD_PATH/backup-temp
+
+RUN ./gradlew build
+
+#############
+# Final image
+FROM openjdk:8-jdk
+MAINTAINER "elemental-source"
+
+VOLUME /config
+VOLUME /mocks-test
+VOLUME /backup-temp
+
+WORKDIR /
+
+EXPOSE 5000
+EXPOSE 9090
+
+ENV APP_PARAMS "--spring.config.location=file:/config/application.yml"
+
+COPY --from=build /building/build/libs/*.jar app.jar
+ENTRYPOINT ["java", \
+            "-agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=5000 -Djava.security.egd=file:/dev/./urandom", \
+            "-jar", \
+            "/app.jar", \
+            "$APP_PARAMS"]

README.md

@@ -0,0 +1,146 @@
+[![Build Status](https://travis-ci.org/elemental-source/mock-api.svg?branch=master)](https://travis-ci.org/elemental-source/mock-api)
+[![codecov.io](https://codecov.io/github/elemental-source/mock-api/coverage.svg?branch=master)](https://codecov.io/github/elemental-source/mock-api?branch=master)
+[![Codacy Badge](https://api.codacy.com/project/badge/Grade/2be4911c74b14b68a37e78ca4c2c8273)](https://www.codacy.com/app/elemental-source/mock-api?utm_source=github.com&utm_medium=referral&utm_content=elemental-source/mock-api&utm_campaign=Badge_Grade)
+
+## Coverage History
+![codecov.io](https://codecov.io/github/elemental-source/mock-api/branch.svg?branch=master)
+
+# Mock API
+
+Allows for reusable http request/response cycles in your tests, similar to WireMock.
+
+## Features
+
+* Capture live responses from external hosts and save the stubs locally
+* Define your mocked responses using JSON
+* Folder-based data files
+* Per-request conditional proxying
+* Simple YAML configuration
+
+## Rules
+
+All your requests should be directed to the application. When an HTTP request is made, the following matching rules are applied:
+
+1. Is there a valid mock data file (i.e. request/response pattern) existing in `api.fileBase` folder that matches the request pattern? If so, the mocked response is returned. 
+2. If not, does the request uri match any pattern described by the `api.uriConfigurations[].pattern` list? If so, the request will be dispatched to the matching `api.uriConfigurations[].host`.
+3. If none of above is true, the request is dispatched to the default host `api.host`.
+
+Should (2) or (3) occur, the response from an external host will be cached according to the `captureState` and `api.file.backup.path` properties. Next time the same request is made, it will be returned directly from the saved data file.
+
+## Example of a matched request
+
+Let's say you want to return the following mocked response for the following request: 
+
+```
+GET http://www.example.com/payments/111/description?code=ABCD
+```
+
+Expected response:
+
+```
+HTTP 200 (OK)
+{
+    "payment": {
+        "from": "John",
+        "to": "Fred",
+        "value": 33
+    }
+}
+```
+
+You should create the following mock data file (its name has no meaning, it can be anything you like):
+
+```
+{
+    // Request field describes what the request should look like in order to return the matched response.
+    // In this case, query parameter "code" should be equal to "ABCD".
+    // The request pattern is described by its method, headers, query parameters and body.
+    request": {
+        "query": {
+            "code": "ABCD"
+        }
+    },
+    // Response field describes the mocked response in case the request matches.
+    // You can define the response body and status code.
+    "response": {
+        "body": {
+            "payment": {
+                "from": "John",
+                "to": "Fred",
+                "value": 33
+            }
+        },
+        "httpStatus": 200
+        }
+}
+```
+
+Now, in order to properly use the data file, we should consider where it should be located. `mock-api` will parse the request and use the uri to search for the data file in the `api.fileBase` folder. In our example the request uri is `/payments/111/description?code=ABCD`, this means that the data file should be located in `${api.fileBase}/payments/111/description` folder (i.e. file location is based in uri parts and path parameters, other request fields are described in the data file itself). 
+
+## Requirements
+
+* Java JDK 8
+* Gradle 4
+
+## Run
+
+### Using Your Property File
+Create a valid property file in `src/main/resources/application-custom.yml` then run with `-Dspring.profiles.active=custom` argument. Example:
+
+```shell
+./gradlew bootRun -Dspring.profiles.active=custom
+```
+
+### Using Docker Image
+To generate the Docker image, run: 
+
+```shell
+./gradlew buildDocker
+```
+
+By default, the image name will be `elemental-source/mock-api:VERSION`.
+
+In order to run the application, create two folders: one containing the `application-custom.yml` configuration file and the other containing the mock data files. Then run:
+
+```shell
+docker run -d --name mock-api \
+       -p 9090:9090 \
+       -p 5000:5000 \
+       -v /path/to/application-custom.yml:/config/application.yml \
+       -v /path/to/mock/data/files:/data \
+       elemental-source/mock-api:VERSION
+```
+
+Port `9090` exposes the service while port `5000` can be used to debug the application.
+
+You can check application logs from the container: `docker logs -f mock-api`
+
+You can configure your program arguments in your IDE:
+```
+--spring.config.location=file/name/example/application.yml
+```
+
+#### Using docker-compose
+
+Run `docker-compose up --build`
+
+Get results: `curl -X GET 'http://localhost:9090/guests/132'`
+
+Look `api.host` property at `src/main/resources/application.yml` file.
+The value is http://www.mocky.io, the host that will be called if there is no file that dont match with request.
+If you create a new mock, you can call directly. Concat `localhost:9090` with the generated link, like this:
+
+```shell
+curl -X GET 'http://localhost:9090/v2/5b4bbb0c3100003503a7de45'
+```
+
+The response will not found at mock files and then, the external host will be called.
+
+## TODO
+
+- [X] Fix code Style
+- [ ] Create an example of a property file
+- [ ] Split unit from integrated tests
+- [ ] Fix skipping tests
+- [ ] Review dependencies (check, for instance, if it's even necessary to have both GSON and modelmapper dependencies)
+- [ ] Use objectmapper as component: `compile ('com.fasterxml.jackson.datatype: jackson-datatype-jdk8')``