sanitized_msisdns 0.0.2

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    YjE4ODhjNWRmMzZlYTIxMGI2MGU2MGI0N2ZjZWE1Nzc1Zjk4NTYzYg==
+  data.tar.gz: !binary |-
+    ZjVkMTFmZGIzYjZkYzQ5YjRiZTRhZjMwZGI5YWYzMTdkY2ViNzZjYg==
+SHA512:
+  metadata.gz: !binary |-
+    M2JkMjdhM2QzMWUyMjNiYjM2YjQ2NGM5NzllMGJhOTkxZGVmMmRmMmM5MzZm
+    N2Q4NzZjNmZhMDliOTE2NTFkZWQxNzdjM2NlZDNiNGM5MjhjMjc0OTY5MjM3
+    NTQyZTM3ODkwZmNlMmRhZTllYmUzNjI3ZDBkNTkwN2NlMjJkMjI=
+  data.tar.gz: !binary |-
+    YTkwMzFmMmFlODIzZGNlZDc2NTZiZWYwOWRiOTg4NzM2YjU3MTI5NGNhMTU5
+    NjA3MWJjYTNjZmNiNGMyZGI2OTVkMDgwOGJiMTc4ZDJiMjRlMDM0ZTRkYTI0
+    ZjIzYTMxZmM2MWZhNWQ5MGQyYjNhMzcxNDNmNzc3NGJjZTg3OTg=

data/.gitignore

@@ -0,0 +1,12 @@
+vendor/bundle/
+.bundle/
+coverage/
+spec/reports
+*.log
+.yardoc
+/*.gem
+yardoc/
+*~
+.idea/
+doc/
+vendor/

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--profile

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Guardfile

@@ -0,0 +1,5 @@
+guard 'rspec', :version => 2 do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { 'spec' }
+end

data/README.md

@@ -0,0 +1 @@
+A small gem to sanitize MSISDNS as per mobile Number format. This is specially useful for building apis for Android or Iphone apps where the MSISDN is stored in different formats. Currently only indian numbers are supported. 

data/lib/msisdn-sanitizer/errors.rb

@@ -0,0 +1,11 @@
+class InvalidArgumentTypeException < StandardError
+
+end
+
+class InvalidFormatException < StandardError
+
+end
+
+class InvalidCountryCodeException < StandardError
+
+end

data/lib/msisdn-sanitizer/sanitizer.rb

@@ -0,0 +1,67 @@
+module MSISDN
+  class Sanitizer
+
+    # Sanitizes the msisdns
+    # @author Sunil Kumar <sunikumar.gec56@gmail.com>
+    # @param [Array, String] supports msisdn or a list of msisdns.
+    # @param [Hash] options specifying format & country code.
+    # @return [Array] list of sanitized msisdns.
+
+
+    ALLOWED_CODES = {in: %w(0091 +91 0)}
+    MSISDN_LENGTH = {in: 10}
+    ALLOWED_FORMATS = %w( local international )
+    CLEANUP_REGEX = /[^0-9A-Za-z+]/
+
+    class << self
+
+      def sanitize(msisdns, options = {})
+        options.reverse_merge!(
+            :country_code => :in,
+            :format => 'international'
+        )
+
+        raise(InvalidArgumentTypeException, 'Argument must be a string, fixnum or an array.') unless [String, Array, Fixnum].include? msisdns.class
+        raise(InvalidFormatException, 'Invalid format passed as option.') unless ALLOWED_FORMATS.include? options[:format]
+        raise(InvalidCountryCodeException, 'Invalid country code passed as option.') unless ALLOWED_CODES.keys.include? options[:country_code]
+
+        msisdn_list =
+            case msisdns
+              when Array
+                msisdns.collect {|msisdn| msisdn.to_s}
+              when String
+                [msisdns]
+              when Fixnum
+                [msisdns.to_s]
+            end
+
+        filtered_list = clean_and_filter(msisdn_list, options[:country_code])
+        standardize(filtered_list, options[:format])
+      end
+
+      private
+
+      def clean_and_filter(msisdn_list, country_code)
+        filtered_list = msisdn_list.collect do |msisdn|
+          cleaned_msisdn = msisdn.gsub(CLEANUP_REGEX, '')
+          next unless cleaned_msisdn
+          last_ten_digits = cleaned_msisdn.slice(-MSISDN_LENGTH[country_code]..-1)
+          next unless last_ten_digits
+          prefix_code = cleaned_msisdn.slice(0..(-MSISDN_LENGTH[country_code]-1))
+          (ALLOWED_CODES[country_code] << '').include?(prefix_code) ? last_ten_digits : nil
+        end
+        filtered_list.compact
+      end
+
+      def standardize(filtered_list, format)
+        standardized_list = if format == 'international'
+          filtered_list.collect { |msisdn| msisdn.msisdn(format: 'plus_country') }
+        else
+          filtered_list.collect { |msisdn| msisdn.msisdn(format: 'local') }
+        end
+        standardized_list.compact
+      end
+
+    end
+  end
+end

data/lib/msisdn-sanitizer/version.rb

@@ -0,0 +1,5 @@
+module MSISDN
+  def self.version
+    Gem::Version.new '0.0.2'
+  end
+end

data/lib/msisdn_sanitizer.rb

@@ -0,0 +1,6 @@
+require 'bundler/setup'
+require 'mobme_support'
+
+require_relative 'msisdn-sanitizer/version'
+require_relative 'msisdn-sanitizer/errors'
+require_relative 'msisdn-sanitizer/sanitizer'

data/sanitized_msisdns.gemspec

@@ -0,0 +1,29 @@
+lib = File.expand_path('../lib/', __FILE__)
+$:.unshift lib unless $:.include?(lib)
+
+require 'msisdn-sanitizer/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'sanitized_msisdns'
+  s.version     = MSISDN.version
+  s.author      = 'Sunil Kumar'
+  s.email       = 'sunilkumar.gec56@gmail.com'
+  s.homepage    = 'http://tech.sunilnkumar.com/'
+  s.summary     = %q{Sanitizes msisdns}
+  s.description = %q{Sanitized the msisdns. Helpful for proper formating of Android mobile numbers. }
+
+  s.add_dependency 'mobme_support'
+
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'guard'
+  s.add_development_dependency 'guard-rspec'
+  s.add_development_dependency 'simplecov'
+  s.add_development_dependency 'yard'
+  s.add_development_dependency 'simplecov-rcov'
+  s.add_development_dependency 'rdiscount'
+
+  s.files              = `git ls-files`.split("\n") - %w(Gemfile.lock .ruby-version)
+  s.test_files         = `git ls-files -- {spec}/*`.split("\n")
+  s.require_paths      = %w(lib)
+end

data/spec/sanitizer_spec.rb

@@ -0,0 +1,108 @@
+require 'spec_helper'
+require_relative '../lib/msisdn_sanitizer'
+
+describe MSISDN::Sanitizer do
+
+  subject { MSISDN::Sanitizer }
+
+  let(:msisdn_list) do
+    [
+        '+918089106942',
+        '8089129856',
+        '09846752687',
+        '00919745044399',
+        '67809123456',
+        '0939-109456',
+        '+91 91 67 100865',
+        '914712438548',
+        '914712',
+        '918891598095',
+        '09539368042',
+        '0041796704934',
+        '+8891090909'
+    ]
+  end
+
+  let(:filtered_msisdn_list) do
+    %w(
+          8089106942
+          8089129856
+          9846752687
+          9745044399
+          0939109456
+          9167100865
+          9539368042
+      )
+  end
+
+  let(:standardized_msisdn_list) do
+    {
+      international_format:
+         %w(
+          +918089106942
+          +918089129856
+          +919846752687
+          +919745044399
+          +919167100865
+          +919539368042
+          ),
+
+      local_format:
+          %w(
+            8089106942
+            8089129856
+            9846752687
+            9745044399
+            9167100865
+            9539368042
+          )
+    }
+  end
+
+  it 'cleans and filters msisdns by removing all characters which are not digits and +' do
+    expect(subject.send(:clean_and_filter, msisdn_list, :in)).to eq filtered_msisdn_list
+  end
+
+  it 'standardizes the msisdn as per the format provided' do
+    expect(subject.send(:standardize, filtered_msisdn_list, 'local')).to eq standardized_msisdn_list[:local_format]
+    expect(subject.send(:standardize, filtered_msisdn_list, 'international')).to eq standardized_msisdn_list[:international_format]
+  end
+
+  it 'raises an exception if the msisdn passed in not a string or array' do
+    expect{ subject.sanitize( {msisdn: 9897090909} ) }.to raise_error InvalidArgumentTypeException
+  end
+
+  it 'raises an exception if the format provided is not local or international' do
+    expect{ subject.sanitize('9897090909', format: 'regional' ) }.to raise_error InvalidFormatException
+  end
+
+  it 'raises an exception if the country code passed is not in the list of country codes' do
+    expect{ subject.sanitize(['9897090909'],  country_code: 'ne' ) }.to raise_error InvalidCountryCodeException
+  end
+
+  it 'uses the default options of format and country code if no other options are given' do
+    subject.should_receive(:clean_and_filter).with(['9897090909'], :in).and_return([])
+    subject.should_receive(:standardize).with([], 'international').and_return([])
+    subject.sanitize(['9897090909'])
+  end
+
+  it 'uses the format and country code if supplied as arguments' do
+    subject.should_receive(:clean_and_filter).with(['9897090909'], :in).and_return([])
+    subject.should_receive(:standardize).with([], 'local').and_return([])
+    subject.sanitize(['9897090909'], format: 'local', country_code: :in)
+  end
+
+  it 'converts any arguments into a string of arrays' do
+    subject.stub(:standardize)
+    subject.should_receive(:clean_and_filter).exactly(4).times.with(['9897090909'], :in)
+    subject.sanitize(['9897090909'], format: 'local')
+    subject.sanitize('9897090909', format: 'local')
+    subject.sanitize(9897090909, format: 'local')
+    subject.sanitize([9897090909], format: 'local')
+  end
+
+  it 'returns an array of sanitized msisdns' do
+    expect(subject.sanitize( ['9897090909'], format: 'local') ).to be_a_kind_of(Array)
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'simplecov'
+require 'simplecov-rcov'
+
+SimpleCov.formatter = SimpleCov::Formatter::RcovFormatter
+SimpleCov.start do
+  add_filter 'vendor'
+  add_filter 'spec'
+end if ENV['COVERAGE']

metadata

@@ -0,0 +1,181 @@
+--- !ruby/object:Gem::Specification
+name: sanitized_msisdns
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Sunil Kumar
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mobme_support
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: rake
+  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: guard
+  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: guard-rspec
+  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: simplecov
+  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: yard
+  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: simplecov-rcov
+  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: rdiscount
+  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: ! 'Sanitized the msisdns. Helpful for proper formating of Android mobile
+  numbers. '
+email: sunilkumar.gec56@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- Guardfile
+- README.md
+- lib/msisdn-sanitizer/errors.rb
+- lib/msisdn-sanitizer/sanitizer.rb
+- lib/msisdn-sanitizer/version.rb
+- lib/msisdn_sanitizer.rb
+- sanitized_msisdns.gemspec
+- spec/sanitizer_spec.rb
+- spec/spec_helper.rb
+homepage: http://tech.sunilnkumar.com/
+licenses: []
+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.1.11
+signing_key: 
+specification_version: 4
+summary: Sanitizes msisdns
+test_files: []