merge

Author: raLaaaa

README.md

@@ -1,20 +1,24 @@
 # zulip-java-rest
 A thin and easy to use Java library to access the [Zulip API](https://zulipchat.com/api/).
-This library covers every API call of the Zulip API except for real-time events but is in it's core really simple.
+This library covers every API call of the Zulip REST API except for real-time events. It is aimed at being as simple as possible.
 # How to use
 ## Setup and usage
+
+### JAR
+Simply build this project with `mvn package` and you can use the .jar in your classpath.
+
 ### Maven
-Just add the following dependency to your pom.xml or the JAR of this repository to your projects build path.
+Just add the following dependency to your pom.xml.
 
 ```xml
 <dependency>
-	<groupId>io.taliox</groupId>
-	<artifactId>zulip-java-rest</artifactId>
-	<version>0.0.1-SNAPSHOT</version>
+  <groupId>io.taliox</groupId>
+  <artifactId>zulip-java-rest</artifactId>
+  <version>0.0.2</version>
 </dependency>
 ```
 ### Where do I get the API key for authentication?
-You can either use a bot or a user account to communicate with the API. To find out the needed token please see the official [Zulip documentation](https://zulipchat.com/api/api-keys).
+You can either use a bot or a user account to communicate with the API. To find out the needed token or how to create a bot please see the official [Zulip documentation](https://zulipchat.com/api/api-keys).
 
 ### At first Create the ZulipRestExecutor to communicate with the Zulip API
 The core of this library is the `ZulipRestExecutor` it is responsible for performing HTTP calls.
@@ -27,14 +31,14 @@ To change credentials after instantiating the ZulipRestExecutor it is recommende
 
 ### How to use the ZulipRestExecutor?
 To perform an API call you should use the `executeCall(ZulipRestAPICall call)` method of the newly created object.
-All API calls are packed inside the library as instantiatable objects which be executed by the `ZulipRestExecutor`.
-The naming convention of all call objects is like the following: `HTTP request mehtod + object of action`.
+All API calls are packed inside the library as instantiatable objects which can be executed by the `ZulipRestExecutor`.
+The naming convention of all call objects is like the following: `HTTP request method + object of action`.
 
 So for instance if we want to send a message to someone on our Zulip server we need to create a `PostMessage` object to pass it into our executeCall method.
 
 ```java
-PostMessage postMessage = new PostMessage("anotheruser@zulip.com", "Hello world");
-String response = executor.executeCall(ZulipRestAPICall call)
+PostMessage postMessage = new PostMessage("anotheruser@zulip.com", "hello world");
+String response = executor.executeCall(postMessage)
 ```
 
 executeCall always returns the answer from the Zulip server for instance whether the call was successful or not.
@@ -64,13 +68,13 @@ String response = executor.executeCall(getAllStreams);
 
 ### Send a message to a single person
 ```java
-PostMessage postMessage = new PostMessage("anotheruser@zulip.com", "Hello world");
+PostMessage postMessage = new PostMessage("anotheruser@zulip.com", "hello world");
 String response = executor.executeCall(postMessage);
 ```
 
 ### Send a message to a stream
 ```java
-PostMessage postMessage = new PostMessage("Streamname", "topicname", "Hello world");
+PostMessage postMessage = new PostMessage("streamname", "topicname", "hello world");
 String response = executor.executeCall(postMessage);
 ```
 
@@ -82,16 +86,17 @@ String response = executor.executeCall(createUser);
 
 ### Create a new stream
 ```java
-PostCreateStream createStream = new PostCreateStream("[{\"description\":\"This is new\",\"name\":\"A new Stream\"}]");	
+PostCreateStream createStream = new PostCreateStream("[{\"description\":\"This is a new stream\",\"name\":\"A new Stream\"}]");	
 createStream.setInvite_only(true);
 createStream.setAnnounce(true);
 ```
+
 After instantiating the object to be executed you always can set optional parameters.
 In this case for example whether the newly created stream is supposed be invite only.
 This works the same for all objects.
 
 ### Delete a message
-```
+```java
 DeleteMessage deleteMessage = new DeleteMessage("54");
 String response = executor.executeCall(deleteMessage);
 ```
@@ -104,14 +109,15 @@ patchMessage.setType(UpdateMessageTypes.change_later);
 String response = executor.executeCall(patchMessage);
 ```
 
-Please always refer to [official Zulip API documentation](https://zulipchat.com/api/) in case you are not sure what structure the parameters of an call object need to be.
-A full list of API calls, return types and parameters to perform calls can be found there.
+Please always refer to the [official Zulip API documentation](https://zulipchat.com/api/) in case you are not sure what structure the parameters of an call object need to be.
+A full list of API calls, return types and parameters to perform calls can be found over there.
 
 We are working on more examples and tests within the library so you can try it out right of the box.
 
 ## Contributing
-Thanks for your interest! Do not hesitate to open an issue if you have a question, feedback or found something that`s not supposed to be working like it should.
-Pull requests for improvements of the library are also highly appriciated.
+Thanks for your interest! Do not hesitate to open an issue if you have a question, feedback or found something that is not working like it should.
+
+Pull requests for improvements of the library or it's documentation are also highly appreciated.
 
 ## Licenses
 This library and its content is released under the [MIT License](https://choosealicense.com/licenses/mit/).

pom.xml

@@ -4,7 +4,7 @@
 
 	<groupId>io.taliox</groupId>
 	<artifactId>zulip-java-rest</artifactId>
-	<version>0.0.3-SNAPSHOT</version>
+	<version>1.0.0-SNAPSHOT</version>
 	<inceptionYear>2019</inceptionYear>
 
 	<parent>

src/main/java/io/taliox/zulip/ZulipRestExecutor.java

@@ -37,5 +37,5 @@ public ZulipRestExecutor(String userName, String password, String serverURL) {
 	public String executeCall(ZulipRestAPICall call) {
 		return call.execute(this);
 	}
-
-}
+	
+}

src/main/java/io/taliox/zulip/calls/ZulipRestAPICall.java

@@ -138,6 +138,8 @@ protected String performRequest(HashMap<String, String> parameters, HttpRequestB
 						"Bad request. The server could not process your request sucessfully: " + builder.toString());
 			}
 
+		base.releaseConnection();	
+			
 		} catch (ClientProtocolException e) {
 			e.printStackTrace();
 		} catch (IOException e) {
@@ -254,4 +256,4 @@ protected void setParameters(HashMap<String, String> parameters) {
 		this.parameters = parameters;
 	}
 
-}
+}

src/main/java/io/taliox/zulip/calls/users/GetProfile.java

@@ -28,10 +28,9 @@ public GetProfile() {
 	 * @see io.taliox.zulip.calls.Callable#execute()
 	 */
 	public String execute(ZulipRestExecutor executor) {
-		setHttpController(executor.httpController);
 		setHttpController(executor.httpController);
 		HttpGet get = new HttpGet(this.httpController.getServer() + getZulipAPIUrl());
 		return performRequest(getParameters(), get);
 	}
 
-}
+}