【園木】料金シミュレーションAPIの開発 #37

ysk91 · 2023-04-10T07:51:52Z

やったこと

API開発
- rates.ymlにデータ作成
- costs_controller.rbにindexアクションとcalculate_rateアクションを作成
  - indexアクションではrates.ymlの内容をjsonで返す
  - calculate_rateアクションでは入力値から料金計算の結果をjsonで返す
テスト設計
- costs_controller.rbのリクエストspecを作成
UI開発
- simulations_controller.rbにinputアクションとoutputアクションを作成
  - inputアクションでは契約アンペア数と使用量を入力
  - outputアクションでは入力値からapiを叩いた結果を表に出力
本番環境構築
- URL: https://enechange-challenge.onrender.com
  - 契約アンペア数, 使用量を入力することで料金シミュレーションの結果を取得
- API用URL
  - プラン一覧取得: https://enechange-challenge.onrender.com/api/v1/costs
  - 料金シミュレーション: https://enechange-challenge.onrender.com/api/v1/costs/calculate_rate?contract_ampere=30&usage=100
    - 契約アンペア: 30A, 使用量: 100kWh の例

課題

UIのデザイン

yournameディレクトリ名を変更

mochikichi · 2023-04-11T07:33:11Z

@ysk91
プルリク提出ありがとうございます！
ひとまず対応お疲れさまでした。

内容はこれから確認させていただきますが、ざっと見たところ、料金計算ロジックに対するテストが記載されておりませんでしたので追加お願いします。
弊社ではテストも重要視しているためよろしくおねがいします。

ysk91 · 2023-04-11T08:48:22Z

@mochikichi

ご指摘いただきありがとうございます。
本件以下コミットにて対応いたしました。
c80a8db
ご確認をお願いします。

keishi1129 · 2023-04-12T16:31:45Z

serverside_challenge_1/challenges/sonoki/app/controllers/api/v1/costs_controller.rb

+                    price: total_cost
+                  }
+      end
+      render json: costs.to_json, status: 200


間違っていたらすみません。to_jsonって必要ですか。

costs自体が既にハッシュなので不要でした。
修正しました。
ysk91@7913bdf#diff-bebb16eb4b12378fcb91ff5afb5e43b378eb34c711f2a332446da3b0f13f8619R49

keishi1129 · 2023-04-12T16:33:21Z

serverside_challenge_1/challenges/sonoki/app/controllers/api/v1/costs_controller.rb

+  private
+
+  def yaml_path
+    Rails.root.join('config', 'rates.yml')


リクエスト来るたびに読み込むのは遅くなる原因になりますね

yaml_pathをコントローラ内でメモ化しました。
ysk91@7913bdf#diff-bebb16eb4b12378fcb91ff5afb5e43b378eb34c711f2a332446da3b0f13f8619R56

yaml_data自体をメモ化しました。
9286a10#diff-bebb16eb4b12378fcb91ff5afb5e43b378eb34c711f2a332446da3b0f13f8619R54

今はcosts_controllerの中で定義していますが、進める中で最適な場所を考えてみます。

keishi1129 · 2023-04-12T16:34:34Z

serverside_challenge_1/challenges/sonoki/app/controllers/simulations_controller.rb

+    usage = params[:usage]
+
+    if usage == "0"
+      render "input"


好みですが

Suggested change

render "input"

render :input

修正しました。
29d409f#diff-feb71b51f115d4dc122999f84a58fffda21b371b56e43d2cc617f3c84d49cd9aR13

keishi1129 · 2023-04-12T16:36:17Z

serverside_challenge_1/challenges/sonoki/app/controllers/simulations_controller.rb

+      end
+      data = JSON.parse(response.body)
+      @results = data
+      render "output"


render "output" っていりますか？

不要でした。修正しました。
ysk91@7913bdf#diff-feb71b51f115d4dc122999f84a58fffda21b371b56e43d2cc617f3c84d49cd9aL23

keishi1129 · 2023-04-12T16:41:56Z

serverside_challenge_1/challenges/sonoki/app/views/simulations/input.html.erb

+<%= form_with url: output_simulations_path, method: :get, local: true do |f| %>
+  <div>
+    <%= f.label :contract_ampere, '契約アンペア数' %>
+    <%= f.select :contract_ampere, [10, 15, 20, 30, 40, 50, 60], required: true %>A


[10, 15, 20, 30, 40, 50, 60]をviewにベタ書きするのは微妙ですね。
いろんなところにベタ書きが増えていき、メンテナンスが大変になりそうなので何処かにまとめておきたいです。

コントローラ内に変数として定義しました。
29d409f#diff-feb71b51f115d4dc122999f84a58fffda21b371b56e43d2cc617f3c84d49cd9aR31

keishi1129 · 2023-04-12T16:44:29Z

serverside_challenge_1/challenges/sonoki/enechange_challenge_keypair.pem

+SWVDjQKBgQCpqFddnSmatf6oQ/4u1DtGOsE53aRnhxyGr66LwdThD30af4r+6d92
+7kZEDXcm3flAjzkpWNd2ifxOkxL8IPP88Twdhy9L/z2wK8Kg5iK4rB2MXwgwuYJV
+2VpWWL4BOd2syhXG98zoU2tTASYMGeOSJVgnw/O8VjSqIcuHqYecBw==
+-----END RSA PRIVATE KEY-----


これってなんの値でしょうか。
security的に、PRにあげていいものでしょうか。

AWSにアップしようとした時に作成したkeypairです。
gitignoreする前にcommitしたものが残っていました。
今はRenderにアップしているのでこのファイルは不要です。
削除しました。
8897705

mochikichi · 2023-04-13T11:31:49Z

serverside_challenge_1/challenges/sonoki/app/controllers/api/v1/costs_controller.rb

+    usage = params[:usage].to_i
+    rates = YAML.load_file(yaml_path)
+
+    if contract_ampere.zero? || usage.zero?


リクエスト
契約アンペア数 : 10 / 15 / 20 / 30 / 40 / 50 / 60 のいずれかとする。（単位A）

上記の仕様があるので、フロント側制御のみではなく、サーバーサイド(API側)でバリデーションを入れたほうが良いですね

突貫対応ですが、表示するプランが無い場合にinputに戻すようにしました。
ただ、

本質的な解決ではない

if節が増えてあまり美しくない

ので、より改善が必要だと感じています。。
29d409f#diff-feb71b51f115d4dc122999f84a58fffda21b371b56e43d2cc617f3c84d49cd9aR23

mochikichi · 2023-04-13T11:38:15Z

serverside_challenge_1/challenges/sonoki/config/rates.yml

+    50: 1430.00
+    60: 1716.00
+  usage_rates:
+    - range: [1, 120]


データベースに保存するとしたらどのような構造にするのが良いでしょうか？

Company has_many :plans という親子関係を作ります。

Companyには最低限以下のカラムを用意します。

id

name

Planには以下のカラムを用意します。

id

company_id

name

basic_rates

usage_rates

PostgreSQLを使用している場合

マイグレーションファイルを以下のように設定することでbasic_ratesにJSONデータを、usage_ratesに配列データを格納することができます。

t.json :basic_rates t.string :usage_rates, array: true, default: []

MySQLやSQLiteを使用している場合

マイグレーションファイルでテキスト型のデータを作成します。

t.text :basic_rates t.text :usage_rates

その後、モデルファイルでシリアライズします。

serialize :basic_rates, JSON serialize :usage_rates, Array

一例として、東京電力エナジーパートナーの従量電灯Bプランの場合、
basic_rates = {
10: 286.00,
15: 429.00,
20: 572.00,
30: 858.00,
40: 1144.00,
50: 1430.00,
60: 1716.00,
}

usage_rates = [
{range: [1, 120], rate: 19.88},
{range: [121, 300], rate: 26.48},
{range: [301, "inf"], rate: 30.57}
]
というデータを格納します。
コントローラファイルでは現在と同様の計算メソッドが使用できます。

参考

https://dev.classmethod.jp/articles/postgresql-14-supports-json-subscripting/

https://qiita.com/yodog712/items/e3098eef8b494ab62fbd

ありがとうございます！
カラムに配列型を使うメリット・デメリットを調べてみると勉強になると思います

th5o · 2023-04-13T15:03:59Z

serverside_challenge_1/challenges/sonoki/node_modules/@popperjs/core/LICENSE.md

@@ -0,0 +1,20 @@
+The MIT License (MIT)


node_modules は git 管理したほうがいいでしょうか？

th5o · 2023-04-13T15:08:13Z

serverside_challenge_1/challenges/sonoki/app/controllers/api/v1/costs_controller.rb

+
+    if contract_ampere.zero? || usage.zero?
+      render json: { error: 'Invalid input: contract_ampere and usage are required' }, status: 400
+    else


else ブロックがメソッドの大部分を占めてネストが深くなってますが、
ネストを浅く読みやすくする方法はないでしょうか？

レビュー対応

keishi1129 · 2023-04-25T01:19:49Z

@ysk91
迅速な修正ありがとうございます！モデル化もできたらしてみてください。プログラムが書きやすくなるはずですので数段レベルアップすると思います。連絡いただければ私レビューしますので！

計算ロジックをCostモデルに持たせた

レビューコメントを追加

ysk91 · 2023-05-09T06:59:17Z

@ysk91 迅速な修正ありがとうございます！モデル化もできたらしてみてください。プログラムが書きやすくなるはずですので数段レベルアップすると思います。連絡いただければ私レビューしますので！

@keishi1129

コミット内容

Planモデルの作成
- 3627c85
- テスト: 680b96f
Queryモデルの作成
- 21fd2a2
- テスト: 3737b92

学習メモ

Planモデルについて

当初、PlanモデルとPlansLoaderモジュールが同じように思えてyamlデータをモデル化するメリットが分かりませんでした。
しかし、以下のように役割を分けることで、メリットがあることが分かりました。

役割分担
- PlansLoaderモジュール: yamlデータを呼び出す(メモ化含む)
- Planモデル: 呼び出したyamlデータに対する処理をメソッドとして定義する
メリット
- Planモデル内でyamlデータの操作をメソッド化することで、他のモデルやコントローラからの呼び出しが容易になる
  - 今は全てのプランを呼び出すだけだが、プランにidを付与してPlanモデル内でfind_planメソッドのようなものを定義すれば特定のプランだけ計算することができる

Queryモデルについて

Costモデル内のバリデーション処理をQueryモデルに持たせました。
これにより、Costモデルを計算ロジックに専念させることができました。
また、バリデーションテストをquery_specにまとめることでcost_specがスッキリしたように感じます。

質問

@mochikichi

現在、api_requests_spec.rbにて計算結果が正しいことをテストしていますが、プランが変更した場合などに書き換える必要があり、DRYでないように感じます。
以前面接内で「検算シートは不要」とおっしゃっていましたが、その方法が分かりません。
何かヒントになるキーワードを教えて頂けますでしょうか？

keishi1129 · 2023-05-10T23:22:21Z

@ysk91
早速モデル化に挑戦していただきありがとうございます。PlanモデルとPlansLoaderモジュールを分けるメリットですがおっしゃる通りかと思います。またQueryモデルの導入も素晴らしいと思います。実際業務で使われているシミュレーションAPIも同様なモデルが存在しております。

また以下の質問にも答えてしまいますと、プランが変更したときにテストを書き換える必要が出てくることこそテストの意味があるのです。とある変更して、期待通りテストが落ちてしまうことで、それまでテストが機能していたことの証明になるためです。

現在、api_requests_spec.rbにて計算結果が正しいことをテストしていますが、プランが変更した場合などに書き換える必要があり、DRYでないように感じます。

常々思いますが、疑問に思う点やそれを自己で解決されようとしている点が非常に素晴らしいなと思います。入社後もどんどん吸収していってください！

ysk91 and others added 18 commits March 30, 2023 20:04

apiを新規立ち上げ

aee4829

costs_controllerを作成

afe70ce

indexページでjsonを返す

3fe4056

calculate_rateアクションを作成

1b95b10

出力を配列で返せるようにした

6e7ce0f

使用量別に計算可能

3c4de07

存在しない契約アンペアの処理を追加

798e0c5

RSpecの初期設定

2777733

calculate_rateアクションのテストを作成

e4af252

indexアクションのRSpecを作成

94c6c2a

yamlデータを修正

283be08

入力画面を作成

aab3300

出力画面を作成

c03bdbc

API呼び出し用に環境変数を設定

a0f368f

Update README.md

ef1e167

本番環境に向けて修正

e6392c0

yournameディレクトリ名を変更

f4e43cf

Merge pull request #1 from ysk91/sonoki

346c0b8

yournameディレクトリ名を変更

ysk91 changed the title ~~【課題提出】料金シミュレーションAPIの開発~~ 【園木】料金シミュレーションAPIの開発 Apr 11, 2023

ysk91 and others added 7 commits April 11, 2023 10:02

renderにアップロード用に設定

8d58403

rake assetsをコメントアウト

d31c565

rootパスを設定

2382ffa

outputアクションでhttpsリクエストを送るように設定

1cce842

Update README.md

8409617

Update README.md

ca78969

webpackerをインストール

1cef839

ysk91 added 2 commits April 11, 2023 17:39

計算ロジックテストを追加

8deab3c

api計算テストを追加

c80a8db

keishi1129 reviewed Apr 12, 2023

View reviewed changes

mochikichi reviewed Apr 13, 2023

View reviewed changes

th5o reviewed Apr 13, 2023

View reviewed changes

ysk91 and others added 15 commits April 17, 2023 11:03

簡単なミスを修正

7913bdf

中度のレビューに対応

29d409f

Delete enechange_challenge_keypair.pem

8897705

differenceのタイポを修正

34df231

計算ロジックを修正

03973bc

key.to_s問題を解決

3311907

usageがzeroのとき値を返す

faaea65

usage=0のテスト作成

9fad181

yaml_dataをメモ化

9286a10

Merge pull request #2 from ysk91/review

0121ded

レビュー対応

計算ロジックをモデルに移動

a6a1031

契約アンペアのバリデーション追加

9b03c9f

UIでエラーを返す

a322123

Modelでyamldataを読み込み

c673ff9

cost_spec作成

dee4e2e

ysk91 and others added 3 commits May 9, 2023 12:58

Merge pull request #3 from ysk91/cost_model

e91353d

計算ロジックをCostモデルに持たせた

レビューコメント

35d5eec

Merge pull request #4 from ysk91/cost_model

447b728

レビューコメントを追加

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

【園木】料金シミュレーションAPIの開発 #37

【園木】料金シミュレーションAPIの開発 #37

ysk91 commented Apr 10, 2023 •

edited

Loading

mochikichi commented Apr 11, 2023

ysk91 commented Apr 11, 2023

keishi1129 Apr 12, 2023

ysk91 Apr 17, 2023

keishi1129 Apr 12, 2023

ysk91 Apr 17, 2023

ysk91 Apr 22, 2023

keishi1129 Apr 12, 2023

ysk91 Apr 17, 2023

keishi1129 Apr 12, 2023

ysk91 Apr 17, 2023

keishi1129 Apr 12, 2023

ysk91 Apr 17, 2023

keishi1129 Apr 12, 2023

ysk91 Apr 17, 2023

mochikichi Apr 13, 2023

ysk91 Apr 17, 2023

mochikichi Apr 13, 2023

ysk91 Apr 20, 2023 •

edited

Loading

mochikichi Apr 28, 2023

th5o Apr 13, 2023

th5o Apr 13, 2023

keishi1129 commented Apr 25, 2023 •

edited

Loading

ysk91 commented May 9, 2023 •

edited

Loading

keishi1129 commented May 10, 2023 •

edited

Loading

【園木】料金シミュレーションAPIの開発 #37

Are you sure you want to change the base?

【園木】料金シミュレーションAPIの開発 #37

Conversation

ysk91 commented Apr 10, 2023 • edited Loading

やったこと

課題

mochikichi commented Apr 11, 2023

ysk91 commented Apr 11, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ysk91 Apr 20, 2023 • edited Loading

Choose a reason for hiding this comment

PostgreSQLを使用している場合

MySQLやSQLiteを使用している場合

参考

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

keishi1129 commented Apr 25, 2023 • edited Loading

ysk91 commented May 9, 2023 • edited Loading

コミット内容

学習メモ

Planモデルについて

Queryモデルについて

質問

keishi1129 commented May 10, 2023 • edited Loading

ysk91 commented Apr 10, 2023 •

edited

Loading

ysk91 Apr 20, 2023 •

edited

Loading

keishi1129 commented Apr 25, 2023 •

edited

Loading

ysk91 commented May 9, 2023 •

edited

Loading

keishi1129 commented May 10, 2023 •

edited

Loading