muser-firebase-export

Java application to export music listening data collected with the MUSER Android app. Data is exported from Firebase Firestore to a CSV file.

Setup

You'll need the following installed to build the project:

• JDK 8 or higher
• Apache Maven

Build

To build the application use mvn clean package command. This command will create a jar file (i.e., muser-0.0.1-SNAPSHOT.jar) under the target folder.

Setup Firebase Account

Generate a admin private-key json file (e.g., admin-key.json) for your service account. To generate the key file follow the instructions in Firebase setup page.

Run

To run the application use java -jar command and pass the admin-key.json file as an argument:

java -jar target/muser-0.0.1-SNAPSHOT.jar -keyFile /path/to/file/fileName.json

Additional Optional Command Line Arguments

• -userId <userId> Takes a user id as an argument and performs the analysis for that specific user. Example usage: -userId abcdef.
• -startDate <mm-dd-yyyy> -endDate <mm-dd-yyyy> Takes two dates as argument and performs the analysis for activities in the specific date range. The filter will assume the dates in the UTC timezone. Example usage: -startDate 05-05-2021 -endDate 07-15-2021 will perform the analysis from May 05, 2021 00:00:00 UTC, to July 15, 2021 00:00:00 UTC.

  Note: The startDate and endDate must be provided together (providing only one results in error).
  

License

/*
 * Copyright (C) 2019-2020 University of South Florida
 *
 * 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.
 */