https://github.com/raederdev/yoappserver
YoAppServer is a simple solution for creating server side applications that interact with the Yo developer API.
https://github.com/raederdev/yoappserver
Last synced: about 1 year ago
JSON representation
YoAppServer is a simple solution for creating server side applications that interact with the Yo developer API.
- Host: GitHub
- URL: https://github.com/raederdev/yoappserver
- Owner: RaederDev
- License: mit
- Created: 2014-09-07T12:51:49.000Z (almost 12 years ago)
- Default Branch: master
- Last Pushed: 2014-09-10T19:57:11.000Z (almost 12 years ago)
- Last Synced: 2025-04-02T16:01:46.337Z (about 1 year ago)
- Language: Java
- Homepage:
- Size: 3.12 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
YoAppServer
===========
YoAppServer is a simple solution for creating server side applications that interact with the Yo developer API. It is written in Java utilizing many OpenSource technologies. The Server itself is not only a fully functional webserver to handle callbacks but also offers a API to interact with the Yo API servers.
To get started download the already compiled jar file and the dependencies:
[https://github.com/DudeNamedBen/YoAppServer/blob/master/YoAppServer.zip][1]
or compile it from source using maven.
Once you have aquired the jar file put it into the folder where you want to run it from and execute the server using java:
java -jar YoAppServer.jar
The server will generate all needed configuration files and the apps folder. Once you have a working AppServer you can start developing your own apps.
Add the AppServer as a dependency to your Project and add a file called "app.json" in the root package of your project, the AppServer will read this configuration file when enabling your App.
{
"main": "your.package.app.App",
"name": "MyAwesomeYo",
"url": "/relativeCallbackUrl",
"apiKey": ""
}
- The main parameter must be the full class name (including package) of the class in your project that extends YoApp.
- The name parameter is the name of your project.
- The url parameter is a relative callback url that the app should listen for. For example when you server has the address mydomain.com the appserver would listen on port 4242 (if you haven't changed that in the configuration file) resulting in the base url of: http://mydomain.com:4242/, when you now specify that you app listens for /relativeCallbackUrl your app will be notified when the YoApp server accesses: http://mydomain.com:4242/relativeCallbackUrl. If you specify / as the url, the app will be notified on all valid requests, this can be useful to write for example a statistic app. It is possible to have multiple apps listen for the same url, all apps will be notified.
- The apiKey parameter should be your API key, if you don't want to specify it in your app configuration you can also override the getApiKey method of YoApp and ommit this entry.
Here you can find an example of what you can do with the API. The App will listen for incoming Yos and will fetch the current subscriber count once a yo is reveived, then it will yo the user back. All Operations are done asynchronously to avoid locking the main thread.
public class App extends YoApp {
private final YoCommunicator communicator;
public App() {
communicator = new YoCommunicator(this);
}
@Override
public void onDisable() {
System.out.println("App disable method called.");
}
@Override
public void onEnable() {
System.out.println("App enable method called.");
}
@Override
public void onMessage(String username, String url, String userSuppliedUrl) {
if(userSuppliedUrl != null) {
System.out.println("The user has sent the following Url: " + userSuppliedUrl);
}
try {
communicator.getSubscriberCount(new SuccessSubscriberCallback() {
@Override
public void run() {
if(getSuccess()) {
System.out.println("We have: " + getSubscribers() + " Subscribers!");
} else {
System.out.println("We have recveived an error: " + getError());
}
}
});
communicator.sendYo(new SuccessCallback() {
@Override
public void run() {
if(getSuccess()) {
System.out.println("The User has successfully received the Yo!");
} else {
System.out.println("An Error occured: " + getError());
}
}
}, username);
} catch (NoApiKeyException ex) {
Logger.getLogger(App.class.getName()).log(Level.SEVERE, null, ex);
}
}
}
Once you have finished writing your App compile it into a jar file, put it into the "apps" folder of your server and start the server. The server will automatically detect and load your app.
[1]: https://github.com/DudeNamedBen/YoAppServer/blob/master/YoAppServer.zip