Merge pull request #149 from pbozin/develop

Switch to using unique username instead of email

Author: pbozin

.gitignore

@@ -12,4 +12,4 @@
 target
 src/main/resources/
 src/test/resources/
-*.iml
+*.iml

CONTRIBUTING.md

@@ -0,0 +1,32 @@
+# Contributing
+
+
+## Hello!
+
+Thank you for your interest in contributing to the Open Bank Project!
+
+## Pull requests
+
+If submitting a pull request please read and sign our [CLA](http://github.com/OpenBankProject/OBP-API/blob/develop/Harmony_Individual_Contributor_Assignment_Agreement.txt) and send it to contact@tesobe.com - We'll send you back a code to include in the comment section of subsequent pull requests.
+
+Please reference Issue Numbers in your commits.
+
+## Code comments
+
+Please comment your code ! :-) Imagine an engineer is trying to fix a production issue: she is working on a tiny screen, via a dodgy mobile Internet connection, in a sandstorm - Your code is fresh in your mind. Your comments could help her!
+
+## Issues
+
+If would like to report an issue or suggest any kind of improvement please use Github Issues.
+
+## Licenses
+
+Open Bank Project API, API Explorer and Sofi are dual licenced under the AGPL and commercial licenses. Open Bank Project SDKs are licenced under Apache 2 or MIT style licences.
+
+Please see the NOTICE for each project licence.
+
+## Setup and Tests
+
+See the README for instructions on setup and running the tests :-)
+
+Welcome!

Harmony_Individual_Contributor_Assignment_Agreement.txt

@@ -82,23 +82,32 @@ TO THE MAXIMUM EXTENT PERMITTED BY APPLICABLE LAW, IN NO EVENT WILL YOU OR US BE
 
 
 
-You
 ________________________
-Name:	________________________
-Address:	________________________
-________________________
 
-Us
+You:
+
+
+Name: ________________________________
+
+Address: ________________________________
+
+Github username ________________________________
+
+Email / Phone	________________________________
+
+
 ________________________
-Name:	Simon Redfern
-Title:	CEO TESOBE / Music Pictures Ltd
-Address:	Osloerstrasse 16/17
- Berlin 13359, German
 
+Us:
 
+Name:	Simon Redfern
+Title:	CEO, TESOBE Ltd
+Address:	Osloerstrasse 16/17, Berlin 13359, Germany
 
 
 
+________________________
+
 
 [SUBMISSION_INSTRUCTIONS] – In person.
 
@@ -125,4 +134,4 @@ Address:	Osloerstrasse 16/17
 
 
 
-This work is licensed under a Creative Commons Attribution 3.0 Unported License.
+This work is licensed under a Creative Commons Attribution 3.0 Unported License.

NOTICE

@@ -1,5 +1,5 @@
-Open Bank Project - Transparency / Social Finance Web Application
-Copyright (C) 2011, 2012, TESOBE / Music Pictures Ltd
+Open Bank Project API
+Copyright (C) 2011-2016, TESOBE Ltd
 
 This program is free software: you can redistribute it and/or modify
 it under the terms of the GNU Affero General Public License as published by
@@ -15,14 +15,14 @@ You should have received a copy of the GNU Affero General Public License
 along with this program. If not, see <http://www.gnu.org/licenses/>.
 
 Email: contact@tesobe.com 
-TESOBE / Music Pictures Ltd 
+TESOBE Ltd
 Osloerstrasse 16/17
 Berlin 13359, Germany
 
  This product includes software developed at
  TESOBE (http://www.tesobe.com/)
 by 
-Simon Redfern : simon AT tesobe DOT com
-Stefan Bethge : stefan AT tesobe DOT com
-Everett Sochowski : everett AT tesobe DOT com
-Ayoub Benali: ayoub AT tesobe DOT com
+Simon Redfern
+Stefan Bethge
+Everett Sochowski
+Ayoub Benali

README.md

@@ -14,32 +14,131 @@ Our tag line is: Bank as a Platform. Transparency as an Asset.
 
 The API uses OAuth 1.0 authentication.
 
-The project roadmap is available [here.](https://trello.com/b/O9IjhPXB/open-bank-project-api) 
+The project roadmap is available [here.](https://openbankproject.com/roadmap/)
 
 ## DOCUMENTATION 
 
 Please refer to the [wiki](https://github.com/OpenBankProject/OBP-API/wiki) to see the API specification. 
 
 ## STATUS
 
-[V1.2] (https://github.com/OpenBankProject/OBP-API/wiki/REST-API-V1.2) is mostly implemented
+[V1.2.1] (https://github.com/OpenBankProject/OBP-API/wiki/REST-API-V1.2.1) is the current stable API.
 
 ## LICENSE
 
-This project is dual licensed under the AGPL V3 (see NOTICE) and a commercial license from TESOBE
-Some files (OAuth related) are licensed under the Apache 2 license.
+This project is dual licensed under the AGPL V3 (see NOTICE) and commercial licenses from TESOBE Ltd.
 
 ## SETUP
 
 The project uses Maven 3 as its build tool.
 
 To compile and run jetty, install Maven 3 and execute:
 
-mvn jetty:run
+./mvn.sh jetty:run
+
+## To run with IntelliJ IDEA
+
+* Make sure you have the IntelliJ Scala plugin installed.
+
+* Create a new folder e.g. OpenBankProject and cd there
+
+* git clone https://github.com/OpenBankProject/OBP-API.git
+
+* In IntelliJ IDEA do File -> New -> Project from existing sources
+
+* (Alternatively you can do File -> New -> Project from VCS and checkout from github)
+
+* When / if prompted, choose Java 1.8 and Scala 2.11 otherwise keep the defaults. Use the Maven options. Do not change the project name etc.
+
+* Navigate to test/scala/code/RunWebApp. You may see a Setup Scala SDK link. Click this and check Scala 2.11.8 or so.
+
+* In src/main/resources/props create a test.default.props for tests. Set connector=mapped
+
+* In src/main/resources/props create a <yourloginname>.default.props for development. Set connector=mapped
+
+* Now **Rebuild** the project so everything is compiled.
+
+* Run RunWebApp by right clicking on it or selecting Run. The built in jetty server should start on localhost:8080
+
+* Browse to localhost:8080 but don't try anything else there yet.
+
+### Run some tests.
+ 
+* Run a single test. For instance right click on test/scala/code/branches/MappedBranchProviderTest and select Run Mapp...
+
+* Run multiple tests: Right click on test/scala/code and select Run. If need be:
+ Goto Run / Debug configurations
+ Test Kind: Select All in Package
+ Package: Select code
+ Add the absolute /path-to-your-OBP-API in the "working directory" field
+ You might need to assign more memory via VM Options: e.g. -Xmx1512M -XX:MaxPermSize=512M
+ 
+ Make sure your test.default.props has the minimum settings (see test.default.props.template)
+
+ 
+ Right click test/scala/code and select the Scala Tests in code to run them all.
+ 
+ Note: You may want to disable some tests not relevant to your setup e.g.:
+ set bank_account_creation_listener=false in test.default.props 
+
+
+## Other ways to run tests
+
+* See pom.xml for test configuration
+* See http://www.scalatest.org/user_guide
+
+
+## From the command line
+
+Set memory options
+export MAVEN_OPTS="-Xmx3000m -XX:MaxPermSize=512m"
+
+Run one test
+mvn -DwildcardSuites=code.api.directloginTest test
+
 
 ----
 
-# Databases:
+## Ubuntu
+
+If you use Ubuntu (or a derivate) and encrypted home directories (e.g. you have ~/.Private), you might run into the following error when the project is built:
+
+ uncaught exception during compilation: java.io.IOException
+ [ERROR] File name too long
+ [ERROR] two errors found
+ [DEBUG] Compilation failed (CompilerInterface)
+
+The current workaround is to move the project directory onto a different partition, e.g. under /opt/ .
+
+
+## Databases:
+
+The default database for testing etc is H2. PostgreSQL is used for the sandboxes (user accounts, metadata, transaction cache).
+
+## Sandbox data
+
+To populate the OBP database with sandbox data:
+
+1) In your Props file, set allow_sandbox_data_import=true
+2) In your Props files, set sandbox_data_import_secret=YOUR-KEY-HERE
+3) Now you can POST the sandbox json found in src/main/scala/code/api/sandbox/example_data/example_import.json to /sandbox/v1.0/data-import?secret_token=YOUR-KEY-HERE
+4) If successful you should get 201 Created.
+
+
+## Kafka (optional):
+
+If Kafka connector is selected in props (connector=kafka), Kafka and Zookeeper have to be installed, as well as OBP-Kafka-Python (which can be either running from command-propmpt or from inside Docker container):
+
+* Kafka and Zookeeper can be installed using system's default installer or by unpacking the archives (http://apache.mirrors.spacedump.net/kafka/ and http://apache.mirrors.spacedump.net/zookeeper/)
+
+* OBP-Kafka-Python can be downloaded from https://github.com/OpenBankProject/OBP-Kafka-Python
+
+
+## Scala / Lift
+
+* We use scala and liftweb http://www.liftweb.net/
+
+* Advanced architecture: http://exploring.liftweb.net/master/index-9.html
 
-The default datastores used are MongoDB (metadata, transaction cache) and Postgres (user accounts).
+* A good book on Lift: "Lift in Action" by Timothy Perrett published by Manning.
 

mvn.sh

@@ -0,0 +1,7 @@
+#!/bin/sh
+
+# Deprecated option -XX:MaxPermSize=256m is kept
+# just in case someone still uses java 1.7
+export MAVEN_OPTS="-Xmx1024m -Xms1024m -Xss1024k -XX:MaxPermSize=256m"
+
+mvn $1 $2 $3 $4