Http ActionService

REST service for Janet. Supports fully customizable requests, http-clients and converters.

Getting Started

1. Define service and add it to Janet

ActionService httpService = new HttpActionService(API_URL, new OkClient(), new GsonConverter(new Gson()))
Janet janet = new Janet.Builder().addService(httpService).build();

Service requires: End-point url, HttpClient and Converter.

2. Define Request-Response action class

@HttpAction(value = "/demo", method = HttpAction.Method.GET)
public class ExampleAction {
  @Response ExampleDataModel responseData;
}

Each action is an individual class that contains all information about the request and response. It must be annotated with @HttpAction

3. Use ActionPipe to send/observe action

ActionPipe<ExampleAction> actionPipe = janet.createPipe(ExampleAction.class);
actionPipe
  .createObservable(new ExampleAction())
  .subscribeOn(Schedulers.io())
  .subscribe(new ActionStateSubscriber<ExampleAction>()
          .onProgress((action, progress) -> System.out.println("Current progress: " + progress))
          .onSuccess(action -> System.out.println("Got example " + action))
          .onFail((action, throwable) -> System.err.println("Bad things happened " + throwable))
  );

Http Action Configuration

Request path, method and type are defined by @HttpAction annotation:

• value – url path
• method – get/post/put/delete/head/patch
• type –  simple/multipart/form_url_encoded

To configure request, Action fields can be annotated with:

• @Path for path value
• @Url rewrites full url or suffixes
• @Query for request URL parameters
• @Body for POST request body
• @Field for request fields if request type is HttpAction.Type.FORM_URL_ENCODED
• @Part for multipart request parts
• @RequestHeader for request headers

To process response, special annotations can be used:

• @Response for getting response body.
• @Status for getting response status. Field types Integer, Long, int or long can be used to get status code or use boolean to know that request was sent successfully
• @ResponseHeader for getting response headers

Example:

@HttpAction(
        value = "/demo/{examplePath}/info",
        method = HttpAction.Method.GET,
        type = HttpAction.Type.SIMPLE
)
public class ExampleAction {
    // Request params
    @Path("examplePath") String pathValue;
    @Query("someParam") int queryParam;
    @RequestHeader("Example-RequestHeader-Name") String requestHeaderValue;
    // Response data
    @Status int statusCode;
    @Response ExampleDataModel exampleDataModel;
    @ResponseHeader("Example-ResponseHeader-Name") String responseHeaderValue;
}

Advanced bits

• supports request progress;
• supports request cancelation;
• provides useful HttpException for failed requests;
• supports action inheritance
• based on annotation processing
• consider using javac option '-Ajanet.http.factory.class.suffix=MyLib' or kotlin's kapt.arguments{ arg(“janet.http.factory.class.suffix”, “MyLib”)}) for api libraries. See Sample Library

Kotlin support

Kotlin action classes are supported except internal modifier. See TestProgressAction as example.

Download

repositories {
    jcenter()
    maven { url "https://jitpack.io" }
}

dependencies {
    implementation 'com.github.janet-io.janet-http:service:xxx'
    apt     'com.github.janet-io.janet-http:service-compiler:xxx'
    implementation 'com.github.janet-io.janet-http:client-okhttp:xxx'
    implementation 'com.github.janet-io.janet-converters:gson:yyy'
    // it is recommended you also explicitly depend on latest Janet version for bug fixes and new features.
    implementation 'com.github.janet-io:janet:zzz' 
}

• janet:
• janet-http:
• janet-converters:

Recipes

• Authorize requests via ActionServiceWrapper, e.g. AuthWrapper
• Log requests via HttpClient or ActionServiceWrapper, e.g. SampleLoggingService
• Convert Retrofit interfaces into actions with Converter Util
• Write tests using MockHttpActionService
• See more samples: Simple Android app, Advanced Android app

Proguard

• Add Rules to your proguard config.
• See Android Sample for complete proguard config example.

Notes

HttpActionService is highly inspired by Retrofit2 – thanks guys, it's awesome! We put our effort to make it even more flexible and reusable, so everyone who loves Retrofit and reactive approach should give it a try.

License

Copyright (c) 2018 Techery

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.