security_identifiers 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2966f074a72f9e3b0937e0d66ee7738f735da794
-  data.tar.gz: efdb4c760ec5945b8a5e2a90c2f046eeb4c4a898
+  metadata.gz: 8d4a1a164bc410f563cc724a23854d04ecfa5f56
+  data.tar.gz: 6ae673ffb5413e871201358c2b2c2da695b81a75
 SHA512:
-  metadata.gz: 0e2c726c65b626c4cbb6f6d992b013a8c2280ee6ae3f7a30da5731951b56f0890684eef22f938d1e6b3218513c383108010cb81a8d3b826f2871198be3dbc2df
-  data.tar.gz: 0ec8c45c8a1a9665e4f3293e55e4125b81779b25e2f3e353b8c6d9f35e0d11272a609b2e8084990ff6a7a48db3034fe24f57a2d549cb49ed39361982fae8a122
+  metadata.gz: 16cd1df966a268205dc28469b74b873196466576f7e4f689072f4f2301ea77831a4cdf93f6f41a40bb28c578e7483c8bda290e4fbeea5eaf6d072d5ae07df0cd
+  data.tar.gz: 4faeb36286a5d64b6b2f57b1bf9e7afb57c6664cc3a53932d013bee1f12d1143967e325b49a2dc09f2c393eda37568a8cc0a1e97a5e5bbfd78664b1d5e27a73f

data/.gitignore

@@ -16,3 +16,5 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+
+.rubocop-http*

data/.rubocop.yml

@@ -0,0 +1,2 @@
+inherit_from:
+  - https://raw.githubusercontent.com/invisiblelines/style-guide/master/ruby/.rubocop.yml

data/.travis.yml

@@ -1,8 +1,16 @@
+sudo: false
 language: ruby
 rvm:
-  - 2.2.0
-  - 2.1.0
-  - 2.0.0
-  - 1.9.3
-  - jruby-19mode
+  - 2.4.0
+  - 2.3.3
+  - 2.2.6
+  - jruby-9.1.5.0
+  - jruby-head
   - ruby-head
+cache:
+  bundler: true
+
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+    - rvm: jruby-head

data/README.md

@@ -47,7 +47,7 @@ Now you can validate
 
     isin.valid? # => true
 
-The same method apply to CUSIPs and SEDOLs.
+The same method applies to CUSIPs and SEDOLs.
 
 CUSIPs and SEDOLs also support converting these identifiers to ISINs.
 

data/Rakefile

@@ -1,8 +1,8 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task" 
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
-RSpec::Core::RakeTask.new(:spec) 
+RSpec::Core::RakeTask.new(:spec)
 
-task :spec 
+task :spec
 
-task :default => :spec 
+task default: :spec

data/lib/security_identifiers/base.rb

@@ -1,10 +1,8 @@
 module SecurityIdentifiers
-
   class InvalidFormat < StandardError; end
   class InvalidConversion < StandardError; end
 
   class Base
-
     attr_reader :original_check_digit
 
     def valid?
@@ -17,22 +15,31 @@ module SecurityIdentifiers
 
     private
 
-      def digits
-        @digits ||= @identifier.split('').map { |i| i.match(/[A-Z]/) ? (i.ord - 55) : i.to_i }
-      end
+    def digits_for(char)
+      return char.to_i unless char =~ /[A-Z]/
 
-      def even_values
-        @even_values ||= digits.values_at(* digits.each_index.select { |i| i.even? })
-      end
+      ord = char.to_i(36)
+      [ord / 10, ord % 10]
+    end
 
-      def odd_values
-        @odd_values ||= digits.values_at(* digits.each_index.select { |i| i.odd? })
-      end
+    def digits
+      @digits ||= @identifier.each_char.flat_map { |char| digits_for(char) }
+    end
 
-      def fix!
-        @original_check_digit = check_digit
-      end
+    def even_values
+      @even_values ||= digits.select.with_index(1) { |digit, i| i.even? && digit }
+    end
 
-  end
+    def odd_values
+      @odd_values ||= digits.select.with_index(1) { |digit, i| i.odd? && digit }
+    end
+
+    def fix!
+      @original_check_digit = check_digit
+    end
 
+    def mod_10(sum)
+      (10 - sum % 10) % 10
+    end
+  end
 end

data/lib/security_identifiers/cusip.rb

@@ -1,11 +1,15 @@
 module SecurityIdentifiers
-
   class CUSIP < Base
+    SYMBOLS = {
+      '*' => [3, 6],
+      '@' => [3, 7],
+      '#' => [3, 8]
+    }.freeze
 
     def initialize(str)
       raise InvalidFormat if str.nil?
 
-      match_data = str.upcase.match(/^([A-Z0-9]{8})(\d{1})?$/)
+      match_data = str.upcase.match(/^([A-Z0-9\*@#]{8})(\d{1})?$/)
 
       raise InvalidFormat if match_data.nil?
 
@@ -15,21 +19,27 @@ module SecurityIdentifiers
     end
 
     def check_digit
-      values = odd_values.map { |i| i * 2 }.zip(even_values).flatten
+      values = even_values.map { |i| i * 2 }.zip(odd_values).flatten
 
-      values = values.inject(0) do |sum, i|
-        sum += (i / 10) + i % 10
+      sum = values.inject(0) do |result, i|
+        result + (i / 10) + i % 10
       end
 
-      ((10 - values) % 10) % 10
+      mod_10(sum)
     end
 
     def to_isin(iso = 'US')
-      raise InvalidConversion if !['US', 'CA'].include?(iso)
+      raise InvalidConversion unless %w(US CA).include?(iso)
 
       ISIN.new([iso, @identifier, check_digit].join)
     end
 
-  end
+    private
+
+    def digits_for(char)
+      return SYMBOLS[char] if SYMBOLS.key?(char)
 
+      super
+    end
+  end
 end

data/lib/security_identifiers/isin.rb

@@ -1,7 +1,5 @@
 module SecurityIdentifiers
-
   class ISIN < Base
-
     def initialize(str)
       raise InvalidFormat if str.nil?
 
@@ -15,25 +13,22 @@ module SecurityIdentifiers
     end
 
     def check_digit
-      longest, shortest = if even_values.last == digits.last
-         [even_values, odd_values]
-      else
-        [odd_values, even_values]
-      end
+      first_group, second_group = digit_groups
+      first_group.map! { |d| d * 2 }
 
-      longest = longest.map { |i| i * 2 }
-      values  = (longest.concat(shortest)).to_s.scan(/./).map(&:to_i)
-      sum     = values.inject(&:+)
+      sum = (first_group + second_group).join.each_char.inject(0) { |result, i| result + i.to_i }
 
-      (10 - (sum % 10)) % 10
+      mod_10(sum)
     end
 
-    protected
+    private
 
-      def digits
-        @digits ||= super.join('').split('').map(&:to_i)
+    def digit_groups
+      if digits.size.even?
+        [even_values, odd_values]
+      else
+        [odd_values, even_values]
       end
-
+    end
   end
-
 end

data/lib/security_identifiers/sedol.rb

@@ -1,6 +1,6 @@
 module SecurityIdentifiers
-
   class SEDOL < Base
+    WEIGHTS = [1, 3, 1, 7, 3, 9, 1].freeze
 
     def initialize(str)
       raise InvalidFormat if str.nil?
@@ -15,22 +15,23 @@ module SecurityIdentifiers
     end
 
     def check_digit
-      weights = [1, 3, 1, 7, 3, 9, 1]
-      sum     = 0
-
-      digits.each_with_index do |i, idx|
-        sum += weights[idx] * i
+      sum = digits.each_with_index.inject(0) do |result, (i, idx)|
+        result + WEIGHTS[idx] * i
       end
 
-      (10 - sum % 10) % 10
+      mod_10(sum)
     end
 
-    def to_isin(iso='GB')
-      raise InvalidConversion if !['GB', 'IE'].include?(iso)
+    def to_isin(iso = 'GB')
+      raise InvalidConversion unless %w(GB IE).include?(iso)
 
       ISIN.new([iso, '00', @identifier, check_digit].join)
     end
 
-  end
+    private
 
+    def digits_for(char)
+      char =~ /[A-Z]/ ? char.to_i(36) : char.to_i
+    end
+  end
 end

data/lib/security_identifiers/validations/cusip_validator.rb

@@ -1,23 +1,13 @@
 module SecurityIdentifiers
-
   module Validations
-
     class CusipValidator < ActiveModel::EachValidator
-
       def validate_each(record, attribute, value)
-        begin
-          cusip = CUSIP.new(value)
+        cusip = CUSIP.new(value)
 
-          unless cusip.valid?
-            record.errors[attribute] << 'does not have a valid check digit'
-          end
-        rescue SecurityIdentifiers::InvalidFormat
-          record.errors[attribute] << 'is not in the correct format'
-        end
+        record.errors[attribute] << 'does not have a valid check digit' unless cusip.valid?
+      rescue SecurityIdentifiers::InvalidFormat
+        record.errors[attribute] << 'is not in the correct format'
       end
-
     end
-
   end
-
 end

data/lib/security_identifiers/validations/isin_validator.rb

@@ -1,23 +1,13 @@
 module SecurityIdentifiers
-
   module Validations
-
     class IsinValidator < ActiveModel::EachValidator
-
       def validate_each(record, attribute, value)
-        begin
-          isin = ISIN.new(value)
+        isin = ISIN.new(value)
 
-          unless isin.valid?
-            record.errors[attribute] << 'does not have a valid check digit'
-          end
-        rescue SecurityIdentifiers::InvalidFormat
-          record.errors[attribute] << 'is not in the correct format'
-        end
+        record.errors[attribute] << 'does not have a valid check digit' unless isin.valid?
+      rescue SecurityIdentifiers::InvalidFormat
+        record.errors[attribute] << 'is not in the correct format'
       end
-
     end
-
   end
-
 end

data/lib/security_identifiers/validations/sedol_validator.rb

@@ -1,23 +1,13 @@
 module SecurityIdentifiers
-
   module Validations
-
     class SedolValidator < ActiveModel::EachValidator
-
       def validate_each(record, attribute, value)
-        begin
-          sedol = SEDOL.new(value)
+        sedol = SEDOL.new(value)
 
-          unless sedol.valid?
-            record.errors[attribute] << 'does not have a valid check digit'
-          end
-        rescue SecurityIdentifiers::InvalidFormat
-          record.errors[attribute] << 'is not in the correct format'
-        end
+        record.errors[attribute] << 'does not have a valid check digit' unless sedol.valid?
+      rescue SecurityIdentifiers::InvalidFormat
+        record.errors[attribute] << 'is not in the correct format'
       end
-
     end
-
   end
-
 end

data/lib/security_identifiers/version.rb

@@ -1,5 +1,3 @@
 module SecurityIdentifiers
-
-  VERSION = '0.1.1'
-
+  VERSION = '0.2.0'.freeze
 end

data/security_identifiers.gemspec

@@ -5,25 +5,25 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'security_identifiers/version'
 
 Gem::Specification.new do |s|
-  s.name          = "security_identifiers"
+  s.name          = 'security_identifiers'
   s.version       = SecurityIdentifiers::VERSION
-  s.authors       = ["Kieran Johnson"]
-  s.email         = ["hello@invisiblelines.com"]
-  s.summary       = %q{Security Identifier validation library for Ruby}
-  s.description   = s.summary
-  s.homepage      = ""
-  s.license       = "MIT"
+  s.authors       = ['Kieran Johnson']
+  s.email         = ['hello@invisiblelines.com']
+  s.summary       = 'Security Identifier validation library for Ruby'
+  s.description   = 'Validate ISIN, CUSIP and SEDOL codes'
+  s.homepage      = 'https://github.com/invisiblelines/security_identifiers'
+  s.license       = 'MIT'
 
-  s.files         = `git ls-files`.split($/)
+  s.files         = `git ls-files`.split($RS)
   s.executables   = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
   s.test_files    = s.files.grep(%r{^(test|spec|features)/})
-  s.require_paths = ["lib"]
+  s.require_paths = ['lib']
 
   s.add_development_dependency 'bundler', '~> 1.3'
-  s.add_development_dependency 'rake'
-  s.add_development_dependency 'activemodel'
+  s.add_development_dependency 'rake', '~> 12.0', '>= 12.0.0'
+  s.add_development_dependency 'activemodel', '5.0.2'
   s.add_development_dependency 'guard', '2.12.1'
   s.add_development_dependency 'guard-rspec', '4.5.0'
-
-  s.add_development_dependency 'rspec', '~> 3.2.0'
+  s.add_development_dependency 'rspec', '~> 3.5', '>= 3.5.0'
+  s.add_development_dependency 'rubocop', '0.47.1'
 end

data/spec/cusip_spec.rb

@@ -1,7 +1,6 @@
 require 'spec_helper'
 
 describe CUSIP do
-
   it 'is invalid without 8 character alpha-numeric identifier' do
     expect { CUSIP.new('5509BG3') }.to raise_error(SecurityIdentifiers::InvalidFormat)
   end
@@ -38,6 +37,18 @@ describe CUSIP do
     end
   end
 
+  context 'Valid PPN codes' do
+    let(:cusip) { CUSIP.new('00800*AA6') }
+
+    it 'calculates the check digit' do
+      expect(cusip.check_digit).to eql(cusip.original_check_digit.to_i)
+    end
+
+    it 'validates the check digit' do
+      expect(cusip).to be_valid
+    end
+  end
+
   context 'Invalid check digit' do
     let(:cusip) { CUSIP.new('125509BG4') }
 
@@ -69,5 +80,4 @@ describe CUSIP do
       expect(cusip.to_s).to eql('125509BG3')
     end
   end
-
 end

data/spec/isin_spec.rb

@@ -1,7 +1,6 @@
 require 'spec_helper'
 
 describe ISIN do
-
   it 'is invalid without a country code' do
     expect { ISIN.new('120378331004') }.to raise_error(SecurityIdentifiers::InvalidFormat)
   end
@@ -42,6 +41,30 @@ describe ISIN do
     end
   end
 
+  context 'Regression alphanumeric ISIN' do
+    let(:isin) { ISIN.new('CA26210W1005') }
+
+    it 'calculates the check digit' do
+      expect(isin.check_digit).to eql(5)
+    end
+
+    it 'validates the check digit' do
+      expect(isin).to be_valid
+    end
+  end
+
+  context 'Valid alphanumeric ISIN ETF' do
+    let(:isin) { ISIN.new('IE00B3RBWM25') }
+
+    it 'calculates the check digit' do
+      expect(isin.check_digit).to eql(5)
+    end
+
+    it 'validates the check digit' do
+      expect(isin).to be_valid
+    end
+  end
+
   context 'Invalid check digit' do
     let(:isin) { ISIN.new('US0378331004') }
 
@@ -50,6 +73,14 @@ describe ISIN do
     end
   end
 
+  context 'Invalid check digit ETF' do
+    let(:isin) { ISIN.new('IE00B3RBWM24') }
+
+    it 'validates the check digit' do
+      expect(isin).to_not be_valid
+    end
+  end
+
   context '#to_s' do
     let(:isin) { ISIN.new('AU0000XVGZA3') }
 
@@ -57,5 +88,4 @@ describe ISIN do
       expect(isin.to_s).to eql('AU0000XVGZA3')
     end
   end
-
 end

data/spec/sedol_spec.rb

@@ -1,7 +1,6 @@
 require 'spec_helper'
 
 describe SEDOL do
-
   it 'is invalid without 6 character alpha-numeric identifier' do
     expect { SEDOL.new('B0WNL') }.to raise_error(SecurityIdentifiers::InvalidFormat)
   end
@@ -49,5 +48,4 @@ describe SEDOL do
       expect(sedol.to_s).to eql('B0WNLY7')
     end
   end
-
 end

data/spec/validations/cusip_validator_spec.rb

@@ -1,9 +1,7 @@
 require 'spec_helper'
 
 describe Validations::CusipValidator do
-
   context 'with invalid cusip' do
-
     subject { Security.new(cusip: '5509BG3') }
 
     it 'is invalid' do
@@ -12,12 +10,10 @@ describe Validations::CusipValidator do
   end
 
   context 'with cusip' do
-
     subject { Security.new(cusip: '125509BG3') }
 
     it 'is valid' do
       expect(subject).to be_valid
     end
   end
-
 end

data/spec/validations/isin_validator_spec.rb

@@ -1,7 +1,6 @@
 require 'spec_helper'
 
 describe Validations::IsinValidator do
-
   context 'without isin' do
     subject { Security.new(isin: 'US03783310') }
 
@@ -17,5 +16,4 @@ describe Validations::IsinValidator do
       expect(subject).to be_valid
     end
   end
-
 end

data/spec/validations/sedol_validator_spec.rb

@@ -1,7 +1,6 @@
 require 'spec_helper'
 
 describe Validations::SedolValidator do
-
   context 'without sedol' do
     subject { Security.new(sedol: 'BOWN') }
 
@@ -11,12 +10,10 @@ describe Validations::SedolValidator do
   end
 
   context 'with sedol' do
-
     subject { Security.new(sedol: 'B0WNLY7') }
 
     it 'is valid' do
       expect(subject).to be_valid
     end
   end
-
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: security_identifiers
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Kieran Johnson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-11 00:00:00.000000000 Z
+date: 2017-03-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -28,30 +28,36 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 12.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 12.0.0
 - !ruby/object:Gem::Dependency
   name: activemodel
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 5.0.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 5.0.2
 - !ruby/object:Gem::Dependency
   name: guard
   requirement: !ruby/object:Gem::Requirement
@@ -86,15 +92,35 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.2.0
+        version: '3.5'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.5.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.2.0
-description: Security Identifier validation library for Ruby
+        version: '3.5'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.47.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.47.1
+description: Validate ISIN, CUSIP and SEDOL codes
 email:
 - hello@invisiblelines.com
 executables: []
@@ -102,6 +128,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rubocop.yml"
 - ".travis.yml"
 - Gemfile
 - Guardfile
@@ -125,7 +152,7 @@ files:
 - spec/validations/cusip_validator_spec.rb
 - spec/validations/isin_validator_spec.rb
 - spec/validations/sedol_validator_spec.rb
-homepage: ''
+homepage: https://github.com/invisiblelines/security_identifiers
 licenses:
 - MIT
 metadata: {}
@@ -145,7 +172,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: Security Identifier validation library for Ruby