sec_id 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0f9406f82fc8d468dff0ada3da32d7c9a3cf69d3f18e57eee32c146bf4d7057e
+  data.tar.gz: 8b85da6d43ebd5c46daff708c0070693e16dd8f66e11a0682e4c54c0d46aeead
+SHA512:
+  metadata.gz: 867400988954ad03423b476920077c8d498ed2744cb1b863c4ab2959478609b6ce3cd8b424f4189d5d6220a9794fb3df9e3abe3c2b948273c41754e34a69f9de
+  data.tar.gz: 0a357e424416fc0969a25fc492c05215a54dd5c8518978fb55830dbac47e656fa5b50e482e34e09b7d0cb21057bf906dda963350a826e934f77e107a727d28ca

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,24 @@
+require:
+  - rubocop-rspec
+
+AllCops:
+  TargetRubyVersion: 2.3
+  DisplayCopNames: true
+  DisplayStyleGuide: true
+  ExtraDetails: true
+
+Metrics/LineLength:
+  Max: 120
+
+Style/Documentation:
+  Enabled: false
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*'
+
+RSpec/MultipleExpectations:
+  Max: 5
+
+RSpec/ExampleLength:
+  Max: 10

data/.travis.yml

@@ -0,0 +1,35 @@
+---
+sudo: false
+cache: bundler
+language: ruby
+
+env:
+  global:
+    - CC_TEST_REPORTER_ID=9995f7b2aa6866b0427aef31d946ff1feded8f6e109eaf6ccb58e91c73d0bfeb
+
+rvm:
+  - 2.3
+  - 2.4
+  - 2.5
+  - 2.6
+  - ruby-head
+
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+  fast_finish: true
+
+before_script:
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+  - chmod +x ./cc-test-reporter
+  - ./cc-test-reporter before-build
+
+script:
+  - bundle exec rake
+
+after_script:
+  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT
+
+notifications:
+  recipients: leonid@svyatov.ru
+  on_failure: change

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in sec_id.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Leonid Svyatov
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,133 @@
+# 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)
+
+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)
+
+WIP: [CUSIP](https://en.wikipedia.org/wiki/CUSIP),
+[SEDOL](https://en.wikipedia.org/wiki/SEDOL),
+[IBAN](https://en.wikipedia.org/wiki/International_Bank_Account_Number).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sec_id', '~> 1.0'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sec_id
+
+## Usage
+
+### Base API
+
+Base API has 4 main methods which can be used both on class level and on instance level:
+
+* `valid?` - never raises any errors, always returns `true` or `false`,
+  numbers without the check-digit will return `false`
+
+  ```ruby
+  # class level
+  SecId::ISIN.valid?('US5949181045') # => true
+  SecId::ISIN.valid?('US594918104')  # => false
+
+  # instance level
+  isin = SecId::ISIN.new('US5949181045')
+  isin.valid? # => true
+  ```
+
+* `valid_format?` - never raises any errors, always returns `true` or `false`,
+  numbers without the check-digit but in valid format will return `true`
+
+  ```ruby
+  # class level
+  SecId::ISIN.valid_format?('US5949181045') # => true
+  SecId::ISIN.valid_format?('US594918104') # => true
+
+  # instance level
+  isin = SecId::ISIN.new('US594918104')
+  isin.valid_format? # => true
+  ```
+
+* `restore!` - restores check-digit and returns the full number,
+  raises an error if number's format is invalid and thus check-digit is impossible to calculate
+
+  ```ruby
+  # class level
+  SecId::ISIN.restore!('US594918104') # => 'US5949181045'
+
+  # instance level
+  isin = SecId::ISIN.new('US5949181045')
+  isin.restore! # => 'US5949181045'
+  ```
+
+* `check_digit` and `calculate_check_digit` - these are the same,
+  but the former is used at class level for bravity,
+  and the latter is used at instance level for clarity;
+  it calculates and returns the check-digit if the number is valid
+  and raises an error otherwise.
+
+  ```ruby
+  # class level
+  SecId::ISIN.check_digit('US594918104') # => 5
+
+  # instance level
+  isin = SecId::ISIN.new('US594918104')
+  isin.calculate_check_digit # => 5
+  isin.check_digit # => nil
+  ```
+
+  :exclamation: Please note that `isin.check_digit` returns `nil` because `#check_digit`
+  at instance level represents original check-digit of the number passed to `new`,
+  which in this example is missing and thus it's `nil`.
+
+### SecId::ISIN full example
+
+```ruby
+# class level
+SecId::ISIN.valid?('US5949181045')       # => true
+SecId::ISIN.valid_format?('US594918104') # => true
+SecId::ISIN.restore!('US594918104')      # => 'US5949181045'
+SecId::ISIN.check_digit('US594918104')   # => 5
+
+# instance level
+isin = SecId::ISIN.new('US5949181045')
+isin.isin                  # => 'US5949181045'
+isin.country_code          # => 'US'
+isin.nsin                  # => '594918104'
+isin.check_digit           # => 5
+isin.valid?                # => true
+isin.valid_format?         # => true
+isin.restore!              # => 'US5949181045'
+isin.calculate_check_digit # => 5
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies.
+Then, run `rake spec` to run the tests. You can also run `bin/console`
+for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+## Contributing
+
+Bug reports and pull requests are welcome on
+GitHub at https://github.com/svyatov/sec_id.
+
+## License
+
+The gem is available as open source under the terms of
+the [MIT License](LICENSE.txt).

data/Rakefile

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+RuboCop::RakeTask.new do |task|
+  task.requires << 'rubocop-rspec'
+end
+
+task default: %i[rubocop spec]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'sec_id'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/sec_id/base.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module SecId
+  class Base
+    LETTERS = Set.new('A'..'Z').freeze
+
+    attr_reader :identifier, :check_digit
+
+    def self.valid?(id)
+      new(id).valid?
+    end
+
+    def self.valid_format?(id)
+      new(id).valid_format?
+    end
+
+    def self.restore!(id_without_check_digit)
+      new(id_without_check_digit).restore!
+    end
+
+    def self.check_digit(id)
+      new(id).calculate_check_digit
+    end
+
+    def initialize(_sec_id_number)
+      raise NotImplementedError
+    end
+
+    def valid?
+      raise NotImplementedError
+    end
+
+    def valid_format?
+      raise NotImplementedError
+    end
+
+    def restore!
+      raise NotImplementedError
+    end
+
+    def calculate_check_digit
+      raise NotImplementedError
+    end
+
+    def to_s
+      "#{identifier}#{check_digit}"
+    end
+    alias to_str to_s
+
+    private
+
+    def digitized_identifier
+      @digitized_identifier ||= identifier.each_char.flat_map { |char| char_to_digits char }
+    end
+
+    def char_to_digits(char)
+      return char.to_i unless LETTERS.include? char
+
+      number = char.to_i(36)
+      [number / 10, number % 10]
+    end
+
+    def mod_10(sum)
+      (10 - (sum % 10)) % 10
+    end
+  end
+end

data/lib/sec_id/isin.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module SecId
+  # https://en.wikipedia.org/wiki/International_Securities_Identification_Number
+  class ISIN < Base
+    ID_REGEX = /\A
+      (?<identifier>
+        (?<country_code>[A-Z]{2})
+        (?<nsin>[A-Z0-9]{9}))
+      (?<check_digit>\d)?
+    \z/x.freeze
+
+    attr_reader :isin, :country_code, :nsin
+
+    def initialize(isin)
+      @isin = isin.to_s.strip.upcase
+      isin_parts = @isin.match(ID_REGEX) || {}
+
+      @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
+    end
+
+    def calculate_check_digit
+      raise InvalidFormatError, "ISIN '#{isin}' is invalid and check-digit cannot be calculated!" unless valid_format?
+
+      mod_10 luhn_sum
+    end
+
+    private
+
+    # https://en.wikipedia.org/wiki/Luhn_algorithm
+    def 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 += double_even + (odd || 0)
+      end
+
+      sum
+    end
+  end
+end

data/lib/sec_id/version.rb

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

data/lib/sec_id.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'set'
+require 'sec_id/version'
+require 'sec_id/base'
+require 'sec_id/isin'
+
+module SecId
+  Error = Class.new(StandardError)
+  InvalidFormatError = Class.new(Error)
+end

data/sec_id.gemspec

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sec_id/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'sec_id'
+  spec.version       = SecId::VERSION
+  spec.authors       = ['Leonid Svyatov']
+  spec.email         = ['leonid@svyatov.ru']
+
+  spec.summary       = 'Validate security identification numbers with ease!'
+  spec.description   = %(#{spec.summary} Currently supported standards: ISIN, CUSIP, SEDOL, IBAN.)
+  spec.homepage      = 'https://github.com/svyatov/sec_id'
+  spec.license       = 'MIT'
+
+  spec.required_ruby_version = '>= 2.3.0'
+
+  spec.require_paths = ['lib']
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+
+  spec.add_development_dependency 'bundler', '>= 1.16'
+  spec.add_development_dependency 'rake', '>= 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.8'
+  spec.add_development_dependency 'rubocop', '~> 0.63.1'
+  spec.add_development_dependency 'rubocop-rspec', '~> 1.32'
+  spec.add_development_dependency 'simplecov', '~> 0.16.1'
+end

metadata

@@ -0,0 +1,143 @@
+--- !ruby/object:Gem::Specification
+name: sec_id
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Leonid Svyatov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-02-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.63.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.63.1
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.32'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.32'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.1
+description: 'Validate security identification numbers with ease! Currently supported
+  standards: ISIN, CUSIP, SEDOL, IBAN.'
+email:
+- leonid@svyatov.ru
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/sec_id.rb
+- lib/sec_id/base.rb
+- lib/sec_id/isin.rb
+- lib/sec_id/version.rb
+- sec_id.gemspec
+homepage: https://github.com/svyatov/sec_id
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.2
+signing_key: 
+specification_version: 4
+summary: Validate security identification numbers with ease!
+test_files: []