Updates for 1.3.15 (#9)

* Update to utilize new features in 1.3.15. Update README.

* Point to release artifact

Author: adriansoghoian

.idea/compiler.xml

@@ -4,6 +4,8 @@ The CommonHealth Client SDK provides an interface that allows applications to ac
 
 The CommonHealth Client SDK is in open beta. 
 
+If you're interested in developing a production integration with the CommonHealth Client SDK, please reach out to developers [at] commonhealth.org to begin the process of being whitelisted. 
+
 While we consider the SDK to be relatively stable, this is pre-release software, so the interfaces are subject to change based on evolving requirements and developer feedback. We're currently investigating ways to make it easier to remove configuration dependencies, so if you find anything particularly burdensome or confusing, please let us know by either emailing us or opening a Github issue.
 
 ## Audience 
@@ -25,11 +27,11 @@ Once CommonHealth Developer Edition is installed, you will need to add a sample
 
 ### Gradle Dependencies
 
-The CommonHealth Client SDK consists of two modules: commonhealthclient and common. Commonhealthclient contains the bulk of functionality for the SDK, while common types shared between the CommonHealth application and the CommonHealth Client SDK. You'll need to add the following to your application's list of dependencies:
+The CommonHealth Client SDK consists of two modules: commonhealth-client and commonhealth-common. CommonHealthClient contains the bulk of functionality for the SDK, while common contains types shared between the CommonHealth application and the CommonHealth Client SDK. You'll need to add the following to your application's list of dependencies:
 
 ```
-implementation "org.thecommonsproject:commonhealth-common:1.1.2"
-implementation "org.thecommonsproject:commonhealth-client:1.1.2"
+implementation "org.thecommonsproject:commonhealth-common:1.3.15"
+implementation "org.thecommonsproject:commonhealth-client:1.3.15"
 ```
 
 The release artifacts are made avalable via the Maven Central repository, so you will need to have the following in your list of dependency repositories:
@@ -339,10 +341,46 @@ Upon receiving the NEW_DATA_AVAILABLE notification, you can invoke a method on t
 
  Using these can help you identify when and if you need to pull data from CommonHealth, or if data has been deleted in CommonHealth and should be removed from your local datastore, if persisted.
 
+### Reading Verifiable Credentials (SMART® Health Cards) -- new in v1.3.15 and currently in beta 
+
+_Note: This feature is currently in beta and should not yet be used in production applications. We'd love your feedback as you start using it; please open a Github issue, or email developers [at] commonhealth.org with any thoughts that you have. Thank you!_
+
+Client applications can now request to read Verifiable Credentials (SMART® Health Cards) from CommonHealth. This is a completely separate, independent flow from requesting other types of health data. 
+
+Client applications simply request access based on a set of Verifiable Credential types, and if the user consents to sharing any SMART® Health Cards that match the requested types, then the data will be returned immediately to the calling application. There is no persistent connection established, and the client application will have to request again (and the user consent again) to access the same data. 
+
+Invoking the `readVerifiableCredentials` will redirect to CommonHealth, initiating a consent flow where the user can select which SHCs (or none) to share.
+
+Here's a snippet demonstrating how the new `readVerifiableCredentials` method can be called to retrieve COVID-19 Vaccination SMART® Health Cards:
+
+ ```
+// Determine which VC types you'd like to read
+// In this case, we're requesting COVID-19 Vaccination records.  
+val c19VaxVcTypes = setOf(
+    "https://smarthealth.cards#immunization",
+    "https://smarthealth.cards#covid19",
+    "https://smarthealth.cards#health-card"
+)
+
+// Pass the VC Types into the readVerifiableCredentials suspending method        
+val smartHealthCards = commonHealthStore.readVerifiableCredentials(
+    context,
+    c19VaxVcTypes
+)
+ ```
+
+CommonHealth performs SMART® Health Card validation prior to ingesting the cards into the app, including signature validation and checks against the payload contents. However, it is recommended to perform your own validation depending on your use case. The raw JWT can be accessed through the `json` property on each `VerifiableRecordSampleDataQueryResult` object.
+
 ## Registering with CommonHealth
 
 Registering with CommonHealth is not required to begin testing integrations with CommonHealth Developer Edition. However, if you have a client application that you would like to use in staging or production environments, you'll need to register the application with CommonHealth. This is similar to registering an OAuth client, where you would specify information such as required scope, authorization redirect URI, etc. Please reach out to developers [at] commonhealth.org for more information.
 
+## Upgrading from v1.1.2 to v1.3.15
+`v1.3.15` introduced a small number of changes:
+
+- Support for requesting access to Verifiable Credentials (SMART® Health Cards) is now in beta
+- Updates to support higher Android OS levels (specifically changes to accommodate new restrictions on apps calling into packageManager)
+
 ## Upgrading from v0.4.8 to v1.1.2
 `v1.1.2` introduced a small number of changes:
 
@@ -352,7 +390,6 @@ Registering with CommonHealth is not required to begin testing integrations with
     - `org.thecommonsproject.commonhealth:commonhealthclient` is now `org.thecommonsproject:commonhealth-client`
  - The artifacts are now hosted in Maven Central.
 
-
 ## Upgrading from v0.4.4 to v0.4.8
 `v0.4.8` introduced a number of large changes and enhancements to the API:
 

.idea/gradle.xml

@@ -20,6 +20,7 @@ android {
         manifestPlaceholders.interappAuthRedirectScheme = "org.thecommonsproject.android.commonhealth.sampleapp"
         manifestPlaceholders.interappAuthRedirectHost = "interapp"
         manifestPlaceholders.interappAuthRedirectPath = "/redirect"
+        manifestPlaceholders.commonHealthAppId = "org.thecommonsproject.android.phr.developer"
     }
     buildTypes {
         release {
@@ -34,7 +35,7 @@ android {
     }
 
     kotlinOptions {
-        jvmTarget = "1.8"
+        jvmTarget = "11"
     }
 }
 

.idea/misc.xml

@@ -11,7 +11,8 @@
         android:roundIcon="@mipmap/ic_launcher_round"
         android:supportsRtl="true"
         android:theme="@style/AppTheme">
-        <activity android:name=".MainActivity">
+        <activity android:name=".MainActivity"
+            android:exported="true">
             <intent-filter>
                 <action android:name="android.intent.action.MAIN" />
 
@@ -20,4 +21,8 @@
         </activity>
     </application>
 
+    <queries>
+        <package android:name="${commonHealthAppId}" />
+    </queries>
+
 </manifest>

README.md

@@ -2,8 +2,6 @@ package org.thecommonsproject.android.commonhealth.sampleapp
 
 import android.content.Context
 import android.content.Intent
-import android.util.Log
-import androidx.lifecycle.LiveData
 import androidx.lifecycle.MutableLiveData
 import androidx.lifecycle.ViewModel
 import androidx.lifecycle.viewModelScope
@@ -16,6 +14,7 @@ import org.thecommonsproject.android.common.interapp.CommonHealthAuthorizationSt
 import org.thecommonsproject.android.common.interapp.dataquery.response.DataQueryResult
 import org.thecommonsproject.android.common.interapp.dataquery.response.FHIRSampleDataQueryResult
 import org.thecommonsproject.android.common.interapp.dataquery.response.RecordUpdateQueryResult
+import org.thecommonsproject.android.common.interapp.dataquery.response.VerifiableRecordSampleDataQueryResult
 import org.thecommonsproject.android.common.interapp.scope.DataType
 import org.thecommonsproject.android.common.interapp.scope.Scope
 import org.thecommonsproject.android.common.interapp.scope.ScopeRequest
@@ -24,14 +23,22 @@ import org.thecommonsproject.android.commonhealthclient.AuthorizationRequest
 import org.thecommonsproject.android.commonhealthclient.CommonHealthAvailability
 import org.thecommonsproject.android.commonhealthclient.CommonHealthStore
 import timber.log.Timber
-import java.util.*
 
 class MainViewModel(
     private val commonHealthStore: CommonHealthStore
 ) : ViewModel() {
 
+    companion object {
+        private val c19VaxVcTypes = setOf(
+            "https://smarthealth.cards#immunization",
+            "https://smarthealth.cards#covid19",
+            "https://smarthealth.cards#health-card"
+        )
+    }
+
     private val connectionAlias = "connection_alias"
-    private val TAG by lazy { MainViewModel::class.java.simpleName }
+
+    var storedVCResults = emptyList<VerifiableRecordSampleDataQueryResult>()
 
     val allDataTypes: List<DataType.ClinicalResource> = listOf(
         DataType.ClinicalResource.AllergyIntoleranceResource,
@@ -172,6 +179,15 @@ class MainViewModel(
         return commonHealthStore.getCommonHealthAvailability(context)
     }
 
+    suspend fun fetchC19VaxStatus(context: Context): List<VerifiableRecordSampleDataQueryResult> {
+        val results = commonHealthStore.readVerifiableCredentials(
+            context,
+            c19VaxVcTypes
+        )
+        storedVCResults = results
+        return results
+    }
+
     fun prettyPrintJSON(jsonString: String): String {
         val gson = GsonBuilder().setPrettyPrinting().create()
         val element = JsonParser.parseString(jsonString)

app/build.gradle

@@ -17,6 +17,9 @@ import timber.log.Timber
 class SampleApplication: Application() {
 
     private var database: SampleApplicationDatabase? = null
+    private val cryptoProvider: CryptoProvider by lazy {
+        DefaultCryptoProvider(DefaultAndroidKeystoreClientWrapper())
+    }
 
     private fun getDatabasePassphrase(context: Context, cryptoProvider: CryptoProvider) : ByteArray {
         val passphraseFilePath = context.filesDir.absolutePath.plus("/encryptedDatabasePassphrase")
@@ -46,7 +49,6 @@ class SampleApplication: Application() {
 
     private fun initializeCommonHealthStore(application: Application) {
 
-        val cryptoProvider = DefaultCryptoProvider(DefaultAndroidKeystoreClientWrapper())
         val context = application.applicationContext
         val notificationPreferences = NotificationPreferences(
             subscribedNotificationTypes = setOf(

app/src/main/AndroidManifest.xml

@@ -13,6 +13,7 @@ import androidx.navigation.fragment.findNavController
 import androidx.navigation.navOptions
 import androidx.recyclerview.widget.LinearLayoutManager
 import androidx.recyclerview.widget.RecyclerView
+import kotlinx.coroutines.delay
 import kotlinx.coroutines.launch
 import org.thecommonsproject.android.common.interapp.CommonHealthAuthorizationStatus
 import org.thecommonsproject.android.common.interapp.dataquery.response.RecordUpdateQueryResult
@@ -30,6 +31,7 @@ class CategoryListFragment : Fragment() {
 
     private val viewModel by activityViewModels<MainViewModel> { getVmFactory() }
     private lateinit var authorizeButton: Button
+    private lateinit var requestShcsButton: Button
     private lateinit var spinner: ProgressBar
 
     override fun onCreateView(
@@ -83,6 +85,12 @@ class CategoryListFragment : Fragment() {
             startActivity(authIntent)
         }
 
+        requestShcsButton = view.findViewById(R.id.request_shcs)
+        requestShcsButton.isEnabled = false
+        requestShcsButton.setOnClickListener {
+            requestC19VaxStatus()
+        }
+
         spinner = view.findViewById(R.id.progress_bar)
 
         viewModel.resultsLiveData.observe(viewLifecycleOwner) { resultsMap ->
@@ -100,10 +108,38 @@ class CategoryListFragment : Fragment() {
         updateUI()
     }
 
+    private fun requestC19VaxStatus() {
+        val context = context ?: return
+        viewModel.viewModelScope.launch {
+            spinner.visibility = View.VISIBLE
+            val results = viewModel.fetchC19VaxStatus(context)
+            spinner.visibility = View.GONE
+            if (results.isEmpty()) {
+                Toast.makeText(requireContext(), "Fetched 0 Verifiable Credentials", Toast.LENGTH_LONG).show()
+                return@launch
+            }
+
+            delay(500)
+
+            val directions = CategoryListFragmentDirections.actionCategoryListFragmentToVcResultsListFragment()
+            val options = navOptions {
+                anim {
+                    enter = R.anim.slide_in_right
+                    exit = R.anim.slide_out_left
+                    popEnter = R.anim.slide_in_left
+                    popExit = R.anim.slide_out_right
+                }
+            }
+            findNavController().navigate(directions, options)
+        }
+    }
+
     private fun updateUI() {
         viewModel.viewModelScope.launch {
             when(viewModel.getCommonHealthAvailability(requireContext())) {
-                CommonHealthAvailability.AVAILABLE -> { }
+                CommonHealthAvailability.AVAILABLE -> {
+                    requestShcsButton.isEnabled = true
+                }
                 CommonHealthAvailability.NOT_INSTALLED,
                 CommonHealthAvailability.ACCOUNT_NOT_CONFIGURED_FOR_SHARING -> {
                     Toast.makeText(
@@ -112,6 +148,7 @@ class CategoryListFragment : Fragment() {
                         Toast.LENGTH_LONG
                     ).show()
                     authorizeButton.isEnabled = false
+                    requestShcsButton.isEnabled = false
                     return@launch
                 }
             }