General improvements and fixes (#820)

* Improve common requests, add new common request handling, add medal and buddy handling & new listeners for buddies, medals and level ups

* Fix PokemonGo#checkChallenge accepting empty challenge URLs

* Add path utils and example to move from one point to another at the given speed

* Fix multiple captchas being received

Author: Gegy

library/src/main/java/com/pokegoapi/api/PokemonGo.java

@@ -23,8 +23,6 @@
 import POGOProtos.Networking.Requests.RequestTypeOuterClass;
 import POGOProtos.Networking.Requests.RequestTypeOuterClass.RequestType;
 import POGOProtos.Networking.Responses.CheckChallengeResponseOuterClass.CheckChallengeResponse;
-import POGOProtos.Networking.Responses.DownloadSettingsResponseOuterClass.DownloadSettingsResponse;
-import POGOProtos.Networking.Responses.GetInventoryResponseOuterClass.GetInventoryResponse;
 import POGOProtos.Networking.Responses.VerifyChallengeResponseOuterClass.VerifyChallengeResponse;
 import com.google.protobuf.ByteString;
 import com.google.protobuf.InvalidProtocolBufferException;
@@ -36,6 +34,7 @@
 import com.pokegoapi.api.listener.Listener;
 import com.pokegoapi.api.listener.LoginListener;
 import com.pokegoapi.api.map.Map;
+import com.pokegoapi.api.map.Point;
 import com.pokegoapi.api.player.PlayerProfile;
 import com.pokegoapi.api.settings.Settings;
 import com.pokegoapi.auth.CredentialProvider;
@@ -188,9 +187,9 @@ public void login(CredentialProvider credentialProvider)
 		}
 		this.credentialProvider = credentialProvider;
 		startTime = currentTimeMillis();
-		playerProfile = new PlayerProfile(this);
-		settings = new Settings(this);
 		inventories = new Inventories(this);
+		settings = new Settings(this);
+		playerProfile = new PlayerProfile(this);
 
 		initialize();
 
@@ -247,15 +246,7 @@ private void initialize() throws RemoteServerException, CaptchaActiveException,
 	 */
 	private void fireRequestBlock(ServerRequest request)
 			throws RemoteServerException, CaptchaActiveException, LoginFailedException {
-		ServerRequest[] requests = CommonRequests.fillRequest(request, this);
-
-		getRequestHandler().sendServerRequests(requests);
-		try {
-			inventories.updateInventories(GetInventoryResponse.parseFrom(requests[3].getData()));
-			settings.updateSettings(DownloadSettingsResponse.parseFrom(requests[5].getData()));
-		} catch (InvalidProtocolBufferException e) {
-			throw new RemoteServerException();
-		}
+		getRequestHandler().sendServerRequests(request.withCommons());
 	}
 
 	/**
@@ -540,10 +531,17 @@ public String checkChallenge()
 				AsyncHelper.toBlocking(getRequestHandler().sendAsyncServerRequests(request));
 		CheckChallengeResponse response = CheckChallengeResponse.parseFrom(responseData);
 		String newChallenge = response.getChallengeUrl();
-		if (newChallenge != null && newChallenge.length() > 0) {
+		if (response.getShowChallenge() && newChallenge != null && newChallenge.length() > 0) {
 			updateChallenge(newChallenge, true);
 			return newChallenge;
 		}
 		return null;
 	}
+
+	/**
+	 * @return the current player position in Point form
+	 */
+	public Point getPoint() {
+		return new Point(this.getLatitude(), this.getLongitude());
+	}
 }

library/src/main/java/com/pokegoapi/api/listener/PlayerListener.java

@@ -0,0 +1,27 @@
+package com.pokegoapi.api.listener;
+
+import com.pokegoapi.api.PokemonGo;
+import com.pokegoapi.api.player.Medal;
+import com.pokegoapi.api.player.PlayerProfile;
+
+/**
+ * Listener for all player related events.
+ */
+public interface PlayerListener extends Listener {
+	/**
+	 * Called when the player levels up
+	 * @param api the current api instance
+	 * @param oldLevel the old player level
+	 * @param newLevel the new player level
+	 * @return true if you want to accept level up rewards
+	 */
+	boolean onLevelUp(PokemonGo api, int oldLevel, int newLevel);
+
+	/**
+	 * Called when a new medal is awarded or leveled up for the current player
+	 * @param api the current api
+	 * @param profile the player receiving this medal
+	 * @param medal the medal awarded
+	 */
+	void onMedalAwarded(PokemonGo api, PlayerProfile profile, Medal medal);
+}

library/src/main/java/com/pokegoapi/api/listener/PokemonListener.java

@@ -1,6 +1,7 @@
 package com.pokegoapi.api.listener;
 
 import POGOProtos.Enums.EncounterTypeOuterClass.EncounterType;
+import POGOProtos.Enums.PokemonFamilyIdOuterClass.PokemonFamilyId;
 import com.pokegoapi.api.PokemonGo;
 import com.pokegoapi.api.inventory.Pokeball;
 import com.pokegoapi.api.map.pokemon.CatchablePokemon;
@@ -36,4 +37,12 @@ public interface PokemonListener extends Listener {
 	 * @return true to abort the capture and false to retry
 	 */
 	boolean onCatchEscape(PokemonGo api, CatchablePokemon pokemon, Pokeball pokeball, int throwCount);
+
+	/**
+	 * Called when your buddy pokemon finds candies
+	 * @param api the current api
+	 * @param family the candy family type
+	 * @param candyCount the amount of candies found
+	 */
+	void onBuddyFindCandy(PokemonGo api, PokemonFamilyId family, int candyCount);
 }

library/src/main/java/com/pokegoapi/api/map/Point.java

@@ -39,4 +39,9 @@ public Point(SpawnPointOuterClass.SpawnPoint spawnpoint) {
 		this.latitude = spawnpoint.getLatitude();
 		this.longitude = spawnpoint.getLongitude();
 	}
+
+	@Override
+	public String toString() {
+		return this.latitude + ", " + this.longitude;
+	}
 }

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

@@ -0,0 +1,58 @@
+/*
+ *     This program is free software: you can redistribute it and/or modify
+ *     it under the terms of the GNU General Public License as published by
+ *     the Free Software Foundation, either version 3 of the License, or
+ *     (at your option) any later version.
+ *
+ *     This program is distributed in the hope that it will be useful,
+ *     but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *     GNU General Public License for more details.
+ *
+ *     You should have received a copy of the GNU General Public License
+ *     along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+package com.pokegoapi.api.player;
+
+import POGOProtos.Data.PlayerBadgeOuterClass.PlayerBadge;
+import POGOProtos.Enums.BadgeTypeOuterClass.BadgeType;
+import lombok.Getter;
+import lombok.Setter;
+
+public class Medal {
+	@Getter
+	@Setter
+	private int rank;
+	@Getter
+	private BadgeType type;
+
+	@Getter
+	private final int startValue;
+	@Getter
+	private final double currentValue;
+	@Getter
+	private final int endValue;
+
+	/**
+	 * Creates a Medal with a PlayerBadge proto
+	 * @param badge the proto to inititialize with
+	 */
+	public Medal(PlayerBadge badge) {
+		this.type = badge.getBadgeType();
+		this.rank = badge.getRank();
+		this.startValue = badge.getStartValue();
+		this.currentValue = badge.getCurrentValue();
+		this.endValue = badge.getEndValue();
+	}
+
+	@Override
+	public int hashCode() {
+		return type.getNumber();
+	}
+
+	@Override
+	public boolean equals(Object obj) {
+		return obj instanceof Medal && ((Medal) obj).type.equals(type);
+	}
+}