Changes for v2.1.0 (#143)

* Add entityId property support to ApiSessionCreate
* Add entityId support to ClientConfig and SessionProvider
* Implode error messages and append to ResponseException and ResultException
* Add missing extensions to composer.json require: ext-dom, ext-libxml, ext-simplexml, ext-xmlwriter
* Add PHP v7.3 to test in travis.yml
* Remove exceptions for elements missing in control block response
* Fix SessionProvider code coverage
* Move ApiSessionCreateTest to Company folder and fix code coverage tag
* Update copyright year
* Bump version to 2.1.0

Author: jimmymcpeter

.travis.yml

@@ -4,6 +4,7 @@ php:
   - 7.0
   - 7.1
   - 7.2
+  - 7.3
 
 before_script:
   - composer self-update

composer.json

@@ -11,7 +11,11 @@
   ],
   "require": {
     "php": ">=7.0",
+    "ext-dom": "*",
+    "ext-libxml": "*",
     "ext-mbstring": "*",
+    "ext-simplexml": "*",
+    "ext-xmlwriter": "*",
     "guzzlehttp/guzzle": "^6.2.3",
     "ramsey/uuid": "^3.6.1",
     "psr/log": "~1.0"

phpunit.xml.dist

@@ -1,6 +1,6 @@
 <?xml version="1.0"?>
 <!--
-Copyright 2018 Sage Intacct, Inc.
+Copyright 2019 Sage Intacct, Inc.
 
 Licensed under the Apache License, Version 2.0 (the "License"). You may not
 use this file except in compliance with the License. You may obtain a copy 

src/Intacct/AbstractClient.php

@@ -1,7 +1,7 @@
 <?php
 
 /**
- * Copyright 2018 Sage Intacct, Inc.
+ * Copyright 2019 Sage Intacct, Inc.
  *
  * Licensed under the Apache License, Version 2.0 (the "License"). You may not
  * use this file except in compliance with the License. You may obtain a copy

src/Intacct/ClientConfig.php

@@ -1,7 +1,7 @@
 <?php
 
 /**
- * Copyright 2018 Sage Intacct, Inc.
+ * Copyright 2019 Sage Intacct, Inc.
  *
  * Licensed under the Apache License, Version 2.0 (the "License"). You may not
  * use this file except in compliance with the License. You may obtain a copy
@@ -159,6 +159,25 @@ public function setCompanyId(string $companyId)
         $this->companyId = $companyId;
     }
 
+    /** @var string|null */
+    private $entityId;
+
+    /**
+     * @return string|null
+     */
+    public function getEntityId() //:string
+    {
+        return $this->entityId;
+    }
+
+    /**
+     * @param string $entityId
+     */
+    public function setEntityId(string $entityId)
+    {
+        $this->entityId = $entityId;
+    }
+
     /** @var string */
     private $userId = '';
 

src/Intacct/Credentials/CredentialsInterface.php

@@ -1,7 +1,7 @@
 <?php
 
 /**
- * Copyright 2018 Sage Intacct, Inc.
+ * Copyright 2019 Sage Intacct, Inc.
  *
  * Licensed under the Apache License, Version 2.0 (the "License"). You may not
  * use this file except in compliance with the License. You may obtain a copy

src/Intacct/Credentials/Endpoint.php

@@ -1,7 +1,7 @@
 <?php
 
 /**
- * Copyright 2018 Sage Intacct, Inc.
+ * Copyright 2019 Sage Intacct, Inc.
  *
  * Licensed under the Apache License, Version 2.0 (the "License"). You may not
  * use this file except in compliance with the License. You may obtain a copy

src/Intacct/Credentials/LoginCredentials.php

@@ -1,7 +1,7 @@
 <?php
 
 /**
- * Copyright 2018 Sage Intacct, Inc.
+ * Copyright 2019 Sage Intacct, Inc.
  *
  * Licensed under the Apache License, Version 2.0 (the "License"). You may not
  * use this file except in compliance with the License. You may obtain a copy
@@ -28,6 +28,9 @@ class LoginCredentials implements CredentialsInterface
     /** @var string */
     const COMPANY_ID_ENV_NAME = 'INTACCT_COMPANY_ID';
 
+    /** @var string */
+    const ENTITY_ID_ENV_NAME = 'INTACCT_ENTITY_ID';
+
     /** @var string */
     const USER_ID_ENV_NAME = 'INTACCT_USER_ID';
 
@@ -40,6 +43,9 @@ class LoginCredentials implements CredentialsInterface
     /** @var string */
     private $companyId;
 
+    /** @var string|null */
+    private $entityId;
+
     /** @var string */
     private $userId;
 
@@ -64,6 +70,12 @@ public function __construct(ClientConfig $config, SenderCredentials $senderCreds
         if (!$config->getCompanyId()) {
             $config->setCompanyId(getenv(static::COMPANY_ID_ENV_NAME));
         }
+        if ($config->getEntityId() == null) {
+            $envEntityId = getenv(static::ENTITY_ID_ENV_NAME);
+            if ($envEntityId !== false) {
+                $config->setEntityId($envEntityId);
+            }
+        }
         if (!$config->getUserId()) {
             $config->setUserId(getenv(static::USER_ID_ENV_NAME));
         }
@@ -81,6 +93,9 @@ public function __construct(ClientConfig $config, SenderCredentials $senderCreds
             if ($profile->getCompanyId()) {
                 $config->setCompanyId($profile->getCompanyId());
             }
+            if ($profile->getEntityId() !== null) {
+                $config->setEntityId($profile->getEntityId());
+            }
             if ($profile->getUserId()) {
                 $config->setUserId($profile->getUserId());
             }
@@ -95,6 +110,7 @@ public function __construct(ClientConfig $config, SenderCredentials $senderCreds
                 . static::COMPANY_ID_ENV_NAME . '"'
             );
         }
+        // Entity ID is not required, no Error
         if (!$config->getUserId()) {
             throw new \InvalidArgumentException(
                 'Required User ID not supplied in config or env variable "'
@@ -109,6 +125,9 @@ public function __construct(ClientConfig $config, SenderCredentials $senderCreds
         }
 
         $this->setCompanyId($config->getCompanyId());
+        if ($config->getEntityId() !== null) {
+            $this->setEntityId($config->getEntityId());
+        }
         $this->setUserId($config->getUserId());
         $this->setPassword($config->getUserPassword());
         $this->setSenderCredentials($senderCreds);
@@ -130,6 +149,22 @@ public function setCompanyId(string $companyId)
         $this->companyId = $companyId;
     }
 
+    /**
+     * @return string
+     */
+    public function getEntityId() //: string
+    {
+        return $this->entityId;
+    }
+
+    /**
+     * @param string $entityId
+     */
+    public function setEntityId(string $entityId)
+    {
+        $this->entityId = $entityId;
+    }
+
     /**
      * @return string
      */

src/Intacct/Credentials/ProfileCredentialProvider.php

@@ -1,7 +1,7 @@
 <?php
 
 /**
- * Copyright 2018 Sage Intacct, Inc.
+ * Copyright 2019 Sage Intacct, Inc.
  *
  * Licensed under the Apache License, Version 2.0 (the "License"). You may not
  * use this file except in compliance with the License. You may obtain a copy
@@ -40,6 +40,9 @@ public static function getLoginCredentials(ClientConfig $config): ClientConfig
         if (isset($data['company_id'])) {
             $creds->setCompanyId($data['company_id']);
         }
+        if (isset($data['entity_id'])) {
+            $creds->setEntityId($data['entity_id']);
+        }
         if (isset($data['user_id'])) {
             $creds->setUserId($data['user_id']);
         }

src/Intacct/Credentials/SenderCredentials.php

@@ -1,7 +1,7 @@
 <?php
 
 /**
- * Copyright 2018 Sage Intacct, Inc.
+ * Copyright 2019 Sage Intacct, Inc.
  *
  * Licensed under the Apache License, Version 2.0 (the "License"). You may not
  * use this file except in compliance with the License. You may obtain a copy