Upload Lingotek content metadata to TMS project document fields

Updated the API call and added content metadata options in the translation profile form.

Test failed because campaign_rating was set as a string in the schema, but should be an integer

Updated the automatic, disabled, and manual profiles in the config

Changed the value of the default campaign rating for the default profiles.

Patch did not include changes.

Updated the profile config yaml files

Fixed the handling of Lingotek Metadata in Lingotek.php on line 192 and 227.

Updated the metadata in the API call to check and see if it is even set.

Fixed two unit tests to account for the changes

Updated one more test

Some objects going through the metadata don't have profiles and so I put a try catch around it.

Another attempt at fixing the getEntityProfile call.

Removed Client parameter from the API call

Added the ability to send metadata in the document upload and update calls. These metadata can be controlled by the profile the content is using. There is a permission checkbox and text field for each on the profile so that they can be configured. The concept is finished for now and ready to be reviewed.

This patch doesn't apply with latest HEAD.

Interdiff not available because patch 21 won't apply. Just had to update the patch since another patch committed before this one had a conflict with this one.

The configuration files changes are invalid, or at least the installation aborts when using config strict checking (which happens in simpletests). Also, as there won't be any option to edit default provided profiles, I don't think it makes sense to duplicate the defaults.
I'm not sure yet, but I think config schema won't complain about not having them.

Added LingotekIntelligenceMetadataInterface for separating those methods from LingotekProfileInterface.
We will reuse that one for a global intelligence metadata settings that can be overridden by profiles.

Fixed typo in method name and coding standards.

Added configuration form and services for checking the global intelligence settings.
Added tests for this form.

Fixed test.

Reuse form for the profiles overrides. Add tests for the profile form.

A simple addition to a test discovered a bug. Congrats.

Coding standards.

Added logic for using the general settings or overriding with the profile settings as needed.

Added some basic test coverage.

A test for using the contact email as author setting.

1. +++ b/css/lingotek.settings.css
   @@ -4,3 +4,7 @@ input.field-property-checkbox {
   +.indent-form-item {
   +  margin-left: 25px;
   +}
   

   There's already a ".indented" class in Drupal classy theme. Let's reuse that one.

2. +++ b/src/Form/LingotekIntelligenceMetadataForm.php
   @@ -0,0 +1,367 @@
   +    $form['intelligence_metadata']['region'] = [
   +      '#attributes' => ['class' => ['indent-form-item']],
   +      '#type' => 'select',
   +      '#title' => $this->t('Region'),
   +      '#options' => ['region1' => 'Region 1', 'region2' => 'Region 2', 'region3' => 'Region 3'],
   +      '#default_value' => $metadata->getRegion() ?: 'region1',
   +      '#states' => [
   +        'visible' => [
   +          ':input[name="intelligence_metadata[use_region]"]' => ['checked' => TRUE],
   +        ],
   +      ],
   +    ];
   

   As agreed, let's make this a free textfield as the others.

3. +++ b/src/Form/LingotekProfileFormBase.php
   @@ -193,4 +218,27 @@ class LingotekProfileFormBase extends EntityForm {
   -}
   \ No newline at end of file
   

   Ensure the newline is there.

4. +++ b/src/Lingotek.php
   @@ -187,6 +188,17 @@ class Lingotek implements LingotekInterface {
   +    if ($profile !== NULL) {
   +      $json_content = json_decode($content);
   +      if (isset($json_content->_lingotek_metadata)) {
   +        foreach ($json_content->_lingotek_metadata as $key => $val) {
   +          if (substr($key,1,9) === 'api_data_'){
   +            $defaults[substr($key,10)] = $val;
   +          }
   +        }
   +      }
   +    }
   

   I didn't spot this before. We should remove the check for profile here anyway.

   But I'm wondering why we do this after already encoding, and why we cannot handle this in a different way.

   Instead of using a common prefix, let's add this to a different array ($data['_lingotek_metadata']['_intelligence']?)

   Also maybe it should be already given instead of embedded in the same array?

5. +++ b/src/Lingotek.php
   @@ -214,6 +227,15 @@ class Lingotek implements LingotekInterface {
   +    $json_content = json_decode($content);
   +    if (isset($json_content->_lingotek_metadata)) {
   +      foreach ($json_content->_lingotek_metadata as $key => $val) {
   +        if (substr($key,0,9) === '_api_data_'){
   +          $args[substr($key,10)] = $val;
   +        }
   +      }
   +    }
   

   Whatever option we chose, let's remove this code duplication by creating a new method.

6. +++ b/tests/src/Unit/LingotekUnitTest.php
   @@ -393,6 +401,7 @@ class LingotekUnitTest extends UnitTestCase {
   @@ -403,6 +412,7 @@ class LingotekUnitTest extends UnitTestCase {
   
   @@ -403,6 +412,7 @@ class LingotekUnitTest extends UnitTestCase {
   +        'external_application_id' => 'e39e24c7-6c69-4126-946d-cf8fbff38ef0'
   

   Let's add unit tests for ensuring we are passing the rest of the right parameters in the proper way.

I almost forgot: we need to define the defaults in an upgrade and the upgrade tests!

Tests didn't run, something must be wrong.

1. +++ b/src/Lingotek.php
   @@ -188,13 +188,11 @@
   +    $json_content = json_decode($content);
   +    if (isset($json_content->_lingotek_metadata)) {
   +      foreach ($json_content->_lingotek_metadata as $key => $val) {
   +        if (substr($key,1,9) === 'api_data_'){
   +          $defaults[substr($key,10)] = $val;
            }
          }
        }
   

   Let's call the method instead.

2. +++ b/src/Lingotek.php
   @@ -246,6 +238,21 @@
   +  public function getIntelligenceMetadata($content, $args) {
   ...
   +      foreach ($json_content->_lingotek_metadata->_intelligence as $key => $val) {
   +        if ($val !== '' || $val !== NULL){
   +          $args[$key] = $val;
   +        }
   +      }
   +    }
   

   We don't need args as a param. Let's rename the variables to more proper names.

   Why can't we do this before the json is decoded?

3. +++ b/src/Tests/LingotekIntelligenceMetadataTranslationTest.php
   --- a/src/LingotekInterface.php
   +++ b/src/LingotekInterface.php
   
   +++ b/src/LingotekInterface.php
   @@ -73,6 +73,19 @@ interface LingotekInterface {
   +  public function getIntelligenceMetadata($content, $args);
   

   I think this is not needed to be added to the interface. It's an implementation detail, not needed if we had a different implementation for the LingotekInterface.

Fixed assertions in upgrade tests.

Fixed syntax errors on Lingotek.php

Removed getIntelligenceMetadata from interface.

The upgrade path didn't save the config. Fixed coding standards (NULL instead of null, FALSE instead of false, TRUE instead of true).

Fixed tests now that the structure of the array changed.

Let's extend the API so an array is accepted.
If we change how we use the API we avoid JSON encoding/decoding twice.

This failed because we are assuming now in our tests that content will be always an array. We need to modify that mock as we modified the production code for ensuring we accept string and array.

Fixed unit tests. We were testing with an invalid JSON string, so let's ensure that still works.

Probably we should add more testing with arrays and valid JSON strings, but not in this ticket.
Also we could add testing for update functions + metadata, we are only testing upload here. But let's try to close this as is.

TJ reviewed it.

Committed d5122fb and pushed to 8.x-2.x. Thanks!