ifsc 0.0.1

data/tests/ruby/ifsc_spec.rb

@@ -0,0 +1,113 @@
+require 'ifsc'
+
+describe Razorpay::IFSC::IFSC do
+  let(:mocked_response) do
+    {
+      'BANK' => 'Kotak Mahindra Bank',
+      'IFSC' => 'KKBK0000261',
+      'BRANCH' => 'GURGAON',
+      'ADDRESS' => 'JMD REGENT SQUARE,MEHRAULI GURGAON ROAD,OPPOSITE BRISTOL HOTEL,',
+      'CONTACT' => '4131000',
+      'CITY' => 'GURGAON',
+      'DISTRICT' => 'GURGAON',
+      'STATE' => 'HARYAN'
+    }
+  end
+  let(:dummy_code) { 'foo' }
+  let(:code_double) { double('code double') }
+  let(:code) { described_class.new(mocked_response['IFSC']) }
+
+  describe '.get' do
+    before do
+      allow(code).to receive(:api_data).and_return(mocked_response)
+    end
+
+    it 'should parse the IFSC details correctly from the server' do
+      fetched_code = code.get
+
+      expect(fetched_code.bank).to eq mocked_response['BANK']
+      expect(fetched_code.ifsc).to eq mocked_response['IFSC']
+      expect(fetched_code.branch).to eq mocked_response['BRANCH']
+      expect(fetched_code.address).to eq mocked_response['ADDRESS']
+      expect(fetched_code.contact).to eq mocked_response['CONTACT']
+      expect(fetched_code.city).to eq mocked_response['CITY']
+      expect(fetched_code.district).to eq mocked_response['DISTRICT']
+      expect(fetched_code.state).to eq mocked_response['STATE']
+    end
+
+    it 'should set @valid to true and skip local validation' do
+      fetched_code = code.get
+
+      expect(fetched_code.instance_variable_get(:@valid)).to eq true
+      expect(fetched_code.valid?).to eq true
+    end
+  end
+
+  describe '.get_bank_name' do
+    before do
+      allow(code).to receive(:api_data).and_return(mocked_response)
+    end
+
+    it 'should load the bank name into the object' do
+      expect(code.bank).to be_nil
+      code.get
+      expect(code.bank).to eq mocked_response['BANK']
+    end
+  end
+
+  describe '.class' do
+    describe '.find' do
+      it 'should validate and return the fetched object' do
+        expect(described_class).to receive(:new).with(dummy_code).and_return(code_double)
+        expect(code_double).to receive(:get)
+        described_class.find(dummy_code)
+      end
+    end
+
+    describe '#bank_name_for(code)' do
+      it 'should return the correct bank name' do
+        expect(described_class.bank_name_for(mocked_response['IFSC'])).to eq mocked_response['BANK']
+      end
+
+      it 'should return the correct sublet bank name' do
+        expect(described_class.bank_name_for('ALLA0AU1002')).to eq 'Allahabad Up Gramin Bank'
+      end
+    end
+
+    describe '#valid?' do
+      it 'should validate regular numeric branch codes' do
+        expect(described_class.valid?('KKBK0000261')).to eq true
+        expect(described_class.valid?('HDFC0002854')).to eq true
+        expect(described_class.valid?('KARB0000001')).to eq true
+      end
+
+      it 'should validate range branch codes' do
+        expect(described_class.valid?('DLXB0000097')).to eq true
+      end
+
+      it 'should validate string branch codes' do
+        expect(described_class.valid?('BOTM0NEEMRA')).to eq true
+        expect(described_class.valid?('BARB0ZOOTIN')).to eq true
+      end
+
+      it 'should not validate invalid codes' do
+        expect(described_class.valid?('BOTM0XEEMRA')).to eq false
+        expect(described_class.valid?('BOTX0000000')).to eq false
+        expect(described_class.valid?('BOTX0000500')).to eq false
+        expect(described_class.valid?('BOTM0000500')).to eq false
+        expect(described_class.valid?('DLXB0000500')).to eq false
+      end
+    end
+
+    describe '#validate!' do
+      context 'when valid? returns false' do
+        before do
+          allow(described_class).to receive(:valid?).with(dummy_code).and_return(false)
+        end
+        it 'should raise an error when validations fail' do
+          expect { described_class.validate!(dummy_code) }.to raise_error(Razorpay::IFSC::InvalidCodeError)
+        end
+      end
+    end
+  end
+end

data/tests/ruby/validate_spec.rb

@@ -0,0 +1,13 @@
+require 'ifsc'
+
+describe Razorpay::IFSC::IFSC do
+  tests = JSON.parse File.read 'tests/validator_asserts.json'
+
+  tests.each do |test_name, test_cases|
+    it  "should #{test_name}" do
+      test_cases.each do |ifsc, expected_value|
+        expect(Razorpay::IFSC::IFSC.valid? ifsc).to eq expected_value
+      end
+    end
+  end
+end

data/tests/validator_asserts.json

@@ -0,0 +1,26 @@
+{
+	"testBasicValidator": {
+		"KKBK0000261": true,
+		"HDFC0002854": true,
+		"KARB0000001": true
+	},
+	"testValidateInsideRange": {
+		"DLXB0000097": true
+	},
+	"testValidateStringLookup": {
+		"BOTM0NEEMRA": true,
+		"BARB0ZOOTIN": true
+	},
+	"testValidateInvalidCode": {
+		"BOTM0XEEMRA": false,
+		"BOTX0XEEMRA": false,
+		"BOTX0000000": false,
+		"BOTX0000500": false,
+		"BOTM0000500": false,
+		"DLXB0000500": false
+	},
+	"testHPSC": {
+		"HPSC0000406": true,
+		"HPSC0000300": false
+	}
+}

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: ifsc
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Abhay Rana
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-08-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.5'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+description: A simple gem by @razorpay to help you validate your IFSC codes. IFSC
+  codes are bank codes within India
+email:
+- nemo@razorpay.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CONTRIBUTING.md
+- Gemfile
+- README.md
+- ifsc.gemspec
+- src/IFSC.json
+- src/banknames.json
+- src/ruby/ifsc.rb
+- src/sublet.json
+- tests/ruby/ifsc_spec.rb
+- tests/ruby/validate_spec.rb
+- tests/validator_asserts.json
+homepage: https://ifsc.razorpay.com
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- src/ruby
+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.6.12
+signing_key: 
+specification_version: 4
+summary: IFSC code database to help you validate IFSC codes
+test_files:
+- tests/ruby/ifsc_spec.rb
+- tests/ruby/validate_spec.rb
+- tests/validator_asserts.json