rxunfurl's Introduction

RxUnfurl

A reactive extension to generate URL previews.

This library parses available open graph data from the provided url and returns them as a simple model class. Otherwise, the library searches for other fallbacks and returns them instead.

Image dimensions are read from its uri by fetching the required bytes and then sorted according to their resolution.

Gradle dependency

To use the library, add the following dependency to your build.gradle

dependencies {
	compile 'com.schinizer:rxunfurl:0.1.1'
}

Usage

To generate previews, simply subscribe to RxUnfurl.generatePreview(yourURL).

If you are on android, you will need RxAndroid to subscribe to network calls on another thread.

RxUnfurl.generatePreview("http://9gag.com")
    .subscribeOn(Schedulers.io())
    .observeOn(AndroidSchedulers.mainThread())
    .subscribe(new Action1<PreviewData>() {
        @Override
        public void call(PreviewData previewData) {
           
        }
    }, new Action1<Throwable>() {
        @Override
        public void call(Throwable throwable) {
	
        }
    });

This library uses okhttp for network calls. If you will like to supply your instance, call:

RxUnfurl.setInternalClient(yourOKhttpClient);

Sample App

You may find a sample android implementation in /app.

License

Copyright 2016 Schinizer

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.

Recommend Projects