(Ruby)クライアントからwebapiにリクエストを送るプログラムを作りたい。

Question

下記の課題に取り組むために事前学習

QiitaでWebAPI調査し、非公開記事にまとめています。
→ web apiの学習まとめ
その上で、下記課題に取り組んでいます。

解決したい課題

以下WebAPI3つ使って、ある「利用者ID」を与えて「利用者名」・「登録クラブ一覧」・「登録クラブポイント(point)」の出力プログラムをオブジェクト指向プログラミングで設計/実装しなさい。(URLは無効なURLです)

https://riko-19950120.herokuapp.com/users/1

/*レスポンス（例）*/
  {
    attributes: {
      id: 1,
      name: "Rico",
      club_ids: [
        1,
        3,
        5
      ]
    }
  }

https://riko-19950120.herokuapp.com/users/1/clubs

/*レスポンス（例）*/
[
  {
    attributes: {
      id: 1,
      user_id: 1,
      name: "ライザップクラブ",
      point: 15000
    }
  },
  {
    attributes: {
      id: 3,
      user_id: 1,
      name: "シックスパッドクラブ",
      point: 13000
    }
  },
  {
    attributes: {
      id: 5,
      user_id: 1,
      name: "ゴールドジムクラブ",
      point: 52000
    }
  }
]

https://riko-19950120.herokuapp.com/clubs/2

/*レスポンス（例）*/
{
  attributes: {
    id: 2,
    user_id: 2,
    name: "ビリーズブートキャンプクラブ",
    point: 2300
  }
}

自分なりの回答

require 'net/http'
require 'openssl'
require 'uri'
require 'json'
require 'logger'

TIMEOUT_SECOND = 10

# HTTPSに使う時に必要？？(今は横に置いておきました...。)
# url                = '' 
# https              = Net::HTTP.new(url,443)
# https.use_ssl      = true
# https.open_timeout = TIMEOUT_SECOND
# https.read_timeout = TIMEOUT_SECOND
# https.verify_mode  = OpenSSL::SSL::VERIFY_PEER
# https.verify_depth = 5

# Qiitaで見たメソッドをアレンジ)
def get_json(location,limit=10)

  raise ArgumentError, 'too many HTTP redirects' if limit == 0
  uri = URI.parse(location)

  begin
    response = Net::HTTP.start(uri.host,uri.port,use_ssl:uri.scheme == 'https') do |http|
      http.open_timeout = TIMEOUT_SECOND
      http.read_timeout = TIMEOUT_SECOND
      http.get(uri.request_uri)
    end

    case response
    when Net::HTTPSuccess
      json = response.body
      JSON.parse(json)

      ######## ここで「利用者名」・「登録クラブ一覧」・「登録クラブポイント(point)」を？ ####
      
      
    when Net::HTTPRedirection
      location = response['location']
      warn "redirected to #{location}"
      get_json(location, limit - 1)
    else
      puts [uri.to_s, response.value].join(" : ")
      # handle error
    end
  rescue => e
    puts [uri.to_s,e.class,e].join(":")
  end
end

puts get_json('****URL??****')

んー...色々まだ考えることがありそうです。。。

困っていること...。

わからないこと
オブジェクト指向での実装	オブジェクト志向の内容は理解をしていますが、プログラムに落とし込むことができていません。
設問の「ある『利用者ID』を与えて」...の文言	引数idをどのように与えるように実装すればよいのか。クラスのイニシャライズに与えるべきか、メソッドに与えるべきなのかわかりません。

ご助言頂ける方、よろしくお願いします。

Answer 1

考えることが多すぎると、なかなか手が動かなかったりしますよね

「目的が何か」に依るところがありますが、簡素なものでもいいので1つ1つ動くものを作っていき、それらが協調して動くように、全体的に作っていってしまうのもよいかもしれません

たとえば今だとクライアント側のコードはあっても、サーバ側のコードがない(?)ので、それを先に作ってしまうのも手だと思います

# sinatra.rb
require 'sinatra'
require 'json'

# 指定URL の get 通信に応答する
# get ブロック内では params['id'] で実際の値が採れる
get '/users/:id' do
  # Note: 初期段階なので値は固定、他のことは考えない
  # TODO: クライアント側の実装が終わったら変動id 値で応答できるよう、メソッドに切り出し、ないしデータベースとの連携を検討する
  {
    attributes: {
      id: 1,
      name: 'Rico',
      club_ids: [
        1,
        2,
        5
      ]
    }
  }.to_json
end

# get '/users/:id/clubs' do
# ...

ruby sinatra.rb # => localhost:4567 で待ち受け開始

そして次はクライアント側の設計をし、実装をし、そしてまた サーバ側はどんなURL 形式、リソースの区切り方にするかの設計をし、サーバ側のコードを簡単に実装し、その次は... と、設計と実装の二人三脚をしていく...

最初から完璧を目指すのではなく、「作っては壊す」を素早く繰り返すことで、常に動く状態のものを1歩ずつ考えながら進めていくことができると思います

そうすれば自ずと、「ここの処理はメソッドに切り出して まとめたほうが良いかな」「このメソッド群はぜんぶユーザ関連だからクラスにまとめよう」という具合に、外の振る舞い(≒設計)に合わせて、内部のコードも整っていくように思います

何か参考になれば幸いです

Links

• lostisland/faraday: Simple, but flexible HTTP client library, with support for multiple backends. - GitHub
• sinatra/sinatra: Classy web-development dressed in a DSL (official / canonical repo) - GitHub

Comments

[退会済みユーザー]

goufさんありがとうございます！１つ１つ砕いて少しずつ進めてみます。