Scarlet

A Retrofit inspired WebSocket client for Kotlin, Java, and Android.

License

License

GroupId

GroupId

com.tinder.scarlet
ArtifactId

ArtifactId

scarlet
Last Version

Last Version

0.1.12
Release Date

Release Date

Type

Type

jar
Description

Description

Scarlet
A Retrofit inspired WebSocket client for Kotlin, Java, and Android.
Project URL

Project URL

https://github.com/Tinder/Scarlet
Source Code Management

Source Code Management

https://github.com/Tinder/Scarlet

Download scarlet

How to add to project

<!-- https://jarcasting.com/artifacts/com.tinder.scarlet/scarlet/ -->
<dependency>
    <groupId>com.tinder.scarlet</groupId>
    <artifactId>scarlet</artifactId>
    <version>0.1.12</version>
</dependency>
// https://jarcasting.com/artifacts/com.tinder.scarlet/scarlet/
implementation 'com.tinder.scarlet:scarlet:0.1.12'
// https://jarcasting.com/artifacts/com.tinder.scarlet/scarlet/
implementation ("com.tinder.scarlet:scarlet:0.1.12")
'com.tinder.scarlet:scarlet:jar:0.1.12'
<dependency org="com.tinder.scarlet" name="scarlet" rev="0.1.12">
  <artifact name="scarlet" type="jar" />
</dependency>
@Grapes(
@Grab(group='com.tinder.scarlet', module='scarlet', version='0.1.12')
)
libraryDependencies += "com.tinder.scarlet" % "scarlet" % "0.1.12"
[com.tinder.scarlet/scarlet "0.1.12"]

Dependencies

compile (1)

Group / Artifact Type Version
com.tinder.scarlet : scarlet-core jar 0.1.12

runtime (7)

Group / Artifact Type Version
com.tinder.scarlet : scarlet-core-internal jar 0.1.12
com.tinder.scarlet : message-adapter-built-in jar 0.1.12
com.tinder.scarlet : stream-adapter-built-in jar 0.1.12
com.tinder.statemachine : statemachine jar 0.2.0
io.reactivex.rxjava2 : rxjava jar 2.1.16
io.reactivex.rxjava2 : rxkotlin jar 2.2.0
org.jetbrains.kotlin : kotlin-stdlib-jdk7 jar 1.4.31

test (6)

Group / Artifact Type Version
com.tinder.scarlet : test-utils jar 0.1.12
com.tinder.scarlet : stream-adapter-rxjava2 jar 0.1.12
junit : junit jar 4.12
com.nhaarman.mockitokotlin2 : mockito-kotlin jar 2.2.0
org.jetbrains.kotlin : kotlin-reflect jar 1.4.31
org.assertj : assertj-core jar 3.8.0

Project Modules

There are no modules declared in this project.

Scarlet

CircleCI

A Retrofit inspired WebSocket client for Kotlin, Java, and Android.

Update

We are working on a new version of Scarlet that supports other persistent connection protocols: ServerSentEvent, Socket IO, STOMP, and MQTT. It can be found on the 0.2.x branch.

Tutorial

Usage

In this example, we read the realtime Bitcoin price from Gdax WebSocket Feed. For more information, please check out the demo app.

Declare a WebSocket client using an interface:

interface GdaxService {
	@Receive
	fun observeWebSocketEvent(): Flowable<WebSocket.Event>
	@Send
	fun sendSubscribe(subscribe: Subscribe)
	@Receive
 	fun observeTicker(): Flowable<Ticker>
}

Use Scarlet to create an implementation:

val scarletInstance = Scarlet.Builder()
    .webSocketFactory(okHttpClient.newWebSocketFactory("wss://ws-feed.gdax.com"))
    .addMessageAdapterFactory(MoshiMessageAdapter.Factory())
    .addStreamAdapterFactory(RxJava2StreamAdapterFactory())
    .build()

val gdaxService = scarletInstance.create<GdaxService>()

Send a Subscribe message upon connection open and the server will start streaming tickers which contain the latest price.

val BITCOIN_TICKER_SUBSCRIBE_MESSAGE = Subscribe(
    productIds = listOf("BTC-USD"),
    channels = listOf("ticker")
)

gdaxService.observeWebSocketEvent()
    .filter { it is WebSocket.Event.OnConnectionOpened<*> }
    .subscribe({
        gdaxService.sendSubscribe(BITCOIN_TICKER_SUBSCRIBE_MESSAGE)
    })

gdaxService.observeTicker()
    .subscribe({ ticker ->
        Log.d("Bitcoin price is ${ticker.price} at ${ticker.time}")
    })

Android

Scarlet is driven by a StateMachine.

TODO

Download

Scarlet is available via Maven Central.

Snapshots of the development version are available in Sonatype's snapshots repository.

Maven:
<dependency>
    <groupId>com.tinder.scarlet</groupId>
    <artifactId>scarlet</artifactId>
    <version>0.1.12</version>
</dependency>
Gradle:
implementation 'com.tinder.scarlet:scarlet:0.1.12'

Plug-in Roadmap

WebSocket.Factory

  • OkHttpClient
  • MockHttpServer

MessageAdapter.Factory

  • moshi
  • gson
  • protobuf
  • jackson
  • simple-xml

StreamAdapter.Factory

  • RxJava2
  • RxJava1
  • Kotlin Coroutine

Lifecycle

  • AndroidLifecycle

BackoffStrategy

  • Linear
  • Exponential
  • ExponentialWithJitter

Copyright

Copyright (c) 2018, Match Group, LLC
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
    * Redistributions of source code must retain the above copyright
      notice, this list of conditions and the following disclaimer.
    * Redistributions in binary form must reproduce the above copyright
      notice, this list of conditions and the following disclaimer in the
      documentation and/or other materials provided with the distribution.
    * Neither the name of Match Group, LLC nor the names of its contributors
      may be used to endorse or promote products derived from this software
      without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL MATCH GROUP, LLC BE LIABLE FOR ANY
DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
com.tinder.scarlet

Tinder

Tinder Open Source Software

Versions

Version
0.1.12
0.1.11
0.1.10
0.1.9
0.1.8