Move things

README.md

@@ -1,28 +1,6 @@
 # PageSeed Api
 
-This library provides a simple way to interact with the Google PageSpeed Insights API.
-
-```php
-use PageSpeed\Api\Analysis\Category;use PageSpeed\Api\PageSpeedApi;
-
-$api = new PageSpeedApi('YOUR_API');
-
-$analysis = $api->analyse('https://www.example.com');
-
-// LightHouse scores
-echo $audit->getPerformancesScore(); // 100
-echo $audit->getAccessibilityScore(); // 88
-echo $audit->getBestPracticesScore(); // 100
-echo $audit->getSeoScore(); // 90
-
-// Loading Experience metrics
-echo $audit->getLargestContentfulPaint(); // 
-echo $audit->getInteractiveToNextPaint(); // 
-echo $audit->getCumulativeLayoutShift(); // 
-echo $audit->getFirstContentfulPaint(); // 
-echo $audit->getFirstInputDelay(); // 
-echo $audit->getTimeToFirstByte(); // 
-```
+Google PageSpeed Insights API wrapper for PHP.
 
 ## Installation
 
@@ -32,54 +10,49 @@ composer require smnandre/pagespeed-api
 
 ## Usage
 
-
-### PageSpeed Api Key
+### Run an analysis
 
 ```php
-use PageSpeed\Api\PageSpeedApi;
+use PageSpeed\Api\Analysis\Category;use PageSpeed\Api\PageSpeedApi;
 
 $api = new PageSpeedApi('YOUR_API');
-```
-
-### Parameters
-
-#### Audit Strategy	
 
-```php
-// Mobile strategy (default)
-$audit = $api->analyse('https://example.com/', 'mobile');
-
-// Desktop strategy
-$audit = $api->analyse('https://example.com/', 'desktop');
+$analysis = $api->analyse('https://www.example.com');
 ```
 
-#### Analysis Categories
-
-
-### Response 
-
-#### Analysis
+### Get the results
 
+```php
 
-#### Loading Experience
+// LightHouse scores
+$analysis->getAuditScores();
+// 'performance' => 100,
+// 'accessibility' => 88,
+// 'best-practices' => 100,
+// 'seo' => 90
 
+// Loading Experience metrics
+$analysis->getLoadingMetrics();
 
-#### Original Loading Experience
+// Origin Loading Experience metrics
+$analysis->getOriginalLoadingMetrics();
+```
 
-.. 
+### Parameters
 
-#### Lighthouse
+#### Strategy	
 
 ```php
-use PageSpeed\Api\PageSpeedApi;
+// Mobile strategy (default)
+$analysis = $api->analyse('https://example.com/', 'mobile');
 
-$api = new PageSpeedApi();
+// Desktop strategy
+$analysis = $api->analyse('https://example.com/', 'desktop');
+```
 
-$audit = $api->audit('https://www.example.com');
+#### Locale
 
-echo $audit->getScore();
-echo $audit->performanceScore();
-echo $audit->getAccessibilityScore();
-echo $audit->getBestPracticesScore();
-echo $audit->getSeoScore();
+```php
+$analysis = $api->analyse('https://example.com/', 'mobile', 'fr');
 ```
+

src/Analysis.php

@@ -13,6 +13,7 @@
 
 namespace PageSpeed\Api;
 
+use DateTimeImmutable;
 use PageSpeed\Api\Analysis\LighthouseResult;
 use PageSpeed\Api\Analysis\LoadingExperience;
 use Webmozart\Assert\Assert;
@@ -65,11 +66,37 @@ public static function create(array $values): self
         );
     }
 
+    public function getId(): string
+    {
+        return $this->id;
+    }
+
     /**
      * @return array<string, int>
      */
     public function getAuditScores(): array
     {
         return $this->lighthouseResult->getScores();
     }
+
+    /**
+     * @return array<string, mixed>|null
+     */
+    public function getLoadingMetrics(): ?array
+    {
+        return $this->loadingExperience?->getMetrics();
+    }
+
+    /**
+     * @return array<string, mixed>|null
+     */
+    public function getOriginalLoadingMetrics(): ?array
+    {
+        return $this->originLoadingExperience?->getMetrics();
+    }
+
+    public function getAnalysisUtcDateTime(): DateTimeImmutable
+    {
+        return new DateTimeImmutable($this->analysisUTCTimestamp);
+    }
 }

src/Analysis/LoadingExperience.php

@@ -18,7 +18,7 @@
 final readonly class LoadingExperience
 {
     /**
-     * @param array<string, mixed> $metrics
+     * @param array<string, array<string, mixed>> $metrics
      */
     public function __construct(
         public string $id,
@@ -52,4 +52,13 @@ public static function create(array $values): self
             $values['initial_url'],
         );
     }
+
+    /**
+     * @return array<string, string>
+     */
+    public function getMetrics(): array
+    {
+        /** @phpstan-ignore-next-line */
+        return array_map(fn (array $metric) => $metric['category'], $this->metrics);
+    }
 }

tests/Fixtures/AnalysisFactory.php → tests/Fixtures/Factory/AnalysisFactory.php

@@ -11,7 +11,7 @@
  * file that was distributed with this source code.
  */
 
-namespace PageSpeed\Api\Tests\Fixtures;
+namespace PageSpeed\Api\Tests\Fixtures\Factory;
 
 class AnalysisFactory
 {

tests/Fixtures/ConfigSettingsFactory.php → tests/Fixtures/Factory/ConfigSettingsFactory.php

@@ -11,7 +11,7 @@
  * file that was distributed with this source code.
  */
 
-namespace PageSpeed\Api\Tests\Fixtures;
+namespace PageSpeed\Api\Tests\Fixtures\Factory;
 
 class ConfigSettingsFactory
 {

tests/Fixtures/EnvironmentFactory.php → tests/Fixtures/Factory/EnvironmentFactory.php

@@ -11,7 +11,7 @@
  * file that was distributed with this source code.
  */
 
-namespace PageSpeed\Api\Tests\Fixtures;
+namespace PageSpeed\Api\Tests\Fixtures\Factory;
 
 class EnvironmentFactory
 {

tests/Fixtures/LighthouseCategoryResultFactory.php → tests/Fixtures/Factory/LighthouseCategoryResultFactory.php

@@ -11,7 +11,7 @@
  * file that was distributed with this source code.
  */
 
-namespace PageSpeed\Api\Tests\Fixtures;
+namespace PageSpeed\Api\Tests\Fixtures\Factory;
 
 class LighthouseCategoryResultFactory
 {

tests/Fixtures/LighthouseResultFactory.php → tests/Fixtures/Factory/LighthouseResultFactory.php

@@ -11,7 +11,7 @@
  * file that was distributed with this source code.
  */
 
-namespace PageSpeed\Api\Tests\Fixtures;
+namespace PageSpeed\Api\Tests\Fixtures\Factory;
 
 class LighthouseResultFactory
 {

tests/Fixtures/LoadingExperienceFactory.php → tests/Fixtures/Factory/LoadingExperienceFactory.php

@@ -11,7 +11,7 @@
  * file that was distributed with this source code.
  */
 
-namespace PageSpeed\Api\Tests\Fixtures;
+namespace PageSpeed\Api\Tests\Fixtures\Factory;
 
 class LoadingExperienceFactory
 {