Added support for Glances API and completly reworked API
This commit is contained in:
Sven Kubiak
142
src/main/java/de/svenkubiak/jpushover/apis/Glance.java
Normal file
142
src/main/java/de/svenkubiak/jpushover/apis/Glance.java
Normal file
@ -0,0 +1,142 @@
|
||||
package de.svenkubiak.jpushover.apis;
|
||||
|
||||
import java.io.IOException;
|
||||
import java.util.NavigableMap;
|
||||
import java.util.Objects;
|
||||
import java.util.TreeMap;
|
||||
|
||||
import de.svenkubiak.jpushover.enums.Param;
|
||||
import de.svenkubiak.jpushover.http.PushoverRequest;
|
||||
import de.svenkubiak.jpushover.http.PushoverResponse;
|
||||
import de.svenkubiak.jpushover.utils.Urls;
|
||||
import de.svenkubiak.jpushover.utils.Validate;
|
||||
|
||||
/**
|
||||
*
|
||||
* @author svenkubiak
|
||||
*
|
||||
*/
|
||||
public class Glance {
|
||||
private static final String GLANCE_URL = Urls.getGlanceUrl();
|
||||
private String token;
|
||||
private String user;
|
||||
private String device;
|
||||
private String title;
|
||||
private String text;
|
||||
private String subtext;
|
||||
private int count;
|
||||
private int percent;
|
||||
private String proxyHost;
|
||||
private int proxyPort;
|
||||
|
||||
public Glance withToken(String token) {
|
||||
Objects.requireNonNull(token, "token can not be null");
|
||||
|
||||
this.token = token;
|
||||
return this;
|
||||
}
|
||||
|
||||
public Glance withUser(String user) {
|
||||
Objects.requireNonNull(user, "user can not be null");
|
||||
|
||||
this.user = user;
|
||||
return this;
|
||||
}
|
||||
|
||||
public Glance withDevice(String device) {
|
||||
Objects.requireNonNull(device, "device can not be null");
|
||||
|
||||
this.device = device;
|
||||
return this;
|
||||
}
|
||||
|
||||
/**
|
||||
* A description of the data being shown, such as "Widgets Sold"
|
||||
*
|
||||
* @param title the title to use
|
||||
* @return Glance instance
|
||||
*/
|
||||
public Glance withTitle(String title) {
|
||||
Objects.requireNonNull(title, "title can not be null");
|
||||
Validate.checkArgument(title.length() <= 100, "Title must not exceed a length of 100 characters");
|
||||
|
||||
this.title = title;
|
||||
return this;
|
||||
}
|
||||
|
||||
/**
|
||||
* The main line of data, used on most screens
|
||||
*
|
||||
* @param text the text to use
|
||||
* @return Glance instance
|
||||
*/
|
||||
public Glance withText(String text) {
|
||||
Objects.requireNonNull(text, "text can not be null");
|
||||
Validate.checkArgument(text.length() <= 100, "Text must not exceed a length of 100 characters");
|
||||
|
||||
this.text = text;
|
||||
return this;
|
||||
}
|
||||
|
||||
/**
|
||||
* A second line of data
|
||||
*
|
||||
* @param subtext the subtext to use
|
||||
* @return Glance instance
|
||||
*/
|
||||
public Glance withSubtext(String subtext) {
|
||||
Objects.requireNonNull(subtext, "subtext can not be null");
|
||||
Validate.checkArgument(subtext.length() <= 100, "subtext must not exceed a length of 100 characters");
|
||||
|
||||
this.subtext = subtext;
|
||||
return this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Shown on smaller screens; useful for simple counts
|
||||
*
|
||||
* @param count the count to use
|
||||
* @return Glance instance
|
||||
*/
|
||||
public Glance withCount(int count) {
|
||||
this.count = count;
|
||||
return this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Shown on some screens as a progress bar/circle
|
||||
*
|
||||
* @param percent the percent to use
|
||||
* @return GLance instance
|
||||
*/
|
||||
public Glance withPercent(int percent) {
|
||||
this.percent = percent;
|
||||
return this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Sends a glance to pushover
|
||||
*
|
||||
* @return PushoverResponse instance
|
||||
*
|
||||
* @throws IOException if sending the message fails
|
||||
* @throws InterruptedException if sending the message fails
|
||||
*/
|
||||
public PushoverResponse push() throws IOException, InterruptedException {
|
||||
Objects.requireNonNull(this.token, "Token is required for a glance");
|
||||
Objects.requireNonNull(this.user, "User is required for a glance");
|
||||
|
||||
NavigableMap<String, String> body = new TreeMap<>();
|
||||
body.put(Param.TOKEN.toString(), this.token);
|
||||
body.put(Param.USER.toString(), this.user);
|
||||
body.put(Param.DEVICE.toString(), this.device);
|
||||
body.put(Param.TITLE.toString(), this.title);
|
||||
body.put(Param.TEXT.toString(), this.text);
|
||||
body.put(Param.SUBTEXT.toString(), this.subtext);
|
||||
body.put(Param.COUNT.toString(), String.valueOf(this.count));
|
||||
body.put(Param.PERCENT.toString(), String.valueOf(this.percent));
|
||||
|
||||
|
||||
return new PushoverRequest().push(GLANCE_URL, body, this.proxyHost, this.proxyPort);
|
||||
}
|
||||
}
|
||||
301
src/main/java/de/svenkubiak/jpushover/apis/Message.java
Normal file
301
src/main/java/de/svenkubiak/jpushover/apis/Message.java
Normal file
@ -0,0 +1,301 @@
|
||||
package de.svenkubiak.jpushover.apis;
|
||||
|
||||
import java.io.IOException;
|
||||
import java.util.NavigableMap;
|
||||
import java.util.Objects;
|
||||
import java.util.TreeMap;
|
||||
|
||||
import de.svenkubiak.jpushover.enums.Param;
|
||||
import de.svenkubiak.jpushover.enums.Priority;
|
||||
import de.svenkubiak.jpushover.enums.Sound;
|
||||
import de.svenkubiak.jpushover.http.PushoverRequest;
|
||||
import de.svenkubiak.jpushover.http.PushoverResponse;
|
||||
import de.svenkubiak.jpushover.utils.Urls;
|
||||
|
||||
/**
|
||||
*
|
||||
* @author svenkubiak
|
||||
*
|
||||
*/
|
||||
public class Message {
|
||||
private static final String MESSAGE_URL = Urls.getMessageUrl();
|
||||
private static final String VALIDATION_URL = Urls.getValidationUrl();
|
||||
private Priority priority;
|
||||
private Sound sound;
|
||||
private String token;
|
||||
private String user;
|
||||
private String message;
|
||||
private String device;
|
||||
private String title;
|
||||
private String url;
|
||||
private String urlTitle;
|
||||
private String timestamp;
|
||||
private String retry;
|
||||
private String expire;
|
||||
private String callback;
|
||||
private String proxyHost;
|
||||
private int proxyPort;
|
||||
private boolean html;
|
||||
|
||||
public Message() {
|
||||
this.withSound(Sound.PUSHOVER);
|
||||
this.withPriority(Priority.NORMAL);
|
||||
}
|
||||
|
||||
/**
|
||||
* Your application's API token
|
||||
* (required)
|
||||
*
|
||||
* @param token The pushover API token
|
||||
* @return Message instance
|
||||
*/
|
||||
public final Message withToken(final String token) {
|
||||
Objects.requireNonNull(token, "Token can not be null");
|
||||
|
||||
this.token = token;
|
||||
return this;
|
||||
}
|
||||
|
||||
/**
|
||||
* The user/group key (not e-mail address) of your user (or you),
|
||||
* viewable when logged into the @see <a href="https://pushover.net/login">pushover dashboard</a>
|
||||
* (required)
|
||||
*
|
||||
* @param user The username
|
||||
* @return Message instance
|
||||
*/
|
||||
public final Message withUser(final String user) {
|
||||
this.user = user;
|
||||
return this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Specifies how often (in seconds) the Pushover servers will send the same notification to the user.
|
||||
* Only required if priority is set to emergency.
|
||||
*
|
||||
* @param retry Number of seconds
|
||||
* @return Message instance
|
||||
*/
|
||||
public final Message withRetry(final String retry) {
|
||||
this.retry = retry;
|
||||
return this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Specifies how many seconds your notification will continue to be retried for (every retry seconds).
|
||||
* Only required if priority is set to emergency.
|
||||
*
|
||||
* @param expire Number of seconds
|
||||
* @return Message instance
|
||||
*/
|
||||
public final Message withExpire(final String expire) {
|
||||
this.expire = expire;
|
||||
return this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Your message
|
||||
* (required)
|
||||
*
|
||||
* @param message The message to sent
|
||||
* @return Message instance
|
||||
*/
|
||||
public final Message withMessage(final String message) {
|
||||
this.message = message;
|
||||
return this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Your user's device name to send the message directly to that device,
|
||||
* rather than all of the user's devices
|
||||
* (optional)
|
||||
*
|
||||
* @param device The device name
|
||||
* @return Message instance
|
||||
*/
|
||||
public final Message withDevice(final String device) {
|
||||
this.device = device;
|
||||
return this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Your message's title, otherwise your app's name is used
|
||||
* (optional)
|
||||
*
|
||||
* @param title The title
|
||||
* @return Message instance
|
||||
*/
|
||||
public final Message withTitle(final String title) {
|
||||
this.title = title;
|
||||
return this;
|
||||
}
|
||||
|
||||
/**
|
||||
* A supplementary URL to show with your message
|
||||
* (optional)
|
||||
*
|
||||
* @param url The url
|
||||
* @return Message instance
|
||||
*/
|
||||
public final Message withUrl(final String url) {
|
||||
this.url = url;
|
||||
return this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Enables HTML in the pushover message
|
||||
* (optional)
|
||||
*
|
||||
* @return Message instance
|
||||
*/
|
||||
public final Message enableHtml() {
|
||||
this.html = true;
|
||||
return this;
|
||||
}
|
||||
|
||||
/**
|
||||
* A title for your supplementary URL, otherwise just the URL is shown
|
||||
*
|
||||
* @param urlTitle The url title
|
||||
* @return Message instance
|
||||
*/
|
||||
public final Message withUrlTitle(final String urlTitle) {
|
||||
this.urlTitle = urlTitle;
|
||||
return this;
|
||||
}
|
||||
|
||||
/**
|
||||
* A Unix timestamp of your message's date and time to display to the user,
|
||||
* rather than the time your message is received by our API
|
||||
*
|
||||
* @param timestamp The Unix timestamp
|
||||
* @return Message instance
|
||||
*/
|
||||
public final Message withTimestamp(final String timestamp) {
|
||||
this.timestamp = timestamp;
|
||||
return this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Priority of the message based on the @see <a href="https://pushover.net/api#priority">documentation</a>
|
||||
* (optional)
|
||||
*
|
||||
* @param priority The priority enum
|
||||
* @return Message instance
|
||||
*/
|
||||
public final Message withPriority(final Priority priority) {
|
||||
this.priority = priority;
|
||||
return this;
|
||||
}
|
||||
|
||||
/**
|
||||
* The name of one of the sounds supported by device clients to override
|
||||
* the user's default sound choice
|
||||
* (optional)
|
||||
*
|
||||
* @param sound THe sound enum
|
||||
* @return Message instance
|
||||
*/
|
||||
public final Message withSound(final Sound sound) {
|
||||
this.sound = sound;
|
||||
return this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Callback parameter may be supplied with a publicly-accessible URL that the
|
||||
* pushover servers will send a request to when the user has acknowledged your
|
||||
* notification.
|
||||
* Only required if priority is set to emergency.
|
||||
*
|
||||
* @param callback The callback URL
|
||||
* @return Message instance
|
||||
*/
|
||||
public final Message withCallback(final String callback) {
|
||||
this.callback = callback;
|
||||
return this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Uses the given proxy for HTTP requests
|
||||
*
|
||||
* @param proxyHost The host that should be used for the Proxy
|
||||
* @param proxyPort The port that should be used for the Proxy
|
||||
* @return Message instance
|
||||
*/
|
||||
public final Message withProxy(final String proxyHost, final int proxyPort) {
|
||||
this.proxyHost = proxyHost;
|
||||
this.proxyPort = proxyPort;
|
||||
return this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Sends a validation request to pushover ensuring that the token and user
|
||||
* is correct, that there is at least one active device on the account.
|
||||
*
|
||||
* Requires token parameter
|
||||
* Requires user parameter
|
||||
* Optional device parameter to check specific device
|
||||
*
|
||||
* @return true if token and user are valid and at least on device is on the account, false otherwise
|
||||
*
|
||||
* @throws IOException if validation fails
|
||||
* @throws InterruptedException if validation fails
|
||||
*/
|
||||
public boolean validate() throws IOException, InterruptedException {
|
||||
Objects.requireNonNull(this.token, "Token is required for validation");
|
||||
Objects.requireNonNull(this.user, "User is required for validation");
|
||||
|
||||
NavigableMap<String, String> body = new TreeMap<>();
|
||||
body.put(Param.TOKEN.toString(), this.token);
|
||||
body.put(Param.USER.toString(), this.user);
|
||||
|
||||
var pushoverResponse = new PushoverRequest().push(VALIDATION_URL, body, this.proxyHost, this.proxyPort);
|
||||
|
||||
var valid = false;
|
||||
if (pushoverResponse.getHttpStatus() == 200) {
|
||||
var response = pushoverResponse.getResponse();
|
||||
if (response != null && response.contains("\"status\":1")) {
|
||||
valid = true;
|
||||
}
|
||||
}
|
||||
|
||||
return valid;
|
||||
}
|
||||
|
||||
/**
|
||||
* Sends a message to pushover
|
||||
*
|
||||
* @return PushoverResponse instance
|
||||
*
|
||||
* @throws IOException if sending the message fails
|
||||
* @throws InterruptedException if sending the message fails
|
||||
*/
|
||||
public final PushoverResponse push() throws IOException, InterruptedException {
|
||||
Objects.requireNonNull(this.token, "Token is required for a message");
|
||||
Objects.requireNonNull(this.user, "User is required for a message");
|
||||
Objects.requireNonNull(this.message, "Message is required for a message");
|
||||
|
||||
if (Priority.EMERGENCY.equals(this.priority)) {
|
||||
Objects.requireNonNull(this.retry, "Retry is required on priority emergency");
|
||||
Objects.requireNonNull(this.expire, "Expire is required on priority emergency");
|
||||
}
|
||||
|
||||
NavigableMap<String, String> body = new TreeMap<>();
|
||||
body.put(Param.TOKEN.toString(), this.token);
|
||||
body.put(Param.USER.toString(), this.user);
|
||||
body.put(Param.MESSAGE.toString(), this.message);
|
||||
body.put(Param.DEVICE.toString(), this.device);
|
||||
body.put(Param.TITLE.toString(), this.title);
|
||||
body.put(Param.URL.toString(), this.url);
|
||||
body.put(Param.RETRY.toString(), this.retry);
|
||||
body.put(Param.EXPIRE.toString(), this.expire);
|
||||
body.put(Param.CALLBACK.toString(), this.callback);
|
||||
body.put(Param.URLTITLE.toString(), this.urlTitle);
|
||||
body.put(Param.PRIORITY.toString(), this.priority.toString());
|
||||
body.put(Param.TIMESTAMP.toString(), this.timestamp);
|
||||
body.put(Param.SOUND.toString(), this.sound.toString());
|
||||
body.put(Param.HTML.toString(), this.html ? "1" : "0");
|
||||
|
||||
return new PushoverRequest().push(MESSAGE_URL, body, this.proxyHost, this.proxyPort);
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user