Merge pull request #5405 from nextcloud/chore/fix-little-typo

chore(SocialApi): Fix several small typos

Author: DerDreschner

lib/Cron/SocialUpdate.php

@@ -40,7 +40,7 @@ protected function run($argument) {
 		}
 
 		// update contacts with first available social media profile
-		$result = $this->social->updateAddressbooks($userId, $offsetBook, $offsetContact);
+		$result = $this->social->updateAddressBooks($userId, $offsetBook, $offsetContact);
 
 		if ($result->getStatus() === Http::STATUS_PARTIAL_CONTENT) {
 			// not finished; schedule a follow-up

lib/Service/SocialApiService.php

@@ -105,7 +105,7 @@ protected function addPhoto(array &$contact, string $imageType, string $photo) {
 
 
 	/**
-	 * Gets the addressbook of an addressbookId
+	 * Gets the address book of an addressBookId
 	 *
 	 * @param string $addressBookId the identifier of the addressbook
 	 * @param IManager|null $manager optional a ContactManager to use
@@ -136,12 +136,12 @@ protected function getAddressBook(string $addressBookId, ?IManager $manager = nu
 
 
 	/**
-	 * Retrieves and initiates all addressbooks from a user
+	 * Retrieves and initiates all address books from a user
 	 *
 	 * @param string $userId the user to query
 	 * @param IManager $manager the contact manager to load
 	 */
-	protected function registerAddressbooks($userId, IManager $manager) {
+	protected function registerAddressBooks($userId, IManager $manager) {
 		$coma = $this->serverContainer->get(ContactsManager::class);
 		$coma->setupContactsProvider($manager, $userId, $this->urlGen);
 		$this->manager = $manager;
@@ -150,30 +150,30 @@ protected function registerAddressbooks($userId, IManager $manager) {
 	/**
 	 * Retrieves social profile data for a contact and updates the entry
 	 *
-	 * @param string $addressbookId the addressbook identifier
+	 * @param string $addressBookId the address book identifier
 	 * @param string $contactId the contact identifier
 	 * @param string|null $network the social network to use (if unknown: take first match)
 	 *
 	 * @return JSONResponse an empty JSONResponse with respective http status code
 	 */
-	public function updateContact(string $addressbookId, string $contactId, ?string $network) : JSONResponse {
+	public function updateContact(string $addressBookId, string $contactId, ?string $network) : JSONResponse {
 		if (!$this->syncAllowedByAdmin()) {
 			return new JSONResponse([], Http::STATUS_FORBIDDEN);
 		}
 
-		$socialdata = null;
+		$socialData = null;
 		$imageType = null;
 		$urls = [];
 		$allConnectors = $this->socialProvider->getSocialConnectors();
 
 		try {
-			// get corresponding addressbook
-			$addressBook = $this->getAddressBook(urldecode($addressbookId));
+			// get corresponding address book
+			$addressBook = $this->getAddressBook(urldecode($addressBookId));
 			if (is_null($addressBook)) {
 				return new JSONResponse([], Http::STATUS_BAD_REQUEST);
 			}
 
-			// search contact in that addressbook, get social data
+			// search contact in that address book, get social data
 			$contacts = $addressBook->search($contactId, ['UID'], ['types' => true]);
 
 			if (!isset($contacts[0])) {
@@ -207,29 +207,29 @@ public function updateContact(string $addressbookId, string $contactId, ?string
 			foreach ($urls as $url) {
 				try {
 					$httpResult = $this->clientService->newClient()->get($url);
-					$socialdata = $httpResult->getBody();
+					$socialData = $httpResult->getBody();
 					$imageType = $httpResult->getHeader('content-type');
-					if (isset($socialdata) && !empty($imageType)) {
+					if (isset($socialData) && !empty($imageType)) {
 						break;
 					}
 				} catch (\Exception $e) {
 				}
 			}
 
-			if (!$socialdata || $imageType === null) {
+			if (!$socialData || $imageType === null) {
 				return new JSONResponse([], Http::STATUS_NOT_FOUND);
 			}
 			if (!in_array($imageType, self::ALLOWED_CONTENT_TYPES)) {
 				return new JSONResponse([], Http::STATUS_UNSUPPORTED_MEDIA_TYPE);
 			}
 
-			if (is_resource($socialdata)) {
-				$socialdata = stream_get_contents($socialdata);
+			if (is_resource($socialData)) {
+				$socialData = stream_get_contents($socialData);
 			}
 
-			$socialdata = $this->imageResizer->resizeImage($socialdata);
+			$socialData = $this->imageResizer->resizeImage($socialData);
 
-			if (!$socialdata) {
+			if (!$socialData) {
 				return new JSONResponse([], Http::STATUS_INTERNAL_SERVER_ERROR);
 			}
 
@@ -238,7 +238,7 @@ public function updateContact(string $addressbookId, string $contactId, ?string
 			$changes['URI'] = $contact['URI'];
 			$changes['VERSION'] = $contact['VERSION'];
 
-			$this->addPhoto($changes, $imageType, base64_encode($socialdata));
+			$this->addPhoto($changes, $imageType, base64_encode($socialData));
 
 			if (isset($changes['PHOTO'], $contact['PHOTO']) && $changes['PHOTO'] === $contact['PHOTO']) {
 				return new JSONResponse([], Http::STATUS_NOT_MODIFIED);
@@ -252,7 +252,7 @@ public function updateContact(string $addressbookId, string $contactId, ?string
 	}
 
 	/**
-	 * checks an addressbook is existing
+	 * checks an address book is existing
 	 *
 	 * @param string $searchBookId the UID of the addressbook to verify
 	 * @param string $userId the user that should have access
@@ -267,7 +267,7 @@ public function existsAddressBook(string $searchBookId, string $userId): bool {
 	}
 
 	/**
-	 * checks a contact exists in an addressbook
+	 * checks a contact exists in an address book
 	 *
 	 * @param string $searchContactId the UID of the contact to verify
 	 * @param string $searchBookId the UID of the addressbook to look in
@@ -291,7 +291,7 @@ public function existsContact(string $searchContactId, string $searchBookId, str
 
 	/**
 	 * Stores the result of social avatar updates for each contact
-	 * (used during batch updates in updateAddressbooks)
+	 * (used during batch updates in updateAddressBooks)
 	 *
 	 * @param array $report where the results are added
 	 * @param string $entry the element to add
@@ -350,7 +350,7 @@ protected function sortContacts(array $a, array $b) {
 	}
 
 	/**
-	 * Updates social profile data for all contacts of an addressbook
+	 * Updates social profile data for all contacts of an address book
 	 *
 	 * @param string $userId the address book owner
 	 * @param string|null $offsetBook the addressbook to resume from
@@ -359,7 +359,7 @@ protected function sortContacts(array $a, array $b) {
 	 *
 	 * @return JSONResponse JSONResponse with the list of changed and failed contacts
 	 */
-	public function updateAddressbooks(string $userId, ?string $offsetBook = null, ?string $offsetContact = null, ?string $network = null) : JSONResponse {
+	public function updateAddressBooks(string $userId, ?string $offsetBook = null, ?string $offsetContact = null, ?string $network = null) : JSONResponse {
 		if (!$this->backgroundSyncEnabled($userId)) {
 			return new JSONResponse([], Http::STATUS_FORBIDDEN);
 		}
@@ -368,8 +368,8 @@ public function updateAddressbooks(string $userId, ?string $offsetBook = null, ?
 		$response = [];
 		$startTime = $this->timeFactory->getTime();
 
-		// get corresponding addressbook
-		$this->registerAddressbooks($userId, $this->manager);
+		// get corresponding address book
+		$this->registerAddressBooks($userId, $this->manager);
 		$addressBooks = $this->manager->getUserAddressBooks();
 		usort($addressBooks, [$this, 'sortAddressBooks']); // make sure the order stays the same in consecutive calls
 
@@ -388,7 +388,8 @@ public function updateAddressbooks(string $userId, ?string $offsetBook = null, ?
 				$offsetBook = null;
 			}
 
-			// get contacts in that addressbook
+			// get contacts in that address book
+			/** @noinspection SpellCheckingInspection */
 			$contacts = $addressBook->search('', ['X-SOCIALPROFILE'], ['types' => true]);
 			usort($contacts, [$this, 'sortContacts']); // make sure the order stays the same in consecutive calls
 

tests/unit/Service/SocialApiServiceTest.php

@@ -606,7 +606,7 @@ public function testUpdateAddressbooks($syncAllowedByAdmin, $bgSyncEnabledByUser
 			->expects($this->never())
 			->method('getSocialConnector');
 
-		$result = $this->service->updateAddressbooks('mrstest');
+		$result = $this->service->updateAddressBooks('mrstest');
 
 		$this->assertEquals($expected, $result->getStatus());
 
@@ -637,7 +637,7 @@ public function testUpdateAddressbooksTimeout() {
 
 		$this->setupAddressbooks();
 
-		$result = $this->service->updateAddressbooks('msstest');
+		$result = $this->service->updateAddressBooks('msstest');
 
 		$this->assertEquals(Http::STATUS_PARTIAL_CONTENT, $result->getStatus());
 
@@ -665,7 +665,7 @@ public function testUpdateAddressbooksContinued($syncAllowedByAdmin, $bgSyncEnab
 
 		$this->setupAddressbooks();
 
-		$result = $this->service->updateAddressbooks('mrstest', 'contacts2', '22222222-2222-2222-2222-222222222222');
+		$result = $this->service->updateAddressBooks('mrstest', 'contacts2', '22222222-2222-2222-2222-222222222222');
 
 		$this->assertEquals($expected, $result->getStatus());