german_phone_number_classifier 1.0.0.pre

data/lib/german_phone_number_classifier/version.rb

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

data/lib/german_phone_number_classifier.rb

@@ -0,0 +1,115 @@
+# frozen_string_literal: true
+
+require 'phony'
+require 'german_phone_number_classifier/version'
+require 'german_phone_number_classifier/german_landline_prefixes'
+
+# module providing classifier method for phone numbers
+# as specified by the Bundesnetzagentur
+# https://www.bundesnetzagentur.de/DE/Sachgebiete/Telekommunikation/Unternehmen_Institutionen/Nummerierung/start.html
+module GermanPhoneNumberClassifier
+  class Error < StandardError; end
+
+  def self.classify(phone_number)
+    raise ArgumentError, 'nil phone number' unless phone_number
+
+    scanned = phone_number.scan(/(\+|\d)/).join
+
+    return classify_international(scanned) if scanned.start_with?('+', '00')
+    return classify_national(scanned) if scanned.start_with?('0', '1')
+
+    :no_phone_number
+  rescue ArgumentError
+    :no_phone_number
+  end
+
+  def self.landline_location(phone_number)
+    return unless classify(phone_number) == :landline
+
+    scanned = phone_number.scan(/(\+|\d)/).join
+    national_number = if scanned.start_with?('+', '00')
+                        _cc, *national_blocks = Phony.split(
+                          Phony.normalize(scanned)
+                        )
+                        prepend_zero(national_blocks)
+                      else
+                        scanned
+                      end
+
+    return unless national_number.length > 5
+
+    (3..6).each do |n|
+      hit = landline_lookup(national_number, n)
+      return hit if hit
+    end
+
+    nil
+  end
+
+  # private class methods
+
+  def self.classify_international(international_phone_number)
+    cc, *national_blocks = Phony.split(
+      Phony.normalize(international_phone_number)
+    )
+
+    return :non_german_phone_number unless cc == '49'
+    return :no_phone_number if national_blocks.join.length.zero?
+
+    classify_national(prepend_zero(national_blocks))
+  end
+
+  # rubocop:disable Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/PerceivedComplexity
+  def self.classify_national(national_phone_number)
+    return :authoritative if authoritive?(national_phone_number)
+    return :provider_selection if national_phone_number.match(/^010\d+$/)
+    return :high_connection if national_phone_number.match(/^0137\d+$/)
+    return :service_hotline if national_phone_number.match(/^0180\d+$/)
+    return :vpn if national_phone_number.match(/^018\d+$/)
+    return :online_and_traffic if national_phone_number.match(/^019\d+$/)
+    return :personal_number if national_phone_number.match(/^0700\d+$/)
+    return :free_service_hotline if national_phone_number.match(/^0800\d+$/)
+    return :dialer if national_phone_number.match(/^09009\d+$/)
+    return :premium_service_hotline if national_phone_number.match(/^0900\d+$/)
+    return :mobile if national_phone_number.match(/^015\d+$/)
+    return :mobile if national_phone_number.match(/^016\d+$/)
+    return :mobile if national_phone_number.match(/^017\d+$/)
+    return :test_provider if national_phone_number.match(/^031(0|1)$/)
+    return :landline if landline?(national_phone_number)
+
+    :unknown_class
+  end
+  # rubocop:enable Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/PerceivedComplexity
+
+  def self.prepend_zero(national_blocks)
+    national_blocks.dup.prepend('0').join
+  end
+
+  def self.authoritive?(national_phone_number)
+    case national_phone_number
+    when '110', '112', '115', /^116\d{3}$/, /^118\d{2}$/
+      true
+    else
+      false
+    end
+  end
+
+  def self.landline?(national_phone_number)
+    return false unless national_phone_number.length > 5
+
+    (3..6).each do |n|
+      return true if landline_lookup(national_phone_number, n)
+    end
+
+    false
+  end
+
+  def self.landline_lookup(national_phone_number, length)
+    GermanPhoneNumberClassifier::GERMAN_LANDLINE_PREFIXES[
+      national_phone_number[0, length].to_i
+    ]
+  end
+
+  private_class_method :prepend_zero, :classify_national, :landline_lookup,
+                       :classify_international, :authoritive?, :landline?
+end

metadata

@@ -0,0 +1,192 @@
+--- !ruby/object:Gem::Specification
+name: german_phone_number_classifier
+version: !ruby/object:Gem::Version
+  version: 1.0.0.pre
+platform: ruby
+authors:
+- Carsten Wirth
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-04-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: phony
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.19.9
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.19.9
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 11.1.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 11.1.3
+- !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.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.25'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.25'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.10'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.21.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.21.2
+- !ruby/object:Gem::Dependency
+  name: simplecov-console
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+description: Library for checking in which category a german phone number falls in
+  regards to Bundesnetzagentur classes.
+email:
+- carsten.wirth@homeday.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/ruby.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/parse_landline
+- bin/setup
+- german_phone_number_classifier.gemspec
+- lib/german_phone_number_classifier.rb
+- lib/german_phone_number_classifier/german_landline_prefixes.rb
+- lib/german_phone_number_classifier/version.rb
+homepage: https://github.com/jethroo/german_phone_number_classifier
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/jethroo/german_phone_number_classifier
+  source_code_uri: https://github.com/jethroo/german_phone_number_classifier
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubygems_version: 3.3.5
+signing_key:
+specification_version: 4
+summary: Classifying german phone numbers
+test_files: []