Merge branch 'master' of github.com:studyplus/Studyplus-Android-SDK into abolish-local-maven

x7c1 · x7c1 · commit 355d71ef4cdf · 2014-03-05T16:55:49.000+09:00
Conflicts:
	build.gradle
diff --git a/README.md b/README.md
@@ -12,7 +12,7 @@ Studyplus SDK for Android
 
 Graddle Project
 
-```
+```groovy
 repositories {
     maven { url 'http://raw.github.com/studyplus/Studyplus-Android-SDK/master/repository' }
 }
@@ -21,10 +21,58 @@ dependencies {
 }
 ```
 
-##Usage
+## Usage
+
+### Authenticate
+
+Open an Activity to connect with Studyplus.
+
+```java
+try {
+    AuthTransit.from(activity).startActivity(
+	    context.getString("app_consumer_key"),
+	    context.getString("app_consumer_key_secret")
+    );
+} catch (ActivityNotFoundException e) {
+    e.printStackTrace();
+    Toast.makeText(context, "Need for Studyplus 2.14.0+", Toast.LENGTH_SHORT).show();
+}
+```
+
+Then save its result.
+
+```java
+@Override
+protected void onActivityResult(int requestCode, int resultCode, Intent data) {
+	CertificationStore.create(context).update(data);
+}
+```
+
+### Post a record to Studyplus
+
+Create ApiRequest and send it with ApiClient.
+
+```java
+ApiRequest request = StudyRecordPostRequest.of(
+	new StudyRecordBuilder()
+		.setComment("perfect!")
+		.setAmountTotal(30)
+		.setDurationSeconds(2 * 60)
+		.build()
+);
+
+try {
+    StudyplusApi.getClient(context).send(request);
+} catch (AccessTokenNotFound e) {
+    e.printStackTrace();
+    Toast.makeText(context, "Access token not exists", Toast.LENGTH_SHORT).show();
+}
+```
+
+### More
 
-Coming Soon
+* See also [actual examples](https://github.com/studyplus/Studyplus-Android-SDK/blob/master/SDKExample/src/main/java/jp/studyplus/android/sdk/example/ExampleActivity.java).
 
-##License
+## License
 
 * [MIT License](http://opensource.org/licenses/MIT)
diff --git a/SDKExample/src/main/java/jp/studyplus/android/sdk/example/ExampleActivity.java b/SDKExample/src/main/java/jp/studyplus/android/sdk/example/ExampleActivity.java
@@ -1,6 +1,7 @@
 package jp.studyplus.android.sdk.example;
 
 import android.app.Activity;
+import android.content.ActivityNotFoundException;
 import android.content.Context;
 import android.content.Intent;
 import android.os.Bundle;
@@ -16,6 +17,7 @@
 import jp.studyplus.android.sdk.service.api.StudyplusApi;
 import jp.studyplus.android.sdk.service.api.response.ErrorResponse;
 import jp.studyplus.android.sdk.service.api.response.SuccessfulResponse;
+import jp.studyplus.android.sdk.service.auth.AccessTokenNotFound;
 import jp.studyplus.android.sdk.service.auth.AuthTransit;
 import jp.studyplus.android.sdk.service.auth.CertificationStore;
 import jp.studyplus.android.sdk.service.studyrecord.StudyRecordBuilder;
@@ -57,7 +59,13 @@ public void onClick(View v) {
 					.setDurationSeconds(2 * 60)
 					.build());
 
-			StudyplusApi.getClient(context).send(request.with(this));
+			try {
+				StudyplusApi.getClient(context).send(request.with(this));
+			} catch (AccessTokenNotFound e) {
+				e.printStackTrace();
+				Toast.makeText(context, R.string. sample_certification_no_access_token, Toast.LENGTH_SHORT)
+						.show();
+			}
 		}
 
 		@Subscribe @SuppressWarnings("unused")
@@ -84,10 +92,16 @@ private OnClickToAuth(Activity activity) {
 		}
 		@Override
 		public void onClick(View v) {
-			AuthTransit.from(activity).startActivity(
-				context.getString(R.string.sample_consumer_key),
-				context.getString(R.string.sample_consumer_key_secret)
-			);
+			try {
+				AuthTransit.from(activity).startActivity(
+						context.getString(R.string.sample_consumer_key),
+						context.getString(R.string.sample_consumer_key_secret)
+				);
+			} catch (ActivityNotFoundException e) {
+				e.printStackTrace();
+				Toast.makeText(context, R.string.sample_certification_studyplus_not_found, Toast.LENGTH_SHORT)
+						.show();
+			}
 		}
 	}
 
diff --git a/SDKExample/src/main/res/values/strings.xml b/SDKExample/src/main/res/values/strings.xml
@@ -4,4 +4,6 @@
     <string name="app_name">SDK Example</string>
     <string name="hello_world">Hello world!!!</string>
 
+    <string name="sample_certification_no_access_token">アクセストークンがありません。先に認証をしてください。</string>
+    <string name="sample_certification_studyplus_not_found">Studyplus 2.14.0 以上のインストールが必要です。</string>
 </resources>
diff --git a/StudyplusAndroidSDK/build.gradle b/StudyplusAndroidSDK/build.gradle
@@ -1,4 +1,6 @@
+
 apply plugin: 'android-library'
+apply plugin: 'android-test'
 
 android {
     compileSdkVersion 19
@@ -10,11 +12,26 @@ android {
         versionCode 1
         versionName "1.0"
     }
+    sourceSets {
+        instrumentTest.setRoot('src/test')
+    }
+}
+
+tasks.withType(Test) {
+    systemProperty "robolectric.logging", "stdout"
 }
 
 dependencies {
     compile 'com.android.support:appcompat-v7:19.0.1'
     compile 'com.google.guava:guava:16.0'
+
+    def forTesting = [
+        'junit:junit:4.11',
+        'org.robolectric:robolectric:2.3-SNAPSHOT',
+        'com.squareup:fest-android:1.0.7',
+    ]
+    forTesting.each{ testCompile it }
+    forTesting.each{ instrumentTestCompile it }
 }
 
 if (gradle.startParameter.taskNames.contains('uploadArchives')) {
diff --git a/StudyplusAndroidSDK/src/main/java/jp/studyplus/android/sdk/service/api/StudyplusApi.java b/StudyplusAndroidSDK/src/main/java/jp/studyplus/android/sdk/service/api/StudyplusApi.java
@@ -2,6 +2,7 @@
 
 import android.content.Context;
 
+import jp.studyplus.android.sdk.service.auth.AccessTokenNotFound;
 import jp.studyplus.android.sdk.service.auth.CertificationStore;
 
 
@@ -10,7 +11,12 @@
  */
 public class StudyplusApi {
 
-	public static ApiClient getClient(Context context){
+	/**
+	 * @param context Specifies application context.
+	 * @return client for StudyplusAPI
+	 * @throws AccessTokenNotFound
+	 */
+	public static ApiClient getClient(Context context) {
 		ApiCertification certification = CertificationStore.create(context).getDefault();
 		return new ApiClient(certification);
 	}
diff --git a/StudyplusAndroidSDK/src/main/java/jp/studyplus/android/sdk/service/auth/AuthTransit.java b/StudyplusAndroidSDK/src/main/java/jp/studyplus/android/sdk/service/auth/AuthTransit.java
@@ -1,6 +1,7 @@
 package jp.studyplus.android.sdk.service.auth;
 
 import android.app.Activity;
+import android.content.ActivityNotFoundException;
 import android.content.Intent;
 import android.net.Uri;
 
@@ -24,7 +25,14 @@ public AuthTransit setRequestCode(int requestCode){
 		return new AuthTransit(activity, requestCode);
 	}
 
-	public void startActivity(String consumerKey, String consumerSecret){
+	/**
+	 * Start the certification {@link Activity} for API.
+	 *
+	 * @param consumerKey for API
+	 * @param consumerSecret for API
+	 * @throws ActivityNotFoundException when not installed Studyplus application or un-supported version.
+	 */
+	public void startActivity(String consumerKey, String consumerSecret) {
 		Intent intent = new Intent();
 		intent.setAction(Intent.ACTION_VIEW);
 		intent.putExtra("consumer_key", consumerKey);
diff --git a/StudyplusAndroidSDK/src/main/java/jp/studyplus/android/sdk/service/auth/CertificationStore.java b/StudyplusAndroidSDK/src/main/java/jp/studyplus/android/sdk/service/auth/CertificationStore.java
@@ -46,7 +46,13 @@ private Optional<String> findAccessToken(){
 		return Optional.fromNullable(preferences.getString(KEY_ACCESS_TOKEN, null));
 	}
 
-	public ApiCertification getDefault(){
+	/**
+	 * Return the basic {@link ApiCertification} instance for API.
+	 *
+	 * @return certification instance for API.
+	 * @throws AccessTokenNotFound
+	 */
+	public ApiCertification getDefault() {
 		Optional<String> token = findAccessToken();
 		if (!token.isPresent()){
 			throw new AccessTokenNotFound();
diff --git a/StudyplusAndroidSDK/src/test/java/jp/studyplus/android/sdk/test/RobolectricGradleTestRunner.java b/StudyplusAndroidSDK/src/test/java/jp/studyplus/android/sdk/test/RobolectricGradleTestRunner.java
@@ -0,0 +1,35 @@
+package jp.studyplus.android.sdk.test;
+
+import org.junit.runner.notification.RunNotifier;
+import org.junit.runners.model.FrameworkMethod;
+import org.junit.runners.model.InitializationError;
+import org.robolectric.AndroidManifest;
+import org.robolectric.RobolectricTestRunner;
+import org.robolectric.annotation.Config;
+import org.robolectric.res.Fs;
+
+public class RobolectricGradleTestRunner extends RobolectricTestRunner {
+
+	public RobolectricGradleTestRunner(Class<?> testClass) throws InitializationError {
+		super(testClass);
+	}
+
+	@Override
+	protected void runChild(FrameworkMethod method, RunNotifier notifier) {
+		super.runChild(method, notifier);
+	}
+
+	@Override
+	protected AndroidManifest getAppManifest(Config config) {
+		String manifestProperty = System.getProperty("android.manifest");
+		if (config.manifest().equals(Config.DEFAULT) && manifestProperty != null) {
+			String resProperty = System.getProperty("android.resources");
+			String assetsProperty = System.getProperty("android.assets");
+			return new AndroidManifest(
+				Fs.fileFromPath(manifestProperty),
+				Fs.fileFromPath(resProperty),
+				Fs.fileFromPath(assetsProperty));
+		}
+		return super.getAppManifest(config);
+	}
+}
diff --git a/StudyplusAndroidSDK/src/test/java/jp/studyplus/android/sdk/test/RobolectricTest.java b/StudyplusAndroidSDK/src/test/java/jp/studyplus/android/sdk/test/RobolectricTest.java
@@ -0,0 +1,22 @@
+package jp.studyplus.android.sdk.test;
+
+import android.app.Activity;
+
+import org.junit.Before;
+import org.junit.Ignore;
+import org.junit.runner.RunWith;
+import org.robolectric.Robolectric;
+
+@Ignore
+@RunWith(RobolectricGradleTestRunner.class)
+public class RobolectricTest {
+
+	@Before
+	public void setUp(){
+		Robolectric.checkActivities(true);
+	}
+
+	protected Activity getActivity(){
+		return Robolectric.buildActivity(Activity.class).create().get();
+	}
+}
diff --git a/StudyplusAndroidSDK/src/test/java/jp/studyplus/android/sdk/test/auth/AuthTransitTest.java b/StudyplusAndroidSDK/src/test/java/jp/studyplus/android/sdk/test/auth/AuthTransitTest.java
@@ -0,0 +1,16 @@
+package jp.studyplus.android.sdk.test.auth;
+
+import android.content.ActivityNotFoundException;
+
+import org.junit.Test;
+
+import jp.studyplus.android.sdk.service.auth.AuthTransit;
+import jp.studyplus.android.sdk.test.RobolectricTest;
+
+public class AuthTransitTest extends RobolectricTest {
+
+	@Test(expected = ActivityNotFoundException.class)
+	public void shouldThrowActivityNotFound() {
+		AuthTransit.from(getActivity()).startActivity("dummy_key", "dummy_key_secret");
+	}
+}
diff --git a/StudyplusAndroidSDK/src/test/java/jp/studyplus/android/sdk/test/service/api/StudyplusApiTest.java b/StudyplusAndroidSDK/src/test/java/jp/studyplus/android/sdk/test/service/api/StudyplusApiTest.java
@@ -0,0 +1,19 @@
+package jp.studyplus.android.sdk.test.service.api;
+
+import org.junit.Test;
+
+import jp.studyplus.android.sdk.service.api.ApiRequest;
+import jp.studyplus.android.sdk.service.api.StudyplusApi;
+import jp.studyplus.android.sdk.service.auth.AccessTokenNotFound;
+import jp.studyplus.android.sdk.service.studyrecord.StudyRecordBuilder;
+import jp.studyplus.android.sdk.service.studyrecord.StudyRecordPostRequest;
+import jp.studyplus.android.sdk.test.RobolectricTest;
+
+public class StudyplusApiTest extends RobolectricTest{
+
+	@Test(expected = AccessTokenNotFound.class)
+	public void testCatchAccessToken(){
+		ApiRequest request = StudyRecordPostRequest.of(new StudyRecordBuilder().build());
+		StudyplusApi.getClient(getActivity()).send(request);
+	}
+}
diff --git a/build.gradle b/build.gradle
@@ -2,14 +2,21 @@
 buildscript {
     repositories {
         mavenCentral()
+        maven {
+            url 'https://oss.sonatype.org/content/repositories/snapshots/'
+        }
     }
     dependencies {
         classpath 'com.android.tools.build:gradle:0.8.3'
+        classpath 'com.squareup.gradle:gradle-android-test-plugin:0.9.1-SNAPSHOT'
     }
 }
 
 allprojects {
     repositories {
         mavenCentral()
+        maven {
+            url 'https://oss.sonatype.org/content/repositories/snapshots/'
+        }
     }
 }
