kamome 0.1.0

data/lib/kamome/operation.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+module Kamome
+  class Operation
+    TYPE_HASH = :hash
+    TYPE_DETAIL = :detail
+    TYPE_DEFAULT = :default
+
+    GENRE_GENERAL = :general
+    GENRE_JIGYOSHO = :jigyosho
+
+    URL_GENERAL_ALL = 'https://www.post.japanpost.jp/zipcode/dl/kogaki/zip/ken_all.zip'
+    URL_GENERAL_ADD = 'https://www.post.japanpost.jp/zipcode/dl/kogaki/zip/add_%s.zip'
+    URL_GENERAL_DEL = 'https://www.post.japanpost.jp/zipcode/dl/kogaki/zip/del_%s.zip'
+    URL_JIGYOSHO_ALL = 'https://www.post.japanpost.jp/zipcode/dl/jigyosyo/zip/jigyosyo.zip'
+    URL_JIGYOSHO_ADD = 'https://www.post.japanpost.jp/zipcode/dl/jigyosyo/zip/jadd%s.zip'
+    URL_JIGYOSHO_DEL = 'https://www.post.japanpost.jp/zipcode/dl/jigyosyo/zip/jdel%s.zip'
+
+    class << self
+      def general_all(type: TYPE_DEFAULT)
+        new(type: type, genre: GENRE_GENERAL, urls: [URL_GENERAL_ALL])
+      end
+
+      def jigyosho_all(type: TYPE_DEFAULT)
+        new(type: type, genre: GENRE_JIGYOSHO, urls: [URL_JIGYOSHO_ALL])
+      end
+
+      def general_diff(date:, type: TYPE_DEFAULT)
+        yymm = format_yymm(date)
+        new(type: type, genre: GENRE_GENERAL, urls: [URL_GENERAL_ADD % yymm, URL_GENERAL_DEL % yymm])
+      end
+
+      def jigyosho_diff(date:, type: TYPE_DEFAULT)
+        yymm = format_yymm(date)
+        new(type: type, genre: GENRE_JIGYOSHO, urls: [URL_JIGYOSHO_ADD % yymm, URL_JIGYOSHO_DEL % yymm])
+      end
+
+      private
+
+      YYMM_FORMAT = /\d{2}(0[1-9]|1[0-2])/.freeze
+      def format_yymm(date)
+        yymm = date.respond_to?(:strftime) ? date.strftime('%y%m') : date.to_s
+        return yymm if yymm =~ YYMM_FORMAT
+
+        raise ::Kamome::ArgumentError, 'Wrong argument "date" (required "yymm" format)'
+      end
+    end
+
+    attr_reader :type
+    attr_reader :genre
+    attr_reader :urls
+
+    def initialize(type:, genre:, urls:)
+      @type = type
+      @genre = genre
+      @urls = urls
+    end
+
+    def type_hash?
+      type == TYPE_HASH
+    end
+
+    def type_detail?
+      type == TYPE_DETAIL
+    end
+
+    def type_default?
+      type == TYPE_DEFAULT
+    end
+
+    def genre_general?
+      genre == GENRE_GENERAL
+    end
+
+    def genre_jigyosho?
+      genre == GENRE_JIGYOSHO
+    end
+  end
+end

data/lib/kamome/transformations/cleaner.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Kamome
+  module Transformations
+    module Cleaner
+      module_function
+
+      TOWN_KAN_SUB_RULE = /(\((?!.カイ\)).+|イカニケイサイガナイバアイ|.+ノツギニバンチガクルバアイ|.+イチエン)$/.freeze
+      def clean_town_kana(value)
+        value.sub(TOWN_KAN_SUB_RULE, '')
+      end
+
+      TOWN_SUB_RULE = /(（(?!.+階）).+）|以下に掲載がない場合|.+の次に番地がくる場合|.+一円)$/.freeze
+      def clean_town(value)
+        value.sub(TOWN_SUB_RULE, '')
+      end
+    end
+  end
+end

data/lib/kamome/transformations/extractor.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Kamome
+  module Transformations
+    module Extractor
+      module_function
+
+      POST_OFFICE_REG = /（(.+私書箱第.+号)）$/.freeze
+      def extract_street(value)
+        value.sub(POST_OFFICE_REG, '')
+      end
+
+      def extract_post_office_box(value)
+        value[POST_OFFICE_REG, 1] || ''
+      end
+    end
+  end
+end

data/lib/kamome/transformations/general_csv.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+require 'kamome/transformations/cleaner'
+require 'kamome/models/general'
+require 'kamome/models/address'
+
+module Kamome
+  module Transformations
+    # Transform a GENERAL csv row to a Hash or others
+    class GeneralCsv
+      include Kamome::Transformations::Cleaner
+
+      # Generate hash from a general csv row
+      # @return [Hash]
+      def generate_hash(row)
+        validate_row!(row)
+        transform(row)
+      end
+
+      def generate_detail_model(row)
+        attributes = generate_hash(row)
+        ::Kamome::Models::General.new(attributes)
+      end
+
+      def generate_model(row)
+        attributes = extract(generate_hash(row))
+        ::Kamome::Models::Address.new(attributes)
+      end
+
+      private
+
+      VALID_ROW_SIZE = 15
+
+      def validate_row!(row)
+        return if row&.size == VALID_ROW_SIZE
+
+        raise ArgumentError, "Wrong row size (expected #{VALID_ROW_SIZE}, got #{row&.size})"
+      end
+
+      def transform(row) # rubocop:disable Metrics/AbcSize
+        {
+          code: row[0].to_s,
+          zipcode: row[2].to_s,
+          prefecture_kana: row[3].to_s,
+          city_kana: row[4].to_s,
+          town_kana: clean_town_kana(row[5].to_s),
+          prefecture: row[6].to_s,
+          city: row[7].to_s,
+          town: clean_town(row[8].to_s),
+          ambiguous_town: row[9].to_i == 1,
+          ambiguous_street: row[10].to_i == 1,
+          required_chome: row[11].to_i == 1,
+          ambiguous_zipcode: row[12].to_i == 1,
+          state: row[13].to_i,
+          reason: row[14].to_i
+        }
+      end
+
+      def extract(attributes)
+        {
+          code: attributes[:code],
+          zipcode: attributes[:zipcode],
+          prefecture: attributes[:prefecture],
+          city: attributes[:city],
+          town: attributes[:town],
+          street: '',
+          company_name: '',
+          post_office_box: '',
+          state: attributes[:state]
+        }
+      end
+    end
+  end
+end

data/lib/kamome/transformations/jigyosho_csv.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+require 'kamome/transformations/extractor'
+require 'kamome/models/jigyosho'
+require 'kamome/models/address'
+
+module Kamome
+  module Transformations
+    # Transform a JIGYOSHO csv row to a Hash or others
+    class JigyoshoCsv
+      include ::Kamome::Transformations::Extractor
+
+      # Generate a Hash from a JIGYOSHO csv row
+      # @return [Hash]
+      def generate_hash(row)
+        validate_row!(row)
+        transform(row)
+      end
+
+      # Generate an instance of Kamome::Models::Jigyosho from a JIGYOSHO csv row
+      # @return [Kamome::Models::Jigyosho]
+      def generate_detail_model(row)
+        attributes = generate_hash(row)
+        ::Kamome::Models::Jigyosho.new(attributes)
+      end
+
+      # Generate an instance of Kamome::Models::Address from a JIGYOSHO csv row
+      # @return [Kamome::Models::Address]
+      def generate_model(row)
+        attributes = extract(generate_hash(row))
+        ::Kamome::Models::Address.new(attributes)
+      end
+
+      private
+
+      VALID_ROW_SIZE = 13
+
+      def validate_row!(row)
+        return if row&.size == VALID_ROW_SIZE
+
+        raise ArgumentError, "Wrong row size (expected #{VALID_ROW_SIZE}, got #{row&.size})"
+      end
+
+      def transform(row) # rubocop:disable Metrics/AbcSize
+        {
+          code: row[0].to_s,
+          company_name_kana: row[1].to_s,
+          company_name: row[2].to_s,
+          prefecture: row[3].to_s,
+          city: row[4].to_s,
+          town: row[5].to_s,
+          street: extract_street(row[6].to_s),
+          post_office_box: extract_post_office_box(row[6].to_s),
+          zipcode: row[7].to_s,
+          japanpost_office_name: row[9].to_s,
+          has_post_office_box: row[10].to_i == 1,
+          multiple: row[11].to_i,
+          state: row[12].to_i
+        }
+      end
+
+      def extract(attributes)
+        {
+          code: attributes[:code],
+          zipcode: attributes[:zipcode],
+          prefecture: attributes[:prefecture],
+          city: attributes[:city],
+          town: attributes[:town],
+          street: attributes[:street],
+          company_name: attributes[:company_name],
+          post_office_box: attributes[:post_office_box],
+          state: convert_state(attributes[:state])
+        }
+      end
+
+      def convert_state(state)
+        state == 5 ? 2 : state
+      end
+    end
+  end
+end

data/lib/kamome/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Kamome
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,188 @@
+--- !ruby/object:Gem::Specification
+name: kamome
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- kengos
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-11-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.60'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.60'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.30'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.30'
+- !ruby/object:Gem::Dependency
+  name: rubyzip
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+description: the Japanese postcode loading interface
+email:
+- kengo@kengos.jp
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- ".yardopts"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- Makefile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- kamome.gemspec
+- lib/kamome.rb
+- lib/kamome/configuration.rb
+- lib/kamome/csv_handler.rb
+- lib/kamome/downloader.rb
+- lib/kamome/loader.rb
+- lib/kamome/models/address.rb
+- lib/kamome/models/general.rb
+- lib/kamome/models/jigyosho.rb
+- lib/kamome/operation.rb
+- lib/kamome/transformations/cleaner.rb
+- lib/kamome/transformations/extractor.rb
+- lib/kamome/transformations/general_csv.rb
+- lib/kamome/transformations/jigyosho_csv.rb
+- lib/kamome/version.rb
+homepage: https://github.com/kengos/kamome
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/kengos/kamome
+  source_code_uri: https://github.com/kengos/kamome
+  changelog_uri: https://github.com/kengos/kamome/blob/master/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: kamome-0.1.0
+test_files: []