Add Pixelfed client

Author: h3poteto

example/typescript/src/pixelfed/authorization.ts

@@ -0,0 +1,44 @@
+import * as readline from 'readline'
+import generator, { OAuth } from 'megalodon'
+
+const rl: readline.ReadLine = readline.createInterface({
+  input: process.stdin,
+  output: process.stdout
+})
+
+const SCOPES: Array<string> = ['read', 'write', 'follow']
+const BASE_URL: string = process.env.PIXELFED_URL!
+
+let clientId: string
+let clientSecret: string
+
+const client = generator('pixelfed', BASE_URL)
+
+client
+  .registerApp('Test App', {
+    scopes: SCOPES
+  })
+  .then(appData => {
+    clientId = appData.client_id
+    clientSecret = appData.client_secret
+    console.log('Authorization URL is generated.')
+    console.log(appData.url)
+    console.log()
+    return new Promise<string>(resolve => {
+      rl.question('Enter the authorization code from website: ', code => {
+        resolve(code)
+        rl.close()
+      })
+    })
+  })
+  .then((code: string) => {
+    return client.fetchAccessToken(clientId, clientSecret, code)
+  })
+  .then((tokenData: OAuth.TokenData) => {
+    console.log('\naccess_token:')
+    console.log(tokenData.access_token)
+    console.log('\nrefresh_token:')
+    console.log(tokenData.refresh_token)
+    console.log()
+  })
+  .catch((err: Error) => console.error(err))

example/typescript/src/pixelfed/instance.ts

@@ -0,0 +1,9 @@
+import generator, { Entity, Response } from 'megalodon'
+
+const BASE_URL: string = process.env.PIXELFED_URL!
+
+const client = generator('pixelfed', BASE_URL)
+
+client.getInstance().then((res: Response<Entity.Instance>) => {
+  console.log(res.data)
+})

example/typescript/src/pixelfed/timeline.ts

@@ -0,0 +1,11 @@
+import generator, { MegalodonInterface, Entity, Response } from 'megalodon'
+
+const BASE_URL: string = process.env.PIXELFED_URL!
+
+const access_token: string = process.env.PIXELFED_ACCESS_TOKEN!
+
+const client: MegalodonInterface = generator('pixelfed', BASE_URL, access_token)
+
+client.getPublicTimeline().then((resp: Response<Array<Entity.Status>>) => {
+  console.log(resp.data)
+})

megalodon/src/detector.ts

@@ -47,7 +47,7 @@ type Metadata = {
  * @param proxyConfig Proxy setting, or set false if don't use proxy.
  * @return SNS name.
  */
-export const detector = async (url: string): Promise<'mastodon' | 'pleroma' | 'friendica' | 'firefish' | 'gotosocial'> => {
+export const detector = async (url: string): Promise<'mastodon' | 'pleroma' | 'friendica' | 'firefish' | 'gotosocial' | 'pixelfed'> => {
   const options: AxiosRequestConfig = {
     timeout: 20000
   }
@@ -73,6 +73,8 @@ export const detector = async (url: string): Promise<'mastodon' | 'pleroma' | 'f
           return 'firefish'
         case 'mastodon':
           return 'mastodon'
+        case 'pixelfed':
+          return 'pixelfed'
         case 'pleroma':
           return 'pleroma'
         case 'sharkey':
@@ -101,6 +103,8 @@ export const detector = async (url: string): Promise<'mastodon' | 'pleroma' | 'f
           return 'firefish'
         case 'mastodon':
           return 'mastodon'
+        case 'pixelfed':
+          return 'pixelfed'
         case 'pleroma':
           return 'pleroma'
         case 'sharkey':
@@ -129,6 +133,8 @@ export const detector = async (url: string): Promise<'mastodon' | 'pleroma' | 'f
           return 'firefish'
         case 'mastodon':
           return 'mastodon'
+        case 'pixelfed':
+          return 'pixelfed'
         case 'pleroma':
           return 'pleroma'
         case 'sharkey':

megalodon/src/index.ts

@@ -5,6 +5,7 @@ import generator, { MegalodonInterface, WebSocketInterface } from './megalodon'
 import { detector } from './detector'
 import Mastodon from './mastodon'
 import Pleroma from './pleroma'
+import Pixelfed from './pixelfed'
 import Firefish from './firefish'
 import Gotosocial from './gotosocial'
 import Entity from './entity'
@@ -23,6 +24,7 @@ export {
   FilterContext,
   Mastodon,
   Pleroma,
+  Pixelfed,
   Firefish,
   Gotosocial,
   Entity

megalodon/src/mastodon/api_client.ts

@@ -368,7 +368,7 @@ namespace MastodonAPI {
      * Get connection and receive websocket connection for Pleroma API.
      *
      * @param url Streaming url.
-     * @param stream Stream name, please refer: https://git.pleroma.social/pleroma/pleroma/blob/develop/lib/pleroma/web/mastodon_api/mastodon_socket.ex#L19-28
+     * @param stream Stream name
      * @returns WebSocket, which inherits from EventEmitter
      */
     public socket(url: string, stream: string, params?: string): Streaming {

megalodon/src/mastodon/web_socket.ts

@@ -27,8 +27,8 @@ export default class Streaming extends EventEmitter implements WebSocketInterfac
   private _pongWaiting: boolean = false
 
   /**
-   * @param url Full url of websocket: e.g. https://pleroma.io/api/v1/streaming
-   * @param stream Stream name, please refer: https://git.pleroma.social/pleroma/pleroma/blob/develop/lib/pleroma/web/mastodon_api/mastodon_socket.ex#L19-28
+   * @param url Full url of websocket: e.g. https://mastodon.social/api/v1/streaming
+   * @param stream Stream name
    * @param accessToken The access token.
    * @param userAgent The specified User Agent.
    */

megalodon/src/megalodon.ts

@@ -6,6 +6,7 @@ import Entity from './entity'
 import Friendica from './friendica'
 import Firefish from './firefish'
 import Gotosocial from './gotosocial'
+import Pixelfed from './pixelfed'
 
 export interface WebSocketInterface {
   start(): void
@@ -1436,14 +1437,14 @@ export class NodeinfoError extends Error {
 /**
  * Get client for each SNS according to megalodon interface.
  *
- * @param sns Name of your SNS, `mastodon`, `pleroma`, `firefish`, or `gotosocial`.
+ * @param sns Name of your SNS, `mastodon`, `pleroma`, `firefish`, `gotosocial`, or `pixelfed`.
  * @param baseUrl hostname or base URL.
  * @param accessToken access token from OAuth2 authorization
  * @param userAgent UserAgent is specified in header on request.
  * @return Client instance for each SNS you specified.
  */
 const generator = (
-  sns: 'mastodon' | 'pleroma' | 'friendica' | 'firefish' | 'gotosocial',
+  sns: 'mastodon' | 'pleroma' | 'friendica' | 'firefish' | 'gotosocial' | 'pixelfed',
   baseUrl: string,
   accessToken: string | null = null,
   userAgent: string | null = null
@@ -1469,6 +1470,10 @@ const generator = (
       const gotosocial = new Gotosocial(baseUrl, accessToken, userAgent)
       return gotosocial
     }
+    case 'pixelfed': {
+      const pixelfed = new Pixelfed(baseUrl, accessToken, userAgent)
+      return pixelfed
+    }
   }
 }