kirico 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 509096a9019dc94c96f63802979b7f7fc85261d2
-  data.tar.gz: edd24c57291b695f87321a9406ad721420801720
+  metadata.gz: 6c4627b33a39bccf807dad907f29ac1a27759a1e
+  data.tar.gz: 01f7bcbd94b549c5355a399da93563694952c911
 SHA512:
-  metadata.gz: cc6f911e48dfffcec6398f095b7329679511140e029baf7b04530a887af919d0f0ef7c777f64e6b75bdf7660075c8b11424302b375cefc845cc98263f81cb46c
-  data.tar.gz: 2a021ec0c08e49f41c10356b7e7c6b63925c8703e8849b1832601b6b026a13d91b5e47bfd9ce8c83c3511e766c07b88acc396f17108a61b3e4f0d668ccddf199
+  metadata.gz: a1b217e440827287d6938b778aad6d15d042789323d2a3e33f721dec38ba3316c8bd24a9564c8e5c289afaa0be022dfe7e14e52618ddb6b2ec02b5f457c26c40
+  data.tar.gz: eb0ef8835a41d38e02abadd3a56ed7e6a2f02e34282864f7ec4b9be5a0e6d5733b1f43cd208079d04d5c2730bb703ed08ad8b04e220effc3a3e7daf12b595edb

data/LICENSE.md

@@ -0,0 +1,7 @@
+Copyright (c) 2017 Kensuke NAITO and KUFU, Inc.
+
+以下に定める条件に従い、本ソフトウェアおよび関連文書のファイル（以下「ソフトウェア」）の複製を取得するすべての人に対し、ソフトウェアを無制限に扱うことを無償で許可します。これには、ソフトウェアの複製を使用、複写、変更、結合、掲載、頒布、サブライセンス、および/または販売する権利、およびソフトウェアを提供する相手に同じことを許可する権利も無制限に含まれます。
+
+上記の著作権表示および本許諾表示を、ソフトウェアのすべての複製または重要な部分に記載するものとします。
+
+ソフトウェアは「現状のまま」で、明示であるか暗黙であるかを問わず、何らの保証もなく提供されます。ここでいう保証とは、商品性、特定の目的への適合性、および権利非侵害についての保証も含みますが、それに限定されるものではありません。 作者または著作権者は、契約行為、不法行為、またはそれ以外であろうと、ソフトウェアに起因または関連し、あるいはソフトウェアの使用またはその他の扱いによって生じる一切の請求、損害、その他の義務について何らの責任も負わないものとします。

data/README.md

@@ -1,45 +1,230 @@
-<img width="446" alt="kirico-logo" src="https://cloud.githubusercontent.com/assets/2214179/22500174/267fa8a8-e8a6-11e6-905f-fc79a049afab.png">
+<img width="300" alt="kirico-logo" src="https://cloud.githubusercontent.com/assets/2214179/22500174/267fa8a8-e8a6-11e6-905f-fc79a049afab.png">
 
-# Kirico
+# kirico
 
 [![CircleCI](https://circleci.com/gh/kufu/kirico.svg?style=svg)](https://circleci.com/gh/kufu/kirico)
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/kirico`. To experiment with that code, run `bin/console` for an interactive prompt.
+A Ruby implementation of 届書作成プログラム
 
-TODO: Delete this and the text above, and describe your gem
+## 理念
 
-## Installation
+2008 年より[電子政府（e-Gov）のウェブサイト](http://www.e-gov.go.jp/shinsei/index.html)上で社会保険・労働保険関連手続きの電子申請の受付が開始されました。  
+2010 年には e-Gov の使い勝手の向上を図り、一括申請機能の提供が開始されました。  
+そして 2014 年 10 月、さらなる利便性の向上を目的に、外部連携 API 仕様が公開されました。  
 
-Add this line to your application's Gemfile:
+これまで様々な取組が行われてきた一方で、確定申告などで利用される国税の電子申告（e-Tax）と比べるとまだまだ普及度が低いのが実情です。  
+また、一部の電子申請では年金機構の公開する「届書作成プログラム」を利用して CSV ファイルを生成する必要があり、一般利用者、ソフトウェア開発者共に負担となるものでした。  
+
+わたしたちは kirico の開発・公開によって CSV 形式の電子申請への対応を容易にすることで e-Gov 外部連携 API に対応したソフトウェアが増えることを期待します。  
+そして、電子政府の認知度の向上、利用率の向上、及び利用の拡大に貢献し、もってユーザの利便性の向上を目指します。
+
+
+## インストール
+
+Gemfile に追記して:
 
 ```ruby
 gem 'kirico'
 ```
 
-And then execute:
+bundle コマンドを実行します:
+
+```bash
+$ bundle
+```
+
+もしくは、直接インストール:
+
+```bash
+$ gem install kirico
+```
+
+## 使い方
+
+
+<img width="500" alt="data structure" src="https://cloud.githubusercontent.com/assets/2214179/23646339/c7f056b6-0353-11e7-9632-b1aeb0ed3458.png">
+
+_データ構造: 仕様書 p.6-2 より_
+
+
+**FD 管理レコード**
+
+```ruby
+require 'kirico'
+require 'i18n'
+I18n.locale = :ja
+
+# FD 管理レコード
+fd = Kirico::FDManagementRecord.new do |rec|
+  rec.area_code = '03'
+  rec.office_code = 'ｷﾘｺ'
+  rec.fd_seq_number = '001'
+  rec.created_at = Date.new(2017, 1, 1)
+end
+
+fd.valid? #=> true
+
+fd.office_code = 'ほげ'
+fd.valid? #=> false
+fd.errors #=> 略
+```
+
+**事業所情報**
+
+```ruby
+require 'kirico'
+require 'i18n'
+I18n.locale = :ja
+
+# 事業所情報
+company = Kirico::Company.new do |rec|
+  rec.area_code = '03'
+  rec.office_code = 'ｷﾘｺ'
+  rec.office_number = '1234'
+  rec.zip_code1 = '123'
+  rec.zip_code2 = '4567'
+  rec.address = '東京都世田谷区上馬0-0-0'
+  rec.name = '株式会社印度カレー'
+  rec.owner_name = '内藤　キリコ'
+  rec.tel_number = '03-0000-0000'
+end
+
+company.valid? #=> true
+
+company.name = '株式会社印度咖喱'
+company.valid? #=> false
+company.errors #=> 略
+```
+
+**データレコード（住所変更届）**
+
+```ruby
+# 住所変更届データレコード
+address_record = Kirico::ChangingAddressRecord.new do |rec|
+  rec.area_code = '03'
+  rec.office_code = 'ｷﾘｺ'
+  rec.ip_code = '100'
+  rec.basic_pension_number1 = '1234'
+  rec.basic_pension_number2 = '567890'
+  rec.birth_at = Date.new(1984, 7, 23)
+  rec.zip_code1 = '123'
+  rec.zip_code2 = '4567'
+  rec.new_address_yomi = 'ﾄｳｷｮｳﾄｼﾌﾞﾔｸｻｸﾗｶﾞｵｶ'
+  rec.new_address = '東京都渋谷区桜丘'
+  rec.updated_at = Date.new(2017, 3, 7)
+  rec.ip_name_yomi = 'ﾀﾅｶ ﾀﾛｳ'
+  rec.ip_name = '田中　太郎'
+  rec.old_address_yomi = 'ﾄｳｷｮｳﾄｵｵﾀｸｳﾉｷ'
+  rec.old_address = '東京都大田区鵜の木'
+  rec.memo = 'メモメモ'
+end
+
+address_record.valid? #=> true
+
+address_record.ip_name_yomi = 'タナカタロウ'
+address_record.valid? #=> false
+address_record.errors #=> 略
+```
+
+**CSV 生成用フォーム**
+
+```ruby
+
+# FD 管理用レコード
+fd = Kirico::FDManagementRecord.new do |rec|
+  rec.area_code = '03'
+  # ...
+end
+
+company = Kirico::Company.new do |rec|
+  rec.area_code = '03'
+  # ...
+end
+
+address_record = Kirico::ChangingAddressRecord.new do |rec|
+  rec.area_code = '03'
+  # ...
+end
+
+form = Kirico::Form.new(fd: fd, company: company, records: [address_record])
+form.valid? #=> true
+
+# CSV ファイルの生成
+File.open(Kirico::Form::FILE_NAME, 'w') do |f|
+  f.puts(form.to_csv)
+end
+```
+
+
+## 生成した CSV の検証
 
-    $ bundle
+日本年金機構の公開している検証プログラムで生成した CSV ファイルを検証することもできます。
+※動作には Windows 環境が必要となります
 
-Or install it yourself as:
+<img width="400" alt="kirico-logo" src="https://cloud.githubusercontent.com/assets/2214179/23650706/609ed1e6-0366-11e7-92d9-625354982b9f.png">
 
-    $ gem install kirico
+検証プログラムのダウンロードはこちらから。  
+[届出システムを自社開発または市販ソフトを使用する場合｜日本年金機構](https://www.nenkin.go.jp/denshibenri/setsumei/20150415.html)
 
-## Usage
 
-TODO: Write usage instructions here
+## 対応手続き
 
-## Development
+|  データレコード | クラス名 | 実装状況 |
+|  ------ | ------ | ------ |
+|  資格取得届データレコード | TBD | △ |
+|  資格喪失届データレコード | TBD | △ |
+|  住所変更届データレコード | Kirico::ChangingAddressRecord | ◯ |
+|  算定基礎届データレコード | TBD | △ |
+|  月額変更届データレコード | TBD | △ |
+|  賞与支払届データレコード | TBD | △ |
+|  被扶養者（異動）届データレコード | TBD | △ |
+|  3号関係届（資格取得）データレコード | TBD | △ |
+|  3号関係届（資格喪失）データレコード | TBD | △ |
+|  3号関係届（志望）データレコード | TBD | △ |
+|  国民年金第3号被保険者<br><br/>被扶養配偶者非該当届データレコード | TBD | △ |
 
-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).
+※実装状況について
+
+- ◯: 実装、テスト済み
+- △: 実装予定
+
+## 参考リンク
+
+- [届出システムを自社開発または市販ソフトを使用する場合｜日本年金機構](https://www.nenkin.go.jp/denshibenri/setsumei/20150415.html)
+    届書作成プログラム仕様について
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/kirico.
+1. Fork it ( https://github.com/kufu/kirico/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+
+## Copyright
+
+Copyright (c) 2017 Kensuke NAITO and KUFU, Inc.  
+ライセンスはこちら: [kirico/LICENSE.md](https://github.com/kufu/kirico/blob/master/LICENSE.md)
+
+
+# KUFU について
+
+![KUFU logo](https://raw.githubusercontent.com/wiki/kufu/kiji/images/logo_kufu.png)
+
+kirico は株式会社 KUFU によってメンテナンス、開発が行われています。  
+わたしたちは OSS の力を信じています。  
+
+KUFU では OSS 活動に積極的なエンジニアを募集しています！  
 
+[「雇用」×「国のAPI」をハックする Ruby エンジニア募集！](https://www.wantedly.com/projects/3788)
 
-## License
 
-The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+# kirico について
 
+切子（kirico）とは江戸時代末期より生産されている伝統的なガラス細工です。  
+中でも薩摩切子は薩摩藩御用達の工芸品であり、多くの大名に珍重されてきました。
+色付きの厚いガラスを被せ文様を彫るため、薄く繊細な江戸切子と比較すると、重厚な印象が特徴的です。
+幕末の動乱の中で生産設備に壊滅的な被害を受け、その技術は一時途絶えていましたが、
+近年、各地の職人の努力により復刻に成功しました。

data/lib/kirico/validators/charset_validator.rb

@@ -68,6 +68,8 @@ module Kirico
       # value.blank? はタブ文字等の場合でも true となるため注意
       return error_chars if value.nil? || value.empty?
 
+      # e-Gov では U+FF0D (FULLWIDTH HYPHEN-MINUS) を許容しているようだ
+      # -> Shift_JIS ではなく CP932 が適当
       match = regex(options[:accept]).match(value.encode('CP932'))
       return error_chars if match.nil?
 

data/lib/kirico/validators/sjis_bytesize_validator.rb

@@ -48,7 +48,7 @@ module Kirico
     end
 
     def validate_each(record, attribute, value = '')
-      value_length = value.to_s.encode('Shift_JIS', undef: :replace).bytesize
+      value_length = value.to_s.encode('CP932', undef: :replace).bytesize
 
       errors_options = options.except(*RESERVED_OPTIONS)
 

data/lib/kirico/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module Kirico
-  VERSION = '0.1.3'
+  VERSION = '0.1.4'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kirico
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - kakipo
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-03-06 00:00:00.000000000 Z
+date: 2017-03-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -248,7 +248,7 @@ files:
 - ".ruby-version"
 - Gemfile
 - Guardfile
-- LICENSE.txt
+- LICENSE.md
 - README.md
 - Rakefile
 - bin/console

data/LICENSE.txt

@@ -1,21 +0,0 @@
-The MIT License (MIT)
-
-Copyright (c) 2016 kakipo
-
-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.