Merge branch 'release/3.3.0'

Bartek Kwiecien · Bartek Kwiecien · commit 95adec03dbe2 · 2021-03-12T14:54:46.000+01:00
diff --git a/.flake8 b/.flake8
@@ -0,0 +1,6 @@
+[flake8]
+max-line-length = 120
+per-file-ignores =
+    filestack/__init__.py:F401,E402
+    filestack/models/__init__.py:F401
+    filestack/mixins/__init__.py:F401
diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml
@@ -0,0 +1,36 @@
+name: Tests
+
+on: [push, pull_request]
+
+jobs:
+  tests:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ubuntu-latest, macos-latest, windows-latest]
+        python-version: [3.5, 3.6, 3.7, 3.8]
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v2
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install requirements
+      run: pip install -r requirements.txt
+    - name: Run tests
+      run: pytest -v --cov=filestack tests
+
+  static-analysis:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python
+      uses: actions/setup-python@v2
+      with:
+        python-version: 3.8
+    - name: Install tools
+      run: pip install flake8 bandit
+    - name: Run analysis
+      run: |
+        flake8 filestack/
+        bandit -r -lll filestack/
diff --git a/.travis.yml b/.travis.yml
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,10 @@
 # Filestack-Python Changelog
 
+### 3.3.0 (March 12th, 2021)
+- Added Image OCR [#52](https://github.com/filestack/filestack-python/pull/52)
+- Changed how files from external urls are uploaded [#54](https://github.com/filestack/filestack-python/pull/54)
+- Added custom exception for HTTP errors [#57](https://github.com/filestack/filestack-python/pull/57)
+
 ### 3.2.1 (July 22nd, 2020)
 - FS-7797 changed http method used when uploading external urls
 
diff --git a/README.md b/README.md
@@ -1,8 +1,8 @@
 <p align="center"><img src="logo.svg" align="center" width="100"/></p>
 <h1 align="center">Filestack Python</h1>
 <p align="center">
-  <a href="http://travis-ci.org/filestack/filestack-python">
-    <img src="https://img.shields.io/travis/filestack/filestack-python.svg">
+  <a href="https://img.shields.io/pypi/pyversions/filestack-python.svg">
+    <img src="https://github.com/filestack/filestack-python/actions/workflows/tests.yml/badge.svg">
   </a>
   <a href="https://pypi.python.org/pypi/filestack-python">
     <img src="https://img.shields.io/pypi/v/filestack-python.svg">
diff --git a/VERSION b/VERSION
@@ -1 +1 @@
-3.2.1
+3.3.0
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -1,4 +1,4 @@
 Sphinx==2.1.2
 sphinx-rtd-theme==0.4.3
 trafaret==2.0.2
-requests==2.23.0
+requests==2.24.0
diff --git a/filestack/__init__.py b/filestack/__init__.py
@@ -1,4 +1,4 @@
-__version__ = '3.2.1'
+__version__ = '3.3.0'
 
 
 class CFG:
diff --git a/filestack/exceptions.py b/filestack/exceptions.py
@@ -0,0 +1,7 @@
+class FilestackHTTPError(Exception):
+    """
+    Custom HTTPError instead of requests.exceptions.HTTPError to add response body.
+
+    References:
+        - https://github.com/psf/requests/pull/4234
+    """
diff --git a/filestack/mixins/common.py b/filestack/mixins/common.py
@@ -98,7 +98,7 @@ def get_content(self, security=None):
 
     def tags(self, security=None):
         """
-        Performs image tagging operation on current object
+        Performs image tagging operation on current object (image)
 
         Args:
             security (:class:`filestack.Security`): Security object that will be used
@@ -125,3 +125,18 @@ def sfw(self, security=None):
         obj = self._add_transform_task('sfw', params={'self': None})
         response = requests.get(obj.signed_url(security=security))
         return response.json()
+
+    def ocr(self, security=None):
+        """
+        Performs OCR on current object (image)
+
+        Args:
+            security (:class:`filestack.Security`): Security object that will be used
+                to run OCR
+
+        Returns:
+            `dict`: dictionary containing OCR data
+        """
+        obj = self._add_transform_task('ocr', params={'self': None})
+        response = requests.get(obj.signed_url(security=security))
+        return response.json()
diff --git a/filestack/models/client.py b/filestack/models/client.py
@@ -19,7 +19,7 @@ class Client:
     and provide a Security object to sign all your API calls.
 
     >>> from filestack import Client, Security
-    >>> security = Security(policy={'expiry': 1594200833, '<YOUR APP SECRET>'})
+    >>> security = Security(policy={'expiry': 1594200833}, secret='YOUR APP SECRET')
     >>> cli = Client('<FILESTACK_APIKEY>', storage='gcs', security=security)
     """
     def __init__(self, apikey, storage='S3', security=None):
diff --git a/filestack/uploads/external_url.py b/filestack/uploads/external_url.py
@@ -1,36 +1,31 @@
-import base64
-from collections import OrderedDict
-
-from filestack.utils import requests
-
 from filestack import config
+from filestack.utils import requests
 
 
-def build_store_task(store_params):
-    if not store_params:
-        return 'store'
-
-    task_args = []
-    store_params = OrderedDict(sorted(store_params.items(), key=lambda t: t[0]))
-    for key, value in store_params.items():
-        if key in ('filename', 'location', 'path', 'container', 'region', 'access', 'base64decode', 'workflows'):
-            if key == 'workflows':
-                value = '[{}]'.format(','.join('"{}"'.format(item) for item in value))
-            if key == 'path':
-                value = '"{}"'.format(value)
-            task_args.append('{}:{}'.format(key, str(value).lower()))
-
-    return 'store={}'.format(','.join(task_args))
+def upload_external_url(url, apikey, store_params=None, security=None):
+    store_params = store_params or {}
 
+    # remove params that are currently not supported in external url upload
+    for item in ('mimetype', 'upload_tags'):
+        store_params.pop(item, None)
 
-def upload_external_url(url, apikey, store_params=None, security=None):
-    store_task = build_store_task(store_params or {})
-    encoded_url = 'b64://{}'.format(base64.urlsafe_b64encode(url.encode()).decode())
-    url_elements = [config.CDN_URL, apikey, store_task, encoded_url]
+    payload = {
+        'apikey': apikey,
+        'sources': [url],
+        'tasks': [{
+            'name': 'store',
+            'params': store_params
+        }]
+    }
 
     if security is not None:
-        url_elements.insert(3, security.as_url_string())
-
-    # TODO: use processing endpoint and "store" task for uploading external urls
-    response = requests.get('/'.join(url_elements))
+        payload['tasks'].append({
+            'name': 'security',
+            'params': {
+                'policy': security.policy_b64,
+                'signature': security.signature
+            }
+        })
+
+    response = requests.post('{}/process'.format(config.CDN_URL), json=payload)
     return response.json()['handle']
diff --git a/filestack/utils.py b/filestack/utils.py
@@ -3,8 +3,10 @@
 import random
 from functools import partial
 import requests as original_requests
+from requests.exceptions import HTTPError
 
 from filestack import config
+from filestack.exceptions import FilestackHTTPError
 
 
 def unique_id(length=10):
@@ -30,8 +32,10 @@ def handle_request(self, name, *args, **kwargs):
         requests_method = getattr(original_requests, name)
         response = requests_method(*args, **kwargs)
 
-        if not response.ok:
-            raise Exception(response.text)
+        try:
+            response.raise_for_status()
+        except HTTPError as e:
+            raise FilestackHTTPError(response.text) from e
 
         return response
 
diff --git a/requirements.txt b/requirements.txt
@@ -2,6 +2,6 @@ coveralls==1.1
 httmock==1.2.6
 pytest==4.6.3
 pytest-cov==2.5.0
-requests==2.22.0
+requests==2.25.1
 responses==0.10.6
-trafaret==1.2.0
+trafaret==2.0.2
diff --git a/setup.py b/setup.py
@@ -23,7 +23,7 @@ def read_version():
     author_email='support@filestack.com',
     packages=find_packages(),
     install_requires=[
-        'requests==2.23.0',
+        'requests==2.25.1',
         'trafaret==2.0.2'
     ],
     classifiers=[
@@ -34,6 +34,7 @@ def read_version():
         'Programming Language :: Python :: 3.5',
         'Programming Language :: Python :: 3.6',
         'Programming Language :: Python :: 3.7',
+        'Programming Language :: Python :: 3.8',
         'Topic :: Internet :: WWW/HTTP',
     ],
 )
diff --git a/tests/client_test.py b/tests/client_test.py
@@ -29,7 +29,7 @@ def test_wrong_storage():
 
 
 def test_store_external_url(client):
-    @urlmatch(netloc=r'cdn.filestackcontent\.com', method='get', scheme='https')
+    @urlmatch(netloc=r'cdn.filestackcontent\.com', method='post', scheme='https')
     def api_store(url, request):
         return response(200, {'handle': HANDLE})
 
diff --git a/tests/helpers.py b/tests/helpers.py
@@ -1,3 +1,4 @@
+from requests.exceptions import HTTPError
 
 
 class DummyHttpResponse:
@@ -11,3 +12,12 @@ def __init__(self, ok=True, status_code=200, json_dict=None, content=b'', header
 
     def json(self):
         return self.json_dict
+
+    def raise_for_status(self):
+        """
+        Return a dummy error if 'ok' was specified as False.
+
+        Note that in the original 'requests', response.ok calls raise_for_status() instead
+        """
+        if not self.ok:
+            raise HTTPError("HTTP request failed.")
diff --git a/tests/uploads/test_upload_external_url.py b/tests/uploads/test_upload_external_url.py
@@ -1,63 +1,48 @@
-import base64
 from unittest.mock import patch
 
 import pytest
 
 from tests.helpers import DummyHttpResponse
 from filestack import config
-from filestack.models import Security
 from filestack.uploads.external_url import upload_external_url
 
 url = 'http://image.url'
-encoded_url = 'b64://{}'.format(base64.urlsafe_b64encode(url.encode()).decode())
 apikey = 'TESTAPIKEY'
 
 
-@patch('filestack.uploads.external_url.requests.get')
-def test_upload(post_mock):
-    post_mock.return_value = DummyHttpResponse(json_dict={'handle': 'newHandle'})
-
-    handle = upload_external_url(url, apikey)
-    assert handle == 'newHandle'
-    post_mock.assert_called_once_with('{}/{}/store/{}'.format(config.CDN_URL, apikey, encoded_url))
-
-
-@pytest.mark.parametrize('store_params, expected_store_task', [
-    [{'location': 'S3'}, 'store=location:s3'],
-    [{'path': 'store/path/image.jpg'}, 'store=path:"store/path/image.jpg"'],
-    [{'base64decode': True, 'access': 'public'}, 'store=access:public,base64decode:true'],
-    [
-        {'workflows': ['uuid-1', 'uuid-2'], 'container': 'bucket-name'},
-        'store=container:bucket-name,workflows:["uuid-1","uuid-2"]'
-    ],
+@pytest.mark.parametrize('store_params, security, expected_store_tasks', [
+    (
+        {'location': 's3'},
+        None,
+        [
+            {
+                'name': 'store', 'params': {'location': 's3'}
+            }
+        ]
+    ),
+    (
+        {'path': 'new-path/', 'mimetype': 'application/json'},
+        type('SecurityMock', (), {'policy_b64': 'abc', 'signature': '123'}),
+        [
+            {
+                'name': 'store', 'params': {'path': 'new-path/'}
+            },
+            {
+                'name': 'security', 'params': {'policy': 'abc', 'signature': '123'}
+            }
+        ]
+    )
 ])
-@patch('filestack.uploads.external_url.requests.get')
-def test_upload_with_store_params(post_mock, store_params, expected_store_task):
+@patch('filestack.uploads.external_url.requests.post')
+def test_upload_with_store_params(post_mock, store_params, security, expected_store_tasks):
+    expected_payload = {
+        'apikey': 'TESTAPIKEY',
+        'sources': ['http://image.url'],
+        'tasks': expected_store_tasks
+    }
     post_mock.return_value = DummyHttpResponse(json_dict={'handle': 'newHandle'})
 
-    handle = upload_external_url(url, apikey, store_params=store_params)
+    handle = upload_external_url(url, apikey, store_params=store_params, security=security)
     assert handle == 'newHandle'
     post_args, _ = post_mock.call_args
-    req_url = post_args[0]
-    assert expected_store_task in req_url
-
-
-@patch('filestack.uploads.external_url.requests.get')
-def test_upload_with_security(post_mock):
-    post_mock.return_value = DummyHttpResponse(json_dict={'handle': 'newHandle'})
-    security = Security({'expiry': 123123123123, 'call': ['write']}, 'SECRET')
-    handle = upload_external_url(url, apikey, security=security)
-    assert handle == 'newHandle'
-    expected_url = '{}/{}/store/{}/{}'.format(
-        config.CDN_URL, apikey, security.as_url_string(), encoded_url
-    )
-    post_mock.assert_called_once_with(expected_url)
-
-
-@patch('filestack.uploads.external_url.requests.get')
-def test_upload_exception(post_mock):
-    error_message = 'Oops!'
-    post_mock.side_effect = Exception(error_message)
-
-    with pytest.raises(Exception, match=error_message):
-        upload_external_url(url, apikey)
+    post_mock.assert_called_once_with('{}/process'.format(config.CDN_URL), json=expected_payload)
diff --git a/tox.ini b/tox.ini

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-__version__ = '3.2.1'`
	`1`	`+__version__ = '3.3.0'`
`2`	`2`
`3`	`3`
`4`	`4`	`class CFG:`