Merge lp:~karni/ubuntu-sso-java-library/v2-initial-import into lp:~ubuntuone-client-engineering/ubuntu-sso-java-library/v2

[Michał Karnicki]

Initial import.

Initial import of new, robust code base setup. Ant build tool; dir-structure Maven ready.

How to test:
$ bzr branch lp:~karni/ubuntu-sso-java-library/v2-initial-import foo
$ cd foo
$ ant setup jar

[Mike McCracken (mikemc)]

A couple minor things:

The .project.template has the name as 'ubuntuone-sso' - should it be 'ubuntu-sso' like the LP project name?

README: same question about naming, should it be "ubuntu sso"?

README: line 81 of the diff typo: "Single Sing On"

build.xml: same project name question in a couple of places.
The package ID (is that the right name for it in java?) ends up being com.ubuntu.one.api.sso -- should that be com.ubuntu.sso.api or something?

In the python packages, the SSO stuff is a packaged named "ubuntu_sso" and the U1 specific stuff is named "ubuntuone.*" -- does a similar naming split make sense here?

review: Needs Information

[lp:~karni/ubuntu-sso-java-library/v2-initial-import]

2. By Michał Karnicki on 2012-12-18

Unzip jmock in ./lib/test.

3. By Michał Karnicki on 2012-12-18

Review fixes. Updated naming convention.

4. By Michał Karnicki on 2012-12-18

Fixed package names.

[Mike McCracken (mikemc)]

Looks good, builds & tests fine for me on mac os 10.7

review: Approve

=== added file '.bzrignore'
--- .bzrignore	1970-01-01 00:00:00 +0000
+++ .bzrignore	2012-12-18 21:35:23 +0000
@@ -0,0 +1,16 @@
+bin
+target
+.project
+.classpath
+lib
+lib/signpost-commonshttp4-*.jar
+lib/signpost-core-*.jar
+lib/commons-codec-*.jar
+lib/commons-logging-*.jar
+lib/httpcore-*.jar
+lib/httpclient-*.jar
+lib/jackson-mini-*.jar
+lib/lombok.jar
+lib/test/junit-*.jar
+lib/test/jmock-*.jar
+lib/test/hamcrest-all-*.jar

=== added file '.classpath.template'
--- .classpath.template	1970-01-01 00:00:00 +0000
+++ .classpath.template	2012-12-18 21:35:23 +0000
@@ -0,0 +1,25 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<classpath>
+	<classpathentry kind="src" path="src/main/java" />
+	<classpathentry kind="src" path="src/test/java" />
+	<classpathentry kind="lib" path="lib/signpost-commonshttp4-1.2.1.1.jar" />
+	<classpathentry kind="lib" path="lib/signpost-core-1.2.1.1.jar" />
+	<classpathentry kind="lib" path="lib/commons-codec-1.4.jar" />
+	<classpathentry kind="lib" path="lib/commons-logging-1.1.1.jar" />
+	<classpathentry kind="lib" path="lib/httpclient-4.1.3.jar" />
+	<classpathentry kind="lib" path="lib/httpcore-4.1.3.jar" />
+	<classpathentry kind="lib" path="lib/jackson-mini-1.9.5.jar" />
+
+	<classpathentry kind="lib" path="lib/lombok.jar" />
+
+	<!-- Test -->
+	<classpathentry kind="lib" path="lib/test/junit-4.10.jar" />
+	<classpathentry kind="lib" path="lib/test/jmock-2.5.1.jar" />
+	<classpathentry kind="lib" path="lib/test/hamcrest-all-1.2.jar" />
+
+<!--
+	<classpathentry kind="con" path="org.eclipse.jdt.junit.JUNIT_CONTAINER/4" />
+	<classpathentry kind="con" path="org.eclipse.jdt.launching.JRE_CONTAINER/org.eclipse.jdt.internal.debug.ui.launcher.StandardVMType/JavaSE-1.6" />
+-->
+	<classpathentry kind="output" path="bin" />
+</classpath>

=== added file '.project.template'
--- .project.template	1970-01-01 00:00:00 +0000
+++ .project.template	2012-12-18 21:35:23 +0000
@@ -0,0 +1,17 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<projectDescription>
+	<name>ubuntuone-accounts</name>
+	<comment></comment>
+	<projects>
+	</projects>
+	<buildSpec>
+		<buildCommand>
+			<name>org.eclipse.jdt.core.javabuilder</name>
+			<arguments>
+			</arguments>
+		</buildCommand>
+	</buildSpec>
+	<natures>
+		<nature>org.eclipse.jdt.core.javanature</nature>
+	</natures>
+</projectDescription>

=== added file 'README.md'
--- README.md	1970-01-01 00:00:00 +0000
+++ README.md	2012-12-18 21:35:23 +0000
@@ -0,0 +1,63 @@
+# What is this?
+
+Ubuntu One Accounts Java library, formerly known as
+Ubuntu Single Sign On Java library, talks to
+Ubuntu One authentications and accounts REST APIs.
+It allows you to:
+ * register and authenticate users
+ * retrieve account details
+ * list and manage connected devices
+
+# tl;dr
+
+Build with:
+
+	$ ant setup jar
+
+Find the jar under ./target/dist directory.
+
+# How do I build it?
+
+You can download a jar file directly from the project page
+on [Launchpad](https://launchpad.net/ubuntu-sso-java-library)
+or, if you prefer, you can build it from source.
+
+To download dependencies, run:
+
+    $ ant setup
+
+To build a jar file, run:
+
+    $ ant jar
+
+You will find the jar file in the ./target/dist directory.
+
+# How do I hack it?
+
+If you use Eclipse, first run:
+
+	$ ant setup eclipse
+
+Which will download the dependencies and create fresh copies of
+.project and .classpath files for you.
+
+# How do I use it?
+
+Grab lp:~karni/ubuntu-sso-java-library/sso-cli-example
+from [Launchpad](https://code.launchpad.net/ubuntu-sso-java-library)
+and have a look at the source code. This example shows how to
+sign up and sign in using the library.
+
+Grab lp:~karni/ubuntuone-files-java-library/cli-ubuntuone
+from [Launchpad](https://code.launchpad.net/ubuntuone-files-java-library).
+This example involves sign in only.
+
+# Feedback
+
+If you have comments or ideas for improvements, do not hesitate
+to contact Ubuntu One team on irc.freenode.net at #ubuntuone channel.
+(Feel free to ping me directly, I am *karni* on Freenode).
+
+# Misc
+
+Project uses ant build tool, but has maven-ready directory structure.

=== added file 'ant.properties'
--- ant.properties	1970-01-01 00:00:00 +0000
+++ ant.properties	2012-12-18 21:35:23 +0000
@@ -0,0 +1,49 @@
+java.encoding=UTF-8
+
+lib.signpost.ver=1.2.1.1
+url.oasp=http://oauth-signpost.googlecode.com/files
+
+lib.signpost-core.jar=signpost-core-${lib.signpost.ver}.jar
+lib.signpost-core.url=${url.oasp}/${lib.signpost-core.jar}
+
+lib.signpost-commonshttp4.jar=signpost-commonshttp4-${lib.signpost.ver}.jar
+lib.signpost-commonshttp4.url=${url.oasp}/${lib.signpost-commonshttp4.jar}
+
+url.ibiblio=http://mirrors.ibiblio.org/pub/mirrors/maven2
+
+lib.commons-codec.ver=1.4
+lib.commons-codec.jar=commons-codec-${lib.commons-codec.ver}.jar
+lib.commons-codec.url=${url.ibiblio}/commons-codec/commons-codec/${lib.commons-codec.ver}/${lib.commons-codec.jar}
+
+lib.commons-logging.ver=1.1.1
+lib.commons-logging.jar=commons-logging-${lib.commons-logging.ver}.jar
+lib.commons-logging.url=${url.ibiblio}/commons-logging/commons-logging/${lib.commons-logging.ver}/${lib.commons-logging.jar}
+
+lib.httpcore.ver=4.1.3
+lib.httpcore.jar=httpcore-${lib.httpcore.ver}.jar
+lib.httpcore.url=${url.ibiblio}/org/apache/httpcomponents/httpcore/${lib.httpcore.ver}/${lib.httpcore.jar}
+
+lib.httpclient.ver=4.1.3
+lib.httpclient.jar=httpclient-${lib.httpclient.ver}.jar
+lib.httpclient.url=${url.ibiblio}/org/apache/httpcomponents/httpclient/${lib.httpclient.ver}/${lib.httpclient.jar}
+
+lib.jackson-mini.ver=1.9.5
+lib.jackson-mini.jar=jackson-mini-${lib.jackson-mini.ver}.jar
+lib.jackson-mini.url=http://jackson.codehaus.org/${lib.jackson-mini.ver}/${lib.jackson-mini.jar}
+
+lib.lombok.jar=lombok.jar
+lib.lombok.url=http://projectlombok.googlecode.com/files/lombok.jar
+
+lib.junit.ver=4.10
+lib.junit.jar=junit-${lib.junit.ver}.jar
+lib.junit.url=${url.ibiblio}/junit/junit/${lib.junit.ver}/${lib.junit.jar}
+
+lib.jmock.ver=2.5.1
+lib.jmock.zip=jmock-${lib.jmock.ver}-jars.zip
+lib.jmock.jar=jmock-${lib.jmock.ver}.jar
+lib.jmock.url=http://cloud.github.com/downloads/jmock-developers/jmock-library/${lib.jmock.zip}
+
+lib.hamcrest-all.ver=1.2
+lib.hamcrest-all.jar=hamcrest-all-${lib.hamcrest-all.ver}.jar
+lib.hamcrest-all.url=http://hamcrest.googlecode.com/files/${lib.hamcrest-all.jar}
+

=== added file 'build.xml'
--- build.xml	1970-01-01 00:00:00 +0000
+++ build.xml	2012-12-18 21:35:23 +0000
@@ -0,0 +1,307 @@
+<?xml version="1.0"?>
+<project name="ubuntuone-accounts" default="jar" basedir=".">
+
+	<description>
+	*** Ubuntu One Accounts *** 
+
+	Ubuntu One Accounts Java library
+	http://launchpad.net/ubuntu-sso-java-library
+
+	API documentation:
+	http://one.ubuntu.com/developer
+	-> Account Admin APIs
+
+	Contact:
+	IRC: #ubuntuone @ irc.freenode.net
+
+	For instructions on building, see README.md
+	</description>	
+
+	<property environment="env" />
+
+	<property file="build.properties" />
+	<property file="ant.properties" />
+
+	<property name="project.groupId" value="com.ubuntu.one.api.accounts" />
+	<property name="project.artifactId" value="ubuntuone-accounts" />
+
+	<exec
+		executable="bash"
+		outputproperty="project.version"
+		failonerror="true">
+
+		<arg value="-c" />
+		<arg value="bzr tags|head -n1|cut -d' ' -f1" />
+	</exec>
+	<exec
+		executable="bzr"
+		outputproperty="project.revision"
+		failonerror="true">
+
+		<arg value="revno" />
+	</exec>
+
+	<property name="target" value="${basedir}/target" />
+	<property name="src.home" value="${basedir}/src/main/java" />
+	<property name="resource.home" value="${basedir}/src/main/resources" />
+	<property name="build.home" value="${target}/jar" />
+	<property name="dist.dir" value="${target}/dist" />
+	<property name="generated.home" value="${basedir}/src/main/generated" />
+
+	<!-- Test -->
+	<property name="test.dir" value="${target}/test" />
+	<property name="test.dir.src" value="${basedir}/src/test/java" />
+	<property name="test.dir.data" value="src/main/test/resources" />
+	<property name="test.dir.classes" value="${test.dir}/classes" />
+	<property name="test.dir.reports" value="${test.dir}/reports" />
+
+	<property name="lib" value="${basedir}/lib" />
+	<property name="lib.test" value="${basedir}/lib/test" />
+
+	<patternset id="support.jars.patternset">
+		<include name="*.jar" />
+	</patternset>
+
+	<patternset id="test.jars.patternset">
+		<include name="*.jar" />
+	</patternset>
+
+	<path id="compile.classpath">
+		<fileset
+			id="compile.jars"
+			dir="${lib}">
+
+			<patternset refid="support.jars.patternset" />
+		</fileset>
+	</path>
+
+	<path id="test.compile.classpath">
+		<path refid="compile.classpath" />
+		<fileset dir="${basedir}/lib/test">
+			<patternset refid="test.jars.patternset" />
+		</fileset>
+	</path>
+
+	<path id="test.classpath">
+		<path refid="test.compile.classpath" />
+		<path>
+			<fileset dir="lib/test">
+				<patternset refid="test.jars.patternset" />
+			</fileset>
+		</path>
+		<pathelement location="${test.dir.classes}" />
+	</path>
+
+	<target
+		name="version"
+		description="Prints project version and bzr revision">
+
+		<echo message="Version: ${project.version}" />
+		<echo message="Revision: ${project.revision}" />
+	</target>
+
+	<target
+		name="all"
+		depends="clean,test"
+		description="Clean build and dist directories, then compile" />
+
+	<target
+		name="clean"
+		description="Delete old build and dist directories">
+
+		<delete dir="${target}" />
+		<delete dir="${generated.home}" />
+		<mkdir dir="${generated.home}" />
+	</target>
+
+	<target
+		name="clean-lib"
+		description="Delete downloaded jar files">
+
+		<delete dir="${lib}" />
+	</target>
+
+	<target
+		name="clean-all"
+		depends="clean,clean-lib"
+		description="Delete jars and build directories" />
+
+	<target
+		name="compile"
+		depends="prepare"
+		description="Compile Java sources">
+
+		<javac
+			destdir="${build.home}"
+			debug="${compile.debug}"
+			debuglevel="lines,vars,source"
+			deprecation="${compile.deprecation}"
+			optimize="${compile.optimize}"
+			includeantruntime="false">
+
+			<classpath refid="compile.classpath" />
+			<src path="${src.home}" />
+			<src path="${generated.home}" />
+		</javac>
+	</target>
+
+	<target
+		name="jar"
+		depends="compile,test"
+		description="Create binary distribution">
+
+		<!-- Copy resources -->
+		<copy todir="${build.home}">
+			<fileset
+				dir="${resource.home}"
+				excludes="**/*.java" />
+		</copy>
+		<delete dir="${dist.dir}" />
+		<mkdir dir="${dist.dir}" />
+		<jar
+			jarfile="${dist.dir}/${project.artifactId}-${project.version}.jar"
+			basedir="${build.home}" />
+	</target>
+
+	<target
+		name="test.init"
+		unless="skipTests">
+
+		<mkdir dir="${test.dir.classes}" />
+		<delete dir="${test.dir.reports}" />
+		<mkdir dir="${test.dir.reports}" />
+	</target>
+
+	<target
+		name="test-compile"
+		depends="compile, test.init"
+		unless="skipTests">
+
+		<javac
+			srcdir="${test.dir.src}"
+			destdir="${test.dir.classes}"
+			debug="${compile.debug}"
+			debuglevel="lines,vars,source"
+			deprecation="${compile.deprecation}"
+			includeantruntime="true">
+
+			<classpath refid="test.compile.classpath" />
+		</javac>
+	</target>
+
+	<target
+		name="test"
+		depends="test-compile"
+		description="Test application"
+		unless="skipTests">
+
+		<junit
+			printsummary="yes"
+			haltonfailure="no">
+
+			<classpath refid="test.classpath" />
+			<formatter type="plain" />
+			<batchtest
+				fork="yes"
+				todir="${test.dir.reports}">
+				<fileset dir="${test.dir.classes}">
+					<include name="**/*.class" />
+				</fileset>
+			</batchtest>
+		</junit>
+	</target>
+
+	<target
+		name="javadoc"
+		depends="compile"
+		description="Create Javadoc API documentation">
+
+		<mkdir dir="docs/api" />
+		<javadoc
+			sourcepath="${src.home}"
+			destdir="docs/api"
+			packagenames="*">
+
+			<classpath refid="compile.classpath" />
+		</javadoc>
+	</target>
+
+	<target name="prepare">
+		<mkdir dir="${build.home}" />
+		<mkdir dir="${generated.home}" />
+	</target>
+
+	<target name="get-jars">
+
+		<mkdir dir="${lib}" />
+		<mkdir dir="${lib.test}" />
+
+		<!-- Dependencies -->
+
+		<get src="${lib.signpost-core.url}" dest="${lib}"
+			verbose="on" usetimestamp="true" maxtime="60" />
+
+		<get src="${lib.signpost-commonshttp4.url}" dest="${lib}"
+			verbose="on" usetimestamp="true" maxtime="60" />
+
+		<get src="${lib.commons-codec.url}" dest="${lib}"
+			verbose="on" usetimestamp="true" maxtime="60" />
+
+		<get src="${lib.commons-logging.url}" dest="${lib}"
+			verbose="on" usetimestamp="true" maxtime="60" />
+
+		<get src="${lib.httpcore.url}" dest="${lib}"
+			verbose="on" usetimestamp="true" maxtime="60" />
+
+		<get src="${lib.httpclient.url}" dest="${lib}"
+			verbose="on" usetimestamp="true" maxtime="60" />
+
+		<get src="${lib.jackson-mini.url}" dest="${lib}"
+			verbose="on" usetimestamp="true" maxtime="60" />
+
+		<!-- Compile only -->
+
+		<get src="${lib.lombok.url}" dest="${lib}"
+			verbose="on" usetimestamp="true" maxtime="60" />
+
+		<!-- Test -->
+
+		<get src="${lib.junit.url}" dest="${lib.test}"
+			verbose="on" usetimestamp="true" maxtime="60" />
+
+		<get src="${lib.jmock.url}" dest="${lib.test}"
+			verbose="on" usetimestamp="true" maxtime="60" />
+		<unzip src="${lib.test}/${lib.jmock.zip}" dest="${lib.test}">
+			<patternset>
+				<include name="**/${lib.jmock.jar}" />
+				<!--<include name="**/${lib.jmock-junit4.jar}" />-->
+			</patternset>
+			<mapper type="flatten" />
+		</unzip>
+		<delete file="${lib.test}/${lib.jmock.zip}" quiet="true" />	
+
+		<get src="${lib.hamcrest-all.url}" dest="${lib.test}"
+			verbose="on" usetimestamp="true" maxtime="60" />
+	</target>
+
+	<target
+		name="setup"
+		depends="get-jars"
+		description="Download project depenencies.">
+
+		<echo message="Downloaded all project dependencies." />
+	</target>
+
+	<target
+		name="eclipse"
+		description="Create fresh .project and .classpath">
+
+		<copy
+			file=".project.template"
+			tofile=".project" />
+		<copy
+			file=".classpath.template"
+			tofile=".classpath" />
+	</target>
+</project>
+

=== added directory 'src'
=== added directory 'src/main'
=== added directory 'src/main/config'
=== added directory 'src/main/filters'
=== added directory 'src/main/generated'
=== added directory 'src/main/java'
=== added directory 'src/main/java/com'
=== added directory 'src/main/java/com/ubuntu'
=== added directory 'src/main/java/com/ubuntu/one'
=== added directory 'src/main/java/com/ubuntu/one/api'
=== added directory 'src/main/java/com/ubuntu/one/api/accounts'
=== added file 'src/main/java/com/ubuntu/one/api/accounts/U1Accounts.java'
--- src/main/java/com/ubuntu/one/api/accounts/U1Accounts.java	1970-01-01 00:00:00 +0000
+++ src/main/java/com/ubuntu/one/api/accounts/U1Accounts.java	2012-12-18 21:35:23 +0000
@@ -0,0 +1,4 @@
+package com.ubuntu.one.api.accounts;
+
+public class U1Accounts {
+}

=== added directory 'src/main/resources'
=== added directory 'src/test'
=== added directory 'src/test/filters'
=== added directory 'src/test/java'
=== added directory 'src/test/java/com'
=== added directory 'src/test/java/com/ubuntu'
=== added directory 'src/test/java/com/ubuntu/one'
=== added directory 'src/test/java/com/ubuntu/one/api'
=== added directory 'src/test/java/com/ubuntu/one/api/accounts'
=== added file 'src/test/java/com/ubuntu/one/api/accounts/U1AccountsTest.java'
--- src/test/java/com/ubuntu/one/api/accounts/U1AccountsTest.java	1970-01-01 00:00:00 +0000
+++ src/test/java/com/ubuntu/one/api/accounts/U1AccountsTest.java	2012-12-18 21:35:23 +0000
@@ -0,0 +1,21 @@
+package com.ubuntu.one.api.accounts;
+
+import org.junit.After;
+import org.junit.Assert;
+import org.junit.Before;
+import org.junit.Test;
+
+public class U1AccountsTest {
+    @Before
+    public void doBefore() {
+    }
+
+    @After
+    public void doAfter() {
+    }
+
+    @Test
+    public void aTest() {
+        Assert.assertTrue(true);
+    }
+}

=== added directory 'src/test/resources'