jp_address 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 45abd003f1050456228956f25f942d426f7ce682
+  data.tar.gz: 8270ae79d703962df2e8108bfb2774e73f9b28d3
+SHA512:
+  metadata.gz: c7a41d57de32d48ee3ec1440d4ca5762dde2a3e46dfd2c72ab5c2a75279d27b6f30c49779373988c0f5529d2fbe9ed67e80a17e2ac54577410b9f746c6190560
+  data.tar.gz: ddd986155a574e619b92cebfefc67aaec12c6c23217175947e297909f4b7744ebcd4c9c16527abe22590ac7ad3d85622765f3afe2ac0fb713e1bc9871bb3f1dc

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2016 
+
+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.rdoc

@@ -0,0 +1,97 @@
+= JpAddress: A Rails plugin for Japan Zipcode API.
+
+== JpAddressとは
+日本郵便の「郵便番号データ」を Rails 4.0 で使用するためのプラグインです。
+以下の機能を備えます。
+
+* 郵便局提供の郵便番号データをダウンロードしてＤＢにロード
+* 郵便番号をキーに住所情報を返却するＡＰＩ（コントローラ）。
+
+== インストール
+  % gem install jp_address
+
+GemFileに追記
+  gem 'jp_address'
+
+テーブルの作成
+  % rake jp_address:install:migrations
+  % rake db:migrate
+
+== マスターデータのＤＢへのロード
+開発環境
+  % rails runner -e development 'JpAddress::Zipcode.load_master_data'
+本番環境
+  % rails runner -e production 'JpAddress::Zipcode.load_master_data'
+
+環境にもよりますが、１～３分ぐらいかかると思います。
+
+※ APP_ROOT/tmp/ を作業ディレクトリに使用しています。
+
+== ＡＰＩのマウント
+マウントしたいRailsアプリの config/routes.rb に追記。
+  mount JpAddress::Engine, at: "/jp_address"
+
+== ＡＰＩの利用
+/jp_address にマウントした場合、下記URLへGETリクエストをすることで、JSONを取得できます。
+後はこれを好きに加工してテキストボックスなどにセットして使ってください。
+
+  http://localhost:3000/jp_address/zipcodes/search?zip=5330033
+  
+  {"id":84280,"zip":"5330033","prefecture":"大阪府","city":"大阪市東淀川区","town":"東中島"}
+
+== サンプルとなる coffee script
+フォームには
+* zipcode（テキストボックス）
+* prefecture_id（セレクトボックス。いわゆる都道府県プルダウン）
+* address（テキストボックス）
+の３要素があり、zipcodeに入れられた値を元にＡＰＩを叩き、prefecture_id と address に
+値をセットするサンプルです。
+
+prefecture_id の選択は、都道府県名で行っています。
+なので、お使いの都道府県マスターのＩＤ値に影響を受けることなく選択できるはずです。
+
+  class AddressSearch
+    constructor: (zip_elem_id, prefecture_elem_id, address_elem_id) ->
+      @$zip               = $(zip_elem_id)
+      @$prefecture        = $(prefecture_elem_id)
+      @$address           = $(address_elem_id)
+      @prefecture_elem_id = prefecture_elem_id
+
+    _remove_hyphen: ->
+      @$zip.val(@$zip.val().replace(/-/, ''))
+
+    _clear_current_value: ->
+      $(@prefecture_elem_id + ' >option:eq(0)').prop 'selected', true
+      @$address.val ''
+
+    _set_prefecture: (json) ->
+      $(@prefecture_elem_id + ' > option').each ->
+        if $(@).text() == json['prefecture']
+          $(@).prop 'selected', true
+
+    _set_address: (json) ->
+      @$address.val json['city'] + json['town']
+
+    _call_api: ->
+      $.getJSON '/jp_address/zipcodes/search', {zip: @$zip.val()}, (json) =>
+        if json['id'] == null
+          @._clear_current_value()
+        else
+          @._set_prefecture json
+          @._set_address json
+
+    execute: ->
+      @._remove_hyphen()
+      if @$zip.val().length == 7
+        @._call_api()
+
+  $ ->
+    address_search = new AddressSearch('#zipcode', '#prefecture_id', '#address')
+    $('#zipcode').keyup ->
+      address_search.execute()
+
+== 作者
+
+Copyright 2016 (c) Tadashi K, under MIT License.
+
+Tadashi K <densya203@skult.jp>

data/Rakefile

@@ -0,0 +1,26 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'JpAddress'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+load 'rails/tasks/statistics.rake'
+
+
+
+Bundler::GemHelper.install_tasks
+

data/app/assets/javascripts/jp_address/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/app/assets/stylesheets/jp_address/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/controllers/jp_address/application_controller.rb

@@ -0,0 +1,4 @@
+module JpAddress
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/controllers/jp_address/zipcodes_controller.rb

@@ -0,0 +1,10 @@
+require_dependency "jp_address/application_controller"
+
+module JpAddress
+  class ZipcodesController < ApplicationController
+    def search
+      @zipcode = Zipcode.find_by(:zip => params[:zip]) || Zipcode.new
+      render text: @zipcode.to_json
+    end
+  end
+end

data/app/helpers/jp_address/application_helper.rb

@@ -0,0 +1,4 @@
+module JpAddress
+  module ApplicationHelper
+  end
+end

data/app/models/jp_address/zipcode.rb

@@ -0,0 +1,82 @@
+module JpAddress
+  class Zipcode < ActiveRecord::Base
+
+    MASTER_CSV_PATH = 'tmp/ken_all.csv'
+
+    def self.download_master_file_from_japanpost
+      _setup_directory
+      zip = _save_zip(_request_to_japanpost.body)
+      _save_csv(zip.path)
+      :success if File.exist?(MASTER_CSV_PATH)
+    end
+
+    def self._setup_directory
+      FileUtils.mkdir_p 'tmp'
+      _remove_csv
+    end
+    private_class_method :_setup_directory
+
+    def self._request_to_japanpost
+      url = URI.parse('http://www.post.japanpost.jp/zipcode/dl/kogaki/zip/ken_all.zip')
+      res = Net::HTTP.start(url.host, url.port) do |http|
+        http.get('/zipcode/dl/kogaki/zip/ken_all.zip')
+      end
+      res
+    end
+    private_class_method :_request_to_japanpost
+
+    def self._save_zip(binary)
+      tmp_zip = Tempfile.open('ken_all.zip') do |f|
+        f.binmode
+        f.write binary
+        f
+      end
+      tmp_zip
+    end
+    private_class_method :_save_zip
+
+    def self._save_csv(zip_path)
+      Zip::File.open(zip_path) do |zip_file|
+        zip_file.each do |entry|
+          entry.extract(MASTER_CSV_PATH)
+        end
+      end
+    end
+    private_class_method :_save_csv
+
+    def self.load_master_data(csv_path = MASTER_CSV_PATH)
+      download_master_file_from_japanpost if !File.exist?(csv_path)
+      _clear_table
+      CSV.foreach(csv_path, encoding:'SJIS:UTF-8') do |row|
+        connection.execute(
+          sanitize_sql(
+            ["insert into jp_address_zipcodes (zip, prefecture, city, town)
+              values ('%s', '%s', '%s', '%s')", row[2], row[6], row[7], _remove_needless_words(row[8])
+            ]
+          )
+        )
+      end
+      _remove_csv
+    end
+
+    def self._clear_table
+      begin
+        connection.truncate 'jp_address_zipcodes'
+      rescue NotImplementedError
+        connection.execute 'delete from jp_address_zipcodes'
+      end
+    end
+    private_class_method :_clear_table
+
+    def self._remove_needless_words(base)
+      base.sub(/以下に掲載がない場合/, '').sub(/（.*/, '')
+    end
+    private_class_method :_remove_needless_words
+
+    def self._remove_csv
+      FileUtils.rm_rf MASTER_CSV_PATH
+    end
+    private_class_method :_remove_csv
+
+  end
+end

data/app/views/layouts/jp_address/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>JpAddress</title>
+  <%= stylesheet_link_tag    "jp_address/application", media: "all" %>
+  <%= javascript_include_tag "jp_address/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/config/routes.rb

@@ -0,0 +1,3 @@
+JpAddress::Engine.routes.draw do
+  get 'zipcodes/search'
+end

data/db/migrate/20160312045953_create_jp_address_zipcodes.rb

@@ -0,0 +1,10 @@
+class CreateJpAddressZipcodes < ActiveRecord::Migration
+  def change
+    create_table :jp_address_zipcodes do |t|
+      t.string :zip       , null: false, index: true
+      t.string :prefecture, null: false
+      t.string :city      , null: false
+      t.string :town
+    end
+  end
+end

data/lib/jp_address/engine.rb

@@ -0,0 +1,10 @@
+module JpAddress
+  class Engine < ::Rails::Engine
+    isolate_namespace JpAddress
+
+    config.generators do |g|
+      g.test_framework :rspec, fixture: false
+      g.fixture_replacement :factory_girl, dir: "spec/factories"
+    end
+  end
+end

data/lib/jp_address/version.rb

@@ -0,0 +1,3 @@
+module JpAddress
+  VERSION = "0.0.1"
+end

data/lib/jp_address.rb

@@ -0,0 +1,9 @@
+require 'net/http'
+require 'uri'
+require 'tempfile'
+require 'csv'
+require 'zip'
+require "jp_address/engine"
+
+module JpAddress
+end

data/lib/tasks/jp_address_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :jp_address do
+#   # Task goes here
+# end

data/spec/controllers/jp_address/zipcodes_controller_spec.rb

@@ -0,0 +1,25 @@
+require 'rails_helper'
+
+module JpAddress
+  RSpec.describe ZipcodesController, type: :controller do
+    routes { JpAddress::Engine.routes }
+
+    describe "GET #search" do
+      it "returns http success" do
+        get :search
+        expect(response).to have_http_status(:success)
+      end
+      it "returns valid data when a vaild zip is passed" do
+        create(:jp_address_zipcode)
+        get :search, zip: '5330033'
+        expect(response.body).to match '"zip":"5330033","prefecture":"大阪府","city":"大阪市東淀川区","town":"東中島"'
+      end
+      it "returns empty data when a invaild zip is passed" do
+        create(:jp_address_zipcode)
+        get :search, zip: '9999999'
+        expect(response.body).to match '"id":null,"zip":null,"prefecture":null,"city":null,"town":null'
+      end
+    end
+
+  end
+end

data/spec/dummy/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.

data/spec/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Rails.application.load_tasks

data/spec/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/spec/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/spec/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,5 @@
+class ApplicationController < ActionController::Base
+  # Prevent CSRF attacks by raising an exception.
+  # For APIs, you may want to use :null_session instead.
+  protect_from_forgery with: :exception
+end

data/spec/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/spec/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag    'application', media: 'all', 'data-turbolinks-track' => true %>
+  <%= javascript_include_tag 'application', 'data-turbolinks-track' => true %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/spec/dummy/bin/bundle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+load Gem.bin_path('bundler', 'bundle')

data/spec/dummy/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path('../../config/application', __FILE__)
+require_relative '../config/boot'
+require 'rails/commands'

data/spec/dummy/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run

data/spec/dummy/bin/setup

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+require 'pathname'
+
+# path to your application root.
+APP_ROOT = Pathname.new File.expand_path('../../',  __FILE__)
+
+Dir.chdir APP_ROOT do
+  # This script is a starting point to setup your application.
+  # Add necessary setup steps to this file:
+
+  puts "== Installing dependencies =="
+  system "gem install bundler --conservative"
+  system "bundle check || bundle install"
+
+  # puts "\n== Copying sample files =="
+  # unless File.exist?("config/database.yml")
+  #   system "cp config/database.yml.sample config/database.yml"
+  # end
+
+  puts "\n== Preparing database =="
+  system "bin/rake db:setup"
+
+  puts "\n== Removing old logs and tempfiles =="
+  system "rm -f log/*"
+  system "rm -rf tmp/cache"
+
+  puts "\n== Restarting application server =="
+  system "touch tmp/restart.txt"
+end

data/spec/dummy/config/application.rb

@@ -0,0 +1,32 @@
+require File.expand_path('../boot', __FILE__)
+
+# Pick the frameworks you want:
+require "active_record/railtie"
+require "action_controller/railtie"
+require "action_mailer/railtie"
+require "action_view/railtie"
+require "sprockets/railtie"
+# require "rails/test_unit/railtie"
+
+Bundler.require(*Rails.groups)
+require "jp_address"
+
+module Dummy
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+
+    # Do not swallow errors in after_commit/after_rollback callbacks.
+    config.active_record.raise_in_transactional_callbacks = true
+  end
+end
+

data/spec/dummy/config/boot.rb

@@ -0,0 +1,5 @@
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../../Gemfile', __FILE__)
+
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+$LOAD_PATH.unshift File.expand_path('../../../../lib', __FILE__)

data/spec/dummy/config/database.yml

@@ -0,0 +1,25 @@
+# SQLite version 3.x
+#   gem install sqlite3
+#
+#   Ensure the SQLite 3 gem is defined in your Gemfile
+#   gem 'sqlite3'
+#
+default: &default
+  adapter: sqlite3
+  pool: 5
+  timeout: 5000
+
+development:
+  <<: *default
+  database: db/development.sqlite3
+
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
+test:
+  <<: *default
+  database: db/test.sqlite3
+
+production:
+  <<: *default
+  database: db/production.sqlite3

data/spec/dummy/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the Rails application.
+require File.expand_path('../application', __FILE__)
+
+# Initialize the Rails application.
+Rails.application.initialize!

data/spec/dummy/config/environments/development.rb

@@ -0,0 +1,41 @@
+Rails.application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # In the development environment your application's code is reloaded on
+  # every request. This slows down response time but is perfect for development
+  # since you don't have to restart the web server when you make code changes.
+  config.cache_classes = false
+
+  # Do not eager load code on boot.
+  config.eager_load = false
+
+  # Show full error reports and disable caching.
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  # Don't care if the mailer can't send.
+  config.action_mailer.raise_delivery_errors = false
+
+  # Print deprecation notices to the Rails logger.
+  config.active_support.deprecation = :log
+
+  # Raise an error on page load if there are pending migrations.
+  config.active_record.migration_error = :page_load
+
+  # Debug mode disables concatenation and preprocessing of assets.
+  # This option may cause significant delays in view rendering with a large
+  # number of complex assets.
+  config.assets.debug = true
+
+  # Asset digests allow you to set far-future HTTP expiration dates on all assets,
+  # yet still be able to expire them through the digest params.
+  config.assets.digest = true
+
+  # Adds additional error checking when serving assets at runtime.
+  # Checks for improperly declared sprockets dependencies.
+  # Raises helpful error messages.
+  config.assets.raise_runtime_errors = true
+
+  # Raises error for missing translations
+  # config.action_view.raise_on_missing_translations = true
+end