Fix tutorial name selection and fix pokeballs not being decreased when catching pokemon (#835)

Author: Gegy

library/src/main/java/com/pokegoapi/api/map/pokemon/CatchablePokemon.java

@@ -40,6 +40,7 @@
 import com.google.protobuf.InvalidProtocolBufferException;
 import com.pokegoapi.api.PokemonGo;
 import com.pokegoapi.api.inventory.Item;
+import com.pokegoapi.api.inventory.ItemBag;
 import com.pokegoapi.api.inventory.Pokeball;
 import com.pokegoapi.api.listener.PokemonListener;
 import com.pokegoapi.api.map.pokemon.encounter.DiskEncounterResult;
@@ -530,10 +531,13 @@ public CatchResult catchPokemon(double normalizedHitPosition,
 									int amount, int razberriesLimit)
 			throws LoginFailedException, CaptchaActiveException, RemoteServerException {
 
-		Item razzberriesInventory = api.getInventories().getItemBag().getItem(ItemId.ITEM_RAZZ_BERRY);
+		ItemBag itemBag = api.getInventories().getItemBag();
+		Item razzberriesInventory = itemBag.getItem(ItemId.ITEM_RAZZ_BERRY);
 		int razzberriesCountInventory = razzberriesInventory.getCount();
 		int razberries = 0;
 		int numThrows = 0;
+		Item pokeballItem = itemBag.getItem(type.getBallType());
+		int pokeballCount = pokeballItem.getCount();
 		CatchResult result;
 
 		if (razzberriesCountInventory < razberriesLimit) {
@@ -556,6 +560,13 @@ && useItem(ItemId.ITEM_RAZZ_BERRY).getSuccess()) {
 				break;
 			}
 
+			if (result.getStatus() != CatchStatus.CATCH_ERROR) {
+				pokeballItem.setCount(--pokeballCount);
+				if (pokeballCount <= 0) {
+					break;
+				}
+			}
+
 			// continue for the following cases:
 			// CatchStatus.CATCH_ESCAPE
 			// CatchStatus.CATCH_MISSED
@@ -589,6 +600,7 @@ && useItem(ItemId.ITEM_RAZZ_BERRY).getSuccess()) {
 			}
 
 			numThrows++;
+
 		}
 		while (amount < 0 || numThrows < amount);
 

library/src/main/java/com/pokegoapi/api/player/PlayerProfile.java

@@ -99,8 +99,8 @@ public class PlayerProfile {
 
 	/**
 	 * @param api the api
-	 * @throws LoginFailedException when the auth is invalid
-	 * @throws RemoteServerException when the server is down/having issues
+	 * @throws LoginFailedException   when the auth is invalid
+	 * @throws RemoteServerException  when the server is down/having issues
 	 * @throws CaptchaActiveException if a captcha is active and the message can't be sent
 	 */
 	public PlayerProfile(PokemonGo api) throws LoginFailedException, CaptchaActiveException, RemoteServerException {
@@ -111,8 +111,8 @@ public PlayerProfile(PokemonGo api) throws LoginFailedException, CaptchaActiveEx
 	/**
 	 * Updates the player profile with the latest data.
 	 *
-	 * @throws LoginFailedException when the auth is invalid
-	 * @throws RemoteServerException when the server is down/having issues
+	 * @throws LoginFailedException   when the auth is invalid
+	 * @throws RemoteServerException  when the server is down/having issues
 	 * @throws CaptchaActiveException if a captcha is active and the message can't be sent
 	 */
 	public void updateProfile() throws RemoteServerException, CaptchaActiveException, LoginFailedException {
@@ -174,9 +174,9 @@ public void updateProfile(PlayerData playerData) {
 	/**
 	 * Performs a GET_PLAYER_PROFILE request.
 	 *
-	 * @throws RemoteServerException if the server has an issue or an invalid request is sent
+	 * @throws RemoteServerException  if the server has an issue or an invalid request is sent
 	 * @throws CaptchaActiveException if a captcha is active, and the message cannot be sent
-	 * @throws LoginFailedException if login fails
+	 * @throws LoginFailedException   if login fails
 	 */
 	public void getProfile() throws RemoteServerException, CaptchaActiveException, LoginFailedException {
 		GetPlayerProfileMessage profileMessage = GetPlayerProfileMessage.newBuilder()
@@ -208,9 +208,9 @@ public void getProfile() throws RemoteServerException, CaptchaActiveException, L
 	 *
 	 * @param level the trainer level that you want to accept the rewards for
 	 * @return a PlayerLevelUpRewards object containing information about the items rewarded and unlocked for this level
-	 * @throws LoginFailedException when the auth is invalid
-	 * @throws RemoteServerException when the server is down/having issues
-	 * @throws CaptchaActiveException if a captcha is active and the message can't be sent
+	 * @throws LoginFailedException       when the auth is invalid
+	 * @throws RemoteServerException      when the server is down/having issues
+	 * @throws CaptchaActiveException     if a captcha is active and the message can't be sent
 	 * @throws InsufficientLevelException if you have not yet reached the desired level
 	 * @see PlayerLevelUpRewards
 	 */
@@ -241,7 +241,7 @@ public PlayerLevelUpRewards acceptLevelUpRewards(int level)
 	/**
 	 * Add currency.
 	 *
-	 * @param name the name
+	 * @param name   the name
 	 * @param amount the amount
 	 * @throws InvalidCurrencyException the invalid currency exception
 	 */
@@ -258,8 +258,8 @@ public void addCurrency(String name, int amount) throws InvalidCurrencyException
 	/**
 	 * Check and equip badges.
 	 *
-	 * @throws LoginFailedException when the auth is invalid
-	 * @throws RemoteServerException When a buffer exception is thrown
+	 * @throws LoginFailedException   when the auth is invalid
+	 * @throws RemoteServerException  When a buffer exception is thrown
 	 * @throws CaptchaActiveException if a captcha is active and the message can't be sent
 	 * @deprecated use getMedals, which uses common requests to check for badges
 	 */
@@ -297,8 +297,8 @@ public int getCurrency(Currency currency) {
 	 *
 	 * @param response the response to get badges from
 	 * @throws CaptchaActiveException if a captcha is active and the message can't be sent
-	 * @throws LoginFailedException if login fails
-	 * @throws RemoteServerException if the server has an issue
+	 * @throws LoginFailedException   if login fails
+	 * @throws RemoteServerException  if the server has an issue
 	 */
 	public void updateAwardedMedals(CheckAwardedBadgesResponse response)
 			throws CaptchaActiveException, LoginFailedException, RemoteServerException {
@@ -432,8 +432,8 @@ public boolean hasBuddy() {
 	 *
 	 * @param pokemon the pokemon to set as your buddy
 	 * @return if this task was successfull
-	 * @throws LoginFailedException when the auth is invalid
-	 * @throws RemoteServerException when the server is down/having issues
+	 * @throws LoginFailedException   when the auth is invalid
+	 * @throws RemoteServerException  when the server is down/having issues
 	 * @throws CaptchaActiveException if a captcha is active and the message can't be sent
 	 */
 	public boolean setBuddy(Pokemon pokemon) throws CaptchaActiveException, LoginFailedException, RemoteServerException {
@@ -454,8 +454,8 @@ public boolean setBuddy(Pokemon pokemon) throws CaptchaActiveException, LoginFai
 	/**
 	 * Set the account to legal screen in order to receive valid response
 	 *
-	 * @throws LoginFailedException when the auth is invalid
-	 * @throws RemoteServerException when the server is down/having issues
+	 * @throws LoginFailedException   when the auth is invalid
+	 * @throws RemoteServerException  when the server is down/having issues
 	 * @throws CaptchaActiveException if a captcha is active and the message can't be sent
 	 */
 	public void activateAccount() throws LoginFailedException, CaptchaActiveException, RemoteServerException {
@@ -465,8 +465,8 @@ public void activateAccount() throws LoginFailedException, CaptchaActiveExceptio
 	/**
 	 * Setup an avatar for the current account
 	 *
-	 * @throws LoginFailedException when the auth is invalid
-	 * @throws RemoteServerException when the server is down/having issues
+	 * @throws LoginFailedException   when the auth is invalid
+	 * @throws RemoteServerException  when the server is down/having issues
 	 * @throws CaptchaActiveException if a captcha is active and the message can't be sent
 	 */
 	public void setupAvatar() throws LoginFailedException, CaptchaActiveException, RemoteServerException {
@@ -517,8 +517,8 @@ public void setupAvatar() throws LoginFailedException, CaptchaActiveException, R
 	/**
 	 * Encounter tutorial complete. In other words, catch the first Pokémon
 	 *
-	 * @throws LoginFailedException when the auth is invalid
-	 * @throws RemoteServerException when the server is down/having issues
+	 * @throws LoginFailedException   when the auth is invalid
+	 * @throws RemoteServerException  when the server is down/having issues
 	 * @throws CaptchaActiveException if a captcha is active and the message can't be sent
 	 */
 	public void encounterTutorialComplete() throws LoginFailedException, CaptchaActiveException, RemoteServerException {
@@ -558,23 +558,23 @@ public void encounterTutorialComplete() throws LoginFailedException, CaptchaActi
 	/**
 	 * Setup an user name for our account
 	 *
-	 * @throws LoginFailedException when the auth is invalid
-	 * @throws RemoteServerException when the server is down/having issues
+	 * @throws LoginFailedException   when the auth is invalid
+	 * @throws RemoteServerException  when the server is down/having issues
 	 * @throws CaptchaActiveException if a captcha is active and the message can't be sent
 	 */
-	public void claimCodeName() throws LoginFailedException, CaptchaActiveException, RemoteServerException {
-		claimCodeName(null);
+	public String claimCodeName() throws LoginFailedException, CaptchaActiveException, RemoteServerException {
+		return claimCodeName(null);
 	}
 
 	/**
 	 * Setup an user name for our account
 	 *
 	 * @param lastFailure the last name used that was already taken; null for first try.
-	 * @throws LoginFailedException when the auth is invalid
-	 * @throws RemoteServerException when the server is down/having issues
+	 * @throws LoginFailedException   when the auth is invalid
+	 * @throws RemoteServerException  when the server is down/having issues
 	 * @throws CaptchaActiveException if a captcha is active and the message can't be sent
 	 */
-	public void claimCodeName(String lastFailure)
+	public String claimCodeName(String lastFailure)
 			throws LoginFailedException, CaptchaActiveException, RemoteServerException {
 		if (getPlayerData().getRemainingCodenameClaims() <= 0) {
 			throw new RuntimeException("You have no remaining codename claims!");
@@ -602,41 +602,38 @@ public void claimCodeName(String lastFailure)
 		String updatedCodename = null;
 		try {
 			ClaimCodenameResponse claimCodenameResponse = ClaimCodenameResponse.parseFrom(request.getData());
-			if (claimCodenameResponse.getStatus() == ClaimCodenameResponse.Status.SUCCESS) {
-				updatedCodename = claimCodenameResponse.getCodename();
-			} else {
-				claimCodeName(name);
+			if (claimCodenameResponse.getStatus() != ClaimCodenameResponse.Status.SUCCESS) {
+				return claimCodeName(name);
 			}
+			updatedCodename = claimCodenameResponse.getCodename();
+
 			if (claimCodenameResponse.hasUpdatedPlayer()) {
 				updateProfile(claimCodenameResponse.getUpdatedPlayer());
 			}
-		} catch (InvalidProtocolBufferException e) {
-			throw new RemoteServerException(e);
-		}
 
-		if (updatedCodename != null) {
-			markTutorial(TutorialStateOuterClass.TutorialState.NAME_SELECTION);
+			if (updatedCodename != null) {
+				markTutorial(TutorialStateOuterClass.TutorialState.NAME_SELECTION);
 
-			final GetPlayerMessage getPlayerReqMsg = GetPlayerMessage.newBuilder()
-					.setPlayerLocale(playerLocale.getPlayerLocale())
-					.build();
-			request = new ServerRequest(RequestType.GET_PLAYER, getPlayerReqMsg);
+				final GetPlayerMessage getPlayerReqMsg = GetPlayerMessage.newBuilder()
+						.setPlayerLocale(playerLocale.getPlayerLocale())
+						.build();
+				request = new ServerRequest(RequestType.GET_PLAYER, getPlayerReqMsg);
 
-			api.getRequestHandler().sendServerRequests(request.withCommons());
+				api.getRequestHandler().sendServerRequests(request.withCommons());
 
-			try {
 				updateProfile(GetPlayerResponse.parseFrom(request.getData()));
-			} catch (InvalidProtocolBufferException e) {
-				throw new RemoteServerException(e);
 			}
+		} catch (InvalidProtocolBufferException e) {
+			throw new RemoteServerException(e);
 		}
+		return updatedCodename;
 	}
 
 	/**
 	 * The last step, mark the last tutorial state as completed
 	 *
-	 * @throws LoginFailedException when the auth is invalid
-	 * @throws RemoteServerException when the server is down/having issues
+	 * @throws LoginFailedException   when the auth is invalid
+	 * @throws RemoteServerException  when the server is down/having issues
 	 * @throws CaptchaActiveException if a captcha is active and the message can't be sent
 	 */
 	public void firstTimeExperienceComplete()
@@ -674,4 +671,4 @@ private static String randomCodenameGenerator() {
 		}
 		return sb.toString();
 	}
-}
+}