Merge pull request #20 from line/axios

Use axios instead of got

Author: Hyunje Jun

docs/pages/api-reference/client.md

@@ -15,7 +15,7 @@ class Client {
   replyMessage(replyToken: string, messages: Message | Message[]): Promise<{}>
   multicast(to: string[], messages: Message | Message[]): Promise<{}>
   getProfile(userId: string): Promise<Profile>
-  getMessageContent(messageId: string): ReadableStream
+  getMessageContent(messageId: string): Promise<ReadableStream>
   leaveGroup(groupId: string): Promise<{}>
   leaveRoom(roomId: string): Promise<{}>
 }
@@ -100,25 +100,27 @@ client.getProfile('user_id').then((profile) => {
 });
 ```
 
-### `getMessageContent(messageId: string): ReadableStream`
+### `getMessageContent(messageId: string): Promise<ReadableStream>`
 
 It corresponds to the [Content](https://devdocs.line.me/en/#content) API.
 
 The argument is an ID of media messages, such as image, video, and audio. The ID
 can be retrieved from a message object of a message event.
 
-Please beware that what it returns is not a promise, but a [readable stream](https://nodejs.org/dist/latest/docs/api/stream.html#stream_readable_streams).
+Please beware that what it returns is promise of [readable stream](https://nodejs.org/dist/latest/docs/api/stream.html#stream_readable_streams).
 You can pipe the stream into a file, an HTTP response, etc.
 
 ``` js
-const stream = client.getMessageContent('message_id')
-
-stream.on('data', (chunk) => {
-  ...
-})
-stream.on('error', (err) => {
-  ...
-})
+client.getMessageContent('message_id')
+  .then((stream) => {
+    stream.on('data', (chunk) => {
+      ...
+    })
+    stream.on('error', (err) => {
+      ...
+    })
+    stream.pipe(...)
+  })
 ```
 
 ### `leaveGroup(groupId: string): Promise<{}>`

docs/pages/api-reference/exceptions.md

@@ -28,7 +28,7 @@ class SignatureValidationFailed extends Error {
 }
 
 class JSONParseError extends Error {
-  public raw: string;
+  public raw: any;
 }
 
 class RequestError extends Error {

lib/client.ts

@@ -46,7 +46,7 @@ export default class Client {
     return this.get(URL.roomMemberProfile(roomId, userId));
   }
 
-  public getMessageContent(messageId: string): NodeJS.ReadableStream {
+  public getMessageContent(messageId: string): Promise<NodeJS.ReadableStream> {
     return this.stream(URL.content(messageId));
   }
 
@@ -70,7 +70,7 @@ export default class Client {
     return post(url, this.authHeader(), body);
   }
 
-  private stream(url: string): NodeJS.ReadableStream {
+  private stream(url: string): Promise<NodeJS.ReadableStream> {
     return stream(url, this.authHeader());
   }
 }

lib/exceptions.ts

@@ -1,52 +1,46 @@
-import * as got from "got";
-
 export class SignatureValidationFailed extends Error {
-  public signature: string;
-
-  constructor(msg: string, signature: string) {
-    super(msg);
-    this.signature = signature;
+  constructor(
+    message: string,
+    public signature: string,
+  ) {
+    super(message);
   }
 }
 
 export class JSONParseError extends Error {
-  public raw: string;
-
-  constructor(msg: string, raw: string) {
-    super(msg);
-    this.raw = raw;
+  constructor(
+    message: string,
+    public raw: any,
+  ) {
+    super(message);
   }
 }
 
 export class RequestError extends Error {
-  public code: string;
-  private origin: Error;
-
-  constructor(gotErr: RequestError) {
-    super(gotErr.message);
-    this.code = gotErr.code;
-    this.origin = gotErr;
+  constructor(
+    message: string,
+    public code: string,
+    private originalError: Error,
+  ) {
+    super(message);
   }
 }
 
 export class ReadError extends Error {
-  private origin: Error;
-
-  constructor(gotErr: ReadError) {
-    super(gotErr.message);
-    this.origin = gotErr;
+  constructor(
+    private originalError: Error,
+  ) {
+    super(originalError.message);
   }
 }
 
 export class HTTPError extends Error {
-  public statusCode: number;
-  public statusMessage: string;
-  private origin: Error;
-
-  constructor(gotErr: HTTPError) {
-    super(gotErr.message);
-    this.statusCode = gotErr.statusCode;
-    this.statusMessage = gotErr.statusMessage;
-    this.origin = gotErr;
+  constructor(
+    message: string,
+    public statusCode: number,
+    public statusMessage: string,
+    private originalError: Error,
+  ) {
+    super(message);
   }
 }

lib/http.ts

@@ -1,4 +1,4 @@
-import * as got from "got";
+import axios, { AxiosError } from "axios";
 import {
   HTTPError,
   JSONParseError,
@@ -8,21 +8,31 @@ import {
 
 const pkg = require("../package.json"); // tslint:disable-line no-var-requires
 
-function parseJSON(raw: string): any {
-  try {
-    return JSON.parse(raw);
-  } catch (err) {
-    throw new JSONParseError(err.message, raw);
+function checkJSON(raw: any): any {
+  if (typeof raw === "object") {
+    return raw;
+  } else {
+    throw new JSONParseError("Failed to parse response body as JSON", raw);
   }
 }
 
-function wrapError(err: Error) {
-  if (err instanceof got.RequestError) {
-    throw new RequestError(err as any);
-  } else if (err instanceof got.ReadError) {
-    throw new ReadError(err as any);
-  } else if (err instanceof got.HTTPError) {
-    throw new HTTPError(err as any);
+function wrapError(err: AxiosError) {
+  if (err.response) {
+    throw new HTTPError(
+      err.message,
+      err.response.status,
+      err.response.statusText,
+      err,
+    );
+  } else if (err.code) {
+    throw new RequestError(
+      err.message,
+      err.code,
+      err,
+    );
+  } else if (err.config) {
+    // unknown, but from axios
+    throw new ReadError(err);
   }
 
   // otherwise, just rethrow
@@ -31,27 +41,27 @@ function wrapError(err: Error) {
 
 const userAgent = `${pkg.name}/${pkg.version}`;
 
-export function stream(url: string, headers: any): NodeJS.ReadableStream {
+export function stream(url: string, headers: any): Promise<NodeJS.ReadableStream> {
   headers["User-Agent"] = userAgent;
-  return got.stream(url, { headers });
+  return axios
+    .get(url, { headers, responseType: "stream" })
+    .then((res) => res.data as NodeJS.ReadableStream);
 }
 
 export function get(url: string, headers: any): Promise<any> {
   headers["User-Agent"] = userAgent;
-  return got
+
+  return axios
     .get(url, { headers })
-    .then((res: any) => parseJSON(res.body))
+    .then((res) => checkJSON(res.data))
     .catch(wrapError);
 }
 
-export function post(url: string, headers: any, body?: any): Promise<any> {
+export function post(url: string, headers: any, data?: any): Promise<any> {
   headers["Content-Type"] = "application/json";
   headers["User-Agent"] = userAgent;
-  return got
-    .post(url, {
-      body: JSON.stringify(body),
-      headers,
-    })
-    .then((res: any) => parseJSON(res.body))
+  return axios
+    .post(url, data, { headers })
+    .then((res) => checkJSON(res.data))
     .catch(wrapError);
 }