Consolidate some files

Author: Sporiff

README.md

@@ -12,4 +12,4 @@ This server is intended as a reference implementation for testing purposes and e
 
 This server is a work in progress.
 It will be updated as new specs are created.
-At the current time, the server supports only simple user registration and subscription management.
+At the current time, the server supports only simple user registration and subscriptionEntity management.

src/docs/index.adoc

@@ -8,5 +8,6 @@
 
 This server implements the https://openpodcastapi.org[Open Podcast API].
 
+include::auth.adoc[]
 include::users.adoc[]
 include::subscriptions.adoc[]

src/docs/subscriptions.adoc

@@ -2,7 +2,7 @@
 :doctype: book
 :sectlinks:
 
-The `subscriptions` endpoint exposes operations taken on subscriptions. A subscription represents two things:
+The `subscriptions` endpoint exposes operations taken on subscriptions. A subscriptionEntity represents two things:
 
 1. A podcast feed
 2. The relationship between a user and a podcast feed
@@ -18,7 +18,7 @@ POST /api/v1/users
 [[actions-subscriptions-create]]
 === Create subscriptions
 
-When a user adds a subscription to the system, a corresponding `subscription` object is fetched or created depending on whether a matching subscription is present. A link is then created between the user and the subscription.
+When a user adds a subscriptionEntity to the system, a corresponding `subscriptionEntity` object is fetched or created depending on whether a matching subscriptionEntity is present. A link is then created between the user and the subscriptionEntity.
 
 operation::subscriptions-bulk-create-mixed[snippets='request-fields,curl-request,response-fields,http-response']
 
@@ -47,16 +47,16 @@ operation::subscriptions-list[snippets='query-parameters,curl-request,response-f
 
 operation::subscriptions-list-with-unsubscribed[snippets='curl-request,http-response']
 
-[[actions-subscription-fetch]]
-=== Fetch a single subscription
+[[actions-subscriptionEntity-fetch]]
+=== Fetch a single subscriptionEntity
 
-Returns the details of a single subscription for the  authenticated user. Returns `404` if the user has no subscription entry for the feed in question.
+Returns the details of a single subscriptionEntity for the  authenticated user. Returns `404` if the user has no subscriptionEntity entry for the feed in question.
 
-operation::subscription-get[snippets='path-parameters,curl-request,response-fields,http-response']
+operation::subscriptionEntity-get[snippets='path-parameters,curl-request,response-fields,http-response']
 
-[[actions-subscription-update]]
+[[actions-subscriptionEntity-update]]
 === Unsubscribe from a feed
 
-Unsubscribes the authenticated user from a feed. This action updates the user subscription record to mark the subscription as inactive. It does not delete the subscription record.
+Unsubscribes the authenticated user from a feed. This action updates the user subscriptionEntity record to mark the subscriptionEntity as inactive. It does not delete the subscriptionEntity record.
 
-operation::subscription-unsubscribe[snippets='path-parameters,curl-request,response-fields,http-response']
+operation::subscriptionEntity-unsubscribe[snippets='path-parameters,curl-request,response-fields,http-response']

src/main/java/org/openpodcastapi/opa/auth/ApiAuthController.java

@@ -6,8 +6,8 @@
 import lombok.extern.log4j.Log4j2;
 import org.openpodcastapi.opa.config.JwtService;
 import org.openpodcastapi.opa.security.TokenService;
-import org.openpodcastapi.opa.user.model.User;
-import org.openpodcastapi.opa.user.repository.UserRepository;
+import org.openpodcastapi.opa.user.User;
+import org.openpodcastapi.opa.user.UserRepository;
 import org.springframework.http.ResponseEntity;
 import org.springframework.security.authentication.AuthenticationManager;
 import org.springframework.security.authentication.UsernamePasswordAuthenticationToken;

src/main/java/org/openpodcastapi/opa/config/JwtAuthenticationFilter.java

@@ -12,8 +12,8 @@
 import lombok.RequiredArgsConstructor;
 import lombok.extern.log4j.Log4j2;
 import org.openpodcastapi.opa.service.CustomUserDetails;
-import org.openpodcastapi.opa.user.model.User;
-import org.openpodcastapi.opa.user.repository.UserRepository;
+import org.openpodcastapi.opa.user.User;
+import org.openpodcastapi.opa.user.UserRepository;
 import org.springframework.beans.factory.annotation.Value;
 import org.springframework.http.HttpHeaders;
 import org.springframework.security.authentication.UsernamePasswordAuthenticationToken;
@@ -69,7 +69,7 @@ protected void doFilterInternal(HttpServletRequest req, @Nonnull HttpServletResp
             throws ServletException, IOException {
 
         // Don't apply the check on the auth endpoints
-        if (req.getRequestURI().startsWith("/api/auth/")) {
+        if (req.getRequestURI().startsWith("/api/auth/") || req.getRequestURI().startsWith("/docs")) {
             chain.doFilter(req, res);
             return;
         }

src/main/java/org/openpodcastapi/opa/config/SecurityConfig.java

@@ -32,7 +32,7 @@ public SecurityFilterChain defaultSecurityFilterChain(HttpSecurity http) throws
                 .sessionManagement(sm -> sm
                         .sessionCreationPolicy(SessionCreationPolicy.STATELESS)) // Stateless session
                 .authorizeHttpRequests(auth -> auth
-                        .requestMatchers("/", "/login", "/logout-confirm", "/register", "/docs", "/css/**", "/js/**", "/images/**", "/favicon.ico", "/api/auth/login", "/api/auth/refresh").permitAll()
+                        .requestMatchers("/", "/login", "/logout-confirm", "/register", "/docs**", "/css/**", "/js/**", "/images/**", "/favicon.ico", "/api/auth/**").permitAll()
                         .requestMatchers("/api/v1/**").authenticated()
                         .anyRequest().authenticated())
                 .addFilterBefore(jwtAuthenticationFilter, UsernamePasswordAuthenticationFilter.class)

src/main/java/org/openpodcastapi/opa/config/TemplateConfig.java

@@ -1,5 +1,7 @@
 package org.openpodcastapi.opa.config;
 
+import nz.net.ultraq.thymeleaf.layoutdialect.LayoutDialect;
+import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
 import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry;
 import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
@@ -20,4 +22,9 @@ public void addResourceHandlers(ResourceHandlerRegistry registry) {
                 .addResourceHandler("/docs/**")
                 .addResourceLocations("classpath:/docs/");
     }
+
+    @Bean
+    public LayoutDialect layoutDialect() {
+        return new LayoutDialect();
+    }
 }

src/main/java/org/openpodcastapi/opa/config/WebConfig.java

@@ -52,7 +52,7 @@ public static UUID getFeedUUID(String feedUrl) {
         return generator.generate(sanitizedFeedUrl);
     }
 
-    /// Validates that a supplied subscription UUID has been calculated properly
+    /// Validates that a supplied subscriptionEntity UUID has been calculated properly
     ///
     /// @param feedUrl      the URL of the podcast feed
     /// @param suppliedUUID the UUID to validate

src/main/java/org/openpodcastapi/opa/helpers/UUIDHelper.java

@@ -2,7 +2,7 @@
 
 import jakarta.persistence.*;
 import lombok.*;
-import org.openpodcastapi.opa.user.model.User;
+import org.openpodcastapi.opa.user.User;
 
 import java.time.Instant;