commit 580c43c9fc91ed76b723e6b060f4ee401e8628bb Author: skubiak Date: Wed Jan 7 13:16:55 2015 +0100 initial commit diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..1229c22 --- /dev/null +++ b/.gitignore @@ -0,0 +1,5 @@ +.classpath +.project +.settings/ +/target +/*.versionsBackup diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..5c304d1 --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ +Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "{}" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright {yyyy} {name of copyright owner} + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/README.md b/README.md new file mode 100644 index 0000000..e976527 --- /dev/null +++ b/README.md @@ -0,0 +1,38 @@ +[![Maven Central](https://maven-badges.herokuapp.com/maven-central/de.svenkubiak/jpushover/badge.svg)](https://maven-badges.herokuapp.com/maven-central/de.svenkubiak/jpushover) +[![Build Status](https://secure.travis-ci.org/svenkubiak/jpushover.png?branch=master)](http://travis-ci.org/svenkubiak/jpushover) + +JPushover +================ + +Convenient class for sending messages to [Pushover][1] in Java project + +Usage +------------------ + +1) Add the jpushover dependency to your pom.xml: + + + de.svenkubiak + jpushover + x.x.x + + +2) Use the JPushover object were need + + new JPushover() + .token("MyToken") + .user("MyUser") + .message("MyPusher") + .push(); + +If you want more information and/or the response from Pushover API, use the JPushoverResponse object. + + JPushoverResponse jPushoverResponse = new JPushover() + .token("MyToken") + .user("MyUser") + .message("MyPusher") + .push(); + +JPushoverResponse will return the raw HTTP status code, along with the raw JSON response and a convenient boolean if the request was successful or not. + +[1]: https://pushover.net \ No newline at end of file diff --git a/logback.xml b/logback.xml new file mode 100644 index 0000000..6f21fb1 --- /dev/null +++ b/logback.xml @@ -0,0 +1,10 @@ + + + + %d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n + + + + + + \ No newline at end of file diff --git a/pom.xml b/pom.xml new file mode 100644 index 0000000..6ca5e49 --- /dev/null +++ b/pom.xml @@ -0,0 +1,168 @@ + + 4.0.0 + de.svenkubiak + jpushover + 1.0.0-SNAPSHOT + jar + + + The Apache Software License, Version 2.0 + http://www.apache.org/licenses/LICENSE-2.0.txt + + + + + Sven Kubiak + sk@svenkubiak.de + + + + UTF-8 + 1.1.2 + + + 3.1.0 + + + scm:git:git@github.com:svenkubiak/JPushover.git + scm:git:git@github.com:svenkubiak/JPushover.git + git@github.com:svenkubiak/JPushover.git + HEAD + + JPushover + Convenient class for sending messages to pushover in Java project + https://github.com/svenkubiak/embedded-mongodb + + + + org.apache.maven.plugins + maven-compiler-plugin + 3.2 + + 1.7 + 1.7 + false + true + + + + org.apache.maven.plugins + maven-source-plugin + 2.4 + + + attach-sources + + jar-no-fork + + + + + + org.apache.maven.plugins + maven-javadoc-plugin + 2.10.1 + + + attach-javadocs + + jar + + + + + + org.apache.maven.plugins + maven-release-plugin + 2.5.1 + + true + deploy + + + + org.codehaus.mojo + versions-maven-plugin + 2.1 + + + + + + commons-io + commons-io + 2.4 + + + junit + junit + 4.12 + test + + + org.apache.httpcomponents + fluent-hc + 4.3.6 + + + ch.qos.logback + logback-classic + ${logback.version} + + + ch.qos.logback + logback-core + ${logback.version} + + + org.slf4j + slf4j-api + 1.7.10 + + + com.google.guava + guava + 18.0 + + + + + ossrh + https://oss.sonatype.org/content/repositories/snapshots + + + ossrh + https://oss.sonatype.org/service/local/staging/deploy/maven2/ + + + + + release-sign-artifacts + + + performRelease + true + + + + + + org.apache.maven.plugins + maven-gpg-plugin + 1.5 + + + sign-artifacts + verify + + sign + + + + + + + + + \ No newline at end of file diff --git a/src/main/java/de/svenkubiak/jpushover/JPushover.java b/src/main/java/de/svenkubiak/jpushover/JPushover.java new file mode 100644 index 0000000..74d7f75 --- /dev/null +++ b/src/main/java/de/svenkubiak/jpushover/JPushover.java @@ -0,0 +1,203 @@ +package de.svenkubiak.jpushover; + +import java.io.IOException; +import java.util.List; + +import org.apache.commons.io.IOUtils; +import org.apache.http.Consts; +import org.apache.http.HttpResponse; +import org.apache.http.NameValuePair; +import org.apache.http.client.fluent.Form; +import org.apache.http.client.fluent.Request; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +import com.google.common.base.Preconditions; + +import de.svenkubiak.jpushover.enums.Constants; +import de.svenkubiak.jpushover.enums.Priority; +import de.svenkubiak.jpushover.enums.Sound; + +public class JPushover { + private static final Logger LOG = LoggerFactory.getLogger(JPushover.class); + + 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 Priority priority; + private Sound sound; + + public JPushover(){ + } + + /** + * Your application's API token + * (required) + * + * @param token + * @return JPushover instance + */ + public JPushover token(String token) { + this.token = token; + return this; + } + + /** + * The user/group key (not e-mail address) of your user (or you), + * viewable when logged into the @see pushover dashboard + * (required) + * + * @param user + * @return JPushover instance + */ + public JPushover user(String user) { + this.user = user; + return this; + } + + /** + * Your message + * (required) + * + * @param message + * @return JPushover instance + */ + public JPushover message(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 + * @return JPushover instance + */ + public JPushover device(String device) { + this.device = device; + return this; + } + + /** + * Your message's title, otherwise your app's name is used + * (optional) + * + * @param title + * @return JPushover instance + */ + public JPushover title(String title) { + this.title = title; + return this; + } + + /** + * A supplementary URL to show with your message + * (optional) + * + * @param url + * @return JPushover instance + */ + public JPushover url(String url) { + this.url = url; + return this; + } + + /** + * A title for your supplementary URL, otherwise just the URL is shown + * + * @param urlTitle + * @return JPushover instance + */ + public JPushover urlTitle(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 + * @return JPushover instance + */ + public JPushover timestamp(String timestamp) { + this.timestamp = timestamp; + return this; + } + + /** + * Send as LOWESET to generate no notification/alert, + * LOW to always send as a quiet notification, + * NORMAL to display as high-priority and bypass the user's quiet hours, + * or emergence to also require confirmation from the user + * (optional) + * + * @param priority + * @return JPushover instance + */ + public JPushover priority(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 + * @return JPushover instance + */ + public JPushover sound(Sound sound) { + this.sound = sound; + return this; + } + + /** + * Send the message to pushover + */ + public JPushoverResponse push() { + Preconditions.checkNotNull(this.token, "Token is required"); + Preconditions.checkNotNull(this.user, "User is required"); + Preconditions.checkNotNull(this.message, "Message is required"); + + List params = Form.form() + .add(Constants.TOKEN.value(), this.token) + .add(Constants.USER.value(), this.user) + .add(Constants.MESSAGE.value(), this.message) + .add(Constants.DEVICE.value(), this.device) + .add(Constants.TITLE.value(), this.title) + .add(Constants.URL.value(), this.url) + .add(Constants.URLTITLE.value(), this.urlTitle) + .add(Constants.PRIORITY.value(), this.priority.value()) + .add(Constants.TIMESTAMP.value(), this.timestamp) + .add(Constants.SOUND.value(), this.sound.value()) + .build(); + + HttpResponse httpResponse = null; + JPushoverResponse jPushoverResponse = null; + try { + httpResponse = Request.Post(Constants.PUSHOVER_URL.value()).bodyForm(params, Consts.UTF_8).execute().returnResponse(); + + if (httpResponse != null) { + int status = httpResponse.getStatusLine().getStatusCode(); + + jPushoverResponse = new JPushoverResponse() + .httpStatus(status) + .response(IOUtils.toString(httpResponse.getEntity().getContent(), Consts.UTF_8)) + .isSuccessful((status == 200) ? true : false); + } + } catch (IOException e) { + LOG.error("Failed to send message to pushover", e); + } + + return (jPushoverResponse == null) ? new JPushoverResponse().isSuccessful(false) : jPushoverResponse; + } +} \ No newline at end of file diff --git a/src/main/java/de/svenkubiak/jpushover/JPushoverResponse.java b/src/main/java/de/svenkubiak/jpushover/JPushoverResponse.java new file mode 100644 index 0000000..5dd6669 --- /dev/null +++ b/src/main/java/de/svenkubiak/jpushover/JPushoverResponse.java @@ -0,0 +1,49 @@ +package de.svenkubiak.jpushover; + +public class JPushoverResponse { + private String response; + private int httpStatus; + private boolean successful; + + public JPushoverResponse(){ + } + + public JPushoverResponse response(String response) { + this.response = response; + return this; + } + + public JPushoverResponse httpStatus(int httpStatus) { + this.httpStatus = httpStatus; + return this; + } + + public JPushoverResponse isSuccessful(boolean successful) { + this.successful = successful; + return this; + } + + /** + * The raw Json Response from the pushover API + * @return String + */ + public String getResponse() { + return response; + } + + /** + * The HTTP status from the HTTP request + * @return int + */ + public int getHttpStatus() { + return httpStatus; + } + + /** + * True if request to pushover API returned HTTP code 200, false otherwise + * @return boolen + */ + public boolean isSuccessful() { + return successful; + } +} \ No newline at end of file diff --git a/src/main/java/de/svenkubiak/jpushover/enums/Constants.java b/src/main/java/de/svenkubiak/jpushover/enums/Constants.java new file mode 100644 index 0000000..8a56410 --- /dev/null +++ b/src/main/java/de/svenkubiak/jpushover/enums/Constants.java @@ -0,0 +1,25 @@ +package de.svenkubiak.jpushover.enums; + +public enum Constants { + PUSHOVER_URL("https://api.pushover.net/1/messages.json"), + MESSAGE("message"), + TITLE("title"), + DEVICE("device"), + USER("user"), + TOKEN("token"), + SOUND("sound"), + PRIORITY("priority"), + TIMESTAMP("timestamp"), + URL("url"), + URLTITLE("urltile"); + + private final String value; + + Constants (String value) { + this.value = value; + } + + public String value() { + return this.value; + } +} \ No newline at end of file diff --git a/src/main/java/de/svenkubiak/jpushover/enums/Priority.java b/src/main/java/de/svenkubiak/jpushover/enums/Priority.java new file mode 100644 index 0000000..f91c0fc --- /dev/null +++ b/src/main/java/de/svenkubiak/jpushover/enums/Priority.java @@ -0,0 +1,19 @@ +package de.svenkubiak.jpushover.enums; + +public enum Priority { + LOWEST("-2"), + LOW("-1"), + NORMAL("0"), + HIGH("1"), + EMERGENCY("2"); + + private final String value; + + Priority (String value) { + this.value = value; + } + + public String value() { + return this.value; + } +} \ No newline at end of file diff --git a/src/main/java/de/svenkubiak/jpushover/enums/Sound.java b/src/main/java/de/svenkubiak/jpushover/enums/Sound.java new file mode 100644 index 0000000..6cec88a --- /dev/null +++ b/src/main/java/de/svenkubiak/jpushover/enums/Sound.java @@ -0,0 +1,36 @@ +package de.svenkubiak.jpushover.enums; + +public enum Sound { + PUSHOVER("pushover"), + BIKE("bike"), + BUGLE("bugke"), + CASHREGISTET("cashregister"), + CLASSICAL("classical"), + COSMIC("cosmic"), + FALLING("falling"), + GAMELAN("gamelan"), + INCOMING("incoming"), + INTERMISSION("intermission"), + MAGIC("magic"), + MECHANICAL("mechanical"), + PIANOBAR("pianobar"), + SIREN("siren"), + SPACEALARM("spacealarm"), + TUGBOAT("tugboat"), + ALIEN("alien"), + CLIMB("climb"), + PERSISTENT("persistent"), + ECHO("echo"), + UPDOWN("updown"), + NONE("none"); + + private final String value; + + Sound (String value) { + this.value = value; + } + + public String value() { + return this.value; + } +} diff --git a/src/test/java/de/svenkubiak/jpushover/AppTest.java b/src/test/java/de/svenkubiak/jpushover/AppTest.java new file mode 100644 index 0000000..3a27e39 --- /dev/null +++ b/src/test/java/de/svenkubiak/jpushover/AppTest.java @@ -0,0 +1,10 @@ +package de.svenkubiak.jpushover; + +import org.junit.Test; + + +public class AppTest { + @Test + public void testApp() { + } +} \ No newline at end of file