NathanCheshire/JRoboHash

Intro

This library is a Java/JVM wrapper for the RoboHash image API.

Using with Gradle

This artifact is not deployed on Maven, thus you will need to use Jitpack to utilize this library. Make sure you have the following line in your repositories Gradle config (it is recommended that JitPack be at the end of the repositories section, source):

maven { url 'https://jitpack.io' }

Then add the following to your dependencies: implementation 'com.github.nathancheshire.jrobohash:COMMIT_HASH_OR_RELEASE'.

The COMMIT_HASH_OR_RELEASE may vary depending on the targeted version (commit SHA, or release) of JRoboHash you would like to use.

For example, both implementation 'com.github.nathancheshire.jrobohash:v1.0.0' and implementation 'com.github.nathancheshire.jrobohash:e755c39' would result in the same artifact.

API Support

This client features support for the comprehensive RoboHash API. Using a builder pattern, all supported URL parameters are configurable via this API.

Getting Started

Using the client is simplistic and intuitive yet also extensible should the requirement present itself. The default implementation of RoboHashRequestBuilder, that of RoboHashRequestBuilderImpl, allows for the following as an example:

RoboHashRequestBuilder requestBuilder = new RoboHashRequestBuilderImpl('MY_AVATAR_KEY')
        .addImageSet(ImageSet.MONSTERS)
        .addImageSet(ImageSet.HUMANS)
        .setSize(new Dimension(500,500))
        .setImageExtension(ImageExtension.JPEG);

There are of course additional mutators exposed by RoboHashRequestBuilders to allow customization of all URL parameters supported by the RoboHash API.

You may pass a RoboHashRequestBuilder instance to the RoboHashRequestHandler to generate URLs, load images into memory, and save images which reflect the state of a RoboHashRequestBuilder instance.

// Build a URL
String builtUrl = RoboHashRequestHandler.buildRequestUrl(requestBuilder);
// Save the image to a file
RoboHashRequestHandler.saveToFile(requestBuilder,new File("./path/to/my/file/my_image.jpeg"));

Contributing

If you think a feature is missing, or have an idea for improvement, then by all means contribute! Make sure to follow clean-code styles. I closely follow the principles set forth in books such as Effective Java by Joshua Bloch, Clean Code, and The Clean Coder by Robert Cecil Martin.

General guidelines are as follows:

Make sure your implementation closely matches the implementation you see present in the source files (same code style)
Make sure to add Javadoc to every member, field, class, method, etc.
Make sure to write unit tests if applicable for your added code and update any tests which might be failing due to a modification you made
Make sure all unit tests are passing before you submit a PR for review
Make sure that code coverage is maintained at 100% before you submit a PR for review

Issues

Specific issue formats are not important. Simply ensure an issue exists and is assigned to you before starting on a task or bug fix. If you create a PR, make sure it references the issue.

Resources

RoboHash API Docs

Raw link: https://robohash.org/

RoboHash GitHub

Raw link: https://github.com/e1ven/Robohash

NathanCheshire / JRoboHash