[ruby]nilエラーを回避する方法

Question

やりたいこと

webAPIの基礎を学習したく、郵便番号APIからjsonデータを取得しrubyで住所を表示するプログラムを書く

Qiitaでこちらの非常にわかりやすい記事を参考にさせていただいた

JSONについてRubyを使用しながら簡単に解説してみる

まずはサンプルコード

require 'net/http' #標準ライブラリの呼び出し
require 'uri'
require "json" #jsonを使うためのライブラリ

#指定のURLにJSONデータをリクエストしている
res = Net::HTTP.get(URI.parse('http://zipcloud.ibsnet.co.jp/api/search?zipcode=6695221'))

#表示する
puts res

# 実行結果
{
    "message": null,
    "results": [
        {
            "address1": "兵庫県",
            "address2": "朝来市",
            "address3": "和田山町秋葉台",
            "kana1": "ﾋｮｳｺﾞｹﾝ",
            "kana2": "ｱｻｺﾞｼ",
            "kana3": "ﾜﾀﾞﾔﾏﾁｮｳｱｷﾊﾞﾀﾞｲ",
            "prefcode": "28",
            "zipcode": "6695221"
        }
    ],
    "status": 200
}

返ってきたjsonデータを確認することが可能。

もう少し実践的なプログラム

require 'net/http' 
require "json"
require 'uri'

#住所を返却する。無効な郵便番号に関してはメッセージを返す
def search_address(post_code)
  res = Net::HTTP.get(URI.parse("http://zipcloud.ibsnet.co.jp/api/search?zipcode=#{post_code}"))
  hash = JSON.parse(res)

#有効な郵便番号の判別
  if hash["status"] == 200
    #住所を返す
    return hash["results"][0].values.take(3).join("")
  else
    #エラーメッセージを返す
    return hash["message"]
  end
end

print "検索する郵便番号を入力してください(ハイフン無し):"
post_code = gets.chomp

#結果を表示する
puts search_address(post_code)

初心者にも非常にわかりやすい解説で関心したのだけど...

# 実行し、郵便番号1000001を入力してみる
$ ruby post.rb
検索する郵便番号を入力してください(ハイフンなし):1000001
# 実在する住居表示が出ました
東京都千代田区千代田

# 実行し、実在しない郵便番号0000000を入力してみる
$ ruby post.rb
検索する郵便番号を入力してください(ハイフンなし):0000000
# nilエラーが発生
Traceback (most recent call last):
	1: from post.rb:20:in `<main>'
post.rb:12:in `search_address': undefined method `[]' for nil:NilClass (NoMethodError)

あれ、条件分岐で有効な郵便番号を判別し、無効な郵便番号に対してはメッセージを返すのでは？
サンプルコードで、

{
    "message": null,
(省略)

となっていたことを思い出しましたが、

1. json形式で返ってきた"message"がnullなことによってnil:NilClassエラーが起こっている
2. 条件分岐が良くなくて、elsif でnilエラーを回避できていない
3. 写経のどこかでスペルミスが起こっている
4. それ以外

のどれかが考えられます（「それ以外」を選択肢に含めた時点で必ずどれかなのですが）。

実装したいもの

本当は、実在しない郵便番号を入力したらerrorではなくて"do not exist"とか"入力された値は無効です"などdのメッセージを表示してtrueにしたいです。

解決策は何かありますでしょうか？

Answer 1

nilなのかどうかをifで判断します。

return hash["results"][0].values.take(3).join("")
のところを、

if hash["results"]
  return hash["results"][0].values.take(3).join("")
else
  return "入力された値は無効です"
end

に。

Comments

[hiroshimaeasyry]

今回のような場合は["result"]が空かどうかの条件分岐をしないといけないということでした。
上のコードでちゃんと動きが確認できました、ありがとうございました。

Answer 2

実際に動かして試せてないですが、
＞2. 条件分岐が良くなくて、elsif でnilエラーを回避できていない
に該当していると思います。

下記APIのドキュメントを見ると、「入力パラメータエラー」または「API内部で発生したエラー」の場合に、エラー(statusが200以外)となるようです。
郵便番号検索API - zipcloud

上記APIドキュメントに明記されている箇所は見つけれませんでしたが、一般的に「入力パラメータエラー」とするのは、
・必須項目（今回の場合zipcode）が未指定
・入力値が形式不正（桁数がおかしい等）
の場合が多く、今回のように「0000000」の場合は、形式としては正しく、ただ該当する郵便番号データが存在しない、というだけなので、「入力パラメータエラー」とはしない可能性が高いです。

なので、郵便番号データが取得できたかどうかのチェック方法としては、statusを見るのではなく、resultが空かを見ると良いかと思います。

※明記されていない内容で実装するのが怖い場合は、API提供元に問い合わせすれば確実です。

Comments

[hiroshimaeasyry]

条件分岐の仕方としてはやはり["result"]が空かどうかを見たほうがよかったです。

・正しい入力に対して正しい住居表示
・存在しない値の入力に対して無効ですの表示
・桁不足の入力に対して無効の表示
・何も入力せず送信した結果無効の表示

とうまく分岐できるようになりました。ありがとうございました。