anonymise 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b4908d0afa0613463253178c7dd9cb55e3b5697a47fe1ed98d822576b9b4c419
-  data.tar.gz: fe8abd61f8308405c82899d22e73d21cd8fc2ef2fdf11e4bb14e2ec55ddc8062
+  metadata.gz: 96aaf3e416414c2fd10fc33c6266deae95c9b4a7eea50b7c32c351c33dda1774
+  data.tar.gz: 4f6b0b2c01c54948d8b03565e54380e41312c49716a948ebf6f0b01754c1cd2a
 SHA512:
-  metadata.gz: 2b7c727b9efc943c26fafaf5a7a6ed932942847eae6188e49aab769716da9fb43a39d912d854ab2263a428bd2e620e2942455f999b46f3c354f16fc11d8843f1
-  data.tar.gz: a243deaf319517dc8705aa34e01b48df312dd3ac8e497c1555b41bb8e0bd982f523f4163187ac841343a1ba921da5cb456c641dfc09680778af2777ce52db17e
+  metadata.gz: dcf2d1ecbf818c83d69cfdd2f9ac7367e219a31d81e777535dfee1417752536b270b3d17041e93d170da216c8acbd409c0adfab10fabbbcd8388d3c4ce497cbb
+  data.tar.gz: 55464b134bd0e8e38abf895ec2c29551838e342d08acfbf1e867ca1f0293be00d62ebdd98572203fa8b11007528877e04cf86e4259b959969c5a2496c4ee1d71

data/README.md

@@ -1,8 +1,5 @@
 # Anonymise
-
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/anonymise`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-
+Anonymise you postgres database
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -19,20 +16,31 @@ Or install it yourself as:
 
     $ gem install anonymise
 Create `anonymise.yml` file in your local machine
-Add below code to `/anonymise.yml`
+
 ```$xslt
+
 {
-  name: ["first_name","last_name","name"],
-  internet: ["email","url"],
-  address: ["street"]
+  users: {email: 'email',last_name: 'string'},
 }
+
 ```
-`anonymise.yml` file will holder customer column names that need to be anonymised.
-The column names are group in categories according to [Faker class names](https://github.com/faker-ruby/faker#default)
+`users` is a table  in the database you want to anonymise
+
+`email: 'email'` defines a column in users that has data type email
 
+`last_name: 'string''` defines a column is users table that has data type string
+
+Datatypes that can be used:-
+```aidl
+1. email
+2. string
+3. number
+4. mobile
+5. url
+```
 ## Usage
 ```$xslt
-   $ bundle exec rake anonymise:start db:dbname path:path_to_anonymise.yml
+   $ anonymise fake db:dbname path:path_to_anonymise.yml
 ```
 
 ## Development

data/anonymise.gemspec

@@ -25,11 +25,11 @@ Gem::Specification.new do |spec|
   spec.metadata['homepage_uri'] = spec.homepage
   spec.metadata['source_code_uri'] = spec.homepage
 
+  spec.add_runtime_dependency 'bundler', '~> 2.1.2'
   spec.add_runtime_dependency('colorize', '0.8.1')
-  spec.add_runtime_dependency 'thor', '1.0.1'
   spec.add_runtime_dependency 'faker', '2.9.0'
   spec.add_runtime_dependency 'pg', '1.1.4'
-  spec.add_runtime_dependency 'bundler', '~> 2.1.2'
+  spec.add_runtime_dependency 'thor', '1.0.1'
 
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'

data/anonymise.yml

@@ -1 +1 @@
-{
  name: ["first_name","last_name","name"],
  internet: ["email","url"],
  address: ["street"]
+{
  users: {email: 'email',last_name: 'string'},

data/lib/anonymise/db_connection.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require 'pg'
+require 'colorize'
+module Anonymise
+  module DbConnection
+    def t_ables
+      t_ables = connection.exec "SELECT table_name FROM information_schema.tables
+        WHERE table_schema = 'public'"
+      @t_ables ||= t_ables.map { |m| m['table_name'] }
+    end
+
+    def column_exists?(table, column)
+      res = connection.exec('SELECT TRUE FROM pg_attribute WHERE attrelid = (SELECT c.oid
+    FROM pg_class c JOIN pg_namespace n ON n.oid = c.relnamespace
+    WHERE n.nspname = CURRENT_SCHEMA() AND c.relname =\''"#{table}"'\')
+    AND attname = \''"#{column}"'\' AND NOT attisdropped AND attnum > 0')
+      records_count = res.count
+      records_count.positive?
+    end
+
+    def connection
+      @connection ||= PG.connect db_args
+    rescue PG::Error => e
+      puts e.message.colorize(:red)
+      exit
+    end
+  end
+end

data/lib/anonymise/db_faker.rb

@@ -1,89 +1,47 @@
 # frozen_string_literal: true
 
 require 'faker'
-require 'pg'
 require 'colorize'
+require 'anonymise/db_connection'
 module Anonymise
   class DbFaker
-    def initialize(db_args, path)
+    include Anonymise::DbConnection
+    attr_reader :config, :db_args
+    def initialize(db_args, config)
       @db_args = db_args
-      @path = path
+      @config = config
     end
 
     def fake
-      tables.each do |table|
-        next if excluded_tables.include?(table['table_name'])
-
-        puts "Anonymising #{table['table_name']}_table".colorize(:green)
-        columns.each do |key, values|
-          values.each do |column|
-            next unless column_exists?(table['table_name'], column)
-
-            available_data = connection.exec("select * from #{table['table_name']}")
-            available_data.each do |record|
-              klass_data = Object.const_get("Faker::#{key.capitalize}").send(column.to_sym)
-
-              unless column == 'email'
-                klass_data = klass_data.gsub(/[^a-z ]/, '')
+      config.each do |table, columns|
+        if t_ables.include?(table)
+          puts "Anonymising table #{table}".colorize(:green)
+          columns.each do |column, type|
+            if column_exists?(table, column)
+              available_data = connection.exec("select * from #{table}")
+              available_data.each do |record|
+                val = Faker::Alphanumeric.unique.alpha(number: 6)
+
+                val = val.gsub(/[^a-z ]/, '')
+
+                val = Faker::Internet.unique.email if type == 'email'
+                val = Faker::Internet.unique.url if type == 'url'
+                val = Faker::PhoneNumber.unique.cell if type == 'mobile'
+                if type == 'number'
+                  val = Faker::Faker::Number.unique.number(digits: 6)
+                end
+                connection.exec("UPDATE #{table} SET #{column}='#{val}' WHERE id='#{record['id']}'")
               end
-              connection.exec("UPDATE #{table['table_name']} SET #{column}='#{klass_data}' WHERE id='#{record['id']}'")
+            else
+              puts "Column #{column} does not exist in #{table}_table".colorize(:red)
             end
           end
+        else
+          puts "Table #{table} does not exist on #{db_args[:db]}".colorize(:red)
         end
       end
-      connection&.close
-    end
 
-    private
-
-    def connection
-      @connection ||= PG.connect @db_args
-    rescue PG::Error => e
-      puts e.message.colorize(:red)
-    end
-
-    def columns
-      @columns ||= if configured_columns.nil?
-                     {
-                       name: %w[
-                         first_name
-                         last_name
-                         name
-                       ],
-                       internet: %w[
-                         email
-                         url
-                       ]
-                     }
-                   else
-                     configured_columns
-                   end
-    end
-
-    def configured_columns
-      @configured_columns ||= if !@path.nil? && File.exist?(@path)
-                                YAML.safe_load(File.open(@path))
-                              else
-                                []
-                              end
-    end
-
-    def tables
-      @tables ||= connection.exec "SELECT table_name FROM information_schema.tables
-        WHERE table_schema = 'public'"
-    end
-
-    def excluded_tables
-      @excluded_tables ||= %w[schema_migrations ar_internal_metadata]
-    end
-
-    def column_exists?(table, column)
-      res = connection.exec('SELECT TRUE FROM pg_attribute WHERE attrelid = (SELECT c.oid
-    FROM pg_class c JOIN pg_namespace n ON n.oid = c.relnamespace
-    WHERE n.nspname = CURRENT_SCHEMA() AND c.relname =\''"#{table}"'\')
-    AND attname = \''"#{column}"'\' AND NOT attisdropped AND attnum > 0')
-      records_count = res.count
-      records_count.positive?
+      connection&.close
     end
   end
 end

data/lib/anonymise/invoke.rb

@@ -17,6 +17,26 @@ module Anonymise
       @db_name ||= opt['db']
     end
 
+    def config
+      if opt['path'].nil?
+        puts 'Path to config file is required'.colorize(:red)
+        exit
+      end
+
+      unless File.exist?(opt['path'])
+        puts 'File does not exist'.colorize(:red)
+        exit
+      end
+      @content = YAML.safe_load(File.open(opt['path']))
+
+      if @content.empty?
+        puts 'Config file is empty kindly check https://github.com/thirunjuguna/anonymise/blob/master/anonymise.yml'
+        exit
+      end
+
+      @config ||= @content
+    end
+
     def user
       @user ||= opt['user']
     end
@@ -41,8 +61,7 @@ module Anonymise
         port: @port,
         host: @host
       }
-      path = opt['path']
-      klass = Anonymise::DbFaker.new(db_args, path)
+      klass = Anonymise::DbFaker.new(db_args, config)
       klass.fake
     end
   end

data/lib/anonymise/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Anonymise
-  VERSION = '0.0.3'
+  VERSION = '0.0.4'
 end

data/lib/anonymise.rb

@@ -17,7 +17,7 @@ module Anonymise
       say "Anonymise version #{Anonymise::VERSION}"
     end
 
-    register Anonymise::Invoke, 'start', 'db:db_name path:path_to_config_file', 'Anonymise Database'
+    register Anonymise::Invoke, 'fake', 'fake db:db_name path:path_to_config_file', 'Anonymise Database'
 
     def self.exit_on_failure
       true

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: anonymise
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Thiru Njuguna
@@ -11,33 +11,33 @@ cert_chain: []
 date: 2019-12-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: colorize
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.1
+        version: 2.1.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.1
+        version: 2.1.2
 - !ruby/object:Gem::Dependency
-  name: thor
+  name: colorize
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.0.1
+        version: 0.8.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.0.1
+        version: 0.8.1
 - !ruby/object:Gem::Dependency
   name: faker
   requirement: !ruby/object:Gem::Requirement
@@ -67,19 +67,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 1.1.4
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: thor
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: 2.1.2
+        version: 1.0.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: 2.1.2
+        version: 1.0.1
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -131,6 +131,7 @@ files:
 - bin/console
 - bin/setup
 - lib/anonymise.rb
+- lib/anonymise/db_connection.rb
 - lib/anonymise/db_faker.rb
 - lib/anonymise/invoke.rb
 - lib/anonymise/version.rb