Merge pull request #50 from filestack/feature/FS-7434-upload-tags

FS-7434 upload tags

Author: bkwi

docs/requirements.txt

@@ -1,4 +1,4 @@
 Sphinx==2.1.2
 sphinx-rtd-theme==0.4.3
-trafaret==1.2.0
-requests==2.22.0
+trafaret==2.0.2
+requests==2.23.0

docs/source/uploading_files.rst

@@ -79,15 +79,20 @@ Each upload function shown above takes a :data:`store_params` argument which is
         'region': 'string',
         'access': 'string',
         'base64decode': True|False,
-        'workflows': ['workflow-id-1', 'workflow-id-2']
+        'workflows': ['workflow-id-1', 'workflow-id-2'],
+        'upload_tags': {
+            'key': 'value',
+            'key2': 'value'
+        }
     }
 
 * **filename** - name for the stored file
-* **location** - name for the stored file
+* **location** - storage provider to be used
 * **path** - the path to store the file within the specified container
 * **container** - the bucket or container (folder) in which to store the file (does not apply when storing to Dropbox)
 * **mimetype** - mime type that should be stored in file's metadata
 * **region** - storage region (applies to S3 only)
 * **access** - should the file be stored as :data:`"public"` or :data:`"private"` (applies to S3 only)
 * **base64decode** - indicates if content should be decoded before it is stored
 * **workflows** - IDs of `Filestack Workflows <https://www.filestack.com/products/workflows>`_ that should be triggered after upload
+* **upload_tags** - set of :data:`key: value` pairs that will be returned with webhook for particular upload

filestack/models/security.py

@@ -35,6 +35,6 @@ def as_url_string(self):
         Returns the security part of signed urls
 
         Returns:
-            str: url part in the form of :data:`security=p:\<encoded policy>,s:\<signature>`
+            str: url part in the form of :data:`security=p:\\<encoded policy>,s:\\<signature>`
         """
         return 'security=p:{},s:{}'.format(self.policy_b64, self.signature)

filestack/trafarets.py

@@ -2,14 +2,22 @@
 
 STORE_LOCATION_SCHEMA = t.Enum('S3', 'gcs', 'azure', 'rackspace', 'dropbox')
 
-STORE_SCHEMA = t.Dict({
-    'filename': t.String(),
-    'mimetype': t.String(),
-    'location': t.String(),
-    'path': t.String(),
-    'container': t.String(),
-    'region': t.String(),
-    'access': t.String(),
-    'base64decode': t.Bool(),
-    'workflows': t.List(t.String())
-}).make_optional('*')
+
+def validate_upload_tags(d):
+    t.List(t.String, max_length=10).check(list(d.keys()))
+    t.Mapping(t.String(max_length=128), t.String(max_length=256)).check(d)
+    return d
+
+
+STORE_SCHEMA = t.Dict(
+    t.Key('filename', optional=True, trafaret=t.String),
+    t.Key('mimetype', optional=True, trafaret=t.String),
+    t.Key('location', optional=True, trafaret=t.String),
+    t.Key('path', optional=True, trafaret=t.String),
+    t.Key('container', optional=True, trafaret=t.String),
+    t.Key('region', optional=True, trafaret=t.String),
+    t.Key('access', optional=True, trafaret=t.String),
+    t.Key('base64decode', optional=True, trafaret=t.Bool),
+    t.Key('workflows', optional=True, trafaret=t.List(t.String)),
+    t.Key('upload_tags', optional=True, trafaret=validate_upload_tags),
+)

filestack/uploads/intelligent_ingestion.py

@@ -139,8 +139,11 @@ def upload(apikey, filepath, file_obj, storage, params=None, security=None):
         'upload_id': start_response['upload_id'],
     })
 
-    if params.get('workflows'):
-        payload['store']['workflows'] = params['workflows']
+    if 'workflows' in params:
+        payload['store']['workflows'] = params.pop('workflows')
+
+    if 'upload_tags' in params:
+        payload['upload_tags'] = params.pop('upload_tags')
 
     complete_url = 'https://{}/multipart/complete'.format(start_response['location_url'])
     session = requests.Session()

filestack/uploads/multipart.py

@@ -121,8 +121,11 @@ def multipart_upload(apikey, filepath, file_obj, storage, params=None, security=
     payload.update(start_response)
     payload['parts'] = uploaded_parts
 
-    if params.get('workflows'):
-        payload['store']['workflows'] = params['workflows']
+    if 'workflows' in params:
+        payload['store']['workflows'] = params.pop('workflows')
+
+    if 'upload_tags' in params:
+        payload['upload_tags'] = params.pop('upload_tags')
 
     complete_url = 'https://{}/multipart/complete'.format(location_url)
     complete_response = multipart_request(complete_url, payload, params, security)

setup.py

@@ -23,8 +23,8 @@ def read_version():
     author_email='support@filestack.com',
     packages=find_packages(),
     install_requires=[
-        'requests==2.22.0',
-        'trafaret==1.2.0'
+        'requests==2.23.0',
+        'trafaret==2.0.2'
     ],
     classifiers=[
         'Development Status :: 4 - Beta',