Rename Version::getProject() to fetchProject(), Deprecate Version::getProject()

README.md

@@ -291,8 +291,8 @@ $version = $spigotClient->getVersion(352711);
 // get the ID of the project this version belongs to
 $projectId = $version->getProjectId();
 
-// get the project as a Project wrapper
-$project = $version->getProject();
+// fetch the project from the API as a Project wrapper (sends a request)
+$project = $version->fetchProject();
 ```
 
 ## Updating the generated code

src/Client/Version.php

@@ -41,13 +41,29 @@ public function getProjectId(): int
     }
 
     /**
-     * Get the project this version belongs to.
+     * Fetch the project this version belongs to from the API.
+     *
+     * This sends a request to the SpigotMC API every time it is called. The result is not cached.
      *
      * @return Project
      * @throws ApiException
      */
-    public function getProject(): Project
+    public function fetchProject(): Project
     {
         return $this->client->getProject($this->getProjectId());
     }
-}
+
+    /**
+     * Fetch the project this version belongs to from the API.
+     *
+     * This sends a request to the SpigotMC API every time it is called. The result is not cached.
+     *
+     * @deprecated Use {@see fetchProject()} instead. Methods that send a request to the API are prefixed with "fetch".
+     * @return Project
+     * @throws ApiException
+     */
+    public function getProject(): Project
+    {
+        return $this->fetchProject();
+    }
+}

tests/Integration/Client/ClientTest.php

@@ -285,7 +285,7 @@ public function testGetVersionsFromProject(): void
         foreach ($versions as $version) {
             $this->assertNotNull($version);
             $this->assertInstanceOf(Version::class, $version);
-            $this->assertEquals($project, $version->getProject());
+            $this->assertEquals($project, $version->fetchProject());
         }
     }
 

tests/Integration/Client/VersionTest.php

@@ -29,10 +29,10 @@ public function testGetProjectId(): void
     /**
      * @throws ApiException
      */
-    public function testGetProject(): void
+    public function testFetchProject(): void
     {
         $project = $this->apiClient->getProject(6245);
-        $this->assertEquals($project, $this->version->getProject());
+        $this->assertEquals($project, $this->version->fetchProject());
     }
 
 }

tests/Unit/Client/VersionTest.php

@@ -52,18 +52,34 @@ public function testGetProjectId(): void
     /**
      * @throws ApiException
      */
-    public function testGetProject(): void
+    public function testFetchProject(): void
     {
         $handler = new MockHandler([
             new Response(200, [], file_get_contents(__DIR__ . "/Fixtures/getResource.json")),
         ]);
         $this->apiClient->setHttpClient(new Client(['handler' => HandlerStack::create($handler)]));
         $version = new Version($this->apiClient, $this->getResourceUpdateModel());
 
-        $project = $version->getProject();
+        $project = $version->fetchProject();
         $this->assertNotNull($project);
         $this->assertEquals(57242, $project->getData()->getId());
         $this->assertEquals("spark", $project->getData()->getTitle());
     }
 
+    /**
+     * @throws ApiException
+     */
+    public function testDeprecatedGetProjectFetchesProject(): void
+    {
+        $handler = new MockHandler([
+            new Response(200, [], file_get_contents(__DIR__ . "/Fixtures/getResource.json")),
+        ]);
+        $this->apiClient->setHttpClient(new Client(['handler' => HandlerStack::create($handler)]));
+        $version = new Version($this->apiClient, $this->getResourceUpdateModel());
+
+        $project = $version->getProject();
+        $this->assertEquals(57242, $project->getId());
+        $this->assertSame(0, $handler->count());
+    }
+
 }