kamome 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: eabc3d7c8fab14f88254defa7d52769a9d674951c3af50f5332e1f5af678fa77
+  data.tar.gz: ae51e66cd3b662dc93ea8cd31223281004db1b097acb07bb07c123d8e0a8ab00
+SHA512:
+  metadata.gz: f354384ca83990e9eddf6367c7d4453bff84729067a137aa1ebae59398f8d4dae94e1a21657e9830ba8289d8d671caec13314ec27235b0db935c95a1c90d2572
+  data.tar.gz: 705d96a73c879e96c18fa7afc6e186913fab28308bf9e4f560d39d25f564712302e1af941382468786a1b42f2b10bda2f7f8043f9b824898efc17f12bec18424

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/spec/.rspec_status
+*.gem

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,25 @@
+require: rubocop-rspec
+AllCops:
+  TargetRubyVersion: 2.5
+  Include:
+    - 'lib/**/*.rb'
+    - 'spec/**/*.rb'
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*_spec.rb'
+
+Metrics/MethodLength:
+  Max: 20
+
+Style/AsciiComments:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Metrics/LineLength:
+  Max: 120
+
+RSpec/NestedGroups:
+  Max: 4

data/.travis.yml

@@ -0,0 +1,12 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.3.8
+  - 2.4.5
+  - 2.5.3
+before_install: gem install bundler -v 1.17.1
+script:
+  - bundle exec rubocop
+  - bundle exec rspec

data/.yardopts

@@ -0,0 +1,3 @@
+--quiet
+lib/**/*.rb
+- README.md LICENCE CHANGELOG.md

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Changelogs
+
+## 2018/12/01
+
+First implementation

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in kamome.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,72 @@
+PATH
+  remote: .
+  specs:
+    kamome (0.1.0)
+      rubyzip (~> 1.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.5.2)
+      public_suffix (>= 2.0.2, < 4.0)
+    ast (2.4.0)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.3)
+    hashdiff (0.3.7)
+    jaro_winkler (1.5.1)
+    parallel (1.12.1)
+    parser (2.5.3.0)
+      ast (~> 2.4.0)
+    powerpack (0.1.2)
+    public_suffix (3.0.3)
+    rainbow (3.0.0)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    rubocop (0.60.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.5, != 2.5.1.1)
+      powerpack (~> 0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.4.0)
+    rubocop-rspec (1.30.1)
+      rubocop (>= 0.60.0)
+    ruby-progressbar (1.10.0)
+    rubyzip (1.2.2)
+    safe_yaml (1.0.4)
+    unicode-display_width (1.4.0)
+    vcr (4.0.0)
+    webmock (3.4.2)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.17)
+  kamome!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  rubocop (~> 0.60)
+  rubocop-rspec (~> 1.30)
+  vcr (~> 4.0)
+  webmock (~> 3.4)
+
+BUNDLED WITH
+   1.17.1

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2018 kengos.jp Inc. http://github.com/kengos/kamome
+
+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/Makefile

@@ -0,0 +1,12 @@
+.DEFAULT_GOAL := test
+
+.PHONY: test
+test: rubocop rspec
+
+.PHONY: rubocop
+rubocop:
+	@bundle exec rubocop
+
+.PHONY: rspec
+rspec:
+	@bundle exec rspec

data/README.md

@@ -0,0 +1,139 @@
+# Kamome
+
+[![Build Status](https://travis-ci.org/kengos/kamome.svg?branch=master)](https://travis-ci.org/kengos/kamome)
+
+日本郵便の郵便番号データの取得を行うインターフェースです
+
+以下のように block を渡すことで 郵便番号データ の取り込みで任意の実装を行うことができます
+
+```rb
+Kamome.import_general_all do |model, lineno|
+  puts "#{lineno}: #{model.zipcode} => #{model.prefecture}#{model.city}#{model.town}"
+end
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'kamome'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install kamome
+
+## Usage
+
+### 全国一括の郵便番号データの取り込み
+
+```rb
+Kamome.import_general_all do |model, lineno|
+  puts "#{lineno}: #{model.zipcode} => #{model.prefecture}#{model.city}#{model.town}"
+end
+```
+
+### 全国一括の郵便番号データの取り込み(差分)
+
+```rb
+date = Time.local(2018, 11) # 2018/11 更新分の取り込み
+Kamome.import_general_diff(date: date) do |model, lineno|
+  if model.changed?
+    puts "追加データ: #{model.zipcode} => #{model.prefecture}#{model.city}#{model.town}"
+  else
+    puts "削除データ: #{model.zipcode} => #{model.prefecture}#{model.city}#{model.town}"
+  end
+end
+```
+
+### 事業所の郵便番号データの取り込み
+
+```rb
+Kamome.import_jigyosho_all do |model, lineno|
+  puts "#{lineno}: #{model.zipcode} => #{model.prefecture}#{model.city}#{model.town}"
+end
+```
+
+### 事業所の郵便番号データの取り込み(差分)
+
+```rb
+date = Time.local(2018, 11) # 2018/11 更新分の取り込み
+Kamome.import_jigyosho_diff(date: date) do |model, lineno|
+  if model.changed?
+    puts "追加データ: #{model.zipcode} => #{model.prefecture}#{model.city}#{model.town}"
+  else
+    puts "削除データ: #{model.zipcode} => #{model.prefecture}#{model.city}#{model.town}"
+  end
+end
+```
+
+## FAQ
+
+### `Kamome.import_xxx` の model の型を変換したい
+
+#### Hash にする場合
+
+```rb
+Kamome.import_general_all(type: :hash or Kamome::Operation::TYPE_HASH)
+```
+
+#### DetailModel にする場合
+
+```rb
+Kamome.import_general_all(type: :detail or Kamome::Operation::TYPE_DETAIL)
+# 通常の戻りの型である `Kamome::Models::Address` ではなく以下のモデルで返却されます
+#   事業所CSV の場合 `Kamome::Models::Jigyosho`
+#   通常のCSV の場合 `Kamome::Models::General`
+```
+
+## データのクリーニングについて
+
+### 通常のCSV
+
+#### `Kamome::Models::General#town` or `Kamome::Models::Address#town`
+
+|元データ|変換後|備考|
+|--------|------|----|
+|以下に掲載がない場合||空白になります|
+|XXXXXの次に番地がくる場合||空白になります|
+|XXXXX（YYYY階）|XXXXX（YYYY階）|元の値を維持しています|
+|XXXXX（YYYYY）|XXXXX|() の部分が除去されます|
+
+#### `Kamome::Models::General#town_kana`
+
+|元データ|変換後|備考|
+|--------|------|----|
+|イカニケイサイガナイバアイ||空白になります|
+|XXXXXノツギニバンチガクルバアイ||空白になります|
+|XXXXX(Yカイ)|XXXXX(Yカイ)|元の値を維持しています|
+|XXXXX(YYYYY)|XXXXX|() の部分が除去されます|
+
+### 事業所CSV
+
+#### 私書箱情報について
+
+`Kamome::Models::General#post_office_box` or `Kamome::Models::Address#post_office_box`
+
+`０丁目０番地（ああああ郵便局私書箱第０００号）` のようなデータが有った場合
+
+* post_office_box ... `ああああ郵便局私書箱第０００号`
+* street ... `０丁目０番地`
+
+として設定されます
+
+#### `Kamome::Models::General#town_kana`
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `make` 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/kengos/kamome.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'kamome'
+
+# 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/kamome.gemspec

@@ -0,0 +1,47 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "kamome/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "kamome"
+  spec.version       = Kamome::VERSION
+  spec.authors       = ["kengos"]
+  spec.email         = ["kengo@kengos.jp"]
+
+  spec.summary       = "kamome-#{Kamome::VERSION}"
+  spec.description   = %q{the Japanese postcode loading interface}
+  spec.homepage      = "https://github.com/kengos/kamome"
+  spec.licenses = ['MIT']
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = "https://github.com/kengos/kamome"
+    spec.metadata["changelog_uri"] = "https://github.com/kengos/kamome/blob/master/CHANGELOG.md"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  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.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency 'vcr', '~> 4.0'
+  spec.add_development_dependency 'webmock', '~> 3.4'
+  spec.add_development_dependency 'rubocop', '~> 0.60'
+  spec.add_development_dependency 'rubocop-rspec', '~> 1.30'
+  spec.add_dependency 'rubyzip', '~> 1.2'
+end

data/lib/kamome.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+require 'kamome/version'
+require 'kamome/configuration'
+require 'kamome/loader'
+require 'kamome/operation'
+
+module Kamome
+  class Error < StandardError; end
+  class ArgumentError < StandardError; end
+  class DownloadError < Error; end
+
+  class << self
+    def configure
+      yield(configuration)
+    end
+
+    # Import ken_all.zip
+    # @param [Symbol] type :default, :hash, :detail
+    # @example
+    #   Kamome.import_general_all do |model, lineno|
+    #     # do something
+    #   end
+    def import_general_all(type: Operation::TYPE_DEFAULT, &block)
+      operation = ::Kamome::Operation.general_all(type: type)
+      loader.call(operation: operation, &block)
+    end
+
+    # Import add_yymm.zip and del_yymm.zip
+    # @param [Time] date
+    # @param [Symbol] type :default, :hash, :detail
+    # @example
+    #   Kamome.import_general_diff do |model, lineno|
+    #     # do something
+    #   end
+    def import_general_diff(date:, type: Operation::TYPE_DEFAULT, &block)
+      operation = ::Kamome::Operation.general_diff(date: date, type: type)
+      loader.call(operation: operation, &block)
+    end
+
+    # Import jigyosyo.zip
+    # @param [Symbol] type :default, :hash, :detail
+    # @example
+    #   Kamome.import_jigyosho_all do |model, lineno|
+    #     # do something
+    #   end
+    def import_jigyosho_all(type: Operation::TYPE_DEFAULT, &block)
+      operation = ::Kamome::Operation.jigyosho_all(type: type)
+      loader.call(operation: operation, &block)
+    end
+
+    # Import jadd#{yymm}.zip and jdel#{yymm}.zip
+    # @param [Time] date
+    # @param [Symbol] type :default, :hash, :detail
+    # @example
+    #   Kamome.import_jigyosho_all do |model, lineno|
+    #     # do something
+    #   end
+    def import_jigyosho_diff(date:, type: Operation::TYPE_DEFAULT, &block)
+      operation = ::Kamome::Operation.jigyosho_diff(date: date, type: type)
+      loader.call(operation: operation, &block)
+    end
+
+    private
+
+    def configuration
+      @configuration ||= Kamome::Configuration.new
+    end
+
+    def loader
+      Kamome::Loader.new(config: configuration)
+    end
+  end
+end