Implement feature "admin can add a link to a page where someone sells series".

Fix #198

Author: php-coder

NEWS.txt

@@ -10,6 +10,8 @@
 - (infrastructure) ported to Spring's JdbcTemplate (get rid of Spring-Data-JPA and Hibernate)
 - (functionality)  send daily reports to admin by e-mail
 - (infrastructure) use logback (instead of log4j) for logging
+- (functionality)  add possibility for adding series sales
+- (functionality)  add interface for viewing series sales (contributed by Sergey Chechenev)
 
 0.3
 - (functionality)  implemented possibility to user to add series to his collection

src/main/config/checkstyle-suppressions.xml

@@ -14,4 +14,7 @@
 	<!-- These files will be removed during porting integration tests to Cucumber JVM (see #18) -->
 	<suppress checks="ImportOrder" files="src/test/java/ru/mystamps/web/tests" />
 
+	<!-- false positives beause these files contain SQL queries -->
+	<suppress checks="Translation" files="src/main/resources/sql" />
+	
 </suppressions>

src/main/config/findbugs-filter.xml

@@ -8,6 +8,15 @@
 		<Class name="~.*\.dto\..*" />
 		<Bug pattern="EI_EXPOSE_REP,EI_EXPOSE_REP2" />
 	</Match>
+	<Match>
+		<!--
+			Our DTO classes expose it's internal representation.
+			Most of the time because they're using Date class and
+			storing data in byte[].
+		-->
+		<Class name="~.*\.model\..*" />
+		<Bug pattern="EI_EXPOSE_REP,EI_EXPOSE_REP2" />
+	</Match>
 	<Match>
 		<!--
 			It's ok, that we're don't override parent's equals() method.

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

@@ -53,6 +53,7 @@ public final class Url {
 	public static final String ADD_SERIES_PAGE               = "/series/add";
 	public static final String ADD_SERIES_WITH_CATEGORY_PAGE = "/series/add/category/{slug}";
 	public static final String ADD_SERIES_WITH_COUNTRY_PAGE  = "/series/add/country/{slug}";
+	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 SEARCH_SERIES_BY_CATALOG      = "/series/search/by_catalog";
@@ -127,6 +128,7 @@ public static Map<String, String> asMap(boolean serveContentFromSingleHost) {
 		map.put("ADD_SERIES_PAGE", ADD_SERIES_PAGE);
 		map.put("ADD_SERIES_WITH_CATEGORY_PAGE", ADD_SERIES_WITH_CATEGORY_PAGE);
 		map.put("ADD_SERIES_WITH_COUNTRY_PAGE", ADD_SERIES_WITH_COUNTRY_PAGE);
+		map.put("ADD_SERIES_ASK_PAGE", ADD_SERIES_ASK_PAGE);
 		map.put("INFO_SERIES_PAGE", INFO_SERIES_PAGE);
 		map.put("ADD_IMAGE_SERIES_PAGE", ADD_IMAGE_SERIES_PAGE);
 		map.put("SEARCH_SERIES_BY_CATALOG", SEARCH_SERIES_BY_CATALOG);

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

@@ -51,7 +51,9 @@ public static PropertySourcesPlaceholderConfigurer getPropertySourcesPlaceholder
 			new ClassPathResource("sql/user_dao_queries.properties"),
 			new ClassPathResource("sql/users_activation_dao_queries.properties"),
 			new ClassPathResource("sql/series_dao_queries.properties"),
-			new ClassPathResource("sql/suspicious_activity_dao_queries.properties")
+			new ClassPathResource("sql/series_sales_dao_queries.properties"),
+			new ClassPathResource("sql/suspicious_activity_dao_queries.properties"),
+			new ClassPathResource("sql/transaction_participants_dao_queries.properties")
 		);
 		return configurer;
 	}

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

@@ -89,7 +89,9 @@ public SeriesController getSeriesController() {
 			servicesConfig.getCategoryService(),
 			servicesConfig.getCollectionService(),
 			servicesConfig.getCountryService(),
-			servicesConfig.getSeriesService()
+			servicesConfig.getSeriesService(),
+			servicesConfig.getSeriesSalesService(),
+			servicesConfig.getTransactionParticipantService()
 		);
 	}
 

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

@@ -97,6 +97,11 @@ public SeriesDao getSeriesDao() {
 		return new JdbcSeriesDao(jdbcTemplate);
 	}
 
+	@Bean
+	public SeriesSalesDao getSeriesSalesDao() {
+		return new JdbcSeriesSalesDao(jdbcTemplate);
+	}
+	
 	@Bean
 	public UserDao getUserDao() {
 		return new JdbcUserDao(jdbcTemplate);
@@ -112,6 +117,11 @@ public SuspiciousActivityDao getSuspiciousActivityDao() {
 		return new JdbcSuspiciousActivityDao(jdbcTemplate);
 	}
 
+	@Bean
+	public TransactionParticipantDao getTransactionParticipantDao() {
+		return new JdbcTransactionParticipantDao(jdbcTemplate);
+	}
+	
 	@Bean
 	public StampsCatalogDao getYvertCatalogDao() {
 		return new JdbcStampsCatalogDao(

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

@@ -114,6 +114,11 @@ public SeriesService getSeriesService() {
 		);
 	}
 
+	@Bean
+	public SeriesSalesService getSeriesSalesService() {
+		return new SeriesSalesServiceImpl(daoConfig.getSeriesSalesDao());
+	}
+	
 	@Bean
 	public SiteService getSiteService() {
 		return new SiteServiceImpl(daoConfig.getSuspiciousActivityDao());
@@ -149,4 +154,9 @@ public StampsCatalogService getGibbonsCatalogService() {
 		return new StampsCatalogServiceImpl("Gibbons", daoConfig.getGibbonsCatalogDao());
 	}
 
+	@Bean
+	public TransactionParticipantService getTransactionParticipantService() {
+		return new TransactionParticipantServiceImpl(daoConfig.getTransactionParticipantDao());
+	}
+	
 }

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

@@ -20,6 +20,7 @@
 import java.io.IOException;
 import java.util.Calendar;
 import java.util.Collections;
+import java.util.Date;
 import java.util.GregorianCalendar;
 import java.util.HashMap;
 import java.util.LinkedHashMap;
@@ -56,15 +57,19 @@
 import ru.mystamps.web.controller.converter.annotation.Category;
 import ru.mystamps.web.controller.converter.annotation.Country;
 import ru.mystamps.web.controller.converter.annotation.CurrentUser;
+import ru.mystamps.web.dao.dto.EntityWithIdDto;
 import ru.mystamps.web.dao.dto.LinkEntityDto;
 import ru.mystamps.web.dao.dto.PurchaseAndSaleDto;
 import ru.mystamps.web.dao.dto.SeriesInfoDto;
 import ru.mystamps.web.model.AddImageForm;
 import ru.mystamps.web.model.AddSeriesForm;
+import ru.mystamps.web.model.AddSeriesSalesForm;
 import ru.mystamps.web.service.CategoryService;
 import ru.mystamps.web.service.CollectionService;
 import ru.mystamps.web.service.CountryService;
+import ru.mystamps.web.service.SeriesSalesService;
 import ru.mystamps.web.service.SeriesService;
+import ru.mystamps.web.service.TransactionParticipantService;
 import ru.mystamps.web.service.dto.SeriesDto;
 import ru.mystamps.web.support.spring.security.Authority;
 import ru.mystamps.web.support.spring.security.CustomUserDetails;
@@ -78,7 +83,7 @@
 
 @Controller
 @RequiredArgsConstructor
-@SuppressWarnings({ "PMD.AvoidDuplicateLiterals", "PMD.TooManyMethods"})
+@SuppressWarnings({ "PMD.AvoidDuplicateLiterals", "PMD.TooManyMethods", "PMD.GodClass" })
 public class SeriesController {
 
 	private static final Integer CURRENT_YEAR   = new GregorianCalendar().get(Calendar.YEAR);
@@ -89,6 +94,8 @@ public class SeriesController {
 	private final CollectionService collectionService;
 	private final CountryService countryService;
 	private final SeriesService seriesService;
+	private final SeriesSalesService seriesSalesService;
+	private final TransactionParticipantService transactionParticipantService;
 
 	static {
 		YEARS = new LinkedHashMap<>();
@@ -207,6 +214,8 @@ public String showInfo(
 		Map<String, ?> commonAttrs = prepareCommonAttrsForSeriesInfo(series, currentUserId);
 		model.addAllAttributes(commonAttrs);
 
+		addSeriesSalesFormToModel(model);
+		
 		AddImageForm form = new AddImageForm();
 		model.addAttribute("addImageForm", form);
 
@@ -245,6 +254,8 @@ public String processImage(
 			Map<String, ?> commonAttrs = prepareCommonAttrsForSeriesInfo(series, currentUserId);
 			model.addAllAttributes(commonAttrs);
 
+			addSeriesSalesFormToModel(model);
+			
 			// don't try to re-display file upload field
 			form.setImage(null);
 
@@ -313,6 +324,49 @@ public String removeFromCollection(
 		return redirectTo(Url.INFO_COLLECTION_PAGE, collectionSlug);
 	}
 
+	@PostMapping(Url.ADD_SERIES_ASK_PAGE)
+	public String processAskForm(
+			@Valid AddSeriesSalesForm form,
+			BindingResult result,
+			@PathVariable("id") Integer seriesId,
+			Model model,
+			@CurrentUser Integer currentUserId,
+			Locale userLocale,
+			HttpServletResponse response)
+			throws IOException {
+		
+		if (seriesId == null) {
+			response.sendError(HttpServletResponse.SC_NOT_FOUND);
+			return null;
+		}
+		
+		String lang = LocaleUtils.getLanguageOrNull(userLocale);
+		SeriesDto series = seriesService.findFullInfoById(seriesId, lang);
+		if (series == null) {
+			response.sendError(HttpServletResponse.SC_NOT_FOUND);
+			return null;
+		}
+		
+		boolean maxQuantityOfImagesExceeded = !isAdmin() && !isAllowedToAddingImages(series);
+		model.addAttribute("maxQuantityOfImagesExceeded", maxQuantityOfImagesExceeded);
+		
+		AddImageForm addImageForm = new AddImageForm();
+		model.addAttribute("addImageForm", addImageForm);
+		
+		if (result.hasErrors() || maxQuantityOfImagesExceeded) {
+			Map<String, ?> commonAttrs = prepareCommonAttrsForSeriesInfo(series, currentUserId);
+			model.addAllAttributes(commonAttrs);
+			
+			addSeriesSalesFormToModel(model);
+			
+			return "series/info";
+		}
+		
+		seriesSalesService.add(form, series.getId(), currentUserId);
+		
+		return redirectTo(Url.INFO_SERIES_PAGE, series.getId());
+	}
+	
 	@PostMapping(Url.SEARCH_SERIES_BY_CATALOG)
 	public String searchSeriesByCatalog(
 		@RequestParam("catalogNumber") String catalogNumber,
@@ -386,6 +440,25 @@ public String searchSeriesByCatalog(
 		return model;
 	}
 
+	private void addSeriesSalesFormToModel(Model model) {
+		if (!(Features.ADD_PURCHASES_AND_SALES.isActive()
+			&& SecurityContextUtils.hasAuthority(Authority.ADD_SERIES_SALES))) {
+			return;
+		}
+		
+		if (!model.containsAttribute("addSeriesSalesForm")) {
+			AddSeriesSalesForm addSeriesSalesForm = new AddSeriesSalesForm();
+			addSeriesSalesForm.setDate(new Date());
+			model.addAttribute("addSeriesSalesForm", addSeriesSalesForm);
+		}
+		
+		List<EntityWithIdDto> sellers = transactionParticipantService.findAllSellers();
+		model.addAttribute("sellers", sellers);
+		
+		List<EntityWithIdDto> buyers = transactionParticipantService.findAllBuyers();
+		model.addAttribute("buyers", buyers);
+	}
+	
 	private static boolean isAllowedToAddingImages(SeriesDto series) {
 		return series.getImageIds().size() <= series.getQuantity();
 	}

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

@@ -0,0 +1,24 @@
+/*
+ * Copyright (C) 2009-2016 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.AddSeriesSalesDbDto;
+
+public interface SeriesSalesDao {
+	void add(AddSeriesSalesDbDto dto);
+}

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

@@ -0,0 +1,26 @@
+/*
+ * Copyright (C) 2009-2016 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 java.util.List;
+
+import ru.mystamps.web.dao.dto.EntityWithIdDto;
+
+public interface TransactionParticipantDao {
+	List<EntityWithIdDto> findAllAsEntityWithIdDto();
+}

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

@@ -0,0 +1,40 @@
+/*
+ * Copyright (C) 2009-2016 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;
+
+@Getter
+@Setter
+public class AddSeriesSalesDbDto {
+	private Integer seriesId;
+	private Date date;
+	private Integer sellerId;
+	private String url;
+	private BigDecimal price;
+	private String currency;
+	private BigDecimal altPrice;
+	private String altCurrency;
+	private Integer buyerId;
+	private Date createdAt;
+	private Integer createdBy;
+}

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

@@ -0,0 +1,30 @@
+/*
+ * Copyright (C) 2009-2016 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 lombok.Getter;
+import lombok.RequiredArgsConstructor;
+import lombok.ToString;
+
+@Getter
+@ToString
+@RequiredArgsConstructor
+public class EntityWithIdDto {
+	private final Integer id;
+	private final String name;
+}