Class: SecId::CUSIP

Inherits:
Base
  • Object
show all
Includes:
Checkable
Defined in:
lib/sec_id/cusip.rb

Overview

Committee on Uniform Securities Identification Procedures (CUSIP) - a 9-character alphanumeric code that identifies North American securities.

Format: 6-character issuer code (CUSIP-6) + 2-character issue number + 1-digit check digit

Examples:

Validate a CUSIP

SecId::CUSIP.valid?('037833100')  #=> true

Convert to ISIN

cusip = SecId::CUSIP.new('037833100')
cusip.to_isin('US')  #=> #<SecId::ISIN>

See Also:

Constant Summary collapse

ID_REGEX =

Regular expression for parsing CUSIP components.

/\A
  (?<identifier>
    (?<cusip6>[A-Z0-9]{5}[A-Z0-9*@#])
    (?<issue>[A-Z0-9*@#]{2}))
  (?<check_digit>\d)?
\z/x

Constants included from Checkable

SecId::Checkable::CHAR_TO_DIGIT, SecId::Checkable::CHAR_TO_DIGITS

Instance Attribute Summary collapse

Attributes inherited from Base

#full_number, #identifier

Instance Method Summary collapse

Methods included from Checkable

included, #luhn_sum_double_add_double, #luhn_sum_indexed, #luhn_sum_standard, #restore!, #reversed_digits_multi, #reversed_digits_single, #to_s, #valid?

Methods inherited from Base

#to_s, #valid?, valid?, #valid_format?, valid_format?

Constructor Details

#initialize(cusip) ⇒ CUSIP 



35
36
37
38
39
40
41
 
# File 'lib/sec_id/cusip.rb', line 35

def initialize(cusip)
  cusip_parts = parse cusip
  @identifier = cusip_parts[:identifier]
  @cusip6 = cusip_parts[:cusip6]
  @issue = cusip_parts[:issue]
  @check_digit = cusip_parts[:check_digit]&.to_i
end

Instance Attribute Details

#cusip6 ⇒ String? (readonly) 



29
30
31
 
# File 'lib/sec_id/cusip.rb', line 29

def cusip6
  @cusip6
end

#issue ⇒ String? (readonly) 



32
33
34
 
# File 'lib/sec_id/cusip.rb', line 32

def issue
  @issue
end

Instance Method Details

#calculate_check_digit ⇒ Integer

Returns the calculated check digit (0-9).

Raises:



45
46
47
48
 
# File 'lib/sec_id/cusip.rb', line 45

def calculate_check_digit
  validate_format_for_calculation!
  mod10(luhn_sum_double_add_double(reversed_digits_single(identifier)))
end

#cins? ⇒ Boolean 



65
66
67
 
# File 'lib/sec_id/cusip.rb', line 65

def cins?
  cusip6[0] < '0' || cusip6[0] > '9'
end

#to_isin(country_code) ⇒ ISIN

Returns a new ISIN instance.

Raises:



53
54
55
56
57
58
59
60
61
62
 
# File 'lib/sec_id/cusip.rb', line 53

def to_isin(country_code)
  unless ISIN::CGS_COUNTRY_CODES.include?(country_code)
    raise(InvalidFormatError, "'#{country_code}' is not a CGS country code!")
  end

  restore!
  isin = ISIN.new(country_code + full_number)
  isin.restore!
  isin
end