japan_net_bank 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5101a750182d7f4f27383be795e6e5208732c5c6
-  data.tar.gz: f1c9a6a639696c052c677be8e2c80099190c1d47
+  metadata.gz: d7d22972368c9139936b4526f77b0a443b73778c
+  data.tar.gz: 7b9c3e388f6c9895e749b9069003e713c75aea4c
 SHA512:
-  metadata.gz: 38e94b58ce4048e8f31a2268cda03f4c403be22585741ec83d731ee3874bde19b0885530099b73c891d842503abc8a7c46866ae0dba096e01f6910c465bcb7be
-  data.tar.gz: ff5fca00e42a98d4d5ea3c91b7f88cc9b390e986dd504111d7eb499d454e102ed225ba7d35ce0662c026afd9f8c5a60c700c7e0a8858aaf9d6565db9e425fd6d
+  metadata.gz: 21770efe16d422c55a16e49406c09db77be0f314cc2a735cc54a34dfe54dc8e3addd41804dbeffba19d202385d5b68fef001517ef539bac2b1c9171ccc9a596a
+  data.tar.gz: 95222b332853af3347b6f536252dff7c43366968ba5b1a765549e60ce48d1e661ddd5ae3086f56619e4e5fe08f13ac5530b29e61419bcf282f4ad379ab455c85

data/README.md

@@ -45,7 +45,7 @@ Or install it yourself as:
 
 ## Usage
 
-### 振込用 CSV を生成
+### Generate CSV for transfer (1)
 
 ```ruby
 transfer_data = [
@@ -58,26 +58,74 @@ transfer_data = [
         amount:       1600,
     },
     {
-        bank_code:    '0999',
-        branch_code:  '099',
+        bank_code:    '0234',
+        branch_code:  '023',
         account_type: 'ordinary',
-        number:       '0999999',
+        number:       '0234567',
         name:         'サトウハナコ',
         amount:       3200,
     }
 ]
 
-csv_string = JapanNetBank::Transfer.new(transfer_data).to_csv
-# or csv_string = JNB::Transfer.new(transfer_data).to_csv
+csv_string = JapanNetBank::Transfer.from_hash_array(transfer_data).to_csv
+# or csv_string = JNB::Transfer.from_hash_array(transfer_data).to_csv
 
-puts csv_string #=> "1,0123,012,1,0123456,ｻﾄｳｷﾃｺ,1600\r\n1,0999,099,1,0999999,ｻﾄｳﾊﾅｺ,3200\r\n2,,,,,2,4800\r\n"
+puts csv_string #=> "1,0123,012,1,0123456,ｻﾄｳｷﾃｺ,1600\r\n1,0234,023,1,0234567,ｻﾄｳﾊﾅｺ,3200\r\n2,,,,,2,4800\r\n"
 ```
 
-### 振込手数料を算出
+### Generate CSV for transfer (2)
+
+```ruby
+row1 = JapanNetBank::Transfer::Row.new(
+    bank_code:    '0123',
+    branch_code:  '012',
+    account_type: 'ordinary', # ordinary / checking / savings
+    number:       '0123456',
+    name:         'サトウキテコ',
+    amount:       1600,
+)
+
+row2 = JapanNetBank::Transfer::Row.new(
+    bank_code:    '0234',
+    branch_code:  '023',
+    account_type: 'ordinary',
+    number:       '0234567',
+    name:         'サトウハナコ',
+    amount:       3200,
+)
+
+transfer = JapanNetBank::Transfer.generate do |t|
+  t << row1
+  t << row2
+end
+
+puts transfer.to_csv #=> "1,0123,012,1,0123456,ｻﾄｳｷﾃｺ,1600\r\n1,0234,023,1,0234567,ｻﾄｳﾊﾅｺ,3200\r\n2,,,,,2,4800\r\n"
+```
+
+### Parse CSV for transfer
+
+```ruby
+puts csv_string #=> "1,0123,012,1,0123456,ｻﾄｳｷﾃｺ,1600\r\n1,0234,023,1,0234567,ｻﾄｳﾊﾅｺ,3200\r\n2,,,,,2,4800\r\n"
+
+transfer = JapanNetBank::Transfer.parse_csv(csv_string)
+# or transfer = JNB::Transfer.parse_csv(csv_string)
+
+transfer.each do |row|
+  puts row.record_type  #=> "1"
+  puts row.bank_code    #=> "0123"
+  puts row.branch_code  #=> "012"
+  puts row.account_type #=> "ordinary" # ordinary / checking / savings
+  puts row.number       #=> "0123456"
+  puts row.name         #=> "サトウキテコ"
+  puts row.amount       #=> 1600
+end
+```
+
+### Transfer fee
 
 ```ruby
 transfer_fee = JapanNetBank::Transfer.fee_for(bank_code: '0123', amount: 30_000)
-# or JNB::Transfer.fee_for(bank_code: '0123', amount: 30_000)
+# or transfer_fee = JNB::Transfer.fee_for(bank_code: '0123', amount: 30_000)
 
 puts transfer_fee #=> 270
 ```

data/japan_net_bank.gemspec

@@ -22,4 +22,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.5"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec"
+  spec.add_development_dependency "pry"
 end

data/lib/japan_net_bank/transfer/csv.rb

@@ -5,9 +5,13 @@ module JapanNetBank
     class CSV
       def self.generate
         csv = ::CSV.new('', row_sep: "\r\n")
-        yield csv
+        yield(csv)
         csv.string
       end
+
+      def self.parse(csv_string)
+        ::CSV.parse(csv_string)
+      end
     end
   end
 end

data/lib/japan_net_bank/transfer/row.rb

@@ -10,18 +10,14 @@ module JapanNetBank
 
       RECORD_TYPE_DATA    = '1'
       RECORD_TYPE_TRAILER = '2'
+      ACCOUNT_TYPES       = { '1' => 'ordinary', '2' => 'checking', '4' => 'savings' }
 
       validates :bank_code, format: { with: /\A\d{4}\z/ }
       validates :branch_code, format: { with: /\A\d{3}\z/ }
       validates :account_type, inclusion: { in: %w(ordinary checking savings) }
       validates :number, format: { with: /\A\d{7}\z/ }
       validates :name, presence: true
-
-      validates :amount,
-          numericality: {
-              only_integer: true,
-              greater_than_or_equal_to: 1
-          }
+      validates :amount, numericality: { only_integer: true, greater_than_or_equal_to: 1 }
 
       def initialize(record_type: RECORD_TYPE_DATA, bank_code: nil, branch_code: nil, account_type: nil, number: nil, name: nil, amount: nil)
         @record_type  = record_type
@@ -30,7 +26,7 @@ module JapanNetBank
         @account_type = account_type
         @number       = number
         @name         = name
-        @amount       = amount
+        @amount       = amount.to_i
 
         raise ArgumentError, errors.full_messages unless valid?
       end

data/lib/japan_net_bank/transfer.rb

@@ -1,63 +1,147 @@
 require 'japan_net_bank/transfer/row'
 require 'japan_net_bank/transfer/csv'
+require 'nkf'
 
 module JapanNetBank
   class Transfer
-    attr_reader :rows_count, :total_amount, :rows
+    include Enumerable
+
+    #
+    # == row_hash, row_array, row の違い
+    #
+    # row_hash = {
+    #     bank_code:    '0123',
+    #     branch_code:  '012',
+    #     account_type: 'ordinary',
+    #     number:       '0123456',
+    #     name:         'サトウキテコ',
+    #     amount:       1600,
+    # }
+    #
+    # row_array: ['1', '0123', '012', '1', '0123456', 'ｻﾄｳｷﾃｺ', '1600']
+    #
+    # row:
+    #   JapanNetBank::Transfer::DataRow オブジェクト or
+    #   JapanNetBank::Transfer::TrailerRow オブジェクト
+    #
 
     FEE_TO_JAPAN_NET_BANK          = 54
     FEE_FOR_AMOUNT_UNDER_30_000    = 172
     FEE_FOR_AMOUNT_AND_OVER_30_000 = 270
 
-    def self.fee_for(bank_code: nil, amount: nil)
-      raise ArgumentError if bank_code.nil? || amount.nil?
+    class << self
+      def from_hash_array(row_hashes)
+        transfer = self.new
+        transfer.append_row_hashes(row_hashes)
+
+        transfer
+      end
+
+      def generate
+        transfer = self.new
+        yield(transfer)
 
-      if bank_code == JapanNetBank::BANK_CODE
-        FEE_TO_JAPAN_NET_BANK
-      elsif amount < 30_000
-        FEE_FOR_AMOUNT_UNDER_30_000
-      elsif amount >= 30_000
-        FEE_FOR_AMOUNT_AND_OVER_30_000
+        transfer
+      end
+
+      def parse_csv(csv_string)
+        transfer        = self.new
+        row_arrays      = JapanNetBank::Transfer::CSV.parse(encode_to_utf8(csv_string))
+        data_row_arrays = select_data_row_arrays(row_arrays)
+
+        transfer.append_row_arrays(data_row_arrays)
+
+        transfer
+      end
+
+      def fee_for(bank_code: nil, amount: nil)
+        raise ArgumentError if bank_code.nil? || amount.nil?
+
+        if bank_code == JapanNetBank::BANK_CODE
+          FEE_TO_JAPAN_NET_BANK
+        elsif amount < 30_000
+          FEE_FOR_AMOUNT_UNDER_30_000
+        elsif amount >= 30_000
+          FEE_FOR_AMOUNT_AND_OVER_30_000
+        end
+      end
+
+      private
+
+      def select_data_row_arrays(row_arrays)
+        row_arrays.select { |row_array| row_array[0] == JapanNetBank::Transfer::Row::RECORD_TYPE_DATA }
+      end
+
+      def encode_to_utf8(string)
+        # 単純に下記だと、"カ)" の部分が落ちてしまうため
+        # NKF.nkf('-w -X', string)
+
+        NKF.nkf('-w -X', string.encode('UTF-8', NKF.guess(string).to_s))
       end
     end
 
-    def initialize(rows)
+    attr_reader :rows_count, :total_amount, :rows
+
+    def initialize
       @rows         = []
       @rows_count   = 0
       @total_amount = 0
+    end
 
-      rows.each do |row|
-        append_row(row)
+    def append_row_hashes(row_hashes)
+      row_hashes.each do |row_hash|
+        append_row(JapanNetBank::Transfer::Row.new(row_hash))
       end
+    end
+
+    def append_row_arrays(row_arrays)
+      row_arrays.each do |row_array|
+        append_row(JapanNetBank::Transfer::Row.new(row_array_to_hash(row_array)))
+      end
+    end
 
-      add_trailer_row
+    def <<(row)
+      append_row(row)
     end
 
     def to_csv
-      csv_string = JapanNetBank::Transfer::CSV.generate do |csv|
+      JapanNetBank::Transfer::CSV.generate do |csv|
         @rows.each do |row|
-          csv << row
+          csv << row.to_a
         end
+
+        csv << trailer_row if @rows_count > 0
       end
+    end
 
-      csv_string
+    def each
+      @rows.each do |row|
+        yield row
+      end
     end
 
     private
 
     def append_row(row)
-      @rows << JapanNetBank::Transfer::Row.new(row).to_a
+      @rows << row
       @rows_count   += 1
-      @total_amount += row[:amount].to_i
+      @total_amount += row.amount
     end
 
-    def add_trailer_row
-      return if @rows_count.zero?
-      @rows << trailer_row
+    def row_array_to_hash(row_array)
+      {
+          record_type:  row_array[0],
+          bank_code:    sprintf('%04d', row_array[1]),
+          branch_code:  sprintf('%03d', row_array[2]),
+          account_type: JapanNetBank::Transfer::Row::ACCOUNT_TYPES[row_array[3]],
+          number:       sprintf('%07d', row_array[4]),
+          name:         row_array[5],
+          amount:       row_array[6],
+      }
     end
 
     def trailer_row
-      [Row::RECORD_TYPE_TRAILER, nil, nil, nil, nil, @rows_count, @total_amount]
+      [JapanNetBank::Transfer::Row::RECORD_TYPE_TRAILER, nil, nil, nil, nil, @rows_count, @total_amount]
     end
   end
 end

data/lib/japan_net_bank/version.rb

@@ -1,3 +1,3 @@
 module JapanNetBank
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/spec/files/sample_jnb.csv

@@ -0,0 +1,11 @@
+1,33,1,1,1111111,�)��ݼֳ��,1000,�������۳
+1,33,1,1,2222222,�)���ļֳ��,1000,�������۳
+1,33,1,1,3333333,��ݺ���ֳ(�,1000,�������۳
+1,33,1,1,4444444,����ֳ��(�,1000,�������۳
+1,33,1,1,5555555,�ij�ź,1000,�������۳
+1,33,1,1,6666666,�ij�۳,1000,�������۳
+1,33,1,1,7777777,�޲)���ٷֳ��,1000,�������۳
+1,33,1,1,8888888,�-.��-�i�,1000,�������۳
+1,33,1,1,9999999,����(�)��ݼ�Ѽ�,1000,�������۳
+1,33,1,1,1234567,����ݸ���(�,1000,�������۳
+2,,,,,10,10000,

data/spec/japan_net_bank/transfer_spec.rb

@@ -24,8 +24,84 @@ describe JapanNetBank::Transfer do
     }
   }
 
-  let(:rows) { [row_hash1, row_hash2] }
-  let(:transfer) { JapanNetBank::Transfer.new(rows) }
+  let(:row_hashes) { [row_hash1, row_hash2] }
+  let(:transfer) { JapanNetBank::Transfer.from_hash_array(row_hashes) }
+  let(:transfer_data) { File.read('spec/files/sample_jnb.csv') } # Shift_JIS
+
+  describe 'self.from_hash_array' do
+    context '正しい振込データが渡されたとき' do
+      it 'データ行が追加されたデータを生成できる' do
+        data_row1 = transfer.rows.first
+
+        expect(data_row1.bank_code).to eq '0123'
+        expect(data_row1.branch_code).to eq '012'
+        expect(data_row1.account_type).to eq 'ordinary'
+        expect(data_row1.number).to eq '0123456'
+        expect(data_row1.name).to eq 'サトウキテコ'
+        expect(data_row1.amount).to eq 1600
+
+        expect(transfer.rows_count).to eq 2
+        expect(transfer.total_amount).to eq 4800
+      end
+    end
+
+    context 'フォーマットの誤った振込データが渡されたとき' do
+      let(:invalid_row_hash) {
+        {
+            bank_code:    '012',
+            branch_code:  '01',
+            account_type: 'invalid',
+            number:       '012345',
+            # name: を削除している
+            amount:       1.5,
+        }
+      }
+
+      it 'ArgumentError が発生する' do
+        expect {
+          JapanNetBank::Transfer.from_hash_array([invalid_row_hash])
+        }.to raise_error(ArgumentError)
+      end
+    end
+  end
+
+  describe 'self.generate' do
+    let(:row1) { JapanNetBank::Transfer::Row.new(row_hash1) }
+    let(:row2) { JapanNetBank::Transfer::Row.new(row_hash2) }
+
+    it 'Transfer#rows に Row オブジェクトが追加される' do
+      transfer = JapanNetBank::Transfer.generate do |t|
+        t << row1
+        t << row2
+      end
+
+      data_row1 = transfer.rows.first
+
+      expect(data_row1.bank_code).to eq '0123'
+      expect(data_row1.branch_code).to eq '012'
+      expect(data_row1.account_type).to eq 'ordinary'
+      expect(data_row1.number).to eq '0123456'
+      expect(data_row1.name).to eq 'サトウキテコ'
+      expect(data_row1.amount).to eq 1600
+
+      expect(transfer.rows_count).to eq 2
+      expect(transfer.total_amount).to eq 4800
+    end
+  end
+
+  describe 'self.parse_csv' do
+    it 'CSV データを読み込むことができる' do
+      row1 = JapanNetBank::Transfer.parse_csv(transfer_data).rows.first
+
+      expect(row1.record_type).to eq '1'
+      expect(row1.bank_code).to eq '0033'
+      expect(row1.branch_code).to eq '001'
+      expect(row1.account_type).to eq 'ordinary'
+      expect(row1.number).to eq '1111111'
+      expect(row1.name).to eq 'カ)ニホンシヨウジ'
+      expect(row1.amount).to eq 1000
+    end
+  end
 
   describe 'self.fee_for' do
     context 'ジャパンネット銀行への振込のとき' do
@@ -52,37 +128,19 @@ describe JapanNetBank::Transfer do
     end
   end
 
-  describe '#initialize' do
-    context '振込データが正しいとき' do
-      it 'トレーラー行が追加されたデータを生成できる' do
-        row1 = JapanNetBank::Transfer::Row.new(row_hash1).to_a
-        row2 = JapanNetBank::Transfer::Row.new(row_hash2).to_a
-
-        trailer_row = [
-            JapanNetBank::Transfer::Row::RECORD_TYPE_TRAILER,
-            nil, nil, nil, nil, 2, 4800
-        ]
-
-        expect(transfer.rows).to eq [row1, row2, trailer_row]
+  describe 'self.encode_to_utf8' do
+    context 'Shift_JIS の文字列を渡したとき' do
+      it 'UTF-8 の文字列を取得できる（全角カタカナ）' do
+        expect(JapanNetBank::Transfer.send(:encode_to_utf8, transfer_data)).to match 'カ\)ニホンシヨウジ'
       end
     end
 
-    context '振込データのフォーマットに誤りがあるとき' do
-      let(:invalid_row_hash) {
-        {
-            bank_code:    '012',
-            branch_code:  '01',
-            account_type: 'invalid',
-            number:       '012345',
-            # name: を削除している
-            amount:       1.5,
-        }
-      }
+    context '既に UTF-8 に変換した文字列を渡したとき' do
+      let(:utf8_string) { transfer_data.encode('UTF-8', 'Shift_JIS') }
 
-      it 'ArgumentError が発生する' do
-        expect {
-          JapanNetBank::Transfer.new([invalid_row_hash])
-        }.to raise_error(ArgumentError)
+      it 'UTF-8 の文字列を取得できる（全角カタカナ）' do
+        expect(utf8_string).to match /ｶ\)ﾆﾎﾝｼﾖｳｼﾞ/
+        expect(JapanNetBank::Transfer.send(:encode_to_utf8, utf8_string)).to match 'カ\)ニホンシヨウジ'
       end
     end
   end
@@ -101,15 +159,19 @@ describe JapanNetBank::Transfer do
 
   describe '#to_csv' do
     it 'CSV 文字列を取得できる' do
-      csv_row1 = JapanNetBank::Transfer::Row.new(row_hash1).to_a.join(',')
-      csv_row2 = JapanNetBank::Transfer::Row.new(row_hash2).to_a.join(',')
+      row_array1        = JapanNetBank::Transfer::Row.new(row_hash1).to_a.join(',')
+      row_array2        = JapanNetBank::Transfer::Row.new(row_hash2).to_a.join(',')
+      trailer_row_array = [JapanNetBank::Transfer::Row::RECORD_TYPE_TRAILER, nil, nil, nil, nil, 2, 4800].join(',')
 
-      csv_trailer_row = [
-          JapanNetBank::Transfer::Row::RECORD_TYPE_TRAILER,
-          nil, nil, nil, nil, 2, 4800
-      ].join(',')
+      expect(transfer.to_csv).to eq row_array1 + "\r\n" + row_array2 + "\r\n" + trailer_row_array + "\r\n"
+    end
+  end
 
-      expect(transfer.to_csv).to eq csv_row1 + "\r\n" + csv_row2 + "\r\n" + csv_trailer_row + "\r\n"
+  describe '#each' do
+    it 'rows を走査できる' do
+      JapanNetBank::Transfer.parse_csv(transfer_data).each do |row|
+        expect(row.class).to eq JapanNetBank::Transfer::Row
+      end
     end
   end
 end

data/spec/japan_net_bank_spec.rb

@@ -6,7 +6,7 @@ describe JapanNetBank do
   end
 
   it 'JNB でもアクセスできる' do
-    rows = [
+    row_hashes = [
         {
             bank_code:    '0123',
             branch_code:  '012',
@@ -14,11 +14,19 @@ describe JapanNetBank do
             number:       '0123456',
             name:         'サトウキテコ',
             amount:       1600,
+        },
+        {
+            bank_code:    '0123',
+            branch_code:  '012',
+            account_type: 'ordinary',
+            number:       '0999999',
+            name:         'サトウハナコ',
+            amount:       3200,
         }
     ]
 
     expect {
-      JNB::Transfer.new(rows).to_csv
+      JNB::Transfer.from_hash_array(row_hashes).to_csv
     }.not_to raise_error
   end
 end

data/spec/spec_helper.rb

@@ -1,2 +1,3 @@
 $LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
 require 'japan_net_bank'
+require 'pry'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: japan_net_bank
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - INOUE Takuya
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-26 00:00:00.000000000 Z
+date: 2014-06-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -66,6 +66,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: The best way to generate Japan Net Bank CSV to transfer.
 email:
 - inouetakuya5@gmail.com
@@ -86,7 +100,8 @@ files:
 - lib/japan_net_bank/transfer/csv.rb
 - lib/japan_net_bank/transfer/row.rb
 - lib/japan_net_bank/version.rb
-- spec/japan_net_bank/transfer/row_spec.rb
+- spec/files/sample_jnb.csv
+- spec/japan_net_bank/transfer/data_row_spec.rb
 - spec/japan_net_bank/transfer_spec.rb
 - spec/japan_net_bank_spec.rb
 - spec/spec_helper.rb
@@ -116,7 +131,8 @@ signing_key:
 specification_version: 4
 summary: A toolkit for generating Japan Net Bank CSV to transfer.
 test_files:
-- spec/japan_net_bank/transfer/row_spec.rb
+- spec/files/sample_jnb.csv
+- spec/japan_net_bank/transfer/data_row_spec.rb
 - spec/japan_net_bank/transfer_spec.rb
 - spec/japan_net_bank_spec.rb
 - spec/spec_helper.rb