retrosheet
📄
Turn Google Spreadsheet to JSON endpoint. [For Android and JVM].
Benefits
🤗
- No worries about server health (because you're using Google's server
😋 ) - Rapid response and unlimited bandwidth
- You can easily migrate to your REST API without any significant code change.
- You don't have to create an admin panel/dashboard to control the data. You can simply use Google Spreadsheet app (web/mobile).
- You can use this library to create POC/MVP instantly
Install
🤝
repositories {
maven { url 'https://jitpack.io' } // Add jitpack
}
dependencies {
implementation 'com.github.theapache64:retrosheet:latest.version'
}
Usage
⌨️
How to write data ?
✍️
Step 1 : Writing Data To Sheet
- Create a Google Form with some fields
Step 2
- Select response destination and select/create a Google sheet to store the responses.
Step 3
- Now you can open the sheet and change sheet name and column names if you want. This is just to make the Google sheet table look like a real database table (optional)
I've changed 
Step 4
- Next, Press the
Sendbutton and copy the form link
Step 5
- Now let's go to our code and create our
RetrosheetInterceptor
val retrosheetInterceptor = RetrosheetInterceptor.Builder()
.setLogging(false)
// To Read
.addSheet(
"notes", // sheet name
"created_at", "title", "description" // columns in same order
)
// To write
.addForm(
ADD_NOTE_ENDPOINT,
"https://docs.google.com/forms/d/e/1FAIpQLSdmavg6P4eZTmIu-0M7xF_z-qDCHdpGebX8MGL43HSGAXcd3w/viewform?usp=sf_link" // form link
)
.build()
Step 6
- Next, let's create a normal Retrofit API interface
@Write @POST(ADD_NOTE_ENDPOINT) // form name suspend fun addNote(@Body addNoteRequest: AddNoteRequest): AddNoteRequest } ">
interface NotesApi { @Read("SELECT *") @GET("notes") // sheet name suspend fun getNotes(): List<Note> @Write @POST(ADD_NOTE_ENDPOINT) // form name suspend fun addNote(@Body addNoteRequest: AddNoteRequest): AddNoteRequest }
-
@Write : To write data to a sheet
-
@Read : To read data from a sheet.
You can lean more about query language from here : https://developers.google.com/chart/interactive/docs/querylanguage.
NOTE: You can use your column name in the query rather than using column letter such as A,B,C etc.
How to read data ?
📖
Step 7 : Reading data from Sheet
-
We're done configuring the writing part. Now let's finish the reading part. Create/open a google sheet, (it can be either form connected, or a simple Google sheet).
-
Press Share and copy the link
Step 8
- Remove contents after the last forward slash from the copied link.
For example, this
https://docs.google.com/spreadsheets/d/1IcZTH6-g7cZeht_xr82SHJOuJXD_p55QueMrZcnsAvQ/edit?usp=sharing
would become this
https://docs.google.com/spreadsheets/d/1IcZTH6-g7cZeht_xr82SHJOuJXD_p55QueMrZcnsAvQ/
Step 9
- Finally, Set the
RetrofitorOkHttp'sbaseUrlwith the above link.
Done
Full Example
🌟
import com.squareup.moshi.Moshi
import com.github.theapache64.retrosheet.RetrosheetInterceptor
import kotlinx.coroutines.runBlocking
import okhttp3.OkHttpClient
import retrofit2.Retrofit
import retrofit2.converter.moshi.MoshiConverterFactory
/**
* Created by theapache64 : Jul 21 Tue,2020 @ 02:11
*/
fun main() = runBlocking {
// Building Retrosheet Interceptor
val retrosheetInterceptor = RetrosheetInterceptor.Builder()
.setLogging(false)
// To Read
.addSheet(
"notes", // sheet name
"created_at", "title", "description" // columns in same order
)
// To write
.addForm(
"add_note",
"https://docs.google.com/forms/d/e/1FAIpQLSdmavg6P4eZTmIu-0M7xF_z-qDCHdpGebX8MGL43HSGAXcd3w/viewform?usp=sf_link" // form link
)
.build()
// Building OkHttpClient
val okHttpClient = OkHttpClient.Builder()
.addInterceptor(retrosheetInterceptor) // and attaching interceptor
.build()
val moshi = Moshi.Builder().build()
// Building retrofit client
val retrofit = Retrofit.Builder()
// with baseUrl as sheet's public URL
.baseUrl("https://docs.google.com/spreadsheets/d/1YTWKe7_mzuwl7AO1Es1aCtj5S9buh3vKauKCMjx1j_M/") // Sheet's public URL
// and attach previously created OkHttpClient
.client(okHttpClient)
.addConverterFactory(MoshiConverterFactory.create(moshi))
.build()
// Now create the API interface
val notesApi = retrofit.create(NotesApi::class.java)
// Reading notes
println(notesApi.getNotes())
// Adding note
val addNote = notesApi.addNote(
AddNoteRequest("Dynamic Note 1", "Dynamic Desc 1")
)
println(addNote)
Unit
}
Samples
🌠
- Notes - JVM
- README Example
👆
- README Example
- Notes - Android - Android App : Simple note taking app, with add and list feature
- Nemo - Android App : E-Commerce App
- More JVM Samples
TODO
☑️
- Create an online tool to generate model class from sheet link
Contributing
This project is applying ktlint (without import ordering since it's conflicted with IDE's format). Before creating a PR, please make sure your code is aligned with ktlint (./gradlew ktlint). We can run auto-format with:
./gradlew ktlintFormat
Author
✍️
- theapache64
![[ImgBot] Optimize images](https://avatars.githubusercontent.com/in/4706?v=4)
51 Jan 3, 2023
1 May 12, 2022
54 Nov 8, 2022
0 Jul 13, 2022
118 Dec 25, 2022
3.9k Dec 31, 2022
1.4k Dec 29, 2022
269 Dec 1, 2022
35 Dec 10, 2022
13 Aug 29, 2022
14 Dec 2, 2022
67 Mar 29, 2022
2 Jan 7, 2022
4 Jun 15, 2022
3.7k Dec 14, 2022
1.6k Jan 4, 2023
1.5k Dec 9, 2022