Ruby on Rails 6 で郵便番号住所検索な gem

JpAddressとは

日本郵便の「郵便番号データ（www.post.japanpost.jp/zipcode/dl/kogaki/zip/ken_all.zip）」を Rails 6.1 で使用するための gem です。以下の機能を提供します。

郵便局提供の郵便番号データをダウンロードして自前ＤＢのテーブル（jp_address_zipcodes）にロードするクラスメソッド。（JpAddress::Zipcode.load_master_data）
郵便番号を受け取り住所情報をJSONで返却するＡＰＩ（jp_address/zipcodes#search）。

要するに、「郵便番号住所検索 ruby gem」でググった人向けの gem です。お使いのRailsアプリケーションにマウントして使えますので、後必要なのは戻ってくるJSONを加工する手順だけです。

% gem install jp_address

GemFileに追記

gem 'jp_address'

テーブルの作成

% bundle exec rails jp_address:install:migrations
% bundle exec rails db:migrate

開発環境

% rails runner -e development 'JpAddress::Zipcode.load_master_data'

本番環境

% rails runner -e production 'JpAddress::Zipcode.load_master_data'

環境にもよりますが、１～３分ぐらいかかると思います。

※ APP_ROOT/tmp/ を作業ディレクトリに使用しています。※ 最初にテーブルをトランケートしますので、毎回「全件insert」になります。

マウントしたいRailsアプリの config/routes.rb に追記。

mount JpAddress::Engine, at: "/jp_address"

/jp_address にマウントした場合、下記URLへGETリクエストをすることで、JSONを取得できます。後はこれを好きに加工してテキストボックスなどにセットして使ってください。

get

フォームには

の３要素があり、#zipcodeに入れられた値を元にＡＰＩを叩き、#prefecture_id と #address に値をセットするサンプルです。

prefecture_id の選択は、都道府県名で行っています。なので、お使いの都道府県マスターのＩＤ値に影響を受けることなく選択できるはずです。

※ JQuery の存在を前提にしています。※ もともと CoffeeScript で書いてあったソースを decaffeinate したものです。

//