ssn_obfuscater 1.01 → 1.02

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 57f06f92e73816fa8abebae13030b93480e8f494ddcd95deecac83b463a7c357
-  data.tar.gz: da2f658ad64f72daaeec93578f50348dbbdc65bc85deaaaa16fa3d1e635d4032
+  metadata.gz: 1d08a2ff3622fd25c1bc248a3987457cb1a5792a09252f45b90ceac18f37bb35
+  data.tar.gz: d7f14c6f60290c2bf18e5b33123754be1ea067309a5e371a46ddc282f927a1c4
 SHA512:
-  metadata.gz: 7ed49672f2d5d60fbe77109d44908809464dbf9760debd23892e4316cb3ba8b4eb24581bccc8bfd1e9afc1dfb3ef581483f68701433f0a12f7bf972d184052e7
-  data.tar.gz: a64e4c229a938eed5fb13d60ae63f7d22aa09013a78326165b619af8c302ef7fed21bc2b5b04a5eda963b6f1915baeb644d359e18fba32c5fac610af84ff8860
+  metadata.gz: 9deb0825185c8543f583767ae461a1f307063ee131371f3920f9f1bccc44ff38577113053ba83b314b93627059d29431a77a800b3418332d2b771231fd21dc6d
+  data.tar.gz: c3719b538afe83863844ab2c0e4fd92de57a60766178212c206a4fbacff2b1fbbadee1f4d73cb3f59b65a6cd7ad915fcb493e2bf9b49c0c7882606db4b2364b8

data/README.md

@@ -5,7 +5,6 @@
 
 #### Protects client data by detecting and obfuscating social security numbers (ssn).
 
-Note: Currently being moved from local environment to this gem.  Will be completed by 7/10/18
 
 ## Installation
 
@@ -25,7 +24,32 @@ Or install it yourself as:
 
 ## Usage
 
-Note: Currently being moved from local environment to this gem.  Will be completed by 7/10/18
+1) Add your text to a hash with `:text` symbol key, then pass the arguments to `SsnObfuscater.parse(args)` like the example below.  If you don't pass any args, and just run `SsnObfuscater.parse` it will return sample data for testing.
+
+***Note: Social Security Numbers beginning with 000 are not genuine, so this example does not include a real social security number.  It is all fake data generated for testing purposes only.***
+
+```
+text = "Dillan Richmond Gorczany, 8/16/1954, 000-12-3456, richmond.gorczany.dillan@jacobs.io, 405.226.5344, 2012 Erling Pass, Eagle Square, East Dwight, PA, 25733, Dynamic Manufacturing, VP of Tech"
+
+result_hash = SsnObfuscater.parse(text: text)
+```
+
+
+2) The returned data will be in hash format like below:
+
+Note the text below is a sample profile of an employee including phone, mailing address, email, DOB, SSN, IP address, and job position.  Imagine this were a much longer text document where the SSN is more difficult to spot with the naked eye.   SsnObfuscater can detect the SSN and render a safe obfuscated version of the text.
+
+You can access the data, like so: `result_hash[:ssn_obf]` and `result_hash[:safe_text]`
+
+```
+{:ssn_alert=>true,
+ :ssn=>"000-12-3456",
+ :ssn_obf=>"XXX-XX-3456",
+ :safe_text=>
+  "Dillan Richmond Gorczany, 8/16/1954, XXX-XX-3456, richmond.gorczany.dillan@jacobs.io, 405.226.5344, 2012 Erling Pass, Eagle Square, East Dwight, PA, 25733, Dynamic Manufacturing, VP of Tech"
+}
+```
+
 
 ## Development
 

data/Rakefile

@@ -18,22 +18,15 @@ task :console do
   require "active_support/all"
   ARGV.clear
 
-  scraped_links = run_sudoku
-  # binding.pry
+  result_hash = run_ssn
 
   IRB.start
 end
 
 
-def run_sudoku
-  binding.pry
-  solve = SsnObfuscater::Solver.new
-  res = solve.start
-  binding.pry
-
-  # scraper = LinkScraper::Scrape.new({text_criteria: text_criteria, path_criteria: path_criteria})
-  # scraped_links = scraper.start('https://en.wikipedia.org/wiki/Austin%2C_Texas')
-  # binding.pry
+def run_ssn
+  text = "Dillan Richmond Gorczany, 8/16/1954, 000-12-3456, richmond.gorczany.dillan@jacobs.io, 405.226.5344, 2012 Erling Pass, Eagle Square, East Dwight, PA, 25733, Dynamic Manufacturing, VP of Tech"
 
+  result_hash = SsnObfuscater.parse(text: text)
   # scraper = LinkScraper::Scrape.new(WebsCriteria.all_scrub_web_criteria)
 end

data/lib/ssn_obfuscater.rb

@@ -2,9 +2,13 @@ require "ssn_obfuscater/version"
 
 require "ssn_obfuscater/solver"
 # require 'mechanizer'
-# require 'scrub_db'
+require 'faker'
 require 'pry'
 
 module SsnObfuscater
-  # Your code goes here...
+
+  def self.parse(args={})
+    result_hash = self::Solver.new.parse(args)
+  end
+
 end

data/lib/ssn_obfuscater/solver.rb

@@ -2,16 +2,75 @@
 module SsnObfuscater
   class Solver
 
-    def initialize
-      binding.pry
+    # AlgoService.new.parse
+    def parse(args={})
+      text = args.fetch(:text, nil)
+      text = generate_ssn_num_strings if !text.present?
+      result_hash = find_ssn_in_string(text)
+      result_hash.is_a?(::Hash) ? result_hash : nil
+      # safe_string_block = make_string_block_safe(result_hash, text)
+      result_hash
     end
 
-    def start
-      binding.pry
-      "testing setup"
+
+    def parse_string_block(text)
+      strings = text.split(/\.\s+|!|\?/)
+      strings = strings.map { |str|  str.squeeze(' ') }
+      strings = strings.map(&:strip)
+    end
+
+
+    def find_ssn_in_string(string)
+      if string.present?
+        ssn = string.scan(/\d{3}-\d{2}-\d{4}/).join(', ')
+        if ssn.present?
+          ssn_obf = obfuscate_ssn(ssn)
+          string.gsub!(ssn, ssn_obf)
+          result_hash = { ssn_alert: ssn.present?, ssn: ssn, ssn_obf: ssn_obf, safe_text: string }
+        end
+      end
+    end
+
+
+    def make_string_block_safe(result_hashes, text)
+      result_hashes.map do |hsh|
+        ssn = hsh[:ssn]
+        text.gsub!(ssn, hsh[:ssn_obf])
+      end
+      text
+    end
+
+
+    # Obfuscate all Social Security Numbers. Example: XXX-XX-4430.
+    def obfuscate_ssn(ssn)
+      ssn_obf = "XXX-XX-#{ssn[-4..-1]}"
     end
 
 
+    # SsnTool.generate_ssn_num_strings(5)
+    def generate_ssn_num_strings(string_quantity)
+      # fk_address = Faker::Address
+      # fk_job = Faker::Job
+      # fk_name = Faker::Name
+      # fk_internet = Faker::Internet
+      # fk_phone = Faker::PhoneNumber
+      #
+      # fake_profile_strings = (0..string_quantity).map do
+      #   fk_name.name_with_middle
+      #   full_name = fk_name.name_with_middle
+      #   email_address = fk_internet.email(full_name)
+      #   sample_ssn = "#{rand(329...889)}-#{rand(29...89)}-#{rand(2109...8989)}"
+      #   sample_dob = "#{rand(1...12)}/#{rand(1...28)}/#{rand(1950...2010)}"
+      #   address_meth_names = %w(street_address community city state_abbr zip)
+      #   full_address = address_meth_names.map { |part| fk_address.module_eval(part) }.join(', ')
+      #   job_meth_names = %w(field seniority position key_skill employment_type education_level)
+      #   job_details = job_meth_names.map { |part| fk_job.module_eval(part) }.join(', ')
+      #   string = [full_name, sample_dob, sample_ssn, email_address, fk_phone.cell_phone, full_address, job_details].join(', ')
+      # end
+      # string = fake_profile_strings.join(', ')
+
+      "Dillan Richmond Gorczany, 8/16/1954, 000-12-3456, richmond.gorczany.dillan@jacobs.io, 405.226.5344, 2012 Erling Pass, Eagle Square, East Dwight, PA, 25733, Dynamic Manufacturing, VP of Tech"
+    end
 
   end
 end

data/lib/ssn_obfuscater/version.rb

@@ -1,3 +1,3 @@
 module SsnObfuscater
-  VERSION = "1.01"
+  VERSION = "1.02"
 end

data/ssn_obfuscater.gemspec

@@ -32,11 +32,11 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = '~> 2.5.1'
   spec.add_dependency 'activesupport', '~> 5.2'
-  spec.add_dependency 'crm_formatter', '~> 2.64'
+  spec.add_dependency 'crm_formatter', '~> 2.65'
   spec.add_dependency 'mechanizer', '~> 1.12'
   spec.add_dependency 'scrub_db', '~> 2.23'
   spec.add_dependency 'url_verifier', '~> 2.12'
-  spec.add_dependency 'utf8_sanitizer', '~> 2.16'
+  # spec.add_dependency 'faker', '~> 1.8', '>= 1.8.7'
 
   # spec.add_dependency "activesupport-inflector", ['~> 0.1.0']
   spec.add_development_dependency 'bundler', '~> 1.16', '>= 1.16.2'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ssn_obfuscater
 version: !ruby/object:Gem::Version
-  version: '1.01'
+  version: '1.02'
 platform: ruby
 authors:
 - Adam Booth
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-07-06 00:00:00.000000000 Z
+date: 2018-07-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.64'
+        version: '2.65'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.64'
+        version: '2.65'
 - !ruby/object:Gem::Dependency
   name: mechanizer
   requirement: !ruby/object:Gem::Requirement
@@ -80,20 +80,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.12'
-- !ruby/object:Gem::Dependency
-  name: utf8_sanitizer
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.16'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.16'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement