Import series: add support for extracting info about price and known seller.

This commit adds new configuration properties:
- app.site-parser[x].seller-locator
- app.site-parser[x].price-locator
- app.site-parser[x].currency-value

Addressed to #695

Author: php-coder

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

@@ -116,6 +116,8 @@ public SeriesController getSeriesController() {
 	public SeriesImportController getSeriesImportController() {
 		return new SeriesImportController(
 			servicesConfig.getSeriesImportService(),
+			servicesConfig.getSeriesSalesService(),
+			servicesConfig.getSeriesSalesImportService(),
 			getSeriesController(),
 			eventPublisher
 		);

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

@@ -105,6 +105,11 @@ public SeriesImportDao getSeriesImportDao() {
 		return new JdbcSeriesImportDao(jdbcTemplate);
 	}
 
+	@Bean
+	public SeriesSalesImportDao getSeriesSalesImportDao() {
+		return new JdbcSeriesSalesImportDao(jdbcTemplate);
+	}
+	
 	@Bean
 	public SeriesSalesDao getSeriesSalesDao() {
 		return new JdbcSeriesSalesDao(jdbcTemplate);

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

@@ -178,6 +178,8 @@ public SeriesImportService getSeriesImportService() {
 			LoggerFactory.getLogger(SeriesImportServiceImpl.class),
 			daoConfig.getSeriesImportDao(),
 			getSeriesService(),
+			getSeriesSalesService(),
+			getSeriesSalesImportService(),
 			getSeriesInfoExtractorService(),
 			eventPublisher
 		);
@@ -190,7 +192,8 @@ public SeriesInfoExtractorService getSeriesInfoExtractorService() {
 			new SeriesInfoExtractorServiceImpl(
 				LoggerFactory.getLogger(SeriesInfoExtractorServiceImpl.class),
 				getCategoryService(),
-				getCountryService()
+				getCountryService(),
+				getTransactionParticipantService()
 			)
 		);
 	}
@@ -203,6 +206,14 @@ public SeriesSalesService getSeriesSalesService() {
 		);
 	}
 
+	@Bean
+	public SeriesSalesImportService getSeriesSalesImportService() {
+		return new SeriesSalesImportServiceImpl(
+			LoggerFactory.getLogger(SeriesSalesImportServiceImpl.class),
+			daoConfig.getSeriesSalesImportDao()
+		);
+	}
+	
 	@Bean
 	public SiteService getSiteService() {
 		return new SiteServiceImpl(

src/main/java/ru/mystamps/web/controller/SeriesImportController.java

@@ -18,6 +18,7 @@
 package ru.mystamps.web.controller;
 
 import java.io.IOException;
+import java.util.Date;
 import java.util.Locale;
 
 import javax.servlet.http.HttpServletRequest;
@@ -40,11 +41,15 @@
 import ru.mystamps.web.Url;
 import ru.mystamps.web.controller.converter.annotation.CurrentUser;
 import ru.mystamps.web.controller.dto.ImportSeriesForm;
+import ru.mystamps.web.controller.dto.ImportSeriesSalesForm;
 import ru.mystamps.web.controller.dto.RequestImportForm;
 import ru.mystamps.web.controller.event.ImportRequestCreated;
 import ru.mystamps.web.dao.dto.ImportRequestDto;
 import ru.mystamps.web.dao.dto.SeriesParsedDataDto;
+import ru.mystamps.web.dao.dto.SeriesSaleParsedDataDto;
 import ru.mystamps.web.service.SeriesImportService;
+import ru.mystamps.web.service.SeriesSalesImportService;
+import ru.mystamps.web.service.SeriesSalesService;
 import ru.mystamps.web.util.LocaleUtils;
 
 import static ru.mystamps.web.controller.ControllerUtils.redirectTo;
@@ -54,6 +59,8 @@
 public class SeriesImportController {
 
 	private final SeriesImportService seriesImportService;
+	private final SeriesSalesService seriesSalesService;
+	private final SeriesSalesImportService seriesSalesImportService;
 	private final SeriesController seriesController;
 	private final ApplicationEventPublisher eventPublisher;
 
@@ -127,6 +134,20 @@ public String showRequestAndImportSeriesForm(
 			}
 		}
 
+		SeriesSaleParsedDataDto seriesSale = seriesSalesImportService.getParsedData(requestId);
+		if (seriesSale != null) {
+			ImportSeriesSalesForm seriesSaleForm = new ImportSeriesSalesForm();
+			seriesSaleForm.setSellerId(seriesSale.getSellerId());
+			seriesSaleForm.setPrice(seriesSale.getPrice());
+			seriesSaleForm.setCurrency(seriesSale.getCurrency());
+			
+			form.setSeriesSale(seriesSaleForm);
+			
+			if (seriesSale.getSellerId() != null) {
+				seriesController.addSellersToModel(model);
+			}
+		}
+		
 		model.addAttribute("importSeriesForm", form);
 		model.addAttribute("showForm", hasParsedData);
 
@@ -175,11 +196,27 @@ public String processImportSeriesForm(
 		seriesController.addCountriesToModel(model, lang);
 		seriesController.addYearToModel(model);
 
+		ImportSeriesSalesForm seriesSaleForm = form.getSeriesSale();
+		if (seriesSaleForm != null) {
+			seriesController.addSellersToModel(model);
+		}
+		
 		if (result.hasErrors()) {
 			return "series/import/info";
 		}
 
-		Integer seriesId = seriesImportService.addSeries(form, requestId, currentUserId);
+		if (seriesSaleForm != null) {
+			// fill required values prior passing the form into the service.
+			seriesSaleForm.setDate(new Date());
+			seriesSaleForm.setUrl(request.getUrl());
+		}
+		
+		Integer seriesId = seriesImportService.addSeries(
+			form,
+			seriesSaleForm,
+			requestId,
+			currentUserId
+		);
 
 		return redirectTo(Url.INFO_SERIES_PAGE, seriesId);
 	}

src/main/java/ru/mystamps/web/controller/TestController.java

@@ -67,4 +67,27 @@ public void simpleHtml(HttpServletResponse response) throws IOException {
 		);
 	}
 
+	@GetMapping("/valid/series-info/existing-seller")
+	public void seriesInfoWithExistingSeller(HttpServletResponse response) throws IOException {
+		response.setContentType("text/html");
+		response.setCharacterEncoding("UTF-8");
+		response.getWriter().println(
+			"<!DOCTYPE html>"
+			+ "<html>"
+				+ "<head>"
+					+ "<title>Series info (existing seller)</title>"
+				+ "</head>"
+				+ "<body>"
+					// CheckStyle: ignore LineLength for next 2 lines
+					+ "Image:  <a id=\"series-image-link-1\" href=\"/image/1\">series image</a><br />"
+					+ "Seller: <a id=\"test-seller\" href=\"http://example.com/eicca-toppinen\">Eicca Toppinen</a><br />"
+					+ "Price:  <span id=\"test-price\">111</span> RUB<br />"
+					// this is needed to simplify an integration test
+					// (required fields "category" and "quantity" will be filled automatically)
+					+ "Info:   <span class=\"dl-horizontal\">Спорт, 3 марки</span>"
+				+ "</body>"
+			+ "</html>"
+		);
+	}
+	
 }

src/main/java/ru/mystamps/web/controller/dto/ImportSeriesForm.java

@@ -19,6 +19,7 @@
 
 import java.math.BigDecimal;
 
+import javax.validation.Valid;
 import javax.validation.constraints.Max;
 import javax.validation.constraints.Min;
 import javax.validation.constraints.NotNull;
@@ -84,6 +85,9 @@ public class ImportSeriesForm implements AddSeriesDto, NullableImageUrl {
 	@NotNull
 	private MultipartFile downloadedImage;
 
+	@Valid
+	private ImportSeriesSalesForm seriesSale;
+	
 	//
 	// The methods bellow required for AddSeriesDto interface.
 	// They are no-op methods because we don't support all values during series import.

src/main/java/ru/mystamps/web/controller/dto/ImportSeriesSalesForm.java

@@ -0,0 +1,75 @@
+/*
+ * Copyright (C) 2009-2018 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.controller.dto;
+
+import java.math.BigDecimal;
+import java.util.Date;
+
+import javax.validation.constraints.NotNull;
+
+import org.springframework.format.annotation.NumberFormat;
+
+import lombok.Getter;
+import lombok.Setter;
+
+import ru.mystamps.web.dao.dto.Currency;
+import ru.mystamps.web.service.dto.AddSeriesSalesDto;
+
+// @todo #695 /series/import/request/{id}(seriesSale):
+//  add integration test for validation of required fields
+@Getter
+@Setter
+public class ImportSeriesSalesForm implements AddSeriesSalesDto {
+	
+	@NotNull
+	private Integer sellerId;
+	
+	@NotNull
+	@NumberFormat(pattern = "###.##")
+	private BigDecimal price;
+	
+	@NotNull
+	private Currency currency;
+	
+	// We don't expose these fields to a form because we know already what
+	// values should be. Even if user will try to provide its own values, it's not
+	// a problem as we always rewrite them in the controller.
+	private Date date;
+	private String url;
+	
+	//
+	// The methods bellow required for AddSeriesSalesDto interface.
+	// They are no-op methods because we don't support all values during series import.
+	//
+	
+	@Override
+	public BigDecimal getAltPrice() {
+		return null;
+	}
+	
+	@Override
+	public Currency getAltCurrency() {
+		return null;
+	}
+	
+	@Override
+	public Integer getBuyerId() {
+		return null;
+	}
+	
+}

src/main/java/ru/mystamps/web/controller/event/DownloadingSucceededEventListener.java

@@ -92,7 +92,11 @@ public void onApplicationEvent(DownloadingSucceeded event) {
 			info.getImageUrl(),
 			info.getIssueDate(),
 			info.getQuantity(),
-			info.getPerforated()
+			info.getPerforated(),
+			info.getSellerName(),
+			info.getSellerUrl(),
+			info.getPrice(),
+			info.getCurrency()
 		);
 		importService.saveParsedData(requestId, data);
 	}

src/main/java/ru/mystamps/web/dao/SeriesSalesImportDao.java

@@ -0,0 +1,26 @@
+/*
+ * Copyright (C) 2009-2018 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.dao;
+
+import ru.mystamps.web.dao.dto.SeriesSaleParsedDataDto;
+import ru.mystamps.web.dao.dto.SeriesSalesParsedDataDbDto;
+
+public interface SeriesSalesImportDao {
+	void addParsedData(Integer requestId, SeriesSalesParsedDataDbDto data);
+	SeriesSaleParsedDataDto findParsedDataByRequestId(Integer requestId);
+}

src/main/java/ru/mystamps/web/dao/TransactionParticipantDao.java

@@ -27,5 +27,6 @@ public interface TransactionParticipantDao {
 	void add(AddParticipantDbDto participant);
 	List<EntityWithParentDto> findBuyersWithParents();
 	List<EntityWithParentDto> findSellersWithParents();
+	Integer findSellerId(String name, String url);
 	List<EntityWithIdDto> findAllGroups();
 }

src/main/java/ru/mystamps/web/dao/dto/SeriesSaleParsedDataDto.java

@@ -0,0 +1,31 @@
+/*
+ * Copyright (C) 2009-2018 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.dao.dto;
+
+import java.math.BigDecimal;
+
+import lombok.Getter;
+import lombok.RequiredArgsConstructor;
+
+@Getter
+@RequiredArgsConstructor
+public class SeriesSaleParsedDataDto {
+	private final Integer sellerId;
+	private final BigDecimal price;
+	private final Currency currency;
+}

src/main/java/ru/mystamps/web/dao/dto/SeriesSalesParsedDataDbDto.java

@@ -0,0 +1,43 @@
+/*
+ * Copyright (C) 2009-2018 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.dao.dto;
+
+import java.math.BigDecimal;
+import java.util.Date;
+
+import lombok.Getter;
+import lombok.Setter;
+import lombok.ToString;
+
+@Getter
+@Setter
+@ToString(exclude = { "createdAt", "updatedAt" })
+public class SeriesSalesParsedDataDbDto {
+	private Integer sellerId;
+	private BigDecimal price;
+	private String currency;
+	private Date createdAt;
+	private Date updatedAt;
+	
+	// they aren't useless
+	@SuppressWarnings("PMD.UselessParentheses")
+	public boolean hasAtLeastOneFieldFilled() {
+		return sellerId != null || (price != null && currency != null);
+	}
+	
+}