feat: implement import of a series sales by URL.

Implementation details:
- /series/{id}: a new form for importing a series sale has been added.
  It's only available when ADD_PURCHASES_AND_SALES Togglz feature is
  active and user has IMPORT_SERIES_SALES authority
- IMPORT_SERIES_SALES authority has been added and granted to admin user
  by default
- migration: JacksonAutoConfiguration should be removed from
  spring.autoconfigure.exclude property in application*.properties file

Fix #995

Author: php-coder

NEWS.txt

@@ -28,6 +28,7 @@
 - (functionality)  show similar series on a page with series info
 - (infrastructure) add ability to send e-mails via Mailgun API
 - (infrastructure) port the integration tests to Robot Framework. Also remove TestNG and FEST assertions
+- (functionality)  implement import of a series sales by URL
 
 0.3
 - (functionality)  implemented possibility to user to add series to his collection

pom.xml

@@ -143,18 +143,6 @@
 					<groupId>org.springframework.boot</groupId>
 					<artifactId>spring-boot-starter-tomcat</artifactId>
 				</exclusion>
-				<exclusion>
-					<groupId>com.fasterxml.jackson.core</groupId>
-					<artifactId>jackson-core</artifactId>
-				</exclusion>
-				<exclusion>
-					<groupId>com.fasterxml.jackson.core</groupId>
-					<artifactId>jackson-databind</artifactId>
-				</exclusion>
-				<exclusion>
-					<groupId>com.fasterxml.jackson.core</groupId>
-					<artifactId>jackson-annotations</artifactId>
-				</exclusion>
 			</exclusions>
 		</dependency>
 

src/main/java/ru/mystamps/web/Url.java

@@ -51,12 +51,15 @@ public final class Url {
 	public static final String ADD_SERIES_ASK_PAGE      = "/series/{id}/ask";
 	public static final String INFO_SERIES_PAGE         = "/series/{id}";
 	public static final String ADD_IMAGE_SERIES_PAGE    = "/series/{id}/image";
+	public static final String SERIES_INFO_PAGE_REGEXP  = "/series/(\\d+|\\d+/(ask|image))";
 	public static final String SEARCH_SERIES_BY_CATALOG = "/series/search/by_catalog";
 
 	public static final String REQUEST_IMPORT_SERIES_PAGE = "/series/import/request";
 	public static final String REQUEST_IMPORT_PAGE        = "/series/import/request/{id}";
 	public static final String LIST_IMPORT_REQUESTS_PAGE  = "/series/import/requests";
 
+	public static final String IMPORT_SERIES_SALES        = "/series/sales/import";
+	
 	public static final String SUGGEST_SERIES_CATEGORY    = "/suggest/series_category";
 	public static final String SUGGEST_SERIES_COUNTRY     = "/suggest/series_country";
 
@@ -91,7 +94,7 @@ public final class Url {
 	public static final String ADD_SERIES_WITH_COUNTRY_PAGE   = "/series/add/country/{slug}";
 
 	// MUST be updated when any of our resources were modified
-	public static final String RESOURCES_VERSION      = "v0.3.12";
+	public static final String RESOURCES_VERSION      = "v0.3.13";
 
 	// CheckStyle: ignore LineLength for next 7 lines
 	public static final String MAIN_CSS               = "/static/" + RESOURCES_VERSION + "/styles/main.min.css";
@@ -155,6 +158,7 @@ public static Map<String, String> asMap(boolean production) {
 		map.put("INFO_COUNTRY_PAGE", INFO_COUNTRY_PAGE);
 		map.put("INFO_SERIES_PAGE", INFO_SERIES_PAGE);
 		map.put("LIST_IMPORT_REQUESTS_PAGE", LIST_IMPORT_REQUESTS_PAGE);
+		map.put("IMPORT_SERIES_SALES", IMPORT_SERIES_SALES);
 		map.put("LOGIN_PAGE", LOGIN_PAGE);
 		map.put("LOGOUT_PAGE", LOGOUT_PAGE);
 		map.put("PUBLIC_URL", production ? PUBLIC_URL : SITE);

src/main/java/ru/mystamps/web/config/ControllersConfig.java

@@ -38,6 +38,7 @@
 import ru.mystamps.web.feature.series.SeriesConfig;
 import ru.mystamps.web.feature.series.SeriesService;
 import ru.mystamps.web.feature.series.importing.SeriesImportConfig;
+import ru.mystamps.web.feature.series.importing.sale.SeriesSalesImportConfig;
 
 @Configuration
 @RequiredArgsConstructor
@@ -50,7 +51,8 @@
 	ParticipantConfig.Controllers.class,
 	ReportConfig.Controllers.class,
 	SeriesConfig.Controllers.class,
-	SeriesImportConfig.Controllers.class
+	SeriesImportConfig.Controllers.class,
+	SeriesSalesImportConfig.Controllers.class
 })
 public class ControllersConfig {
 

src/main/java/ru/mystamps/web/config/MvcConfig.java

@@ -45,6 +45,7 @@
 import ru.mystamps.web.feature.country.CountryService;
 import ru.mystamps.web.feature.series.DownloadImageInterceptor;
 import ru.mystamps.web.feature.series.importing.event.EventsConfig;
+import ru.mystamps.web.support.spring.mvc.RestExceptionHandler;
 import ru.mystamps.web.support.spring.security.CurrentUserArgumentResolver;
 
 import java.util.List;
@@ -153,6 +154,11 @@ public LocaleResolver getLocaleResolver() {
 		return resolver;
 	}
 
+	@Bean
+	public RestExceptionHandler restExceptionHandler() {
+		return new RestExceptionHandler();
+	}
+	
 	private static HandlerInterceptor getLocaleChangeInterceptor() {
 		LocaleChangeInterceptor interceptor = new LocaleChangeInterceptor();
 		interceptor.setParamName("lang");

src/main/java/ru/mystamps/web/config/ServicesConfig.java

@@ -127,7 +127,7 @@ public DownloaderService getImageDownloaderService() {
 		);
 	}
 
-	@Bean
+	@Bean(name = "seriesDownloaderService")
 	public DownloaderService getSeriesDownloaderService() {
 		return new TimedDownloaderService(
 			LoggerFactory.getLogger(TimedDownloaderService.class),

src/main/java/ru/mystamps/web/feature/series/importing/RequestImportForm.java

@@ -38,8 +38,14 @@
 })
 public class RequestImportForm implements RequestImportDto {
 
+	// @todo #995 Series sale import: use its own interface and form
+	// @todo #995 /series/sales/import: validate that we have a parser for this url
 	@NotEmpty(groups = Group.Level1.class)
 	@Size(
+		// For series sales a max length is SERIES_SALES_URL_MAX_LENGTH but since they are equal,
+		// we use IMPORT_REQUEST_URL_MAX_LENGTH here.
+		// Also, as the import saves nothing, this check actually isn't required. Perhaps,
+		// we shouldn't validate on this stage and let it fail later, during a sale creation.
 		max = IMPORT_REQUEST_URL_MAX_LENGTH,
 		message = "{value.too-long}",
 		groups = Group.Level2.class

src/main/java/ru/mystamps/web/feature/series/importing/SeriesImportConfig.java

@@ -22,6 +22,7 @@
 import org.springframework.context.ApplicationEventPublisher;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
+import org.springframework.context.annotation.Lazy;
 import org.springframework.jdbc.core.namedparam.NamedParameterJdbcTemplate;
 import ru.mystamps.web.feature.participant.ParticipantService;
 import ru.mystamps.web.feature.series.SeriesController;
@@ -67,11 +68,13 @@ public static class Services {
 		private final ParticipantService participantService;
 		private final SeriesService seriesService;
 		private final SeriesSalesService seriesSalesService;
-		private final SeriesSalesImportService seriesSalesImportService;
 		private final ApplicationEventPublisher eventPublisher;
 
 		@Bean
-		public SeriesImportService seriesImportService(SeriesImportDao seriesImportDao) {
+		public SeriesImportService seriesImportService(
+			SeriesImportDao seriesImportDao,
+			@Lazy SeriesSalesImportService seriesSalesImportService) {
+			
 			return new SeriesImportServiceImpl(
 				LoggerFactory.getLogger(SeriesImportServiceImpl.class),
 				seriesImportDao,

src/main/java/ru/mystamps/web/feature/series/importing/sale/SeriesSaleExtractedInfo.java

@@ -0,0 +1,31 @@
+/*
+ * Copyright (C) 2009-2019 Slava Semushin <[email protected]>
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ */
+package ru.mystamps.web.feature.series.importing.sale;
+
+import lombok.Getter;
+import lombok.RequiredArgsConstructor;
+
+import java.math.BigDecimal;
+
+@Getter
+@RequiredArgsConstructor
+public class SeriesSaleExtractedInfo {
+	private final Integer sellerId;
+	private final BigDecimal price;
+	private final String currency;
+}

src/main/java/ru/mystamps/web/feature/series/importing/sale/SeriesSaleImportController.java

@@ -0,0 +1,57 @@
+/*
+ * Copyright (C) 2009-2019 Slava Semushin <[email protected]>
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ */
+package ru.mystamps.web.feature.series.importing.sale;
+
+import lombok.RequiredArgsConstructor;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import org.springframework.http.HttpStatus;
+import org.springframework.http.ResponseEntity;
+import org.springframework.web.bind.annotation.PostMapping;
+import org.springframework.web.bind.annotation.RequestBody;
+import org.springframework.web.bind.annotation.RestController;
+import ru.mystamps.web.Url;
+import ru.mystamps.web.feature.series.importing.RequestImportForm;
+
+import javax.validation.Valid;
+
+@RestController
+@RequiredArgsConstructor
+public class SeriesSaleImportController {
+	
+	private static final Logger LOG = LoggerFactory.getLogger(SeriesSaleImportController.class);
+	
+	private final SeriesSalesImportService seriesSalesImportService;
+	
+	@PostMapping(Url.IMPORT_SERIES_SALES)
+	public ResponseEntity<SeriesSaleExtractedInfo> downloadAndParse(
+		@RequestBody @Valid RequestImportForm form) {
+		
+		String url = form.getUrl();
+		
+		try {
+			SeriesSaleExtractedInfo result = seriesSalesImportService.downloadAndParse(url);
+			return ResponseEntity.ok(result);
+			
+		} catch (RuntimeException ex) { // NOPMD: AvoidCatchingGenericException; try to catch-all
+			LOG.error("Failed to process '{}': {}", url, ex.getMessage());
+			return new ResponseEntity<>(HttpStatus.INTERNAL_SERVER_ERROR);
+		}
+	}
+	
+}

src/main/java/ru/mystamps/web/feature/series/importing/sale/SeriesSalesImportConfig.java

@@ -18,26 +18,53 @@
 package ru.mystamps.web.feature.series.importing.sale;
 
 import lombok.RequiredArgsConstructor;
+import org.springframework.beans.factory.annotation.Qualifier;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
 import org.springframework.jdbc.core.namedparam.NamedParameterJdbcTemplate;
+import ru.mystamps.web.feature.series.DownloaderService;
+import ru.mystamps.web.feature.series.importing.SeriesInfoExtractorService;
+import ru.mystamps.web.feature.series.importing.extractor.SiteParserService;
 
 /**
  * Spring configuration that is required for importing series sale in an application.
+ *
+ *  The beans are grouped into two classes to make possible to register a controller
+ *  and the services in the separated application contexts.
  */
 @Configuration
 public class SeriesSalesImportConfig {
 
+	@RequiredArgsConstructor
+	public static class Controllers {
+		
+		private final SeriesSalesImportService seriesSalesImportService;
+		
+		@Bean
+		public SeriesSaleImportController seriesSaleImportController() {
+			return new SeriesSaleImportController(seriesSalesImportService);
+		}
+		
+	}
+	
 	@RequiredArgsConstructor
 	public static class Services {
 
 		private final NamedParameterJdbcTemplate jdbcTemplate;
+		private final SiteParserService siteParserService;
+		private final SeriesInfoExtractorService extractorService;
 
 		@Bean
 		public SeriesSalesImportService seriesSalesImportService(
-			SeriesSalesImportDao seriesSalesImportDao) {
+			SeriesSalesImportDao seriesSalesImportDao,
+			@Qualifier("seriesDownloaderService") DownloaderService seriesDownloaderService) {
 
-			return new SeriesSalesImportServiceImpl(seriesSalesImportDao);
+			return new SeriesSalesImportServiceImpl(
+				seriesSalesImportDao,
+				seriesDownloaderService,
+				siteParserService,
+				extractorService
+			);
 		}
 
 		@Bean

src/main/java/ru/mystamps/web/feature/series/importing/sale/SeriesSalesImportService.java

@@ -18,6 +18,7 @@
 package ru.mystamps.web.feature.series.importing.sale;
 
 public interface SeriesSalesImportService {
+	SeriesSaleExtractedInfo downloadAndParse(String url);
 	void saveParsedData(Integer requestId, SeriesSalesParsedDataDbDto seriesSalesParsedData);
 	SeriesSaleParsedDataDto getParsedData(Integer requestId);
 }

src/main/java/ru/mystamps/web/feature/series/importing/sale/SeriesSalesImportServiceImpl.java

@@ -19,12 +19,75 @@
 
 import lombok.RequiredArgsConstructor;
 import org.apache.commons.lang3.Validate;
+import org.springframework.security.access.prepost.PreAuthorize;
 import org.springframework.transaction.annotation.Transactional;
+import ru.mystamps.web.feature.series.DownloadResult;
+import ru.mystamps.web.feature.series.DownloaderService;
+import ru.mystamps.web.feature.series.importing.RawParsedDataDto;
+import ru.mystamps.web.feature.series.importing.SeriesExtractedInfo;
+import ru.mystamps.web.feature.series.importing.SeriesInfoExtractorService;
+import ru.mystamps.web.feature.series.importing.extractor.SeriesInfo;
+import ru.mystamps.web.feature.series.importing.extractor.SiteParser;
+import ru.mystamps.web.feature.series.importing.extractor.SiteParserService;
+import ru.mystamps.web.support.spring.security.HasAuthority;
 
 @RequiredArgsConstructor
 public class SeriesSalesImportServiceImpl implements SeriesSalesImportService {
 
 	private final SeriesSalesImportDao seriesSalesImportDao;
+	private final DownloaderService downloaderService;
+	private final SiteParserService siteParserService;
+	private final SeriesInfoExtractorService extractorService;
+	
+	// @todo #995 SeriesSalesImportServiceImpl.downloadAndParse(): add unit tests
+	@Override
+	@Transactional(readOnly = true)
+	@PreAuthorize(HasAuthority.IMPORT_SERIES)
+	@SuppressWarnings("PMD.AvoidThrowingRawExceptionTypes")
+	public SeriesSaleExtractedInfo downloadAndParse(String url) {
+		SiteParser parser = siteParserService.findForUrl(url);
+		if (parser == null) {
+			throw new RuntimeException("could not find an appropriate parser");
+		}
+		
+		DownloadResult result = downloaderService.download(url);
+		if (result.hasFailed()) {
+			String message = "could not download: " + result.getCode();
+			throw new RuntimeException(message);
+		}
+		
+		String content = result.getDataAsString();
+		
+		// @todo #995 SiteParser: introduce a method for parsing only sales-related info
+		SeriesInfo info = parser.parse(content);
+		if (info.isEmpty()) {
+			throw new RuntimeException("could not parse the page");
+		}
+		
+		RawParsedDataDto data = new RawParsedDataDto(
+			null,
+			null,
+			null,
+			null,
+			null,
+			null,
+			null,
+			info.getSellerName(),
+			info.getSellerUrl(),
+			info.getPrice(),
+			info.getCurrency()
+		);
+		
+		// CheckStyle: ignore LineLength for next 1 line
+		// @todo #995 SeriesInfoExtractorService: introduce a method for parsing only sales-related info
+		SeriesExtractedInfo seriesInfo = extractorService.extract(url, data);
+		
+		return new SeriesSaleExtractedInfo(
+			seriesInfo.getSellerId(),
+			seriesInfo.getPrice(),
+			seriesInfo.getCurrency()
+		);
+	}
 
 	// @todo #834 SeriesSalesImportServiceImpl.saveParsedData(): introduce dto without dates
 	@Override