Offline data caching

Offline App (or Offline-First App) enables user to seamlessly interact with it by using local device storage and then synchronizing the data with some remote storage (cloud database, etc) later via a background process.

Author: SamsetDev

.idea/codeStyles/Project.xml

@@ -0,0 +1 @@
+/build

.idea/misc.xml

@@ -0,0 +1,107 @@
+apply plugin: 'com.android.application'
+apply plugin: 'kotlin-android'
+apply plugin: 'kotlin-android-extensions'
+
+android {
+    compileSdkVersion 28
+    defaultConfig {
+        applicationId "com.samset.retrooffline"
+        minSdkVersion 15
+        targetSdkVersion 28
+        versionCode 1
+        versionName "1.0"
+        multiDexEnabled true
+        vectorDrawables.useSupportLibrary = true
+        testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
+    }
+    buildTypes {
+        release {
+            minifyEnabled false
+            proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
+        }
+    }
+    compileOptions {
+        sourceCompatibility = '1.8'
+        targetCompatibility = '1.8'
+    }
+
+    
+}
+
+dependencies {
+    implementation fileTree(dir: 'libs', include: ['*.jar'])
+
+    /*
+   * LIBRARY HEADER 2: ANDROID SUPPORT ************************************************************
+   */
+
+    implementation "androidx.cardview:cardview:$support"
+    implementation "androidx.appcompat:appcompat:$support"
+    //implementation "com.google.android.material:material:$support"
+    implementation "androidx.constraintlayout:constraintlayout:$constraintlayout"
+
+    /*
+    * LIBRARY HEADER 2: KOTLIN SUPPORT *************************************************************
+    */
+    implementation "org.jetbrains.kotlin:kotlin-stdlib:$rootProject.kotlin_version"
+
+    /*
+    * LIBRARY HEADER 1: JETPACK  *******************************************************************
+    */
+
+
+    /*
+    * LIBRARY HEADER 4: OTHER LIBRARIES ************************************************************
+    */
+    implementation 'com.intuit.sdp:sdp-android:1.0.4'
+    implementation "com.android.support:multidex:$multiDex"
+    implementation 'com.android.support:recyclerview-v7:28.0.0-alpha1'
+    implementation 'androidx.legacy:legacy-support-v4:1.0.0-alpha1'
+    annotationProcessor "com.android.databinding:compiler:$databinding"
+
+
+    /*
+    * Step 2: Adding image library
+    */
+    implementation "com.squareup.picasso:picasso:$rootProject.picassoVersion"
+    implementation "de.hdodenhof:circleimageview:$rootProject.circleimageVersion"
+    implementation "com.jakewharton.picasso:picasso2-okhttp3-downloader:$rootProject.picassodownloaderVersion"
+
+    /*
+    * LIBRARY HEADER 5: RETROFIT  ******************************************************************
+    */
+
+    /*
+    * Step 1: Adding retrofit library
+    */
+    implementation "com.squareup.retrofit2:retrofit:$rootProject.retrofit"
+    implementation "com.squareup.retrofit2:converter-gson:$rootProject.retrofit"
+    implementation "com.squareup.retrofit2:converter-scalars:$rootProject.retrofit"
+    implementation "com.squareup.retrofit2:adapter-rxjava2:$rootProject.retrofit"
+    implementation "com.squareup.okhttp3:logging-interceptor:$rootProject.intercepter"
+    implementation "com.jakewharton.retrofit:retrofit2-rxjava2-adapter:$rootProject.adapter"
+
+    /*
+    * Step 1: Adding volley,Gson and rx library
+    */
+
+    implementation 'com.google.guava:guava:19.0' // for google caching
+   // implementation "com.google.code.gson:gson:$rootProject.gson"
+    implementation "io.reactivex.rxjava2:rxjava:$rootProject.rxjava"
+    implementation "io.reactivex.rxjava2:rxandroid:$rootProject.rxandroid"
+
+    /*
+    * LIBRARY HEADER 6: DAGGER DEPENDENCY  *********************************************************
+    */
+    implementation "com.google.dagger:dagger:$rootProject.dagger"
+    implementation "com.google.dagger:dagger-android:$rootProject.dagger"
+    implementation "com.google.dagger:dagger-android-support:$rootProject.dagger"
+    annotationProcessor "com.google.dagger:dagger-compiler:$rootProject.dagger"
+    annotationProcessor "com.google.dagger:dagger-android-processor:$rootProject.dagger"
+
+
+
+    testImplementation 'junit:junit:4.12'
+    androidTestImplementation 'androidx.test:runner:1.1.0-alpha3'
+    androidTestImplementation 'androidx.test.espresso:espresso-core:3.1.0-alpha3'
+}

.idea/modules.xml

@@ -0,0 +1,21 @@
+# Add project specific ProGuard rules here.
+# You can control the set of applied configuration files using the
+# proguardFiles setting in build.gradle.
+#
+# For more details, see
+#   http://developer.android.com/guide/developing/tools/proguard.html
+
+# If your project uses WebView with JS, uncomment the following
+# and specify the fully qualified class name to the JavaScript interface
+# class:
+#-keepclassmembers class fqcn.of.javascript.interface.for.webview {
+#   public *;
+#}
+
+# Uncomment this to preserve the line number information for
+# debugging stack traces.
+#-keepattributes SourceFile,LineNumberTable
+
+# If you keep the line number information, uncomment this to
+# hide the original source file name.
+#-renamesourcefileattribute SourceFile

.idea/runConfigurations.xml

@@ -0,0 +1,27 @@
+package com.samset.retrooffline;
+
+import android.content.Context;
+
+import androidx.test.InstrumentationRegistry;
+import androidx.test.runner.AndroidJUnit4;
+
+import org.junit.Test;
+import org.junit.runner.RunWith;
+
+import static org.junit.Assert.*;
+
+/**
+ * Instrumented test, which will execute on an Android device.
+ *
+ * @see <a href="http://d.android.com/tools/testing">Testing documentation</a>
+ */
+@RunWith(AndroidJUnit4.class)
+public class ExampleInstrumentedTest {
+    @Test
+    public void useAppContext() {
+        // Context of the app under test.
+        Context appContext = InstrumentationRegistry.getTargetContext();
+
+        assertEquals("com.samset.retrooffline", appContext.getPackageName());
+    }
+}

.idea/vcs.xml

@@ -0,0 +1,25 @@
+<?xml version="1.0" encoding="utf-8"?>
+<manifest xmlns:android="http://schemas.android.com/apk/res/android"
+    package="com.samset.retrooffline">
+
+    <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
+    <uses-permission android:name="android.permission.ACCESS_WIFI_STATE" />
+    <uses-permission android:name="android.permission.INTERNET"/>
+    <application
+        android:name=".AppApplication"
+        android:allowBackup="true"
+        android:icon="@mipmap/ic_launcher"
+        android:label="@string/app_name"
+        android:roundIcon="@mipmap/ic_launcher_round"
+        android:supportsRtl="true"
+        android:theme="@style/AppTheme">
+        <activity android:name=".ui.MainActivity">
+            <intent-filter>
+                <action android:name="android.intent.action.MAIN" />
+
+                <category android:name="android.intent.category.LAUNCHER" />
+            </intent-filter>
+        </activity>
+    </application>
+
+</manifest>

app/.gitignore

@@ -0,0 +1,28 @@
+package com.samset.retrooffline;
+
+import android.app.Application;
+
+import com.squareup.picasso.Picasso;
+
+import javax.inject.Inject;
+
+import androidx.multidex.MultiDex;
+
+/**
+ * Copyright (C) RetrofitOfflineSample - All Rights Reserved
+ * Unauthorized copying of this file, via any medium is strictly prohibited Proprietary and confidential.
+ * <p>
+ * Created by samset on 15/03/19 at 1:52 PM for RetrofitOfflineSample .
+ */
+
+
+public class AppApplication extends Application {
+
+    @Override
+    public void onCreate() {
+        super.onCreate();
+        MultiDex.install(this);
+
+    }
+
+}

app/build.gradle

@@ -0,0 +1,19 @@
+package com.samset.retrooffline.model;
+
+import java.io.Serializable;
+
+/**
+ * Copyright (C) RetrofitOfflineSample - All Rights Reserved
+ * Unauthorized copying of this file, via any medium is strictly prohibited Proprietary and confidential.
+ * <p>
+ * Created by samset on 16/03/19 at 12:23 PM for RetrofitOfflineSample .
+ */
+
+
+public class BasicResponse implements Serializable {
+    private String name;
+
+    public String getName() {
+        return name;
+    }
+}

app/proguard-rules.pro

@@ -0,0 +1,34 @@
+package com.samset.retrooffline.model;
+
+import java.io.Serializable;
+
+/**
+ * Copyright (C) RetrofitOfflineSample - All Rights Reserved
+ * Unauthorized copying of this file, via any medium is strictly prohibited Proprietary and confidential.
+ * <p>
+ * Created by samset on 16/03/19 at 12:24 PM for RetrofitOfflineSample .
+ */
+
+
+public class JSONResponses implements Serializable {
+
+    private String id;
+    private String image;
+    public String getId() {
+        return id;
+    }
+
+    public void setId(String id) {
+        this.id = id;
+    }
+
+
+
+    public String getImage() {
+        return image;
+    }
+
+    public void setImage(String image) {
+        this.image = image;
+    }
+}

app/src/androidTest/java/com/samset/retrooffline/ExampleInstrumentedTest.java

@@ -0,0 +1,26 @@
+package com.samset.retrooffline.network;
+
+import com.samset.retrooffline.model.BasicResponse;
+
+import java.util.List;
+
+import retrofit2.Call;
+import retrofit2.http.GET;
+import retrofit2.http.Path;
+
+/**
+ * Copyright (C) RetrofitOfflineSample - All Rights Reserved
+ * Unauthorized copying of this file, via any medium is strictly prohibited Proprietary and confidential.
+ * <p>
+ * Created by samset on 16/03/19 at 12:18 PM for RetrofitOfflineSample .
+ */
+
+
+public interface ApiService {
+
+    @GET("/users/{user}/repos")
+    Call<List<BasicResponse>> reposForuser(@Path("user") String user);
+
+
+
+}