Merge branch 'master' into Development

README.md

@@ -3,6 +3,9 @@
 Pokemon GO Java API
 
 [![Build Status](https://travis-ci.org/Grover-c13/PokeGOAPI-Java.svg?branch=master)](https://travis-ci.org/Grover-c13/PokeGOAPI-Java)
+[![](https://jitpack.io/v/Grover-c13/PokeGOAPI-Java.svg)](https://jitpack.io/#Grover-c13/PokeGOAPI-Java)
+
+Javadocs : [CLICK ME](https://jitpack.io/com/github/Grover-c13/PokeGOAPI-Java/a2828da60d/javadoc/) 
 
 See this guide for adding functionality:
    https://docs.google.com/document/d/1BE8O6Z19sQ54T5T7QauXgA11GbL6D9vx9AAMCM5KlRA
@@ -11,47 +14,112 @@ See this spreadsheet for RPC endpoints and progress :
    https://docs.google.com/spreadsheets/d/1Xv0Gw5PzIRaVou2xrl6r7qySrcmOKjQWLBjJA73YnJM
 
 ___
-:exclamation:
-
-This API may seem unstable. This is because the backend Pokemon GO servers are unstable.
+:exclamation: :exclamation: :exclamation:
 
-In case stuff is not working as expected, wait a moment to see if the problem resolves itself automatically.
+This API may have issues when the PokemonGO servers are under high load or down, in this case please wait for the official to get back up. You can check the official servers status on [IsPokemonGoDownOrNot.com](http://ispokemongodownornot.com) or [MMOServerStatus.com](http://www.mmoserverstatus.com/pokemon_go).
 
-You may also check the status of the servers on [IsPokemonGoDownOrNot.com](http://ispokemongodownornot.com) or [MMOServerStatus.com](http://www.mmoserverstatus.com/pokemon_go).
+This API doesnt fake the official client perfectly, niantic may know that you arent using the official app, we encourage you to use a alternate account to play with this API.
 
-If you just want to use it, wait some days until the server issues are resolved (or if there is a problem with this library, you may fix it and send a PR this way).
+If you are using this lib to catch pokemon and loot pokestop, take care that you arent teleporting, the servers may issue a softban against your client (its temporary, between 10 and 30 minutes in general).
 
-:exclamation:
+:exclamation: :exclamation: :exclamation:
 ___
 
-# Build
-  - Clone the repo and cd into the folder
-  - `` git submodule update --init ``
-  - compile and package
-  - `` ./gradlew build bundle ``
-  - you should have the api bundled in ``build/libs/PokeGOAPI-Java_bundle-0.0.1-SNAPSHOT.jar``
+# How to import
+
+  Import from Maven/Gradle/SBT/Leiningen using JitPack : [![](https://jitpack.io/v/Grover-c13/PokeGOAPI-Java.svg)](https://jitpack.io/#Grover-c13/PokeGOAPI-Java)
+
+  After you clicked on this link, jitpack will show you multiple build (try use the latest one since the api grow everyday).
+  JitPack will show an example for each dependency manager to include our API into your project.
 
-  PS : To Eclipse user, you must build once : `` ./gradlew build `` and add the generated java class for proto into eclipse source path : Right click on the project > Build path > Configure Build Path > Source > Add Folder > Select `build/generated/source/proto/main/java` > Finish
+OR
 
-# Usage
-Include the API as jar from your own build, or use Maven/Gradle/SBT/Leiningen: https://jitpack.io/#Grover-c13/PokeGOAPI-Java/master-SNAPSHOT
+  Import JAR in Eclipse
+    - Right click on the project
+    - Select Build path > Java Build Path
+    - Select Libraries tab
+    - Select Add External JARs…
+    - Select `PokeGOAPI-Java/build/libs/PokeGOAPI-Java-0.0.1-SNAPSHOT.jar`
+    - Finish
 
-Mostly everything is accessed through the PokemonGo class in the API package.
+# Build from source
+  - Clone the repo and cd into the folder
+  - `` git submodule update --init ``
+  - `` ./gradlew build ``
+  - you should have the api jar in ``build/libs/PokeGOAPI-Java-0.0.1-SNAPSHOT.jar``
 
-The constructor of PokemonGo class requires a AuthInfo object which can be obtained from GoogleLogin().login or PtcLogin().login, and a OkHttpClient object.
+PS : for users who want to import the api into Eclipse IDE, you'll need to :
+  - build once : `` ./gradlew build ``
+  - Right click on the project
+  - Select Build path > Configure Build Path > Source > Add Folder
+  - Select `build/generated/source/proto/main/java`
+  - Finish
 
-EG:
+# Usage exemple (mostly how to login) :
 ```java
 OkHttpClient httpClient = new OkHttpClient();
-//Use Google
-//First Ever Login. Persist info when you recieve callback
-PokemonGo go = new PokemonGo(new GoogleCredentialProvider(httpClient,listner),httpClient);
-//Subsequently
-PokemonGo go = new PokemonGo(new GoogleCredentialProvider(httpClient,refreshToken),httpClient);
-//Or use PTC
+
+/** 
+* Google: 
+* You will need to redirect your user to GoogleUserCredentialProvider.LOGIN_URL
+* Afer this, the user must signin on google and get the token that will be show to him.
+* This token will need to be put as argument to login.
+*/
+GoogleUserCredentialProvider provider = new GoogleUserCredentialProvider(http);
+
+// in this url, you will get a code for the google account that is logged
+System.out.println("Please go to " + GoogleUserCredentialProvider.LOGIN_URL);
+System.out.println("Enter authorisation code:");
+
+// Ask the user to enter it in the standart input
+Scanner sc = new Scanner(System.in);
+String access = sc.nextLine();
+
+// we should be able to login with this token
+provider.login(access);
+PokemonGo go = new PokemonGo(provider, httpClient);
+
+/**
+* After this, if you do not want to re-authorize the google account every time, 
+* you will need to store the refresh_token that you can get the first time with provider.getRefreshToken()
+* ! The API does not store the refresh token for you !
+* log in using the refresh token like this :
+*/
+PokemonGo go = new PokemonGo(new GoogleUserCredentialProvider(httpClient, refreshToken), httpClient);
+
+/**
+* PTC is much simpler, but less secure.
+* You will need the username and password for each user log in
+* This account does not currently support a refresh_token. 
+* Example log in :
+*/
 PokemonGo go = new PokemonGo(new PtcCredentialProvider(httpClient,username,password),httpClient);
-Log.v(go.getPlayerProfile());
+
+// After this you can access the api from the PokemonGo instance :
+go.getPlayerProfile(); // to get the user profile
+go.getInventories(); // to get all his inventories (Pokemon, backpack, egg, incubator)
+go.setLocation(lat, long, alt); // set your position to get stuff around (altitude is not needed, you can use 1 for example)
+go.getMap().getCatchablePokemon(); // get all currently Catchable Pokemon around you
+
+// If you want to go deeper, you can directly send your request with our RequestHandler
+// For example, here we are sending a request to get the award for our level
+// This applies to any method defined in the protos file as Request/Response)
+
+LevelUpRewardsMessage msg = LevelUpRewardsMessage.newBuilder().setLevel(yourLVL).build(); 
+ServerRequest serverRequest = new ServerRequest(RequestType.LEVEL_UP_REWARDS, msg);
+go.getRequestHandler().sendServerRequests(serverRequest);
+
+// and get the response like this :
+
+LevelUpRewardsResponse response = null;
+try {
+	response = LevelUpRewardsResponse.parseFrom(serverRequest.getData());
+} catch (InvalidProtocolBufferException e) {
+	// its possible that the parsing fail when servers are in high load for example.
+	throw new RemoteServerException(e);
+}
 ```
+
 ##Android Dev FAQ
 
   - I can't use the sample code! It just throws a login exception!
@@ -75,11 +143,11 @@ You can't. The Google Identity Platform uses the SHA1 fingerprint and package na
   - Submit a pull request on the `Development` branch :D
 
 ## Contributors
-  - Grover-c13
-  - jabbink
-  - Aphoh
-  - zeladada
-  - darakath
-  - vmarchaud
-
-You can join us in the slack channel #javaapi on the pkre.slack.com (you should get an invite by a bot posted somewhere in the subreddit /r/pokemongodev)
+  - @Grover-c13
+  - @jabbink
+  - @Aphoh
+  - @mjmfighter
+  - @vmarchaud
+  - @langerhans
+
+You can join us in the slack channel #javaapi on the pkre.slack.com ([you can get invited here](https://shielded-earth-81203.herokuapp.com/))

build.gradle

@@ -8,8 +8,6 @@ buildscript {
     dependencies {
         classpath 'com.google.protobuf:protobuf-gradle-plugin:0.7.7'
     }
-
-
 }
 
 apply plugin: 'idea'
@@ -25,6 +23,7 @@ targetCompatibility = 1.7
 
 repositories {
     mavenCentral()
+    maven { url "https://jitpack.io" }
 }
 
 sourceSets {
@@ -39,13 +38,11 @@ sourceSets {
 
 // Remove all .proto definition from the final build
 processResources {
-    exclude('**/*')
+    exclude('POGOProtos/')
 }
 
 // Run this task to bundle all needed dependency
 task bundle(type: Jar) {
-    baseName = project.name + '_bundle'
-
     from {
         configurations.compile.collect {
             it.isDirectory() && !it.isEmpty() ? it : zipTree(it)
@@ -54,6 +51,8 @@ task bundle(type: Jar) {
     with jar
 }
 
+jar.finalizedBy(bundle)
+
 protobuf {
     // Configure the protoc executable
     protoc {
@@ -90,11 +89,15 @@ checkstyle {
 checkstyleMain.doLast {
     def outputFile = file(checkstyleOutputDir + "main.xml")
     if (outputFile.exists() && outputFile.text.contains("<error ")) {
-        throw new GradleException("There were checkstyle warnings! For more info check $outputFile")
+        logger.warn("!!!!-----------------------------------!!!!")
+        logger.warn("There were checkstyle warnings! For more info check $outputFile")
+        logger.warn("PLEASE CORRECT BEFORE SUBMITTING A PULLREQUEST")
+        logger.warn("!!!!-----------------------------------!!!!")
     }
 }
 
 dependencies {
+    compile 'com.github.svarzee:gpsoauth-java:v0.3.0'
     compile 'com.squareup.okio:okio:1.9.0'
     compile 'com.squareup.moshi:moshi:1.2.0'
     compile 'com.annimon:stream:1.1.1'
@@ -109,11 +112,19 @@ idea {
     }
 }
 
-task sourcesJar(type: Jar) {
-    from sourceSets.main.java.srcDirs
+task sourcesJar(type: Jar, dependsOn: classes) {
     classifier = 'sources'
+    from sourceSets.main.allJava
+}
+
+task javadocJar(type: Jar, dependsOn: javadoc) {
+    classifier = 'javadoc'
+    javadoc.failOnError(false);
+    javadoc.source = sourceSets.main.allJava
+    from javadoc.destinationDir
 }
 
 artifacts {
     archives sourcesJar
+    archives javadocJar
 }