Merge branch 'main' into add-phpstan

Author: stephangroen

README.md

@@ -266,4 +266,4 @@ Guzzle 6 and 7 is supported starting from v3. For Guzzle 3 use [v1](https://gith
 
 ## TODO
 
-- Current entities do not contain all available properties. Feel free to submit a PR with added or extended entities if you require them. Use the ```userscript.js``` in greasemonkey or tampermonkey to generate entities consistently and completely.
+- Current entities do not contain all available properties. Feel free to submit a PR with added or extended entities if you require them.

composer.json

@@ -21,8 +21,8 @@
         "ext-json": "*"
     },
     "require-dev": {
-        "phpunit/phpunit": "^8.5|^9.3",
         "phpstan/phpstan": "^2.1"
+        "phpunit/phpunit": "^9.6"
     },
     "autoload": {
         "psr-4": {

phpunit.xml.dist

@@ -1,16 +1,19 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-         bootstrap="./vendor/autoload.php"
-         colors="true"
-         xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.3/phpunit.xsd">
+<phpunit
+        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+        bootstrap="./vendor/autoload.php"
+        colors="true"
+        xsi:noNamespaceSchemaLocation="./vendor/phpunit/phpunit/phpunit.xsd">
+
+  <coverage>
+    <include>
+      <directory suffix=".php">src</directory>
+    </include>
+  </coverage>
+
   <testsuites>
-    <testsuite name="Application Test Suite">
+    <testsuite name="Exact PHP Client Test Suite">
       <directory>tests</directory>
     </testsuite>
   </testsuites>
-  <filter>
-    <whitelist>
-      <directory suffix=".php">src</directory>
-    </whitelist>
-  </filter>
 </phpunit>

src/Picqer/Financials/Exact/SyncDeleted.php

@@ -12,7 +12,7 @@
  * @property string $DeletedDate Deleted date
  * @property int $Division Division code
  * @property string $EntityKey Entity key
- * @property int $EntityType Entity Types: 1= TransactionLines 2= Accounts 3= Addresses 4= Attachments 5= Contacts 6= Documents 7= GLAccounts 8= ItemPrices 9= Items 10= PaymentTerms 12= SalesOrders (This entity is going to be removed. Please refer to the new entity SalesOrderHeaders, SalesOrderLines.) 13= SalesInvoices 14= TimeCostTransactions 15= StockPositions 16= GoodsDeliveries 17= GoodsDeliveryLines 18= GLClassifications 19= ItemWarehouses 20= StorageLocationStockPositions 21= Projects 22= PurchaseOrders 23= Subscriptions 24= SubscriptionLines 25= ProjectWBS 26= ProjectPlanning 27= LeaveAbsenceHoursByDay 28= SerialBatchNumbers 29= StockSerialBatchNumbers 30= ItemAccounts 31= DiscountTables 32= SalesOrderHeaders 33= SalesOrderLines 34= QuotationHeaders 35= QuotationLines 36= ShopOrders 37= ShopOrderMaterialPlans 38= ShopOrderRoutingStepPlans 39= Schedules 40= ScheduleEntries 41= ItemStorageLocations 42= Employees 43= Employments 44= EmploymentContracts 45= EmploymentOrganizations 46= EmploymentCLAs 47= EmploymentSalaries 48= BankAccounts 49= EmploymentTaxAuthoritiesGeneral 50= ShopOrderPurchasePlanning 51= ShopOrderSubOrders
+ * @property int $EntityType Entity Types: 1= TransactionLines 2= Accounts 3= Addresses 4= Attachments 5= Contacts 6= Documents 7= GLAccounts 8= ItemPrices 9= Items 10= PaymentTerms 12= SalesOrders (This entity is going to be removed. Please refer to the new entity SalesOrderHeaders, SalesOrderLines.) 13= SalesInvoices 14= TimeCostTransactions 15= StockPositions 16= GoodsDeliveries 17= GoodsDeliveryLines 18= GLClassifications 19= ItemWarehouses 20= StorageLocationStockPositions 21= Projects 22= PurchaseOrders 23= Subscriptions 24= SubscriptionLines 25= ProjectWBS 26= ProjectPlanning 27= LeaveAbsenceHoursByDay 28= SerialBatchNumbers 29= StockSerialBatchNumbers 30= ItemAccounts 31= DiscountTables 32= SalesOrderHeaders 33= SalesOrderLines 34= QuotationHeaders 35= QuotationLines 36= ShopOrders 37= ShopOrderMaterialPlans 38= ShopOrderRoutingStepPlans 39= Schedules 40= ScheduleEntries 41= ItemStorageLocations 42= Employees 43= Employments 44= EmploymentContracts 45= EmploymentOrganizations 46= EmploymentCLAs 47= EmploymentSalaries 48= BankAccounts 49= EmploymentTaxAuthoritiesGeneral 50= ShopOrderPurchasePlanning 51= ShopOrderSubOrders 53= RequirementIssues 54= BillOfMaterialMaterials
  * @property string $ID Primary key
  */
 class SyncDeleted extends Model

src/Picqer/Financials/Exact/SyncScheduleEntry.php

@@ -8,21 +8,29 @@
  * @see https://start.exactonline.nl/docs/HlpRestAPIResourcesDetails.aspx?name=SyncHRMScheduleEntries
  *
  * @property int $Timestamp Timestamp
+ * @property bool $Break This property is for Schedule type 4 (Time frames per day). Set to true if there is break time else false.
+ * @property string $BreakEndTime This is the break end time. This property is for Schedule type 4 (Time frames per day)
+ * @property string $BreakStartTime This is the break start time. This property is for Schedule type 4 (Time frames per day)
  * @property string $Created Created date.
- * @property string $Creator ID of creator.
+ * @property string $Creator User ID of creator.
  * @property string $CreatorFullName Name of creator
  * @property int $Day The day in the week. 0 - Monday; 1 - Tuesday; 2 - Wednesday; 3 - Thursday; 4 - Friday; 5 - Saturday; 6 - Sunday
+ * @property bool $DayIsSelected This property is required for Schedule type 2 (Hours and specific days).
  * @property int $Division Division code
- * @property string $EndTime This is the end time of the schedule entry.
- * @property string $Hours The total number of hours for per day. Values is in 'HH:mm' format, eg : 08:00
+ * @property string $Employee Identifier of the employee
+ * @property string $EmployeeFullName Name of employee
+ * @property string $Employment Employment ID
+ * @property int $EmploymentNumber Employment number
+ * @property string $EndTime This is the end time of the work day. This property is for Schedule type 4 (Time frames per day)
+ * @property string $Hours Set the total number of hours for per day. This property is for Schedule type 3 (Hours per day). Values should be in 'HH:mm' format, eg : 08:00
  * @property string $ID Primary key
  * @property string $Modified Last modified date.
- * @property string $Modifier ID of modifier
+ * @property string $Modifier User ID of modifier.
  * @property string $ModifierFullName Name of modifier
  * @property string $Schedule The id of the schedule linked to this schedule entry.
- * @property int $ScheduleActivityType The activity of the schedule entry. 0 - Work; 1 - Pause
- * @property string $StartTime This is the start time of the schedule entry.
- * @property int $WeekNumber This is the week number.
+ * @property int $ScheduleType This is the schedule type id based on the Schedule. 1 - Hours and average days; 2 - Hours and specific days; 3 - Hours per day; 4 - Time frames per day
+ * @property string $StartTime This is the start time of the work day. This property is for Schedule type 4 (Time frames per day)
+ * @property int $WeekNumber This is the week number .
  */
 class SyncScheduleEntry extends Model
 {
@@ -32,19 +40,27 @@ class SyncScheduleEntry extends Model
 
     protected $fillable = [
         'Timestamp',
+        'Break',
+        'BreakEndTime',
+        'BreakStartTime',
         'Created',
         'Creator',
         'CreatorFullName',
         'Day',
+        'DayIsSelected',
         'Division',
+        'Employee',
+        'EmployeeFullName',
+        'Employment',
+        'EmploymentNumber',
         'EndTime',
         'Hours',
         'ID',
         'Modified',
         'Modifier',
         'ModifierFullName',
         'Schedule',
-        'ScheduleActivityType',
+        'ScheduleType',
         'StartTime',
         'WeekNumber',
     ];

src/Picqer/Financials/Exact/SyncShopOrderPurchasePlanning.php

@@ -0,0 +1,57 @@
+<?php
+
+namespace Picqer\Financials\Exact;
+
+/**
+ * Class SyncShopOrderPurchasePlanning.
+ *
+ * @see https://start.exactonline.nl/docs/HlpRestAPIResourcesDetails.aspx?name=SyncManufacturingShopOrderPurchasePlanning
+ *
+ * @property int $Timestamp Timestamp
+ * @property string $Created Creation date
+ * @property string $Creator User ID of creator
+ * @property string $CreatorFullName Name of creator
+ * @property int $Division Division code
+ * @property float $Factor Factor
+ * @property int $FactorType Conversion factor type between produced item and Subcontract purchase Unit
+ * @property string $ID Primary key
+ * @property string $Modified Last modified date
+ * @property string $Modifier User ID of modifier
+ * @property string $ModifierFullName Name of modifier
+ * @property string $PurchaseOrder Reference to PurchaseOrderLines
+ * @property int $PurchaseOrderNumber Number of the purchase order
+ * @property float $Quantity Quantity
+ * @property string $ShopOrder Reference to ShopOrders
+ * @property string $ShopOrderMaterialPlan Reference to ShopOrderMaterialPlans
+ * @property int $ShopOrderNumber Unique number to indentify the shop order
+ * @property string $ShopOrderRoutingStepPlan Reference to ShopOrderRoutingStepPlans
+ */
+class SyncShopOrderPurchasePlanning extends Model
+{
+    use Query\Findable;
+
+    protected $primaryKey = 'Timestamp';
+
+    protected $fillable = [
+        'Timestamp',
+        'Created',
+        'Creator',
+        'CreatorFullName',
+        'Division',
+        'Factor',
+        'FactorType',
+        'ID',
+        'Modified',
+        'Modifier',
+        'ModifierFullName',
+        'PurchaseOrder',
+        'PurchaseOrderNumber',
+        'Quantity',
+        'ShopOrder',
+        'ShopOrderMaterialPlan',
+        'ShopOrderNumber',
+        'ShopOrderRoutingStepPlan',
+    ];
+
+    protected $url = 'sync/Manufacturing/ShopOrderPurchasePlanning';
+}

src/Picqer/Financials/Exact/SyncShopOrderSubOrder.php

@@ -0,0 +1,55 @@
+<?php
+
+namespace Picqer\Financials\Exact;
+
+/**
+ * Class SyncShopOrderSubOrder.
+ *
+ * @see https://start.exactonline.nl/docs/HlpRestAPIResourcesDetails.aspx?name=SyncManufacturingShopOrderSubOrders
+ *
+ * @property int $Timestamp Timestamp
+ * @property string $Created Creation date
+ * @property string $Creator User ID of creator
+ * @property string $CreatorFullName Name of creator
+ * @property int $Division Division code
+ * @property string $ID Primary key
+ * @property int $Level Level of the sub shop order within the shop order structure
+ * @property string $Modified Last modified date
+ * @property string $Modifier User ID of modifier
+ * @property string $ModifierFullName Name of modifier
+ * @property string $ShopOrder Reference to ShopOrders for the current shop order
+ * @property string $ShopOrderMain Reference to ShopOrders for main shop order
+ * @property int $ShopOrderMainNumber Number of main shop order
+ * @property string $ShopOrderMaterialPlan Reference to ShopOrderMaterialPlans
+ * @property int $ShopOrderNumber Number of the current shop order
+ * @property string $ShopOrderParent Reference to ShopOrders for parent shop order
+ * @property int $ShopOrderParentNumber Number of parent shop order
+ */
+class SyncShopOrderSubOrder extends Model
+{
+    use Query\Findable;
+
+    protected $primaryKey = 'Timestamp';
+
+    protected $fillable = [
+        'Timestamp',
+        'Created',
+        'Creator',
+        'CreatorFullName',
+        'Division',
+        'ID',
+        'Level',
+        'Modified',
+        'Modifier',
+        'ModifierFullName',
+        'ShopOrder',
+        'ShopOrderMain',
+        'ShopOrderMainNumber',
+        'ShopOrderMaterialPlan',
+        'ShopOrderNumber',
+        'ShopOrderParent',
+        'ShopOrderParentNumber',
+    ];
+
+    protected $url = 'sync/Manufacturing/ShopOrderSubOrders';
+}

tests/ConnectionTest.php

@@ -89,12 +89,10 @@ public function testResponseIsLoggedIfAcquiringTokensFailed(): void
         $connection->get('crm/Accounts');
     }
 
-    public function endpointsThatDontUseDivisionInUrl(): array
+    public function endpointsThatDontUseDivisionInUrl(): \Generator
     {
-        return [
-            'System users endpoint' => ['system/Users'],
-            'Me endpoint'           => ['current/Me'],
-        ];
+        yield 'System users endpoint' => ['system/Users'];
+        yield 'Me endpoint'           => ['current/Me'];
     }
 
     private function createMockHandler(): MockHandler

tests/ModelTest.php

@@ -2,7 +2,6 @@
 
 namespace Picqer\Tests;
 
-use Generator;
 use PHPUnit\Framework\TestCase;
 use Picqer\Financials\Exact\Item;
 use Picqer\Financials\Exact\Query\Resultset;
@@ -12,7 +11,7 @@ class ModelTest extends TestCase
 {
     use MocksExactConnection;
 
-    public function testCanFindModel()
+    public function testCanFindModel(): void
     {
         $handler = $this->createMockHandlerUsingFixture('item.json');
         $connection = $this->createMockConnection($handler);
@@ -23,7 +22,7 @@ public function testCanFindModel()
         $this->assertEquals('00000000-0000-0000-0000-000000000000', $response->primaryKeyContent());
     }
 
-    public function testCanGetFirstModel()
+    public function testCanGetFirstModel(): void
     {
         $handler = $this->createMockHandlerUsingFixture('item.json');
         $connection = $this->createMockConnection($handler);
@@ -34,7 +33,7 @@ public function testCanGetFirstModel()
         $this->assertEquals('00000000-0000-0000-0000-000000000000', $response->primaryKeyContent());
     }
 
-    public function testCanGetModels()
+    public function testCanGetModels(): void
     {
         $handler = $this->createMockHandlerUsingFixture('items.json');
         $connection = $this->createMockConnection($handler);
@@ -45,18 +44,17 @@ public function testCanGetModels()
         $this->assertCount(2, $response);
     }
 
-    public function testCanGetModelsAsGenerator()
+    public function testCanGetModelsAsGenerator(): void
     {
         $handler = $this->createMockHandlerUsingFixture('items.json');
         $connection = $this->createMockConnection($handler);
 
         $response = (new Item($connection))->getAsGenerator();
 
-        $this->assertInstanceOf(Generator::class, $response);
-        $this->assertCount(2, $response);
+        $this->assertEquals(2, iterator_count($response));
     }
 
-    public function testCanFilterModels()
+    public function testCanFilterModels(): void
     {
         $handler = $this->createMockHandlerUsingFixture('items.json');
         $connection = $this->createMockConnection($handler);
@@ -67,18 +65,17 @@ public function testCanFilterModels()
         $this->assertCount(2, $response);
     }
 
-    public function testCanFilterModelsAsGenerator()
+    public function testCanFilterModelsAsGenerator(): void
     {
         $handler = $this->createMockHandlerUsingFixture('items.json');
         $connection = $this->createMockConnection($handler);
 
         $response = (new Item($connection))->filterAsGenerator('IsWebshopItem eq 0');
 
-        $this->assertInstanceOf(Generator::class, $response);
-        $this->assertCount(2, $response);
+        $this->assertEquals(2, iterator_count($response));
     }
 
-    public function testCanGetCollectionFromResult()
+    public function testCanGetCollectionFromResult(): void
     {
         $handler = $this->createMockHandlerUsingFixture('items.json');
         $connection = $this->createMockConnection($handler);
@@ -91,7 +88,7 @@ public function testCanGetCollectionFromResult()
         $this->assertCount(2, $collection);
     }
 
-    public function testCanGetCollectionFromResultAsGenerator()
+    public function testCanGetCollectionFromResultAsGenerator(): void
     {
         $handler = $this->createMockHandlerUsingFixture('items.json');
         $connection = $this->createMockConnection($handler);
@@ -100,18 +97,16 @@ public function testCanGetCollectionFromResultAsGenerator()
         $result = $connection->get($item->url(), []);
         $collection = $item->collectionFromResultAsGenerator($result);
 
-        $this->assertInstanceOf(Generator::class, $collection);
-        $this->assertCount(2, $collection);
+        $this->assertEquals(2, iterator_count($collection));
     }
 
-    public function testCanGetResultSet()
+    public function testCanGetResultSet(): void
     {
         $handler = $this->createMockHandler();
         $connection = $this->createMockConnection($handler);
-        $item = new Item($connection);
 
-        $resultset = (new Item($connection))->getResultSet();
+        $resultSet = (new Item($connection))->getResultSet();
 
-        $this->assertInstanceOf(Resultset::class, $resultset);
+        $this->assertInstanceOf(Resultset::class, $resultSet);
     }
 }