rxrapidapi / rxrapidapi Goto Github PK

Show the power of the dark side!

@Application(project = BuildConfig.PROJECT, key = BuildConfig.API_KEY)
public interface HackerNewsApi {
    @ApiPackage("HackerNews")
    Observable<Map<String, Object>> getBestStories();
}

Throws an exception when invoked: java.lang.IllegalStateException: Multipart body must have at least one part.

Integrate project with waffle.io

Points of note:

• Keep the RxRapidApiBuilder.from() convenience method.
• Implement RxRapidApiBuilder.from() in terms of the builder pattern.
• Have tests that use both the RxRapidApiBuilder.from() and builder pattern.
• Other stories to follow once the builder pattern is available.

• Document the need for a NASA API key in local.properties
• Choose which API call to make - getPictureOfTheDay - https://rapidapi.com/package/NasaAPI/functions/getPictureOfTheDay
• Build the GUI

Once the builder pattern is available, add an .application(project, key) method to the builder to allow the @Application annotation to become optional.

Basic "README" page is up with a stock template. What still needs to be done:

• Getting started
• Configuration + Builder
• Contribution Guide (yes, pull requests accepted, but keep the tests passing and static code analysis clean)

The RxRapidApiBuilder silently assumes that a KeyValueMapProcessor will work when no parameterized type is specified as a return value. This should probably throw an exception instead.

See: https://github.com/ReactiveX/RxJava/wiki/What's-different-in-2.0

As things stand, there's no way to point this SDK at an enterprise installation of RapidAPI. Consider how to override the hard-coded server in the builder interface.

Passing a null as an optional value gets encoded as the String "null" right now. It ought to skip that value entirely.

The current SDK only sends "data" parameters, not "file".

In addition to declaring interface methods as returning Observable<>, the SDK should support users who want them to return Single<>.

Notes

A Single is something like an Observable, but instead of emitting a series of values — anywhere from none at all to an infinite number — it always either emits one value or an error notification.

• onSuccess - a Single passes this method the sole item that the Single emits
• onError - a Single passes this method the Throwable that caused the Single to be unable to emit an item

A Single will call only one of these methods, and will only call it once. Upon calling either method, the Single terminates and the subscription to it ends.

When the "success" return value is obviously JSON formatted but is coming back as a String, is there anything that the SDK can do to (maybe) parse it automatically?

Create a snippet that developers can copy and paste into their code.

For reference:
The Android snippet looks like that:

import com.rapidapi.rapidconnect.RapidApiConnect;\n\nRapidApiConnect connect = new RapidApiConnect(PROJECT, KEY);\n\nMap<String, Argument> body = new HashMap<String, Argument>();\n\nparamslist\n\n
    try { \n\tMap<String, Object> response = connect.call(packagename, blockname, body);\nif(response.get(\"success\") != null) { \n\n\n } else{ \n\n\n } \n} catch(Exception e){ \n\n\n }

where PROJECT, KEY and paramlist are dynamically replaced with the project's details.

Make the @ApiPackage annotation work like @Application to reduce noise in interface definitions.

When calling APIs that require an API key in every method, it would be nice to reduce the interface noise and specify this parameter as a default.

Take a look at EventBrite as an example (there may be others) - looks like there are websocket based webhooks that can be handled.

See also: https://github.com/RapidSoftwareSolutions/rapidapi-android-sdk

Run through the wiki

• Javadoc
• Make sure that everything is polished
• Document fully-formed API interfaces in the demo
• Showing the latest versions / latest annotations
• Display best practices up-front
• All builder methods