Issue #7036 - [XTM Integration] Add support for providing workflow name

cms/translations/xtm/xtm_api.py

 # This file is part of the Adblock Plus web scripts,
 # Copyright (C) 2006-present eyeo GmbH
 #
 # Adblock Plus is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License version 3 as
 # published by the Free Software Foundation.
 #
 # Adblock Plus is distributed in the hope that it will be useful,
 # but WITHOUT ANY WARRANTY; without even the implied warranty of
 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
@@ skipping 43 matching lines @@
 class XTMCloudAPI(object):
 
     _AUTHORIZATION_TMP = 'XTM-Basic {0}'
 
     class _UrlPaths:
         CREATE = 'projects'
         DOWNLOAD = 'projects/{0}/files/download'
         UPLOAD = 'projects/{0}/files/upload'
         GET_TARGET_LANG = 'projects/{0}/metrics'
         ADD_TARGET_LANG = 'projects/{0}/target-languages'
+        GET_WORKFLOW_IDS = 'workflows'
 
     _MATCH_TYPE = {
         False: 'NO_MATCH',
         True: 'MATCH_NAMES',
     }
 
     class _SuccessCodes:
         CREATE = 201
         UPLOAD = 200
         DOWNLOAD = 200
         GET_TARGET_LANGS = 200
         ADD_TARGET_LANGS = 200
+        GET_WORKFLOW_IDS = 200
 
     def __init__(self, token):
         """Constructor.
 
         Parameters
         ----------
         token: str
             Token used to authenticate with the API.
 
         """
@@ skipping 295 matching lines @@
             project_id,
         )
         headers = {'content-type': 'application/json'}
 
         response = self._execute(url, data=data, headers=headers)
 
         if response.status_code != self._SuccessCodes.ADD_TARGET_LANGS:
             raise XTMCloudException(response.status_code, response.content,
                                     'adding target languages to project')
 
+    def get_workflows_by_name(self, name, exact=True):
+        """Get workflows with a specific name.
+
+        Parameters
+        ----------
+        name: str
+            The name of the workflow we're looking for.
+        exact: bool

[Vasily Kuznetsov, 2018/10/16 14:52:54]

Do we actually use this?

[Tudor Avram, 2018/10/18 16:29:23]

No, we don't. We're only interested in exact matches, anyway.

+            Whether we're looking for exact matches only or if partial ones
+            are ok, too. Default True.
+
+        Returns
+        -------
+        iterable
+            Of workflow ids that match the name.
+
+        """
+        url = self.base_url + self._UrlPaths.GET_WORKFLOW_IDS
+
+        response = self._execute(url, params={'name': name})
+
+        if response.status_code != self._SuccessCodes.GET_WORKFLOW_IDS:
+            raise XTMCloudException(response.status_code, response.content,
+                                    'extracting workflow ids')
+
+        if not exact:
+            return [item['id']
+                    for item in json.loads(response.content.encode('utf-8'))]
+
+        valid_ids = []
+        for item in json.loads(response.content.encode('utf-8')):
+            if name.lower().replace(' ', '') == \
+                    item['name'].lower().replace(' ', ''):
+                valid_ids.append(item['id'])
+        return valid_ids
+
 
 def get_token(username, password, user_id):
     """Generate an API token from username and password.
 
     Parameters
     ----------
     username: str
         The username used to generate the token.
     password: str
         The password used to generate the token.
@@ skipping 22 matching lines @@
     headers = {'content-type': 'application/json'}
 
     response = requests.post(url, data=request_body, headers=headers)
 
     if response.status_code == 200:
         return json.loads(response.text)['token'].encode()
 
     raise XTMCloudException(response.status_code,
                             response.text.encode('utf-8'),
                             'generating token')