Merge pull request #38 from dcastrowa/addNewProperties

Add new properties

Author: mattmanley

maproulette/models/challenge.py

@@ -116,6 +116,24 @@ def default_priority(self):
     def default_priority(self, value):
         self._default_priority = value
 
+    @property
+    def high_priority_rule(self):
+        """The high priority for this challenge"""
+        return self._high_priority_rule
+
+    @high_priority_rule.setter
+    def high_priority_rule(self, value):
+        self._high_priority_rule = value
+
+    @property
+    def low_priority_rule(self):
+        """The low priority of this challenge"""
+        return self._low_priority_rule
+
+    @low_priority_rule.setter
+    def low_priority_rule(self, value):
+        self._low_priority_rule = value
+
     @property
     def default_zoom(self):
         """The default zoom level for this challenge"""
@@ -143,9 +161,139 @@ def max_zoom(self):
     def max_zoom(self, value):
         self._max_zoom = value
 
+    @property
+    def osm_id_property(self):
+        """The id property of an osm feature"""
+        return self._osm_id_property
+
+    @osm_id_property.setter
+    def osm_id_property(self, value):
+        self._osm_id_property = value
+
+    @property
+    def cooperative_type(self):
+        """"""
+        return self._cooperative_type
+
+    @cooperative_type.setter
+    def cooperative_type(self, value):
+        self._cooperative_type = value
+
+    @property
+    def popularity(self):
+        """The popularity of a challenge"""
+        return self._popularity
+
+    @popularity.setter
+    def popularity(self, value):
+        self._popularity = value
+
+    @property
+    def check_in_comment(self):
+        """Comment to be associated with changes made by users"""
+        return self._check_in_comment
+
+    @check_in_comment.setter
+    def check_in_comment(self, value):
+        self._check_in_comment = value
+
+    @property
+    def check_in_source(self):
+        """Hashtag appended to changeset comments"""
+        return self._check_in_source
+
+    @check_in_source.setter
+    def check_in_source(self, value):
+        self._check_in_source = value
+
+    @property
+    def requires_local(self):
+        """Whether or not tasks require local knowledge to complete"""
+        return self._requires_local
+
+    @requires_local.setter
+    def requires_local(self, value):
+        self._requires_local = value
+
+    @property
+    def default_basemap(self):
+        """The default basemap to use for this challenge"""
+        return self._default_basemap
+
+    @default_basemap.setter
+    def default_basemap(self, value):
+        self._default_basemap = value
+
+    @property
+    def default_basemap_id(self):
+        """The id of the default basemap"""
+        return self._default_basemap_id
+
+    @default_basemap_id.setter
+    def default_basemap_id(self, value):
+        self._default_basemap_id = value
+
+    @property
+    def custom_basemap(self):
+        """The custom basemap of this challenge"""
+        return self._custom_basemap
+
+    @custom_basemap.setter
+    def custom_basemap(self, value):
+        self._custom_basemap = value
+
+    @property
+    def update_tasks(self):
+        """Whether or not to periodically delete old tasks"""
+        return self._update_tasks
+
+    @update_tasks.setter
+    def update_tasks(self, value):
+        self._update_tasks = value
+
+    @property
+    def exportable_properties(self):
+        """Comma separated list of properties to be exportable"""
+        return self._exportable_properties
+
+    @exportable_properties.setter
+    def exportable_properties(self, value):
+        self._exportable_properties = value
+
+    @property
+    def preferred_tags(self):
+        """List of preferred tags the user can use when completing tasks"""
+        return self._preferred_tags
+
+    @preferred_tags.setter
+    def preferred_tags(self, value):
+        self._preferred_tags = value
+
+    @property
+    def task_styles(self):
+        """Custom task styling based on specific task feature properties"""
+        return self._task_styles
+
+    @task_styles.setter
+    def task_styles(self, value):
+        self._task_styles = value
+
+    @property
+    def remote_geojson(self):
+        """Create a challenge from a GeoJSON URL"""
+        return self._remote_geojson
+
+    @remote_geojson.setter
+    def remote_geojson(self, value):
+        self._remote_geojson = value
+
     def __init__(self, name, id=None, description=None, parent=None, instruction=None, difficulty=None, blurb=None,
-                 enabled=None, challenge_type=None, featured=None, overpassQL=None, default_priority=None, default_zoom=None,
-                 min_zoom=None, max_zoom=None):
+                 enabled=None, challenge_type=None, featured=None, overpassQL=None, default_priority=None,
+                 high_priority_rule=None, low_priority_rule=None, default_zoom=None, min_zoom=None, max_zoom=None,
+                 osm_id_property=None, cooperative_type=None, popularity=None, check_in_comment=None,
+                 check_in_source=None, requires_local=None, default_basemap=None, default_basemap_id=None,
+                 custom_basemap=None, update_tasks=None, exportable_properties=None, preferred_tags=None,
+                 task_styles=None, remote_geojson=None):
         self._id = id
         self._name = name
         self._description = description
@@ -158,16 +306,33 @@ def __init__(self, name, id=None, description=None, parent=None, instruction=Non
         self._featured = featured
         self._overpassQL = overpassQL
         self._default_priority = default_priority
+        self._high_priority_rule = high_priority_rule
+        self._low_priority_rule = low_priority_rule
         self._default_zoom = default_zoom
         self._min_zoom = min_zoom
         self._max_zoom = max_zoom
+        self._osm_id_property = osm_id_property
+        self._cooperative_type = cooperative_type
+        self._popularity = popularity
+        self._check_in_comment = check_in_comment
+        self._check_in_source = check_in_source
+        self._requires_local = requires_local
+        self._default_basemap = default_basemap
+        self._default_basemap_id = default_basemap_id
+        self._custom_basemap = custom_basemap
+        self._update_tasks = update_tasks
+        self._exportable_properties = exportable_properties
+        self._preferred_tags = preferred_tags
+        self._task_styles = task_styles
+        self._remote_geojson = remote_geojson
 
     def to_dict(self):
         """Converts all non-null properties of a challenge object into a dictionary"""
         properties = {
             "id": self._id,
             "name": self._name,
             "description": self._description,
+            "deleted": self.description,
             "parent": self._parent,
             "instruction": self._instruction,
             "difficulty": self._difficulty,
@@ -177,9 +342,25 @@ def to_dict(self):
             "featured": self._featured,
             "overpassQL": self._overpassQL,
             "defaultPriority": self._default_priority,
+            "highPriorityRule": self._high_priority_rule,
+            "lowPriorityRule": self._low_priority_rule,
             "defaultZoom": self._default_zoom,
             "minZoom": self._min_zoom,
-            "maxZoom": self._max_zoom
+            "maxZoom": self._max_zoom,
+            "osmIdProperty": self._osm_id_property,
+            "cooperativeType": self._cooperative_type,
+            "popularity": self._popularity,
+            "checkInComment": self._check_in_comment,
+            "checkInSource": self._check_in_source,
+            "requiresLocal": self._requires_local,
+            "defaultBasemap": self._default_basemap,
+            "defautlBasemapId": self._default_basemap_id,
+            "customBasemap": self._custom_basemap,
+            "updateTasks": self._update_tasks,
+            "exportableProperties": self._exportable_properties,
+            "preferredTags": self._preferred_tags,
+            "taskStyles": self._task_styles,
+            "remoteGeoJson": self.remote_geojson
         }
         return {k: v for (k, v) in properties.items() if v is not None}
 

maproulette/models/project.py

@@ -66,20 +66,31 @@ def display_name(self, value):
 
     @property
     def is_virtual(self):
-        """Whether or not this project is virtual"""
+        """Whether or not a project is virtual"""
         return self._is_virtual
 
     @is_virtual.setter
     def is_virtual(self, value):
         self._is_virtual = value
 
-    def __init__(self, name, id=None, description=None, groups=None, enabled=None, display_name=None, is_virtual=None):
+    @property
+    def featured(self):
+        """Whether or not the project is featured"""
+        return self._featured
+
+    @featured.setter
+    def featured(self, value):
+        self._featured = value
+
+    def __init__(self, name, id=None, description=None, groups=None, enabled=None,
+                 is_virtual=None, display_name=None, featured=None):
         self._id = id
         self._name = name
         self._description = description
         self._groups = groups
         self._enabled = enabled
         self._display_name = display_name
+        self._featured = featured
         self._is_virtual = is_virtual
 
     def to_dict(self):
@@ -91,7 +102,8 @@ def to_dict(self):
             "groups": self._groups,
             "enabled": self._enabled,
             "display_name": self._display_name,
-            "is_virtual": self._is_virtual
+            "featured": self._featured,
+            "isVirtual": self._is_virtual
         }
         return {k: v for (k, v) in properties.items() if v is not None}
 

maproulette/models/task.py

@@ -153,9 +153,19 @@ def mapillary_images(self):
     def mapillary_images(self, value):
         self._mapillary_images = value
 
+    @property
+    def cooperative_work(self):
+        """A tag that is or will be used for a new type of task resolution"""
+        return self._cooperative_work
+
+    @cooperative_work.setter
+    def cooperative_work(self, value):
+        self._cooperative_work = value
+
     def __init__(self, name, parent, geometries, id=None, instruction=None, location=None, suggested_fix=None,
-                 status=None, mapped_on=None, review=None, priority=None, changeset_id=None, completion_responses=None,
-                 bundle_id=None, is_bundle_primary=None, mapillary_images=None):
+                 status=None, mapped_on=None, review=None, priority=None, changeset_id=None,
+                 completion_responses=None, bundle_id=None, is_bundle_primary=None, mapillary_images=None,
+                 cooperative_work=None):
         self._id = id
         self._name = name
         self._parent = parent
@@ -172,6 +182,7 @@ def __init__(self, name, parent, geometries, id=None, instruction=None, location
         self._bundle_id = bundle_id
         self._is_bundle_primary = is_bundle_primary
         self._mapillary_images = mapillary_images
+        self._cooperative_work = cooperative_work
 
     def to_dict(self):
         """Converts all non-null properties of a task object into a dictionary"""
@@ -190,7 +201,8 @@ def to_dict(self):
             "completionResponses": self._completion_responses,
             "bundleId": self._bundle_id,
             "isBundlePrimary": self._is_bundle_primary,
-            "mapillaryImages": self._mapillary_images
+            "mapillaryImages": self._mapillary_images,
+            "cooperativeWork": self._cooperative_work
         }
         return {k: v for (k, v) in properties.items() if v is not None}
 

tests/test_project_api.py

@@ -48,8 +48,7 @@ def test_create_project(self, mock_request, api_instance=api):
     @patch('maproulette.api.maproulette_server.requests.Session.post')
     def test_add_challenge_to_project(self, mock_request, api_instance=api):
         test_virtual_project_model = maproulette.ProjectModel(name='Test Virtual Project Name',
-                                                              id=1234,
-                                                              is_virtual=True)
+                                                              id=1234)
         test_challenge_model = maproulette.ChallengeModel(name='Test Challenge Name',
                                                           id=246)
         test_virtual_project_id = test_virtual_project_model.id
@@ -61,8 +60,7 @@ def test_add_challenge_to_project(self, mock_request, api_instance=api):
     @patch('maproulette.api.maproulette_server.requests.Session.post')
     def test_remove_challenge_from_project(self, mock_request, api_instance=api):
         test_virtual_project_model = maproulette.ProjectModel(name='Test Virtual Project Name',
-                                                              id=1234,
-                                                              is_virtual=True)
+                                                              id=1234)
         test_challenge_model = maproulette.ChallengeModel(name='Test Challenge Name', id=246)
         test_virtual_project_id = test_virtual_project_model.id
         test_challenge_id = test_challenge_model.id