https://github.com/naohito-t/neams-api
rails6 api mode
https://github.com/naohito-t/neams-api
api docker rails6 ruby stripe
Last synced: 6 months ago
JSON representation
rails6 api mode
- Host: GitHub
- URL: https://github.com/naohito-t/neams-api
- Owner: naohito-T
- Created: 2022-01-09T05:28:54.000Z (over 4 years ago)
- Default Branch: develop
- Last Pushed: 2022-02-10T14:38:36.000Z (over 4 years ago)
- Last Synced: 2025-04-07T09:43:06.689Z (about 1 year ago)
- Topics: api, docker, rails6, ruby, stripe
- Language: Ruby
- Homepage:
- Size: 93.8 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Intorduction
開発環境での作成はrootディレクトリのREADME.mdを参照してください。
[README](../README.md)
## Herokuに設定する環境変数
Dockerを使わないRailsデプロイでは、以下の環境変数が自動で設定される。
- LANG: en_US.UTF-8（ランゲージ）
- RACK_ENV: production（ラックエンブ）
Rackへ現在の環境を示す変数
Rackとは … http送受信処理を担当するモジュールのこと。
- RAILS_ENV: production（レイルズ エンブ）
Railsへ現在の環境を示す変数
- RAILS_LOG_TO_STDOUT: enabled（ログ スタンダート アウト）
logを標準で出力するか否かのフラグ。enabled = 出力する。
- RAILS_SERVE_STATIC_FILES: enabled（サーバー スタティック ファイルズ）
publicディレクトリからの静的ファイルを提供してもらう（apiモードではあんま意味ないかも）
Docker経由の場合は、自分で本番用の環境変数を設定する必要がある。
LANGについては既にDockerfileで定義しているため、その他の環境変数をconfigに定義しています。
## How To deploy ?
$ tree -L 1
.
|-- Dockerfile
|-- Gemfile
|-- Gemfile.lock
|-- Makefile
|-- README.md
|-- Rakefile
|-- api
|-- app
| |-- model Controlleから渡させる。
|-- bin
|-- config
|-- config.ru
|-- db
|-- entrypoint.sh
|-- heroku.yml
|-- lefthook.yml
|-- lib
|-- log
|-- public
|-- storage
|-- test
|-- tmp
|-- .irbrc Rubyコンソールを実行する $libコマンド実行時に読み込まれる設定ファイル(Railsコンソール起動時にも読み込まれる)
`-- vendor
## db/migrate/*
マイグレーションファイルはテーブルの中身のカラムを作成するファイル
- マイグレーションファイル命名規則
tableを作成するやつ
create_tablename
columnを変更するやつ
change_tablename
## validation 設定確認
[参考](https://blog.cloud-acct.com/posts/u-rails-error-messages-jayml)
```sh
# api rails console へlogin
$ make api.console
# I18n.t("パス") ... 引数のパスで指定したymlファイルの値を返す。
$ I18n.t("activerecord.attributes.user")
=> {:name=>"名前", :email=>"メールアドレス", :password=>"パスワード", :activated=>"アクティブフラグ", :admin=>"管理者"}
```
## debug確認(binding.pry)
[参考](https://blog.cloud-acct.com/posts/u-rails-custom-eachvalidator)
止めたいコードのところでbinding.pryをするとコードが実行された時に止まる。
```ruby
def validate_each(record, attribute, value)
# debug
binding.pry # ここで止まる
end
```
- record
ユーザオブジェクト
- attribute
属性が入る。エラーメッセージにも使われる
- value
ユーザが入力した値が入る
## クラス宣言について
Zeitwerkの仕様に合ったクラスの宣言を
Rails6から導入されたオートロードシステムの「Zeitwerk（ツァイトベルク）」の仕様で、ファイルパスと一致するクラスを宣言しないと正しく読み込まれません。
つまり、
「servicers」以下のファイルパス =>「user_auth/auth_token.rb」と
クラスの宣言 => UserAuth::AuthToken を一致させる必要。
何も継承しないクラスを宣言する場合は、
「services」ディレクトリ直下にauth_token.rbを作成し、
その中でAuthTokenクラスを宣言すればOK