Merge pull request #3 from 9renpoto/master

refactor: format and tests
Pull requestsありがとうございました。

Author: ToMGitHubN

.github/workflows/node.js.yml

@@ -0,0 +1,31 @@
+# This workflow will do a clean install of node dependencies, cache/restore them, build the source code and run tests across different versions of node
+# For more information see: https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions
+
+name: Node.js CI
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [12.x, 14.x, 16.x]
+        # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Use Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v2
+      with:
+        node-version: ${{ matrix.node-version }}
+        cache: 'npm'
+    - run: npm ci
+    - run: npm run build --if-present
+    - run: npm test

.gitignore

@@ -1,2 +1,122 @@
-/node_modules
-# setting.yaml
+### https://raw.github.com/github/gitignore/cdd9e946da421758c6f42c427c7bc65c8326155d/Node.gitignore
+
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+.pnpm-debug.log*
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+*.lcov
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# Snowpack dependency directory (https://snowpack.dev/)
+web_modules/
+
+# TypeScript cache
+*.tsbuildinfo
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Microbundle cache
+.rpt2_cache/
+.rts2_cache_cjs/
+.rts2_cache_es/
+.rts2_cache_umd/
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variables file
+.env
+.env.test
+.env.production
+
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+.parcel-cache
+
+# Next.js build output
+.next
+out
+
+# Nuxt.js build / generate output
+.nuxt
+dist
+
+# Gatsby files
+.cache/
+# Comment in the public line in if your project uses Gatsby and not Next.js
+# https://nextjs.org/blog/next-9-1#public-directory-support
+# public
+
+# vuepress build output
+.vuepress/dist
+
+# Serverless directories
+.serverless/
+
+# FuseBox cache
+.fusebox/
+
+# DynamoDB Local files
+.dynamodb/
+
+# TernJS port file
+.tern-port
+
+# Stores VSCode versions used for testing VSCode extensions
+.vscode-test
+
+# yarn v2
+.yarn/cache
+.yarn/unplugged
+.yarn/build-state.yml
+.yarn/install-state.gz
+.pnp.*
+
+

.husky/pre-commit

@@ -0,0 +1,4 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+npx lint-staged

README.md

@@ -1,10 +1,9 @@
-# gcs-basic-authとは
+# gcs-basic-auth とは
 
-
-gcs-basic-authは、Google Cloud Storage(以下、GCS)のファイルをBasic認証をつけて公開するためプログラムです。
+gcs-basic-auth は、Google Cloud Storage(以下、GCS)のファイルを Basic 認証をつけて公開するためプログラムです。
 Google App Engine(以下、GAE)にデプロイして使用します。
 
-GAEにアクセスされるとBasic認証を表示し、認証されるとリバースプロキシのように動いてGCSのファイルをユーザに転送します。
+GAE にアクセスされると Basic 認証を表示し、認証されるとリバースプロキシのように動いて GCS のファイルをユーザに転送します。
 
 # How it works
 
@@ -24,19 +23,18 @@ env_variables:
   BASIC_AUTH_PASSWORD: 'hoge_password'#<-Basic認証で入力させたいパスワード
 ```
 
-3.GAEのstandard(node)にデプロイ
+3.GAE の standard(node)にデプロイ
 
-4.GAEにアクセスして表示を確認
+4.GAE にアクセスして表示を確認
 
-表示されない場合、IAMの権限が足りているか、stackDrive Loggingページを確認します。
+表示されない場合、IAM の権限が足りているか、stackDrive Logging ページを確認します。
 
 ```
 Management (IAM) API has not been used in project
 ```
 
 などが、出ているときは指示に従って権限を追加します。
 
-
 # その他設定系
 
 ```yaml
@@ -72,27 +70,27 @@ env_variables:
 
 ### 転送モードについて
 
-設定のTRANSFER_MODE(転送モード)について説明します。
+設定の TRANSFER_MODE(転送モード)について説明します。
 
-転送の基本的な動きは、ユーザがアクセスすると、GAEが `GCS->GAE->ブラウザ/ユーザ` と流れます。
-ただし、GAEのstandardは60秒しか動作しないため、巨大ファイルだと転送が間に合わない可能性があります。
-そこで、GCSの署名付きURL(一定期間のみ使用可能なURL)を使い、ファイル転送をGCSから行います。
+転送の基本的な動きは、ユーザがアクセスすると、GAE が `GCS->GAE->ブラウザ/ユーザ` と流れます。
+ただし、GAE の standard は 60 秒しか動作しないため、巨大ファイルだと転送が間に合わない可能性があります。
+そこで、GCS の署名付き URL(一定期間のみ使用可能な URL)を使い、ファイル転送を GCS から行います。
 転送の流れが、 `GAE->(署名付きURL)->ブラウザ->(リダイレクト)->GCS->(ファイル転送)->ブラウザ` とすることで巨大ファイルの問題を解決できます。
-また、GCS->GAEと経由するより直接転送したほうが安くなります。
-ただし、HTMLを署名付きURLで取得すると、正常に機能しません。
-URLがGCSになるため、HTMLはGCSを起点にファイルを取得しようとし、失敗します。
-これは、CSSやJSにも当てはまります。
+また、GCS->GAE と経由するより直接転送したほうが安くなります。
+ただし、HTML を署名付き URL で取得すると、正常に機能しません。
+URL が GCS になるため、HTML は GCS を起点にファイルを取得しようとし、失敗します。
+これは、CSS や JS にも当てはまります。
 
-どのファイルをGCS署名付きURLを使うかの設定が転送モードです。
+どのファイルを GCS 署名付き URL を使うかの設定が転送モードです。
 
-+ TRANSFER_MODE: 'ALL_DIRECT' => すべてのファイルはGAEを経由して転送
-+ TRANSFER_MODE: 'ALLOW_DIRECT' => ALLOW_DIRECT_LISTに記載したファイルのみGAEを経由して転送
-+ TRANSFER_MODE: 'ALLOW_REDIRECT' => ALLOW_REDIRECT_LISTに記載されていないファイルをGAEを経由して転送
+- TRANSFER_MODE: 'ALL_DIRECT' => すべてのファイルは GAE を経由して転送
+- TRANSFER_MODE: 'ALLOW_DIRECT' => ALLOW_DIRECT_LIST に記載したファイルのみ GAE を経由して転送
+- TRANSFER_MODE: 'ALLOW_REDIRECT' => ALLOW_REDIRECT_LIST に記載されていないファイルを GAE を経由して転送
 
-ALLOW_DIRECT_LISTと、ALLOW_REDIRECT_LISTには、対象としたいファイルの拡張子を記載下さい。
+ALLOW_DIRECT_LIST と、ALLOW_REDIRECT_LIST には、対象としたいファイルの拡張子を記載下さい。
 
-また、署名付きURLの有効時間は、GCS_URL_LIFETIMEで設定できます。(初期値:1時間)
+また、署名付き URL の有効時間は、GCS_URL_LIFETIME で設定できます。(初期値:1 時間)
 
-GAE転送する必要があり、60秒で間に合わない場合は、
+GAE 転送する必要があり、60 秒で間に合わない場合は、
 `app.yaml`の`env: standard` => `env: flexible`に変更することで接続時間を伸ばせます。
 ただし、サーバスケールが分速に遅くなるので、ある程度サーバ台数を確保しておく必要があります。

SECURITY.md

@@ -0,0 +1,21 @@
+# Security Policy
+
+## Supported Versions
+
+Use this section to tell people about which versions of your project are
+currently being supported with security updates.
+
+| Version | Supported          |
+| ------- | ------------------ |
+| 5.1.x   | :white_check_mark: |
+| 5.0.x   | :x:                |
+| 4.0.x   | :white_check_mark: |
+| < 4.0   | :x:                |
+
+## Reporting a Vulnerability
+
+Use this section to tell people how to report a vulnerability.
+
+Tell them where to go, how often they can expect to get an update on a
+reported vulnerability, what to expect if the vulnerability is accepted or
+declined, etc.

app.yaml

@@ -2,4 +2,4 @@ runtime: nodejs10
 env: standard
 instance_class: F2
 includes:
-- setting.yaml
+  - setting.yaml