Add an HTTP endpoint and an always true token

Author: lasley

base_web_hook/controllers/main.py

@@ -8,11 +8,22 @@
 class WebHookController(http.Controller):
 
     @http.route(
-        ['/base_web_hook/<string:slug>'],
+        ['/base_web_hook/json/<string:slug>.json'],
         type='json',
         auth='none',
     )
-    def receive(self, slug, **kwargs):
+    def json_receive(self, *args, **kwargs):
+        return self._receive(*args, **kwargs)
+
+    @http.route(
+        ['/base_web_hook/<string:slug>'],
+        type='http',
+        auth='none',
+    )
+    def http_receive(self, *args, **kwargs):
+        return self._receive(*args, **kwargs)
+
+    def _receive(self, slug, **kwargs):
         hook = self.env['web.hook'].search_by_slug(slug)
         return hook.receive(
             data=kwargs,

base_web_hook/models/__init__.py

@@ -1,9 +1,19 @@
 # -*- coding: utf-8 -*-
 # License LGPL-3.0 or later (http://www.gnu.org/licenses/lgpl).
 
+# Concrete models
 from . import web_hook
-from . import web_hook_adapter
 from . import web_hook_token
+
+# Adapters
+from . import web_hook_adapter
 from . import web_hook_token_adapter
+
+# Token Interfaces
+from . import web_hook_token_none
 from . import web_hook_token_plain
 from . import web_hook_token_user
+
+# Request Bin Hook
+from . import web_hook_request_bin
+from . import web_hook_request_bin_request

base_web_hook/models/web_hook.py

@@ -37,14 +37,31 @@ class WebHook(models.Model):
         selection='_get_interface_types',
         required=True,
     )
-    uri_path = fields.Char(
-        help='This is the URI path that is used to call the web hook.',
+    uri_path_json = fields.Char(
+        help='This is the URI path that is used to call the web hook with '
+             'a JSON request.',
         compute='_compute_uri_path',
         store=True,
         readonly=True,
     )
-    uri = fields.Char(
-        help='This is the URI that is used to call the web hook externally.',
+    uri_path_http = fields.Char(
+        help='This is the URI path that is used to call the web hook with '
+             'a form encoded request.',
+        compute='_compute_uri_path',
+        store=True,
+        readonly=True,
+    )
+    uri_json = fields.Char(
+        string='JSON Endpoint',
+        help='This is the URI that is used to call the web hook externally. '
+             'This endpoint only accepts requests with a JSON mime-type.',
+        compute='_compute_uri',
+    )
+    uri_http = fields.Char(
+        string='Form-Encoded Endpoint',
+        help='This is the URI that is used to call the web hook externally. '
+             'This endpoint should be used with requests that are form '
+             'encoded, not JSON.',
         compute='_compute_uri',
     )
     token_id = fields.Many2one(
@@ -85,14 +102,18 @@ def _compute_uri_path(self):
                 # Do not compute slug until saved
                 continue
             name = slugify(record.name or '').strip().strip('-')
-            record.uri_path = '/base_web_hook/%s-%d' % (name, record.id)
+            record.uri_path_json = '/base_web_hook/%s-%d.json' % (
+                name, record.id,
+            )
+            record.uri_path_http = '/base_web_hook/%s-%d' % (name, record.id)
 
     @api.multi
-    @api.depends('uri_path')
+    @api.depends('uri_path_http', 'uri_path_json')
     def _compute_uri(self):
         base_uri = self.env['ir.config_parameter'].get_param('web.base.url')
         for record in self.filtered(lambda r: r.uri_path):
-            record.uri = '%s%s' % (base_uri, record.uri_path)
+            record.uri_json = '%s%s' % (base_uri, record.uri_path_json)
+            record.uri_http = '%s%s' % (base_uri, record.uri_path_http)
 
     @api.model
     def _get_token_types(self):

base_web_hook/models/web_hook_token_none.py

@@ -0,0 +1,19 @@
+# -*- coding: utf-8 -*-
+# Copyright 2017 LasLabs Inc.
+# License LGPL-3.0 or later (http://www.gnu.org/licenses/lgpl).
+
+from odoo import api, models
+
+
+class WebHookTokenNone(models.Model):
+    """This is a token that will validate under all circumstances."""
+
+    _name = 'web.hook.token.none'
+    _inherit = 'web.hook.token.adapter'
+    _description = 'Web Hook Token - None'
+
+    @api.multi
+    def validate(self, token_string, *_, **__):
+        """Return ``True`` if the received token is the same as configured.
+        """
+        return True

base_web_hook/views/web_hook_view.xml

@@ -19,7 +19,8 @@
                         <field name="token_type" />
                         <field name="token_secret" />
                         <field name="company_id" />
-                        <field name="uri" />
+                        <field name="uri_http" />
+                        <field name="uri_json" />
                     </group>
                 </sheet>
 
@@ -34,7 +35,8 @@
             <tree string="Web Hooks">
                 <field name="name" />
                 <field name="interface_type" />
-                <field name="uri" />
+                <field name="uri_http" />
+                <field name="uri_json" />
             </tree>
         </field>
     </record>