Skip to content

Commit

Permalink
[MIG] website_recaptcha_v2: migration to 16.0
Browse files Browse the repository at this point in the history
  • Loading branch information
@huguesdk
huguesdk committed Jan 16, 2024
1 parent d97a180 commit 5e0108b
Show file tree
Hide file tree
Showing 6 changed files with 84 additions and 83 deletions.
12 changes: 6 additions & 6 deletions website_recaptcha_v2/README.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Website reCAPTCHA v2
!! This file is generated by oca-gen-addon-readme !!
!! changes will be overwritten. !!
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! source digest: sha256:7f93442702a45bbb8c73c99e3b4b0954f9ef93ea935012d7de96bf37ae5e76be
!! source digest: sha256:55856dbbdf9c9efc1b9b1ebbb33638a0018eda0d91bd6c8c9e30805aa8f2e5b0
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
Expand All @@ -17,13 +17,13 @@ Website reCAPTCHA v2
:target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
:alt: License: AGPL-3
.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fwebsite-lightgray.png?logo=github
:target: https://github.com/OCA/website/tree/12.0/website_recaptcha_v2
:target: https://github.com/OCA/website/tree/16.0/website_recaptcha_v2
:alt: OCA/website
.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
:target: https://translation.odoo-community.org/projects/website-12-0/website-12-0-website_recaptcha_v2
:target: https://translation.odoo-community.org/projects/website-16-0/website-16-0-website_recaptcha_v2
:alt: Translate me on Weblate
.. |badge5| image:: https://img.shields.io/badge/runboat-Try%20me-875A7B.png
:target: https://runboat.odoo-community.org/builds?repo=OCA/website&target_branch=12.0
:target: https://runboat.odoo-community.org/builds?repo=OCA/website&target_branch=16.0
:alt: Try me on Runboat

|badge1| |badge2| |badge3| |badge4| |badge5|
Expand Down Expand Up @@ -55,7 +55,7 @@ Bug Tracker
Bugs are tracked on `GitHub Issues <https://github.com/OCA/website/issues>`_.
In case of trouble, please check there if your issue has already been reported.
If you spotted it first, help us to smash it by providing a detailed and welcomed
`feedback <https://github.com/OCA/website/issues/new?body=module:%20website_recaptcha_v2%0Aversion:%2012.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
`feedback <https://github.com/OCA/website/issues/new?body=module:%20website_recaptcha_v2%0Aversion:%2016.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.

Do not contact contributors directly about support or help with technical issues.

Expand Down Expand Up @@ -101,6 +101,6 @@ OCA, or the Odoo Community Association, is a nonprofit organization whose
mission is to support the collaborative development of Odoo features and
promote its widespread use.

This module is part of the `OCA/website <https://github.com/OCA/website/tree/12.0/website_recaptcha_v2>`_ project on GitHub.
This module is part of the `OCA/website <https://github.com/OCA/website/tree/16.0/website_recaptcha_v2>`_ project on GitHub.

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.
2 changes: 1 addition & 1 deletion website_recaptcha_v2/__manifest__.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

{
"name": "Website reCAPTCHA v2",
"version": "15.0.1.0.0",
"version": "16.0.1.0.0",
"category": "Website",
"depends": ["website"],
"author": (
Expand Down
3 changes: 2 additions & 1 deletion website_recaptcha_v2/models/website.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@
from odoo import _, api, fields, models

URL = "https://www.recaptcha.net/recaptcha/api/siteverify"
RECAPTCHA_API_TIMEOUT = 30


class Website(models.Model):
Expand Down Expand Up @@ -52,7 +53,7 @@ def is_recaptcha_v2_valid(self, form_values):
return (False, _("No response given."))
get_res = {"secret": self.recaptcha_v2_secret_key, "response": response}

res = requests.post(URL, data=get_res).json()
res = requests.post(URL, data=get_res, timeout=RECAPTCHA_API_TIMEOUT).json()

error_msg = "\n".join(
self._get_error_message(error) for error in res.get("error-codes", [])
Expand Down
40 changes: 20 additions & 20 deletions website_recaptcha_v2/static/description/index.html
View file
Original file line number Diff line number Diff line change
@@ -1,20 +1,20 @@
<?xml version="1.0" encoding="utf-8" ?>
<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="Docutils: http://docutils.sourceforge.net/" />
<meta name="generator" content="Docutils: https://docutils.sourceforge.io/" />
<title>Website reCAPTCHA v2</title>
<style type="text/css">

/*
:Author: David Goodger (goodger@python.org)
:Id: $Id: html4css1.css 7952 2016-07-26 18:15:59Z milde $
:Id: $Id: html4css1.css 8954 2022-01-20 10:10:25Z milde $
:Copyright: This stylesheet has been placed in the public domain.

Default cascading style sheet for the HTML output of Docutils.

See http://docutils.sf.net/docs/howto/html-stylesheets.html for how to
See https://docutils.sourceforge.io/docs/howto/html-stylesheets.html for how to
customize this style sheet.
*/

Expand Down Expand Up @@ -367,9 +367,9 @@ <h1 class="title">Website reCAPTCHA v2</h1>
!! This file is generated by oca-gen-addon-readme !!
!! changes will be overwritten. !!
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! source digest: sha256:7f93442702a45bbb8c73c99e3b4b0954f9ef93ea935012d7de96bf37ae5e76be
!! source digest: sha256:55856dbbdf9c9efc1b9b1ebbb33638a0018eda0d91bd6c8c9e30805aa8f2e5b0
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
<p><a class="reference external" href="https://odoo-community.org/page/development-status"><img alt="Beta" src="https://img.shields.io/badge/maturity-Beta-yellow.png" /></a> <a class="reference external" href="http://www.gnu.org/licenses/agpl-3.0-standalone.html"><img alt="License: AGPL-3" src="https://img.shields.io/badge/licence-AGPL--3-blue.png" /></a> <a class="reference external" href="https://github.com/OCA/website/tree/12.0/website_recaptcha_v2"><img alt="OCA/website" src="https://img.shields.io/badge/github-OCA%2Fwebsite-lightgray.png?logo=github" /></a> <a class="reference external" href="https://translation.odoo-community.org/projects/website-12-0/website-12-0-website_recaptcha_v2"><img alt="Translate me on Weblate" src="https://img.shields.io/badge/weblate-Translate%20me-F47D42.png" /></a> <a class="reference external" href="https://runboat.odoo-community.org/builds?repo=OCA/website&amp;target_branch=12.0"><img alt="Try me on Runboat" src="https://img.shields.io/badge/runboat-Try%20me-875A7B.png" /></a></p>
<p><a class="reference external image-reference" href="https://odoo-community.org/page/development-status"><img alt="Beta" src="https://img.shields.io/badge/maturity-Beta-yellow.png" /></a> <a class="reference external image-reference" href="http://www.gnu.org/licenses/agpl-3.0-standalone.html"><img alt="License: AGPL-3" src="https://img.shields.io/badge/licence-AGPL--3-blue.png" /></a> <a class="reference external image-reference" href="https://github.com/OCA/website/tree/16.0/website_recaptcha_v2"><img alt="OCA/website" src="https://img.shields.io/badge/github-OCA%2Fwebsite-lightgray.png?logo=github" /></a> <a class="reference external image-reference" href="https://translation.odoo-community.org/projects/website-16-0/website-16-0-website_recaptcha_v2"><img alt="Translate me on Weblate" src="https://img.shields.io/badge/weblate-Translate%20me-F47D42.png" /></a> <a class="reference external image-reference" href="https://runboat.odoo-community.org/builds?repo=OCA/website&amp;target_branch=16.0"><img alt="Try me on Runboat" src="https://img.shields.io/badge/runboat-Try%20me-875A7B.png" /></a></p>
<p>This module allows to use reCAPTCHA v2 on website forms.</p>
<p>It is a helper module that only provides the widget and the validation logic
which can be used by other modules to actually display it on website forms and
Expand All @@ -379,42 +379,42 @@ <h1 class="title">Website reCAPTCHA v2</h1>
<p><strong>Table of contents</strong></p>
<div class="contents local topic" id="contents">
<ul class="simple">
<li><a class="reference internal" href="#configuration" id="id1">Configuration</a></li>
<li><a class="reference internal" href="#bug-tracker" id="id2">Bug Tracker</a></li>
<li><a class="reference internal" href="#credits" id="id3">Credits</a><ul>
<li><a class="reference internal" href="#authors" id="id4">Authors</a></li>
<li><a class="reference internal" href="#contributors" id="id5">Contributors</a></li>
<li><a class="reference internal" href="#maintainers" id="id6">Maintainers</a></li>
<li><a class="reference internal" href="#configuration" id="toc-entry-1">Configuration</a></li>
<li><a class="reference internal" href="#bug-tracker" id="toc-entry-2">Bug Tracker</a></li>
<li><a class="reference internal" href="#credits" id="toc-entry-3">Credits</a><ul>
<li><a class="reference internal" href="#authors" id="toc-entry-4">Authors</a></li>
<li><a class="reference internal" href="#contributors" id="toc-entry-5">Contributors</a></li>
<li><a class="reference internal" href="#maintainers" id="toc-entry-6">Maintainers</a></li>
</ul>
</li>
</ul>
</div>
<div class="section" id="configuration">
<h1><a class="toc-backref" href="#id1">Configuration</a></h1>
<h1><a class="toc-backref" href="#toc-entry-1">Configuration</a></h1>
<p>reCAPTCHA is configured in Settings &gt; Website. It can be enabled or disabled
using the checkbox, and the site and secret keys can be defined there when it
is enabled.</p>
</div>
<div class="section" id="bug-tracker">
<h1><a class="toc-backref" href="#id2">Bug Tracker</a></h1>
<h1><a class="toc-backref" href="#toc-entry-2">Bug Tracker</a></h1>
<p>Bugs are tracked on <a class="reference external" href="https://github.com/OCA/website/issues">GitHub Issues</a>.
In case of trouble, please check there if your issue has already been reported.
If you spotted it first, help us to smash it by providing a detailed and welcomed
<a class="reference external" href="https://github.com/OCA/website/issues/new?body=module:%20website_recaptcha_v2%0Aversion:%2012.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**">feedback</a>.</p>
<a class="reference external" href="https://github.com/OCA/website/issues/new?body=module:%20website_recaptcha_v2%0Aversion:%2016.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**">feedback</a>.</p>
<p>Do not contact contributors directly about support or help with technical issues.</p>
</div>
<div class="section" id="credits">
<h1><a class="toc-backref" href="#id3">Credits</a></h1>
<h1><a class="toc-backref" href="#toc-entry-3">Credits</a></h1>
<div class="section" id="authors">
<h2><a class="toc-backref" href="#id4">Authors</a></h2>
<h2><a class="toc-backref" href="#toc-entry-4">Authors</a></h2>
<ul class="simple">
<li>Elico Corp</li>
<li>Tech Receptives</li>
<li>Coop IT Easy SC</li>
</ul>
</div>
<div class="section" id="contributors">
<h2><a class="toc-backref" href="#id5">Contributors</a></h2>
<h2><a class="toc-backref" href="#toc-entry-5">Contributors</a></h2>
<ul class="simple">
<li><a class="reference external" href="https://elico-corp.com">Elico Corp</a>:<ul>
<li>Augustin Cisterne-Kaas</li>
Expand All @@ -436,13 +436,13 @@ <h2><a class="toc-backref" href="#id5">Contributors</a></h2>
</ul>
</div>
<div class="section" id="maintainers">
<h2><a class="toc-backref" href="#id6">Maintainers</a></h2>
<h2><a class="toc-backref" href="#toc-entry-6">Maintainers</a></h2>
<p>This module is maintained by the OCA.</p>
<a class="reference external image-reference" href="https://odoo-community.org"><img alt="Odoo Community Association" src="https://odoo-community.org/logo.png" /></a>
<p>OCA, or the Odoo Community Association, is a nonprofit organization whose
mission is to support the collaborative development of Odoo features and
promote its widespread use.</p>
<p>This module is part of the <a class="reference external" href="https://github.com/OCA/website/tree/12.0/website_recaptcha_v2">OCA/website</a> project on GitHub.</p>
<p>This module is part of the <a class="reference external" href="https://github.com/OCA/website/tree/16.0/website_recaptcha_v2">OCA/website</a> project on GitHub.</p>
<p>You are welcome to contribute. To learn how please visit <a class="reference external" href="https://odoo-community.org/page/Contribute">https://odoo-community.org/page/Contribute</a>.</p>
</div>
</div>
Expand Down
9 changes: 2 additions & 7 deletions website_recaptcha_v2/tests/test_recaptcha.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,19 +24,14 @@ def setUpClass(cls):

@mock.patch(imp_requests)
def test_captcha_http_request(self, requests_mock):
requests_mock.post.side_effect = StopIteration
try:
self.website.is_recaptcha_v2_valid(
{"g-recaptcha-response": "dummy_response"}
)
except StopIteration:
pass
self.website.is_recaptcha_v2_valid({"g-recaptcha-response": "dummy_response"})
requests_mock.post.assert_called_once_with(
"https://www.recaptcha.net/recaptcha/api/siteverify",
data={
"secret": "test-secret",
"response": "dummy_response",
},
timeout=30,
)

@mock.patch(imp_requests)
Expand Down
101 changes: 53 additions & 48 deletions website_recaptcha_v2/views/res_config_settings_view.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,60 +16,65 @@ SPDX-License-Identifier: AGPL-3.0-or-later
<field name="model">res.config.settings</field>
<field name="inherit_id" ref="website.res_config_settings_view_form" />
<field name="arch" type="xml">
<div id="google_maps_setting" position="after">
<div class="col-12 col-lg-6 o_setting_box" id="recaptcha_v2_setting">
<div class="o_setting_left_pane">
<field name="recaptcha_v2_enabled" />
</div>
<div class="o_setting_right_pane">
<img
width="20px"
alt="reCAPTCHA icon"
class="mr-2"
src="website_recaptcha_v2/static/description/recaptcha_ico.png"
/>
<label string="reCAPTCHA v2" for="recaptcha_v2_enabled" />
<span
class="fa fa-lg fa-globe"
title="Values set here are website-specific."
groups="website.group_multi_website"
/>
<div class="text-muted">
Protect your forms using reCAPTCHA v2
<xpath expr="//div[@data-key='website']" position="inside">
<h2>reCAPTCHA v2</h2>
<div class="row o_settings_container mt16" id="recaptcha_v2">
<div
class="col-12 col-lg-6 o_setting_box"
id="recaptcha_v2_setting"
>
<div class="o_setting_left_pane">
<field name="recaptcha_v2_enabled" />
</div>
<div
class="content-group"
attrs="{'invisible': [('recaptcha_v2_enabled', '=', False)]}"
>
<div class="row mt16">
<label
for="recaptcha_v2_site_key"
class="col-md-4 o_light_label"
/>
<field name="recaptcha_v2_site_key" />
</div>
<div class="row">
<label
for="recaptcha_v2_secret_key"
class="col-md-4 o_light_label"
/>
<field name="recaptcha_v2_secret_key" />
<div class="o_setting_right_pane">
<img
width="20px"
alt="reCAPTCHA icon"
class="mr4"
src="website_recaptcha_v2/static/description/recaptcha_ico.png"
/>
<label string="reCAPTCHA v2" for="recaptcha_v2_enabled" />
<span
class="fa fa-lg fa-globe"
title="Values set here are website-specific."
groups="website.group_multi_website"
/>
<div class="text-muted">
Protect your forms using reCAPTCHA v2
</div>
<div class="mt8">
<a
role="button"
class="btn-link"
target="_blank"
href="https://www.google.com/recaptcha/admin"
>
<i class="fa fa-arrow-right" />
Get reCAPTCHA v2 keys
</a>
<div
class="content-group"
attrs="{'invisible': [('recaptcha_v2_enabled', '=', False)]}"
>
<div class="row mt16">
<label
for="recaptcha_v2_site_key"
class="col-4 o_light_label"
/>
<field name="recaptcha_v2_site_key" />
</div>
<div class="row">
<label
for="recaptcha_v2_secret_key"
class="col-4 o_light_label"
/>
<field name="recaptcha_v2_secret_key" />
</div>
<div>
<a
href="https://www.google.com/recaptcha/admin"
class="oe_link"
target="_blank"
>
<i class="fa fa-arrow-right" />
Get reCAPTCHA v2 keys
</a>
</div>
</div>
</div>
</div>
</div>
</div>
</xpath>
</field>
</record>

Expand Down

0 comments on commit 5e0108b

Please sign in to comment.