This is an automated email from the ASF dual-hosted git repository. juhan pushed a commit to branch spring_boot_2 in repository https://gitbox.apache.org/repos/asf/fineract-cn-api.git
commit 7bd388d5b56ab453b2318b22169fe1d320dba188 Author: myrle-krantz <[email protected]> AuthorDate: Mon Mar 13 18:37:19 2017 +0100 Open Sourcing core.api. --- .gitignore | 14 + HEADER | 13 + LICENSE | 201 +++++++++++++++ README.md | 28 ++ build.gradle | 83 ++++++ gradle/wrapper/gradle-wrapper.jar | Bin 0 -> 54212 bytes gradle/wrapper/gradle-wrapper.properties | 6 + gradlew | 172 +++++++++++++ gradlew.bat | 84 ++++++ settings.gradle | 1 + .../mifos/core/api/annotation/ThrowsException.java | 34 +++ .../core/api/annotation/ThrowsExceptions.java | 31 +++ .../io/mifos/core/api/config/ApiConfiguration.java | 37 +++ .../io/mifos/core/api/config/EnableApiFactory.java | 36 +++ .../java/io/mifos/core/api/context/AutoGuest.java | 26 ++ .../java/io/mifos/core/api/context/AutoSeshat.java | 28 ++ .../io/mifos/core/api/context/AutoUserContext.java | 40 +++ .../mifos/core/api/util/AnnotatedErrorDecoder.java | 136 ++++++++++ .../java/io/mifos/core/api/util/ApiConstants.java | 27 ++ .../java/io/mifos/core/api/util/ApiFactory.java | 55 ++++ .../core/api/util/CookieInterceptingClient.java | 92 +++++++ .../api/util/CustomFeignClientsConfiguration.java | 90 +++++++ .../mifos/core/api/util/InternalServerError.java | 27 ++ .../mifos/core/api/util/InvalidTokenException.java | 27 ++ .../io/mifos/core/api/util/NotFoundException.java | 24 ++ .../core/api/util/TenantedTargetInterceptor.java | 36 +++ .../core/api/util/TokenedTargetInterceptor.java | 36 +++ .../java/io/mifos/core/api/util/UserContext.java | 56 ++++ .../io/mifos/core/api/util/UserContextHolder.java | 75 ++++++ .../core/api/context/AutoUserContextTest.java | 46 ++++ .../core/api/util/AnnotatedErrorDecoderTest.java | 281 +++++++++++++++++++++ .../api/util/CookieInterceptingClientTest.java | 81 ++++++ .../api/util/TenantedTargetInterceptorTest.java | 43 ++++ .../api/util/TokenedTargetInterceptorTest.java | 42 +++ .../mifos/core/api/util/UserContextHolderTest.java | 77 ++++++ 35 files changed, 2085 insertions(+) diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..536de5a --- /dev/null +++ b/.gitignore @@ -0,0 +1,14 @@ +/.gradle +.idea +build/ +target/ + +# Ignore Gradle GUI config +gradle-app.setting + +# Avoid ignoring Gradle wrapper jar file (.jar files are usually ignored) +!gradle-wrapper.jar + +*.iml + +*.log \ No newline at end of file diff --git a/HEADER b/HEADER new file mode 100644 index 0000000..d47a70e --- /dev/null +++ b/HEADER @@ -0,0 +1,13 @@ +Copyright ${year} ${name}. + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..8dada3e --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "{}" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright {yyyy} {name of copyright owner} + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/README.md b/README.md new file mode 100644 index 0000000..605c049 --- /dev/null +++ b/README.md @@ -0,0 +1,28 @@ +# Mifos I/O Core API + +[](https://gitter.im/mifos-initiative/mifos.io?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) + +This project is an umbrella for all Mifos I/O Core components. + +## Abstract +Mifos I/O is an application framework for digital financial services, a system to support nationwide and cross-national financial transactions and help to level and speed the creation of an inclusive, interconnected digital economy for every nation in the world. + +## Prerequisites +### Runtime +Install Java 8 as described at https://docs.oracle.com/javase/8/docs/technotes/guides/install/install_overview.html. + +## Versioning +The version numbers follow the [Semantic Versioning](http://semver.org/) scheme. + +In addition to MAJOR.MINOR.PATCH the following postfixes are used to indicate the development state. + +* BUILD-SNAPSHOT - A release currently in development. +* RELEASE - _General availability_ indicates that this release is the best available version and is recommended for all usage. + +The versioning layout is {MAJOR}.{MINOR}.{PATCH}-{INDICATOR}[.{PATCH}]. Only milestones and release candidates can have patch versions. Some examples: + +1.2.3-BUILD-SNAPSHOT +1.3.5-RELEASE + +## License +See [LICENSE](LICENSE) file. diff --git a/build.gradle b/build.gradle new file mode 100644 index 0000000..180a316 --- /dev/null +++ b/build.gradle @@ -0,0 +1,83 @@ +buildscript { + repositories { + jcenter(); + } + dependencies { + classpath 'io.spring.gradle:dependency-management-plugin:0.6.0.RELEASE' + } +} + +plugins { + id 'com.github.hierynomus.license' version '0.13.1' +} + +group 'io.mifos.core' +version '0.1.0-BUILD-SNAPSHOT' + +ext.versions = [ + springcontext : '4.3.3.RELEASE', + springboot : '1.4.1.RELEASE', + feigngson : '8.16.2', + findbugs : '3.0.1', + frameworklangversion : '0.1.0-BUILD-SNAPSHOT' +] + +apply plugin: 'java' +apply plugin: 'idea' +apply plugin: 'maven' +apply plugin: 'maven-publish' +apply plugin: 'license' +apply plugin: 'io.spring.dependency-management' + +tasks.withType(JavaCompile) { + sourceCompatibility = JavaVersion.VERSION_1_8 + targetCompatibility = JavaVersion.VERSION_1_8 +} + +repositories { + jcenter() + mavenLocal() +} + +dependencyManagement { + imports { + mavenBom 'org.springframework.cloud:spring-cloud-netflix:1.2.0.RELEASE' + } +} + +dependencies { + compile( + [group: 'org.springframework.cloud', name: 'spring-cloud-starter-feign'], + [group: 'org.springframework.cloud', name: 'spring-cloud-starter-eureka'], + [group: 'org.springframework', name: 'spring-context', version: versions.springcontext], + [group: 'com.google.code.findbugs', name: 'jsr305', version: versions.findbugs], + [group: 'com.netflix.feign', name: 'feign-gson', version: versions.feigngson], + [group: 'io.mifos.core', name: 'lang', version: versions.frameworklangversion], + ) + + testCompile( + [group: 'org.springframework.boot', name: 'spring-boot-starter-test', version: versions.springboot] + ) +} + + +publishing { + publications { + apiPublication(MavenPublication) { + from components.java + groupId project.group + artifactId project.name + version project.version + } + } +} + +license { + header rootProject.file('HEADER') + strictCheck true + mapping { + java = 'SLASHSTAR_STYLE' + } + ext.year = Calendar.getInstance().get(Calendar.YEAR) + ext.name = 'The Mifos Initiative' +} \ No newline at end of file diff --git a/gradle/wrapper/gradle-wrapper.jar b/gradle/wrapper/gradle-wrapper.jar new file mode 100644 index 0000000..c537cf6 Binary files /dev/null and b/gradle/wrapper/gradle-wrapper.jar differ diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties new file mode 100644 index 0000000..82c49d9 --- /dev/null +++ b/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,6 @@ +#Mon Mar 13 18:26:40 CET 2017 +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists +distributionUrl=https\://services.gradle.org/distributions/gradle-3.4.1-bin.zip diff --git a/gradlew b/gradlew new file mode 100755 index 0000000..4453cce --- /dev/null +++ b/gradlew @@ -0,0 +1,172 @@ +#!/usr/bin/env sh + +############################################################################## +## +## Gradle start up script for UN*X +## +############################################################################## + +# Attempt to set APP_HOME +# Resolve links: $0 may be a link +PRG="$0" +# Need this for relative symlinks. +while [ -h "$PRG" ] ; do + ls=`ls -ld "$PRG"` + link=`expr "$ls" : '.*-> \(.*\)$'` + if expr "$link" : '/.*' > /dev/null; then + PRG="$link" + else + PRG=`dirname "$PRG"`"/$link" + fi +done +SAVED="`pwd`" +cd "`dirname \"$PRG\"`/" >/dev/null +APP_HOME="`pwd -P`" +cd "$SAVED" >/dev/null + +APP_NAME="Gradle" +APP_BASE_NAME=`basename "$0"` + +# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +DEFAULT_JVM_OPTS="" + +# Use the maximum available, or set MAX_FD != -1 to use that value. +MAX_FD="maximum" + +warn ( ) { + echo "$*" +} + +die ( ) { + echo + echo "$*" + echo + exit 1 +} + +# OS specific support (must be 'true' or 'false'). +cygwin=false +msys=false +darwin=false +nonstop=false +case "`uname`" in + CYGWIN* ) + cygwin=true + ;; + Darwin* ) + darwin=true + ;; + MINGW* ) + msys=true + ;; + NONSTOP* ) + nonstop=true + ;; +esac + +CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar + +# Determine the Java command to use to start the JVM. +if [ -n "$JAVA_HOME" ] ; then + if [ -x "$JAVA_HOME/jre/sh/java" ] ; then + # IBM's JDK on AIX uses strange locations for the executables + JAVACMD="$JAVA_HOME/jre/sh/java" + else + JAVACMD="$JAVA_HOME/bin/java" + fi + if [ ! -x "$JAVACMD" ] ; then + die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +else + JAVACMD="java" + which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." +fi + +# Increase the maximum file descriptors if we can. +if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then + MAX_FD_LIMIT=`ulimit -H -n` + if [ $? -eq 0 ] ; then + if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then + MAX_FD="$MAX_FD_LIMIT" + fi + ulimit -n $MAX_FD + if [ $? -ne 0 ] ; then + warn "Could not set maximum file descriptor limit: $MAX_FD" + fi + else + warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT" + fi +fi + +# For Darwin, add options to specify how the application appears in the dock +if $darwin; then + GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\"" +fi + +# For Cygwin, switch paths to Windows format before running java +if $cygwin ; then + APP_HOME=`cygpath --path --mixed "$APP_HOME"` + CLASSPATH=`cygpath --path --mixed "$CLASSPATH"` + JAVACMD=`cygpath --unix "$JAVACMD"` + + # We build the pattern for arguments to be converted via cygpath + ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null` + SEP="" + for dir in $ROOTDIRSRAW ; do + ROOTDIRS="$ROOTDIRS$SEP$dir" + SEP="|" + done + OURCYGPATTERN="(^($ROOTDIRS))" + # Add a user-defined pattern to the cygpath arguments + if [ "$GRADLE_CYGPATTERN" != "" ] ; then + OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)" + fi + # Now convert the arguments - kludge to limit ourselves to /bin/sh + i=0 + for arg in "$@" ; do + CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -` + CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option + + if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition + eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"` + else + eval `echo args$i`="\"$arg\"" + fi + i=$((i+1)) + done + case $i in + (0) set -- ;; + (1) set -- "$args0" ;; + (2) set -- "$args0" "$args1" ;; + (3) set -- "$args0" "$args1" "$args2" ;; + (4) set -- "$args0" "$args1" "$args2" "$args3" ;; + (5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;; + (6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;; + (7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;; + (8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;; + (9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;; + esac +fi + +# Escape application args +save ( ) { + for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done + echo " " +} +APP_ARGS=$(save "$@") + +# Collect all arguments for the java command, following the shell quoting and substitution rules +eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS" + +# by default we should be in the correct project dir, but when run from Finder on Mac, the cwd is wrong +if [ "$(uname)" = "Darwin" ] && [ "$HOME" = "$PWD" ]; then + cd "$(dirname "$0")" +fi + +exec "$JAVACMD" "$@" diff --git a/gradlew.bat b/gradlew.bat new file mode 100644 index 0000000..e95643d --- /dev/null +++ b/gradlew.bat @@ -0,0 +1,84 @@ +@if "%DEBUG%" == "" @echo off +@rem ########################################################################## +@rem +@rem Gradle startup script for Windows +@rem +@rem ########################################################################## + +@rem Set local scope for the variables with windows NT shell +if "%OS%"=="Windows_NT" setlocal + +set DIRNAME=%~dp0 +if "%DIRNAME%" == "" set DIRNAME=. +set APP_BASE_NAME=%~n0 +set APP_HOME=%DIRNAME% + +@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +set DEFAULT_JVM_OPTS= + +@rem Find java.exe +if defined JAVA_HOME goto findJavaFromJavaHome + +set JAVA_EXE=java.exe +%JAVA_EXE% -version >NUL 2>&1 +if "%ERRORLEVEL%" == "0" goto init + +echo. +echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:findJavaFromJavaHome +set JAVA_HOME=%JAVA_HOME:"=% +set JAVA_EXE=%JAVA_HOME%/bin/java.exe + +if exist "%JAVA_EXE%" goto init + +echo. +echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:init +@rem Get command-line arguments, handling Windows variants + +if not "%OS%" == "Windows_NT" goto win9xME_args + +:win9xME_args +@rem Slurp the command line arguments. +set CMD_LINE_ARGS= +set _SKIP=2 + +:win9xME_args_slurp +if "x%~1" == "x" goto execute + +set CMD_LINE_ARGS=%* + +:execute +@rem Setup the command line + +set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar + +@rem Execute Gradle +"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %CMD_LINE_ARGS% + +:end +@rem End local scope for the variables with windows NT shell +if "%ERRORLEVEL%"=="0" goto mainEnd + +:fail +rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of +rem the _cmd.exe /c_ return code! +if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1 +exit /b 1 + +:mainEnd +if "%OS%"=="Windows_NT" endlocal + +:omega diff --git a/settings.gradle b/settings.gradle new file mode 100644 index 0000000..7c8e3dc --- /dev/null +++ b/settings.gradle @@ -0,0 +1 @@ +rootProject.name = 'api' \ No newline at end of file diff --git a/src/main/java/io/mifos/core/api/annotation/ThrowsException.java b/src/main/java/io/mifos/core/api/annotation/ThrowsException.java new file mode 100644 index 0000000..bbd7f27 --- /dev/null +++ b/src/main/java/io/mifos/core/api/annotation/ThrowsException.java @@ -0,0 +1,34 @@ +/* + * Copyright 2017 The Mifos Initiative. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package io.mifos.core.api.annotation; + +import org.springframework.http.HttpStatus; + +import java.lang.annotation.ElementType; +import java.lang.annotation.Repeatable; +import java.lang.annotation.Retention; +import java.lang.annotation.RetentionPolicy; +import java.lang.annotation.Target; + +@Repeatable(value = ThrowsExceptions.class) +@Retention(RetentionPolicy.RUNTIME) +@Target(ElementType.METHOD) +public @interface ThrowsException { + + HttpStatus status(); + + Class<? extends RuntimeException> exception(); +} diff --git a/src/main/java/io/mifos/core/api/annotation/ThrowsExceptions.java b/src/main/java/io/mifos/core/api/annotation/ThrowsExceptions.java new file mode 100644 index 0000000..e4a64d1 --- /dev/null +++ b/src/main/java/io/mifos/core/api/annotation/ThrowsExceptions.java @@ -0,0 +1,31 @@ +/* + * Copyright 2017 The Mifos Initiative. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package io.mifos.core.api.annotation; + +import java.lang.annotation.ElementType; +import java.lang.annotation.Retention; +import java.lang.annotation.RetentionPolicy; +import java.lang.annotation.Target; + +/** + * @author Myrle Krantz + */ +@Retention(RetentionPolicy.RUNTIME) +@Target(ElementType.METHOD) +public @interface ThrowsExceptions { + + ThrowsException[] value(); +} diff --git a/src/main/java/io/mifos/core/api/config/ApiConfiguration.java b/src/main/java/io/mifos/core/api/config/ApiConfiguration.java new file mode 100644 index 0000000..12b74c2 --- /dev/null +++ b/src/main/java/io/mifos/core/api/config/ApiConfiguration.java @@ -0,0 +1,37 @@ +/* + * Copyright 2017 The Mifos Initiative. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package io.mifos.core.api.config; + +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; +import org.springframework.context.annotation.Bean; +import org.springframework.context.annotation.ComponentScan; +import org.springframework.context.annotation.Configuration; + +/** + * @author Myrle Krantz + */ +@Configuration +@ComponentScan({"io.mifos.core.api.util"}) +public class ApiConfiguration { + + public static final String LOGGER_NAME = "api-logger"; + + @Bean(name = LOGGER_NAME) + public Logger logger() { + return LoggerFactory.getLogger(LOGGER_NAME); + } +} diff --git a/src/main/java/io/mifos/core/api/config/EnableApiFactory.java b/src/main/java/io/mifos/core/api/config/EnableApiFactory.java new file mode 100644 index 0000000..3071995 --- /dev/null +++ b/src/main/java/io/mifos/core/api/config/EnableApiFactory.java @@ -0,0 +1,36 @@ +/* + * Copyright 2017 The Mifos Initiative. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package io.mifos.core.api.config; + +import org.springframework.context.annotation.Import; + +import java.lang.annotation.ElementType; +import java.lang.annotation.Inherited; +import java.lang.annotation.Retention; +import java.lang.annotation.RetentionPolicy; +import java.lang.annotation.Target; + +/** + * @author Myrle Krantz + */ +@SuppressWarnings("unused") +@Target({ElementType.TYPE}) +@Retention(RetentionPolicy.RUNTIME) +@Inherited +@Import({ApiConfiguration.class}) +public @interface EnableApiFactory { + +} diff --git a/src/main/java/io/mifos/core/api/context/AutoGuest.java b/src/main/java/io/mifos/core/api/context/AutoGuest.java new file mode 100644 index 0000000..6c0b122 --- /dev/null +++ b/src/main/java/io/mifos/core/api/context/AutoGuest.java @@ -0,0 +1,26 @@ +/* + * Copyright 2017 The Mifos Initiative. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package io.mifos.core.api.context; + +/** + * @author Myrle Krantz + */ +@SuppressWarnings("unused") +public class AutoGuest extends AutoUserContext { + public AutoGuest() { + super("guest", "N/A"); + } +} diff --git a/src/main/java/io/mifos/core/api/context/AutoSeshat.java b/src/main/java/io/mifos/core/api/context/AutoSeshat.java new file mode 100644 index 0000000..bfe5d4a --- /dev/null +++ b/src/main/java/io/mifos/core/api/context/AutoSeshat.java @@ -0,0 +1,28 @@ +/* + * Copyright 2017 The Mifos Initiative. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package io.mifos.core.api.context; + +import io.mifos.core.api.util.ApiConstants; + +/** + * @author Myrle Krantz + */ +@SuppressWarnings({"WeakerAccess", "unused"}) +public class AutoSeshat extends AutoUserContext{ + public AutoSeshat(String token) { + super(ApiConstants.SYSTEM_SU, token); + } +} diff --git a/src/main/java/io/mifos/core/api/context/AutoUserContext.java b/src/main/java/io/mifos/core/api/context/AutoUserContext.java new file mode 100644 index 0000000..4caef7f --- /dev/null +++ b/src/main/java/io/mifos/core/api/context/AutoUserContext.java @@ -0,0 +1,40 @@ +/* + * Copyright 2017 The Mifos Initiative. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package io.mifos.core.api.context; + +import io.mifos.core.api.util.UserContext; +import io.mifos.core.api.util.UserContextHolder; + +import java.util.Optional; + +/** + * @author Myrle Krantz + */ +@SuppressWarnings({"OptionalUsedAsFieldOrParameterType", "WeakerAccess"}) +public class AutoUserContext implements AutoCloseable { + private final Optional<UserContext> previousUserContext; + + public AutoUserContext(final String userName, final String accessToken) { + previousUserContext = UserContextHolder.getUserContext(); + + UserContextHolder.setAccessToken(userName, accessToken); + } + + @Override public void close() { + UserContextHolder.clear(); + previousUserContext.ifPresent(UserContextHolder::setUserContext); + } +} \ No newline at end of file diff --git a/src/main/java/io/mifos/core/api/util/AnnotatedErrorDecoder.java b/src/main/java/io/mifos/core/api/util/AnnotatedErrorDecoder.java new file mode 100644 index 0000000..cb6f0d5 --- /dev/null +++ b/src/main/java/io/mifos/core/api/util/AnnotatedErrorDecoder.java @@ -0,0 +1,136 @@ +/* + * Copyright 2017 The Mifos Initiative. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package io.mifos.core.api.util; + +import feign.Feign; +import feign.FeignException; +import feign.Response; +import feign.codec.ErrorDecoder; +import io.mifos.core.api.annotation.ThrowsException; +import io.mifos.core.api.annotation.ThrowsExceptions; +import org.slf4j.Logger; +import org.springframework.http.HttpStatus; + +import java.lang.reflect.Constructor; +import java.lang.reflect.InvocationTargetException; +import java.lang.reflect.Method; +import java.util.Arrays; +import java.util.Optional; + +/** + * @author Myrle Krantz + */ +class AnnotatedErrorDecoder implements ErrorDecoder { + + private final Class feignClientClass; + private final Logger logger; + + AnnotatedErrorDecoder(final Logger logger, final Class feignClientClass) { + this.logger = logger; + this.feignClientClass = feignClientClass; + } + + @Override + public Exception decode( + final String methodKey, + final Response response) { + final Optional<Optional<Optional<Exception>>> ret = + Arrays.stream(feignClientClass.getMethods()) + .filter(method -> Feign.configKey(feignClientClass, method).equals(methodKey)) + .map(method -> { + final Optional<ThrowsException> annotation = getMatchingAnnotation(response, method); + return annotation.map(a -> constructException(response, a)); + }) + .findAny(); + + return unwrapEmbeddedOptional(ret, getAlternative(methodKey, response)); + } + + private RuntimeException getAlternative(final String methodKey, final Response response) { + if (response.status() == HttpStatus.BAD_REQUEST.value()) { + return new IllegalArgumentException(response.reason()); + } else if (response.status() == HttpStatus.FORBIDDEN.value()) { + return new InvalidTokenException(response.reason()); + } else if (response.status() == HttpStatus.NOT_FOUND.value()) { + return new NotFoundException(); + } else if (response.status() == HttpStatus.INTERNAL_SERVER_ERROR.value()) { + return new InternalServerError(response.reason()); + } else { + return FeignException.errorStatus(methodKey, response); + } + } + + private Optional<ThrowsException> getMatchingAnnotation( + final Response response, + final Method method) { + + final ThrowsExceptions throwsExceptionsAnnotation = + method.getAnnotation(ThrowsExceptions.class); + if (throwsExceptionsAnnotation == null) { + final ThrowsException throwsExceptionAnnotation = + method.getAnnotation(ThrowsException.class); + if ((throwsExceptionAnnotation != null) && + statusMatches(response, throwsExceptionAnnotation)) { + return Optional.of(throwsExceptionAnnotation); + } + } else { + return Arrays.stream(throwsExceptionsAnnotation.value()) + .filter(throwsExceptionAnnotation -> statusMatches(response, + throwsExceptionAnnotation)) + .findAny(); + } + + return Optional.empty(); + } + + private boolean statusMatches(final Response response, + final ThrowsException throwsExceptionAnnotation) { + return throwsExceptionAnnotation.status().value() == response.status(); + } + + @SuppressWarnings("OptionalUsedAsFieldOrParameterType") + private <T> T unwrapEmbeddedOptional( + final Optional<Optional<Optional<T>>> embeddedOptional, T alternative) { + return embeddedOptional.orElse(Optional.empty()).orElse(Optional.empty()).orElse(alternative); + } + + private Optional<Exception> constructException( + final Response response, + final ThrowsException throwsExceptionAnnotations) { + try { + try { + final Constructor<? extends RuntimeException> oneArgumentConstructor = + throwsExceptionAnnotations.exception().getConstructor(Response.class); + + return Optional.of(oneArgumentConstructor.newInstance(response)); + } catch (final NoSuchMethodException e) { + + final Constructor<? extends RuntimeException> noArgumentConstructor = + throwsExceptionAnnotations.exception().getConstructor(); + + return Optional.of(noArgumentConstructor.newInstance()); + } + } catch (final InvocationTargetException + | IllegalAccessException + | InstantiationException + | NoSuchMethodException e) { + logger.error("Instantiating exception {}, in for status {} failed with an exception", + throwsExceptionAnnotations.exception(), throwsExceptionAnnotations.status(), e); + + return Optional.empty(); + } + } +} diff --git a/src/main/java/io/mifos/core/api/util/ApiConstants.java b/src/main/java/io/mifos/core/api/util/ApiConstants.java new file mode 100644 index 0000000..aa9cb79 --- /dev/null +++ b/src/main/java/io/mifos/core/api/util/ApiConstants.java @@ -0,0 +1,27 @@ +/* + * Copyright 2017 The Mifos Initiative. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package io.mifos.core.api.util; + +/** + * @author Myrle Krantz + */ +@SuppressWarnings("WeakerAccess") +public interface ApiConstants { + + String AUTHORIZATION_HEADER = "Authorization"; + String USER_HEADER = "User"; + String SYSTEM_SU = "wepemnefret"; +} diff --git a/src/main/java/io/mifos/core/api/util/ApiFactory.java b/src/main/java/io/mifos/core/api/util/ApiFactory.java new file mode 100644 index 0000000..aa8a7bf --- /dev/null +++ b/src/main/java/io/mifos/core/api/util/ApiFactory.java @@ -0,0 +1,55 @@ +/* + * Copyright 2017 The Mifos Initiative. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package io.mifos.core.api.util; + +import feign.Feign; +import feign.gson.GsonDecoder; +import feign.gson.GsonEncoder; +import io.mifos.core.api.config.ApiConfiguration; +import org.slf4j.Logger; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.beans.factory.annotation.Qualifier; +import org.springframework.cloud.netflix.feign.support.SpringMvcContract; +import org.springframework.stereotype.Component; + +/** + * @author Myrle Krantz + */ +@SuppressWarnings("unused") +@Component +public class ApiFactory { + + private final Logger logger; + + @Autowired + public ApiFactory(@Qualifier(ApiConfiguration.LOGGER_NAME) final Logger logger) { + this.logger = logger; + } + + public <T> T create(final Class<T> clazz, final String target) { + final CookieInterceptingClient client = new CookieInterceptingClient(target); + return Feign.builder() + .contract(new SpringMvcContract()) + .client(client) + .errorDecoder(new AnnotatedErrorDecoder(logger, clazz)) + .requestInterceptor(new TenantedTargetInterceptor()) + .requestInterceptor(new TokenedTargetInterceptor()) + .requestInterceptor(client.getCookieInterceptor()) + .decoder(new GsonDecoder()) + .encoder(new GsonEncoder()) + .target(clazz, target); + } +} diff --git a/src/main/java/io/mifos/core/api/util/CookieInterceptingClient.java b/src/main/java/io/mifos/core/api/util/CookieInterceptingClient.java new file mode 100644 index 0000000..98ef622 --- /dev/null +++ b/src/main/java/io/mifos/core/api/util/CookieInterceptingClient.java @@ -0,0 +1,92 @@ +/* + * Copyright 2017 The Mifos Initiative. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package io.mifos.core.api.util; + +import feign.*; + +import java.io.IOException; +import java.net.CookieManager; +import java.net.URI; +import java.util.*; +import java.util.stream.Collectors; + +/** + * Keeps the cookies for this client and appends them to requests. + * See also CookieInterceptor. + * + * @author Myrle Krantz + */ +class CookieInterceptingClient extends Client.Default { + final CookieManager cookieManager; + private final String target; + + CookieInterceptingClient(final String target) { + this(target, new CookieManager()); + } + + CookieInterceptingClient(final String target, final CookieManager cookieManager) + { + super(null, null); + this.cookieManager = cookieManager; + this.target = target; + } + + RequestInterceptor getCookieInterceptor() { + return new CookieInterceptor(); + } + + private class CookieInterceptor implements RequestInterceptor { + @Override + public void apply(final RequestTemplate template) { + try { + final Map<String, List<String>> cookieHeaders = + cookieManager.get(mapUriType(target + template.url()), mapHeadersType(template.headers())); + cookieHeaders.entrySet().forEach(entry -> template.header(entry.getKey(), entry.getValue())); + } catch (final IOException e) { + throw new IllegalStateException("Mapping cookies failed unexpectedly."); + } + } + } + + /** + * Seam for testing + */ + Response superExecute(final Request request, final Request.Options options) throws IOException { + return super.execute(request, options); + } + + @Override + public Response execute(final Request request, final Request.Options options) throws IOException { + final Response ret = superExecute(request, options); + cookieManager.put(mapUriType(request.url()), mapHeadersType(ret.headers())); + return ret; + } + + private static URI mapUriType(final String url) { + return URI.create(url); + } + + private static Map<String, List<String>> mapHeadersType(final Map<String, Collection<String>> headers) { + final HashMap<String, List<String>> ret = new HashMap<>(); + headers.entrySet().forEach(entry -> + ret.put(entry.getKey(), changeCollectionToList(entry.getValue()))); + return ret; + } + + private static List<String> changeCollectionToList(final Collection<String> value) { + return value.stream().collect(Collectors.toList()); + } +} \ No newline at end of file diff --git a/src/main/java/io/mifos/core/api/util/CustomFeignClientsConfiguration.java b/src/main/java/io/mifos/core/api/util/CustomFeignClientsConfiguration.java new file mode 100644 index 0000000..9fa905d --- /dev/null +++ b/src/main/java/io/mifos/core/api/util/CustomFeignClientsConfiguration.java @@ -0,0 +1,90 @@ +/* + * Copyright 2017 The Mifos Initiative. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package io.mifos.core.api.util; + +import feign.Feign; +import feign.Target; +import feign.codec.Decoder; +import feign.codec.Encoder; +import feign.gson.GsonDecoder; +import feign.gson.GsonEncoder; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; +import org.springframework.beans.factory.annotation.Qualifier; +import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean; +import org.springframework.cloud.netflix.feign.FeignClientsConfiguration; +import org.springframework.context.annotation.Bean; +import org.springframework.context.annotation.Scope; + +import static io.mifos.core.api.config.ApiConfiguration.LOGGER_NAME; + +/** + * @author Myrle Krantz + */ +//@EnableApiFactory (for logger) +@SuppressWarnings({"unused"}) +public class CustomFeignClientsConfiguration extends FeignClientsConfiguration { + private static class AnnotatedErrorDecoderFeignBuilder extends Feign.Builder { + private final Logger logger; + + AnnotatedErrorDecoderFeignBuilder(final Logger logger) { + this.logger = logger; + } + + public <T> T target(Target<T> target) { + this.errorDecoder(new AnnotatedErrorDecoder(logger, target.type())); + return build().newInstance(target); + } + } + + @Bean + @ConditionalOnMissingBean + public TenantedTargetInterceptor tenantedTargetInterceptor() + { + return new TenantedTargetInterceptor(); + } + + @Bean + @ConditionalOnMissingBean + public TokenedTargetInterceptor tokenedTargetInterceptor() + { + return new TokenedTargetInterceptor(); + } + + @Bean + @ConditionalOnMissingBean + public Decoder feignDecoder() { + return new GsonDecoder(); + } + + @Bean + @ConditionalOnMissingBean + public Encoder feignEncoder() { + return new GsonEncoder(); + } + + @Bean(name = LOGGER_NAME) + public Logger logger() { + return LoggerFactory.getLogger(LOGGER_NAME); + } + + @Bean + @Scope("prototype") + @ConditionalOnMissingBean + public Feign.Builder feignBuilder(@Qualifier(LOGGER_NAME) final Logger logger) { + return new AnnotatedErrorDecoderFeignBuilder(logger); + } +} \ No newline at end of file diff --git a/src/main/java/io/mifos/core/api/util/InternalServerError.java b/src/main/java/io/mifos/core/api/util/InternalServerError.java new file mode 100644 index 0000000..037d2ff --- /dev/null +++ b/src/main/java/io/mifos/core/api/util/InternalServerError.java @@ -0,0 +1,27 @@ +/* + * Copyright 2017 The Mifos Initiative. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package io.mifos.core.api.util; + +/** + * @author Myrle Krantz + */ +@SuppressWarnings("WeakerAccess") +public class InternalServerError extends RuntimeException { + + InternalServerError(final String reason) { + super(reason); + } +} diff --git a/src/main/java/io/mifos/core/api/util/InvalidTokenException.java b/src/main/java/io/mifos/core/api/util/InvalidTokenException.java new file mode 100644 index 0000000..d6916ba --- /dev/null +++ b/src/main/java/io/mifos/core/api/util/InvalidTokenException.java @@ -0,0 +1,27 @@ +/* + * Copyright 2017 The Mifos Initiative. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package io.mifos.core.api.util; + +/** + * @author Myrle Krantz + */ +@SuppressWarnings("WeakerAccess") +public class InvalidTokenException extends RuntimeException { + + public InvalidTokenException(final String reason) { + super(reason); + } +} diff --git a/src/main/java/io/mifos/core/api/util/NotFoundException.java b/src/main/java/io/mifos/core/api/util/NotFoundException.java new file mode 100644 index 0000000..9649cd5 --- /dev/null +++ b/src/main/java/io/mifos/core/api/util/NotFoundException.java @@ -0,0 +1,24 @@ +/* + * Copyright 2017 The Mifos Initiative. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package io.mifos.core.api.util; + +/** + * @author Myrle Krantz + */ +@SuppressWarnings("WeakerAccess") +public class NotFoundException extends RuntimeException { + +} diff --git a/src/main/java/io/mifos/core/api/util/TenantedTargetInterceptor.java b/src/main/java/io/mifos/core/api/util/TenantedTargetInterceptor.java new file mode 100644 index 0000000..e820d1e --- /dev/null +++ b/src/main/java/io/mifos/core/api/util/TenantedTargetInterceptor.java @@ -0,0 +1,36 @@ +/* + * Copyright 2017 The Mifos Initiative. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package io.mifos.core.api.util; + +import feign.RequestInterceptor; +import feign.RequestTemplate; +import io.mifos.core.lang.TenantContextHolder; + +import static io.mifos.core.lang.config.TenantHeaderFilter.TENANT_HEADER; + + +/** + * @author Myrle Krantz + */ +@SuppressWarnings("WeakerAccess") +public class TenantedTargetInterceptor implements RequestInterceptor { + + @Override + public void apply(final RequestTemplate template) { + TenantContextHolder.identifier() + .ifPresent(tenantIdentifier -> template.header(TENANT_HEADER, tenantIdentifier)); + } +} diff --git a/src/main/java/io/mifos/core/api/util/TokenedTargetInterceptor.java b/src/main/java/io/mifos/core/api/util/TokenedTargetInterceptor.java new file mode 100644 index 0000000..6e9a226 --- /dev/null +++ b/src/main/java/io/mifos/core/api/util/TokenedTargetInterceptor.java @@ -0,0 +1,36 @@ +/* + * Copyright 2017 The Mifos Initiative. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package io.mifos.core.api.util; + +import feign.RequestInterceptor; +import feign.RequestTemplate; + +/** + * @author Myrle Krantz + */ +@SuppressWarnings("WeakerAccess") +public class TokenedTargetInterceptor implements RequestInterceptor { + + @Override + public void apply(final RequestTemplate template) { + UserContextHolder.getUserContext() + .map(UserContext::getAccessToken) + .ifPresent(token -> template.header(ApiConstants.AUTHORIZATION_HEADER, token)); + UserContextHolder.getUserContext() + .map(UserContext::getUser) + .ifPresent(user -> template.header(ApiConstants.USER_HEADER, user)); + } +} diff --git a/src/main/java/io/mifos/core/api/util/UserContext.java b/src/main/java/io/mifos/core/api/util/UserContext.java new file mode 100644 index 0000000..0a98719 --- /dev/null +++ b/src/main/java/io/mifos/core/api/util/UserContext.java @@ -0,0 +1,56 @@ +/* + * Copyright 2017 The Mifos Initiative. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package io.mifos.core.api.util; + +import javax.annotation.Nonnull; +import java.util.Objects; + +/** + * @author Myrle Krantz + */ +public class UserContext { + private final String user; + private final String accessToken; + + UserContext(@Nonnull String user, @Nonnull String accessToken) { + this.user = user; + this.accessToken = accessToken; + } + + @SuppressWarnings("WeakerAccess") + @Nonnull public String getUser() { + return user; + } + + @SuppressWarnings("WeakerAccess") + @Nonnull public String getAccessToken() { + return accessToken; + } + + @Override + public boolean equals(Object o) { + if (this == o) return true; + if (o == null || getClass() != o.getClass()) return false; + UserContext that = (UserContext) o; + return Objects.equals(user, that.user) && + Objects.equals(accessToken, that.accessToken); + } + + @Override + public int hashCode() { + return Objects.hash(user, accessToken); + } +} diff --git a/src/main/java/io/mifos/core/api/util/UserContextHolder.java b/src/main/java/io/mifos/core/api/util/UserContextHolder.java new file mode 100644 index 0000000..8991d3c --- /dev/null +++ b/src/main/java/io/mifos/core/api/util/UserContextHolder.java @@ -0,0 +1,75 @@ +/* + * Copyright 2017 The Mifos Initiative. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package io.mifos.core.api.util; + +import org.springframework.util.Assert; + +import javax.annotation.Nonnull; +import java.util.Optional; + +/** + * @author Myrle Krantz + */ +@SuppressWarnings({"WeakerAccess", "unused"}) +public class UserContextHolder { + + private static final InheritableThreadLocal<UserContext> THREAD_LOCAL = new InheritableThreadLocal<>(); + + private UserContextHolder() { + } + + @Nonnull + public static String checkedGetAccessToken() { + return Optional.ofNullable(UserContextHolder.THREAD_LOCAL.get()) + .map(UserContext::getAccessToken) + .orElseThrow(IllegalStateException::new); + } + + @Nonnull + public static String checkedGetUser() { + return Optional.ofNullable(UserContextHolder.THREAD_LOCAL.get()) + .map(UserContext::getUser) + .map(UserContextHolder::cropIdentifier) + .orElseThrow(IllegalStateException::new); + } + + private static String cropIdentifier(final String identifier) { + if (identifier.length() > 32) + return identifier.substring(0, 32); + else + return identifier; + } + + @Nonnull + public static Optional<UserContext> getUserContext() { + return Optional.ofNullable(UserContextHolder.THREAD_LOCAL.get()); + } + + public static void setAccessToken(@Nonnull final String user, @Nonnull final String accessToken) { + Assert.notNull(user, "User may not be null."); + Assert.notNull(accessToken, "Access token may not be null."); + UserContextHolder.THREAD_LOCAL.set(new UserContext(user, accessToken)); + } + + public static void setUserContext(@Nonnull final UserContext userContext) + { + UserContextHolder.THREAD_LOCAL.set(userContext); + } + + public static void clear() { + UserContextHolder.THREAD_LOCAL.remove(); + } +} diff --git a/src/test/java/io/mifos/core/api/context/AutoUserContextTest.java b/src/test/java/io/mifos/core/api/context/AutoUserContextTest.java new file mode 100644 index 0000000..df0d8e8 --- /dev/null +++ b/src/test/java/io/mifos/core/api/context/AutoUserContextTest.java @@ -0,0 +1,46 @@ +/* + * Copyright 2017 The Mifos Initiative. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package io.mifos.core.api.context; + +import io.mifos.core.api.util.UserContextHolder; +import org.junit.Assert; +import org.junit.Test; + +import java.util.Optional; + +/** + * @author Myrle Krantz + */ +public class AutoUserContextTest { + @Test + public void stateIsUndisturbedOutsideOfTryBlock() + { + UserContextHolder.setAccessToken("x", "y"); + + //noinspection EmptyTryBlock + try (final AutoUserContext ignored = new AutoUserContext("m", "n")) + { + Assert.assertEquals(UserContextHolder.checkedGetUser(), "m"); + Assert.assertEquals(UserContextHolder.checkedGetAccessToken(), "n"); + } + + Assert.assertEquals(UserContextHolder.checkedGetUser(), "x"); + Assert.assertEquals(UserContextHolder.checkedGetAccessToken(), "y"); + + UserContextHolder.clear(); + } + +} \ No newline at end of file diff --git a/src/test/java/io/mifos/core/api/util/AnnotatedErrorDecoderTest.java b/src/test/java/io/mifos/core/api/util/AnnotatedErrorDecoderTest.java new file mode 100644 index 0000000..7dc1104 --- /dev/null +++ b/src/test/java/io/mifos/core/api/util/AnnotatedErrorDecoderTest.java @@ -0,0 +1,281 @@ +/* + * Copyright 2017 The Mifos Initiative. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package io.mifos.core.api.util; + +import feign.Feign; +import feign.FeignException; +import feign.Response; +import io.mifos.core.api.annotation.ThrowsException; +import org.junit.Assert; +import org.junit.Test; +import org.junit.runner.RunWith; +import org.junit.runners.Parameterized; +import org.slf4j.LoggerFactory; +import org.springframework.http.HttpStatus; + +import java.util.ArrayList; +import java.util.Collection; +import java.util.Collections; + +/** + * @author Myrle Krantz + */ +@RunWith(Parameterized.class) +public class AnnotatedErrorDecoderTest { + + private final TestCase testCase; + + public AnnotatedErrorDecoderTest(final TestCase testCase) { + this.testCase = testCase; + } + + @Parameterized.Parameters + public static Collection testCases() throws NoSuchMethodException { + final Collection<TestCase> ret = new ArrayList<>(); + + final Response emptyInternalServerErrorResponse = Response.builder() + .status(HttpStatus.INTERNAL_SERVER_ERROR.value()) + .reason("blah") + .headers(Collections.emptyMap()) + .build(); + + final Response emptyBadRequestResponse = Response.builder() + .status(HttpStatus.BAD_REQUEST.value()) + .reason("blah") + .headers(Collections.emptyMap()) + .build(); + + final Response emptyConflictResponse = Response.builder() + .status(HttpStatus.CONFLICT.value()) + .reason("blah") + .headers(Collections.emptyMap()) + .build(); + + final Response emptyIAmATeapotResponse = Response.builder() + .status(HttpStatus.I_AM_A_TEAPOT.value()) + .reason("blah") + .headers(Collections.emptyMap()) + .build(); + + final Response emptyUnauthorizedResponse = Response.builder() + .status(HttpStatus.UNAUTHORIZED.value()) + .reason("blah") + .headers(Collections.emptyMap()) + .build(); + + final Response emptyForbiddenResponse = Response.builder() + .status(HttpStatus.FORBIDDEN.value()) + .reason("blah") + .headers(Collections.emptyMap()) + .build(); + + final String madeUpMethodKey = "x"; + + final String annotationlessMethodKey = + Feign.configKey(AnnotationlessInterface.class, AnnotationlessInterface.class.getMethod("method")); + + final String oneAnnotatedMethodKey = + Feign.configKey(OneMethodInterface.class, OneMethodInterface.class.getMethod("method")); + + final String onceAnnotatedMethodKey = + Feign.configKey(OneMethodOneAnnotationInterface.class, OneMethodOneAnnotationInterface.class.getMethod("method")); + + ret.add(new TestCase("Methodless interface") + .clazz(MethodlessInterface.class) + .methodKey(madeUpMethodKey) + .response(emptyConflictResponse) + .expectedResult(FeignException.errorStatus(madeUpMethodKey, emptyConflictResponse))); + + ret.add(new TestCase("Annotationless interface") + .clazz(AnnotationlessInterface.class) + .methodKey(annotationlessMethodKey) + .response(emptyConflictResponse) + .expectedResult(FeignException.errorStatus(annotationlessMethodKey, emptyConflictResponse))); + + ret.add(new TestCase("Interface with one method mapped to parameterless exception") + .clazz(OneMethodInterface.class) + .methodKey(oneAnnotatedMethodKey) + .response(emptyBadRequestResponse) + .expectedResult(new ParameterlessException())); + + ret.add(new TestCase("Interface with one method mapped to parametered exception") + .clazz(OneMethodInterface.class) + .methodKey(oneAnnotatedMethodKey) + .response(emptyConflictResponse) + .expectedResult(new ParameteredException(emptyConflictResponse))); + + ret.add(new TestCase("Interface with one method mapped to an exception which can't be constructed by reflection") + .clazz(OneMethodInterface.class) + .methodKey(oneAnnotatedMethodKey) + .response(emptyIAmATeapotResponse) + .expectedResult(FeignException.errorStatus(oneAnnotatedMethodKey, emptyIAmATeapotResponse))); + + ret.add(new TestCase("Interface with one method, not mapped to the response code returned") + .clazz(OneMethodInterface.class) + .methodKey(oneAnnotatedMethodKey) + .response(emptyUnauthorizedResponse) + .expectedResult(FeignException.errorStatus(oneAnnotatedMethodKey, emptyUnauthorizedResponse))); + + ret.add(new TestCase("Interface with one method that has one annotation") + .clazz(OneMethodOneAnnotationInterface.class) + .methodKey(onceAnnotatedMethodKey) + .response(emptyBadRequestResponse) + .expectedResult(new ParameterlessException())); + + ret.add(new TestCase("Bad request on an interface in which bad request isn't mapped.") + .clazz(AnnotationlessInterface.class) + .methodKey(annotationlessMethodKey) + .response(emptyBadRequestResponse) + .expectedResult(new IllegalArgumentException("blah"))); + + ret.add(new TestCase("Request with invalid token.") + .clazz(OneMethodOneAnnotationInterface.class) + .methodKey(onceAnnotatedMethodKey) + .response(emptyForbiddenResponse) + .expectedResult(new InvalidTokenException("blah"))); + + ret.add(new TestCase("Internal Server Error on an interface in which internal server error isn't mapped.") + .clazz(AnnotationlessInterface.class) + .methodKey(annotationlessMethodKey) + .response(emptyInternalServerErrorResponse) + .expectedResult(new InternalServerError("blah"))); + + return ret; + } + + @SuppressWarnings("ThrowableResultOfMethodCallIgnored") + @Test + public void checkMapping() { + + final AnnotatedErrorDecoder testSubject = new AnnotatedErrorDecoder( + LoggerFactory.getLogger(AnnotatedErrorDecoderTest.class.getName()), testCase.getClazz()); + + final Exception result = testSubject.decode(testCase.getMethodKey(), testCase.getResponse()); + + Assert.assertEquals("Test case \"" + testCase.getName() + "\" failed.", + testCase.expectedResult().getClass(), result.getClass()); + + Assert.assertEquals("Test case \"" + testCase.getName() + "\" failed.", + testCase.expectedResult().getMessage(), result.getMessage()); + } + + private interface MethodlessInterface { + + } + + private interface AnnotationlessInterface { + + @SuppressWarnings("unused") + void method(); + } + + private interface OneMethodInterface { + + @SuppressWarnings("unused") + @ThrowsException(status = HttpStatus.BAD_REQUEST, exception = ParameterlessException.class) + @ThrowsException(status = HttpStatus.CONFLICT, exception = ParameteredException.class) + @ThrowsException(status = HttpStatus.I_AM_A_TEAPOT, exception = WrongParameteredException.class) + void method(); + } + + + private interface OneMethodOneAnnotationInterface { + + @SuppressWarnings("unused") + @ThrowsException(status = HttpStatus.BAD_REQUEST, exception = ParameterlessException.class) + void method(); + } + + private static class TestCase { + + private final String name; + private Class clazz; + private String methodKey; + private Response response; + private Exception expectedResult; + + private TestCase(final String name) { + this.name = name; + } + + public String toString() { + return name; + } + + TestCase clazz(final Class newVal) { + clazz = newVal; + return this; + } + + TestCase methodKey(final String newVal) { + methodKey = newVal; + return this; + } + + TestCase response(final Response newVal) { + response = newVal; + return this; + } + + TestCase expectedResult(final Exception newVal) { + expectedResult = newVal; + return this; + } + + Class getClazz() { + return clazz; + } + + String getMethodKey() { + return methodKey; + } + + Response getResponse() { + return response; + } + + Exception expectedResult() { + return expectedResult; + } + + String getName() { + return name; + } + } + + private static class ParameterlessException extends RuntimeException { + + @SuppressWarnings("WeakerAccess") + public ParameterlessException() { + super("I am a parameterless exception. Aren't I cool."); + } + } + + private static class ParameteredException extends RuntimeException { + + @SuppressWarnings("WeakerAccess") + public ParameteredException(final Response response) { + super("I am a parametered exception with a response of " + response.toString()); + } + } + + private static class WrongParameteredException extends RuntimeException { + + public WrongParameteredException(final String message) { + super(message); + } + } +} diff --git a/src/test/java/io/mifos/core/api/util/CookieInterceptingClientTest.java b/src/test/java/io/mifos/core/api/util/CookieInterceptingClientTest.java new file mode 100644 index 0000000..9d9cb33 --- /dev/null +++ b/src/test/java/io/mifos/core/api/util/CookieInterceptingClientTest.java @@ -0,0 +1,81 @@ +/* + * Copyright 2017 The Mifos Initiative. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package io.mifos.core.api.util; + +import feign.Request; +import feign.RequestTemplate; +import feign.Response; +import org.junit.Assert; +import org.junit.Test; +import org.mockito.Mockito; +import org.springframework.http.HttpStatus; + +import java.io.IOException; +import java.net.CookieManager; +import java.net.URI; +import java.net.URISyntaxException; +import java.nio.charset.Charset; +import java.util.*; + +/** + * @author Myrle Krantz + */ +public class CookieInterceptingClientTest { + private final static String TEST_URL = "http://igle.pop.org/app/v1/";; + + @Test + public void cookiesPlacedInJarThenAttachedToRequest() throws IOException, URISyntaxException { + final CookieInterceptingClient testSubject = new CookieInterceptingClient(TEST_URL); + + //response + final CookieInterceptingClient spiedTestSubject = Mockito.spy(testSubject); + + final Map<String, Collection<String>> cookieHeaders = new HashMap<>(); + cookieHeaders.put("Set-Cookie", Collections.singleton("x=y;Path=/app/v1")); + final Response dummyResponse = Response.builder() + .status(HttpStatus.INTERNAL_SERVER_ERROR.value()) + .reason("blah") + .headers(cookieHeaders) + .build(); + + Mockito.doReturn(dummyResponse).when(spiedTestSubject).superExecute(Mockito.anyObject(), Mockito.anyObject()); + + spiedTestSubject.execute(Request.create("", TEST_URL +"request", Collections.emptyMap(), new byte[]{}, Charset.defaultCharset()), new Request.Options()); + + final Map<String, List<String>> ret = testSubject.cookieManager.get(new URI(TEST_URL), Collections.emptyMap()); + Assert.assertEquals(ret.get("Cookie"), Collections.singletonList("x=y")); + + //request + final RequestTemplate dummyRequestTemplate = new RequestTemplate(); + dummyRequestTemplate.append("/request"); + testSubject.getCookieInterceptor().apply(dummyRequestTemplate); + Assert.assertEquals(dummyRequestTemplate.headers().get("Cookie"), Collections.singletonList("x=y")); + } + + @Test(expected = IllegalStateException.class) + public void unexpectedCookieManagerFailure() throws IOException { + final CookieManager cookieManagerMock = Mockito.mock(CookieManager.class); + //noinspection unchecked + Mockito.when(cookieManagerMock.get(Mockito.anyObject(), Mockito.anyObject())).thenThrow(IOException.class); + + final CookieInterceptingClient testSubject = new CookieInterceptingClient(TEST_URL, cookieManagerMock); + + final RequestTemplate dummyRequestTemplate = new RequestTemplate(); + dummyRequestTemplate.append("/request"); + + testSubject.getCookieInterceptor().apply(dummyRequestTemplate); + } +} \ No newline at end of file diff --git a/src/test/java/io/mifos/core/api/util/TenantedTargetInterceptorTest.java b/src/test/java/io/mifos/core/api/util/TenantedTargetInterceptorTest.java new file mode 100644 index 0000000..5b5f8a3 --- /dev/null +++ b/src/test/java/io/mifos/core/api/util/TenantedTargetInterceptorTest.java @@ -0,0 +1,43 @@ +/* + * Copyright 2017 The Mifos Initiative. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package io.mifos.core.api.util; + +import feign.RequestTemplate; +import io.mifos.core.lang.TenantContextHolder; +import org.junit.Assert; +import org.junit.Test; +import org.junit.runner.RunWith; +import org.junit.runners.BlockJUnit4ClassRunner; + +/** + * @author Myrle Krantz + */ +@RunWith(BlockJUnit4ClassRunner.class) +public class TenantedTargetInterceptorTest { + + @Test + public void test() { + final TenantedTargetInterceptor testSubject = new TenantedTargetInterceptor(); + + final RequestTemplate requestTemplate = new RequestTemplate(); + final String tenantId = "bleblablub"; + + TenantContextHolder.setIdentifier(tenantId); + testSubject.apply(requestTemplate); + + Assert.assertTrue(requestTemplate.headers().get("X-Tenant-Identifier").contains(tenantId)); + } +} diff --git a/src/test/java/io/mifos/core/api/util/TokenedTargetInterceptorTest.java b/src/test/java/io/mifos/core/api/util/TokenedTargetInterceptorTest.java new file mode 100644 index 0000000..582943d --- /dev/null +++ b/src/test/java/io/mifos/core/api/util/TokenedTargetInterceptorTest.java @@ -0,0 +1,42 @@ +/* + * Copyright 2017 The Mifos Initiative. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package io.mifos.core.api.util; + +import feign.RequestTemplate; +import io.mifos.core.api.context.AutoUserContext; +import org.junit.Assert; +import org.junit.Test; + + +/** + * @author Myrle Krantz + */ +public class TokenedTargetInterceptorTest { + + @Test + public void test() { + final TokenedTargetInterceptor testSubject = new TokenedTargetInterceptor(); + + final RequestTemplate requestTemplate = new RequestTemplate(); + + try (final AutoUserContext ignored = new AutoUserContext("x", "y")) { + testSubject.apply(requestTemplate); + } + + Assert.assertTrue(requestTemplate.headers().get(ApiConstants.USER_HEADER).contains("x")); + Assert.assertTrue(requestTemplate.headers().get(ApiConstants.AUTHORIZATION_HEADER).contains("y")); + } +} \ No newline at end of file diff --git a/src/test/java/io/mifos/core/api/util/UserContextHolderTest.java b/src/test/java/io/mifos/core/api/util/UserContextHolderTest.java new file mode 100644 index 0000000..a5365bd --- /dev/null +++ b/src/test/java/io/mifos/core/api/util/UserContextHolderTest.java @@ -0,0 +1,77 @@ +/* + * Copyright 2017 The Mifos Initiative. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package io.mifos.core.api.util; + +import org.apache.commons.lang.RandomStringUtils; +import org.junit.Assert; +import org.junit.Test; + +import java.util.Optional; + +/** + * @author Myrle Krantz + */ +public class UserContextHolderTest { + @Test + public void testUserIdentifierCropping() + { + final String userIdentifier16 = RandomStringUtils.randomAlphanumeric(16); + UserContextHolder.setAccessToken(userIdentifier16, "x"); + + Assert.assertEquals(UserContextHolder.checkedGetUser(), userIdentifier16); + + final String userIdentifier32 = RandomStringUtils.randomAlphanumeric(32); + UserContextHolder.setAccessToken(userIdentifier32, "x"); + + Assert.assertEquals(UserContextHolder.checkedGetUser(), userIdentifier32); + + final String userIdentifier64 = userIdentifier32 + userIdentifier32; + UserContextHolder.setAccessToken(userIdentifier64, "x"); + + Assert.assertEquals(UserContextHolder.checkedGetUser(), userIdentifier32); + } + + @Test(expected = IllegalStateException.class) + public void testUnsetUserIdentifier() + { + UserContextHolder.clear(); + UserContextHolder.checkedGetUser(); + } + + @Test(expected = IllegalStateException.class) + public void testUnsetAccessToken() + { + UserContextHolder.clear(); + UserContextHolder.checkedGetAccessToken(); + } + + @Test + public void testSimpleUnSetAndGet() + { + UserContextHolder.clear(); + final Optional<UserContext> userContext = UserContextHolder.getUserContext(); + Assert.assertTrue(!userContext.isPresent()); + } + + @Test + public void testSimpleSetAndGet() + { + final UserContext setUserContext = new UserContext("x", "y"); + UserContextHolder.clear(); + UserContextHolder.setUserContext(setUserContext); + UserContextHolder.getUserContext().ifPresent(x -> Assert.assertEquals(setUserContext, x)); + } +}
