[Rails]楽天等APIを使用したアプリの設計で適しているのは？

Question

前提・実現したいこと

楽天API等の外部APIを使用したアプリを作成しています。
現在の設計方針ではAPIを利用する機能をクラスにまとめています。
そして、アプリIDやApiKeyをクラス変数またはinitializeで設定して、それらをapiを使用するメソッドで使い回しています。

使用方法としては、Controllerのbefore_actionで上記のクラスのインスタンスを生成し、各アクションでそのインスタンスメソッドを呼び出しています。

規模は小さいので気にする必要がないかもしれませんが、もっと良い（適した）設計があれば教えていただきたいです。

試したこと

module化やconcernでの実装を考えたのですが、クラスで実装しているようにapikey設定を一ヶ所にまとめる方法が思い付きませんでした。

追記

発生するエラー：
Payjp::AuthenticationError: No API key provided. Set your API key using "Payjp.api_key = <API-KEY>".

現状の問題点

• コンソールで確認したところ、PayjpObject::Client.api_key=nilになっていました。
• PayjpObject::Client.request、PayjpObject::Subscription.createにはそれぞれ何を記載すれば良いのでしょうか
• PayjpObject::Subscription.createに引数を与えるにはどうすれば良いのでしょうか

PayjpのAPIを使用したソースコードは以下になります。

・config/initializers/payjp_object_client.rb

PayjpObject::Client.api_key = ENV["PAYJP_SECRET_KEY"];

・controllers/concerns/payjp_object/client.rb

module PayjpObject
  class Client
    class_attribute :api_key
    def self.request
      Payjp::Subscription.create
    end
  end
end

・controllers/concerns/payjp_object/subscription.rb

module PayjpObject
  class Subscription
    def self.create(attrs)
      Client.request(Payjp::Subscription.create).map { |attrs| Subscription.new attrs }
    end

    def find_by(attrs)
      Client.request(Payjp::Subscription.find_by).map { |attrs| Subscription.new attrs }
    end
  end
end

Answer 1

エラー：uninitialized constant PayjpObject

これは config/initializers/payjp_object_client.rb で発生しているってことで良いでしょうか？

autoloadが効いてないように思えます。payjp_object.rbというファイルを探してないから、uninitialized constantになっているように思えます。

concerns は extend ActiveSupport::Concern を設定して include するための関連の置き場です。少し使い方が違うように思えます。

Comments

[nobu09]

なるほど。
修正してみます。

Answer 2

このような記述方法はどこを参考にすれば良いのでしょうか？

特に書籍などがあった覚えはないですが、経験によるものが大きいかと思います。
なので、一番はやいのはGithubのRailsアプリをコードリーディングするのが一番ですね。

また、リクエストクラスとリソースクラスはなぜmodels配下なのでしょうか？

機能がcontrollerの補助的な役割と考えているので、controllers配下に配置した方が適しているように思いました。

一番はテストをしやすい事ですね。
それとコントローラーは名前のとおりコントロールするものです。
要は旗振りだけを担うものと自分は考えています。
controllerの「補助的な役割」という考え方も悪くないですが、補助的なものはAuthなど認証、認可などの許可するかを判断するものが正しいと考えます。

Comments

[nobu09]

非常にわかりやすい説明ありがとうございました。
とても勉強になりました。
どうもありがとうございます。

Answer 3

参考になれば良いですが、個人的にはできるだけ Rails way に乗っかる方法で実装することが多いですね。

楽天のAPI使ったことないので、適当ですが、例えばこんな感じで単一責任の原則に乗っかていけば自ずと良い設計になるのではないかと思います。

設定の初期化

config/initilaizers/rakuten_client.rb

Rakuten::Client.app_id = 'hoge';
Rakuten::Client.api_key = 'hoge';

リクエストクラス

app/models/rakuten/client.rb

module Rakuten
  class Client
    class_attribute :app_id, :api_key

    def self.request
      # ここでAPIをコールする
      return []
    end
  end
end

リソースクラス

app/models/rakuten/book.rb

module Rakuten
  class Book
    def search
      Client.request('https://rakuten/api/books').map { |attrs| Book.new attrs }
    end
  end
end

コントローラー

app/controllers/rakuten_books_controller.rb

class Rakuten::BooksController < ApplicationController
  def index
    @books = Rakuten::Book.search
  end
end

Comments

[nobu09]

ありがとうございます。
無事動作し、コードもスッキリしました。
このような記述方法はどこを参考にすれば良いのでしょうか？

また、リクエストクラスとリソースクラスはなぜmodels配下なのでしょうか？
機能がcontrollerの補助的な役割と考えているので、controllers配下に配置した方が適しているように思いました。

追記：
確認手順に問題がありました。
正しく実施したところエラーになってしまいました。
エラー：uninitialized constant PayjpObject

コードを追記しました。
よろしくお願いいたします。