Merge pull request #18 from Laffini/core

Creating 'core'

Author: Laffini

README.md

@@ -8,53 +8,34 @@ A matching engine written in Java.
 A matching engine matches buy and sell orders in a market.
 
 ## Matching Algorithm
-The matching engine uses a price-time-priority algorithm. The matching priority is firstly price, then time. Market participants are rewarded for offering the best price and coming early. 
+The matching engine uses a price-time-priority algorithm.
+ The matching priority is firstly price, then time.
+ Market participants are rewarded for offering the best price and coming early. 
 
 ## Usage
-To use this API, you will need to run a local service which will be responsible for managing your matching engine. Your application will interact with this service locally via HTTP API calls. By default the service runs on the port 3000.
+The Java-Matching-Engine is broken up into multiple projects.
+This is the 'core' project.
+ This project only contains the engine (no REST API, persistence, etc).
 
-It is recommended that every user of this service audits and verifies all underlying code for its validity and suitability. Mistakes and bugs happen.
-
-## Usage Examples
-### Buying and Selling Example
-#### Creating a maker order
-User A creates a buy order of 2 items (e.g. 2 shares, 2 bitcoin, etc) with a price of 5 (e.g. £5, $5, etc)
-##### Request
-```
-POST /order/
-	?side=BUY
-    &amount=2
-    &price=5
-``` 
-##### Response
-```
-{
-  "trades": [],
-  "id": "02923822-070b-448d-9240-f3623f90927a"
-}
-```
-A unique ID is generated for the order (so that it can be modified/viewed). A list of trades is also returned. In this example the list of trades returned is empty as no trades have been made (due to the order book being empty).
-#### Creating a taker order
-User B creates a sell order of 2 items with a price of 5.
-##### Request
-```
-POST /order/
-	?side=SELL
-    &amount=2
-    &price=5
-``` 
-##### Response
+To use this project, you will need to include the 'core' package as part of your Spring configuration scanning (as seen below).
 ```
-{
-  "trades": [
-    {
-      "takerOrderId": "12964731-2cd4-401b-ac8d-3853f58f75c0",
-      "makerOrderId": "02923822-070b-448d-9240-f3623f90927a",
-      "amount": 2,
-      "price": 5
+@SpringBootApplication(scanBasePackages = "net.laffyco.javamatchingengine.core")
+public class ExampleApp {
+
+	@Autowired
+    private OrderInterface orderInterface
+
+    public static void main(final String[] args) {
+        SpringApplication.run(DbApp.class, args);
+        System.out.println(this.getOrders());
     }
-  ],
-  "id": "12964731-2cd4-401b-ac8d-3853f58f75c0"
+
 }
+
 ```
-As the sell order matches the buy order created earlier we can see that a trade has taken place.
+
+In the example above, we are interacting with the order book through the OrderInterface. 
+The example starts and prints the orders to the console (it will be empty as no orders have been added).
+In most cases you will want to use some of the other Java-Matching-Engine projects as these add additional functionality (such as a REST API) that may suit your needs.
+
+It is recommended that every user of this service audits and verifies all underlying code for its validity and suitability. Mistakes and bugs happen.

pom.xml

@@ -7,12 +7,12 @@
 		<groupId>org.springframework.boot</groupId>
 		<artifactId>spring-boot-starter-parent</artifactId>
 		<version>2.5.0</version>
-		<relativePath /> <!-- lookup parent from repository -->
+		<relativePath />
 	</parent>
-	<groupId>net.laffyco</groupId>
-	<artifactId>java-matching-engine</artifactId>
-	<version>0.1.0</version>
-	<name>java-matching-engine</name>
+	<groupId>net.laffyco.java-matching-engine</groupId>
+	<artifactId>core</artifactId>
+	<version>0.0.1</version>
+	<name>java-matching-engine-core</name>
 	<description>A matching engine made in Java</description>
 	<properties>
 		<java.version>1.8</java.version>
@@ -88,7 +88,7 @@
 		<repository>
 			<id>github</id>
 			<name>GitHub Laffini Apache Maven Packages</name>
-			<url>https://maven.pkg.github.com/Laffini/Java-Matching-Engine</url>
+			<url>https://maven.pkg.github.com/Laffini/Java-Matching-Engine-Core</url>
 		</repository>
 	</distributionManagement>
 

src/main/java/net/laffyco/javamatchingengine/JavaMatchingEngineApplication.java

@@ -0,0 +1,25 @@
+package net.laffyco.javamatchingengine.core;
+
+import org.springframework.boot.autoconfigure.SpringBootApplication;
+
+/**
+ * Service bootstrap.
+ *
+ * @author Laffini
+ *
+ */
+@SpringBootApplication
+public class CoreApplication {
+
+    /**
+     * Start the service.
+     *
+     * @param args
+     */
+    public static void main(final String[] args) {
+        /*
+         * Intentionally left blank.
+         */
+    }
+
+}

src/main/java/net/laffyco/javamatchingengine/core/CoreApplication.java

@@ -1,4 +1,4 @@
-package net.laffyco.javamatchingengine;
+package net.laffyco.javamatchingengine.core.api;
 
 import java.util.HashMap;
 import java.util.List;
@@ -7,31 +7,25 @@
 
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.context.ApplicationEventPublisher;
-import org.springframework.web.bind.annotation.DeleteMapping;
-import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.stereotype.Service;
 import org.springframework.web.bind.annotation.PathVariable;
-import org.springframework.web.bind.annotation.PostMapping;
-import org.springframework.web.bind.annotation.PutMapping;
-import org.springframework.web.bind.annotation.RequestMapping;
 import org.springframework.web.bind.annotation.RequestParam;
-import org.springframework.web.bind.annotation.RestController;
 
-import net.laffyco.javamatchingengine.engine.Order;
-import net.laffyco.javamatchingengine.engine.OrderBook;
-import net.laffyco.javamatchingengine.engine.Side;
-import net.laffyco.javamatchingengine.engine.Trade;
-import net.laffyco.javamatchingengine.events.OrderAddedEvent;
-import net.laffyco.javamatchingengine.events.OrderMatchedEvent;
+import net.laffyco.javamatchingengine.core.engine.Order;
+import net.laffyco.javamatchingengine.core.engine.OrderBook;
+import net.laffyco.javamatchingengine.core.engine.Side;
+import net.laffyco.javamatchingengine.core.engine.Trade;
+import net.laffyco.javamatchingengine.core.events.OrderAddedEvent;
+import net.laffyco.javamatchingengine.core.events.OrderMatchedEvent;
 
 /**
  * Controller for orders.
  *
  * @author Laffini
  *
  */
-@RestController
-@RequestMapping("/order")
-public class OrderController {
+@Service
+public class OrderInterface {
 
     /**
      * Order book.
@@ -50,7 +44,6 @@ public class OrderController {
      *
      * @return orders
      */
-    @GetMapping("/")
     public Map<String, List<Order>> getOrders() {
         final Map<String, List<Order>> response = new HashMap<>();
         response.put("buy", this.orderBook.getBuyOrders());
@@ -65,7 +58,6 @@ public Map<String, List<Order>> getOrders() {
      * @param side
      * @return order (or null if not found)
      */
-    @GetMapping("/{id}")
     public Map<String, Order> getOrder(@PathVariable final String id,
             @RequestParam("side") final Side side) {
         final Map<String, Order> response = new HashMap<>();
@@ -83,7 +75,6 @@ public Map<String, Order> getOrder(@PathVariable final String id,
      * @param price
      * @return order id
      */
-    @PostMapping("/")
     public Map<String, Object> addOrder(@RequestParam("side") final Side side,
             @RequestParam("amount") final double amount,
             @RequestParam("price") final double price) {
@@ -113,7 +104,6 @@ public Map<String, Object> addOrder(@RequestParam("side") final Side side,
      * @param side
      * @return whether an order was deleted or not
      */
-    @DeleteMapping("/{id}")
     public Map<String, Object> deleteOrder(@PathVariable final String id,
             @RequestParam("side") final Side side) {
         final Map<String, Object> response = new HashMap<>();
@@ -135,7 +125,6 @@ public Map<String, Object> deleteOrder(@PathVariable final String id,
      * @param newSide
      * @return whether an order has been updated or not
      */
-    @PutMapping("/{id}")
     public Map<String, Object> updateOrder(@PathVariable final String id,
             @RequestParam("side") final Side side,
             @RequestParam("newAmount") final Optional<Double> newAmount,

…/javamatchingengine/OrderController.java …chingengine/core/api/OrderInterface.javasrc/main/java/net/laffyco/javamatchingengine/OrderController.java renamed to src/main/java/net/laffyco/javamatchingengine/core/api/OrderInterface.java src/main/java/net/laffyco/javamatchingengine/OrderController.java renamed to src/main/java/net/laffyco/javamatchingengine/core/api/OrderInterface.java

@@ -1,24 +1,21 @@
-package net.laffyco.javamatchingengine;
+package net.laffyco.javamatchingengine.core.api;
 
 import java.util.HashMap;
 import java.util.Map;
 
 import org.springframework.beans.factory.annotation.Autowired;
-import org.springframework.web.bind.annotation.GetMapping;
-import org.springframework.web.bind.annotation.RequestMapping;
-import org.springframework.web.bind.annotation.RestController;
+import org.springframework.stereotype.Service;
 
-import net.laffyco.javamatchingengine.engine.OrderBook;
+import net.laffyco.javamatchingengine.core.engine.OrderBook;
 
 /**
  * Spread controller.
  *
  * @author Laffini
  *
  */
-@RestController
-@RequestMapping("/spread")
-public class SpreadController {
+@Service
+public class SpreadInterface {
 
     /**
      * Order book.
@@ -31,7 +28,6 @@ public class SpreadController {
      *
      * @return spread
      */
-    @GetMapping("/")
     public Map<String, Double> getSpread() {
         final Map<String, Double> response = new HashMap<>();
         final double spread = this.orderBook.getSpread();

…javamatchingengine/SpreadController.java …hingengine/core/api/SpreadInterface.javasrc/main/java/net/laffyco/javamatchingengine/SpreadController.java renamed to src/main/java/net/laffyco/javamatchingengine/core/api/SpreadInterface.java src/main/java/net/laffyco/javamatchingengine/SpreadController.java renamed to src/main/java/net/laffyco/javamatchingengine/core/api/SpreadInterface.java

@@ -0,0 +1,5 @@
+/**
+ * @author Laffini
+ *
+ */
+package net.laffyco.javamatchingengine.core.api;

src/main/java/net/laffyco/javamatchingengine/core/api/package-info.java

@@ -1,4 +1,4 @@
-package net.laffyco.javamatchingengine.engine;
+package net.laffyco.javamatchingengine.core.engine;
 
 import java.util.Date;
 import java.util.UUID;

…yco/javamatchingengine/engine/Order.java …avamatchingengine/core/engine/Order.javasrc/main/java/net/laffyco/javamatchingengine/engine/Order.java renamed to src/main/java/net/laffyco/javamatchingengine/core/engine/Order.java src/main/java/net/laffyco/javamatchingengine/engine/Order.java renamed to src/main/java/net/laffyco/javamatchingengine/core/engine/Order.java

@@ -1,4 +1,4 @@
-package net.laffyco.javamatchingengine.engine;
+package net.laffyco.javamatchingengine.core.engine;
 
 import java.util.ArrayList;
 import java.util.Collections;

…javamatchingengine/engine/OrderBook.java …atchingengine/core/engine/OrderBook.javasrc/main/java/net/laffyco/javamatchingengine/engine/OrderBook.java renamed to src/main/java/net/laffyco/javamatchingengine/core/engine/OrderBook.java src/main/java/net/laffyco/javamatchingengine/engine/OrderBook.java renamed to src/main/java/net/laffyco/javamatchingengine/core/engine/OrderBook.java

@@ -1,4 +1,4 @@
-package net.laffyco.javamatchingengine.engine;
+package net.laffyco.javamatchingengine.core.engine;
 
 /**
  * Order sides.