The Java SmugMug API is a library written to wrap the SmugMug API 1.3.0. It is essentially designed to be as intuitive as possible, making it easy to include in your own project and quickly work with the api.
You can download the latest release in the Downloads section. The download includes the required libraries for the project also.
Below are the list of the top level projects that JSMA uses along with a link to their respective licenses for those that are interested.
- Jersey
Provides the infrastructure to make the api calls to SmugMug and parse the JSON response into Java objects. (License) - Simple Logging Facade for Java (SLF4J)
Used to handle logging in a way that will still allow you the freedom to pick whichever logging framework you would like. (License)
Example code can be found in the test directory. In order to run the examples you need to Apply for an API Key with SmugMug.
To run the examples you need to edit UserConfig.java and set APP_NAME, CONSUMER_SECRET, CONSUMER_KEY, OAUTH_TOKEN_ID, and OAUTH_TOKEN_SECRET with the appropriate values for your application and account. NOTE: You can get the values for OAUTH_TOKEN_ID and OAUTH_TOKEN_SECRET by settting the other three and running the AuthExample.
The current List of examples are:
- AuthExample - Good starting point to see how to get your application authorized with a users account.
- AlbumExample - Shows the basic functionality of working with the Albums API.
- ImageExample - Shows how to upload an image to SmugMug.
Then you just can just run all the examples, and they will pull the values from UserConfig.java.
If you encounter a bug or issue please create a New Issue here on Github after checking looking through the Other Issues to see if it has been reported already. If it has then feel free to comment on the existing issue with any additional information.
If you are creating a new issue, I request you put as much information as possible. Method called, with what parameters, if an exception is thrown then include the stacktrace. Basically all the info someone would need to debug the problem.
If there is a feature you want, pretty much follow the same procedure. Check if there is already an issue for it, if so feel free to comment, if not make one with as much detail of what you want as possible.
I will gladly accept pull requests for just about all aspects of the project. It you have a something you would like to contribute here is the general workflow at the moment (this may change as I become more familar with git):
- fork the project
- create a new branch
- make your additions/changes/fixes in the new branch
- submit a pull request with a fairly decent description of what it is about.
When writing your commit messages on your branch try to use a decent commit message. I am horrible about this myself. But basically enough that if someone else read it they would know the point of the changes. Feel free to call me out on this also, as I am trying to break my habit of writing commit messages that read "Fixed stuff" and "Really fixed stuff this time".
The current unit tests cover the Sample Responses given in the API documentation. It does not currently cover all possible mappings. Ideally I would eventually include unit tests to test all these mappings across the classes in the model pacakage.
It would be nice to provide a few examples of working with the api for each of the API classes. If you happen to to struggle with some aspect of using the library, it would be great to provide a solution via an example for others to learn from. I am not sure it is necessary to have an example of every possible call, but if someone wanted to do that or even just a few it would welcomed.
JSMA is released under the MIT License which is simple and easy to understand, while placing almost no restrictions on what you can do with the project.
MIT License (More Information)
Copyright (c) 2012 Jacob K. Schoen
http://github.com/jkschoen/jsmaPermission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.