├── .gitignore ├── .mvn └── wrapper │ ├── maven-wrapper.jar │ └── maven-wrapper.properties ├── LICENSE ├── README.md ├── mvnw ├── mvnw.cmd ├── pom.xml └── src ├── main └── java │ └── com │ └── github │ └── fabiomaffioletti │ └── firebase │ ├── EnableFirebaseRepositories.java │ ├── FirebaseConfiguration.java │ ├── FirebaseConfigurationProperties.java │ ├── document │ ├── FirebaseArrayFindResponse.java │ ├── FirebaseDocument.java │ ├── FirebaseId.java │ ├── FirebaseMapFindResponse.java │ └── FirebasePushResponse.java │ ├── exception │ └── FirebaseRepositoryException.java │ ├── repository │ ├── DefaultFirebaseRealtimeDatabaseRepository.java │ ├── Filter.java │ ├── FirebaseRealtimeDatabaseRepository.java │ └── HttpEntityBuilder.java │ └── service │ └── FirebaseApplicationService.java └── test ├── java └── com │ └── github │ └── fabiomaffioletti │ └── firebase │ ├── FirebaseRealtimeDatabaseRepositoryTest.java │ ├── model │ ├── RemoveAll.java │ ├── definedkey │ │ ├── Author.java │ │ └── Book.java │ └── generatedkey │ │ ├── Comment.java │ │ ├── Constants.java │ │ ├── Post.java │ │ └── Tag.java │ └── repository │ ├── AuthorRepository.java │ ├── BookRepository.java │ ├── CommentRepository.java │ ├── PostRepository.java │ ├── RemoveAllRepository.java │ └── test │ ├── AuthorRepositoryTest.java │ ├── BookRepositoryTest.java │ ├── CommentRepositoryTest.java │ └── PostRepositoryTest.java └── resources └── application.properties /.gitignore: -------------------------------------------------------------------------------- 1 | /target/ 2 | !.mvn/wrapper/maven-wrapper.jar 3 | 4 | ### STS ### 5 | .apt_generated 6 | .classpath 7 | .factorypath 8 | .project 9 | .settings 10 | .springBeans 11 | .sts4-cache 12 | 13 | ### IntelliJ IDEA ### 14 | .idea 15 | *.iws 16 | *.iml 17 | *.ipr 18 | 19 | ### NetBeans ### 20 | /nbproject/private/ 21 | /build/ 22 | /nbbuild/ 23 | /dist/ 24 | /nbdist/ 25 | /.nb-gradle/ 26 | 27 | .DS_Store 28 | src/test/resources/*.json -------------------------------------------------------------------------------- /.mvn/wrapper/maven-wrapper.jar: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/fabiomaffioletti/spring-boot-starter-data-firebase/a12fbb335a50a4526d4a33c1d88ae5a1d15351aa/.mvn/wrapper/maven-wrapper.jar -------------------------------------------------------------------------------- /.mvn/wrapper/maven-wrapper.properties: -------------------------------------------------------------------------------- 1 | distributionUrl=https://repo.maven.apache.org/maven2/org/apache/maven/apache-maven/3.5.4/apache-maven-3.5.4-bin.zip 2 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | MIT License 2 | 3 | Copyright (c) 2019 Fabio Maffioletti 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in all 13 | copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 21 | SOFTWARE. 22 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Firebase Realtime Database repositories for Spring Boot 2 | 3 | Provides a generic way to interact with the Firebase Realtime Database in a Spring Boot application. It basically provides 4 | a generic repository that mimics the main REST endpoints to be used most probably in backend admin applications. Here is the list 5 | of methods that have been implemented: 6 | 7 | - set 8 | - update 9 | - push 10 | - remove 11 | - removeAll 12 | - get 13 | - find 14 | - findAll 15 | 16 | ## Getting started 17 | 18 | ### Preconditions 19 | - you need to have a `RestTemplate` bean available 20 | - you need to have `Jackson` on the classpath 21 | 22 | But they usually come easily with web applications using: 23 | ```xml 24 | 25 | org.springframework.boot 26 | spring-boot-starter-web 27 | 28 | ``` 29 | 30 | ### Declare dependencies 31 | 32 | To use this, just include these dependencies in your pom: 33 | 34 | ```xml 35 | 36 | com.github.fabiomaffioletti 37 | spring-boot-starter-data-firebase 38 | 1.0.0.RELEASE 39 | 40 | ``` 41 | 42 | ...and you need also the `firebase-admin` dependency on your classpath: 43 | ```xml 44 | 45 | com.google.firebase 46 | firebase-admin 47 | [version] 48 | 49 | ``` 50 | 51 | ### Configuration 52 | 53 | To get it to work you need to: 54 | 1) go to your firebase console, generate a service account file and include it in your classpath 55 | or in your file system 56 | 2) specify two things in your application.properties (or yml) file 57 | 58 | ```properties 59 | firebase.service-account-filename=[classpath|file]:[service-account-filename].json 60 | firebase.realtime-database-url=[realtime database url] # for example https://your-application.firebaseio.com 61 | ``` 62 | 63 | ### The code part 64 | 65 | Then, on the Java part: 66 | 1) create a class representing the document you need to persist 67 | 2) annotate it with `@FirebaseDocument`, specifing the realtime database path 68 | 3) create an ID property and annotate it with `@FirebaseId` 69 | 70 | ```java 71 | @FirebaseDocument("/albums") 72 | public class Album { 73 | 74 | @FirebaseId 75 | private String id; 76 | 77 | private String title; 78 | 79 | } 80 | ``` 81 | 82 | Then create a class that extends the `DefaultFirebaseRealtimeDatabaseRepository` class, and annotate it with `@Repository` 83 | or mark it as a Spring `@Bean` in your application configuration. 84 | 85 | ```java 86 | @Repository 87 | public class AlbumRepository extends DefaultFirebaseRealtimeDatabaseRepository { 88 | } 89 | ``` 90 | 91 | Finally, put `@EnableFirebaseRepositories` just next to `@SpringBootApplication` or in any `@Configuration` class in your 92 | application. 93 | 94 | ## Notes 95 | This is at its very early development stages. I did it because I found a lot of code and configuration duplication in 96 | every Firebase project I worked on. It is very far from what I would like it to be, but still I wanted to expose it to 97 | the community, hoping that it would be improved and used by people with the same needs as mines. 98 | 99 | I could not commit the firebase service account file I am using for testing, so if you would like to contribute, you should 100 | create the service account file and put it in the `src/test/resources/application.properties` file. 101 | 102 | ### Next steps 103 | - Provide repositories for Cloud Firestore 104 | - Provide repositories for Cloud Storage 105 | - Automatically register repository beans interfaces rather than annotated classes 106 | -------------------------------------------------------------------------------- /mvnw: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | # ---------------------------------------------------------------------------- 3 | # Licensed to the Apache Software Foundation (ASF) under one 4 | # or more contributor license agreements. See the NOTICE file 5 | # distributed with this work for additional information 6 | # regarding copyright ownership. The ASF licenses this file 7 | # to you under the Apache License, Version 2.0 (the 8 | # "License"); you may not use this file except in compliance 9 | # with the License. You may obtain a copy of the License at 10 | # 11 | # http://www.apache.org/licenses/LICENSE-2.0 12 | # 13 | # Unless required by applicable law or agreed to in writing, 14 | # software distributed under the License is distributed on an 15 | # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16 | # KIND, either express or implied. See the License for the 17 | # specific language governing permissions and limitations 18 | # under the License. 19 | # ---------------------------------------------------------------------------- 20 | 21 | # ---------------------------------------------------------------------------- 22 | # Maven2 Start Up Batch script 23 | # 24 | # Required ENV vars: 25 | # ------------------ 26 | # JAVA_HOME - location of a JDK home dir 27 | # 28 | # Optional ENV vars 29 | # ----------------- 30 | # M2_HOME - location of maven2's installed home dir 31 | # MAVEN_OPTS - parameters passed to the Java VM when running Maven 32 | # e.g. to debug Maven itself, use 33 | # set MAVEN_OPTS=-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=8000 34 | # MAVEN_SKIP_RC - flag to disable loading of mavenrc files 35 | # ---------------------------------------------------------------------------- 36 | 37 | if [ -z "$MAVEN_SKIP_RC" ] ; then 38 | 39 | if [ -f /etc/mavenrc ] ; then 40 | . /etc/mavenrc 41 | fi 42 | 43 | if [ -f "$HOME/.mavenrc" ] ; then 44 | . "$HOME/.mavenrc" 45 | fi 46 | 47 | fi 48 | 49 | # OS specific support. $var _must_ be set to either true or false. 50 | cygwin=false; 51 | darwin=false; 52 | mingw=false 53 | case "`uname`" in 54 | CYGWIN*) cygwin=true ;; 55 | MINGW*) mingw=true;; 56 | Darwin*) darwin=true 57 | # Use /usr/libexec/java_home if available, otherwise fall back to /Library/Java/Home 58 | # See https://developer.apple.com/library/mac/qa/qa1170/_index.html 59 | if [ -z "$JAVA_HOME" ]; then 60 | if [ -x "/usr/libexec/java_home" ]; then 61 | export JAVA_HOME="`/usr/libexec/java_home`" 62 | else 63 | export JAVA_HOME="/Library/Java/Home" 64 | fi 65 | fi 66 | ;; 67 | esac 68 | 69 | if [ -z "$JAVA_HOME" ] ; then 70 | if [ -r /etc/gentoo-release ] ; then 71 | JAVA_HOME=`java-config --jre-home` 72 | fi 73 | fi 74 | 75 | if [ -z "$M2_HOME" ] ; then 76 | ## resolve links - $0 may be a link to maven's home 77 | PRG="$0" 78 | 79 | # need this for relative symlinks 80 | while [ -h "$PRG" ] ; do 81 | ls=`ls -ld "$PRG"` 82 | link=`expr "$ls" : '.*-> \(.*\)$'` 83 | if expr "$link" : '/.*' > /dev/null; then 84 | PRG="$link" 85 | else 86 | PRG="`dirname "$PRG"`/$link" 87 | fi 88 | done 89 | 90 | saveddir=`pwd` 91 | 92 | M2_HOME=`dirname "$PRG"`/.. 93 | 94 | # make it fully qualified 95 | M2_HOME=`cd "$M2_HOME" && pwd` 96 | 97 | cd "$saveddir" 98 | # echo Using m2 at $M2_HOME 99 | fi 100 | 101 | # For Cygwin, ensure paths are in UNIX format before anything is touched 102 | if $cygwin ; then 103 | [ -n "$M2_HOME" ] && 104 | M2_HOME=`cygpath --unix "$M2_HOME"` 105 | [ -n "$JAVA_HOME" ] && 106 | JAVA_HOME=`cygpath --unix "$JAVA_HOME"` 107 | [ -n "$CLASSPATH" ] && 108 | CLASSPATH=`cygpath --path --unix "$CLASSPATH"` 109 | fi 110 | 111 | # For Mingw, ensure paths are in UNIX format before anything is touched 112 | if $mingw ; then 113 | [ -n "$M2_HOME" ] && 114 | M2_HOME="`(cd "$M2_HOME"; pwd)`" 115 | [ -n "$JAVA_HOME" ] && 116 | JAVA_HOME="`(cd "$JAVA_HOME"; pwd)`" 117 | # TODO classpath? 118 | fi 119 | 120 | if [ -z "$JAVA_HOME" ]; then 121 | javaExecutable="`which javac`" 122 | if [ -n "$javaExecutable" ] && ! [ "`expr \"$javaExecutable\" : '\([^ ]*\)'`" = "no" ]; then 123 | # readlink(1) is not available as standard on Solaris 10. 124 | readLink=`which readlink` 125 | if [ ! `expr "$readLink" : '\([^ ]*\)'` = "no" ]; then 126 | if $darwin ; then 127 | javaHome="`dirname \"$javaExecutable\"`" 128 | javaExecutable="`cd \"$javaHome\" && pwd -P`/javac" 129 | else 130 | javaExecutable="`readlink -f \"$javaExecutable\"`" 131 | fi 132 | javaHome="`dirname \"$javaExecutable\"`" 133 | javaHome=`expr "$javaHome" : '\(.*\)/bin'` 134 | JAVA_HOME="$javaHome" 135 | export JAVA_HOME 136 | fi 137 | fi 138 | fi 139 | 140 | if [ -z "$JAVACMD" ] ; then 141 | if [ -n "$JAVA_HOME" ] ; then 142 | if [ -x "$JAVA_HOME/jre/sh/java" ] ; then 143 | # IBM's JDK on AIX uses strange locations for the executables 144 | JAVACMD="$JAVA_HOME/jre/sh/java" 145 | else 146 | JAVACMD="$JAVA_HOME/bin/java" 147 | fi 148 | else 149 | JAVACMD="`which java`" 150 | fi 151 | fi 152 | 153 | if [ ! -x "$JAVACMD" ] ; then 154 | echo "Error: JAVA_HOME is not defined correctly." >&2 155 | echo " We cannot execute $JAVACMD" >&2 156 | exit 1 157 | fi 158 | 159 | if [ -z "$JAVA_HOME" ] ; then 160 | echo "Warning: JAVA_HOME environment variable is not set." 161 | fi 162 | 163 | CLASSWORLDS_LAUNCHER=org.codehaus.plexus.classworlds.launcher.Launcher 164 | 165 | # traverses directory structure from process work directory to filesystem root 166 | # first directory with .mvn subdirectory is considered project base directory 167 | find_maven_basedir() { 168 | 169 | if [ -z "$1" ] 170 | then 171 | echo "Path not specified to find_maven_basedir" 172 | return 1 173 | fi 174 | 175 | basedir="$1" 176 | wdir="$1" 177 | while [ "$wdir" != '/' ] ; do 178 | if [ -d "$wdir"/.mvn ] ; then 179 | basedir=$wdir 180 | break 181 | fi 182 | # workaround for JBEAP-8937 (on Solaris 10/Sparc) 183 | if [ -d "${wdir}" ]; then 184 | wdir=`cd "$wdir/.."; pwd` 185 | fi 186 | # end of workaround 187 | done 188 | echo "${basedir}" 189 | } 190 | 191 | # concatenates all lines of a file 192 | concat_lines() { 193 | if [ -f "$1" ]; then 194 | echo "$(tr -s '\n' ' ' < "$1")" 195 | fi 196 | } 197 | 198 | BASE_DIR=`find_maven_basedir "$(pwd)"` 199 | if [ -z "$BASE_DIR" ]; then 200 | exit 1; 201 | fi 202 | 203 | ########################################################################################## 204 | # Extension to allow automatically downloading the maven-wrapper.jar from Maven-central 205 | # This allows using the maven wrapper in projects that prohibit checking in binary data. 206 | ########################################################################################## 207 | if [ -r "$BASE_DIR/.mvn/wrapper/maven-wrapper.jar" ]; then 208 | if [ "$MVNW_VERBOSE" = true ]; then 209 | echo "Found .mvn/wrapper/maven-wrapper.jar" 210 | fi 211 | else 212 | if [ "$MVNW_VERBOSE" = true ]; then 213 | echo "Couldn't find .mvn/wrapper/maven-wrapper.jar, downloading it ..." 214 | fi 215 | jarUrl="https://repo.maven.apache.org/maven2/io/takari/maven-wrapper/0.4.2/maven-wrapper-0.4.2.jar" 216 | while IFS="=" read key value; do 217 | case "$key" in (wrapperUrl) jarUrl="$value"; break ;; 218 | esac 219 | done < "$BASE_DIR/.mvn/wrapper/maven-wrapper.properties" 220 | if [ "$MVNW_VERBOSE" = true ]; then 221 | echo "Downloading from: $jarUrl" 222 | fi 223 | wrapperJarPath="$BASE_DIR/.mvn/wrapper/maven-wrapper.jar" 224 | 225 | if command -v wget > /dev/null; then 226 | if [ "$MVNW_VERBOSE" = true ]; then 227 | echo "Found wget ... using wget" 228 | fi 229 | wget "$jarUrl" -O "$wrapperJarPath" 230 | elif command -v curl > /dev/null; then 231 | if [ "$MVNW_VERBOSE" = true ]; then 232 | echo "Found curl ... using curl" 233 | fi 234 | curl -o "$wrapperJarPath" "$jarUrl" 235 | else 236 | if [ "$MVNW_VERBOSE" = true ]; then 237 | echo "Falling back to using Java to download" 238 | fi 239 | javaClass="$BASE_DIR/.mvn/wrapper/MavenWrapperDownloader.java" 240 | if [ -e "$javaClass" ]; then 241 | if [ ! -e "$BASE_DIR/.mvn/wrapper/MavenWrapperDownloader.class" ]; then 242 | if [ "$MVNW_VERBOSE" = true ]; then 243 | echo " - Compiling MavenWrapperDownloader.java ..." 244 | fi 245 | # Compiling the Java class 246 | ("$JAVA_HOME/bin/javac" "$javaClass") 247 | fi 248 | if [ -e "$BASE_DIR/.mvn/wrapper/MavenWrapperDownloader.class" ]; then 249 | # Running the downloader 250 | if [ "$MVNW_VERBOSE" = true ]; then 251 | echo " - Running MavenWrapperDownloader.java ..." 252 | fi 253 | ("$JAVA_HOME/bin/java" -cp .mvn/wrapper MavenWrapperDownloader "$MAVEN_PROJECTBASEDIR") 254 | fi 255 | fi 256 | fi 257 | fi 258 | ########################################################################################## 259 | # End of extension 260 | ########################################################################################## 261 | 262 | export MAVEN_PROJECTBASEDIR=${MAVEN_BASEDIR:-"$BASE_DIR"} 263 | if [ "$MVNW_VERBOSE" = true ]; then 264 | echo $MAVEN_PROJECTBASEDIR 265 | fi 266 | MAVEN_OPTS="$(concat_lines "$MAVEN_PROJECTBASEDIR/.mvn/jvm.config") $MAVEN_OPTS" 267 | 268 | # For Cygwin, switch paths to Windows format before running java 269 | if $cygwin; then 270 | [ -n "$M2_HOME" ] && 271 | M2_HOME=`cygpath --path --windows "$M2_HOME"` 272 | [ -n "$JAVA_HOME" ] && 273 | JAVA_HOME=`cygpath --path --windows "$JAVA_HOME"` 274 | [ -n "$CLASSPATH" ] && 275 | CLASSPATH=`cygpath --path --windows "$CLASSPATH"` 276 | [ -n "$MAVEN_PROJECTBASEDIR" ] && 277 | MAVEN_PROJECTBASEDIR=`cygpath --path --windows "$MAVEN_PROJECTBASEDIR"` 278 | fi 279 | 280 | WRAPPER_LAUNCHER=org.apache.maven.wrapper.MavenWrapperMain 281 | 282 | exec "$JAVACMD" \ 283 | $MAVEN_OPTS \ 284 | -classpath "$MAVEN_PROJECTBASEDIR/.mvn/wrapper/maven-wrapper.jar" \ 285 | "-Dmaven.home=${M2_HOME}" "-Dmaven.multiModuleProjectDirectory=${MAVEN_PROJECTBASEDIR}" \ 286 | ${WRAPPER_LAUNCHER} $MAVEN_CONFIG "$@" 287 | -------------------------------------------------------------------------------- /mvnw.cmd: -------------------------------------------------------------------------------- 1 | @REM ---------------------------------------------------------------------------- 2 | @REM Licensed to the Apache Software Foundation (ASF) under one 3 | @REM or more contributor license agreements. See the NOTICE file 4 | @REM distributed with this work for additional information 5 | @REM regarding copyright ownership. The ASF licenses this file 6 | @REM to you under the Apache License, Version 2.0 (the 7 | @REM "License"); you may not use this file except in compliance 8 | @REM with the License. You may obtain a copy of the License at 9 | @REM 10 | @REM http://www.apache.org/licenses/LICENSE-2.0 11 | @REM 12 | @REM Unless required by applicable law or agreed to in writing, 13 | @REM software distributed under the License is distributed on an 14 | @REM "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 15 | @REM KIND, either express or implied. See the License for the 16 | @REM specific language governing permissions and limitations 17 | @REM under the License. 18 | @REM ---------------------------------------------------------------------------- 19 | 20 | @REM ---------------------------------------------------------------------------- 21 | @REM Maven2 Start Up Batch script 22 | @REM 23 | @REM Required ENV vars: 24 | @REM JAVA_HOME - location of a JDK home dir 25 | @REM 26 | @REM Optional ENV vars 27 | @REM M2_HOME - location of maven2's installed home dir 28 | @REM MAVEN_BATCH_ECHO - set to 'on' to enable the echoing of the batch commands 29 | @REM MAVEN_BATCH_PAUSE - set to 'on' to wait for a key stroke before ending 30 | @REM MAVEN_OPTS - parameters passed to the Java VM when running Maven 31 | @REM e.g. to debug Maven itself, use 32 | @REM set MAVEN_OPTS=-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=8000 33 | @REM MAVEN_SKIP_RC - flag to disable loading of mavenrc files 34 | @REM ---------------------------------------------------------------------------- 35 | 36 | @REM Begin all REM lines with '@' in case MAVEN_BATCH_ECHO is 'on' 37 | @echo off 38 | @REM set title of command window 39 | title %0 40 | @REM enable echoing my setting MAVEN_BATCH_ECHO to 'on' 41 | @if "%MAVEN_BATCH_ECHO%" == "on" echo %MAVEN_BATCH_ECHO% 42 | 43 | @REM set %HOME% to equivalent of $HOME 44 | if "%HOME%" == "" (set "HOME=%HOMEDRIVE%%HOMEPATH%") 45 | 46 | @REM Execute a user defined script before this one 47 | if not "%MAVEN_SKIP_RC%" == "" goto skipRcPre 48 | @REM check for pre script, once with legacy .bat ending and once with .cmd ending 49 | if exist "%HOME%\mavenrc_pre.bat" call "%HOME%\mavenrc_pre.bat" 50 | if exist "%HOME%\mavenrc_pre.cmd" call "%HOME%\mavenrc_pre.cmd" 51 | :skipRcPre 52 | 53 | @setlocal 54 | 55 | set ERROR_CODE=0 56 | 57 | @REM To isolate internal variables from possible post scripts, we use another setlocal 58 | @setlocal 59 | 60 | @REM ==== START VALIDATION ==== 61 | if not "%JAVA_HOME%" == "" goto OkJHome 62 | 63 | echo. 64 | echo Error: JAVA_HOME not found in your environment. >&2 65 | echo Please set the JAVA_HOME variable in your environment to match the >&2 66 | echo location of your Java installation. >&2 67 | echo. 68 | goto error 69 | 70 | :OkJHome 71 | if exist "%JAVA_HOME%\bin\java.exe" goto init 72 | 73 | echo. 74 | echo Error: JAVA_HOME is set to an invalid directory. >&2 75 | echo JAVA_HOME = "%JAVA_HOME%" >&2 76 | echo Please set the JAVA_HOME variable in your environment to match the >&2 77 | echo location of your Java installation. >&2 78 | echo. 79 | goto error 80 | 81 | @REM ==== END VALIDATION ==== 82 | 83 | :init 84 | 85 | @REM Find the project base dir, i.e. the directory that contains the folder ".mvn". 86 | @REM Fallback to current working directory if not found. 87 | 88 | set MAVEN_PROJECTBASEDIR=%MAVEN_BASEDIR% 89 | IF NOT "%MAVEN_PROJECTBASEDIR%"=="" goto endDetectBaseDir 90 | 91 | set EXEC_DIR=%CD% 92 | set WDIR=%EXEC_DIR% 93 | :findBaseDir 94 | IF EXIST "%WDIR%"\.mvn goto baseDirFound 95 | cd .. 96 | IF "%WDIR%"=="%CD%" goto baseDirNotFound 97 | set WDIR=%CD% 98 | goto findBaseDir 99 | 100 | :baseDirFound 101 | set MAVEN_PROJECTBASEDIR=%WDIR% 102 | cd "%EXEC_DIR%" 103 | goto endDetectBaseDir 104 | 105 | :baseDirNotFound 106 | set MAVEN_PROJECTBASEDIR=%EXEC_DIR% 107 | cd "%EXEC_DIR%" 108 | 109 | :endDetectBaseDir 110 | 111 | IF NOT EXIST "%MAVEN_PROJECTBASEDIR%\.mvn\jvm.config" goto endReadAdditionalConfig 112 | 113 | @setlocal EnableExtensions EnableDelayedExpansion 114 | for /F "usebackq delims=" %%a in ("%MAVEN_PROJECTBASEDIR%\.mvn\jvm.config") do set JVM_CONFIG_MAVEN_PROPS=!JVM_CONFIG_MAVEN_PROPS! %%a 115 | @endlocal & set JVM_CONFIG_MAVEN_PROPS=%JVM_CONFIG_MAVEN_PROPS% 116 | 117 | :endReadAdditionalConfig 118 | 119 | SET MAVEN_JAVA_EXE="%JAVA_HOME%\bin\java.exe" 120 | set WRAPPER_JAR="%MAVEN_PROJECTBASEDIR%\.mvn\wrapper\maven-wrapper.jar" 121 | set WRAPPER_LAUNCHER=org.apache.maven.wrapper.MavenWrapperMain 122 | 123 | set DOWNLOAD_URL="https://repo.maven.apache.org/maven2/io/takari/maven-wrapper/0.4.2/maven-wrapper-0.4.2.jar" 124 | FOR /F "tokens=1,2 delims==" %%A IN (%MAVEN_PROJECTBASEDIR%\.mvn\wrapper\maven-wrapper.properties) DO ( 125 | IF "%%A"=="wrapperUrl" SET DOWNLOAD_URL=%%B 126 | ) 127 | 128 | @REM Extension to allow automatically downloading the maven-wrapper.jar from Maven-central 129 | @REM This allows using the maven wrapper in projects that prohibit checking in binary data. 130 | if exist %WRAPPER_JAR% ( 131 | echo Found %WRAPPER_JAR% 132 | ) else ( 133 | echo Couldn't find %WRAPPER_JAR%, downloading it ... 134 | echo Downloading from: %DOWNLOAD_URL% 135 | powershell -Command "(New-Object Net.WebClient).DownloadFile('%DOWNLOAD_URL%', '%WRAPPER_JAR%')" 136 | echo Finished downloading %WRAPPER_JAR% 137 | ) 138 | @REM End of extension 139 | 140 | %MAVEN_JAVA_EXE% %JVM_CONFIG_MAVEN_PROPS% %MAVEN_OPTS% %MAVEN_DEBUG_OPTS% -classpath %WRAPPER_JAR% "-Dmaven.multiModuleProjectDirectory=%MAVEN_PROJECTBASEDIR%" %WRAPPER_LAUNCHER% %MAVEN_CONFIG% %* 141 | if ERRORLEVEL 1 goto error 142 | goto end 143 | 144 | :error 145 | set ERROR_CODE=1 146 | 147 | :end 148 | @endlocal & set ERROR_CODE=%ERROR_CODE% 149 | 150 | if not "%MAVEN_SKIP_RC%" == "" goto skipRcPost 151 | @REM check for post script, once with legacy .bat ending and once with .cmd ending 152 | if exist "%HOME%\mavenrc_post.bat" call "%HOME%\mavenrc_post.bat" 153 | if exist "%HOME%\mavenrc_post.cmd" call "%HOME%\mavenrc_post.cmd" 154 | :skipRcPost 155 | 156 | @REM pause the script if MAVEN_BATCH_PAUSE is set to 'on' 157 | if "%MAVEN_BATCH_PAUSE%" == "on" pause 158 | 159 | if "%MAVEN_TERMINATE_CMD%" == "on" exit %ERROR_CODE% 160 | 161 | exit /B %ERROR_CODE% 162 | -------------------------------------------------------------------------------- /pom.xml: -------------------------------------------------------------------------------- 1 | 2 | 5 | 4.0.0 6 | 7 | 8 | org.springframework.boot 9 | spring-boot-starter-parent 10 | 2.1.1.RELEASE 11 | 12 | 13 | 14 | com.github.fabiomaffioletti 15 | spring-boot-starter-data-firebase 16 | 1.0.0.RELEASE 17 | 18 | 19 | 20 | Fabio Maffioletti 21 | fabio.maffioletti@gmail.com 22 | 23 | 24 | 25 | 26 | 27 | MIT License 28 | http://www.opensource.org/licenses/mit-license.php 29 | 30 | 31 | 32 | 33 | scm:git:git@github.com:fabiomaffioletti/spring-boot-starter-data-firebase.git 34 | scm:git:git@github.com:fabiomaffioletti/spring-boot-starter-data-firebase.git 35 | git@github.com:fabiomaffioletti/spring-boot-starter-data-firebase.git 36 | 37 | 38 | 39 | UTF-8 40 | UTF-8 41 | 1.8 42 | 43 | 44 | 45 | 46 | ossrh 47 | https://oss.sonatype.org/content/repositories/snapshots 48 | 49 | 50 | ossrh 51 | https://oss.sonatype.org/service/local/staging/deploy/maven2/ 52 | 53 | 54 | 55 | 56 | 57 | org.springframework.boot 58 | spring-boot-starter 59 | provided 60 | 61 | 62 | org.springframework.boot 63 | spring-boot-starter-web 64 | provided 65 | 66 | 67 | org.springframework.boot 68 | spring-boot-configuration-processor 69 | true 70 | 71 | 72 | com.google.firebase 73 | firebase-admin 74 | 6.6.0 75 | provided 76 | 77 | 78 | 79 | org.springframework.boot 80 | spring-boot-starter-test 81 | test 82 | 83 | 84 | 85 | 86 | 87 | 88 | org.apache.maven.plugins 89 | maven-source-plugin 90 | 91 | 92 | attach-sources 93 | 94 | jar 95 | 96 | 97 | 98 | 99 | 100 | 101 | org.apache.maven.plugins 102 | maven-javadoc-plugin 103 | 104 | false 105 | 106 | 107 | 108 | attach-javadocs 109 | 110 | jar 111 | 112 | 113 | 114 | 115 | 116 | 117 | org.apache.maven.plugins 118 | maven-gpg-plugin 119 | 1.6 120 | 121 | 122 | sign-artifacts 123 | verify 124 | 125 | sign 126 | 127 | 128 | 129 | --pinentry-mode 130 | loopback 131 | 132 | 133 | 134 | 135 | 136 | 137 | 138 | org.sonatype.plugins 139 | nexus-staging-maven-plugin 140 | 1.6.8 141 | true 142 | 143 | ossrh 144 | https://oss.sonatype.org/ 145 | true 146 | 147 | 148 | 149 | 150 | 151 | 152 | -------------------------------------------------------------------------------- /src/main/java/com/github/fabiomaffioletti/firebase/EnableFirebaseRepositories.java: -------------------------------------------------------------------------------- 1 | package com.github.fabiomaffioletti.firebase; 2 | 3 | import org.springframework.context.annotation.Import; 4 | 5 | import java.lang.annotation.*; 6 | 7 | @Retention(RetentionPolicy.RUNTIME) 8 | @Target(value = ElementType.TYPE) 9 | @Documented 10 | @Import(FirebaseConfiguration.class) 11 | public @interface EnableFirebaseRepositories { 12 | } 13 | -------------------------------------------------------------------------------- /src/main/java/com/github/fabiomaffioletti/firebase/FirebaseConfiguration.java: -------------------------------------------------------------------------------- 1 | package com.github.fabiomaffioletti.firebase; 2 | 3 | import com.fasterxml.jackson.databind.ObjectMapper; 4 | import com.fasterxml.jackson.databind.introspect.AnnotatedMember; 5 | import com.fasterxml.jackson.databind.introspect.JacksonAnnotationIntrospector; 6 | import com.github.fabiomaffioletti.firebase.document.FirebaseId; 7 | import com.github.fabiomaffioletti.firebase.service.FirebaseApplicationService; 8 | import org.springframework.context.annotation.Bean; 9 | import org.springframework.context.annotation.Configuration; 10 | import org.springframework.core.io.DefaultResourceLoader; 11 | import org.springframework.core.io.ResourceLoader; 12 | 13 | import java.io.IOException; 14 | 15 | /** 16 | * Created by fabio on 03/12/2018. 17 | */ 18 | @Configuration 19 | public class FirebaseConfiguration { 20 | 21 | @Bean 22 | public FirebaseConfigurationProperties firebaseConfigurationProperties() { 23 | return new FirebaseConfigurationProperties(); 24 | } 25 | 26 | @Bean 27 | public ResourceLoader resourceLoader() { 28 | return new DefaultResourceLoader(); 29 | } 30 | 31 | @Bean 32 | public FirebaseApplicationService firebaseApplicationService() throws IOException { 33 | return new FirebaseApplicationService(resourceLoader(), firebaseConfigurationProperties()); 34 | } 35 | 36 | @Bean 37 | public ObjectMapper firebaseObjectMapper() { 38 | ObjectMapper objectMapper = new ObjectMapper(); 39 | objectMapper.setAnnotationIntrospector(new JacksonAnnotationIntrospector() { 40 | @Override 41 | public boolean hasIgnoreMarker(AnnotatedMember m) { 42 | return _findAnnotation(m, FirebaseId.class) != null; 43 | } 44 | }); 45 | return objectMapper; 46 | } 47 | 48 | } 49 | -------------------------------------------------------------------------------- /src/main/java/com/github/fabiomaffioletti/firebase/FirebaseConfigurationProperties.java: -------------------------------------------------------------------------------- 1 | package com.github.fabiomaffioletti.firebase; 2 | 3 | import org.springframework.boot.context.properties.ConfigurationProperties; 4 | import org.springframework.context.annotation.Configuration; 5 | 6 | @Configuration 7 | @ConfigurationProperties(prefix = "firebase") 8 | public class FirebaseConfigurationProperties { 9 | 10 | private String serviceAccountFilename; 11 | 12 | private String realtimeDatabaseUrl; 13 | 14 | public String getServiceAccountFilename() { 15 | return serviceAccountFilename; 16 | } 17 | 18 | public void setServiceAccountFilename(String serviceAccountFilename) { 19 | this.serviceAccountFilename = serviceAccountFilename; 20 | } 21 | 22 | public String getRealtimeDatabaseUrl() { 23 | return realtimeDatabaseUrl; 24 | } 25 | 26 | public void setRealtimeDatabaseUrl(String realtimeDatabaseUrl) { 27 | this.realtimeDatabaseUrl = realtimeDatabaseUrl; 28 | } 29 | 30 | } 31 | -------------------------------------------------------------------------------- /src/main/java/com/github/fabiomaffioletti/firebase/document/FirebaseArrayFindResponse.java: -------------------------------------------------------------------------------- 1 | package com.github.fabiomaffioletti.firebase.document; 2 | 3 | import java.util.ArrayList; 4 | 5 | /** 6 | * Created by fabio on 03/12/2018. 7 | */ 8 | public class FirebaseArrayFindResponse extends ArrayList { 9 | 10 | } 11 | -------------------------------------------------------------------------------- /src/main/java/com/github/fabiomaffioletti/firebase/document/FirebaseDocument.java: -------------------------------------------------------------------------------- 1 | package com.github.fabiomaffioletti.firebase.document; 2 | 3 | import java.lang.annotation.Documented; 4 | import java.lang.annotation.Retention; 5 | import java.lang.annotation.Target; 6 | 7 | import static java.lang.annotation.ElementType.TYPE; 8 | import static java.lang.annotation.RetentionPolicy.RUNTIME; 9 | 10 | /** 11 | * Created by fabio on 02/12/2018. 12 | */ 13 | @Documented 14 | @Target(TYPE) 15 | @Retention(RUNTIME) 16 | public @interface FirebaseDocument { 17 | 18 | String value(); 19 | 20 | } 21 | -------------------------------------------------------------------------------- /src/main/java/com/github/fabiomaffioletti/firebase/document/FirebaseId.java: -------------------------------------------------------------------------------- 1 | package com.github.fabiomaffioletti.firebase.document; 2 | 3 | import java.lang.annotation.Documented; 4 | import java.lang.annotation.Retention; 5 | import java.lang.annotation.Target; 6 | 7 | import static java.lang.annotation.ElementType.FIELD; 8 | import static java.lang.annotation.RetentionPolicy.RUNTIME; 9 | 10 | /** 11 | * Created by fabio on 02/12/2018. 12 | */ 13 | @Documented 14 | @Target(FIELD) 15 | @Retention(RUNTIME) 16 | public @interface FirebaseId { 17 | 18 | } 19 | -------------------------------------------------------------------------------- /src/main/java/com/github/fabiomaffioletti/firebase/document/FirebaseMapFindResponse.java: -------------------------------------------------------------------------------- 1 | package com.github.fabiomaffioletti.firebase.document; 2 | 3 | import java.util.HashMap; 4 | 5 | /** 6 | * Created by fabio on 03/12/2018. 7 | */ 8 | public class FirebaseMapFindResponse extends HashMap { 9 | 10 | } 11 | -------------------------------------------------------------------------------- /src/main/java/com/github/fabiomaffioletti/firebase/document/FirebasePushResponse.java: -------------------------------------------------------------------------------- 1 | package com.github.fabiomaffioletti.firebase.document; 2 | 3 | /** 4 | * Created by fabio on 03/12/2018. 5 | */ 6 | public class FirebasePushResponse { 7 | 8 | private String name; 9 | 10 | public String getName() { 11 | return name; 12 | } 13 | 14 | public void setName(String name) { 15 | this.name = name; 16 | } 17 | 18 | } 19 | -------------------------------------------------------------------------------- /src/main/java/com/github/fabiomaffioletti/firebase/exception/FirebaseRepositoryException.java: -------------------------------------------------------------------------------- 1 | package com.github.fabiomaffioletti.firebase.exception; 2 | 3 | /** 4 | * Created by fabio on 03/12/2018. 5 | */ 6 | public class FirebaseRepositoryException extends RuntimeException { 7 | 8 | public FirebaseRepositoryException(String message) { 9 | super(message); 10 | } 11 | 12 | } 13 | -------------------------------------------------------------------------------- /src/main/java/com/github/fabiomaffioletti/firebase/repository/DefaultFirebaseRealtimeDatabaseRepository.java: -------------------------------------------------------------------------------- 1 | package com.github.fabiomaffioletti.firebase.repository; 2 | 3 | import com.fasterxml.jackson.core.type.TypeReference; 4 | import com.fasterxml.jackson.databind.ObjectMapper; 5 | import com.github.fabiomaffioletti.firebase.document.*; 6 | import com.github.fabiomaffioletti.firebase.exception.FirebaseRepositoryException; 7 | import com.github.fabiomaffioletti.firebase.service.FirebaseApplicationService; 8 | import com.google.common.collect.Lists; 9 | import org.springframework.beans.factory.annotation.Autowired; 10 | import org.springframework.core.ParameterizedTypeReference; 11 | import org.springframework.core.annotation.AnnotationUtils; 12 | import org.springframework.http.HttpEntity; 13 | import org.springframework.http.HttpMethod; 14 | import org.springframework.http.HttpStatus; 15 | import org.springframework.util.ReflectionUtils; 16 | import org.springframework.web.client.HttpClientErrorException; 17 | import org.springframework.web.client.RestTemplate; 18 | 19 | import java.io.IOException; 20 | import java.lang.reflect.Field; 21 | import java.lang.reflect.ParameterizedType; 22 | import java.lang.reflect.Type; 23 | import java.util.Arrays; 24 | import java.util.List; 25 | import java.util.StringJoiner; 26 | import java.util.stream.LongStream; 27 | 28 | /** 29 | * Maps methods here: 30 | * - https://firebase.google.com/docs/database/rest/save-data?authuser=0 31 | * - https://firebase.google.com/docs/database/rest/retrieve-data?authuser=0 32 | */ 33 | @SuppressWarnings("unchecked") 34 | public class DefaultFirebaseRealtimeDatabaseRepository implements FirebaseRealtimeDatabaseRepository { 35 | 36 | @Autowired 37 | private RestTemplate restTemplate; 38 | 39 | @Autowired 40 | private ObjectMapper firebaseObjectMapper; 41 | 42 | @Autowired 43 | private FirebaseApplicationService firebaseApplicationService; 44 | 45 | private Class documentClass; 46 | 47 | private Class documentIdClass; 48 | 49 | private Field documentId; 50 | 51 | private String documentPath; 52 | 53 | private final static List allowedIdTypes = Lists.newArrayList(Integer.class, Long.class, String.class); 54 | 55 | public DefaultFirebaseRealtimeDatabaseRepository() { 56 | documentClass = (Class) ((ParameterizedType) getClass().getGenericSuperclass()).getActualTypeArguments()[0]; 57 | documentIdClass = (Class) ((ParameterizedType) getClass().getGenericSuperclass()).getActualTypeArguments()[1]; 58 | if(!allowedIdTypes.contains(documentIdClass)) { 59 | throw new RuntimeException(String.format("FirebaseId type %s is not managed for class %s", documentIdClass.getSimpleName(), documentClass.getSimpleName())); 60 | } 61 | 62 | FirebaseDocument annotation = AnnotationUtils.findAnnotation(documentClass, FirebaseDocument.class); 63 | assert annotation != null : String.format("No FirebaseDocument annotation found on class %s", documentClass.getSimpleName()); 64 | documentId = Arrays.stream(documentClass.getDeclaredFields()).filter(field -> field.isAnnotationPresent(FirebaseId.class)) 65 | .findFirst().orElseThrow(() -> new FirebaseRepositoryException(String.format("FirebaseId not found for class %s", documentClass.getSimpleName()))); 66 | documentPath = annotation.value(); 67 | } 68 | 69 | @Override 70 | public T set(T document, Object... uriVariables) { 71 | ReflectionUtils.makeAccessible(documentId); 72 | ID id = (ID) ReflectionUtils.getField(documentId, document); 73 | assert id != null : "When using set an id value must be specified"; 74 | 75 | HttpEntity httpEntity = HttpEntityBuilder.create(firebaseObjectMapper, firebaseApplicationService).document(document).build(); 76 | T response = restTemplate.exchange(getDocumentPath(id), HttpMethod.PUT, httpEntity, documentClass, uriVariables).getBody(); 77 | ReflectionUtils.setField(documentId, response, id); 78 | 79 | return response; 80 | } 81 | 82 | @Override 83 | public T update(T document, Object... uriVariables) { 84 | ReflectionUtils.makeAccessible(documentId); 85 | ID id = (ID) ReflectionUtils.getField(documentId, document); 86 | assert id != null : "When using update an id value must be specified"; 87 | 88 | HttpEntity httpEntity = HttpEntityBuilder.create(firebaseObjectMapper, firebaseApplicationService) 89 | .header("X-HTTP-Method-Override", HttpMethod.PATCH.name()) 90 | .document(document).build(); 91 | T response = restTemplate.exchange(getDocumentPath(id), HttpMethod.PUT, httpEntity, documentClass, uriVariables).getBody(); 92 | ReflectionUtils.setField(documentId, response, id); 93 | 94 | return response; 95 | } 96 | 97 | @Override 98 | public T push(T document, Object... uriVariables) { 99 | ReflectionUtils.makeAccessible(documentId); 100 | 101 | HttpEntity httpEntity = HttpEntityBuilder.create(firebaseObjectMapper, firebaseApplicationService).document(document).build(); 102 | FirebasePushResponse response = restTemplate.exchange(getDocumentPath(), HttpMethod.POST, httpEntity, FirebasePushResponse.class, uriVariables).getBody(); 103 | assert response != null : String.format("Response is null for push document of class %s", documentClass.getSimpleName()); 104 | ReflectionUtils.setField(documentId, document, response.getName()); 105 | 106 | return document; 107 | } 108 | 109 | @Override 110 | public void remove(ID id, Object... uriVariables) { 111 | HttpEntity httpEntity = HttpEntityBuilder.create(firebaseObjectMapper, firebaseApplicationService).build(); 112 | restTemplate.exchange(getDocumentPath(id), HttpMethod.DELETE, httpEntity, Void.class, uriVariables).getBody(); 113 | } 114 | 115 | @Override 116 | public void removeAll(Object... uriVariables) { 117 | HttpEntity httpEntity = HttpEntityBuilder.create(firebaseObjectMapper, firebaseApplicationService).build(); 118 | restTemplate.exchange(getDocumentPath(), HttpMethod.DELETE, httpEntity, Void.class, uriVariables).getBody(); 119 | } 120 | 121 | @Override 122 | public T get(ID id, Object... uriVariables) throws FirebaseRepositoryException { 123 | ReflectionUtils.makeAccessible(documentId); 124 | 125 | HttpEntity httpEntity = HttpEntityBuilder.create(firebaseObjectMapper, firebaseApplicationService).build(); 126 | T response = restTemplate.exchange(getDocumentPath(id), HttpMethod.GET, httpEntity, documentClass, uriVariables).getBody(); 127 | if (response == null) { 128 | throw new HttpClientErrorException(HttpStatus.NOT_FOUND); 129 | } else { 130 | ReflectionUtils.setField(documentId, response, id); 131 | return response; 132 | } 133 | } 134 | 135 | @Override 136 | public List findAll(Object... uriVariables) { 137 | return find(Filter.FilterBuilder.builder().build(), uriVariables); 138 | } 139 | 140 | @Override 141 | public List find(Filter filter, Object... uriVariables) { 142 | HttpEntity httpEntity = HttpEntityBuilder.create(firebaseObjectMapper, firebaseApplicationService).build(); 143 | String responseString = restTemplate.exchange(getDocumentPath() + filter.toQueryParameters(), HttpMethod.GET, httpEntity, String.class, uriVariables).getBody(); 144 | 145 | try { 146 | return readAsList(responseString); 147 | } catch (IOException objectListException) { 148 | try { 149 | return readAsArray(responseString); 150 | } catch (IOException objectArrayException) { 151 | return Lists.newArrayList(); 152 | } 153 | } 154 | } 155 | 156 | private List readAsArray(String responseString) throws IOException { 157 | List collect = firebaseObjectMapper.readValue(responseString, new FirebaseObjectListTypeReference(firebaseArrayFindResponseParameterizedTypeReference)); 158 | LongStream.range(0, collect.size()).forEach(index -> { 159 | if (collect.get((int) index) != null) { 160 | ReflectionUtils.makeAccessible(documentId); 161 | 162 | // for now only Integer and Long are supported 163 | if(documentIdClass.equals(Integer.class)) { 164 | ReflectionUtils.setField(documentId, collect.get((int) index), (int) index); 165 | } else { 166 | ReflectionUtils.setField(documentId, collect.get((int) index), index); 167 | } 168 | 169 | } 170 | }); 171 | 172 | return collect; 173 | } 174 | 175 | private List readAsList(String responseString) throws IOException { 176 | List result = Lists.newArrayList(); 177 | FirebaseMapFindResponse response = firebaseObjectMapper.readValue(responseString, new FirebaseObjectListTypeReference(firebaseMapFindResponseParameterizedTypeReference)); 178 | if (response != null) { 179 | response.forEach((key, value) -> { 180 | ReflectionUtils.makeAccessible(documentId); 181 | ReflectionUtils.setField(documentId, value, key); 182 | result.add(value); 183 | }); 184 | } 185 | return result; 186 | } 187 | 188 | private String getDocumentPath(ID id) { 189 | return new StringJoiner("/", "", ".json") 190 | .add(firebaseApplicationService.getDatabaseUrl()) 191 | .add(documentPath) 192 | .add(String.valueOf(id)) 193 | .toString(); 194 | } 195 | 196 | private String getDocumentPath() { 197 | return new StringJoiner("/", "", ".json") 198 | .add(firebaseApplicationService.getDatabaseUrl()) 199 | .add(documentPath) 200 | .toString(); 201 | } 202 | 203 | // https://stackoverflow.com/questions/21987295/using-spring-resttemplate-in-generic-method-with-generic-parameter/29547365#29547365 204 | private ParameterizedTypeReference> firebaseMapFindResponseParameterizedTypeReference = new ParameterizedTypeReference>() { 205 | @Override 206 | public Type getType() { 207 | ParameterizedType delegate = (ParameterizedType) super.getType(); 208 | Type[] actualTypeArguments = new Type[]{documentId.getType(), documentClass}; 209 | return getParameterizedType(actualTypeArguments, delegate); 210 | } 211 | }; 212 | 213 | private ParameterizedTypeReference> firebaseArrayFindResponseParameterizedTypeReference = new ParameterizedTypeReference>() { 214 | @Override 215 | public Type getType() { 216 | ParameterizedType delegate = (ParameterizedType) super.getType(); 217 | Type[] actualTypeArguments = new Type[]{documentClass}; 218 | return getParameterizedType(actualTypeArguments, delegate); 219 | } 220 | }; 221 | 222 | private ParameterizedType getParameterizedType(Type[] actualTypeArguments, ParameterizedType delegate) { 223 | return new ParameterizedType() { 224 | @Override 225 | public Type[] getActualTypeArguments() { 226 | return actualTypeArguments; 227 | } 228 | 229 | @Override 230 | public Type getRawType() { 231 | return delegate.getRawType(); 232 | } 233 | 234 | @Override 235 | public Type getOwnerType() { 236 | return delegate.getOwnerType(); 237 | } 238 | }; 239 | } 240 | 241 | public static class FirebaseObjectListTypeReference extends TypeReference { 242 | private final Type type; 243 | 244 | public FirebaseObjectListTypeReference(ParameterizedTypeReference parameterizedTypeReference) { 245 | this.type = parameterizedTypeReference.getType(); 246 | } 247 | 248 | @Override 249 | public Type getType() { 250 | return type; 251 | } 252 | } 253 | 254 | } 255 | -------------------------------------------------------------------------------- /src/main/java/com/github/fabiomaffioletti/firebase/repository/Filter.java: -------------------------------------------------------------------------------- 1 | package com.github.fabiomaffioletti.firebase.repository; 2 | 3 | import com.google.common.collect.ImmutableMap; 4 | 5 | import static java.util.stream.Collectors.joining; 6 | import static org.springframework.util.StringUtils.isEmpty; 7 | 8 | public class Filter { 9 | private ImmutableMap conditions; 10 | 11 | private Filter(ImmutableMap conditions) { 12 | this.conditions = conditions; 13 | } 14 | 15 | public String toQueryParameters() { 16 | return conditions.entrySet().stream().map(entry -> entry.getKey() + "=" + entry.getValue()).collect(joining("&", "?", "")); 17 | } 18 | 19 | public static class FilterBuilder { 20 | 21 | private String orderBy; 22 | 23 | private Integer limitToFirst; 24 | 25 | private Integer limitToLast; 26 | 27 | private Object startAt; 28 | 29 | private Object endAt; 30 | 31 | private Object equalTo; 32 | 33 | private FilterBuilder() {} 34 | 35 | public static FilterBuilder builder() { 36 | return new FilterBuilder(); 37 | } 38 | 39 | public FilterBuilder orderBy(String orderBy) { 40 | this.orderBy = orderBy; 41 | return this; 42 | } 43 | 44 | public FilterBuilder limitToFirst(Integer limitToFirst) { 45 | this.limitToFirst = limitToFirst; 46 | return this; 47 | } 48 | 49 | public FilterBuilder limitToLast(Integer limitToLast) { 50 | this.limitToLast = limitToLast; 51 | return this; 52 | } 53 | 54 | public FilterBuilder startAt(Object startAt) { 55 | this.startAt = checkAndApplyType(startAt); 56 | return this; 57 | } 58 | 59 | public FilterBuilder endAt(Object endAt) { 60 | this.endAt = checkAndApplyType(endAt); 61 | return this; 62 | } 63 | 64 | public FilterBuilder equalTo(Object equalTo) { 65 | this.equalTo = checkAndApplyType(equalTo); 66 | return this; 67 | } 68 | 69 | public Filter build() { 70 | ImmutableMap.Builder builder = ImmutableMap.builder(); 71 | if (!isEmpty(orderBy)) builder.put("orderBy", "\"" + orderBy + "\""); 72 | if (!isEmpty(limitToFirst)) builder.put("limitToFirst", String.valueOf(limitToFirst)); 73 | if (!isEmpty(limitToLast)) builder.put("limitToLast", String.valueOf(limitToLast)); 74 | if (!isEmpty(startAt)) builder.put("startAt", startAt); 75 | if (!isEmpty(endAt)) builder.put("endAt", endAt); 76 | if (!isEmpty(equalTo)) builder.put("equalTo", equalTo); 77 | return new Filter(builder.build()); 78 | } 79 | 80 | private Object checkAndApplyType(Object object) { 81 | if (object instanceof String) { 82 | return "\"" + object + "\""; 83 | } 84 | return object; 85 | } 86 | 87 | } 88 | 89 | } -------------------------------------------------------------------------------- /src/main/java/com/github/fabiomaffioletti/firebase/repository/FirebaseRealtimeDatabaseRepository.java: -------------------------------------------------------------------------------- 1 | package com.github.fabiomaffioletti.firebase.repository; 2 | 3 | import java.util.List; 4 | 5 | /** 6 | * Created by fabio on 02/12/2018. 7 | */ 8 | public interface FirebaseRealtimeDatabaseRepository { 9 | 10 | /** 11 | * Saves a new document. The document must have a user defined id. 12 | * @param document The document to be saved 13 | * @param uriVariables The optional uri variables corresponding to placeholders in the FirebaseDocument annotation 14 | * @return The saved document along with its id 15 | */ 16 | T set(T document, Object... uriVariables); 17 | 18 | /** 19 | * Updates an existing document. If the document does not exist, it will be created. The document must have an id. 20 | * @param document The document (or part of the document) to be updated 21 | * @param uriVariables The optional uri variables corresponding to placeholders in the FirebaseDocument annotation 22 | * @return The saved document along with its id 23 | */ 24 | T update(T document, Object... uriVariables); 25 | 26 | /** 27 | * Saves a new document. Firebase will generate an id and return it with the document. 28 | * @param document The document to be saved 29 | * @param uriVariables The optional uri variables corresponding to placeholders in the FirebaseDocument annotation 30 | * @return The saved document along with its id 31 | */ 32 | T push(T document, Object... uriVariables); 33 | 34 | /** 35 | * Removes a document. 36 | * @param id The id of the document to be removed 37 | * @param uriVariables The optional uri variables corresponding to placeholders in the FirebaseDocument annotation 38 | */ 39 | void remove(ID id, Object... uriVariables); 40 | 41 | /** 42 | * Removes all documents. 43 | * @param uriVariables The optional uri variables corresponding to placeholders in the FirebaseDocument annotation 44 | */ 45 | void removeAll(Object... uriVariables); 46 | 47 | /** 48 | * Gets a document with the given id. 49 | * @param id The id of the document to be retrieved 50 | * @param uriVariables The optional uri variables corresponding to placeholders in the FirebaseDocument annotation 51 | * @return The document along with its id 52 | */ 53 | T get(ID id, Object... uriVariables); 54 | 55 | /** 56 | * Retrieves all documents. 57 | * @param uriVariables The optional uri variables corresponding to placeholders in the FirebaseDocument annotation 58 | * @return The list of matching documents 59 | */ 60 | List findAll(Object... uriVariables); 61 | 62 | /** 63 | * Retrieves all documents matching the given filter. 64 | * @param filter The filter, or query, to be applied when filtering 65 | * @param uriVariables The optional uri variables corresponding to placeholders in the FirebaseDocument annotation 66 | * @return The list of matching documents 67 | */ 68 | List find(Filter filter, Object... uriVariables); 69 | 70 | } 71 | -------------------------------------------------------------------------------- /src/main/java/com/github/fabiomaffioletti/firebase/repository/HttpEntityBuilder.java: -------------------------------------------------------------------------------- 1 | package com.github.fabiomaffioletti.firebase.repository; 2 | 3 | import com.fasterxml.jackson.databind.ObjectMapper; 4 | import com.github.fabiomaffioletti.firebase.exception.FirebaseRepositoryException; 5 | import com.github.fabiomaffioletti.firebase.service.FirebaseApplicationService; 6 | import org.springframework.http.HttpEntity; 7 | import org.springframework.util.MultiValueMap; 8 | 9 | import java.io.IOException; 10 | 11 | public class HttpEntityBuilder { 12 | 13 | private final ObjectMapper firebaseObjectMapper; 14 | 15 | private final FirebaseApplicationService firebaseApplicationService; 16 | 17 | private T document; 18 | 19 | private MultiValueMap headers; 20 | 21 | private HttpEntityBuilder(ObjectMapper firebaseObjectMapper, FirebaseApplicationService firebaseApplicationService) { 22 | try { 23 | this.firebaseObjectMapper = firebaseObjectMapper; 24 | this.firebaseApplicationService = firebaseApplicationService; 25 | headers = this.firebaseApplicationService.headers(); 26 | } catch (IOException e) { 27 | throw new FirebaseRepositoryException(e.getMessage()); 28 | } 29 | } 30 | 31 | public static HttpEntityBuilder create(ObjectMapper firebaseObjectMapper, FirebaseApplicationService firebaseApplicationService) { 32 | return new HttpEntityBuilder(firebaseObjectMapper, firebaseApplicationService); 33 | } 34 | 35 | public HttpEntityBuilder document(T document) { 36 | this.document = document; 37 | return this; 38 | } 39 | 40 | public HttpEntityBuilder header(String headerName, String headerValue) { 41 | this.headers.add(headerName, headerValue); 42 | return this; 43 | } 44 | 45 | public HttpEntity build() { 46 | try { 47 | if(document == null) { 48 | return new HttpEntity<>(headers); 49 | } else { 50 | return new HttpEntity<>(firebaseObjectMapper.writeValueAsString(document), headers); 51 | } 52 | } catch (IOException e) { 53 | throw new FirebaseRepositoryException(e.getMessage()); 54 | } 55 | } 56 | 57 | } 58 | -------------------------------------------------------------------------------- /src/main/java/com/github/fabiomaffioletti/firebase/service/FirebaseApplicationService.java: -------------------------------------------------------------------------------- 1 | package com.github.fabiomaffioletti.firebase.service; 2 | 3 | import com.github.fabiomaffioletti.firebase.FirebaseConfigurationProperties; 4 | import com.google.api.client.googleapis.auth.oauth2.GoogleCredential; 5 | import com.google.auth.oauth2.GoogleCredentials; 6 | import com.google.firebase.FirebaseApp; 7 | import com.google.firebase.FirebaseOptions; 8 | import org.springframework.boot.context.properties.EnableConfigurationProperties; 9 | import org.springframework.core.io.Resource; 10 | import org.springframework.core.io.ResourceLoader; 11 | import org.springframework.http.HttpHeaders; 12 | import org.springframework.util.LinkedMultiValueMap; 13 | import org.springframework.util.MultiValueMap; 14 | 15 | import java.io.IOException; 16 | import java.util.Arrays; 17 | 18 | @EnableConfigurationProperties(FirebaseConfigurationProperties.class) 19 | public class FirebaseApplicationService { 20 | 21 | private GoogleCredential scoped; 22 | 23 | private final ResourceLoader resourceLoader; 24 | 25 | private final FirebaseConfigurationProperties firebaseConfigurationProperties; 26 | 27 | public FirebaseApplicationService(ResourceLoader resourceLoader, FirebaseConfigurationProperties firebaseConfigurationProperties) throws IOException { 28 | this.firebaseConfigurationProperties = firebaseConfigurationProperties; 29 | this.resourceLoader = resourceLoader; 30 | assert firebaseConfigurationProperties.getServiceAccountFilename() != null; 31 | assert firebaseConfigurationProperties.getRealtimeDatabaseUrl() != null; 32 | 33 | // file: or classpath: 34 | Resource serviceAccount = resourceLoader.getResource(firebaseConfigurationProperties.getServiceAccountFilename()); 35 | 36 | FirebaseOptions options = new FirebaseOptions.Builder() 37 | .setCredentials(GoogleCredentials.fromStream(serviceAccount.getInputStream())) 38 | .setDatabaseUrl(firebaseConfigurationProperties.getRealtimeDatabaseUrl()) 39 | .build(); 40 | 41 | if (FirebaseApp.getApps().isEmpty()) { 42 | FirebaseApp.initializeApp(options); 43 | } 44 | 45 | GoogleCredential googleCred = GoogleCredential.fromStream(serviceAccount.getInputStream()); 46 | scoped = googleCred.createScoped(Arrays.asList("https://www.googleapis.com/auth/firebase.database", "https://www.googleapis.com/auth/userinfo.email")); 47 | scoped.refreshToken(); 48 | } 49 | 50 | private String token() throws IOException { 51 | String token = scoped.getAccessToken(); 52 | if (token == null || scoped.getExpiresInSeconds() < 100) { 53 | scoped.refreshToken(); 54 | token = scoped.getAccessToken(); 55 | } 56 | return token; 57 | } 58 | 59 | public MultiValueMap headers() throws IOException { 60 | LinkedMultiValueMap headers = new LinkedMultiValueMap<>(); 61 | headers.add(HttpHeaders.AUTHORIZATION, "Bearer " + token()); 62 | return headers; 63 | } 64 | 65 | public String getDatabaseUrl() { 66 | return firebaseConfigurationProperties.getRealtimeDatabaseUrl(); 67 | } 68 | 69 | } 70 | -------------------------------------------------------------------------------- /src/test/java/com/github/fabiomaffioletti/firebase/FirebaseRealtimeDatabaseRepositoryTest.java: -------------------------------------------------------------------------------- 1 | package com.github.fabiomaffioletti.firebase; 2 | 3 | import org.springframework.boot.context.properties.EnableConfigurationProperties; 4 | import org.springframework.boot.test.context.SpringBootTest; 5 | import org.springframework.test.context.TestPropertySource; 6 | 7 | import java.lang.annotation.*; 8 | 9 | @Target({ElementType.TYPE}) 10 | @Retention(RetentionPolicy.RUNTIME) 11 | @Documented 12 | @Inherited 13 | @SpringBootTest(classes = FirebaseConfiguration.class) 14 | @TestPropertySource(locations = "classpath:application.properties") 15 | @EnableConfigurationProperties(FirebaseConfigurationProperties.class) 16 | public @interface FirebaseRealtimeDatabaseRepositoryTest { 17 | } 18 | -------------------------------------------------------------------------------- /src/test/java/com/github/fabiomaffioletti/firebase/model/RemoveAll.java: -------------------------------------------------------------------------------- 1 | package com.github.fabiomaffioletti.firebase.model; 2 | 3 | import com.github.fabiomaffioletti.firebase.document.FirebaseDocument; 4 | import com.github.fabiomaffioletti.firebase.document.FirebaseId; 5 | 6 | import static com.github.fabiomaffioletti.firebase.model.generatedkey.Constants.BASE_PATH; 7 | 8 | @FirebaseDocument(BASE_PATH) 9 | public class RemoveAll { 10 | 11 | @FirebaseId 12 | private String id; 13 | 14 | public String getId() { 15 | return id; 16 | } 17 | 18 | public void setId(String id) { 19 | this.id = id; 20 | } 21 | 22 | } 23 | -------------------------------------------------------------------------------- /src/test/java/com/github/fabiomaffioletti/firebase/model/definedkey/Author.java: -------------------------------------------------------------------------------- 1 | package com.github.fabiomaffioletti.firebase.model.definedkey; 2 | 3 | import com.github.fabiomaffioletti.firebase.document.FirebaseDocument; 4 | import com.github.fabiomaffioletti.firebase.document.FirebaseId; 5 | 6 | import static com.github.fabiomaffioletti.firebase.model.generatedkey.Constants.BASE_PATH; 7 | 8 | @FirebaseDocument(BASE_PATH + "/authors") 9 | public class Author { 10 | 11 | @FirebaseId 12 | private Long id; 13 | 14 | private String name; 15 | 16 | public Long getId() { 17 | return id; 18 | } 19 | 20 | public void setId(Long id) { 21 | this.id = id; 22 | } 23 | 24 | public String getName() { 25 | return name; 26 | } 27 | 28 | public void setName(String name) { 29 | this.name = name; 30 | } 31 | } 32 | -------------------------------------------------------------------------------- /src/test/java/com/github/fabiomaffioletti/firebase/model/definedkey/Book.java: -------------------------------------------------------------------------------- 1 | package com.github.fabiomaffioletti.firebase.model.definedkey; 2 | 3 | import com.github.fabiomaffioletti.firebase.document.FirebaseDocument; 4 | import com.github.fabiomaffioletti.firebase.document.FirebaseId; 5 | 6 | import static com.github.fabiomaffioletti.firebase.model.generatedkey.Constants.BASE_PATH; 7 | 8 | @FirebaseDocument(BASE_PATH + "/books") 9 | public class Book { 10 | 11 | @FirebaseId 12 | private Integer id; 13 | 14 | private String title; 15 | 16 | public Integer getId() { 17 | return id; 18 | } 19 | 20 | public void setId(Integer id) { 21 | this.id = id; 22 | } 23 | 24 | public String getTitle() { 25 | return title; 26 | } 27 | 28 | public void setTitle(String title) { 29 | this.title = title; 30 | } 31 | 32 | } 33 | -------------------------------------------------------------------------------- /src/test/java/com/github/fabiomaffioletti/firebase/model/generatedkey/Comment.java: -------------------------------------------------------------------------------- 1 | package com.github.fabiomaffioletti.firebase.model.generatedkey; 2 | 3 | import com.github.fabiomaffioletti.firebase.document.FirebaseDocument; 4 | import com.github.fabiomaffioletti.firebase.document.FirebaseId; 5 | 6 | import static com.github.fabiomaffioletti.firebase.model.generatedkey.Constants.BASE_PATH; 7 | 8 | @FirebaseDocument(BASE_PATH + "/comments/{postId}") 9 | public class Comment { 10 | 11 | @FirebaseId 12 | private String id; 13 | 14 | private String content; 15 | 16 | public String getId() { 17 | return id; 18 | } 19 | 20 | public void setId(String id) { 21 | this.id = id; 22 | } 23 | 24 | public String getContent() { 25 | return content; 26 | } 27 | 28 | public void setContent(String content) { 29 | this.content = content; 30 | } 31 | 32 | } 33 | -------------------------------------------------------------------------------- /src/test/java/com/github/fabiomaffioletti/firebase/model/generatedkey/Constants.java: -------------------------------------------------------------------------------- 1 | package com.github.fabiomaffioletti.firebase.model.generatedkey; 2 | 3 | public class Constants { 4 | 5 | public static final String BASE_PATH = "spring-boot-starter-data-firebase-tests"; 6 | 7 | } 8 | -------------------------------------------------------------------------------- /src/test/java/com/github/fabiomaffioletti/firebase/model/generatedkey/Post.java: -------------------------------------------------------------------------------- 1 | package com.github.fabiomaffioletti.firebase.model.generatedkey; 2 | 3 | import com.github.fabiomaffioletti.firebase.document.FirebaseDocument; 4 | import com.github.fabiomaffioletti.firebase.document.FirebaseId; 5 | 6 | import java.util.List; 7 | 8 | @FirebaseDocument(Constants.BASE_PATH + "/posts") 9 | public class Post { 10 | 11 | @FirebaseId 12 | private String id; 13 | 14 | private String title; 15 | 16 | private String body; 17 | 18 | private List tags; 19 | 20 | private String[] categories; 21 | 22 | public String getId() { 23 | return id; 24 | } 25 | 26 | public void setId(String id) { 27 | this.id = id; 28 | } 29 | 30 | public String getTitle() { 31 | return title; 32 | } 33 | 34 | public void setTitle(String title) { 35 | this.title = title; 36 | } 37 | 38 | public String getBody() { 39 | return body; 40 | } 41 | 42 | public void setBody(String body) { 43 | this.body = body; 44 | } 45 | 46 | public List getTags() { 47 | return tags; 48 | } 49 | 50 | public void setTags(List tags) { 51 | this.tags = tags; 52 | } 53 | 54 | public String[] getCategories() { 55 | return categories; 56 | } 57 | 58 | public void setCategories(String[] categories) { 59 | this.categories = categories; 60 | } 61 | } 62 | -------------------------------------------------------------------------------- /src/test/java/com/github/fabiomaffioletti/firebase/model/generatedkey/Tag.java: -------------------------------------------------------------------------------- 1 | package com.github.fabiomaffioletti.firebase.model.generatedkey; 2 | 3 | public class Tag { 4 | 5 | private String name; 6 | 7 | public String getName() { 8 | return name; 9 | } 10 | 11 | public void setName(String name) { 12 | this.name = name; 13 | } 14 | 15 | } 16 | -------------------------------------------------------------------------------- /src/test/java/com/github/fabiomaffioletti/firebase/repository/AuthorRepository.java: -------------------------------------------------------------------------------- 1 | package com.github.fabiomaffioletti.firebase.repository; 2 | 3 | import com.github.fabiomaffioletti.firebase.model.definedkey.Author; 4 | 5 | public class AuthorRepository extends DefaultFirebaseRealtimeDatabaseRepository { 6 | } 7 | -------------------------------------------------------------------------------- /src/test/java/com/github/fabiomaffioletti/firebase/repository/BookRepository.java: -------------------------------------------------------------------------------- 1 | package com.github.fabiomaffioletti.firebase.repository; 2 | 3 | import com.github.fabiomaffioletti.firebase.model.definedkey.Book; 4 | 5 | public class BookRepository extends DefaultFirebaseRealtimeDatabaseRepository { 6 | } 7 | -------------------------------------------------------------------------------- /src/test/java/com/github/fabiomaffioletti/firebase/repository/CommentRepository.java: -------------------------------------------------------------------------------- 1 | package com.github.fabiomaffioletti.firebase.repository; 2 | 3 | import com.github.fabiomaffioletti.firebase.model.generatedkey.Comment; 4 | 5 | public class CommentRepository extends DefaultFirebaseRealtimeDatabaseRepository { 6 | } 7 | -------------------------------------------------------------------------------- /src/test/java/com/github/fabiomaffioletti/firebase/repository/PostRepository.java: -------------------------------------------------------------------------------- 1 | package com.github.fabiomaffioletti.firebase.repository; 2 | 3 | import com.github.fabiomaffioletti.firebase.model.generatedkey.Post; 4 | 5 | public class PostRepository extends DefaultFirebaseRealtimeDatabaseRepository { 6 | } 7 | -------------------------------------------------------------------------------- /src/test/java/com/github/fabiomaffioletti/firebase/repository/RemoveAllRepository.java: -------------------------------------------------------------------------------- 1 | package com.github.fabiomaffioletti.firebase.repository; 2 | 3 | import com.github.fabiomaffioletti.firebase.model.RemoveAll; 4 | 5 | public class RemoveAllRepository extends DefaultFirebaseRealtimeDatabaseRepository { 6 | } 7 | -------------------------------------------------------------------------------- /src/test/java/com/github/fabiomaffioletti/firebase/repository/test/AuthorRepositoryTest.java: -------------------------------------------------------------------------------- 1 | package com.github.fabiomaffioletti.firebase.repository.test; 2 | 3 | import com.github.fabiomaffioletti.firebase.FirebaseRealtimeDatabaseRepositoryTest; 4 | import com.github.fabiomaffioletti.firebase.model.definedkey.Author; 5 | import com.github.fabiomaffioletti.firebase.repository.AuthorRepository; 6 | import com.github.fabiomaffioletti.firebase.repository.RemoveAllRepository; 7 | import org.junit.Before; 8 | import org.junit.Test; 9 | import org.junit.runner.RunWith; 10 | import org.springframework.beans.factory.annotation.Autowired; 11 | import org.springframework.boot.test.context.TestConfiguration; 12 | import org.springframework.context.annotation.Bean; 13 | import org.springframework.context.annotation.Import; 14 | import org.springframework.test.context.junit4.SpringRunner; 15 | import org.springframework.web.client.RestTemplate; 16 | 17 | import java.util.List; 18 | 19 | import static org.hamcrest.core.Is.is; 20 | import static org.junit.Assert.assertNotNull; 21 | import static org.junit.Assert.assertThat; 22 | 23 | @RunWith(SpringRunner.class) 24 | @FirebaseRealtimeDatabaseRepositoryTest 25 | @Import(AuthorRepositoryTest.RepositoryTestConfiguration.class) 26 | public class AuthorRepositoryTest { 27 | 28 | @TestConfiguration 29 | public static class RepositoryTestConfiguration { 30 | 31 | @Bean 32 | public RestTemplate restTemplate() { 33 | return new RestTemplate(); 34 | } 35 | 36 | @Bean 37 | public AuthorRepository authorRepository() { 38 | return new AuthorRepository(); 39 | } 40 | 41 | @Bean 42 | public RemoveAllRepository removeAllRepository() { 43 | return new RemoveAllRepository(); 44 | } 45 | 46 | } 47 | 48 | @Autowired 49 | private AuthorRepository authorRepository; 50 | 51 | @Autowired 52 | private RemoveAllRepository removeAllRepository; 53 | 54 | @Before 55 | public void setUp() { 56 | removeAllRepository.removeAll(); 57 | } 58 | 59 | @Test 60 | public void itShouldSaveAuthorsWithSuccessAsAList() { 61 | Author author = new Author(); 62 | author.setId(1L); 63 | author.setName("author # 1"); 64 | author = authorRepository.set(author); 65 | assertNotNull(author); 66 | 67 | author = new Author(); 68 | author.setId(2L); 69 | author.setName("author # 2"); 70 | author = authorRepository.set(author); 71 | assertNotNull(author); 72 | 73 | author = authorRepository.get(1L); 74 | assertNotNull(author); 75 | assertThat(author.getName(), is("author # 1")); 76 | 77 | author = new Author(); 78 | author.setId(3000L); 79 | author.setName("author # 3"); 80 | author = authorRepository.set(author); 81 | assertNotNull(author); 82 | 83 | List authors = authorRepository.findAll(); 84 | assertThat(authors.size(), is(3)); 85 | } 86 | 87 | @Test 88 | public void itShouldSaveAuthorsWithSuccessAsAnArray() { 89 | Author author = new Author(); 90 | author.setId(1L); 91 | author.setName("author # 1"); 92 | author = authorRepository.set(author); 93 | assertNotNull(author); 94 | 95 | author = new Author(); 96 | author.setId(2L); 97 | author.setName("author # 2"); 98 | author = authorRepository.set(author); 99 | assertNotNull(author); 100 | 101 | author = authorRepository.get(1L); 102 | assertNotNull(author); 103 | assertThat(author.getName(), is("author # 1")); 104 | 105 | author = new Author(); 106 | author.setId(3L); 107 | author.setName("author # 3"); 108 | author = authorRepository.set(author); 109 | assertNotNull(author); 110 | 111 | List authors = authorRepository.findAll(); 112 | assertThat(authors.size(), is(4)); 113 | } 114 | 115 | } 116 | -------------------------------------------------------------------------------- /src/test/java/com/github/fabiomaffioletti/firebase/repository/test/BookRepositoryTest.java: -------------------------------------------------------------------------------- 1 | package com.github.fabiomaffioletti.firebase.repository.test; 2 | 3 | import com.github.fabiomaffioletti.firebase.FirebaseRealtimeDatabaseRepositoryTest; 4 | import com.github.fabiomaffioletti.firebase.model.definedkey.Book; 5 | import com.github.fabiomaffioletti.firebase.repository.BookRepository; 6 | import com.github.fabiomaffioletti.firebase.repository.RemoveAllRepository; 7 | import org.junit.Before; 8 | import org.junit.Test; 9 | import org.junit.runner.RunWith; 10 | import org.springframework.beans.factory.annotation.Autowired; 11 | import org.springframework.boot.test.context.TestConfiguration; 12 | import org.springframework.context.annotation.Bean; 13 | import org.springframework.context.annotation.Import; 14 | import org.springframework.test.context.junit4.SpringRunner; 15 | import org.springframework.web.client.RestTemplate; 16 | 17 | import java.util.List; 18 | 19 | import static org.hamcrest.core.Is.is; 20 | import static org.junit.Assert.assertNotNull; 21 | import static org.junit.Assert.assertThat; 22 | 23 | @RunWith(SpringRunner.class) 24 | @FirebaseRealtimeDatabaseRepositoryTest 25 | @Import(BookRepositoryTest.RepositoryTestConfiguration.class) 26 | public class BookRepositoryTest { 27 | 28 | @TestConfiguration 29 | public static class RepositoryTestConfiguration { 30 | 31 | @Bean 32 | public RestTemplate restTemplate() { 33 | return new RestTemplate(); 34 | } 35 | 36 | @Bean 37 | public BookRepository bookRepository() { 38 | return new BookRepository(); 39 | } 40 | 41 | @Bean 42 | public RemoveAllRepository removeAllRepository() { 43 | return new RemoveAllRepository(); 44 | } 45 | 46 | } 47 | 48 | @Autowired 49 | private BookRepository bookRepository; 50 | 51 | @Autowired 52 | private RemoveAllRepository removeAllRepository; 53 | 54 | @Before 55 | public void setUp() { 56 | removeAllRepository.removeAll(); 57 | } 58 | 59 | @Test 60 | public void itShouldSaveBooksWithSuccessAsAList() { 61 | Book book = new Book(); 62 | book.setId(1); 63 | book.setTitle("book # 1"); 64 | book = bookRepository.set(book); 65 | assertNotNull(book); 66 | 67 | book = new Book(); 68 | book.setId(2); 69 | book.setTitle("book # 2"); 70 | book = bookRepository.set(book); 71 | assertNotNull(book); 72 | 73 | book = bookRepository.get(1); 74 | assertNotNull(book); 75 | assertThat(book.getTitle(), is("book # 1")); 76 | 77 | book = new Book(); 78 | book.setId(3000); 79 | book.setTitle("book # 3"); 80 | book = bookRepository.set(book); 81 | assertNotNull(book); 82 | 83 | List books = bookRepository.findAll(); 84 | assertThat(books.size(), is(3)); 85 | } 86 | 87 | @Test 88 | public void itShouldSaveBooksWithSuccessAsAnArray() { 89 | Book book = new Book(); 90 | book.setId(1); 91 | book.setTitle("book # 1"); 92 | book = bookRepository.set(book); 93 | assertNotNull(book); 94 | 95 | book = new Book(); 96 | book.setId(2); 97 | book.setTitle("book # 2"); 98 | book = bookRepository.set(book); 99 | assertNotNull(book); 100 | 101 | book = bookRepository.get(1); 102 | assertNotNull(book); 103 | assertThat(book.getTitle(), is("book # 1")); 104 | 105 | book = new Book(); 106 | book.setId(3); 107 | book.setTitle("book # 3"); 108 | book = bookRepository.set(book); 109 | assertNotNull(book); 110 | 111 | List books = bookRepository.findAll(); 112 | assertThat(books.size(), is(4)); 113 | } 114 | 115 | } 116 | -------------------------------------------------------------------------------- /src/test/java/com/github/fabiomaffioletti/firebase/repository/test/CommentRepositoryTest.java: -------------------------------------------------------------------------------- 1 | package com.github.fabiomaffioletti.firebase.repository.test; 2 | 3 | import com.github.fabiomaffioletti.firebase.FirebaseRealtimeDatabaseRepositoryTest; 4 | import com.github.fabiomaffioletti.firebase.model.generatedkey.Comment; 5 | import com.github.fabiomaffioletti.firebase.model.generatedkey.Post; 6 | import com.github.fabiomaffioletti.firebase.repository.CommentRepository; 7 | import com.github.fabiomaffioletti.firebase.repository.PostRepository; 8 | import com.github.fabiomaffioletti.firebase.repository.RemoveAllRepository; 9 | import org.junit.Before; 10 | import org.junit.Test; 11 | import org.junit.runner.RunWith; 12 | import org.springframework.beans.factory.annotation.Autowired; 13 | import org.springframework.boot.test.context.TestConfiguration; 14 | import org.springframework.context.annotation.Bean; 15 | import org.springframework.context.annotation.Import; 16 | import org.springframework.test.context.junit4.SpringRunner; 17 | import org.springframework.web.client.HttpClientErrorException; 18 | import org.springframework.web.client.RestTemplate; 19 | 20 | import java.util.List; 21 | 22 | import static org.hamcrest.Matchers.is; 23 | import static org.junit.Assert.*; 24 | 25 | @RunWith(SpringRunner.class) 26 | @FirebaseRealtimeDatabaseRepositoryTest 27 | @Import(CommentRepositoryTest.RepositoryTestConfiguration.class) 28 | public class CommentRepositoryTest { 29 | 30 | @TestConfiguration 31 | public static class RepositoryTestConfiguration { 32 | 33 | @Bean 34 | public RestTemplate restTemplate() { 35 | return new RestTemplate(); 36 | } 37 | 38 | @Bean 39 | public PostRepository postRepository() { 40 | return new PostRepository(); 41 | } 42 | 43 | @Bean 44 | public CommentRepository commentRepository() { 45 | return new CommentRepository(); 46 | } 47 | 48 | @Bean 49 | public RemoveAllRepository removeAllRepository() { 50 | return new RemoveAllRepository(); 51 | } 52 | 53 | } 54 | 55 | @Autowired 56 | private PostRepository postRepository; 57 | 58 | @Autowired 59 | private CommentRepository commentRepository; 60 | 61 | @Autowired 62 | private RemoveAllRepository removeAllRepository; 63 | 64 | private Post post_1; 65 | 66 | private Post post_2; 67 | 68 | @Before 69 | public void setUp() { 70 | removeAllRepository.removeAll(); 71 | 72 | post_1 = new Post(); 73 | post_1.setTitle("My test post_1 # 1"); 74 | post_1.setBody("My test post_1 # 1 body"); 75 | post_1 = postRepository.push(post_1); 76 | 77 | post_2 = new Post(); 78 | post_2.setTitle("My test post_2 # 2"); 79 | post_2.setBody("My test post_2 # 2 body"); 80 | post_2 = postRepository.push(post_2); 81 | } 82 | 83 | @Test 84 | public void itShouldSaveCommentsForTwoPostsWithSuccess() { 85 | String postId = post_1.getId(); 86 | Comment comment = new Comment(); 87 | comment.setContent("My test comment #1 for post_1 #1"); 88 | comment = commentRepository.push(comment, postId); 89 | assertNotNull(comment); 90 | assertNotNull(comment.getId()); 91 | 92 | comment = new Comment(); 93 | comment.setContent("My test comment #2 for post_1 #1"); 94 | comment = commentRepository.push(comment, postId); 95 | assertNotNull(comment); 96 | assertNotNull(comment.getId()); 97 | 98 | List comments = commentRepository.findAll(postId); 99 | assertThat(comments.size(), is(2)); 100 | 101 | postId = post_2.getId(); 102 | comment = new Comment(); 103 | comment.setContent("My test comment #1 for post_2 #2"); 104 | comment = commentRepository.push(comment, postId); 105 | assertNotNull(comment); 106 | assertNotNull(comment.getId()); 107 | 108 | comments = commentRepository.findAll(postId); 109 | assertThat(comments.size(), is(1)); 110 | 111 | comment = commentRepository.get(comment.getId(), postId); 112 | assertNotNull(comment); 113 | 114 | try { 115 | commentRepository.get(comment.getId(), post_1.getId()); 116 | fail(); 117 | } catch(HttpClientErrorException e) { 118 | assertTrue(true); 119 | } 120 | } 121 | 122 | @Test 123 | public void itShouldSaveAndRemoveACommentWithSuccess() { 124 | String postId = post_1.getId(); 125 | Comment comment = new Comment(); 126 | comment.setContent("My test comment #1 for post_1 #1"); 127 | comment = commentRepository.push(comment, postId); 128 | assertNotNull(comment); 129 | assertNotNull(comment.getId()); 130 | 131 | List comments = commentRepository.findAll(postId); 132 | assertThat(comments.size(), is(1)); 133 | 134 | commentRepository.remove(comment.getId(), postId); 135 | comments = commentRepository.findAll(postId); 136 | assertThat(comments.size(), is(0)); 137 | } 138 | 139 | @Test 140 | public void itShouldSaveAndRemoveAllCommentsWithSuccess() { 141 | String postId = post_1.getId(); 142 | Comment comment = new Comment(); 143 | comment.setContent("My test comment #1 for post_1 #1"); 144 | comment = commentRepository.push(comment, postId); 145 | assertNotNull(comment); 146 | assertNotNull(comment.getId()); 147 | 148 | comment.setContent("My test comment #2 for post_1 #1"); 149 | comment = commentRepository.push(comment, postId); 150 | assertNotNull(comment); 151 | assertNotNull(comment.getId()); 152 | 153 | List comments = commentRepository.findAll(postId); 154 | assertThat(comments.size(), is(2)); 155 | 156 | commentRepository.removeAll(postId); 157 | comments = commentRepository.findAll(postId); 158 | assertThat(comments.size(), is(0)); 159 | } 160 | 161 | } 162 | -------------------------------------------------------------------------------- /src/test/java/com/github/fabiomaffioletti/firebase/repository/test/PostRepositoryTest.java: -------------------------------------------------------------------------------- 1 | package com.github.fabiomaffioletti.firebase.repository.test; 2 | 3 | import com.github.fabiomaffioletti.firebase.FirebaseRealtimeDatabaseRepositoryTest; 4 | import com.github.fabiomaffioletti.firebase.model.generatedkey.Post; 5 | import com.github.fabiomaffioletti.firebase.model.generatedkey.Tag; 6 | import com.github.fabiomaffioletti.firebase.repository.Filter; 7 | import com.github.fabiomaffioletti.firebase.repository.PostRepository; 8 | import com.github.fabiomaffioletti.firebase.repository.RemoveAllRepository; 9 | import com.google.common.collect.Lists; 10 | import org.junit.Before; 11 | import org.junit.Test; 12 | import org.junit.runner.RunWith; 13 | import org.springframework.beans.factory.annotation.Autowired; 14 | import org.springframework.boot.test.context.TestConfiguration; 15 | import org.springframework.context.annotation.Bean; 16 | import org.springframework.context.annotation.Import; 17 | import org.springframework.test.context.junit4.SpringRunner; 18 | import org.springframework.web.client.HttpClientErrorException; 19 | import org.springframework.web.client.RestTemplate; 20 | 21 | import java.util.List; 22 | import java.util.stream.IntStream; 23 | 24 | import static org.hamcrest.Matchers.is; 25 | import static org.junit.Assert.*; 26 | 27 | @RunWith(SpringRunner.class) 28 | @FirebaseRealtimeDatabaseRepositoryTest 29 | @Import(PostRepositoryTest.RepositoryTestConfiguration.class) 30 | public class PostRepositoryTest { 31 | 32 | @TestConfiguration 33 | public static class RepositoryTestConfiguration { 34 | 35 | @Bean 36 | public RestTemplate restTemplate() { 37 | return new RestTemplate(); 38 | } 39 | 40 | @Bean 41 | public PostRepository postRepository() { 42 | return new PostRepository(); 43 | } 44 | 45 | @Bean 46 | public RemoveAllRepository removeAllRepository() { 47 | return new RemoveAllRepository(); 48 | } 49 | 50 | } 51 | 52 | @Autowired 53 | private PostRepository postRepository; 54 | 55 | @Autowired 56 | private RemoveAllRepository removeAllRepository; 57 | 58 | @Before 59 | public void setUp() { 60 | removeAllRepository.removeAll(); 61 | } 62 | 63 | @Test 64 | public void itShouldSaveAndUpdateAndRetrieveAPostWithSuccess() { 65 | Post post = new Post(); 66 | post.setTitle("My test post # 1"); 67 | post.setBody("My test post # 1 body"); 68 | post.setCategories(new String[]{"Category #1", "Category #2", "Category #3"}); 69 | post = postRepository.push(post); 70 | assertNotNull(post); 71 | assertNotNull(post.getId()); 72 | assertThat(post.getCategories().length, is(3)); 73 | 74 | post = postRepository.get(post.getId()); 75 | assertThat(post.getTitle(), is("My test post # 1")); 76 | assertNull(post.getTags()); 77 | 78 | Tag tagOne = new Tag(); 79 | tagOne.setName("tag_one"); 80 | Tag tagTwo = new Tag(); 81 | tagTwo.setName("tag_two"); 82 | post.setTitle("My updated title # 1"); 83 | post.setTags(Lists.newArrayList(tagOne, tagTwo)); 84 | post = postRepository.update(post); 85 | assertThat(post.getTitle(), is("My updated title # 1")); 86 | assertThat(post.getTags().size(), is(2)); 87 | 88 | List posts = postRepository.findAll(); 89 | assertThat(posts.size(), is(1)); 90 | 91 | posts = postRepository.find(Filter.FilterBuilder.builder().orderBy("title").limitToFirst(1).build()); 92 | assertThat(posts.size(), is(1)); 93 | } 94 | 95 | @Test 96 | public void itShouldCreateAPostIfUpdatingAnUnexistingPost() { 97 | try { 98 | postRepository.get("unexisting"); 99 | fail(); 100 | } catch (HttpClientErrorException e) { 101 | Post post = new Post(); 102 | post.setId("unexisting"); 103 | post.setTitle("Title of an unexisting post"); 104 | post = postRepository.update(post); 105 | assertNotNull(post); 106 | assertThat(post.getId(), is("unexisting")); 107 | assertThat(post.getTitle(), is("Title of an unexisting post")); 108 | } 109 | } 110 | 111 | @Test 112 | public void itShouldSaveAndRetrieveAListOfPostWithSuccess() { 113 | IntStream.range(1, 20).boxed().forEach(i -> { 114 | Post post = new Post(); 115 | post.setTitle(String.format("My test post # %s", i)); 116 | post.setBody(String.format("My test post # %s body", i)); 117 | postRepository.push(post); 118 | }); 119 | 120 | List posts = postRepository.find(Filter.FilterBuilder.builder().orderBy("title").limitToFirst(5).build()); 121 | assertThat(posts.size(), is(5)); 122 | } 123 | 124 | } -------------------------------------------------------------------------------- /src/test/resources/application.properties: -------------------------------------------------------------------------------- 1 | firebase.service-account-filename=classpath:sb-starter-data-firebase.json 2 | firebase.realtime-database-url=https://sb-starter-data-firebase.firebaseio.com --------------------------------------------------------------------------------