{"id":22246011,"url":"https://github.com/tonystrawberry/japan_postcoder","last_synced_at":"2025-03-25T11:23:31.878Z","repository":{"id":189939708,"uuid":"681609594","full_name":"tonystrawberry/japan_postcoder","owner":"tonystrawberry","description":"🏡 A Ruby gem for getting Japan address from postal code.","archived":false,"fork":false,"pushed_at":"2023-08-22T15:56:03.000Z","size":10257,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-04-26T07:22:46.135Z","etag":null,"topics":["address","gem","japan","ruby"],"latest_commit_sha":null,"homepage":"","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/tonystrawberry.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-08-22T11:34:46.000Z","updated_at":"2023-08-23T02:25:44.000Z","dependencies_parsed_at":"2024-12-03T05:28:25.688Z","dependency_job_id":null,"html_url":"https://github.com/tonystrawberry/japan_postcoder","commit_stats":null,"previous_names":["tonystrawberry/japan_postcoder"],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tonystrawberry%2Fjapan_postcoder","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tonystrawberry%2Fjapan_postcoder/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tonystrawberry%2Fjapan_postcoder/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tonystrawberry%2Fjapan_postcoder/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tonystrawberry","download_url":"https://codeload.github.com/tonystrawberry/japan_postcoder/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245450561,"owners_count":20617373,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["address","gem","japan","ruby"],"created_at":"2024-12-03T05:25:34.297Z","updated_at":"2025-03-25T11:23:31.840Z","avatar_url":"https://github.com/tonystrawberry.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n  \u003ca\u003e\n    \u003cimg src=\"https://static.vecteezy.com/system/resources/thumbnails/004/587/562/small_2x/doodle-freehand-drawing-of-japan-map-free-vector.jpg\" width=\"60\" /\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\u003ch1 align=\"center\"\u003e\n  🇯🇵 Japan Postcoder\n\u003c/h1\u003e\n\n[![Tests](https://github.com/tonystrawberry/japan_postcoder/workflows/Ruby/badge.svg)](https://github.com/tonystrawberry/japan_postcoder/actions/workflows/main.yml)\n\u003ca href=\"https://codeclimate.com/github/tonystrawberry/japan_postcoder/maintainability\"\u003e\u003cimg src=\"https://api.codeclimate.com/v1/badges/7362475ad52048cbbee1/maintainability\" /\u003e\u003c/a\u003e\n\u003ca href=\"https://codeclimate.com/github/tonystrawberry/japan_postcoder/test_coverage\"\u003e\u003cimg src=\"https://api.codeclimate.com/v1/badges/7362475ad52048cbbee1/test_coverage\" /\u003e\u003c/a\u003e\n[![Gem Version](https://badge.fury.io/rb/japan_postcoder.svg)](https://badge.fury.io/rb/japan_postcoder)\n\nJapan Postcoder is a library that allows you to get the address of a location in Japan from its postcode.\nIt will help you get the prefecture, city, ward and street name from a postcode.\n\nAll the location data is provided by the [Japan Post](https://www.post.japanpost.jp/zipcode/download.html)\n\nRubygems link is here: https://rubygems.org/gems/japan_postcoder\n\n# 🏃🏻 Getting started\n\nStart by including `japan-postcoder` in your project:\n\n```bash\ngem 'japan-postcoder'\n```\n\nThen, you can use the `JapanPostcoder` class to get the address of a location in Japan from its postcode:\n\n# 👨🏻‍💻 Usage\n\nYou can use the `JapanPostcoder` class to get the address of a location in Japan in **string** format.\n```ruby\nrequire 'japan-postcoder'\n\npostcode = '2140037'\naddress = JapanPostcoder.to_address(postcode)\n\nputs address # =\u003e \"神奈川県川崎市多摩区菅仙谷町\"\n```\n\nYou can also use the `JapanPostcoder` class to get the address of a location in Japan in **hash** format.\n```ruby\nrequire 'japan-postcoder'\n\npostcode = '2140037'\naddress = JapanPostcoder.to_address_hash(postcode)\n\nputs address # =\u003e {:prefecture=\u003e\"神奈川県\", :city=\u003e\"川崎市\", :ward=\u003e\"多摩区\", :district=\u003e\"菅仙谷町\"}\n```\n\n## 🇬🇧 Romaji transcription\n\nYou can use the `JapanPostcoder` class to get the address of a location in Japan in **romaji** format by using the `romaji` named argument.\n\n```ruby\naddress = JapanPostcoder.to_address('2140037', romaji: true)\nputs address # =\u003e \"KANAGAWA KEN KAWASAKI SHI TAMA KU SUGESEN YACHO\"\n```\n\n```ruby\naddress = JapanPostcoder.to_address_hash('2140037', romaji: true)\nputs address # =\u003e {:prefecture=\u003e\"KANAGAWA KEN\", :city=\u003e\"KAWASAKI SHI\", :ward=\u003e\"TAMA KU\", :district=\u003e\"SUGESEN YACHO\"}\n```\n\n# 💪 Contributing\n\nIf you notice a bug or want to add a new feature, please open an issue or submit a pull request.\nThank you and enjoy!\n\n# 📝 License\n\nThis project is free to use under the terms of the MIT License.\n\n# 📝 Self-memo\nAfter updating the gem:\n- Update the version in `lib/japan_postcoder/version.rb`\n- Create a PR and merge it after it's been approved \u0026 tested\n- Run `gem build japan_postcoder.gemspec`\n- Run `gem push japan_postcoder-\u003cversion\u003e.gem`\n- Run `gh release create \u003cversion\u003e`\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftonystrawberry%2Fjapan_postcoder","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftonystrawberry%2Fjapan_postcoder","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftonystrawberry%2Fjapan_postcoder/lists"}