refactor: simplify samples and add security contracts

- Replace Bar/Foo with Item record in all samples
- Remove HATEOAS from contracts sample
- Add Spring Security with authenticated/unauthenticated contracts
- Add tests for @PathVariable and @RequestParam with UUID and FriendlyId types
- Update contract files with proper package declarations

Author: mariuszs

README.md

@@ -111,7 +111,7 @@ Dependencies
 <dependency>
     <groupId>com.devskiller.friendly-id</groupId>
     <artifactId>friendly-id</artifactId>
-    <version>1.1.0</version>
+    <version>2.0.0-alpha6</version>
 </dependency>
 ```
 
@@ -161,7 +161,7 @@ The FriendlyID library includes a Spring configuration to make it easy to add sh
 <dependency>
     <groupId>com.devskiller.friendly-id</groupId>
     <artifactId>friendly-id-spring-boot-starter</artifactId>
-    <version>1.1.0</version>
+    <version>2.0.0-alpha6</version>
 </dependency>
 ```
 
@@ -205,7 +205,7 @@ First, add the following Jackson module dependency:
 <dependency>
     <groupId>com.devskiller.friendly-id</groupId>
     <artifactId>friendly-id-jackson-datatype</artifactId>
-    <version>1.1.0</version>
+    <version>2.0.0-alpha6</version>
 </dependency>
 ```
 Then register the `FriendlyIdModule` module as follows:
@@ -224,7 +224,7 @@ First, add the dependency:
 <dependency>
     <groupId>com.devskiller.friendly-id</groupId>
     <artifactId>friendly-id-jooq</artifactId>
-    <version>1.1.0</version>
+    <version>2.0.0-alpha6</version>
 </dependency>
 ```
 
@@ -251,7 +251,7 @@ First, add the dependency:
 <dependency>
     <groupId>com.devskiller.friendly-id</groupId>
     <artifactId>friendly-id-jpa</artifactId>
-    <version>1.1.0</version>
+    <version>2.0.0-alpha6</version>
 </dependency>
 ```
 
@@ -279,7 +279,7 @@ First, add the dependency:
 <dependency>
     <groupId>com.devskiller.friendly-id</groupId>
     <artifactId>friendly-id-openfeign</artifactId>
-    <version>1.1.0</version>
+    <version>2.0.0-alpha6</version>
 </dependency>
 ```
 

friendly-id-samples/friendly-id-contracts/pom.xml

@@ -20,32 +20,39 @@
         <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
         <java.version>21</java.version>
         <spring-cloud-contract.version>5.0.1</spring-cloud-contract.version>
+        <rest-assured.version>6.0.0</rest-assured.version>
     </properties>
 
     <dependencies>
         <dependency>
             <groupId>org.springframework.boot</groupId>
             <artifactId>spring-boot-starter-web</artifactId>
         </dependency>
+        <dependency>
+            <groupId>org.springframework.boot</groupId>
+            <artifactId>spring-boot-starter-security</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>org.springframework.security</groupId>
+            <artifactId>spring-security-test</artifactId>
+            <scope>test</scope>
+        </dependency>
         <dependency>
             <groupId>org.springframework.cloud</groupId>
             <artifactId>spring-cloud-starter-contract-verifier</artifactId>
             <scope>test</scope>
         </dependency>
+        <dependency>
+            <groupId>io.rest-assured</groupId>
+            <artifactId>spring-mock-mvc</artifactId>
+            <version>${rest-assured.version}</version>
+            <scope>test</scope>
+        </dependency>
         <dependency>
             <groupId>com.devskiller.friendly-id</groupId>
             <artifactId>friendly-id-spring-boot-starter</artifactId>
             <version>${project.version}</version>
         </dependency>
-        <dependency>
-            <groupId>org.springframework.boot</groupId>
-            <artifactId>spring-boot-starter-hateoas</artifactId>
-        </dependency>
-        <dependency>
-            <groupId>org.atteo</groupId>
-            <artifactId>evo-inflector</artifactId>
-            <version>1.2.2</version>
-        </dependency>
         <!-- Jackson 3 modules are now included automatically by Spring Boot 4 -->
 
         <dependency>
@@ -124,6 +131,12 @@
                 <configuration>
                     <basePackageForTests>com.devskiller.friendly_id.sample.contracts</basePackageForTests>
                     <baseClassForTests>com.devskiller.friendly_id.sample.contracts.ContractVerifierBase</baseClassForTests>
+                    <baseClassMappings>
+                        <baseClassMapping>
+                            <contractPackageRegex>.*authenticated.*</contractPackageRegex>
+                            <baseClassFQN>com.devskiller.friendly_id.sample.contracts.AuthenticatedContractBase</baseClassFQN>
+                        </baseClassMapping>
+                    </baseClassMappings>
                     <testFramework>JUNIT5</testFramework>
                 </configuration>
             </plugin>

friendly-id-samples/friendly-id-contracts/src/main/java/com/devskiller/friendly_id/sample/contracts/AdminController.java

@@ -0,0 +1,15 @@
+package com.devskiller.friendly_id.sample.contracts;
+
+import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.RestController;
+
+@RestController
+@RequestMapping("/admin")
+public class AdminController {
+
+	@GetMapping("/status")
+	public String status() {
+		return "OK";
+	}
+}

friendly-id-samples/friendly-id-contracts/src/main/java/com/devskiller/friendly_id/sample/contracts/BarController.java

@@ -0,0 +1,23 @@
+package com.devskiller.friendly_id.sample.contracts;
+
+import java.util.UUID;
+
+import com.devskiller.friendly_id.FriendlyIdFormat;
+import com.devskiller.friendly_id.IdFormat;
+import com.devskiller.friendly_id.type.FriendlyId;
+
+/**
+ * Example record demonstrating different UUID serialization formats.
+ *
+ * @param id           UUID serialized as FriendlyId string (default behavior)
+ * @param rawId        UUID serialized as raw UUID string
+ * @param friendlyUuid UUID explicitly serialized as FriendlyId string
+ * @param friendlyId   FriendlyId value object type
+ */
+public record Item(
+		UUID id,
+		@IdFormat(FriendlyIdFormat.RAW) UUID rawId,
+		@IdFormat(FriendlyIdFormat.URL62) UUID friendlyUuid,
+		FriendlyId friendlyId
+) {
+}