vat-siren-siret 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: aae81bf8365a335292e5b7f2682698e7c74621f1
+  data.tar.gz: 227938495503bac7ba772247e0e835afab3c315e
+SHA512:
+  metadata.gz: cd52c2fd8285ca55c81e5c30b3bc73737c993c8cf7a0e57c24d2ae3012ffc77aa1a2db5ad2b60b38e7d947279c2ddf103143d675b529cb10f172a3be4a445131
+  data.tar.gz: 626b8257f2b9123646779e52b1b5d3743e9f67410253b6d2f2be24d9a340bb47c469b6b0ec5a52aa3bea9e9cb73ac2d20ea97aba109b5734d333e9a754bf4b49

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,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,7 @@
+Metrics/LineLength:
+  Max: 120
+  IgnoredPatterns: ['\A#']
+
+Style/BlockLength:
+  Exclude:
+    - 'spec/**/*.rb'

data/.travis.yml

@@ -0,0 +1,10 @@
+sudo: false
+language: ruby
+rvm:
+  - 1.9
+  - 2.0
+  - 2.1
+  - 2.2
+  - 2.3
+  - 2.4
+before_install: gem install bundler -v 1.15.4

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 MathieuDerelle
+
+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,107 @@
+# vat-siren-siret
+
+[![Build Status](https://travis-ci.org/MathieuDerelle/vat-siren-siret.svg?branch=master)](https://travis-ci.org/MathieuDerelle/vat-siren-siret)
+[![Coverage Status](https://coveralls.io/repos/github/MathieuDerelle/vat-siren-siret/badge.svg)](https://coveralls.io/github/MathieuDerelle/vat-siren-siret)
+[![Gem Version](https://badge.fury.io/rb/vat-siren-siret.svg)](https://badge.fury.io/rb/vat-siren-siret)
+[![License](https://img.shields.io/github/license/mashape/apistatus.svg)](https://github.com/MathieuDerelle/vat-siren-siret/blob/master/LICENSE.txt)
+[![GitHub pull requests](https://img.shields.io/badge/PR-welcome-green.svg)](https://github.com/MathieuDerelle/vat-siren-siret/pulls)
+
+This library allows to check french VAT, SIRET and SIREN, to generate french VAT, SIRET and SIREN and to generate VAT or SIREN from SIRET, SIREN and VAT.
+
+It has been largely inspired by the [eponymous JS library](https://github.com/jbdemonte/vat-siren-siret) and [the ruby siret gem](https://github.com/samleb/siret)
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'vat-siren-siret', '~> 0.1'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install vat-siren-siret
+
+
+## Usage
+
+```
+// Check string
+Vss.siren?('813454717')      // true
+Vss.siret?('81345471700014') // true
+Vss.vat?('FR42813454717')    // true
+
+// Generate VAT from SIREN / SIRET
+Vss.to_vat('813454717')      // FR42813454717
+Vss.to_vat('81345471700014') // FR42813454717
+
+// Generate SIREN from SIRET / VAT
+Vss.to_siren('81345471700014') // 813454717
+Vss.to_siren('FR42813454717')  // 813454717
+
+// Generate SIREN / SIRET / VAT
+Vss.generate_siren // 022676134
+Vss.generate_siret // 07577658981212
+Vss.generate_vat   // FR60087471512
+```
+
+
+## API
+
+### Vss.siren?(value)
+
+Evaluate if the `value` is a SIREN and return a `boolean`.
+
+### Vss.siret?(value)
+
+Evaluate if the `value` is a SIRET and return a `boolean`.
+
+### Vss.vat?(value)
+
+Evaluate if the `value` is a french VAT and return a `boolean`.
+
+### Vss.to_vat(value)
+
+Generate the french VAT from a SIREN or a SIRET and return a `string`
+Return `false` when value is neither a SIREN, SIRET or VAT.
+Return `value` if it already is a VAT.
+
+### Vss.to_siren(value)
+
+Generate the SIREN from a VAT or a SIRET and return a `string`
+Return `false` when value is neither a SIREN, SIRET or VAT.
+Return `value` if it already is a SIREN.
+
+### Vss.generate_siren
+
+Generate a random SIREN passing the luhn check.
+
+### Vss.generate_siret
+
+Generate a random SIRET passing the luhn check.
+
+### Vss.generate_vat
+
+Generate a random VAT passing the luhn check.
+
+
+## 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`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/MathieuDerelle/vat-siren-siret.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'vss'
+
+# 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/vat/siren/siret.rb

@@ -0,0 +1 @@
+require 'vss'

data/lib/vss.rb

@@ -0,0 +1,120 @@
+# French VAT / SIRET / SIREN numbers validation and generation as described here:
+# https://fr.wikipedia.org/wiki/Syst%C3%A8me_d%27identification_du_r%C3%A9pertoire_des_%C3%A9tablissements#Calcul_et_validit.C3.A9_d.27un_num.C3.A9ro_SIRET
+module Vss
+  VERSION = '0.1.0'.freeze
+
+  REGEXPS = {
+    SIREN: /^\d{9}$/,
+    SIRET: /^\d{14}$/,
+    VAT: /^FR\d{11}$/,
+    formatSIREN: /(\d\d\d\B)/,
+    formatSIRET: /^(\d{3})(\d{3})(\d{3})(\d{5})$/,
+    formatVAT: /^([A-Z]{2})(\d{2})(\d{3})(\d{3})(\d{3})$/
+  }.freeze
+
+  # Return TRUE if the SIREN is valid
+  def self.siren?(siren)
+    siren.is_a?(String) && match?(REGEXPS[:SIREN], siren) && luhn_valid?(siren)
+  end
+
+  # Return TRUE if the SIRET is valid
+  def self.siret?(siret)
+    siret.is_a?(String) && match?(REGEXPS[:SIRET], siret) && luhn_valid?(siret)
+  end
+
+  # Return TRUE if the VAT is valid
+  def self.vat?(vat)
+    vat.is_a?(String) && match?(REGEXPS[:VAT], vat) && valid_vat?(vat)
+  end
+
+  # Convert a SIREN / SIRET / VAT to a SIREN
+  def self.to_siren(string)
+    return string if siren?(string)
+    return string[0..8] if siret?(string)
+    return string[4..-1] if vat?(string)
+    false
+  end
+
+  # Convert a SIREN / SIRET / VAT to a VAT
+  def self.to_vat(string)
+    return string if vat?(string)
+    siren = siret?(string) ? to_siren(string) : string
+    return false unless siren?(siren)
+    key = vat_key(siren)
+    "FR#{format('%02d', key)}#{siren}"
+  end
+
+  def self.generate_siren
+    complete_for_luhn_checksum(generate_digits(7))
+  end
+
+  def self.generate_siret
+    complete_for_luhn_checksum(generate_digits(12))
+  end
+
+  def self.generate_vat
+    to_vat(generate_siren)
+  end
+
+  def self.format_siren(siren)
+    raise 'Not a valid SIREN' unless siren?(siren)
+    siren.gsub(REGEXPS[:formatSIREN], '\1 ')
+  end
+
+  def self.format_siret(siret)
+    raise 'Not a valid SIRET' unless siret?(siret)
+    siret.gsub(REGEXPS[:formatSIRET], '\1 \2 \3 \4')
+  end
+
+  def self.format_vat(vat)
+    raise 'Not a valid VAT number' unless vat?(vat)
+    vat.gsub(REGEXPS[:formatVAT], '\1 \2 \3 \4 \5')
+  end
+
+  # private methods
+
+  def self.match?(re, str) # :nodoc:
+    return re.match?(str) if re.respond_to?(:match?) # ruby >= 2.4
+    !(re =~ str).nil?
+  end
+
+  def self.luhn_checksum(string) # :nodoc:
+    checksum = 0
+    string.each_char
+          .map(&:to_i)
+          .reverse
+          .each_with_index do |digit, idx|
+      tmp = idx.odd? ? digit * 2 : digit
+      tmp -= 9 if tmp > 9
+      checksum += tmp
+    end
+    checksum
+  end
+
+  # https://fr.wikipedia.org/wiki/Formule_de_Luhn
+  def self.luhn_valid?(string) # :nodoc:
+    (luhn_checksum(string) % 10).zero?
+  end
+
+  def self.valid_vat?(string) # :nodoc:
+    siren = string[4..-1]
+    vat_key(siren) == string[2..3].to_i && luhn_valid?(siren)
+  end
+
+  def self.vat_key(string) # :nodoc:
+    (12 + (3 * (string.to_i % 97))) % 97
+  end
+
+  def self.generate_digits(length)
+    format("%0#{length}d", rand(10**(length - 1)))
+  end
+
+  def self.complete_for_luhn_checksum(string)
+    rest = 10 - luhn_checksum(string) % 10
+    a = rest / 3
+    b = rest > 2 ? rest - 2 * a : rest
+    "#{string}#{a}#{b}"
+  end
+
+  private_class_method :match?, :luhn_checksum, :luhn_valid?, :valid_vat?, :vat_key, :generate_digits, :complete_for_luhn_checksum
+end

data/vat-siren-siret.gemspec

@@ -0,0 +1,28 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'vss'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'vat-siren-siret'
+  spec.version       = Vss::VERSION
+  spec.authors       = ['MathieuDerelle']
+  spec.email         = ['mathieu@purchease.com']
+
+  spec.summary       = 'Library to check or generate french VAT / SIRET / SIREN'
+  spec.description   = 'Transposition in ruby of the eponymous JS library'
+  spec.homepage      = 'https://github.com/MathieuDerelle/vat-siren-siret'
+  spec.license       = 'MIT'
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.15'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'coveralls'
+end

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification
+name: vat-siren-siret
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- MathieuDerelle
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-02-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !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.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Transposition in ruby of the eponymous JS library
+email:
+- mathieu@purchease.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/vat/siren/siret.rb
+- lib/vss.rb
+- vat-siren-siret.gemspec
+homepage: https://github.com/MathieuDerelle/vat-siren-siret
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: Library to check or generate french VAT / SIRET / SIREN
+test_files: []