anonymise 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 96aaf3e416414c2fd10fc33c6266deae95c9b4a7eea50b7c32c351c33dda1774
-  data.tar.gz: 4f6b0b2c01c54948d8b03565e54380e41312c49716a948ebf6f0b01754c1cd2a
+  metadata.gz: 36b2fe6689c2ef9209a40f6260c7b3f9d87d5f753285188b229bc0f81f9db829
+  data.tar.gz: 4b0007942885a364ba8a4c5a4d4f5ab48dae9e9f555dbd78370cca508ec0db22
 SHA512:
-  metadata.gz: dcf2d1ecbf818c83d69cfdd2f9ac7367e219a31d81e777535dfee1417752536b270b3d17041e93d170da216c8acbd409c0adfab10fabbbcd8388d3c4ce497cbb
-  data.tar.gz: 55464b134bd0e8e38abf895ec2c29551838e342d08acfbf1e867ca1f0293be00d62ebdd98572203fa8b11007528877e04cf86e4259b959969c5a2496c4ee1d71
+  metadata.gz: 78cf01d76b8c12c8502193f92ec4c667dabe5c2b989aed4cac3326b2a734488184d1253903b3cb1acb610ea19a48f5b00f821a8238adb26cfc33f7db39e21a8c
+  data.tar.gz: 97693e7e11a2d993f33b5d54a8d86bb6e104a811d4930b3fe4d838810360a1905e48534ed8bd4504919bbec6a7d512724adb99c4040d5edefcea5a9fff733512

data/README.md

@@ -1,5 +1,5 @@
 # Anonymise
-Anonymise you postgres database
+Anonymise your postgres database
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -37,6 +37,8 @@ Datatypes that can be used:-
 3. number
 4. mobile
 5. url
+6. description
+7. company
 ```
 ## Usage
 ```$xslt

data/decksender.yml

@@ -0,0 +1 @@
+{
  users: {email: 'email',firstname: 'firstname', lastname: 'lastname'},
  verified_emails: {email: 'email'},
  organisations: {name: 'company', description: 'description' },

data/lib/anonymise.rb

@@ -1,13 +1,13 @@
 # frozen_string_literal: true
 
 require 'rake'
-require 'faker'
 require 'pg'
 require 'colorize'
 require 'thor'
 require 'thor/group'
-require 'anonymise/invoke'
+require 'anonymise/db_faker'
 require 'anonymise/version'
+require 'anonymise/resource'
 module Anonymise
   class Command < Thor
     desc '-v', 'Show Anonymise version'
@@ -17,10 +17,31 @@ module Anonymise
       say "Anonymise version #{Anonymise::VERSION}"
     end
 
-    register Anonymise::Invoke, 'fake', 'fake db:db_name path:path_to_config_file', 'Anonymise Database'
+    desc 'fake',
+         'Anonymise Database'
+    method_option :db, required: true, type: :string, desc: 'Database name to anonymise'
+    method_option :path, required: true, type: :string, desc: 'Anonymisation definitions to apply'
+    method_option :user, aliases: 'u', default: 'apps', type: :string, desc: 'User to connect as'
+    method_option :password, aliases: 'p', default: 'apps', type: :string, desc: 'Password for user'
+    method_option :host, aliases: 'h', default: '127.0.0.1', type: :string, desc: 'Database host address'
+    method_option :port, aliases: 'P', default: 5432, type: :numeric, desc: 'Port on host'
+    method_option :dry_run, default: false, type: :boolean, desc: 'No apply any changes to the database, just return counts'
+    def fake
+      db_args = { dbname: options.db, user: options.user,
+                  password: options.password, port: options.port,
+                  host: options.host }
+      puts '*** DRY RUN ***' if options.dry_run
+      DbFaker.new(db_args, config(options.path), options.dry_run).fake
+    end
 
     def self.exit_on_failure
       true
     end
+
+    private
+
+    def config(path)
+      Resource.new(path).content
+    end
   end
 end

data/lib/anonymise/db_faker.rb

@@ -7,9 +7,10 @@ module Anonymise
   class DbFaker
     include Anonymise::DbConnection
     attr_reader :config, :db_args
-    def initialize(db_args, config)
+    def initialize(db_args, config, dry_run = false)
       @db_args = db_args
       @config = config
+      @dry_run = dry_run
     end
 
     def fake
@@ -18,24 +19,13 @@ module Anonymise
           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
+              print("...#{fake_column(column, table, type)} records affected for column #{column}")
             else
-              puts "Column #{column} does not exist in #{table}_table".colorize(:red)
+              print "...column #{column} does not exist in #{table}_table".colorize(:red)
             end
+            print "\n"
           end
+          print "\n"
         else
           puts "Table #{table} does not exist on #{db_args[:db]}".colorize(:red)
         end
@@ -43,5 +33,40 @@ module Anonymise
 
       connection&.close
     end
+
+    def get_fake_for_type(type, origin_length)
+      val = Faker::Alphanumeric.unique.alpha(number: origin_length)
+      val = val.gsub(/[^a-z ]/, '')
+
+      val = Faker::Company.name if type == 'company'
+      val = Faker::Name.last_name if type == 'lastname'
+      val = Faker::Name.first_name if type == 'firstname'
+      if type == 'description'
+        val = Faker::Lorem.paragraph_by_chars(number: 256, supplemental: false)
+      end
+      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: origin_length)
+      end
+      val.gsub(/'/, '')
+    end
+
+    private
+
+    def fake_column(column, table, type)
+      available_data = connection.exec("select * from #{table}")
+      c_row_count = 0
+      available_data.each do |record|
+        c_row_count += 1
+        origin_length = record[column]&.length || 6
+        val = get_fake_for_type(type, origin_length)
+        unless @dry_run
+          connection.exec("UPDATE #{table} SET #{column}='#{val}' WHERE id='#{record['id']}'")
+        end
+      end
+      c_row_count
+    end
   end
 end

data/lib/anonymise/resource.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require 'colorize'
+
+module Anonymise
+  class Resource
+    attr_reader :path
+    def initialize(path)
+      @path = path
+    end
+
+    def content
+      if @path.nil?
+        puts 'Path to config file is required'.colorize(:red)
+        exit
+      end
+      if @path.start_with?('http')
+        # get this from the URL via tempfile.
+        yml_file = ''
+      elsif File.exist?(@path)
+        yml_file = File.open(@path)
+      else
+        puts 'File does not exist'.colorize(:red)
+        exit
+      end
+      content = YAML.safe_load(yml_file)
+      yml_file.close
+      if content.empty?
+        puts 'Config file is empty kindly check https://github.com/thirunjuguna/anonymise/blob/master/anonymise.yml'
+        exit
+      end
+      content
+    end
+  end
+end

data/lib/anonymise/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: anonymise
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Thiru Njuguna
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-12-26 00:00:00.000000000 Z
+date: 2019-12-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -130,10 +130,11 @@ files:
 - bin/anonymise
 - bin/console
 - bin/setup
+- decksender.yml
 - lib/anonymise.rb
 - lib/anonymise/db_connection.rb
 - lib/anonymise/db_faker.rb
-- lib/anonymise/invoke.rb
+- lib/anonymise/resource.rb
 - lib/anonymise/version.rb
 homepage: http://github.com/thirunjuguna/anonymise
 licenses:

data/lib/anonymise/invoke.rb

@@ -1,68 +0,0 @@
-# frozen_string_literal: true
-
-require 'anonymise/db_faker'
-module Anonymise
-  class Invoke < Thor::Group
-    include Thor::Actions
-
-    desc 'Anonymise DB'
-
-    argument :opt, type: :hash, desc: 'Options'
-
-    def db_name
-      if opt['db'].nil?
-        puts 'Database name to anonymise is required'.colorize(:red)
-        exit
-      end
-      @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
-
-    def password
-      @password ||= opt['password']
-    end
-
-    def port
-      @port ||= opt['port']
-    end
-
-    def host
-      @host ||= opt['host']
-    end
-
-    def setup
-      db_args = {
-        dbname: @db_name,
-        user: @user,
-        password: @password,
-        port: @port,
-        host: @host
-      }
-      klass = Anonymise::DbFaker.new(db_args, config)
-      klass.fake
-    end
-  end
-end