php-coder / mystamps Goto Github PK

Useful links:

• https://github.com/GabiAxel/spring-social-google
• http://gabiaxel.github.io/spring-social-google-reference/
• http://adamneumann.co/bootstrap-social-buttons/
• http://nixmash.com/java/adding-google-sign-in-to-spring-social/
• https://www.wimdeblauwe.com/blog/2023/01/24/using-google-login-with-spring-boot-3-and-thymeleaf/

MailServiceImpl class doesn't have any unit tests. We should add them.

Technical Debt for: 681913b (#1)

Technical Debt for: 227b9a5 (#2)

Methods:

• createCollection()
• addToCollection()
• removeFromCollection()
• isSeriesInCollection()
• countCollectionsOfUsers()

@see http://docs.spring.io/spring-security/site/docs/3.2.x/reference/htmlsingle/#remember-me

During series creation user may specify not only year of release but also day and month.

Useful links:

• http://projects.spring.io/spring-social-facebook/
• http://spring.io/blog/2010/11/03/socializing-spring-applications/
• http://www.petrikainulainen.net/programming/spring-framework/adding-social-sign-in-to-a-spring-mvc-web-application-configuration/
• http://www.petrikainulainen.net/programming/spring-framework/adding-social-sign-in-to-a-spring-mvc-web-application-registration-and-login/
• http://adamneumann.co/bootstrap-social-buttons/
• http://krams915.blogspot.ru/2012/12/spring-social-with-javaconfig-part-1.html
• http://krams915.blogspot.ru/2012/12/spring-social-with-javaconfig-part-2.html
• http://krams915.blogspot.ru/2012/12/spring-social-with-javaconfig-part-3.html
• http://krams915.blogspot.ru/2012/12/spring-social-with-javaconfig-part-4.html
• http://krams915.blogspot.ru/2012/12/spring-social-with-javaconfig-part-5.html
• http://krams915.blogspot.ru/2012/12/spring-social-with-javaconfig-part-6.html
• http://krams915.blogspot.ru/2012/12/spring-social-with-javaconfig-part-7.html
• http://krams915.blogspot.ru/2012/12/spring-social-with-javaconfig-part-8.html
• http://www.captaindebug.com/2012/06/getting-started-with-spring-social.html
• http://www.captaindebug.com/2012/06/facebook-and-twitter-behind-scenes.html
• http://www.captaindebug.com/2012/06/oauth-administration-steps.html
• http://www.captaindebug.com/2012/07/oauth-20-webapp-flow-overview.html
• http://www.captaindebug.com/2012/07/getting-started-with-spring-social-part.html
• http://www.captaindebug.com/2012/07/getting-started-with-spring-social.html
• http://harmonicdevelopment.tumblr.com/post/13613051804/adding-spring-social-to-a-spring-mvc-and-spring
• http://harmonicdevelopment.tumblr.com/post/13626880413/adding-spring-social-to-a-spring-mvc-and-spring
• http://harmonicdevelopment.tumblr.com/post/13664810119/adding-spring-social-to-a-spring-mvc-and-spring
• http://www.gridshore.nl/2010/11/04/connecting-to-linkedin-using-spring-social/
• http://spring.io/blog/2015/01/26/springone2gx-2014-replay-booting-up-spring-social (video)
• http://nixmash.com/java/spring-social-additions-to-a-spring-security-app/
• https://www.marcobehler.com/guides/spring-security-oauth2

• check that collectionService.createCollection() invokes and argument isn't null

Technical Debt for: 227b9a5 (#2)

When all 3 fields were specified (day, month and year) then date must not be in future. Also when month and year were specified they either must not be in future. The same rule is applicable to the year: it must be current year or in past.

See also: http://in.relation.to/2013/08/09/hibernate-validator-510-alpha-1-released/#H-MessageInterpolation

Technical Debt for: 227b9a5 (#2)

When user opens series info page, he should see a button for removing series from collection. When he clicks on it, he should be redirected to collection page where this series shouldn't be listed.

Technical Debt for: 227b9a5 (#2)

At page with series info page, registered user may add series to own collection. After that at page with collection user can see all series in his collection.

• day must be passed to dao when day, month and year were specified
• month must be passed to dao when month and year were specified
• day must not be passed to dao if month and year were not specified
• month must not be passed to dao if year were not specified

Technical Debt for: a8573e7 (#4)

Useful links:

• http://projects.spring.io/spring-social-twitter/
• http://spring.io/blog/2010/11/03/socializing-spring-applications/
• http://www.petrikainulainen.net/programming/spring-framework/adding-social-sign-in-to-a-spring-mvc-web-application-configuration/
• http://www.petrikainulainen.net/programming/spring-framework/adding-social-sign-in-to-a-spring-mvc-web-application-registration-and-login/
• http://adamneumann.co/bootstrap-social-buttons/

Month must be >= 1 and <= 12. For all other cases, error message with code month.invalid must be shown.

Technical Debt for: a8573e7 (#4)

We should migrate to latest Spring 4.1.x version.

Useful resources:

• http://docs.spring.io/spring-framework/docs/4.0.x/spring-framework-reference/htmlsingle/#new-in-4.0
• http://xpadro.blogspot.com.es/2014/01/migrating-spring-mvc-restful-web.html

Also with new release we can use some new features:

• Dependency to BOM artifact (http://docs.spring.io/spring/docs/4.0.x/spring-framework-reference/html/overview.html#overview-maven-bom)
• @conditional (as replacement for @Profile) (http://docs.spring.io/spring-framework/docs/4.0.x/spring-framework-reference/htmlsingle/#beans-java-conditional)

• exception should be thrown if collection is null
• exception should be thrown if collection id is null
• should call seriesDao.findByAsSeriesInfo() and pass collection id and lang as arguments
• should pass null when lang is null

Technical Debt for: 227b9a5 (#2)

When user opens series info page, he should see a button for adding series to collection. When he clicks on it, he should be redirected to collection page where this series should be listed.

Technical Debt for: 227b9a5 (#2)

Technical Debt for: 5caa57c (#5)

On collection page any user should see a statistic about his collection:

• categories
• countries
• series
• stamps

If collection is empty then statistic shouldn't be shown.

Useful links:

• https://github.com/vkolodrevskiy/spring-social-vkontakte
• http://adamneumann.co/bootstrap-social-buttons/

When user has empty collection and adds series, then counter of collections on index page should be increased.

Technical Debt for: 227b9a5 (#2)

If all 3 fields were specified (day, month and year) then date must be valid (i.e. exists).

See also: http://in.relation.to/2013/08/09/hibernate-validator-510-alpha-1-released/#H-MessageInterpolation

We may utilize service https://coveralls.io/ for publishing statistic of code coverage and have online acces to it.

Tasks:

• Register on https://coveralls.io/
• Use coveralls-maven-plugin (https://github.com/trautonen/coveralls-maven-plugin)
• Add badge to README.md

@see http://spring.io/blog/2013/07/02/spring-security-java-config-preview-introduction/
@see http://spring.io/blog/2013/07/03/spring-security-java-config-preview-web-security/
@see http://spring.io/blog/2013/07/04/spring-security-java-config-preview-method-security/

During country's creation, user should have ability to specify country name on Russian. This localized name will be shown later on site for all users with Russian locale.

Users should see 10 last added series on index page.

Add year field validation at series creation page. It must be inside range [1840, $currentYear].

After user's registration we should send mail to him with activation key. The message should be on Russian and on English. Probably, we can use Mailgun service (http://www.mailgun.com/) to sending our mails.

When any user opens page with non-empty collection he should see 2 pie charts:

• by categories
• by countries

We should correctly handle cases when

• user has series with unknown countries (we should group them together and show in gray color)
• some of categories/countries represent less than 1% (we should group them together and show in gray color)

May be we could use Google Charts (https://developers.google.com/chart/) for that:

• https://developers.google.com/chart/interactive/docs/gallery/piechart#Example
• https://developers.google.com/chart/interactive/docs/gallery/piechart#donut

Special page should be shown when any exception occurs on the site.

We should implement integration tests for such cases:

$ curl -s 'http://localhost:8081/' -H 'Accept-Language: ru' | grep '<body'
    <body lang="ru">
$ curl -s 'http://localhost:8081/' -H 'Accept-Language: en' | grep '<body'
    <body lang="en">
$ curl -s 'http://localhost:8081/' -H 'Accept-Language: fr' | grep '<body'
    <body lang="en">

Tech Debt for fb24a23 (#31)

On index page only 10 recently added series should be shown. When user adds 11 then last series should disappear.

Technical Debt for: 5caa57c (#5)

Need to research and implement special version of email validator which will use Mailgun API. This allows to us detect more invalid e-mail addresses.

See http://documentation.mailgun.com/api-email-validation.html#email-validation

Related to: #1 and commit 681913b

Thymeleaf (http://www.thymeleaf.org/) is a mature technology which has good enough support of Spring MVC and Spring Security (https://github.com/thymeleaf/thymeleaf-extras-springsecurity3).

When field month was filled, field year is mandatory. If validation failed then error message with code month.requires.year must be shown.

Technical Debt for: a8573e7 (#4)

@see http://docs.spring.io/spring-security/site/docs/3.2.x/reference/htmlsingle/#csrf

Change URLs from /country/1 to /country/1/italy.

Also place tag on country's info page (http://robotstxt.org.ru/rurobots/yandex/yandex-robot-control#relquotcanonicalquot__ltlinkgt).

Apache DBCP library which used by now for connection pooling isn't perfect and should be replaced by better library, for instance, HikariCP (https://brettwooldridge.github.io/HikariCP/).

Related links:

• https://github.com/brettwooldridge/HikariCP/wiki/Pool-Analysis
• http://stackoverflow.com/questions/520585/connection-pooling-options-with-jdbc-dbcp-vs-c3p0
• https://github.com/brettwooldridge/HikariCP/wiki/MySQL-Configuration
• https://github.com/brettwooldridge/HikariCP/wiki/Rapid-Recovery

When field day was filled, field month is mandatory. If validation failed then error message with code day.requires.month must be shown.

Technical Debt for: a8573e7 (#4)

Change URLs from /category/1 to /category/1/animals

Also place tag on country's info page (http://robotstxt.org.ru/rurobots/yandex/yandex-robot-control#relquotcanonicalquot__ltlinkgt).

Our integration tests only test the case when user has English locale. We also should add test where user has Russian locale to check that language of mail message depends on user's locale.

Technical Debt for: 681913b (#1)

When user has collection with one series and removes this series, then counter of collections on index page should be decreased.

Technical Debt for: 227b9a5 (#2)

We should try to use jQuery email address validator by Mailgun because it improves speed on the client side, add additional protection and also allows to us detecting typos and improve user experience.

@see https://github.com/mailgun/validator-demo

Related to: #1 and commit 681913b

We should output user's language as <body>s attribute:

<body lang="(ru|en)">

Day of month must be >= 1 and <= 31. For all other cases, error message with code day.invalid must be shown.

Technical Debt for: a8573e7 (#4)

We should port our views to use Bootstrap 3.x instead of 2.x which is a bit outdated.

• Port views (static + dynamic):
  • account/activate.html
  • account/auth.html
  • account/register.html
  • category/add.html
  • category/info.html
  • collection/info.html
  • country/add.html
  • country/info.html
  • error/401.html
  • error/403.html
  • error/404.html
  • error/500.html
  • series/add.html
  • series/info.html
  • site/index.html
• Test in IE
• Update NEWS.txt

When anonymous user opens series info page, he should see link to registration page.

Technical Debt for: 227b9a5 (#2)

Users should see 10 last created (non empty) collections on index page.

After adding new series it should be shown on index page in list of recently added series.

Technical Debt for: 5caa57c (#5)

Cucumber (https://github.com/cucumber/cucumber-jvm) is a great framework for writing acceptance tests. We definitely should use it instead of our's own.

• Read https://cucumber.io/docs/reference
• Read https://cucumber.io/docs/reference/jvm
• Read https://thomassundberg.wordpress.com/2014/05/29/cucumber-jvm-hello-world/
• Read http://www.slideshare.net/alan_parkinson/test-automation-with-cucumberjvm
• Watch https://www.youtube.com/playlist?list=PL_noPv5wmuO_t6yYbPfjwhJFOOcio89tI
  • Setting Up Cucumber
  • Writing a Basic Script
  • Writing a Basic WebDriver Script
  • Parameter Handling
  • Scenario Data Tables
  • Scenario Outline Data Tables
  • Scenario Hooks
  • Maven Setup
  • Cucumber Reporting
  • Test Suites
  • Drop Downs, Checkboxes and Radios
  • Background Script
  • Multiple Step Definition Classes
  • Page Objects
• Port our test
  • WhenAdminAddCategory
    • categoryNameEnShouldNotBeTooShort()
    • categoryNameRuShouldNotBeTooShort()
    • categoryNameEnShouldNotBeTooLong()
    • categoryNameRuShouldNotBeTooLong()
    • categoryNameEnShouldBeUnique()
    • categoryNameRuShouldBeUnique()
    • categoryNameEnWithAllowedCharactersShouldBeAccepted()
    • categoryNameRuWithAllowedCharactersShouldBeAccepted()
    • categoryNameEnWithForbiddenCharactersShouldBeRejected()
    • categoryNameRuWithForbiddenCharactersShouldBeRejected()
    • categoryNameEnShouldNotStartsFromHyphen()
    • categoryNameRuShouldNotStartsFromHyphen()
    • categoryNameEnShouldNotEndsWithHyphen()
    • categoryNameRuShouldNotEndsWithHyphen()
    • categoryNameEnShouldBeStripedFromLeadingAndTrailingSpaces()
    • categoryNameRuShouldBeStripedFromLeadingAndTrailingSpaces()
    • shouldBeRedirectedToPageWithInfoAboutCategoryAfterCreation()
    • categoryShouldBeAvailableForChoosingAtPageWithSeries()
  • WhenAdminAddCountry
    • countryNameEnShouldNotBeTooShort()
    • countryNameRuShouldNotBeTooShort()
    • countryNameEnShouldNotBeTooLong()
    • countryNameRuShouldNotBeTooLong()
    • countryNameEnShouldBeUnique()
    • countryNameRuShouldBeUnique()
    • countryNameEnWithAllowedCharactersShouldBeAccepted()
    • countryNameRuWithAllowedCharactersShouldBeAccepted()
    • countryNameEnWithForbiddenCharactersShouldBeRejected()
    • countryNameRuWithForbiddenCharactersShouldBeRejected()
    • countryNameEnShouldNotStartsFromHyphen()
    • countryNameRuShouldNotStartsFromHyphen()
    • countryNameEnShouldNotEndsWithHyphen()
    • countryNameRuShouldNotEndsWithHyphen()
    • countryNameEnShouldBeStripedFromLeadingAndTrailingSpaces()
    • countryNameRuShouldBeStripedFromLeadingAndTrailingSpaces()
    • shouldBeRedirectedToPageWithInfoAboutCountryAfterCreation()
    • countryShouldBeAvailableForChoosingAtPageWithSeries()
  • WhenAdminAddSeries
    • catalogNumbersShouldAcceptValidValues()
    • quantityShouldBeANumber()
    • quantityShouldBeNotLessThanLimit()
    • quantityShouldNotBeGreaterThanLimit()
    • catalogNumbersShouldRejectInvalidValues()
    • catalogPricesShouldRejectInvalidValues()
    • commentShouldNotBeTooLong()
    • imageSizeMustBeGreaterThanZero()
    • issueYearFieldShouldHaveOptionsForRangeFrom1840ToCurrentYear()
    • catalogNumbersShouldBeStripedFromSpaces()
    • commentShouldBeStripedFromLeadingAndTrailingSpaces()
    • shouldCreateSeriesWithOnlyRequiredFieldsFilled()
    • shouldCreateSeriesWithAllFieldsFilled()
    • shouldIgnoreDuplicatedCatalogNumbers()
    • shouldAllowExistingCatalogNumbers()
  • WhenAdminAtIndexPage
    • shouldExistsWelcomeText()
    • shouldExistsLinkForAddingSeries()
    • shouldExistsLinkForAddingCountries()
    • shouldExistsLinkForAddingCategories()
  • WhenAnonymousUserActivateAccount
    • activationKeyShouldBeAutoFilledFromURL()
    • loginAndPasswordShouldBeDifferent()
    • passwordAndConfirmationShouldMatch()
    • loginShouldNotBeTooShort()
    • mostShortLoginShouldBeAccepted()
    • loginShouldNotBeTooLong()
    • mostLongLoginShouldBeAccepted()
    • loginWithAllowedCharactersShouldBeAccepted()
    • loginWithForbiddenCharactersShouldBeRejected()
    • loginShouldBeUnique()
    • nameShouldNotBeTooLong()
    • nameWithAllowedCharactersShouldBeAccepted()
    • nameWithForbiddenCharactersShouldBeRejected()
    • nameShouldNotStartsFromHyphen()
    • nameShouldNotEndsWithHyphen()
    • nameShouldBeStripedFromLeadingAndTrailingSpaces()
    • passwordShouldNotBeTooShort()
    • mostShortPasswordShouldBeAccepted()
    • passwordWithAllowedCharactersShouldBeAccepted()
    • passwordWithForbiddenCharactersShouldBeRejected()
    • activationKeyShouldNotBeTooShort()
    • activationKeyShouldNotBeTooLong()
    • activationKeyWithForbiddenCharactersShouldBeRejected()
    • wrongActivationKeyShouldBeRejected()
    • afterActivationShouldExistsMessageWithLinkForAuthentication()
    • activationShouldPassWhenUserProvidedEmptyName()
  • WhenAnonymousUserAddCategory
    • shouldExistsErrorMessage()
    • shouldExistsErrorCode()
  • WhenAnonymousUserAddCountry
    • shouldExistsErrorMessage()
    • shouldExistsErrorCode()
  • WhenAnonymousUserAddSeries
    • shouldExistsErrorMessage()
    • shouldExistsErrorCode()
  • WhenAnonymousUserAtForbiddenPage
    • shouldExistsErrorMessage()
    • shouldExistsErrorCode()
  • WhenAnonymousUserAtIndexPage
    • shouldAbsentWelcomeText()
    • linkForAddingSeriesShouldBeAbsent()
    • linkForAddingCategoriesShouldBeAbsent()
    • linkForAddingCountriesShouldBeAbsent()
  • WhenAnonymousUserAtUnauthorizedPage
    • shouldExistsErrorMessage()
    • shouldExistsErrorCode()
  • WhenAnonymousUserAuthenticates
    • emptyValuesShouldBeConsideredAsInvalidCredentials()
    • invalidCredentialsShouldBeRejected()
    • validCredentialsShouldAuthenticateUserOnSite()
  • WhenAnonymousUserOpenNotExistingCategoryPage
    • shouldShow404Page()
  • WhenAnonymousUserOpenNotExistingCountryPage
    • shouldShow404Page()
  • WhenAnonymousUserOpenNotExistingSeriesPage
    • shouldShow404Page()
  • WhenAnonymousUserOpenNotExistingPage
    • shouldExistsErrorMessage()
    • shouldExistsErrorCode()
    • incidentShouldBeLoggedToDatabase()
    • shouldShow404Page()
  • WhenAnonymousUserOpenTogglzConsole
    • shouldExistsErrorMessage()
    • shouldExistsErrorCode()
  • WhenAnonymousUserRegisterAccount
    • shouldExistsMessageWithLinkToAuthenticationPage()
    • emailShouldNotBeTooLong()
    • emailShouldBeValid()
    • emailShouldBeStripedFromLeadingAndTrailingSpaces()
    • successfulMessageShouldBeShownAfterRegistration()
    • emailWithActivationKeyShouldBeSentAfterRegistration()
  • WhenUserAddSeries
    • catalogNumbersShouldAcceptValidValues()
    • quantityShouldBeANumber()
    • quantityShouldBeNotLessThanLimit()
    • quantityShouldNotBeGreaterThanLimit()
    • catalogNumbersShouldRejectInvalidValues()
    • catalogPricesShouldRejectInvalidValues()
    • imageSizeMustBeGreaterThanZero()
    • issueYearFieldShouldHaveOptionsForRangeFrom1840ToCurrentYear()
    • catalogNumbersShouldBeStripedFromSpaces()
    • shouldCreateSeriesWithOnlyRequiredFieldsFilled()
    • shouldCreateSeriesWithAllFieldsFilled()
    • shouldIgnoreDuplicatedCatalogNumbers()
    • shouldAllowExistingCatalogNumbers()
  • WhenUserAtActivateAccountPage
    • messageShouldBeShown()
    • messageShouldBeShown()
    • formWithLegendShouldBeAbsent()
  • WhenUserAtAuthPage
    • messageShouldBeShown()
    • formWithLegendShouldBeAbsent()
  • WhenUserAtIndexPage
    • shouldExistsWelcomeText()
    • shouldExistsLinkForAddingSeries()
    • linkForAddingCategoriesShouldBeAbsent()
    • linkForAddingCountriesShouldBeAbsent()
  • WhenUserAtRegisterAccountPage
    • messageShouldBeShown()
    • formWithLegendShouldBeAbsent()
  • WhenUserLogsOut.shouldRedirectAndClearSession()
  • WhenUserOpenTogglzConsole
    • shouldExistsErrorMessage()
    • shouldExistsErrorCode()
• Port checks for required fields
  • add category
  • add country
  • add series
  • registration
  • activation
• Port standart checks
• Review and remove branch re_131_thucidies
• Review and remove branch re_131_thucidies_new
• Review and remove branch re_131_thucidies_new_new
• Review and remove branch gh18_serenity
• Update README.md
• Add package-info.java files
• Update wiki if it's required
• Remove TestNG dependency
• Remove fest-assert dependency
• Update src/main/config/checkstyle-suppressions.xml
• Update src/main/config/checkstyle.xml (remove testng and fest; add junit and hamcrest)