anonymise 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: bbd2148a3efac4ce8415cbda3a2268555d26970ce9e8b1b841b605cfb8811d38
+  data.tar.gz: ce0a9e4ee889ae1ce34bf728520ac88ba1b5828979a077527b129a73bd3b00cf
+SHA512:
+  metadata.gz: 5325050df93de863a6214beb29f30d1ec6f51d7123ae566eebdc8f67ab5bc5badc3a88e96ca9130e6623aefe31a8fa16e666458c770ba3eaf11e344e7d0a4c15
+  data.tar.gz: 557420fed9eaa07c2a649d36c0f4b9b2858519de668de1181357b6cdb847fc93632d45848f91b66875184ae738377cd409f484beb0cfb23f69ab48fd95cff2c0

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/.idea

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/.ruby-gemset

@@ -0,0 +1 @@
+anonymise

data/.ruby-version

@@ -0,0 +1 @@
+2.5.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at thirunjuguna@outlook.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Thiru Njuguna
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,54 @@
+# 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.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'anonymise'
+```
+
+And then execute:
+
+    $ bundle
+
+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"]
+}
+```
+`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)
+
+## Usage
+```$xslt
+   $ bundle exec rake anonymise:start db:dbname path:path_to_anonymise.yml
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/thirunjuguna/anonymise. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Anonymise project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/thirunjuguna/anonymise/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'anonymise'

data/anonymise.gemspec

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'anonymise/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'anonymise'
+  spec.version       = Anonymise::VERSION
+  spec.authors       = ['Thiru Njuguna']
+  spec.email         = ['thirunjuguna@outlook.com']
+
+  spec.summary       = 'anonymise'
+  spec.description   = 'Helps you fake anonymise your postgres database'
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'bin'
+  spec.executables   = ['anonymise']
+  spec.require_paths = ['lib']
+
+  spec.homepage      = 'http://github.com/thirunjuguna/anonymise'
+  spec.license       = 'MIT'
+
+  spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+
+  spec.add_development_dependency 'bundler', '~> 2.1.2'
+  spec.add_development_dependency 'colorize', '0.8.1'
+  spec.add_development_dependency 'faker', '2.9.0'
+  spec.add_development_dependency 'pg', '1.1.4'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'thor', '1.0.1'
+end

data/anonymise.yml

@@ -0,0 +1 @@
+{
  name: ["first_name","last_name","name"],
  internet: ["email","url"],
  address: ["street"]

data/bin/anonymise

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift(File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib')))
+require 'anonymise'
+Anonymise::Command.start

data/bin/console

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'anonymise'
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install

data/lib/anonymise/db_faker.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+require 'faker'
+require 'pg'
+require 'colorize'
+module Anonymise
+  class DbFaker
+    def initialize(db_args, path)
+      @db_args = db_args
+      @path = path
+    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 ]/, '')
+              end
+              connection.exec("UPDATE #{table['table_name']} SET #{column}='#{klass_data}' WHERE id='#{record['id']}'")
+            end
+          end
+        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?
+    end
+  end
+end

data/lib/anonymise/invoke.rb

@@ -0,0 +1,49 @@
+# 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 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
+      }
+      path = opt['path']
+      klass = Anonymise::DbFaker.new(db_args, path)
+      klass.fake
+    end
+  end
+end

data/lib/anonymise/version.rb

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

data/lib/anonymise.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require 'rake'
+require 'faker'
+require 'pg'
+require 'colorize'
+require 'thor'
+require 'thor/group'
+require 'anonymise/invoke'
+require 'anonymise/version'
+module Anonymise
+  class Command < Thor
+    desc '-v', 'Show Anonymise version'
+    map %w[-v --version] => :version
+
+    def version
+      say "Anonymise version #{Anonymise::VERSION}"
+    end
+
+    register Anonymise::Invoke, 'start', 'db:db_name path:path_to_config_file', 'Anonymise Database'
+
+    def self.exit_on_failure
+      true
+    end
+  end
+end

metadata

@@ -0,0 +1,163 @@
+--- !ruby/object:Gem::Specification
+name: anonymise
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Thiru Njuguna
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-12-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.2
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+- !ruby/object:Gem::Dependency
+  name: faker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.9.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.9.0
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.1.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.1.4
+- !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.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+description: Helps you fake anonymise your postgres database
+email:
+- thirunjuguna@outlook.com
+executables:
+- anonymise
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-gemset"
+- ".ruby-version"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- anonymise.gemspec
+- anonymise.yml
+- bin/anonymise
+- bin/console
+- bin/setup
+- lib/anonymise.rb
+- lib/anonymise/db_faker.rb
+- lib/anonymise/invoke.rb
+- lib/anonymise/version.rb
+homepage: http://github.com/thirunjuguna/anonymise
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: http://github.com/thirunjuguna/anonymise
+  source_code_uri: http://github.com/thirunjuguna/anonymise
+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: []
+rubygems_version: 3.0.6
+signing_key: 
+specification_version: 4
+summary: anonymise
+test_files: []