PixelDroid-App-Android/app/src/main/java/com/h/pixeldroid/api/PixelfedAPI.kt

package com.h.pixeldroid.api

import com.h.pixeldroid.objects.*
import io.reactivex.Observable
import io.reactivex.Single
import okhttp3.MultipartBody
import retrofit2.Call
import retrofit2.Retrofit
import retrofit2.adapter.rxjava2.RxJava2CallAdapterFactory
import retrofit2.converter.gson.GsonConverterFactory
import retrofit2.http.*
import retrofit2.http.Field

/*
    Implements the Pixelfed API
    https://docs.pixelfed.org/technical-documentation/api-v1.html
    However, since this is mostly based on the Mastodon API, the documentation there
    will be more useful: https://docs.joinmastodon.org/
 */

interface PixelfedAPI {


    companion object {
        @Deprecated(
            "Use the DI-d PixelfedAPIHolder instead",
            ReplaceWith("apiHolder.api")
        )
        fun create(baseUrl: String): PixelfedAPI {
            return Retrofit.Builder()
                .baseUrl(baseUrl)
                .addConverterFactory(GsonConverterFactory.create())
                .addCallAdapterFactory(RxJava2CallAdapterFactory.create())
                .build().create(PixelfedAPI::class.java)
        }
    }


    @FormUrlEncoded
    @POST("/api/v1/apps")
    fun registerApplication(
        @Field("client_name") client_name: String,
        @Field("redirect_uris") redirect_uris: String,
        @Field("scopes") scopes: String? = null,
        @Field("website") website: String? = null
    ): Single<Application>


    @FormUrlEncoded
    @POST("/oauth/token")
    fun obtainToken(
        @Field("client_id") client_id: String,
        @Field("client_secret") client_secret: String,
        @Field("redirect_uri") redirect_uri: String,
        @Field("scope") scope: String? = "read",
        @Field("code") code: String? = null,
        @Field("grant_type") grant_type: String? = null
    ): Single<Token>

    // get instance configuration
    @GET("/api/v1/instance")
    fun instance() : Single<Instance>

    /**
     * Instance info from the Nodeinfo .well_known (https://nodeinfo.diaspora.software/protocol.html) endpoint
     */
    @GET("/.well-known/nodeinfo")
    fun wellKnownNodeInfo() : Single<NodeInfoJRD>

    /**
     * Instance info from [NodeInfo] (https://nodeinfo.diaspora.software/schema.html) endpoint
     */
    @GET
    fun nodeInfoSchema(
            @Url nodeInfo_schema_url: String
    ) : Call<NodeInfo>

    @FormUrlEncoded
    @POST("/api/v1/accounts/{id}/follow")
    fun follow(
        //The authorization header needs to be of the form "Bearer <token>"
        @Path("id") statusId: String,
        @Header("Authorization") authorization: String,
        @Field("reblogs") reblogs : Boolean = true
    ) : Call<Relationship>

    @POST("/api/v1/accounts/{id}/unfollow")
    fun unfollow(
        //The authorization header needs to be of the form "Bearer <token>"
        @Path("id") statusId: String,
        @Header("Authorization") authorization: String
    ) : Call<Relationship>

    @POST("api/v1/statuses/{id}/favourite")
    fun likePost(
        //The authorization header needs to be of the form "Bearer <token>"
        @Header("Authorization") authorization: String,
        @Path("id") statusId: String

    ) : Call<Status>

    @POST("/api/v1/statuses/{id}/unfavourite")
    fun unlikePost(
        //The authorization header needs to be of the form "Bearer <token>"
        @Header("Authorization") authorization: String,
        @Path("id") statusId: String
    ) : Call<Status>

    @POST("/api/v1/statuses/{id}/favourited_by")
    fun postLikedBy(
        @Path("id") statusId: String
    ) : Call<List<Account>>

    //Used in our case to post a comment or a status
    @FormUrlEncoded
    @POST("/api/v1/statuses")
    fun postStatus(
        //The authorization header needs to be of the form "Bearer <token>"
        @Header("Authorization") authorization: String,
        @Field("status") statusText : String,
        @Field("in_reply_to_id") in_reply_to_id : String? = null,
        @Field("media_ids[]") media_ids : List<String> = emptyList(),
        @Field("poll[options][]") poll_options : List<String>? = null,
        @Field("poll[expires_in]") poll_expires : List<String>? = null,
        @Field("poll[multiple]") poll_multiple : List<String>? = null,
        @Field("poll[hide_totals]") poll_hideTotals : List<String>? = null,
        @Field("sensitive") sensitive : Boolean? = null,
        @Field("spoiler_text") spoiler_text : String? = null,
        @Field("visibility") visibility : String = "public",
        @Field("scheduled_at") scheduled_at : String? = null,
        @Field("language") language : String? = null
    ) : Call<Status>

    @FormUrlEncoded
    @POST("/api/v1/statuses/{id}/reblog")
    fun reblogStatus(
        @Header("Authorization") authorization: String,
        @Path("id") statusId: String,
        @Field("visibility") visibility: String? = null
    ) : Call<Status>

    @POST("/api/v1/statuses/{id}/unreblog")
    fun undoReblogStatus(
        @Path("id") statusId: String,
        @Header("Authorization") authorization: String
    ) : Call<Status>

    //Used in our case to retrieve comments for a given status
    @GET("/api/v1/statuses/{id}/context")
    fun statusComments(
        @Path("id") statusId: String,
        @Header("Authorization") authorization: String? = null
    ) : Call<Context>

    @GET("/api/v1/timelines/public")
    fun timelinePublic(
        @Query("local") local: Boolean? = null,
        @Query("max_id") max_id: String? = null,
        @Query("since_id") since_id: String? = null,
        @Query("min_id") min_id: String? = null,
        @Query("limit") limit: String? = null
    ): Call<List<Status>>

    @GET("/api/v1/timelines/home")
    fun timelineHome(
        //The authorization header needs to be of the form "Bearer <token>"
        @Header("Authorization") authorization: String,
        @Query("max_id") max_id: String? = null,
        @Query("since_id") since_id: String? = null,
        @Query("min_id") min_id: String? = null,
        @Query("limit") limit: String? = null,
        @Query("local") local: Boolean? = null
    ): Call<List<Status>>

    @GET("/api/v2/search")
    fun search(
        //The authorization header needs to be of the form "Bearer <token>"
        @Header("Authorization") authorization: String,
        @Query("account_id") account_id: String? = null,
        @Query("max_id") max_id: String? = null,
        @Query("min_id") min_id: String? = null,
        @Query("type") type: Results.SearchType? = null,
        @Query("exclude_unreviewed") exclude_unreviewed: Boolean? = null,
        @Query("q") q: String,
        @Query("resolve") resolve: Boolean? = null,
        @Query("limit") limit: String? = null,
        @Query("offset") offset: Int? = null,
        @Query("following") following: Boolean? = null
    ): Call<Results>

    /*
    Note: as of 0.10.8, Pixelfed does not seem to respect the Mastodon API documentation,
    you *need* to pass one of the so-called "optional" arguments. See:
    https://github.com/pixelfed/pixelfed/blob/dev/app/Http/Controllers/Api/ApiV1Controller.php
    An example that works: specify min_id as 1 (not 0 though)
     */
    @GET("/api/v1/notifications")
    fun notifications(
        //The authorization header needs to be of the form "Bearer <token>"
        @Header("Authorization") authorization: String,
        @Query("max_id") max_id: String? = null,
        @Query("since_id") since_id: String? = null,
        @Query("min_id") min_id: String? = null,
        @Query("exclude_types") limit: String? = null,
        @Query("account_id") exclude_types: Boolean? = null
    ): Call<List<Notification>>

    @GET("/api/v1/accounts/verify_credentials")
    fun verifyCredentials(
        //The authorization header needs to be of the form "Bearer <token>"
        @Header("Authorization") authorization: String
        ): Call<Account>

    @GET("/api/v1/accounts/{id}/statuses")
    fun accountPosts(
        @Header("Authorization") authorization: String,
        @Path("id") account_id: String? = null
    ): Call<List<Status>>

    @GET("/api/v1/accounts/relationships")
    fun checkRelationships(
        @Header("Authorization") authorization : String,
        @Query("id[]") account_ids : List<String>
    ) : Call<List<Relationship>>

    @GET("/api/v1/accounts/{id}/followers")
    fun followers(
        @Path("id") account_id: String,
        @Header("Authorization") authorization: String,
        @Query("max_id") max_id: String? = null,
        @Query("since_id") since_id: String? = null,
        @Query("limit") limit: Number? = null
    ) : Call<List<Account>>

    @GET("/api/v1/accounts/{id}/following")
    fun following(
        @Path("id") account_id: String,
        @Header("Authorization") authorization: String,
        @Query("max_id") max_id: String? = null,
        @Query("since_id") since_id: String? = null,
        @Query("limit") limit: Number? = 40
    ) : Call<List<Account>>

    @GET("/api/v1/accounts/{id}")
    fun getAccount(
        @Header("Authorization") authorization: String,
        @Path("id") accountId : String
    ): Call<Account>

    @GET("/api/v1/statuses/{id}")
    fun getStatus(
        @Header("Authorization") authorization: String,
        @Path("id") accountId : String
    ): Call<Status>

    @Multipart
    @POST("/api/v1/media")
    fun mediaUpload(
        //The authorization header needs to be of the form "Bearer <token>"
        @Header("Authorization") authorization: String,
        @Part file: MultipartBody.Part
    ): Observable<Attachment>

    // get discover
    @GET("/api/v2/discover/posts")
    fun discover(
        @Header("Authorization") authorization: String
    ) : Call<DiscoverPosts>
}