Merge pull request #257 from seequent/feat/web_extras

New extras file for Web properties

Author: fwkoch

docs/content/extras.rst

@@ -10,6 +10,8 @@ importing :code:`properties.extras`.
   unique IDs and :code:`Pointer` property to refer to instances by
   unique ID.
 
+* :ref:`web` - Web-related Property classes
+
 * :ref:`singleton` - HasProperties class that creates only one instance
   for a given identifying name. Any instances with that name will
   be the same instance.
@@ -22,5 +24,6 @@ importing :code:`properties.extras`.
     :hidden:
 
     ./uid
+    ./web
     ./singleton
     ./task

docs/content/web.rst

@@ -0,0 +1,6 @@
+.. _web:
+
+Web-Related Extras
+==================
+
+.. autoclass:: properties.extras.URL

properties/extras/__init__.py

@@ -19,3 +19,4 @@
     TaskStatus,
 )
 from .uid import HasUID, Pointer
+from .web import URL

properties/extras/web.py

@@ -0,0 +1,64 @@
+"""Property classes for web-related concepts"""
+from six.moves.urllib.parse import ParseResult, urlparse                       #pylint: disable=import-error
+
+from .. import basic
+
+class URL(basic.String):
+    """String property that only accepts valid URLs
+
+    This property type uses :code:`urllib.parse` to validate
+    input URLs and possibly remove fragments and query params.
+
+    **Available keywords** (in addition to those inherited from
+    :class:`String <properties.String>`):
+
+    * **remove_parameters** - Query params are stripped from input URL (default
+      is False).
+    * **remove_fragment** - Fragment is stripped from input URL (default
+      is False).
+    """
+
+    class_info = 'a URL'
+
+    @property
+    def remove_parameters(self):
+        """Should path and query parameters be stripped"""
+        return getattr(self, '_remove_parameters', False)
+
+    @remove_parameters.setter
+    def remove_parameters(self, value):
+        self._remove_parameters = bool(value)
+
+    @property
+    def remove_fragment(self):
+        """Should fragment be stripped"""
+        return getattr(self, '_remove_fragment', False)
+
+    @remove_fragment.setter
+    def remove_fragment(self, value):
+        self._remove_fragment = bool(value)
+
+    def validate(self, instance, value):
+        """Check if input is valid URL"""
+        value = super(URL, self).validate(instance, value)
+        parsed_url = urlparse(value)
+        if not parsed_url.scheme or not parsed_url.netloc:
+            self.error(instance, value)
+        parse_result = ParseResult(
+            scheme=parsed_url.scheme,
+            netloc=parsed_url.netloc,
+            path=parsed_url.path,
+            params='' if self.remove_parameters else parsed_url.params,
+            query='' if self.remove_parameters else parsed_url.query,
+            fragment='' if self.remove_fragment else parsed_url.fragment,
+        )
+        parse_result = parse_result.geturl()
+        return parse_result
+
+    @property
+    def info(self):
+        info = 'a URL string'
+        if self.remove_parameters:
+            info += ', path or query params removed'
+        if self.remove_fragment:
+            info += ', fragment removed'

tests/test_web.py

@@ -0,0 +1,67 @@
+from __future__ import absolute_import
+from __future__ import division
+from __future__ import print_function
+from __future__ import unicode_literals
+
+import unittest
+
+import properties
+from properties.extras import URL
+
+BASE = 'https://someurl.com'
+PATH = '/my/path'
+QUERY = '?one=1&two=2'
+PARAM = ';/three;four=4'
+FRAGMENT = '#fragment'
+
+class TestURL(unittest.TestCase):
+
+    def test_anyurl(self):
+
+        class HasURL(properties.HasProperties):
+            url = URL('any url')
+
+        hurl = HasURL()
+        hurl.url = BASE
+        assert hurl.url == BASE
+
+        full_url = BASE + PATH + QUERY + PARAM + FRAGMENT
+        hurl = HasURL()
+        hurl.url = full_url
+        assert hurl.url == full_url
+
+    def test_no_params(self):
+
+        class HasURL(properties.HasProperties):
+            url = URL('any url', remove_parameters=True)
+
+        full_url = BASE + PATH + QUERY + PARAM + FRAGMENT
+        expected_url = BASE + PATH + FRAGMENT
+        hurl = HasURL()
+        hurl.url = full_url
+        assert hurl.url == expected_url
+
+    def test_no_fragment(self):
+
+        class HasURL(properties.HasProperties):
+            url = URL('any url', remove_fragment=True)
+
+        full_url = BASE + PATH + QUERY + PARAM + FRAGMENT
+        expected_url = BASE + PATH + QUERY + PARAM
+        hurl = HasURL()
+        hurl.url = full_url
+        assert hurl.url == expected_url
+
+    def test_bad_urls(self):
+
+        class HasURL(properties.HasProperties):
+            url = URL('any url')
+
+        hurl = HasURL()
+        for item in (PATH, QUERY, PARAM, FRAGMENT, 'someurl.com', 'https://'):
+            with self.assertRaises(properties.ValidationError):
+                hurl.url = item
+
+
+if __name__ == '__main__':
+    unittest.main()