├── .gitignore ├── .travis.yml ├── LICENSE.txt ├── README.md ├── build.gradle ├── gradle.properties ├── gradle └── wrapper │ ├── gradle-wrapper.jar │ └── gradle-wrapper.properties ├── gradlew ├── gradlew.bat ├── okcache-control ├── .gitignore ├── build.gradle ├── gradle.properties └── src │ ├── main │ └── java │ │ └── com │ │ └── ncornette │ │ └── cache │ │ └── OkCacheControl.java │ └── test │ └── java │ └── com │ └── ncornette │ └── cache │ ├── BuilderTest.java │ └── OkCacheControlTest.java └── settings.gradle /.gitignore: -------------------------------------------------------------------------------- 1 | *.iml 2 | .gradle 3 | /local.properties 4 | /.idea/workspace.xml 5 | /.idea/libraries 6 | .DS_Store 7 | /build -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | language: java 2 | 3 | after_success: 4 | - bash <(curl -s https://codecov.io/bash) -------------------------------------------------------------------------------- /LICENSE.txt: -------------------------------------------------------------------------------- 1 | 2 | Apache License 3 | Version 2.0, January 2004 4 | http://www.apache.org/licenses/ 5 | 6 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 7 | 8 | 1. Definitions. 9 | 10 | "License" shall mean the terms and conditions for use, reproduction, 11 | and distribution as defined by Sections 1 through 9 of this document. 12 | 13 | "Licensor" shall mean the copyright owner or entity authorized by 14 | the copyright owner that is granting the License. 15 | 16 | "Legal Entity" shall mean the union of the acting entity and all 17 | other entities that control, are controlled by, or are under common 18 | control with that entity. For the purposes of this definition, 19 | "control" means (i) the power, direct or indirect, to cause the 20 | direction or management of such entity, whether by contract or 21 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 22 | outstanding shares, or (iii) beneficial ownership of such entity. 23 | 24 | "You" (or "Your") shall mean an individual or Legal Entity 25 | exercising permissions granted by this License. 26 | 27 | "Source" form shall mean the preferred form for making modifications, 28 | including but not limited to software source code, documentation 29 | source, and configuration files. 30 | 31 | "Object" form shall mean any form resulting from mechanical 32 | transformation or translation of a Source form, including but 33 | not limited to compiled object code, generated documentation, 34 | and conversions to other media types. 35 | 36 | "Work" shall mean the work of authorship, whether in Source or 37 | Object form, made available under the License, as indicated by a 38 | copyright notice that is included in or attached to the work 39 | (an example is provided in the Appendix below). 40 | 41 | "Derivative Works" shall mean any work, whether in Source or Object 42 | form, that is based on (or derived from) the Work and for which the 43 | editorial revisions, annotations, elaborations, or other modifications 44 | represent, as a whole, an original work of authorship. For the purposes 45 | of this License, Derivative Works shall not include works that remain 46 | separable from, or merely link (or bind by name) to the interfaces of, 47 | the Work and Derivative Works thereof. 48 | 49 | "Contribution" shall mean any work of authorship, including 50 | the original version of the Work and any modifications or additions 51 | to that Work or Derivative Works thereof, that is intentionally 52 | submitted to Licensor for inclusion in the Work by the copyright owner 53 | or by an individual or Legal Entity authorized to submit on behalf of 54 | the copyright owner. For the purposes of this definition, "submitted" 55 | means any form of electronic, verbal, or written communication sent 56 | to the Licensor or its representatives, including but not limited to 57 | communication on electronic mailing lists, source code control systems, 58 | and issue tracking systems that are managed by, or on behalf of, the 59 | Licensor for the purpose of discussing and improving the Work, but 60 | excluding communication that is conspicuously marked or otherwise 61 | designated in writing by the copyright owner as "Not a Contribution." 62 | 63 | "Contributor" shall mean Licensor and any individual or Legal Entity 64 | on behalf of whom a Contribution has been received by Licensor and 65 | subsequently incorporated within the Work. 66 | 67 | 2. Grant of Copyright License. Subject to the terms and conditions of 68 | this License, each Contributor hereby grants to You a perpetual, 69 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 70 | copyright license to reproduce, prepare Derivative Works of, 71 | publicly display, publicly perform, sublicense, and distribute the 72 | Work and such Derivative Works in Source or Object form. 73 | 74 | 3. Grant of Patent License. Subject to the terms and conditions of 75 | this License, each Contributor hereby grants to You a perpetual, 76 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 77 | (except as stated in this section) patent license to make, have made, 78 | use, offer to sell, sell, import, and otherwise transfer the Work, 79 | where such license applies only to those patent claims licensable 80 | by such Contributor that are necessarily infringed by their 81 | Contribution(s) alone or by combination of their Contribution(s) 82 | with the Work to which such Contribution(s) was submitted. If You 83 | institute patent litigation against any entity (including a 84 | cross-claim or counterclaim in a lawsuit) alleging that the Work 85 | or a Contribution incorporated within the Work constitutes direct 86 | or contributory patent infringement, then any patent licenses 87 | granted to You under this License for that Work shall terminate 88 | as of the date such litigation is filed. 89 | 90 | 4. Redistribution. You may reproduce and distribute copies of the 91 | Work or Derivative Works thereof in any medium, with or without 92 | modifications, and in Source or Object form, provided that You 93 | meet the following conditions: 94 | 95 | (a) You must give any other recipients of the Work or 96 | Derivative Works a copy of this License; and 97 | 98 | (b) You must cause any modified files to carry prominent notices 99 | stating that You changed the files; and 100 | 101 | (c) You must retain, in the Source form of any Derivative Works 102 | that You distribute, all copyright, patent, trademark, and 103 | attribution notices from the Source form of the Work, 104 | excluding those notices that do not pertain to any part of 105 | the Derivative Works; and 106 | 107 | (d) If the Work includes a "NOTICE" text file as part of its 108 | distribution, then any Derivative Works that You distribute must 109 | include a readable copy of the attribution notices contained 110 | within such NOTICE file, excluding those notices that do not 111 | pertain to any part of the Derivative Works, in at least one 112 | of the following places: within a NOTICE text file distributed 113 | as part of the Derivative Works; within the Source form or 114 | documentation, if provided along with the Derivative Works; or, 115 | within a display generated by the Derivative Works, if and 116 | wherever such third-party notices normally appear. The contents 117 | of the NOTICE file are for informational purposes only and 118 | do not modify the License. You may add Your own attribution 119 | notices within Derivative Works that You distribute, alongside 120 | or as an addendum to the NOTICE text from the Work, provided 121 | that such additional attribution notices cannot be construed 122 | as modifying the License. 123 | 124 | You may add Your own copyright statement to Your modifications and 125 | may provide additional or different license terms and conditions 126 | for use, reproduction, or distribution of Your modifications, or 127 | for any such Derivative Works as a whole, provided Your use, 128 | reproduction, and distribution of the Work otherwise complies with 129 | the conditions stated in this License. 130 | 131 | 5. Submission of Contributions. Unless You explicitly state otherwise, 132 | any Contribution intentionally submitted for inclusion in the Work 133 | by You to the Licensor shall be under the terms and conditions of 134 | this License, without any additional terms or conditions. 135 | Notwithstanding the above, nothing herein shall supersede or modify 136 | the terms of any separate license agreement you may have executed 137 | with Licensor regarding such Contributions. 138 | 139 | 6. Trademarks. This License does not grant permission to use the trade 140 | names, trademarks, service marks, or product names of the Licensor, 141 | except as required for reasonable and customary use in describing the 142 | origin of the Work and reproducing the content of the NOTICE file. 143 | 144 | 7. Disclaimer of Warranty. Unless required by applicable law or 145 | agreed to in writing, Licensor provides the Work (and each 146 | Contributor provides its Contributions) on an "AS IS" BASIS, 147 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 148 | implied, including, without limitation, any warranties or conditions 149 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 150 | PARTICULAR PURPOSE. You are solely responsible for determining the 151 | appropriateness of using or redistributing the Work and assume any 152 | risks associated with Your exercise of permissions under this License. 153 | 154 | 8. Limitation of Liability. In no event and under no legal theory, 155 | whether in tort (including negligence), contract, or otherwise, 156 | unless required by applicable law (such as deliberate and grossly 157 | negligent acts) or agreed to in writing, shall any Contributor be 158 | liable to You for damages, including any direct, indirect, special, 159 | incidental, or consequential damages of any character arising as a 160 | result of this License or out of the use or inability to use the 161 | Work (including but not limited to damages for loss of goodwill, 162 | work stoppage, computer failure or malfunction, or any and all 163 | other commercial damages or losses), even if such Contributor 164 | has been advised of the possibility of such damages. 165 | 166 | 9. Accepting Warranty or Additional Liability. While redistributing 167 | the Work or Derivative Works thereof, You may choose to offer, 168 | and charge a fee for, acceptance of support, warranty, indemnity, 169 | or other liability obligations and/or rights consistent with this 170 | License. However, in accepting such obligations, You may act only 171 | on Your own behalf and on Your sole responsibility, not on behalf 172 | of any other Contributor, and only if You agree to indemnify, 173 | defend, and hold each Contributor harmless for any liability 174 | incurred by, or claims asserted against, such Contributor by reason 175 | of your accepting any such warranty or additional liability. 176 | 177 | END OF TERMS AND CONDITIONS 178 | 179 | APPENDIX: How to apply the Apache License to your work. 180 | 181 | To apply the Apache License to your work, attach the following 182 | boilerplate notice, with the fields enclosed by brackets "[]" 183 | replaced with your own identifying information. (Don't include 184 | the brackets!) The text should be enclosed in the appropriate 185 | comment syntax for the file format. We also recommend that a 186 | file or class name and description of purpose be included on the 187 | same "printed page" as the copyright notice for easier 188 | identification within third-party archives. 189 | 190 | Copyright [yyyy] [name of copyright owner] 191 | 192 | Licensed under the Apache License, Version 2.0 (the "License"); 193 | you may not use this file except in compliance with the License. 194 | You may obtain a copy of the License at 195 | 196 | http://www.apache.org/licenses/LICENSE-2.0 197 | 198 | Unless required by applicable law or agreed to in writing, software 199 | distributed under the License is distributed on an "AS IS" BASIS, 200 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 201 | See the License for the specific language governing permissions and 202 | limitations under the License. 203 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # OkCacheControl 2 | 3 | [![Build Status](https://travis-ci.org/ncornette/OkCacheControl.svg?branch=master)](https://travis-ci.org/ncornette/OkCacheControl) 4 | [![Codacy Badge](https://api.codacy.com/project/badge/Grade/b566a6e4564e4393b78b7b4b36a70452)](https://www.codacy.com/app/nicolas-cornette/OkCacheControl?utm_source=github.com&utm_medium=referral&utm_content=ncornette/OkCacheControl&utm_campaign=Badge_Grade) 5 | [![codecov](https://codecov.io/gh/ncornette/OkCacheControl/branch/master/graph/badge.svg)](https://codecov.io/gh/ncornette/OkCacheControl) 6 | [ ![Download](https://api.bintray.com/packages/ncornette/maven/okcache-control/images/download.svg) ](https://bintray.com/ncornette/maven/okcache-control/_latestVersion) 7 | 8 | Helper class to configure cache behaviour of OkHttp client, also works 9 | with Retrofit for Android. 10 | 11 | Release version is available on jcenter: 12 | ```groovy 13 | repositories { 14 | jcenter() 15 | } 16 | dependencies { 17 | compile 'com.ncornette.cache:okcache-control:1.1.1' 18 | } 19 | ``` 20 | 21 | ## Usage 22 | 23 | Initialize `OkCacheControl` with *OkHttpClient.Builder()*, then you can 24 | call 2 extra methods : 25 | 26 | - `overrideServerCachePolicy(MaxAgeControl)` 27 | - `forceCacheWhenOffline(NetworkMonitor)` 28 | 29 | ```java 30 | okClient = OkCacheControl.on(new OkHttpClient.Builder()) 31 | .overrideServerCachePolicy(30, MINUTES) 32 | .forceCacheWhenOffline(networkMonitor) 33 | .apply() // return to the OkHttpClient.Builder instance 34 | .cache(cache) 35 | .build(); 36 | 37 | ``` 38 | 39 | ## Description 40 | 41 | 42 | - `overrideServerCachePolicy(MaxAgeControl)` will override server cache policy 43 | on responses with *Cache-Control: max-age*. Cache will be used until expiration 44 | even if network is available. Use it when server doesn't implement a cache policy! 45 | 46 | - `forceCacheWhenOffline(NetworkMonitor)` will force the use of cache when 47 | no network connection is available. When offline, cache will be used even 48 | if expired. for Android you can implement a *NetworkMonitor* that returns 49 | the value of *ConnectivityManager.getActiveNetworkInfo().isConnected()*. 50 | 51 | Call `apply()` to add interceptors to *OkHttpClient.Builder* and return the 52 | builder so you can continue to build *OkHttpClient* and add the cache. 53 | 54 | ### Per request cache control 55 | 56 | without `Cache-Control` header, cache is used until expiration, then network. 57 | (with `forceCacheWhenOffline()` expired cache will be used when offline) 58 | 59 | - add `Cache-Control: no-cache` to always use network, cache will be used 60 | only when offline. 61 | 62 | - add `Cache-Control: no-store` to not store response in cache. 63 | 64 | ## License 65 | 66 | Copyright 2016 Nicolas Cornette 67 | 68 | Licensed under the Apache License, Version 2.0 (the "License"); 69 | you may not use this file except in compliance with the License. 70 | You may obtain a copy of the License at 71 | 72 | http://www.apache.org/licenses/LICENSE-2.0 73 | 74 | Unless required by applicable law or agreed to in writing, software 75 | distributed under the License is distributed on an "AS IS" BASIS, 76 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 77 | See the License for the specific language governing permissions and 78 | limitations under the License. 79 | -------------------------------------------------------------------------------- /build.gradle: -------------------------------------------------------------------------------- 1 | 2 | buildscript { 3 | repositories { 4 | jcenter() 5 | mavenLocal() 6 | } 7 | } 8 | 9 | allprojects { 10 | repositories { 11 | jcenter() 12 | } 13 | } 14 | -------------------------------------------------------------------------------- /gradle.properties: -------------------------------------------------------------------------------- 1 | # Project-wide Gradle settings. 2 | 3 | # IDE (e.g. Android Studio) users: 4 | # Gradle settings configured through the IDE *will override* 5 | # any settings specified in this file. 6 | 7 | # For more details on how to configure your build environment visit 8 | # http://www.gradle.org/docs/current/userguide/build_environment.html 9 | 10 | # Specifies the JVM arguments used for the daemon process. 11 | # The setting is particularly useful for tweaking memory settings. 12 | # Default value: -Xmx10248m -XX:MaxPermSize=256m 13 | org.gradle.jvmargs=-Xmx2048m -XX:MaxPermSize=512m -XX:+HeapDumpOnOutOfMemoryError -Dfile.encoding=UTF-8 14 | 15 | # When configured, Gradle will run in incubating parallel mode. 16 | # This option should only be used with decoupled projects. More details, visit 17 | # http://www.gradle.org/docs/current/userguide/multi_project_builds.html#sec:decoupled_projects 18 | # org.gradle.parallel=true 19 | 20 | # publish with 21 | POM_VERSION=1.2.0-SNAPSHOT 22 | POM_GROUPID=com.ncornette.cache 23 | 24 | POM_DESCRIPTION=Helper class to configure cache behaviour of OkHttp client and Retrofit 25 | POM_URL=https://github.com/ncornette/OkCacheControl.git 26 | POM_SCM_URL=https://github.com/ncornette/OkCacheControl.git 27 | POM_LICENCE_NAME=Apache-2.0 28 | POM_LICENCE_URL= 29 | POM_LICENCE_DIST=repo 30 | POM_DEVELOPER_ID=ncornette 31 | POM_DEVELOPER_NAME=Nicolas Cornette 32 | 33 | -------------------------------------------------------------------------------- /gradle/wrapper/gradle-wrapper.jar: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/ncornette/OkCacheControl/c347c853dc4b47e6e97d1bb2f630d1e97af7e41a/gradle/wrapper/gradle-wrapper.jar -------------------------------------------------------------------------------- /gradle/wrapper/gradle-wrapper.properties: -------------------------------------------------------------------------------- 1 | #Wed Jun 22 10:26:50 CEST 2016 2 | distributionBase=GRADLE_USER_HOME 3 | distributionPath=wrapper/dists 4 | zipStoreBase=GRADLE_USER_HOME 5 | zipStorePath=wrapper/dists 6 | distributionUrl=https\://services.gradle.org/distributions/gradle-2.13-all.zip 7 | -------------------------------------------------------------------------------- /gradlew: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | 3 | ############################################################################## 4 | ## 5 | ## Gradle start up script for UN*X 6 | ## 7 | ############################################################################## 8 | 9 | # Attempt to set APP_HOME 10 | # Resolve links: $0 may be a link 11 | PRG="$0" 12 | # Need this for relative symlinks. 13 | while [ -h "$PRG" ] ; do 14 | ls=`ls -ld "$PRG"` 15 | link=`expr "$ls" : '.*-> \(.*\)$'` 16 | if expr "$link" : '/.*' > /dev/null; then 17 | PRG="$link" 18 | else 19 | PRG=`dirname "$PRG"`"/$link" 20 | fi 21 | done 22 | SAVED="`pwd`" 23 | cd "`dirname \"$PRG\"`/" >/dev/null 24 | APP_HOME="`pwd -P`" 25 | cd "$SAVED" >/dev/null 26 | 27 | APP_NAME="Gradle" 28 | APP_BASE_NAME=`basename "$0"` 29 | 30 | # Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. 31 | DEFAULT_JVM_OPTS="" 32 | 33 | # Use the maximum available, or set MAX_FD != -1 to use that value. 34 | MAX_FD="maximum" 35 | 36 | warn ( ) { 37 | echo "$*" 38 | } 39 | 40 | die ( ) { 41 | echo 42 | echo "$*" 43 | echo 44 | exit 1 45 | } 46 | 47 | # OS specific support (must be 'true' or 'false'). 48 | cygwin=false 49 | msys=false 50 | darwin=false 51 | nonstop=false 52 | case "`uname`" in 53 | CYGWIN* ) 54 | cygwin=true 55 | ;; 56 | Darwin* ) 57 | darwin=true 58 | ;; 59 | MINGW* ) 60 | msys=true 61 | ;; 62 | NONSTOP* ) 63 | nonstop=true 64 | ;; 65 | esac 66 | 67 | CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar 68 | 69 | # Determine the Java command to use to start the JVM. 70 | if [ -n "$JAVA_HOME" ] ; then 71 | if [ -x "$JAVA_HOME/jre/sh/java" ] ; then 72 | # IBM's JDK on AIX uses strange locations for the executables 73 | JAVACMD="$JAVA_HOME/jre/sh/java" 74 | else 75 | JAVACMD="$JAVA_HOME/bin/java" 76 | fi 77 | if [ ! -x "$JAVACMD" ] ; then 78 | die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME 79 | 80 | Please set the JAVA_HOME variable in your environment to match the 81 | location of your Java installation." 82 | fi 83 | else 84 | JAVACMD="java" 85 | which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 86 | 87 | Please set the JAVA_HOME variable in your environment to match the 88 | location of your Java installation." 89 | fi 90 | 91 | # Increase the maximum file descriptors if we can. 92 | if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then 93 | MAX_FD_LIMIT=`ulimit -H -n` 94 | if [ $? -eq 0 ] ; then 95 | if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then 96 | MAX_FD="$MAX_FD_LIMIT" 97 | fi 98 | ulimit -n $MAX_FD 99 | if [ $? -ne 0 ] ; then 100 | warn "Could not set maximum file descriptor limit: $MAX_FD" 101 | fi 102 | else 103 | warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT" 104 | fi 105 | fi 106 | 107 | # For Darwin, add options to specify how the application appears in the dock 108 | if $darwin; then 109 | GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\"" 110 | fi 111 | 112 | # For Cygwin, switch paths to Windows format before running java 113 | if $cygwin ; then 114 | APP_HOME=`cygpath --path --mixed "$APP_HOME"` 115 | CLASSPATH=`cygpath --path --mixed "$CLASSPATH"` 116 | JAVACMD=`cygpath --unix "$JAVACMD"` 117 | 118 | # We build the pattern for arguments to be converted via cygpath 119 | ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null` 120 | SEP="" 121 | for dir in $ROOTDIRSRAW ; do 122 | ROOTDIRS="$ROOTDIRS$SEP$dir" 123 | SEP="|" 124 | done 125 | OURCYGPATTERN="(^($ROOTDIRS))" 126 | # Add a user-defined pattern to the cygpath arguments 127 | if [ "$GRADLE_CYGPATTERN" != "" ] ; then 128 | OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)" 129 | fi 130 | # Now convert the arguments - kludge to limit ourselves to /bin/sh 131 | i=0 132 | for arg in "$@" ; do 133 | CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -` 134 | CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option 135 | 136 | if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition 137 | eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"` 138 | else 139 | eval `echo args$i`="\"$arg\"" 140 | fi 141 | i=$((i+1)) 142 | done 143 | case $i in 144 | (0) set -- ;; 145 | (1) set -- "$args0" ;; 146 | (2) set -- "$args0" "$args1" ;; 147 | (3) set -- "$args0" "$args1" "$args2" ;; 148 | (4) set -- "$args0" "$args1" "$args2" "$args3" ;; 149 | (5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;; 150 | (6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;; 151 | (7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;; 152 | (8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;; 153 | (9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;; 154 | esac 155 | fi 156 | 157 | # Split up the JVM_OPTS And GRADLE_OPTS values into an array, following the shell quoting and substitution rules 158 | function splitJvmOpts() { 159 | JVM_OPTS=("$@") 160 | } 161 | eval splitJvmOpts $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS 162 | JVM_OPTS[${#JVM_OPTS[*]}]="-Dorg.gradle.appname=$APP_BASE_NAME" 163 | 164 | exec "$JAVACMD" "${JVM_OPTS[@]}" -classpath "$CLASSPATH" org.gradle.wrapper.GradleWrapperMain "$@" 165 | -------------------------------------------------------------------------------- /gradlew.bat: -------------------------------------------------------------------------------- 1 | @if "%DEBUG%" == "" @echo off 2 | @rem ########################################################################## 3 | @rem 4 | @rem Gradle startup script for Windows 5 | @rem 6 | @rem ########################################################################## 7 | 8 | @rem Set local scope for the variables with windows NT shell 9 | if "%OS%"=="Windows_NT" setlocal 10 | 11 | set DIRNAME=%~dp0 12 | if "%DIRNAME%" == "" set DIRNAME=. 13 | set APP_BASE_NAME=%~n0 14 | set APP_HOME=%DIRNAME% 15 | 16 | @rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. 17 | set DEFAULT_JVM_OPTS= 18 | 19 | @rem Find java.exe 20 | if defined JAVA_HOME goto findJavaFromJavaHome 21 | 22 | set JAVA_EXE=java.exe 23 | %JAVA_EXE% -version >NUL 2>&1 24 | if "%ERRORLEVEL%" == "0" goto init 25 | 26 | echo. 27 | echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 28 | echo. 29 | echo Please set the JAVA_HOME variable in your environment to match the 30 | echo location of your Java installation. 31 | 32 | goto fail 33 | 34 | :findJavaFromJavaHome 35 | set JAVA_HOME=%JAVA_HOME:"=% 36 | set JAVA_EXE=%JAVA_HOME%/bin/java.exe 37 | 38 | if exist "%JAVA_EXE%" goto init 39 | 40 | echo. 41 | echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 42 | echo. 43 | echo Please set the JAVA_HOME variable in your environment to match the 44 | echo location of your Java installation. 45 | 46 | goto fail 47 | 48 | :init 49 | @rem Get command-line arguments, handling Windows variants 50 | 51 | if not "%OS%" == "Windows_NT" goto win9xME_args 52 | if "%@eval[2+2]" == "4" goto 4NT_args 53 | 54 | :win9xME_args 55 | @rem Slurp the command line arguments. 56 | set CMD_LINE_ARGS= 57 | set _SKIP=2 58 | 59 | :win9xME_args_slurp 60 | if "x%~1" == "x" goto execute 61 | 62 | set CMD_LINE_ARGS=%* 63 | goto execute 64 | 65 | :4NT_args 66 | @rem Get arguments from the 4NT Shell from JP Software 67 | set CMD_LINE_ARGS=%$ 68 | 69 | :execute 70 | @rem Setup the command line 71 | 72 | set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar 73 | 74 | @rem Execute Gradle 75 | "%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %CMD_LINE_ARGS% 76 | 77 | :end 78 | @rem End local scope for the variables with windows NT shell 79 | if "%ERRORLEVEL%"=="0" goto mainEnd 80 | 81 | :fail 82 | rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of 83 | rem the _cmd.exe /c_ return code! 84 | if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1 85 | exit /b 1 86 | 87 | :mainEnd 88 | if "%OS%"=="Windows_NT" endlocal 89 | 90 | :omega 91 | -------------------------------------------------------------------------------- /okcache-control/.gitignore: -------------------------------------------------------------------------------- 1 | /build 2 | -------------------------------------------------------------------------------- /okcache-control/build.gradle: -------------------------------------------------------------------------------- 1 | plugins { 2 | id "com.jfrog.bintray" version "1.8.4" 3 | } 4 | 5 | apply plugin: 'java' 6 | apply plugin: 'maven-publish' 7 | apply plugin: 'jacoco' 8 | 9 | sourceCompatibility = 1.7 10 | targetCompatibility = 1.7 11 | 12 | task sourceJar(type: Jar) { 13 | from sourceSets.main.allJava 14 | } 15 | 16 | publishing { 17 | publications { 18 | mavenJava(MavenPublication) { 19 | from components.java 20 | 21 | groupId "${POM_GROUPID}" 22 | artifactId "${POM_ARTIFACTID}" 23 | version "${POM_VERSION}" 24 | 25 | artifact sourceJar { 26 | classifier "sources" 27 | } 28 | } 29 | } 30 | } 31 | 32 | bintray { 33 | dryRun = false 34 | user = project.hasProperty('bintrayUser') ? project.property('bintrayUser') : System.getenv('BINTRAY_USER') 35 | key = project.hasProperty('bintrayApiKey') ? project.property('bintrayApiKey') : System.getenv('BINTRAY_API_KEY') 36 | publications = ['mavenJava'] 37 | pkg { 38 | repo = 'maven' 39 | name = "${POM_ARTIFACTID}" 40 | licenses = ['Apache-2.0'] 41 | vcsUrl = 'https://github.com/ncornette/OkCacheControl.git' 42 | version { 43 | name= "${POM_VERSION}" 44 | } 45 | } 46 | } 47 | 48 | jacocoTestReport { 49 | reports { 50 | xml.enabled true 51 | html.enabled true 52 | } 53 | } 54 | 55 | check.dependsOn jacocoTestReport 56 | 57 | dependencies { 58 | compile fileTree(dir: 'libs', include: ['*.jar']) 59 | compile 'com.squareup.okhttp3:okhttp:3.2.0' 60 | testCompile 'junit:junit:4.12' 61 | testCompile 'com.squareup.okhttp3:mockwebserver:3.2.0' 62 | testCompile 'org.assertj:assertj-core:2.2.0' 63 | testCompile 'org.mockito:mockito-core:2.0.54-beta' 64 | } 65 | -------------------------------------------------------------------------------- /okcache-control/gradle.properties: -------------------------------------------------------------------------------- 1 | POM_ARTIFACTID=okcache-control 2 | -------------------------------------------------------------------------------- /okcache-control/src/main/java/com/ncornette/cache/OkCacheControl.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright (C) 2016 Nicolas Cornette 3 | * 4 | * Licensed under the Apache License, Version 2.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * http://www.apache.org/licenses/LICENSE-2.0 9 | * 10 | * Unless required by applicable law or agreed to in writing, software 11 | * distributed under the License is distributed on an "AS IS" BASIS, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | */ 16 | package com.ncornette.cache; 17 | 18 | import java.io.IOException; 19 | import java.util.concurrent.TimeUnit; 20 | 21 | import okhttp3.CacheControl; 22 | import okhttp3.Interceptor; 23 | import okhttp3.OkHttpClient; 24 | import okhttp3.Request; 25 | import okhttp3.Response; 26 | 27 | /** 28 | * Created by nic on 21/06/16. 29 | */ 30 | public class OkCacheControl { 31 | 32 | /** 33 | * Created by nic on 20/06/16. 34 | */ 35 | public interface NetworkMonitor { 36 | 37 | boolean isOnline(); 38 | } 39 | 40 | public interface MaxAgeControl { 41 | /** 42 | * @return max-age in seconds 43 | */ 44 | long getMaxAge(); 45 | } 46 | 47 | public static OkCacheControl on(OkHttpClient.Builder okBuilder) { 48 | OkCacheControl builder = new OkCacheControl(okBuilder); 49 | return builder; 50 | } 51 | 52 | 53 | private NetworkMonitor networkMonitor; 54 | private long maxAgeValue; 55 | private TimeUnit maxAgeUnit; 56 | private OkHttpClient.Builder okBuilder; 57 | private MaxAgeControl maxAgeControl; 58 | 59 | private OkCacheControl(OkHttpClient.Builder okBuilder) { 60 | this.okBuilder = okBuilder; 61 | } 62 | 63 | public OkCacheControl overrideServerCachePolicy(Long maxAgeSeconds) { 64 | if (maxAgeSeconds == null) { 65 | return this.overrideServerCachePolicy(0, null); 66 | } else { 67 | return this.overrideServerCachePolicy(maxAgeSeconds, TimeUnit.SECONDS); 68 | } 69 | } 70 | 71 | public OkCacheControl overrideServerCachePolicy(long timeValue, TimeUnit unit) { 72 | this.maxAgeControl = null; 73 | this.maxAgeValue = timeValue; 74 | this.maxAgeUnit = unit; 75 | return this; 76 | } 77 | 78 | public OkCacheControl overrideServerCachePolicy(MaxAgeControl maxAgeControl) { 79 | this.maxAgeUnit = null; 80 | this.maxAgeControl = maxAgeControl; 81 | return this; 82 | } 83 | 84 | public OkCacheControl forceCacheWhenOffline(NetworkMonitor networkMonitor) { 85 | this.networkMonitor = networkMonitor; 86 | return this; 87 | } 88 | 89 | public OkHttpClient.Builder apply() { 90 | if (networkMonitor == null && maxAgeUnit == null && maxAgeControl == null) { 91 | return okBuilder; 92 | } 93 | 94 | if (maxAgeUnit != null) { 95 | maxAgeControl = new StaticMaxAgeControl(maxAgeValue, maxAgeUnit); 96 | } 97 | 98 | ResponseHandler responseHandler; 99 | if (maxAgeControl != null) { 100 | responseHandler = new CachePolicyResponseHandler(maxAgeControl); 101 | } else { 102 | responseHandler = new ResponseHandler(); 103 | } 104 | 105 | RequestHandler requestHandler; 106 | if (networkMonitor != null) { 107 | requestHandler = new NetworkMonitorRequestHandler(networkMonitor); 108 | } else { 109 | requestHandler = new RequestHandler(); 110 | } 111 | 112 | Interceptor cacheControlInterceptor = getCacheControlInterceptor( 113 | requestHandler, responseHandler); 114 | 115 | okBuilder.addNetworkInterceptor(cacheControlInterceptor); 116 | 117 | if (networkMonitor != null) { 118 | okBuilder.addInterceptor(cacheControlInterceptor); 119 | } 120 | 121 | return okBuilder; 122 | } 123 | 124 | private static class StaticMaxAgeControl implements MaxAgeControl { 125 | private TimeUnit maxAgeUnit; 126 | private long maxAgeValue; 127 | 128 | private StaticMaxAgeControl(long maxAgeValue, TimeUnit maxAgeUnit) { 129 | this.maxAgeUnit = maxAgeUnit; 130 | this.maxAgeValue = maxAgeValue; 131 | } 132 | 133 | @Override 134 | public long getMaxAge() { 135 | return maxAgeUnit.toSeconds(maxAgeValue); 136 | } 137 | } 138 | 139 | private static class CachePolicyResponseHandler extends ResponseHandler { 140 | private MaxAgeControl maxAgeControl; 141 | 142 | private CachePolicyResponseHandler(MaxAgeControl maxAgeControl) { 143 | this.maxAgeControl = maxAgeControl; 144 | } 145 | 146 | @Override 147 | public Response newResponse(Response response) { 148 | return response.newBuilder() 149 | .removeHeader("Pragma") 150 | .removeHeader("Cache-Control") 151 | .header("Cache-Control", "max-age=" + maxAgeControl.getMaxAge()) 152 | .build(); 153 | } 154 | } 155 | 156 | private static class NetworkMonitorRequestHandler extends RequestHandler { 157 | private NetworkMonitor networkMonitor; 158 | 159 | private NetworkMonitorRequestHandler(NetworkMonitor networkMonitor) { 160 | this.networkMonitor = networkMonitor; 161 | } 162 | 163 | @Override 164 | public Request newRequest(Request request) { 165 | Request.Builder newBuilder = request.newBuilder(); 166 | if (!networkMonitor.isOnline()) { 167 | // To be used with Application Interceptor to use Expired cache 168 | newBuilder.cacheControl(CacheControl.FORCE_CACHE); 169 | } 170 | return newBuilder.build(); 171 | } 172 | } 173 | 174 | private static Interceptor getCacheControlInterceptor(final RequestHandler requestHandler, 175 | final ResponseHandler responseHandler) { 176 | return new Interceptor() { 177 | @Override public Response intercept(Chain chain) throws IOException { 178 | Request originalRequest = chain.request(); 179 | Request request = requestHandler.newRequest(originalRequest); 180 | 181 | Response originalResponse = chain.proceed(request); 182 | 183 | return responseHandler.newResponse(originalResponse); 184 | } 185 | }; 186 | } 187 | 188 | private static class ResponseHandler { 189 | public Response newResponse(Response response) { 190 | return response; 191 | } 192 | } 193 | 194 | private static class RequestHandler { 195 | public Request newRequest(Request request) { 196 | return request; 197 | } 198 | } 199 | } 200 | -------------------------------------------------------------------------------- /okcache-control/src/test/java/com/ncornette/cache/BuilderTest.java: -------------------------------------------------------------------------------- 1 | package com.ncornette.cache; 2 | 3 | import org.junit.Before; 4 | import org.junit.Test; 5 | 6 | import java.io.IOException; 7 | import java.util.concurrent.TimeUnit; 8 | 9 | import okhttp3.CacheControl; 10 | import okhttp3.OkHttpClient; 11 | import okhttp3.Request; 12 | import okhttp3.Response; 13 | import okhttp3.mockwebserver.MockResponse; 14 | import okhttp3.mockwebserver.MockWebServer; 15 | 16 | import static org.assertj.core.api.BDDAssertions.then; 17 | import static org.mockito.BDDMockito.given; 18 | import static org.mockito.Mockito.mock; 19 | 20 | /** 21 | * Created by nic on 24/06/16. 22 | */ 23 | public class BuilderTest { 24 | 25 | private MockWebServer mockWebServer; 26 | private OkCacheControl.NetworkMonitor networkMonitor; 27 | private OkCacheControl.MaxAgeControl maxAgeControl; 28 | 29 | @Before 30 | public void setUp() throws Exception { 31 | mockWebServer = new MockWebServer(); mockWebServer.start(); 32 | networkMonitor = mock(OkCacheControl.NetworkMonitor.class); 33 | maxAgeControl = mock(OkCacheControl.MaxAgeControl.class); 34 | } 35 | 36 | @Test 37 | public void testOverrideServerCachePolicy_NONE() throws Exception { 38 | //given 39 | OkHttpClient client = OkCacheControl.on(new OkHttpClient.Builder()) 40 | .apply().build(); 41 | 42 | //when 43 | mockWebServer.enqueue(new MockResponse().setBody("Response")); 44 | Response response = getResponse(client); 45 | 46 | //then 47 | then(response.header("Cache-Control")).isNull(); 48 | } 49 | 50 | @Test 51 | public void testOverrideServerCachePolicy_DYNAMIC() throws Exception { 52 | //given 53 | given(maxAgeControl.getMaxAge()).willReturn(TimeUnit.MINUTES.toSeconds(5)); 54 | OkHttpClient client = OkCacheControl.on(new OkHttpClient.Builder()) 55 | .overrideServerCachePolicy(maxAgeControl) 56 | .apply().build(); 57 | 58 | //when 59 | mockWebServer.enqueue(new MockResponse().setBody("Response")); 60 | Response response = getResponse(client); 61 | 62 | //then 63 | then(response.header("Cache-Control")).isEqualTo("max-age=300"); 64 | } 65 | 66 | @Test 67 | public void testOverrideServerCachePolicy_LONG_NULL() throws Exception { 68 | //given 69 | OkHttpClient client = OkCacheControl.on(new OkHttpClient.Builder()) 70 | .overrideServerCachePolicy((Long)null) 71 | .apply().build(); 72 | 73 | //when 74 | mockWebServer.enqueue(new MockResponse().setBody("Response")); 75 | Response response = getResponse(client); 76 | 77 | //then 78 | then(response.header("Cache-Control")).isNull(); 79 | } 80 | 81 | @Test 82 | public void testOverrideServerCachePolicy_LONG() throws Exception { 83 | //given 84 | OkHttpClient client = OkCacheControl.on(new OkHttpClient.Builder()) 85 | .overrideServerCachePolicy(TimeUnit.SECONDS.convert(5, TimeUnit.MINUTES)) 86 | .apply().build(); 87 | 88 | //when 89 | mockWebServer.enqueue(new MockResponse().setBody("Response")); 90 | Response response = getResponse(client); 91 | 92 | //then 93 | then(response.header("Cache-Control")).isEqualTo( 94 | "max-age="+TimeUnit.SECONDS.convert(5, TimeUnit.MINUTES)); 95 | } 96 | 97 | 98 | @Test 99 | public void testOverrideServerCachePolicy_STATIC() throws Exception { 100 | //given 101 | OkHttpClient client = OkCacheControl.on(new OkHttpClient.Builder()) 102 | .overrideServerCachePolicy(5, TimeUnit.MINUTES) 103 | .apply().build(); 104 | 105 | //when 106 | mockWebServer.enqueue(new MockResponse().setBody("Response")); 107 | Response response = getResponse(client); 108 | 109 | //then 110 | then(response.header("Cache-Control")).isEqualTo("max-age="+TimeUnit.MINUTES.toSeconds(5)); 111 | } 112 | 113 | @Test 114 | public void testForceCacheWhenOffline_ENABLED_ONLINE() throws Exception { 115 | //given 116 | given(networkMonitor.isOnline()).willReturn(true); 117 | OkHttpClient client = OkCacheControl.on(new OkHttpClient.Builder()) 118 | .forceCacheWhenOffline(networkMonitor) 119 | .apply().build(); 120 | 121 | //when 122 | mockWebServer.enqueue(new MockResponse().setBody("Response")); 123 | Response response = getResponse(client); 124 | 125 | //then 126 | then(response.request().cacheControl().onlyIfCached()).isFalse(); 127 | then(response.request().cacheControl().maxStaleSeconds()).isNotEqualTo(CacheControl.FORCE_CACHE.maxStaleSeconds()); 128 | } 129 | 130 | @Test 131 | public void testForceCacheWhenOffline_ENABLED_OFFLINE() throws Exception { 132 | //given 133 | given(networkMonitor.isOnline()).willReturn(false); 134 | OkHttpClient client = OkCacheControl.on(new OkHttpClient.Builder()) 135 | .forceCacheWhenOffline(networkMonitor) 136 | .apply().build(); 137 | 138 | //when 139 | mockWebServer.enqueue(new MockResponse().setBody("Response")); 140 | Response response = getResponse(client); 141 | 142 | //then 143 | then(response.request().cacheControl().onlyIfCached()).isEqualTo(CacheControl.FORCE_CACHE.onlyIfCached()); 144 | then(response.request().cacheControl().maxStaleSeconds()).isEqualTo(CacheControl.FORCE_CACHE.maxStaleSeconds()); 145 | } 146 | 147 | private Response getResponse(OkHttpClient client) throws IOException { 148 | return client.newCall(new Request.Builder() 149 | .url(mockWebServer.url("/")) 150 | .build()).execute(); 151 | } 152 | 153 | } -------------------------------------------------------------------------------- /okcache-control/src/test/java/com/ncornette/cache/OkCacheControlTest.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright (C) 2016 Nicolas Cornette 3 | * 4 | * Licensed under the Apache License, Version 2.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * http://www.apache.org/licenses/LICENSE-2.0 9 | * 10 | * Unless required by applicable law or agreed to in writing, software 11 | * distributed under the License is distributed on an "AS IS" BASIS, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | */ 16 | package com.ncornette.cache; 17 | 18 | import org.junit.After; 19 | import org.junit.Before; 20 | import org.junit.Test; 21 | 22 | import java.io.File; 23 | import java.io.IOException; 24 | import java.util.concurrent.TimeUnit; 25 | 26 | import okhttp3.Cache; 27 | import okhttp3.OkHttpClient; 28 | import okhttp3.Request; 29 | import okhttp3.Response; 30 | import okhttp3.mockwebserver.MockResponse; 31 | import okhttp3.mockwebserver.MockWebServer; 32 | 33 | import static java.util.concurrent.TimeUnit.MINUTES; 34 | import static org.assertj.core.api.Assertions.assertThat; 35 | import static org.assertj.core.api.BDDAssertions.then; 36 | import static org.mockito.BDDMockito.given; 37 | import static org.mockito.Mockito.mock; 38 | import static org.mockito.Mockito.when; 39 | 40 | /** 41 | * Created by nic on 20/06/16. 42 | */ 43 | public class OkCacheControlTest { 44 | 45 | private MockWebServer mockWebServer; 46 | private Cache cache; 47 | private OkHttpClient client; 48 | private OkCacheControl.NetworkMonitor networkMonitor; 49 | private OkCacheControl.MaxAgeControl maxAgeControl; 50 | 51 | @Before 52 | public void setUp() throws Exception { 53 | mockWebServer = new MockWebServer(); mockWebServer.start(); 54 | 55 | cache = new Cache(new File("./build/tmp/test-ok-cache"), 10 * 1024 * 1024); 56 | cache.evictAll(); 57 | 58 | networkMonitor = mock(OkCacheControl.NetworkMonitor.class); 59 | when(networkMonitor.isOnline()).thenReturn(true); 60 | 61 | maxAgeControl = mock(OkCacheControl.MaxAgeControl.class); 62 | when(maxAgeControl.getMaxAge()).thenReturn(0L); 63 | 64 | client = OkCacheControl.on(new OkHttpClient.Builder()) 65 | .overrideServerCachePolicy(maxAgeControl) 66 | .forceCacheWhenOffline(networkMonitor) 67 | .apply() 68 | .cache(cache) 69 | .build(); 70 | } 71 | 72 | @After 73 | public void tearDown() throws Exception { 74 | mockWebServer.shutdown(); 75 | } 76 | 77 | private void givenResponseInCache(String responseBody, long maxAge, TimeUnit maxAgeUnit) throws Exception { 78 | when(networkMonitor.isOnline()).thenReturn(true); 79 | when(maxAgeControl.getMaxAge()).thenReturn(maxAgeUnit.toSeconds(maxAge)); 80 | 81 | mockWebServer.enqueue(new MockResponse().setBody(responseBody)); 82 | Response response = getResponse(); 83 | 84 | assertThat(cache.networkCount()).isEqualTo(1); 85 | assertThat(cache.hitCount()).isEqualTo(0); 86 | assertThat(response.body().string()).isEqualTo(responseBody); 87 | assertThat(cache.size()).isGreaterThan(0); 88 | } 89 | 90 | @Test 91 | public void test_CACHE_IS_USED() throws Exception { 92 | //given 93 | givenResponseInCache("Cached Response", 5, MINUTES); 94 | given(networkMonitor.isOnline()).willReturn(true); 95 | 96 | //when 97 | mockWebServer.enqueue(new MockResponse().setBody("Network Response")); 98 | Response response = getResponse(); 99 | 100 | //then 101 | then(response.body().string()).isEqualTo("Cached Response"); 102 | then(cache.hitCount()).isEqualTo(1); 103 | } 104 | 105 | private Response getResponse() throws IOException { 106 | return client.newCall(new Request.Builder() 107 | .url(mockWebServer.url("/")) 108 | .build()).execute(); 109 | } 110 | 111 | private Response getResponseFromNetwork() throws IOException { 112 | return client.newCall(new Request.Builder() 113 | .url(mockWebServer.url("/")) 114 | .header("Cache-Control", "no-cache") 115 | .build()).execute(); 116 | } 117 | 118 | private Response getResponseNoStore() throws IOException { 119 | return client.newCall(new Request.Builder() 120 | .url(mockWebServer.url("/")) 121 | .header("Cache-Control", "no-store") 122 | .build()).execute(); 123 | } 124 | 125 | @Test 126 | public void test_FORCE_NETWORK() throws Exception { 127 | //given 128 | givenResponseInCache("Cached Response", 5, MINUTES); 129 | given(networkMonitor.isOnline()).willReturn(true); 130 | 131 | //when 132 | //force network response 133 | mockWebServer.enqueue(new MockResponse().setBody("Network Response")); 134 | Response response = getResponseFromNetwork(); 135 | 136 | //then 137 | then(response.body().string()).isEqualTo("Network Response"); 138 | then(cache.hitCount()).isEqualTo(0); 139 | } 140 | 141 | @Test 142 | public void test_CACHE_EXPIRED() throws Exception { 143 | //given 144 | givenResponseInCache("Expired Response", -5, MINUTES); 145 | given(networkMonitor.isOnline()).willReturn(true); 146 | 147 | //when 148 | mockWebServer.enqueue(new MockResponse().setBody("Network Response")); 149 | Response response = getResponse(); 150 | 151 | //then 152 | then(response.body().string()).isEqualTo("Network Response"); 153 | then(cache.hitCount()).isEqualTo(0); 154 | } 155 | 156 | @Test 157 | public void test_NO_STORE() throws Exception { 158 | //given 159 | given(networkMonitor.isOnline()).willReturn(true); 160 | 161 | //when 162 | mockWebServer.enqueue(new MockResponse().setBody("Network Response")); 163 | Response response = getResponseNoStore(); 164 | 165 | //then 166 | then(response.body().string()).isEqualTo("Network Response"); 167 | assertThat(cache.size()).isZero(); 168 | } 169 | 170 | @Test 171 | public void test_CACHE_EXPIRED_NO_NETWORK() throws Exception { 172 | //given 173 | givenResponseInCache("Expired Response", -5, MINUTES); 174 | given(networkMonitor.isOnline()).willReturn(false); 175 | 176 | //when 177 | mockWebServer.enqueue(new MockResponse().setResponseCode(404)); 178 | Response response = getResponse(); 179 | 180 | //then 181 | then(response.body().string()).isEqualTo("Expired Response"); 182 | then(cache.hitCount()).isEqualTo(1); 183 | } 184 | 185 | @Test 186 | public void test_FORCE_NETWORK_NO_NETWORK() throws Exception { 187 | //given 188 | givenResponseInCache("Expired Response", -5, MINUTES); 189 | given(networkMonitor.isOnline()).willReturn(false); 190 | 191 | //when 192 | //force network response 193 | mockWebServer.enqueue(new MockResponse().setResponseCode(404)); 194 | Response response = getResponseFromNetwork(); 195 | 196 | //then 197 | then(response.body().string()).isEqualTo("Expired Response"); 198 | then(cache.hitCount()).isEqualTo(1); 199 | } 200 | 201 | @Test 202 | public void test_NO_CACHE_NO_NETWORK() throws Exception { 203 | //given 204 | given(networkMonitor.isOnline()).willReturn(false); 205 | 206 | //when 207 | mockWebServer.enqueue(new MockResponse().setResponseCode(404)); 208 | Response response = getResponse(); 209 | 210 | //then 211 | then(response.body().string()).isEmpty(); 212 | then(cache.hitCount()).isEqualTo(0); 213 | then(cache.networkCount()).isEqualTo(0); 214 | } 215 | 216 | } 217 | -------------------------------------------------------------------------------- /settings.gradle: -------------------------------------------------------------------------------- 1 | include ':okcache-control' 2 | --------------------------------------------------------------------------------