🎉 initial

Author: 59naga

.gitignore

@@ -0,0 +1,7 @@
+Thumbs.db
+.DS_Store
+
+node_modules
+bower_components
+
+npm-debug.log

.travis.yml

@@ -0,0 +1,48 @@
+notifications:
+  email: false
+
+# Quick boot options
+sudo: false
+cache:
+  directories:
+    - node_modules
+
+# Ignore version tags
+branches:
+  except:
+    - /^v[0-9]/
+
+# Language options
+language: node_js
+before_install:
+  - if [[ `npm -v` != 3* ]]; then npm i -g npm@3; fi
+node_js:
+  - 4
+before_script:
+  - npm prune
+script:
+  - npm run build
+  - npm run test
+  - npm run lint
+
+# Npm publish options
+deploy:
+  skip_cleanup: true # keep the devDependencies
+  provider: npm
+  email: i59naga@icloud.com
+  api_key:
+    secure: Y+nt75BAkBSshHgS/FCjC7BBmtadNyFmcT5PTEjFxneLpW5SBPe/58iUhxkt5xSDZbxr1l7TH+eOgROxmHx13OROuCUcWrK3m4tbHBbiaI3GcQ7hCEfpnqWeUF53seqDabikypttHcYmELJtW1H+il6U2U5YwPDrEuSOGhnmx1yoZOZ6DCXuLSi/JgLhCY9m7AuvckH40B/7kGMad58Df81EKZYM37/icuG85pWgCoJcPIV1XoF3KTl5T9rPn9pxLdx25xBB/P4tjJ7v+gKuiKiVBJTSpTtlJEQCba/1dWNH1q1/305cgJ/16PlMs0yENQxwVxtcyHpXoULHb0WnGf6Y3YsjG23N/b0GFtgC/lvH/+PBmvbinguu4vrSk53gxqPyZX2+vyvHAtcYN2cssVMe0D3RmPC95U24qeNZ3sqo6w8/C7dk+UjkaBs2/6dUxF0buUmE+iyOmCMQgSiphsGgoqtqCus/qt7vxs6LpIHl/AB+HabQFMMDd0vn091HrFZSxErIr7a57xI7eWcMXPC2sfa2xBu1i5pOWEEb7r8lYnkrCuOjN46/d2VlfFDhLMqqOSvykvrIksSTvHthwPzkaTsNq37/rZmzi+rBs57b3Otvo1EEy2Hcop7FcwBUc/BkrFMPrpV16/IO9Z+V7zilny+kOn+WU238oG6ifM8=
+  on:
+    node: 4
+
+# SAUCE_TOKENS
+env:
+  global:
+    - secure: k9rExG3Ze2gpJGcIVUL3uxlLmXUQeSdoOWb14EzJhxnCxJ8BrU1Ne5GkeM490eNfvWljbmATLeOmB6fHM+tN5/b/4L5b0ow6yLwOKSgCZNg8A5z1rnuZTzpA3O1LPeQ2KQGWMz08UR5i6zbgXiqHUAZM4yGmBBiH0Pje07e0MSPToyyzAFFAkT3Vg52H9djYTf09mdFftXlryobs2Z6cEzzsNRFBVdakRNlsqrdxoWYrTYWPhx/Fknuh7v0yOFjSpg5lLOIAudbzdUKb5lRvZMEtSvQOugbxmImdPesRqfZIGMDhL+LAWHIpB0A4UzPFek89uvkgMkSORm4t8OFGQh8Jjh0SszuWT21mveUvH4NWFU/uyqZaepSmCFvFV0Py6257OKYW3k/rCaRku4Bj9VFHU9gS3dWnPC3dtwXo+/Xg2M9zqx8egKjXPFPeaFQ8q1k43ZqDO7NAnukeHFLe6RaDFRVPv4CUeckohhFnkP4zh3R2AUo+txGAZSwiNnRmyInh8Bmz38VtIyPu2iHcPUyXSfru0nnMpIfVRO3anX2RuIF5CzOIhZ1gp8RcKnxxj/DV5iXv/CshG0TKKuCDlEclic0QTKqBjDX3HBCrAS0IXSTefZgLx8d/V5YWmK7x/BOaOiV5vVzsRHhsxCUqFoyycrlIMAWySsK6K/v0VBo=
+    - secure: H4ksxBKRcHUax9hWAXuKLUMrD3qdYTQgNu8qmQ7L7/9dpv8k0MStbm52ZLkna2rBUE112HzQBwT3o8wzxLFDOkAoPiktl62eE6kuhJIV/TlYPnf5ADglFSp4AX84bdJkWaGuLSA8dDaOBbTnERwRhlaKTUJzxaCgB1/pkThmZO25bP6Pxi7OnGSQ23K1OdKzXITOiAdQ4AtBq+Fi/ECjQNpT6o3IaiTfZ8Q/FgFb5izBLsbbALs7HFJ9loNqPhVaZJ8RUcEM1vRuYd4gjVoegzbsUwZYz7QYipDWVb9+TKsDUp76XLjNdMDlPG1V//YR09hkpvgIpW9+3lxn1aumrhYa1ULgxWGt685yRJHOUx0FBJmjjWbKRfl2rrxdAlMZ5xig9oJlGaay/16aqSAED/wdwQlIJKq1Jhg7mcEIBLoLHSPCeZ3mO0pafUBwWhPBclKJG4lA0HaWdeN0XLX0II7cWFG5Zj/8hjgq5OZrB5gx91PHZCsvvmRkoT3mr2blpfx3eFGDxkE02qQ+fjVAIOAuu6L5Ftab9g6SARo5H9m5dhKoRX8dvKaNlwMS+a9pkb470X3TNnTFF1QlrNsHQoJlQrflPJjAmbkd2hnq6nkR/03+YVslERXa7yOgS7oVx0EjDf2QG2s+ugoQAoXqeR0aVIqUL4H6uIWZQWj7SxU=
+
+# Cloud testing
+after_deploy:
+  - npm install
+  - npm run setup
+  - npm run test-cloud

.zuul.yml

@@ -0,0 +1,20 @@
+# See: https://github.com/defunctzombie/zuul/wiki/zuul.yml
+ui: mocha-bdd
+browsers:
+  - name: chrome
+    version: latest
+  - name: ie
+    version: 9..latest
+  - name: firefox
+    version: latest
+  - name: safari
+    version: latest
+  - name: iphone
+    version: latest
+  - name: ipad
+    version: latest
+  - name: android
+    version: 4.1..latest
+
+browserify:
+  - transform: brfs

README.md

@@ -0,0 +1,124 @@
+`zipcode-ja`
+---
+
+<p align="right">
+  <a href="https://npmjs.org/package/zipcode-ja">
+    <img src="https://img.shields.io/npm/v/zipcode-ja.svg?style=flat-square">
+  </a>
+  <a href="https://travis-ci.org/59naga/zipcode-ja">
+    <img src="http://img.shields.io/travis/59naga/zipcode-ja.svg?style=flat-square">
+  </a>
+  <a href="https://codeclimate.com/github/59naga/zipcode-ja/coverage">
+    <img src="https://img.shields.io/codeclimate/github/59naga/zipcode-ja.svg?style=flat-square">
+  </a>
+  <a href="https://codeclimate.com/github/59naga/zipcode-ja">
+    <img src="https://img.shields.io/codeclimate/coverage/github/59naga/zipcode-ja.svg?style=flat-square">
+  </a>
+  <a href="https://gemnasium.com/59naga/zipcode-ja">
+    <img src="https://img.shields.io/gemnasium/59naga/zipcode-ja.svg?style=flat-square">
+  </a>
+</p>
+
+<p align="center">
+  <a href="https://saucelabs.com/u/59798">
+    <img src="http://soysauce.berabou.me/u/59798/zipcode-ja.svg">
+  </a>
+</p>
+
+[日本郵便 平成28年5月31日更新 郵便番号データ](http://www.post.japanpost.jp/zipcode/dl/kogaki-zip.html) NodeJS / ブラウザ用 JavaScript
+
+インストール
+---
+
+**NodeJS**
+```bash
+npm install zipcode-ja --save
+```
+
+```js
+import zipcodeJa from 'zipcode-ja';
+console.log(zipcodeJa.version, zipcodeJa.lastModified); // '0.0.0', '2016-05-31'
+```
+
+**ブラウザ**（[Download Latest](https://npmcdn.com/zipcode-ja/lib/zipcode-ja.js)）
+```html
+<script src="https://npmcdn.com/zipcode-ja/lib/zipcode-ja.js"></script>
+<script>
+console.log(zipcodeJa.version, zipcodeJa.lastModified); // '0.0.0', '2016-05-31'
+</script>
+```
+
+使用方法
+---
+
+`zipcodeJa`は、一つの巨大なオブジェクトです。実在する住所をキーとして与えると、対応する住所を返します。
+
+```js
+console.log(zipcodeJa['1000002']);
+// {
+//   zipcode: '1000002',
+//   zipcodeOld: '100',
+//   jisX0402: '13101',
+//   address: [
+//     '東京都',
+//     '千代田区',
+//     '皇居外苑'
+//   ],
+//   ruby: [
+//     'とうきょうと',
+//     'ちよだく',
+//     'こうきょがいえん'
+//   ],
+//   status: [
+//     0,
+//     0,
+//     0,
+//     0,
+//     0,
+//     0
+//   ]
+// }
+```
+
+それぞれのプロパティは、元データである[郵便番号データの説明](http://www.post.japanpost.jp/zipcode/dl/readme.html)の情報に対応しています。
+
+* `zipcode` … `郵便番号（7桁）`
+* `zipcodeOld` … `（旧）郵便番号（5桁）`
+* `jisX0402` … `全国地方公共団体コード（JIS X0401、X0402）`
+* `address` … `都道府県名／漢字`, `市区町村名／漢字`, `町域名／漢字`
+* `ruby` … `都道府県名／半角カタカナ`, `市区町村名／半角カタカナ`, `町域名／半角カタカナ`
+* `status`
+  0. `一町域が二以上の郵便番号で表される場合の表示`
+  1. `小字毎に番地が起番されている町域の表示`
+  2. `丁目を有する町域の場合の表示`
+  3. `一つの郵便番号で二以上の町域を表す場合の表示`
+  4. `更新の表示`
+  5. `変更理由`
+
+注意事項として
+  * `address`の`町域名`が「以下に掲載がない場合」を「」に置換
+  * `ruby`は半角カタカナではなく、全角ひらがなに置換
+を行っています。これは、他のスクリプトから利用する際の手順を省略するための調整です。
+
+他のライブラリとの差異
+---
+* [AjaxZip3/yubinbango](https://github.com/ajaxzip3/ajaxzip3.github.io#readme) と違い、DOM依存を行わない
+* [japan-postal-code](https://github.com/mzp/japan-postal-code#readme) と違い、コールバック関数を用いない
+
+開発環境
+---
+下記が[グローバルインストール](https://github.com/creationix/nvm#readme)されていることが前提です。
+* NodeJS v6.2.1
+* Npm v3.9.3 (or [pnpm](https://github.com/rstacruz/pnpm))
+
+```bash
+git clone https://github.com/59naga/zipcode-ja
+cd zipcode-ja
+npm install
+
+npm test
+```
+
+License
+---
+[MIT](http://59naga.mit-license.org/)

index.js

@@ -0,0 +1,4 @@
+var buffer = require('fs').readFileSync(__dirname + '/lib/zipcode-ja.json.gz');
+var inflate = require('pako').inflate;
+
+module.exports = JSON.parse(inflate(buffer, {to: 'string'}));

lib/.gitignore

@@ -0,0 +1,2 @@
+*
+!.gitignore

package.json

@@ -0,0 +1,60 @@
+{
+  "name": "zipcode-ja",
+  "version": "0.0.0",
+  "description": "zipcodes of japanpost.jp as static properties",
+  "main": "index.js",
+  "files": [
+    "index.js",
+    "lib/zipcode-ja.js",
+    "lib/zipcode-ja.json",
+    "lib/zipcode-ja.json.gz"
+  ],
+  "dependencies": {
+    "pako": "^1.0.1"
+  },
+  "scripts": {
+    "prebuild": "node update.js",
+    "build": "browserify -t brfs index.js -s zipcodeJa > lib/zipcode-ja.js",
+    "start": "mocha test.js --watch",
+    "test": "mocha test.js",
+    "lint": "xo",
+    "test-cloud": "zuul test.js",
+    "test-local": "zuul test.js --local --ui mocha-bdd --local 59798 --open",
+    "postversion": "git push --follow-tags && conventional-github-releaser -p atom -r 0"
+  },
+  "devDependencies": {
+    "brfs": "^1.4.3",
+    "browserify": "^13.0.1",
+    "conventional-github-releaser": "^1.1.2",
+    "fast-csv": "^2.0.0",
+    "hanzen": "^0.0.0",
+    "iconv-lite": "^0.4.13",
+    "japanese": "^1.1.0",
+    "mocha": "^2.5.3",
+    "moment": "^2.13.0",
+    "xo": "^0.15.1",
+    "zuul": "^3.9.0"
+  },
+  "xo": {
+    "env": "mocha",
+    "space": 2,
+    "rules": {
+      "no-path-concat": 0
+    }
+  },
+  "keywords": [
+    "japanese",
+    "zip",
+    "ajaxzip"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/59naga/zipcode-ja.git"
+  },
+  "author": "59naga <i59naga@icloud.com> (http://berabou.me/)",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/59naga/zipcode-ja/issues"
+  },
+  "homepage": "https://github.com/59naga/zipcode-ja#readme"
+}

test.js

@@ -0,0 +1,35 @@
+var assert = require('assert');
+var version = require('./package').version;
+var zipcodeJa = require('./');
+
+it('ライブラリのバージョンを取得できるべき', function () {
+  assert(zipcodeJa.version === version);
+});
+it('住所データの更新日時を取得できるべき', function () {
+  assert(zipcodeJa.lastModified.match(/^\w{4}-\w{2}-\w{2}$/));
+});
+it('同期的に住所を取得できるべき', function () {
+  assert.deepEqual(zipcodeJa['1000002'], {
+    zipcode: '1000002',
+    zipcodeOld: '100  ',
+    jisX0402: '13101',
+    address: [
+      '東京都',
+      '千代田区',
+      '皇居外苑'
+    ],
+    ruby: [
+      'とうきょうと',
+      'ちよだく',
+      'こうきょがいえん'
+    ],
+    status: [
+      0,
+      0,
+      0,
+      0,
+      0,
+      0
+    ]
+  });
+});

update.js

@@ -0,0 +1,54 @@
+const execSync = require('child_process').execSync;
+const spawn = require('child_process').spawn;
+const writeFileSync = require('fs').writeFileSync;
+const gzipSync = require('zlib').gzipSync;
+const moment = require('moment');
+const csv = require('fast-csv');
+const decodeStream = require('iconv-lite').decodeStream;
+const hiraganize = require('japanese').hiraganize;
+const toZenkaku = require('hanzen').toZenkaku;
+const version = require('./package.json').version;
+
+const filename = 'lib/zipcode-ja.json';
+const uri = 'http://www.post.japanpost.jp/zipcode/dl/kogaki/zip/ken_all.zip';
+
+const date = new Date(execSync(`curl --head ${uri}`).toString().match(/Last-Modified: (.+)/)[1]);
+const lastModified = moment(date).format('YYYY-MM-DD');
+
+const zipcodes = {};
+spawn(`curl ${uri} | bsdtar -xv -O`, {shell: true})
+.stdout.pipe(decodeStream('SJIS'))
+.pipe(csv())
+.on('data', (line) => {
+  if (line.length === 0) {
+    return;
+  }
+  const [
+    jisX0402, zipcodeOld, zipcode,
+    kanaTodofuken, kanaShikuchoson, kanaChoiki,
+    todofuken, shikuchoson, choiki,
+    ...status
+  ] = line;
+  const data = {
+    zipcode,
+    zipcodeOld,
+    jisX0402,
+    address: [
+      todofuken,
+      shikuchoson,
+      choiki === '以下に掲載がない場合' ? '' : choiki
+    ],
+    ruby: [
+      hiraganize(toZenkaku(kanaTodofuken)),
+      hiraganize(toZenkaku(kanaShikuchoson)),
+      hiraganize(toZenkaku(kanaChoiki))
+    ],
+    status: status.map(char => Number(char))
+  };
+  zipcodes[zipcode] = data;
+})
+.on('end', () => {
+  const data = JSON.stringify(Object.assign({version, lastModified}, zipcodes));
+  writeFileSync(`${filename}`, data);
+  writeFileSync(`${filename}.gz`, gzipSync(data));
+});