Refactoring, access-control, github:get-contributors method

Author: ifedyukin

README.md

@@ -1,18 +1,23 @@
-# WebPurple VK-Provider
-[![Build Status](https://travis-ci.org/WebPurple/vk-provider.svg?branch=master)](https://travis-ci.org/WebPurple/vk-provider)
-[![License MIT](https://img.shields.io/github/license/mashape/apistatus.svg)](https://github.com/WebPurple/vk-provider/blob/master/LICENSE)
+# WebPurple Provider
+[![Build Status](https://travis-ci.org/WebPurple/provider.svg?branch=master)](https://travis-ci.org/WebPurple/provider)
+[![License MIT](https://img.shields.io/github/license/mashape/apistatus.svg)](https://github.com/WebPurple/provider/blob/master/LICENSE)
 
 
 ## Локальная работа
 ```sh
-git clone https://github.com/WebPurple/vk-provider.git
+git clone https://github.com/WebPurple/provider.git
 npm install
 npm run dev
 ```
 
 ## Методы
 ### Albums
-Возвращает информацию о фотографиях в альбоме
+Возвращает информацию о фотографиях в альбоме ВКонтакте
 ```
 GET /albums/:owner_id/:album_id/
-```
+```
+### Contributors
+Возвращает список "contributors" для репозитория GitHub
+```
+GET /contributors/:owner/:repo/
+```

package.json

@@ -1,7 +1,7 @@
 {
-  "name": "vk-provider",
+  "name": "webpurple-provider",
   "version": "0.0.1",
-  "description": "Requests provider for VK",
+  "description": "Requests provider service",
   "author": "Igor Fedyukin <[email protected]>",
   "license": "MIT",
   "scripts": {

src/app/app.controller.ts

@@ -1,13 +1,12 @@
-import { Get, Controller, Header, HttpCode } from '@nestjs/common';
+import { Get, Controller, HttpCode } from '@nestjs/common';
 
 @Controller()
 export class AppController {
   constructor() {}
 
   @Get()
-  @HttpCode(301)
-  @Header('Location', 'https://www.webpurple.net/')
+  @HttpCode(200)
   root(): string {
-    return 'Hello world!';
+    return 'WebPurple provider service is working...';
   }
 }

src/app/app.module.ts

@@ -1,9 +1,9 @@
 import { Module } from '@nestjs/common';
 import { AppController } from './app.controller';
-import { AlbumsModule } from '../modules/albums/albums.module';
+import { AlbumsModule, ContributorsModule } from '../modules';
 
 @Module({
-  imports: [AlbumsModule],
+  imports: [AlbumsModule, ContributorsModule],
   controllers: [AppController],
   providers: [],
 })

src/config.ts

@@ -1,6 +1,15 @@
 export const config = {
   port: process.env.PORT || 8080,
-  apiVersion: '5.80',
-  apiUrl: 'https://api.vk.com/method',
-  serviceToken: process.env.SERVICE_TOKEN,
+  access: {
+    origins: ['webpurple.netlify.com', 'webpurple.net'],
+    token: process.env.TOKEN,
+  },
+  vk: {
+    apiVersion: '5.80',
+    apiUrl: 'https://api.vk.com/method',
+    serviceToken: process.env.VK_SERVICE_TOKEN,
+  },
+  github: {
+    apiUrl: 'https://api.github.com',
+  },
 };

src/main.ts

@@ -1,9 +1,11 @@
 import { NestFactory } from '@nestjs/core';
 import { AppModule } from 'app/app.module';
 import { config } from 'config';
+import { accessChecker } from './middlewares';
 
 async function bootstrap() {
   const app = await NestFactory.create(AppModule);
+  app.use(accessChecker);
   await app.listen(config.port);
 }
 bootstrap();

src/middlewares/access-checker.ts

@@ -0,0 +1,18 @@
+import { config } from '../config';
+
+const { origins, token } = config.access;
+
+const isAllowOrigin = origin => origin && origins.some(o => origin.includes(o));
+
+export const accessChecker = (req, res, next) => {
+  const origin = req.get('origin');
+  const { token } = req.query;
+
+  if (isAllowOrigin(origin) || token === token) {
+    res.set('Access-Control-Allow-Origin', '*');
+    return next();
+  }
+
+  res.status(403);
+  res.send('Access denied!');
+};

src/middlewares/index.ts

@@ -0,0 +1 @@
+export { accessChecker } from './access-checker';

src/modules/albums/albums.controller.ts

@@ -1,15 +1,14 @@
 import { Get, Controller, Param, Header } from '@nestjs/common';
 import { IGetPhotosParams } from './interfaces/GetPhoto';
 import { GetPhotoDto } from '../common/dto/vk/get-photo.dto';
-import { VkService } from '../common/services/vk.service';
+import { VkService } from '../common/services';
 
 @Controller('albums')
 export class AlbumsController {
   constructor(private readonly service: VkService) {}
 
   @Get(':owner_id/:album_id')
   @Header('Content-Type', 'application/json')
-  @Header('Access-Control-Allow-Origin', 'http://webpurple.com')
   getPhotos(@Param() params: IGetPhotosParams): Promise<GetPhotoDto> {
     return this.service.getPhotos(params);
   }

src/modules/common/common.module.ts

@@ -1,8 +1,8 @@
 import { Module } from '@nestjs/common';
-import { VkService } from './services/vk.service';
+import { VkService, GithubService } from './services';
 
 @Module({
-  providers: [VkService],
-  exports: [VkService],
+  providers: [VkService, GithubService],
+  exports: [VkService, GithubService],
 })
 export class CommonModules {}

src/modules/common/dto/github/get-contributors.dto.ts

@@ -0,0 +1,32 @@
+export interface IContributors {
+  avatar_url: string;
+  contributions: number;
+  events_url: string;
+  followers_url: string;
+  following_url: string;
+  gists_url: string;
+  gravatar_id: string;
+  html_url: string;
+  id: number;
+  login: string;
+  node_id: string;
+  organizations_url: string;
+  received_events_url: string;
+  repos_url: string;
+  site_admin: boolean;
+  starred_url: string;
+  subscriptions_url: string;
+  type: string;
+  url: string;
+}
+
+export class GetContributorsDto {
+  public contributors: Array<IContributors>;
+  constructor(response) {
+    this.contributors = Array.isArray(response) ? response : [];
+  }
+
+  static of(response) {
+    return new GetContributorsDto(response);
+  }
+}

src/modules/common/services/github.service.ts

@@ -0,0 +1,20 @@
+import { Injectable } from '@nestjs/common';
+import { config } from '../../../config';
+import { GetContributorsDto } from '../dto/github/get-contributors.dto';
+import axios from 'axios';
+
+@Injectable()
+export class GithubService {
+  private API_URL = config.github.apiUrl;
+
+  public getContributors(params: { owner: string; repo: string }): Promise<GetContributorsDto> {
+    return axios
+      .get(`${this.API_URL}/repos/${params.owner}/${params.repo}/contributors`)
+      .then(response => response.data)
+      .then(GetContributorsDto.of)
+      .catch(e => {
+        console.error(e);
+        return null;
+      });
+  }
+}

src/modules/common/services/index.ts

@@ -0,0 +1,2 @@
+export { GithubService } from './github.service';
+export { VkService } from './vk.service';

src/modules/common/services/vk.service.ts

@@ -5,24 +5,24 @@ import axios from 'axios';
 
 @Injectable()
 export class VkService {
-  private SERVICE_TOKEN = config.serviceToken;
-  private API_URL = config.apiUrl;
-  private API_VERSION = config.apiVersion;
+  private SERVICE_TOKEN = config.vk.serviceToken;
+  private API_URL = config.vk.apiUrl;
+  private API_VERSION = config.vk.apiVersion;
 
   public getPhotos(params: { owner_id: string; album_id: string }): Promise<GetPhotoDto> {
     return axios
-      .get(`${this.API_URL}/photos/get`, {
+      .get(`${this.API_URL}/photos.get`, {
         params: {
           ...params,
           access_token: this.SERVICE_TOKEN,
           v: this.API_VERSION,
         },
       })
       .then(response => response.data.response)
+      .then(GetPhotoDto.of)
       .catch(e => {
         console.error(e);
         return null;
-      })
-      .then(GetPhotoDto.of);
+      });
   }
 }

src/modules/contributors/contributors.controller.ts

@@ -0,0 +1,15 @@
+import { Get, Controller, Param, Header } from '@nestjs/common';
+import { IGetContributorsParams } from './interfaces/GetContributors';
+import { GetContributorsDto } from '../common/dto/github/get-contributors.dto';
+import { GithubService } from '../common/services';
+
+@Controller('contributors')
+export class ContributorsController {
+  constructor(private readonly service: GithubService) {}
+
+  @Get(':owner/:repo')
+  @Header('Content-Type', 'application/json')
+  getContributors(@Param() params: IGetContributorsParams): Promise<GetContributorsDto> {
+    return this.service.getContributors(params);
+  }
+}

src/modules/contributors/contributors.module.ts

@@ -0,0 +1,9 @@
+import { Module } from '@nestjs/common';
+import { ContributorsController } from './contributors.controller';
+import { CommonModules } from '../common/common.module';
+
+@Module({
+  imports: [CommonModules],
+  controllers: [ContributorsController],
+})
+export class ContributorsModule {}

src/modules/contributors/interfaces/GetContributors.ts

@@ -0,0 +1,4 @@
+export interface IGetContributorsParams {
+  owner: string;
+  repo: string;
+}

src/modules/index.ts

@@ -0,0 +1,2 @@
+export { AlbumsModule } from './albums/albums.module';
+export { ContributorsModule } from './contributors/contributors.module';