sec_id 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0f9406f82fc8d468dff0ada3da32d7c9a3cf69d3f18e57eee32c146bf4d7057e
-  data.tar.gz: 8b85da6d43ebd5c46daff708c0070693e16dd8f66e11a0682e4c54c0d46aeead
+  metadata.gz: 4f48ba902d7677a13e7d53d251473ba5a8b5c0379c06b09ceacda30df79a31d1
+  data.tar.gz: 1e54b0d518ca576ad853ff0d170026bbf9e0267d419c8a20209e5334a6d15276
 SHA512:
-  metadata.gz: 867400988954ad03423b476920077c8d498ed2744cb1b863c4ab2959478609b6ce3cd8b424f4189d5d6220a9794fb3df9e3abe3c2b948273c41754e34a69f9de
-  data.tar.gz: 0a357e424416fc0969a25fc492c05215a54dd5c8518978fb55830dbac47e656fa5b50e482e34e09b7d0cb21057bf906dda963350a826e934f77e107a727d28ca
+  metadata.gz: 10c3e1c32582736216141a539161a6d8aead43bdde27c4ad25ac95fd02ce4009959585248c24a740b0b8752554d36d31dfe2e3d28b1ec1ca92b9b8be2c69b1e7
+  data.tar.gz: 41a279f6df4045093a9c870c3ddd03845fe508d0d729bc145f59d96351b3580d51285fbae1aa0bef2c176b4c526d4452a5423796b348028ecbe63a9346430f12

data/.travis.yml

@@ -5,7 +5,7 @@ language: ruby
 
 env:
   global:
-    - CC_TEST_REPORTER_ID=9995f7b2aa6866b0427aef31d946ff1feded8f6e109eaf6ccb58e91c73d0bfeb
+    - CC_TEST_REPORTER_ID=48c33b2bc3ccdc6dafe9ed76482eca03cde47b922a7859074fc2be791247e5fd
 
 rvm:
   - 2.3

data/CHANGELOG.md

@@ -0,0 +1,18 @@
+# Changelog
+
+## [1.1.0] - 2019-02-03
+
+### Added
+
+- CUSIP numbers support: `SecId::CUSIP`
+- CHANGELOG.md file added
+
+### Updated
+
+- Char to digit conversion now uses precalculated tables instead of dynamic calculation for speed
+
+## [1.0.0] - 2017-10-25
+
+### Added
+
+- ISIN numbers support: `SecId::ISIN`

data/README.md

@@ -1,15 +1,18 @@
 # SecId
 [![Gem Version](https://badge.fury.io/rb/sec_id.svg)](https://badge.fury.io/rb/sec_id)
 [![Build Status](https://travis-ci.org/svyatov/sec_id.svg?branch=master)](https://travis-ci.org/svyatov/sec_id)
+[![Maintainability](https://api.codeclimate.com/v1/badges/a4759963a5ddc4d55b24/maintainability)](https://codeclimate.com/github/svyatov/sec_id/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/a4759963a5ddc4d55b24/test_coverage)](https://codeclimate.com/github/svyatov/sec_id/test_coverage)
 
 Validate security identification numbers with ease!
 
 Check-digit calculation is also available.
 
 Currently supported standards:
-[ISIN](https://en.wikipedia.org/wiki/International_Securities_Identification_Number)
+[ISIN](https://en.wikipedia.org/wiki/International_Securities_Identification_Number),
+[CUSIP](https://en.wikipedia.org/wiki/CUSIP)
 
-WIP: [CUSIP](https://en.wikipedia.org/wiki/CUSIP),
+WIP:
 [SEDOL](https://en.wikipedia.org/wiki/SEDOL),
 [IBAN](https://en.wikipedia.org/wiki/International_Bank_Account_Number).
 
@@ -18,7 +21,7 @@ WIP: [CUSIP](https://en.wikipedia.org/wiki/CUSIP),
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'sec_id', '~> 1.0'
+gem 'sec_id', '~> 1.1'
 ```
 
 And then execute:
@@ -114,6 +117,27 @@ isin.restore!              # => 'US5949181045'
 isin.calculate_check_digit # => 5
 ```
 
+### SecId::CUSIP full example
+
+```ruby
+# class level
+SecId::CUSIP.valid?('594918104')       # => true
+SecId::CUSIP.valid_format?('59491810') # => true
+SecId::CUSIP.restore!('59491810')      # => '594918104'
+SecId::CUSIP.check_digit('59491810')   # => 5
+
+# instance level
+cusip = SecId::CUSIP.new('594918104')
+cusip.cusip                 # => '594918104'
+cusip.cusip6                # => '594918'
+cusip.issue                 # => '10'
+cusip.check_digit           # => 4
+cusip.valid?                # => true
+cusip.valid_format?         # => true
+cusip.restore!              # => '594918104'
+cusip.calculate_check_digit # => 4
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies.

data/lib/sec_id.rb

@@ -4,6 +4,7 @@ require 'set'
 require 'sec_id/version'
 require 'sec_id/base'
 require 'sec_id/isin'
+require 'sec_id/cusip'
 
 module SecId
   Error = Class.new(StandardError)

data/lib/sec_id/base.rb

@@ -2,7 +2,27 @@
 
 module SecId
   class Base
-    LETTERS = Set.new('A'..'Z').freeze
+    CHAR_TO_DIGITS = {
+      '0' => 0,      '1' => 1,      '2' => 2,      '3' => 3,      '4' => 4,
+      '5' => 5,      '6' => 6,      '7' => 7,      '8' => 8,      '9' => 9,
+      'A' => [1, 0], 'B' => [1, 1], 'C' => [1, 2], 'D' => [1, 3], 'E' => [1, 4],
+      'F' => [1, 5], 'G' => [1, 6], 'H' => [1, 7], 'I' => [1, 8], 'J' => [1, 9],
+      'K' => [2, 0], 'L' => [2, 1], 'M' => [2, 2], 'N' => [2, 3], 'O' => [2, 4],
+      'P' => [2, 5], 'Q' => [2, 6], 'R' => [2, 7], 'S' => [2, 8], 'T' => [2, 9],
+      'U' => [3, 0], 'V' => [3, 1], 'W' => [3, 2], 'X' => [3, 3], 'Y' => [3, 4], 'Z' => [3, 5],
+      '*' => [3, 6], '@' => [3, 7], '#' => [3, 8]
+    }.freeze
+
+    CHAR_TO_DIGIT = {
+      '0' => 0,  '1' => 1,  '2' => 2,  '3' => 3,  '4' =>  4,
+      '5' => 5,  '6' => 6,  '7' => 7,  '8' => 8,  '9' =>  9,
+      'A' => 10, 'B' => 11, 'C' => 12, 'D' => 13, 'E' => 14,
+      'F' => 15, 'G' => 16, 'H' => 17, 'I' => 18, 'J' => 19,
+      'K' => 20, 'L' => 21, 'M' => 22, 'N' => 23, 'O' => 24,
+      'P' => 25, 'Q' => 26, 'R' => 27, 'S' => 28, 'T' => 29,
+      'U' => 30, 'V' => 31, 'W' => 32, 'X' => 33, 'Y' => 34, 'Z' => 35,
+      '*' => 36, '@' => 37, '#' => 38
+    }.freeze
 
     attr_reader :identifier, :check_digit
 
@@ -50,14 +70,15 @@ module SecId
     private
 
     def digitized_identifier
-      @digitized_identifier ||= identifier.each_char.flat_map { |char| char_to_digits char }
+      raise NotImplementedError
     end
 
     def char_to_digits(char)
-      return char.to_i unless LETTERS.include? char
+      CHAR_TO_DIGITS.fetch(char)
+    end
 
-      number = char.to_i(36)
-      [number / 10, number % 10]
+    def char_to_digit(char)
+      CHAR_TO_DIGIT.fetch(char)
     end
 
     def mod_10(sum)

data/lib/sec_id/cusip.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+module SecId
+  # https://en.wikipedia.org/wiki/CUSIP
+  class CUSIP < Base
+    ID_REGEX = /\A
+      (?<identifier>
+        (?<cusip6>[A-Z0-9]{5}[A-Z0-9*@#])
+        (?<issue>[A-Z0-9*@#]{2}))
+      (?<check_digit>\d)?
+    \z/x.freeze
+
+    VALID_COUNTRY_CODES_FOR_CONVERSION_TO_ISIN = %w[US CA].freeze
+
+    attr_reader :cusip, :cusip6, :issue
+
+    def initialize(cusip)
+      @cusip = cusip.to_s.strip.upcase
+      cusip_parts = @cusip.match(ID_REGEX) || {}
+
+      @identifier = cusip_parts[:identifier]
+      @cusip6 = cusip_parts[:cusip6]
+      @issue = cusip_parts[:issue]
+      @check_digit = cusip_parts[:check_digit].to_i if cusip_parts[:check_digit]
+    end
+
+    def valid?
+      return false unless valid_format?
+
+      check_digit == calculate_check_digit
+    end
+
+    def valid_format?
+      identifier ? true : false
+    end
+
+    def restore!
+      @check_digit = calculate_check_digit
+      @cusip = to_s
+    end
+
+    def calculate_check_digit
+      return mod_10(modified_luhn_sum) if valid_format?
+
+      raise InvalidFormatError, "CUSIP '#{cusip}' is invalid and check-digit cannot be calculated!"
+    end
+
+    private
+
+    # https://en.wikipedia.org/wiki/Luhn_algorithm
+    def modified_luhn_sum
+      sum = 0
+
+      digitized_identifier.reverse.each_slice(2) do |even, odd|
+        double_even = (even || 0) * 2
+        double_even -= 9 if double_even > 9
+        sum += div_10_mod_10(double_even) + div_10_mod_10(odd || 0)
+      end
+
+      sum
+    end
+
+    def digitized_identifier
+      @digitized_identifier ||= identifier.each_char.map(&method(:char_to_digit))
+    end
+
+    def div_10_mod_10(number)
+      (number / 10) + (number % 10)
+    end
+  end
+end

data/lib/sec_id/isin.rb

@@ -38,9 +38,9 @@ module SecId
     end
 
     def calculate_check_digit
-      raise InvalidFormatError, "ISIN '#{isin}' is invalid and check-digit cannot be calculated!" unless valid_format?
+      return mod_10(luhn_sum) if valid_format?
 
-      mod_10 luhn_sum
+      raise InvalidFormatError, "ISIN '#{isin}' is invalid and check-digit cannot be calculated!"
     end
 
     private
@@ -57,5 +57,9 @@ module SecId
 
       sum
     end
+
+    def digitized_identifier
+      @digitized_identifier ||= identifier.each_char.flat_map(&method(:char_to_digits))
+    end
   end
 end

data/lib/sec_id/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SecId
-  VERSION = '1.0.0'
+  VERSION = '1.1.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sec_id
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Leonid Svyatov
@@ -106,6 +106,7 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -114,6 +115,7 @@ files:
 - bin/setup
 - lib/sec_id.rb
 - lib/sec_id/base.rb
+- lib/sec_id/cusip.rb
 - lib/sec_id/isin.rb
 - lib/sec_id/version.rb
 - sec_id.gemspec