zip_geo_jp 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5c0cf6a7e4040b5b4a9de002da9c20698cb393d9150de4b7c0f6d89e147b4ecf
+  data.tar.gz: 35560c128241a19d896e96d2451ab46b943d314e3d866f4bec30c19a27e45af5
+SHA512:
+  metadata.gz: 3dd9d53bdb6e23bb268136d016168184f84b00323e4f7cfa80d79f45246cdfe29ccc83ff94136c86a4fd407476c2fed79ee79ff564127565f7ddbe7ba07ca2c5
+  data.tar.gz: 9042dfa85b1ac8012b207b89ecea0627bd409f3b3a566b92d61f31365bbb39c6e577716c39558fce9b12350aa5153dd11f59b34e04ad28bc2b6e666fe3353db9

data/.gitattributes

@@ -0,0 +1 @@
+data/zip_geo_jp.sqlite3 filter=lfs diff=lfs merge=lfs -text

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/.idea/
+Gemfile.lock
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.3
+before_install: gem install bundler -v 2.1.4

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at toshiya.horie@gree.net. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,10 @@
+source "https://rubygems.org"
+
+gemspec
+
+gem 'rake', '~> 12.0'
+gem 'rspec', '~> 3.0'
+gem 'rubyzip'
+gem 'nokogiri'
+gem 'ruby-progressbar'
+gem 'parallel'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Toshiya Horie
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,46 @@
+# ZipGeoJp
+
+Convert Japanese zip code to latitude/longitude.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'zip_geo_jp'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install zip_geo_jp
+
+## Usage
+
+```
+> ZipGeoJa['167-0021']
+=> #<ZipGeoJp::Record:0x00007f941588c920 @zip_code="167-0021", @prefecture="東京都", @city="杉並区", @latitude=35.7276542, @longitude=139.6158849, @block="井草">
+```
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/toshiya-horie/zip_geo_jp. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/toshiya-horie/zip_geo_jp/blob/main/CODE_OF_CONDUCT.md).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the ZipGeoJp project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/toshiya-horie/zip_geo_jp/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,9 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+Dir.glob('lib/tasks/*.rake').each { |r| load r }

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "zip_geo_jp"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/tasks/zip_geo_ja.rake

@@ -0,0 +1,13 @@
+require_relative '../../lib/zip_geo_jp/rake_helper'
+
+namespace :zip_geo_ja do
+  desc 'Update zip_geo_ja records'
+  task :update do
+    ZipGeoJp::RakeHelper.update
+  end
+
+  desc 'Clean zip_geo_ja records'
+  task :reset do
+    ZipGeoJp::RakeHelper.reset
+  end
+end

data/lib/zip_geo_jp.rb

@@ -0,0 +1,17 @@
+require 'zip_geo_jp/version'
+require 'zip_geo_jp/record'
+
+module ZipGeoJp
+
+  class << self
+
+    # Convert zip code to latitude/longitude
+    #
+    # @param [String] zip_code
+    # @return [Record]
+    def [](zip_code)
+      ZipGeoJp::Record[zip_code.unicode_normalize(:nfkc).sub('-', '')]
+    end
+
+  end
+end

data/lib/zip_geo_jp/downloader.rb

@@ -0,0 +1,38 @@
+require 'open-uri'
+
+module ZipGeoJp
+  class Downloader
+
+    attr_accessor :url, :local_dir
+
+    def initialize(url, local_dir)
+      @url       = url
+      @local_dir = local_dir
+    end
+
+    def filename
+      @filename ||= URI.parse(url).path.to_s.split('/').last
+    end
+
+    def local
+      File.join(@local_dir, filename)
+    end
+
+    def remove
+      FileUtils.remove_file local if File.exist? local
+    end
+
+    def downloaded?
+      File.exist? local
+    end
+
+    def download
+      FileUtils.mkdir_p(@local_dir)
+      open(@url) do |stream|
+        open(local, 'w+b') do |file|
+          file.write(stream.read)
+        end
+      end
+    end
+  end
+end

data/lib/zip_geo_jp/rake_helper.rb

@@ -0,0 +1,73 @@
+require 'parallel'
+require 'zip'
+require 'csv'
+require 'uri'
+require 'open-uri'
+require 'nokogiri'
+require_relative 'downloader'
+require_relative 'record'
+
+module ZipGeoJp
+  module RakeHelper
+
+    DOWNLOAD_URL_ENDPOINT           = 'https://www.post.japanpost.jp/zipcode/dl/oogaki/zip/'.freeze
+    DOWNLOAD_URL_SUFFIX             = ['ken_all.zip'].freeze
+    GOOGLE_MAP_CRAWLING_DURATION    = (ENV['GOOGLE_MAP_CRAWLING_DURATION'] || 1).to_f.freeze
+    GOOGLE_MAP_CRAWLING_CONCURRENCY = (ENV['GOOGLE_MAP_CRAWLING_CONCURRENCY'] || 1).to_i.freeze
+
+    class << self
+      def update
+        DOWNLOAD_URL_SUFFIX.map do |suffix|
+          download_url = DOWNLOAD_URL_ENDPOINT + suffix
+          records      = extract_zip_code(download_url)
+          Parallel.each(records, in_threads: GOOGLE_MAP_CRAWLING_CONCURRENCY) do |zip_code, pref, city, block|
+            puts "Item: #{zip_code} #{pref}#{city}#{block}, Worker: #{Parallel.worker_number}"
+            unless ZipGeoJp::Record[zip_code]
+              coordinates              = coordinates_from_google_map(zip_code)
+              ZipGeoJp::Record[zip_code] = {
+                  prefecture: pref,
+                  city:       city,
+                  block:      block,
+                  latitude:   coordinates[0],
+                  longitude:  coordinates[1],
+              }
+              sleep(GOOGLE_MAP_CRAWLING_DURATION)
+            end
+          end
+        end
+      end
+
+      def reset
+        ZipGeoJp::Record.reset
+      end
+
+      private
+
+      def extract_zip_code(download_url)
+        downloader = ZipGeoJp::Downloader.new(download_url, 'tmp')
+        downloader.download unless downloader.downloaded?
+
+        records = []
+        Zip::File.open(downloader.local) do |zip_file|
+          entry = zip_file.glob('*.CSV').first
+          CSV.parse(
+              entry.get_input_stream.read.encode(Encoding::UTF_8, Encoding::Shift_JIS),
+          ).each do |rows|
+            zipcode           = rows[2]
+            pref, city, block = rows.slice(6, 3).map { |r| r.unicode_normalize(:nfkc) }
+            records.push([zipcode, pref, city, block])
+          end
+        end
+
+        records
+      end
+
+      def coordinates_from_google_map(zip_code)
+        google_map_url  = "https://www.google.com/maps/place/%E3%80%92#{zip_code.gsub(/^(\d{3})(\d{4})$/, '\1-\2')}/"
+        image_url       = Nokogiri::HTML(open(google_map_url).read).at('meta[itemprop="image"]')['content']
+        coordinates_str = URI.parse(image_url).query.split('&').map { |kv| kv.split('=') }.to_h['center']
+        URI.decode(coordinates_str).split(',').map(&:to_f)
+      end
+    end
+  end
+end

data/lib/zip_geo_jp/record.rb

@@ -0,0 +1,61 @@
+require 'sqlite3'
+
+module ZipGeoJp
+  class Record
+    attr_reader :zip_code, :prefecture, :city, :block, :latitude, :longitude
+
+    def initialize(values)
+      @zip_code                                         = values.shift.gsub(/^(\d{3})(\d{4})$/, '\1-\2')
+      @prefecture, @city, @block, @latitude, @longitude = values
+    end
+
+    class << self
+      def [] (key)
+        row = db.execute('SELECT * FROM zip_codes WHERE zip_code = ? LIMIT 1', key).first
+        row ? from_row(row) : nil
+      end
+
+      def []= (key, values)
+        values[:zip_code] = key
+        db.execute(
+            'REPLACE INTO zip_codes(zip_code, prefecture, city, block, latitude, longitude) VALUES(:zip_code, :prefecture, :city, :block, :latitude, :longitude)',
+            values
+        )
+        values
+      end
+
+      def reset
+        File.delete(file) if File.exists?(file)
+      end
+
+      def from_row(row)
+        new(row.values)
+      end
+
+      private
+
+      def db
+        @@db ||= begin
+          db                 = SQLite3::Database.new(file)
+          db.results_as_hash = true
+          db.execute(<<_EOF_
+          CREATE TABLE IF NOT EXISTS zip_codes (
+           zip_code   TEXT NOT NULL PRIMARY KEY,
+           prefecture TEXT NOT NULL,
+           city       TEXT NOT NULL,
+           block      TEXT,
+           latitude   REAL,
+           longitude  REAL
+          )
+_EOF_
+          )
+          db
+        end
+      end
+
+      def file
+        File.join(__dir__, '../../data/zip_geo_jp.sqlite3')
+      end
+    end
+  end # Data
+end # Zipja

data/lib/zip_geo_jp/version.rb

@@ -0,0 +1,3 @@
+module ZipGeoJp
+  VERSION = "0.1.0"
+end

data/zip_geo_jp.gemspec

@@ -0,0 +1,20 @@
+require_relative 'lib/zip_geo_jp/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'zip_geo_jp'
+  spec.version       = ZipGeoJp::VERSION
+  spec.authors       = ['Toshiya Horie']
+  spec.email         = ['toshiya.horie@gmail.com']
+
+  spec.summary       = 'Convert Japanese zip code to coordinates.'
+  spec.description   = spec.summary
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
+  spec.homepage      = 'https://github.com/toshiya-horie/zip_geo_jp'
+
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.require_paths = ['lib']
+  spec.add_dependency 'sqlite3'
+end

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification
+name: zip_geo_jp
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Toshiya Horie
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-03-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Convert Japanese zip code to coordinates.
+email:
+- toshiya.horie@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitattributes"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- data/zip_geo_jp.sqlite3
+- lib/tasks/zip_geo_ja.rake
+- lib/zip_geo_jp.rb
+- lib/zip_geo_jp/downloader.rb
+- lib/zip_geo_jp/rake_helper.rb
+- lib/zip_geo_jp/record.rb
+- lib/zip_geo_jp/version.rb
+- tmp/.gitkeep
+- zip_geo_jp.gemspec
+homepage: https://github.com/toshiya-horie/zip_geo_jp
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.6
+signing_key: 
+specification_version: 4
+summary: Convert Japanese zip code to coordinates.
+test_files: []