Adding SendGridApi interface. #224
Conversation
|
|
thinkingserious
added
status: code review request
| @@ -7,7 +7,7 @@ | |||
| /** | |||
| * Class SendGrid allows for quick and easy access to the SendGrid API. | |||
| */ | |||
| public class SendGrid { | |||
| public class SendGrid implements SendGridApi{ | |||
There was a problem hiding this comment.
Please add a space before the bracket.
| import java.io.IOException; | ||
| import java.util.Map; | ||
|
|
||
| public interface SendGridApi { |
There was a problem hiding this comment.
Please rename to SendGridAPI.
|
|
||
| public interface SendGridApi { | ||
|
|
||
| public void initializeSendGrid(String apiKey); |
There was a problem hiding this comment.
Needs Javadoc comments.
|
|
||
| public void initializeSendGrid(String apiKey); | ||
|
|
||
| public String getLibraryVersion(); |
There was a problem hiding this comment.
Needs Javadoc comments.
|
|
||
| public String getLibraryVersion(); | ||
|
|
||
| public String getVersion(); |
There was a problem hiding this comment.
Needs Javadoc ... you know.
|
|
||
| public Map<String,String> addRequestHeader(String key, String value); | ||
|
|
||
| public Map<String,String> removeRequestHeader(String key); |
There was a problem hiding this comment.
Please add a new line.
There was a problem hiding this comment.
@andy-trimble I addressed the comments.
|
Thanks for taking the time to review @andy-trimble! |
| * Initializes SendGrid | ||
| * @param apiKey is your SendGrid API Key: https://app.sendgrid.com/settings/api_keys | ||
| */ | ||
| public void initializeSendGrid(String apiKey); |
There was a problem hiding this comment.
Please remove the tabs from this file and replace with spaces. This is causing the formatting to be off.
| */ | ||
| public void initializeSendGrid(String apiKey); | ||
|
|
||
| /** |
There was a problem hiding this comment.
Incorrect Javadoc comments.
| public String getLibraryVersion(); | ||
|
|
||
| /** | ||
| * Gets the version. |
There was a problem hiding this comment.
Add @return documentation.
|
|
||
|
|
||
| /** | ||
| * Gets the request headers. |
There was a problem hiding this comment.
Add @return documentation.
|
|
||
| /** | ||
| * Removes a request headers. | ||
| * @param key the key |
There was a problem hiding this comment.
Add @return documentation.
| public Map<String,String> removeRequestHeader(String key); | ||
|
|
||
| /** | ||
| * Gets the host. |
There was a problem hiding this comment.
Add @return documentation.
| public void setHost(String host); | ||
|
|
||
| /** | ||
| * Class makeCall makes the call to the SendGrid API, override this method for testing. |
There was a problem hiding this comment.
Add @param, @return, and @throws documentation.
| public Response makeCall(Request request) throws IOException; | ||
|
|
||
| /** | ||
| * Class api sets up the request to the SendGrid API, this is main interface. |
There was a problem hiding this comment.
Add @param, @return, and @throws documentation.
| public void initializeSendGrid(String apiKey); | ||
|
|
||
| /** | ||
| * Initializes SendGrid |
There was a problem hiding this comment.
This method returns the library version. Please update the documentation to reflect this.
| /** | ||
| * Gets the version. | ||
| * | ||
| * @return |
There was a problem hiding this comment.
Please specify the return value. For example, @return the library version.
|
|
||
| /** | ||
| * Gets the request headers. | ||
| * @return |
There was a problem hiding this comment.
Please specify the return value.
| * | ||
| * @param keythe key | ||
| * @param valuethe value | ||
| * @return |
There was a problem hiding this comment.
Please specify the return value.
| /** | ||
| * Adds a request headers. | ||
| * | ||
| * @param keythe key |
There was a problem hiding this comment.
Add a space between "key" and "the"
| /** | ||
| * Gets the host. | ||
| * | ||
| * @return |
There was a problem hiding this comment.
Please specify the return value.
| * testing. | ||
| * | ||
| * @param request | ||
| * @return |
There was a problem hiding this comment.
Please specify the return value.
| * Class api sets up the request to the SendGrid API, this is main interface. | ||
| * | ||
| * @param request | ||
| * @return |
There was a problem hiding this comment.
Please specify the return value.
| /** | ||
| * Class api sets up the request to the SendGrid API, this is main interface. | ||
| * | ||
| * @param request |
There was a problem hiding this comment.
Please define the parameter.
| * | ||
| * @param request | ||
| * @return | ||
| * @throws IOException |
There was a problem hiding this comment.
Please add "in case of network or marshal error."
|
Merged all recent changes, to rebuild at Travis. |
#194