dimitrovskif/SmartCache

A library for preloaded Retrofit responses.

Download

Step 1. Add the JitPack repository to your build file

Add it in your root settings.gradle at the end of repositories:

	dependencyResolutionManagement {
		repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
		repositories {
			mavenCentral()
			maven { url 'https://jitpack.io' }
		}
	}

Add it in your settings.gradle.kts at the end of repositories:

	dependencyResolutionManagement {
		repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
		repositories {
			mavenCentral()
			maven { url = uri("https://jitpack.io") }
		}
	}

Add to pom.xml

	<repositories>
		<repository>
		    <id>jitpack.io</id>
		    <url>https://jitpack.io</url>
		</repository>
	</repositories>

Add it in your build.sbt at the end of resolvers:

 
    resolvers += "jitpack" at "https://jitpack.io"

Add it in your project.clj at the end of repositories:

 
    :repositories [["jitpack" "https://jitpack.io"]]

Step 2. Add the dependency

	dependencies {
		implementation 'com.github.dimitrovskif:smartcache:0.2'
	}

	dependencies {
		implementation("com.github.dimitrovskif:smartcache:0.2")
	}

	<dependency>
	    <groupId>com.github.dimitrovskif</groupId>
	    <artifactId>smartcache</artifactId>
	    <version>0.2</version>
	</dependency>


                            
    libraryDependencies += "com.github.dimitrovskif" % "smartcache" % "0.2"


                            
    :dependencies [[com.github.dimitrovskif/smartcache "0.2"]]

Readme

SmartCache - preloaded responses for Retrofit 2

This library calls your callback twice: first cached, then fresh data

Instead of showing an empty screen while waiting for a network response, why not load the latest successful response from storage?

Responses are saved in device storage & RAM
No extra logic, only Call<T> becomes SmartCall<T>
Extend your own adapters for other caching strategies

Install and use

Gradle installation:

repositories {
    ...
    maven { url "https://jitpack.io" }
}
    
dependencies {
    compile 'com.github.dimitrovskif:SmartCache:0.2'
}

Enable SmartCallFactory:

SmartCallFactory smartFactory = new SmartCallFactory(BasicCaching.fromCtx(this));
Retrofit retrofit = new Retrofit.Builder()
    .baseUrl("http://myapi.com")
    .addCallAdapterFactory(smartFactory) // add this!
    .build();

Replace Call<T> with SmartCall<T>.

public interface GitHubService {
  @GET("/users/{user}/repos")
  SmartCall<List<Repo>> listRepos(@Path("user") String user);
}

How it works

fff

One request corresponds to two responses: a cache response and a network response. Loading content from your phone is faster than loading from network; therefore your app will show stale content while waiting for a fresh network response. (Note: If the network response comes first, cache won't happen.)

License

Copyright 2019 Filip Dimitrovski

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.