Return both slug and id of role + set explicit valid values

development.ini.old

@@ -0,0 +1,267 @@
+###
+# app configuration
+# https://docs.pylonsproject.org/projects/pyramid/en/latest/narr/environment.html
+###
+[pipeline:main]
+pipeline = tracim_web
+[app:tracim_web]
+use = egg:tracim_backend
+
+pyramid.reload_templates = true
+pyramid.debug_authorization = false
+pyramid.debug_notfound = false
+pyramid.debug_routematch = false
+pyramid.default_locale_name = en
+pyramid.includes =
+    pyramid_debugtoolbar
+
+[pipeline:webdav]
+pipeline = tracim_webdav
+[app:tracim_webdav]
+use = egg:tracim_backend#webdav
+
+[DEFAULT]
+sqlalchemy.url = sqlite:///%(here)s/tracim.sqlite
+
+retry.attempts = 3
+
+# By default, the toolbar only appears for clients from IP addresses
+# '127.0.0.1' and '::1'.
+# debugtoolbar.hosts = 127.0.0.1 ::1
+
+###
+# TRACIM SPECIFIC CONF
+###
+
+### Global
+
+cache_dir = %(here)s/data
+# preview generator cache directory
+preview_cache_dir = /tmp/tracim/preview/
+# file depot storage
+depot_storage_name = tracim
+depot_storage_dir = %(here)s/depot/
+
+# The following parameters allow to personalize the home page
+# They are html ready (you can put html tags they will be interpreted)
+website.title = TRACIM
+website.title.color = #555
+website.home.subtitle = Default login: email: admin@admin.admin (password: admin@admin.admin)
+website.home.tag_line = <div class="text-center" style="font-weight: bold;">Collaboration, versionning and traceability</div>
+website.home.below_login_form = in case of problem, please contact the administrator.
+# Values may be 'all' or 'folders'
+website.treeview.content = all
+# The following base_url is used for links and icons
+# integrated in the email notifcations
+website.base_url = http://127.0.0.1:8080
+# If config not provided, it will be extracted from website.base_url
+website.server_name = 127.0.0.1
+
+# Specifies if the update of comments and attached files is allowed (by the owner only).
+# Examples:
+#    600 means 10 minutes (ie 600 seconds)
+#   3600 means 1 hour (60x60 seconds)
+#
+# Allowed values:
+#  -1 means that content update is allowed for ever
+#   0 means that content update is not allowed
+#   x means that content update is allowed for x seconds (with x>0)
+content.update.allowed.duration = 3600
+
+# Auth type (internal or ldap)
+auth_type = internal
+# If auth_type is ldap, uncomment following ldap_* parameters
+# LDAP server address
+# ldap_url = ldap://localhost:389
+# Base dn to make queries
+# ldap_base_dn = dc=directory,dc=fsf,dc=org
+# Bind dn to identify the search
+# ldap_bind_dn = cn=admin,dc=directory,dc=fsf,dc=org
+# The bind password
+# ldap_bind_pass = toor
+# Attribute name of user record who contain user login (email)
+# ldap_ldap_naming_attribute = uid
+# Matching between ldap attribute and ldap user field (ldap_attr1=user_field1,ldap_attr2=user_field2,...)
+# ldap_user_attributes = mail=email
+# TLS usage to communicate with your LDAP server
+# ldap_tls = False
+# If True, LDAP own tracim group managment (not available for now!)
+# ldap_group_enabled = False
+# User auth token validity in seconds (used to interfaces like web calendars)
+user.auth_token.validity = 604800
+
+### Mail
+
+# Reset password through email related configuration.
+# These emails will be sent through SMTP
+#
+resetpassword.email_sender = email@sender.com
+resetpassword.smtp_host = smtp.sender
+resetpassword.smtp_port = 25
+resetpassword.smtp_login = smtp.login
+resetpassword.smtp_passwd = smtp.password
+
+email.notification.activated = False
+# email.notification.log_file_path = /tmp/mail-notifications.log
+# email notifications can be sent with the user_id added as an identifier
+# this way email clients like Thunderbird will be able to distinguish
+# notifications generated by a user or another one
+email.notification.from.email = noreply+{user_id}@trac.im
+email.notification.from.default_label = Tracim Notifications
+email.notification.reply_to.email = reply+{content_id}@trac.im
+email.notification.references.email = thread+{content_id}@trac.im
+email.notification.content_update.template.html = %(here)s/tracim/templates/mail/content_update_body_html.mak
+email.notification.content_update.template.text = %(here)s/tracim/templates/mail/content_update_body_text.mak
+email.notification.created_account.template.html = %(here)s/tracim/templates/mail/created_account_body_html.mak
+email.notification.created_account.template.text = %(here)s/tracim/templates/mail/created_account_body_text.mak
+# Note: items between { and } are variable names. Do not remove / rename them
+email.notification.content_update.subject = [{website_title}] [{workspace_label}] {content_label} ({content_status_label})
+email.notification.created_account.subject = [{website_title}] Created account
+# processing_mode may be sync or async
+email.notification.processing_mode = sync
+email.notification.smtp.server = your_smtp_server
+email.notification.smtp.port = 25
+email.notification.smtp.user = your_smtp_user
+email.notification.smtp.password = your_smtp_password
+
+## Email sending configuration
+# processing_mode may be sync or async,
+# with async, please configure redis below
+email.processing_mode = sync
+# email.async.redis.host = localhost
+# email.async.redis.port = 6379
+# email.async.redis.db = 0
+
+# Email reply configuration
+email.reply.activated = False
+email.reply.imap.server = your_imap_server
+email.reply.imap.port = 993
+email.reply.imap.user = your_imap_user
+email.reply.imap.password = your_imap_password
+email.reply.imap.folder = INBOX
+email.reply.imap.use_ssl = true
+email.reply.imap.use_idle = true
+# Re-new connection each 10 minutes
+email.reply.connection.max_lifetime = 600
+# Token for communication between mail fetcher and tracim controller
+email.reply.token = mysecuretoken
+# Delay in seconds between each check
+email.reply.check.heartbeat = 60
+email.reply.use_html_parsing = true
+email.reply.use_txt_parsing = true
+# Lockfile path is required for email_reply feature,
+# it's just an empty file use to prevent concurrent access to imap unseen mail
+email.reply.lockfile_path = %(here)s/email_fetcher.lock
+
+### Radical (CalDav server) configuration
+
+# radicale.server.host = 0.0.0.0
+# radicale.server.port = 5232
+# radicale.server.ssl = false
+radicale.server.filesystem.folder = %(here)s/radicale/collections/
+# radicale.server.allow_origin = *
+# radicale.server.realm_message = Tracim Calendar - Password Required
+## url can be extended like http://127.0.0.1:5232/calendar
+## in this case, you have to create your own proxy behind this url.
+## and update following parameters
+# radicale.client.base_url.host = http://127.0.0.1:5232
+# radicale.client.base_url.prefix = /
+
+### WSGIDAV
+
+wsgidav.config_path = %(here)s/wsgidav.conf
+## url can be extended like 127.0.0.1/webdav
+## in this case, you have to create your own proxy behind this url.
+## Do not set http:// prefix.
+# wsgidav.client.base_url = 127.0.0.1:<WSGIDAV_PORT>
+
+###
+# wsgi server configuration
+###
+
+[server:main]
+use = egg:waitress#main
+listen = localhost:6543
+
+[alembic]
+# path to migration scripts
+script_location = tracim/migration
+
+# template used to generate migration files
+# file_template = %%(rev)s_%%(slug)s
+
+# timezone to use when rendering the date
+# within the migration file as well as the filename.
+# string value is passed to dateutil.tz.gettz()
+# leave blank for localtime
+# timezone =
+
+# max length of characters to apply to the
+# "slug" field
+#truncate_slug_length = 40
+
+# set to 'true' to run the environment during
+# the 'revision' command, regardless of autogenerate
+# revision_environment = false
+
+# set to 'true' to allow .pyc and .pyo files without
+# a source .py file to be detected as revisions in the
+# versions/ directory
+# sourceless = false
+
+# version location specification; this defaults
+# to migrate/versions.  When using multiple version
+# directories, initial revisions must be specified with --version-path
+# version_locations = %(here)s/bar %(here)s/bat migrate/versions
+
+# the output encoding used when revision files
+# are written from script.py.mako
+# output_encoding = utf-8
+
+sqlalchemy.url = sqlite:///%(here)s/tracim.sqlite
+
+###
+# logging configuration
+# https://docs.pylonsproject.org/projects/pyramid/en/latest/narr/logging.html
+###
+
+[loggers]
+keys = root, tracim, sqlalchemy, alembic
+
+[handlers]
+keys = console
+
+[formatters]
+keys = generic
+
+[logger_root]
+level = INFO
+handlers = console
+
+[logger_tracim]
+level = DEBUG
+handlers =
+qualname = tracim
+
+[logger_sqlalchemy]
+level = INFO
+handlers =
+qualname = sqlalchemy.engine
+# "level = INFO" logs SQL queries.
+# "level = DEBUG" logs SQL queries and results.
+# "level = WARN" logs neither.  (Recommended for production systems.)
+
+[logger_alembic]
+level = INFO
+handlers =
+qualname = alembic
+
+[handler_console]
+class = StreamHandler
+args = (sys.stderr,)
+level = NOTSET
+formatter = generic
+
+[formatter_generic]
+format = %(asctime)s %(levelname)-5.5s [%(name)s:%(lineno)s][%(threadName)s] %(message)s
+datefmt = %H:%M:%S

tracim/models/context_models.py

@@ -171,7 +171,14 @@ class UserRoleWorkspaceInContext(object):
     # TODO - G.M - 23-05-2018 - Check the API spec for this this !
 
     @property
-    def slug(self) -> str:
+    def role_id(self) -> int:
+        """
+        role as int id, each value refer to a different role.
+        """
+        return self.user_role.role
+
+    @property
+    def role_slug(self) -> str:
         """
         simple name of the role of the user.
         can be anything from UserRoleInWorkspace SLUG, like

tracim/models/data.py

@@ -137,6 +137,7 @@ class UserRoleInWorkspace(DeclarativeBase):
     SLUG[CONTRIBUTOR] = 'contributor'
     SLUG[CONTENT_MANAGER] = 'content_manager'
     SLUG[WORKSPACE_MANAGER] = 'workspace_manager'
+
     # LABEL = dict()
     # LABEL[0] = l_('N/A')
     # LABEL[1] = l_('Reader')
@@ -171,7 +172,10 @@ class UserRoleInWorkspace(DeclarativeBase):
     #     return UserRoleInWorkspace.LABEL[self.role]
 
     @classmethod
-    def get_all_role_values(self):
+    def get_all_role_values(cls) -> typing.List[int]:
+        """
+        Return all valid role value
+        """
         return [
             UserRoleInWorkspace.READER,
             UserRoleInWorkspace.CONTRIBUTOR,
@@ -179,6 +183,16 @@ class UserRoleInWorkspace(DeclarativeBase):
             UserRoleInWorkspace.WORKSPACE_MANAGER
         ]
 
+    @classmethod
+    def get_all_role_slug(cls) -> typing.List[str]:
+        """
+        Return all valid role slug
+        """
+        # INFO - G.M - 25-05-2018 - Be carefull, as long as this method
+        # and get_all_role_values are both used for API, this method should
+        # return item in the same order as get_all_role_values
+        return [cls.SLUG[value] for value in cls.get_all_role_values()]
+
 
 class RoleType(object):
     def __init__(self, role_id):

tracim/tests/functional/test_workspaces.py

@@ -155,7 +155,8 @@ class TestWorkspaceMembersEndpoint(FunctionalTest):
         res = self.testapp.get('/api/v2/workspaces/1/members', status=200).json_body   # nopep8
         assert len(res) == 2
         user_role = res[0]
-        assert user_role['slug'] == 'workspace_manager'
+        assert user_role['role_slug'] == 'workspace_manager'
+        assert user_role['role_id'] == 8
         assert user_role['user_id'] == 1
         assert user_role['workspace_id'] == 1
         assert user_role['user']['display_name'] == 'Global manager'

tracim/views/core_api/schemas.py

@@ -1,8 +1,10 @@
 # coding=utf-8
 import marshmallow
 from marshmallow import post_load
+from marshmallow.validate import OneOf
 
 from tracim.models.context_models import LoginCredentials
+from tracim.models.data import UserRoleInWorkspace
 
 
 class ProfileSchema(marshmallow.Schema):
@@ -87,7 +89,8 @@ class WorkspaceDigestSchema(marshmallow.Schema):
 
 
 class WorkspaceMemberSchema(marshmallow.Schema):
-    slug = marshmallow.fields.String()
+    role_id = marshmallow.fields.Int(validate=OneOf(UserRoleInWorkspace.get_all_role_values()))  # nopep8
+    role_slug = marshmallow.fields.String(validate=OneOf(UserRoleInWorkspace.get_all_role_slug()))  # nopep8
     user_id = marshmallow.fields.Int()
     workspace_id = marshmallow.fields.Int()
     user = marshmallow.fields.Nested(