[FORGE-87] Google ReCaptcha2 module for magnolia. Created: 19/Jun/17  Updated: 23/Jun/17  Resolved: 23/Jun/17

Status: Closed
Project: Forge

Type: Project registration Priority: Neutral
Reporter: Lazo Apostolovski Assignee: Pete Ryland
Resolution: Done Votes: 0
Labels: None

Project Name: ReCaptcha2 Magnolia Module
Project Short Name: magnolia-recaptcha2
Project Description: Google ReCaptcha2 API module for Magnolia cms.

In this module we provide classes, annotations and form procerssors for easy and fast usage of Google ReCaptcha2 API.
Project URL: https://github.com/tricode/magnolia-recaptcha2
Project SCM: Git (git.magnolia-cms.com)
Project Maven groupID: nl.tricode.magnolia.recaptcha2
Project License: https://github.com/tricode/magnolia-recaptcha2/blob/master/LICENSE

 Description   

Google ReCaptcha2 API module for Magnolia cms.

In this module we provide classes, annotations and form procerssors for easy and fast usage of Google ReCaptcha2 API.

Features

Freemarker macros usage

To use this module, include it in your module dependencies. In freemarker templates you can add recaptcha field by including include "/magnolia-recaptcha2/templates/macros/recaptcha2.ftl" which contains 2 macros:

reCaptchaField - render recaptcha with checkbox. Accept one parameter "callback" that can be used with API callback function name.
reCaptchaInvisible - render invisible recaptcha. Accept one parameter "callback" that can be used with API callback function name.
Validation annotation @ReCaptcha usage

You can use: nl.tricode.magnolia.recaptcha2.validation.ReCaptcha annotation to validate recaptcha in rest calls.

Java class usage

ReCaptcha2 class provides static methods for easy recaptcha response check with api.

Form processors usage

To use it in form, we provide nl.tricode.magnolia.recaptcha2.form.processors.ReCaptcha2FormProcessor form processor which validates recaptcha for submitted form.

Templating functions

Templating functions provides recaptcha site keys are registered under rec2fn and can be used to provide site key to your freemarkers.

Configuration

After instaling module you need to configure API Site and API Secret key. This keys will be provided to you by Google ReCaptcha2 API after registering your site. After you get this keys, place them in Magnolia CMS -> /configuration/modules/magnolia-recaptcha2/config

reCaptchaSecret
reCaptchaSiteKey
Prerequisites

git
java 8
Maven 3
License

Copyright (c) 2015 Tricode and contributors. Released under a GNUv3 license.



 Comments   
Comment by Pete Ryland [ 19/Jun/17 ]

Lazo, thanks for registering a new project at the Magnolia Forge!

A Jira project is available for you at https://jira.magnolia-cms.com/projects/RECAPTCHA2.

A Jenkins job is available at https://jenkins.magnolia-cms.com/job/forge_magnolia-recaptcha2.

More details about the infrastructure are available for you at https://forge.magnolia-cms.com/.

Please reopen this issue if you have any questions or if you encounter any issues.

Comment by Lazo Apostolovski [ 20/Jun/17 ]

Pete, How new version get released under /repositories/magnolia.forge.releases?

Comment by Pete Ryland [ 20/Jun/17 ]

Hi Lazo,

You should have the permission to do so, but the pom file must have the right details. I'm guessing that your pom is set to push to your existing maven repository, but to push to our repo, you'd need to use our parent pom as described in the documentation at https://wiki.magnolia-cms.com/display/FORGE/Home#Home-Mavenbuild. If it's a problem to change the pom because you still need to push to your maven repo, then we could also create a branch in your git repo with our parent pom, or even host a slightly-modified copy in our git server if that works better for you.

Comment by Lazo Apostolovski [ 21/Jun/17 ]

Hi Pete,
Its done
You can close this issue.

Comment by Pete Ryland [ 23/Jun/17 ]

Thanks Lazo!

Generated at Mon Feb 12 12:29:38 CET 2024 using Jira 9.4.2#940002-sha1:46d1a51de284217efdcb32434eab47a99af2938b.