Merge remote-tracking branch 'origin/master' into fewer-preps

Author: adamtheturtle

.gitignore

@@ -100,3 +100,9 @@ secrets.tar
 
 # macOS attributes
 *.DS_Store
+
+# pyre
+.pyre/
+
+# pytest
+.pytest_cache/

.travis.yml

@@ -7,14 +7,7 @@ matrix:
 env:
   matrix:
   - TEST_FILENAME=''
-  - TEST_FILENAME=test_add_target.py::TestActiveFlag
-  - TEST_FILENAME=test_add_target.py::TestApplicationMetadata
-  - TEST_FILENAME=test_add_target.py::TestContentTypes
-  - TEST_FILENAME=test_add_target.py::TestImage
-  - TEST_FILENAME=test_add_target.py::TestMissingData
-  - TEST_FILENAME=test_add_target.py::TestTargetName
-  - TEST_FILENAME=test_add_target.py::TestUnexpectedData
-  - TEST_FILENAME=test_add_target.py::TestWidth
+  - TEST_FILENAME=test_add_target.py
   - TEST_FILENAME=test_authorization_header.py
   - TEST_FILENAME=test_database_summary.py
   - TEST_FILENAME=test_date_header.py::TestFormat
@@ -48,7 +41,6 @@ before_install:
 - travis_retry pip install --upgrade pip setuptools
 install:
 - travis_retry pip install --upgrade --editable .[dev]
-- travis_retry npm install -g markdownlint-cli
 cache: pip
 before_script:
 - python ci/set_secrets_file.py

CHANGELOG.rst

@@ -171,6 +171,15 @@ However, it must be set to ``multipart/form-data; boundary=<BOUNDARY>`` where ``
 The documentation page `How To Perform an Image Recognition Query <https://library.vuforia.com/articles/Solution/How-To-Perform-an-Image-Recognition-Query>`__ states that ``Content-Type`` with be the only response header.
 This is not the case.
 
+The documentation page `How To Perform an Image Recognition Query <https://library.vuforia.com/articles/Solution/How-To-Perform-an-Image-Recognition-Query>`__ states that 10 is the maximum allowed value of ``max_num_results``.
+However, the maximum allowed value is 50.
+
+A response to an invalid query may have an ``application/json`` content type but include text (not JSON) data.
+
+After deleting a target, for up to approximately 30 seconds, matching it with a query returns a 500 response.
+
+A target with the name ``\uffff`` gets stuck in processing.
+
 Performing a release
 --------------------
 

CONTRIBUTING.rst

@@ -0,0 +1 @@
+recursive-include src/mock_vws/resources *

MANIFEST.in

@@ -7,6 +7,8 @@ lint:
 	flake8 .
 	isort --recursive --check-only
 	mypy src/ tests/ ci/
+	pip-extra-reqs src/
+	pip-missing-reqs src/
 	pydocstyle
 	pylint *.py src tests ci
 	pyroma .

Makefile

@@ -112,15 +112,23 @@ To change the state, use the ``state`` parameter when calling the mock.
 
 The states available in ``States`` are:
 
--  ``WORKING``.
-This is the default state of the mock.
--  ``PROJECT_INACTIVE``.
-This happens when the license key has been deleted.
+- ``WORKING``.
+  This is the default state of the mock.
+- ``PROJECT_INACTIVE``.
+  This happens when the license key has been deleted.
 
 The mock is tested against the real Vuforia Web Services.
 This ensures that the implemented features of the mock behave, at least to some extent, like the real Vuforia Web Services.
 However, the mocks of these error states are based on observations as they cannot be reliably reproduced.
 
+Custom base URLs
+~~~~~~~~~~~~~~~~
+
+``MockVWS`` mocks the Vuforia Web Services (VWS) API and the Vuforia Web Query API.
+These APIs have base URLs ``https://vws.vuforia.com`` and ``https://cloudreco.vuforia.com`` respectively.
+
+``MockVWS`` takes the optional parameters ``base_vws_url`` and ``base_vwq_url`` to modify the base URLs of the mocked endpoints.
+
 Processing time
 ~~~~~~~~~~~~~~~
 
@@ -162,6 +170,36 @@ Therefore, an image given a ‘success’ status by the mock may not be given a
 When updating an image for a target on the real Vuforia Web Services, the rating may stay the same.
 The mock changes the rating for a target to a different random number when the image is changed.
 
+Matching targets in the processing state
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Matching a target which is in the processing state sometimes returns a successful response with no results.
+Sometimes a 500 (INTERNAL SERVER ERROR) response is given.
+The mock always gives a 500 response.
+
+Matching deleted targets
+~~~~~~~~~~~~~~~~~~~~~~~~
+
+Matching a target which has been deleted returns a 500 (INTERNAL SERVER ERROR) response within the first few seconds.
+This timeframe is not consistent on the real Vuforia Web Services.
+On the mock, this timeframe is three seconds by default.
+``MockVWS`` takes a parameter ``query_recognizes_deletion_seconds`` to change this.
+
+Accepted date formats for the Query API
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+The Query API documentation is not clear on which date formats are expected exactly in the ``Date`` header.
+The mock is strict.
+That is, it accepts only a few date formats, and rejects all others.
+If you find a date format which is accepted by the real Query API but rejected by the mock, please create a GitHub issue.
+
+Targets stuck in processing
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+On the real Vuforia Web Services, targets sometimes get stuck in the processing state.
+For example, targets with the name ``\uffff`` get stuck in the processing state.
+On the mock, no targets get stuck in the processing state.
+
 .. |Build Status| image:: https://travis-ci.org/adamtheturtle/vws-python.svg?branch=master
    :target: https://travis-ci.org/adamtheturtle/vws-python
 .. |codecov| image:: https://codecov.io/gh/adamtheturtle/vws-python/branch/master/graph/badge.svg

README.rst

@@ -15,7 +15,6 @@ def move_secrets_file() -> None:
     travis_builder_number = travis_job_number.split('.')[-1]
     secrets_dir = Path('ci_secrets')
     secrets_path = secrets_dir / f'vuforia_secrets_{travis_builder_number}.env'
-    print(f'Using: {secrets_path}')
     shutil.copy(secrets_path, './vuforia_secrets.env')
 
 

ci/set_secrets_file.py

@@ -1,3 +1,4 @@
+attrs==18.1.0  # Modern attrs is required for pytest
 autoflake==1.2
 check-manifest==0.37
 codecov==2.0.15 # Upload coverage data
@@ -6,16 +7,17 @@ flake8==3.5.0  # Lint
 flake8-commas==2.0.0  # Require silicon valley commas
 flake8-quotes==1.0.0  # Require single quotes
 freezegun==0.3.10  # Freeze time in tests
-hypothesis==3.56.8  # Generate test cases
+hypothesis==3.57.0  # Generate test cases
 isort==4.3.4  # Lint imports
-mypy==0.600  # Type checking
+mypy==0.610  # Type checking
+pip_check_reqs==2.0.3
 pydocstyle==2.1.1  # Lint docstrings
 pyenchant==2.0.0  # Bindings for a spellchecking sytem
-pylint==1.8.4  # Lint
-pyroma==2.3  # Packaging best practices checker
+pylint==1.9.2  # Lint
+pyroma==2.3.1  # Packaging best practices checker
 pytest-cov==2.5.1  # Measure code coverage
 pytest-envfiles==0.1.0  # Use files for environment variables for tests
-pytest==3.5.1  # Test runners
+pytest==3.6.1  # Test runners
 timeout-decorator==0.4.0  # Decorate functions to time out.
-vulture==0.26
+vulture==0.27
 yapf==0.21.0  # Automatic formatting for Python

dev-requirements.txt

@@ -73,8 +73,11 @@ disable=
     no-self-use,
     line-too-long,
     too-few-public-methods,
+    too-many-lines,
     too-many-locals,
     too-many-arguments,
+    too-many-instance-attributes,
+    too-many-return-statements,
     locally-disabled,
     # Let flake8 handle unused imports
     unused-import,
@@ -148,10 +151,10 @@ const-rgx=(([A-Z_][A-Z0-9_]*)|(__.*__))$
 const-name-hint=(([A-Z_][A-Z0-9_]*)|(__.*__))$
 
 # Regular expression matching correct method names
-method-rgx=[a-z_][a-z0-9_]{2,30}$
+method-rgx=[a-z_][a-z0-9_]{2,40}$
 
 # Naming hint for method names
-method-name-hint=[a-z_][a-z0-9_]{2,30}$
+method-name-hint=[a-z_][a-z0-9_]{2,40}$
 
 # Regular expression matching correct inline iteration names
 inlinevar-rgx=[A-Za-z_][A-Za-z0-9_]*$
@@ -160,16 +163,16 @@ inlinevar-rgx=[A-Za-z_][A-Za-z0-9_]*$
 inlinevar-name-hint=[A-Za-z_][A-Za-z0-9_]*$
 
 # Regular expression matching correct function names
-function-rgx=[a-z_][a-z0-9_]{2,30}$
+function-rgx=[a-z_][a-z0-9_]{2,50}$
 
 # Naming hint for function names
-function-name-hint=[a-z_][a-z0-9_]{2,30}$
+function-name-hint=[a-z_][a-z0-9_]{2,50}$
 
 # Regular expression matching correct variable names
-variable-rgx=[a-z_][a-z0-9_]{2,30}$
+variable-rgx=[a-z_][a-z0-9_]{2,50}$
 
 # Naming hint for variable names
-variable-name-hint=[a-z_][a-z0-9_]{2,30}$
+variable-name-hint=[a-z_][a-z0-9_]{2,50}$
 
 # Regular expression matching correct module names
 module-rgx=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$
@@ -178,22 +181,22 @@ module-rgx=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$
 module-name-hint=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$
 
 # Regular expression matching correct class attribute names
-class-attribute-rgx=([A-Za-z_][A-Za-z0-9_]{2,30}|(__.*__))$
+class-attribute-rgx=([A-Za-z_][A-Za-z0-9_]{2,50}|(__.*__))$
 
 # Naming hint for class attribute names
-class-attribute-name-hint=([A-Za-z_][A-Za-z0-9_]{2,30}|(__.*__))$
+class-attribute-name-hint=([A-Za-z_][A-Za-z0-9_]{2,50}|(__.*__))$
 
 # Regular expression matching correct argument names
-argument-rgx=[a-z_][a-z0-9_]{2,30}$
+argument-rgx=[a-z_][a-z0-9_]{2,50}$
 
 # Naming hint for argument names
-argument-name-hint=[a-z_][a-z0-9_]{2,30}$
+argument-name-hint=[a-z_][a-z0-9_]{2,50}$
 
 # Regular expression matching correct attribute names
-attr-rgx=[a-z_][a-z0-9_]{2,30}$
+attr-rgx=[a-z_][a-z0-9_]{2,50}$
 
 # Naming hint for attribute names
-attr-name-hint=[a-z_][a-z0-9_]{2,30}$
+attr-name-hint=[a-z_][a-z0-9_]{2,50}$
 
 # Regular expression matching correct class names
 class-rgx=[A-Z_][a-zA-Z0-9]+$