kiji 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a872976a91ecf3d493cdeb0d8c5d8e39bee5c4e1
+  data.tar.gz: 8c815743a03b7443e884c860115dd7b11333df99
+SHA512:
+  metadata.gz: b2f7275dbb91271fa8275f586fef099b202f24e582ee9e6b83dabb9499009ce710fc1e297fadc5639eb81fd9791fd6de761c50381e622b51d25b549724bbea4f
+  data.tar.gz: d36173406f6e597a9491e1531c4d99cf99d4b970b172315e2a7f74653b6368fb0db0a7e79600315ad33fc8a4617a041fb44738341a19f9cd1b0e09328cc4e5fd

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.env
+.DS_Store

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,7 @@
+inherit_from: '.rubocop_todo.yml'
+
+Style/Blocks:
+  Enabled: false
+
+Style/AsciiComments:
+  Enabled: false

data/.rubocop_todo.yml

@@ -0,0 +1,48 @@
+# This configuration was generated by `rubocop --auto-gen-config`
+# on 2015-04-02 16:13:11 +0900 using RuboCop version 0.29.1.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 5
+Metrics/AbcSize:
+  Max: 47
+
+# Offense count: 1
+# Configuration parameters: CountComments.
+Metrics/ClassLength:
+  Max: 170
+
+# Offense count: 1
+Metrics/CyclomaticComplexity:
+  Max: 7
+
+# Offense count: 54
+# Configuration parameters: AllowURI, URISchemes.
+Metrics/LineLength:
+  Max: 245
+
+# Offense count: 5
+# Configuration parameters: CountComments.
+Metrics/MethodLength:
+  Max: 30
+
+# Offense count: 1
+Metrics/PerceivedComplexity:
+  Max: 8
+
+# Offense count: 4
+Style/Documentation:
+  Enabled: false
+
+# Offense count: 4
+Style/RegexpLiteral:
+  MaxSlashes: 0
+
+Metrics/ClassLength:
+  Exclude:
+    - 'lib/kiji/signer.rb'
+
+Metrics/AbcSize:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.1.5

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in egov.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,48 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+# directories %w(lib spec)
+
+## Uncomment to clear the screen before every task
+# clearing :on
+
+## Guard internally checks for changes in the Guardfile and exits.
+## If you want Guard to automatically start up again, run guard in a
+## shell loop, e.g.:
+##
+##  $ while bundle exec guard; do echo "Restarting Guard..."; done
+##
+## Note: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), then you will want to move
+## the Guardfile to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+
+# Note: The cmd option is now required due to the increasing number of ways
+#       rspec may be run, below are examples of the most common uses.
+#  * bundler: 'bundle exec rspec'
+#  * bundler binstubs: 'bin/rspec'
+#  * spring: 'bin/rspec' (This will use spring if running and you have
+#                          installed the spring binstubs per the docs)
+#  * zeus: 'zeus rspec' (requires the server to be started separately)
+#  * 'just' rspec: 'rspec'
+
+guard :rspec, cmd: 'bundle exec rspec', failed_mode: :focus do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { 'spec' }
+end
+
+guard :bundler do
+  watch('Gemfile')
+  watch(/^.+\.gemspec/)
+end
+
+guard :rubocop, all_on_start: true, cli: ['-D', '--format', 'clang'] do
+  watch(/.+\.rb$/)
+end

data/LICENSE.md

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

data/README.md

@@ -0,0 +1,217 @@
+![kiji logo](https://raw.githubusercontent.com/wiki/kufu/kiji/images/logo_kiji.png)
+
+by [KUFU, Inc.](http://kufuinc.com/)
+
+# kiji
+
+A Ruby interface to the e-Gov API.
+
+## 理念
+
+2008 年より[電子政府（e-Gov）のウェブサイト](http://www.e-gov.go.jp/shinsei/index.html)上で社会保険・労働保険関連手続きの電子申請の受付が開始されました。  
+2010 年には e-Gov の使い勝手の向上を図り、一括申請機能の提供が開始されました。  
+そして 2014 年 10 月、さらなる利便性の向上を目的に、外部連携 API 仕様が公開されました。  
+
+これまで様々な取組が行われてきた一方で、確定申告などで利用される国税の電子申告（e-Tax）と比べるとまだまだ普及度が低いのが実情です。
+
+わたしたちは kiji の開発・公開によって e-Gov 外部連携 API に対応したソフトウェアが増えることを期待します。  
+そして、電子政府の認知度の向上、利用率の向上、及び利用の拡大に貢献し、もってユーザの利便性の向上を目指します。
+
+
+## インストール
+
+Gemfile に追記して:
+
+```ruby
+gem 'kiji'
+```
+
+bundle コマンドを実行します:
+
+```bash
+$ bundle
+```
+
+もしくは、直接インストール:
+
+```bash
+$ gem install kiji
+```
+
+## 使い方
+
+### 利用者 ID 登録
+
+```ruby
+client = Kiji::Client.new do |c|
+  c.software_id   = ENV['EGOV_SOFTWARE_ID']
+  c.api_end_point = ENV['EGOV_API_END_POINT']
+  c.cert          = OpenSSL::X509::Certificate.new(File.read(cert_file))
+  c.private_key   = OpenSSL::PKey::RSA.new(File.read(private_key_file))
+end
+
+response = client.register("NEW_USER_ID") # => Faraday::Response
+xml = Nokogiri::XML(response.body) # => Nokogiri::XML::Document
+xml.at_xpath('//Code').text # => 0（正常終了）
+```
+
+### 利用者認証
+
+```ruby
+client = Kiji::Client.new do |c|
+  c.software_id   = ENV['EGOV_SOFTWARE_ID']
+  c.api_end_point = ENV['EGOV_API_END_POINT']
+  c.cert          = OpenSSL::X509::Certificate.new(File.read(cert_file))
+  c.private_key   = OpenSSL::PKey::RSA.new(File.read(private_key_file))
+end
+
+# 利用者認証（Access Key の取得 & 設定）
+response = client.login("REGISTERED_USER_ID")
+xml = Nokogiri::XML(response.body)
+client.access_key = xml.at_xpath('//AccessKey').text
+```
+
+### 一括申請
+
+```ruby
+client = Kiji::Client.new do |c|
+  c.software_id   = ENV['EGOV_SOFTWARE_ID']
+  c.api_end_point = ENV['EGOV_API_END_POINT']
+  c.cert          = OpenSSL::X509::Certificate.new(File.read(cert_file))
+  c.private_key   = OpenSSL::PKey::RSA.new(File.read(private_key_file))
+end
+
+# 利用者認証（Access Key の取得 & 設定）
+response = client.login("REGISTERED_USER_ID")
+xml = Nokogiri::XML(response.body)
+client.access_key = xml.at_xpath('//AccessKey').text
+
+# 一括申請
+file_name = 'apply.zip'
+encoded_data = Base64.encode64(File.new("data/#{file_name}").read)
+client.apply(file_name, encoded_data)
+```
+
+
+## 事前準備
+
+e-Gov API を利用するには外部連携 API 利用ソフトウェア開発の申込みを行い、ソフトウェア ID を入手する必要があります。  
+詳しくは [利用にあたっての留意事項](http://www.e-gov.go.jp/shinsei/interface_api/attention.html) をご参照ください。
+
+
+## 検証環境での利用
+
+検証環境には BASIC 認証が設定されています。  
+`Kiji::Client` の `basic_auth_id` および `basic_auth_password` に ID と Password をそれぞれ設定しましょう。
+
+```ruby
+client = Kiji::Client.new do |c|
+  ...
+  c.basic_auth_id = ENV['EGOV_BASIC_AUTH_ID']
+  c.basic_auth_password = ENV['EGOV_BASIC_AUTH_PASSWORD']
+end
+```
+
+また、署名に利用する証明書については e-Gov にて配布されているものを利用します。  
+
+[仕様書ダウンロード｜電子政府の総合窓口e-Gov イーガブ](http://www.e-gov.go.jp/shinsei/interface_api/download.html) > 検証環境テスト用電子証明書
+
+**TIPS**
+
+pfx から *.pem と *.cer を取り出す
+
+__*.cer__
+
+```bash
+$ openssl pkcs12 -in e-GovEE02_sha2.pfx -nokeys -out ~/Desktop/egov.cer
+Enter Import Password:（gpkitestと入力）
+MAC verified OK
+```
+
+__*.pem__
+
+```bash
+$ openssl pkcs12 -in e-GovEE02_sha2.pfx -nocerts -out ~/Desktop/egov.pem
+Enter Import Password:（gpkitestと入力）
+MAC verified OK
+Enter PEM pass phrase:（適当なパスワード入力）
+Verifying - Enter PEM pass phrase:（適当なパスワード入力）
+```
+
+
+## API と メソッドの対応
+
+| API | メソッド | 実装状況 |
+| --- | --- | :---: |
+| 利用者 ID 登録 | register | ○ |
+| 利用者認証 | login | ○ |
+| 一括申請 | apply | ○ |
+| 送信案件一覧情報取得 (ID 指定) | sended_applications_by_id | ○ |
+| 送信案件一覧情報取得 (日付 指定) | sended_applications_by_date | ○ |
+| 申請案件一覧情報取得 | arrived_applications | ○ |
+| 状況照会 | reference | ○ |
+| 取下げ | withdraw | ○ |
+| 補正通知一覧取得 | amends | ○ |
+| 補正(再提出) | reamend | △ |
+| 補正(部分補正) | partamend | △ |
+| 補正(補正申請) | amend_apply | △ |
+| 公文書・コメント一覧取得 | notices | ○ |
+| 公文書取得 | officialdocument | ○ |
+| 公文書取得完了 | done_officialdocument | ○ |
+| 公文書署名検証 | verify_officialdocument | ○ |
+| コメント通知取得 | comment | ○ |
+| コメント通知取得完了 | done_comment | ○ |
+| 電子納付対応金融機関一覧取得 | banks | ○ |
+| 電子納付情報一覧取得 | payments | ○ |
+| 電子納付金融機関サイト表示 | - | ☓ |
+| 証明書識別情報追加 | append_certificate | ○ |
+| 証明書識別情報更新 | update_certificate | ○ |
+| 証明書識別情報削除 | delete_certificate | ○ |
+
+※実装状況について
+
+- ○: 実装、テスト済み
+- △: 実装予定
+- ☓: 実装予定無し
+
+## 参考リンク
+
+- [e-Gov電子申請システム｜電子政府の総合窓口e-Gov イーガブ](http://www.e-gov.go.jp/shinsei/index.html)  
+    e-Gov に関する最新情報
+- [外部連携API仕様公開（ソフトウェア開発事業者の方へ）｜電子政府の総合窓口e-Gov イーガブ](http://www.e-gov.go.jp/shinsei/interface_api/index.html)  
+    （公式）API の仕様について
+- [一括申請仕様公開（ソフトウェア開発事業者の方へ）｜電子政府の総合窓口e-Gov イーガブ](http://www.e-gov.go.jp/shinsei/interface/index.html)  
+    （公式）申請データの構造仕様について
+
+## 注意事項
+
+- kiji を利用する場合、必ず検証環境にて検証を行ってください。
+- すでに最終試験に合格したソフトウェアに kiji を組み込む場合、新たにソフトウェア ID を取得し、再度最終試験に合格する必要があります。（API 利用ガイド p. 20）
+- 最終確認試験にて合格していない API 機能を利用すると当該ソフトウェアからの e-Gov 電子申請システムへの接続が制限されます。ご注意ください。（API 利用ガイド p. 20）
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/kiji/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) 2015 Kensuke NAITO and KUFU, Inc.  
+ライセンスはこちら: [kiji/LICENSE.md](https://github.com/kufu/kiji/blob/master/LICENSE.md)
+
+
+## KUFU について
+
+![KUFU logo](https://raw.githubusercontent.com/wiki/kufu/kiji/images/logo_kufu.png)
+
+kiji は株式会社 KUFU によってメンテナンス、開発が行われています。  
+わたしたちは OSS の力を信じています。  
+
+KUFU では OSS 活動に積極的なエンジニアを募集しています！  
+
+[「雇用」×「国のAPI」をハックする Ruby エンジニア募集！](https://www.wantedly.com/projects/3788)
+

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'kiji'
+
+# 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

data/bin/setup

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

data/egov.gemspec

@@ -0,0 +1,42 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'kiji/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'kiji'
+  spec.version       = Kiji::VERSION
+  spec.authors       = ['kakipo']
+  spec.email         = ['kakipo@gmail.com']
+
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com' to prevent pushes to rubygems.org, or delete to allow pushes to any server."
+  # end
+
+  spec.summary       = 'API toolkits for Japanese e-Gov system'
+  spec.homepage      = 'https://github.com/kufu/kiji'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.8'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'guard'
+  spec.add_development_dependency 'guard-rspec'
+  spec.add_development_dependency 'guard-bundler'
+  spec.add_development_dependency 'guard-rubocop'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'pry-byebug'
+  spec.add_development_dependency 'dotenv'
+  spec.add_development_dependency 'webmock'
+  spec.add_development_dependency 'vcr'
+  spec.add_development_dependency 'rubyzip'
+
+  # spec.add_runtime_dependency 'signer'
+  spec.add_runtime_dependency 'faraday'
+  spec.add_runtime_dependency 'nokogiri'
+  spec.add_runtime_dependency 'activesupport'
+end

data/lib/kiji.rb

@@ -0,0 +1,3 @@
+require 'kiji/version'
+require 'kiji/client'
+require 'kiji/zipper'