sec_id 1.1.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4f48ba902d7677a13e7d53d251473ba5a8b5c0379c06b09ceacda30df79a31d1
-  data.tar.gz: 1e54b0d518ca576ad853ff0d170026bbf9e0267d419c8a20209e5334a6d15276
+  metadata.gz: 2306a429fff8833b4ba24039424d20249a1cb6ebb9e9928707c61f7396933835
+  data.tar.gz: 21a9583ecde80ec5a671bbba7ea3492a99c1f128b091a51ea8b3c50d1c3887f5
 SHA512:
-  metadata.gz: 10c3e1c32582736216141a539161a6d8aead43bdde27c4ad25ac95fd02ce4009959585248c24a740b0b8752554d36d31dfe2e3d28b1ec1ca92b9b8be2c69b1e7
-  data.tar.gz: 41a279f6df4045093a9c870c3ddd03845fe508d0d729bc145f59d96351b3580d51285fbae1aa0bef2c176b4c526d4452a5423796b348028ecbe63a9346430f12
+  metadata.gz: 42545c4091db82631984837eb0abda9d34eb78447f25280665835c00e395b750a062037602987451aed333c7b7d233df4df042ea89a60dc1635f0d8904844f57
+  data.tar.gz: c1517768cc621f93d92183b4f47e7159e628d02a0f4936ca9658b0b4743498b300afb6d0a7f140e5616776e6b156aa313299dd02a1429c6f3b74897eecf02211

data/CHANGELOG.md

@@ -1,5 +1,27 @@
 # Changelog
 
+## [2.0.0] - 2019-02-03
+
+### Added
+
+- SEDOL numbers support: `SecId::SEDOL`
+
+### Updated
+
+- **Breaking change**
+
+    API for accessing full number is unified across all classes:
+
+    ```
+    SecId::ISIN#full_number  # previously SecId::ISIN#isin
+    SecId::CUSIP#full_number # previously SecId::CUSIP#cusip
+    SecId::SEDOL#full_number
+    ```
+
+### Fixed
+
+- CUSIP check-digit algorithm fixed
+
 ## [1.1.0] - 2019-02-03
 
 ### Added

data/README.md

@@ -10,10 +10,10 @@ Check-digit calculation is also available.
 
 Currently supported standards:
 [ISIN](https://en.wikipedia.org/wiki/International_Securities_Identification_Number),
-[CUSIP](https://en.wikipedia.org/wiki/CUSIP)
+[CUSIP](https://en.wikipedia.org/wiki/CUSIP),
+[SEDOL](https://en.wikipedia.org/wiki/SEDOL)
 
-WIP:
-[SEDOL](https://en.wikipedia.org/wiki/SEDOL),
+Work in progress:
 [IBAN](https://en.wikipedia.org/wiki/International_Bank_Account_Number).
 
 ## Installation
@@ -21,7 +21,7 @@ WIP:
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'sec_id', '~> 1.1'
+gem 'sec_id', '~> 2.0'
 ```
 
 And then execute:
@@ -107,7 +107,7 @@ SecId::ISIN.check_digit('US594918104')   # => 5
 
 # instance level
 isin = SecId::ISIN.new('US5949181045')
-isin.isin                  # => 'US5949181045'
+isin.full_number           # => 'US5949181045'
 isin.country_code          # => 'US'
 isin.nsin                  # => '594918104'
 isin.check_digit           # => 5
@@ -128,7 +128,7 @@ SecId::CUSIP.check_digit('59491810')   # => 5
 
 # instance level
 cusip = SecId::CUSIP.new('594918104')
-cusip.cusip                 # => '594918104'
+cusip.full_number           # => '594918104'
 cusip.cusip6                # => '594918'
 cusip.issue                 # => '10'
 cusip.check_digit           # => 4
@@ -138,6 +138,25 @@ cusip.restore!              # => '594918104'
 cusip.calculate_check_digit # => 4
 ```
 
+### SecId::SEDOL full example
+
+```ruby
+# class level
+SecId::SEDOL.valid?('B0Z52W5')       # => true
+SecId::SEDOL.valid_format?('B0Z52W') # => true
+SecId::SEDOL.restore!('B0Z52W')      # => 'B0Z52W5'
+SecId::SEDOL.check_digit('B0Z52W')   # => 5
+
+# instance level
+cusip = SecId::SEDOL.new('B0Z52W5')
+cusip.full_number           # => 'B0Z52W5'
+cusip.check_digit           # => 5
+cusip.valid?                # => true
+cusip.valid_format?         # => true
+cusip.restore!              # => 'B0Z52W5'
+cusip.calculate_check_digit # => 5
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies.

data/lib/sec_id/base.rb

@@ -24,7 +24,7 @@ module SecId
       '*' => 36, '@' => 37, '#' => 38
     }.freeze
 
-    attr_reader :identifier, :check_digit
+    attr_reader :full_number, :identifier, :check_digit
 
     def self.valid?(id)
       new(id).valid?
@@ -47,15 +47,18 @@ module SecId
     end
 
     def valid?
-      raise NotImplementedError
+      return false unless valid_format?
+
+      check_digit == calculate_check_digit
     end
 
     def valid_format?
-      raise NotImplementedError
+      identifier ? true : false
     end
 
     def restore!
-      raise NotImplementedError
+      @check_digit = calculate_check_digit
+      @full_number = to_s
     end
 
     def calculate_check_digit
@@ -73,6 +76,11 @@ module SecId
       raise NotImplementedError
     end
 
+    def parse(sec_id_number)
+      @full_number = sec_id_number.to_s.strip.upcase
+      @full_number.match(self.class::ID_REGEX) || {}
+    end
+
     def char_to_digits(char)
       CHAR_TO_DIGITS.fetch(char)
     end
@@ -84,5 +92,9 @@ module SecId
     def mod_10(sum)
       (10 - (sum % 10)) % 10
     end
+
+    def div_10_mod_10(number)
+      (number / 10) + (number % 10)
+    end
   end
 end

data/lib/sec_id/cusip.rb

@@ -10,39 +10,20 @@ module SecId
       (?<check_digit>\d)?
     \z/x.freeze
 
-    VALID_COUNTRY_CODES_FOR_CONVERSION_TO_ISIN = %w[US CA].freeze
-
-    attr_reader :cusip, :cusip6, :issue
+    attr_reader :cusip6, :issue
 
     def initialize(cusip)
-      @cusip = cusip.to_s.strip.upcase
-      cusip_parts = @cusip.match(ID_REGEX) || {}
-
+      cusip_parts = parse cusip
       @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
+      @check_digit = cusip_parts[:check_digit]&.to_i
     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!"
+      raise InvalidFormatError, "CUSIP '#{full_number}' is invalid and check-digit cannot be calculated!"
     end
 
     private
@@ -53,7 +34,6 @@ module SecId
 
       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
 
@@ -63,9 +43,5 @@ module SecId
     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

@@ -10,37 +10,20 @@ module SecId
       (?<check_digit>\d)?
     \z/x.freeze
 
-    attr_reader :isin, :country_code, :nsin
+    attr_reader :country_code, :nsin
 
     def initialize(isin)
-      @isin = isin.to_s.strip.upcase
-      isin_parts = @isin.match(ID_REGEX) || {}
-
+      isin_parts = parse isin
       @identifier = isin_parts[:identifier]
       @country_code = isin_parts[:country_code]
       @nsin = isin_parts[:nsin]
-      @check_digit = isin_parts[:check_digit].to_i if isin_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
-      @isin = to_s
+      @check_digit = isin_parts[:check_digit]&.to_i
     end
 
     def calculate_check_digit
       return mod_10(luhn_sum) if valid_format?
 
-      raise InvalidFormatError, "ISIN '#{isin}' is invalid and check-digit cannot be calculated!"
+      raise InvalidFormatError, "ISIN '#{full_number}' is invalid and check-digit cannot be calculated!"
     end
 
     private

data/lib/sec_id/sedol.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module SecId
+  # https://en.wikipedia.org/wiki/SEDOL
+  class SEDOL < Base
+    ID_REGEX = /\A
+      (?<identifier>[0-9BCDFGHJKLMNPQRSTVWXYZ]{6})
+      (?<check_digit>\d)?
+    \z/x.freeze
+
+    CHARACTER_WEIGHTS = [1, 3, 1, 7, 3, 9].freeze
+
+    attr_reader :full_number
+
+    def initialize(sedol)
+      sedol_parts = parse sedol
+      @identifier = sedol_parts[:identifier]
+      @check_digit = sedol_parts[:check_digit]&.to_i
+    end
+
+    def calculate_check_digit
+      return mod_10(weighted_sum) if valid_format?
+
+      raise InvalidFormatError, "SEDOL '#{full_number}' is invalid and check-digit cannot be calculated!"
+    end
+
+    private
+
+    # NOTE: I know this isn't the most idiomatic Ruby code, but it's the fastest one
+    def weighted_sum
+      index = 0
+      sum = 0
+
+      while index < digitized_identifier.size
+        sum += digitized_identifier[index] * CHARACTER_WEIGHTS[index]
+        index += 1
+      end
+
+      sum
+    end
+
+    def digitized_identifier
+      @digitized_identifier ||= identifier.each_char.map(&method(:char_to_digit))
+    end
+  end
+end

data/lib/sec_id/version.rb

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

data/lib/sec_id.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sec_id
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Leonid Svyatov
@@ -117,6 +117,7 @@ files:
 - lib/sec_id/base.rb
 - lib/sec_id/cusip.rb
 - lib/sec_id/isin.rb
+- lib/sec_id/sedol.rb
 - lib/sec_id/version.rb
 - sec_id.gemspec
 homepage: https://github.com/svyatov/sec_id