Download the PHP package portrino/codeception-yandex-module without Composer
On this page you can find all versions of the php package portrino/codeception-yandex-module. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download portrino/codeception-yandex-module
More information about portrino/codeception-yandex-module
Files in portrino/codeception-yandex-module
Package codeception-yandex-module
Short Description Provides validation of structured data via yandex API
License
Informations about the package codeception-yandex-module
Codeception Yandex Module
This package provides validation of responses via Structured data validator API from Yandex. You can automatically check if your embedded structured data markup (aka semantic markup) is correct based on the current vocabularies like schema.org.
To transmit data to the API, you specify the HTML code or URL of the page. After completing validation, the API outputs the structured data extracted from the page in JSON format, > along with the codes of any errors detected. The following syntaxes are currently supported: JSON-LD, RDFa, microdata, and microformats.
Source: https://tech.yandex.com/validator/
With this module you are able to automate tests for semantic data validation in your cests via codeception. You save time during development of new features, because you do not have to copy your markup manually into the structured data testing tool or structured data validator when checking if some new feature or bugfix break your semantic markup.
You also can use this module for automating structured data validation for large quantities of pages.
Installation
You need to add the repository into your composer.json file
Usage
You can use this module as any other Codeception module, by adding 'Yandex' to the enabled modules in your Codeception suite configurations.
Enable module and setup the configuration variables
- After registering you can get the
apiKey
here: https://developer.tech.yandex.ru/ - The
url
could be set in config file directly or via an environment variable:%BASE_URL%
Update Codeception build
Implement the cept / cest
Methods
seeResponseContainsValidStructuredDataMarkup()
Validates the current response from $I->amOnPage('/foo/bar/');
against the structured data validator API and checks
all supported formats like: JSON-LD, RDFa, microdata, and microformats.
seeResponseContainsValidJsonLdMarkup()
Validates the current response from $I->amOnPage('/foo/bar/');
against the structured data validator API and checks
only the data which is in JSON-LD format.
seeResponseContainsValidMicrodataMarkup()
Validates the current response from $I->amOnPage('/foo/bar/');
against the structured data validator API and checks
only the data which is in microdata format.
seeResponseContainsValidMicroformatMarkup()
Validates the current response from $I->amOnPage('/foo/bar/');
against the structured data validator API and checks
only the data which is in microformat format.
seeResponseContainsValidRdfaMarkup()
Validates the current response from $I->amOnPage('/foo/bar/');
against the structured data validator API and checks
only the data which is in RDFa format.
grabStructuredDataFromApiResponse()
Grab the structured data from the current response and it returns it as array. Please have a look at https://tech.yandex.com/validator/doc/dg/concepts/response_standart-docpage/ for information about the standard response format of the yandex API.
grabStructuredDataFromApiResponseByJsonPath()
Experimental!!!
Grab the structured data from the current response by jsonPath query syntax with the help of JSONPath PHP Package. All "special" chars like:
- .
- //
- /
-
- :
- @
- '
- \
are replaced in json response from yandex structured data validator API by _ to make jsonPath working!
Authors
- André Wuttig - Initial work, Unit Tests - aWuttig
See also the list of contributors who participated in this project.
All versions of codeception-yandex-module with dependencies
flow/jsonpath Version ~0.3
nixsolutions/yandex-php-library Version ~3.0.0