anon 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b58dd8e96a5488b0ae05d43be7b9a9cc2162db34
-  data.tar.gz: e8ae73279bd357ab92e6aa258426d63206db3734
+  metadata.gz: 03b2f17f2051079e45100d331e070bd5b22be37f
+  data.tar.gz: 973464a56e3a81b49a90d5f5af2b4b2b23577331
 SHA512:
-  metadata.gz: 162ebe61b83c353976ff81da3d2882d32cbf9b0b464a3b6b8a67e3ad9bdce20abdaa7cadbdcd91ce0b3ac7838f1f72ef98dfe21b38ed6b104c7605e105f0c046
-  data.tar.gz: ab5a70456e30880db8e2a238454ddc003813c339218ccbd152ee3e7d5dac656cfd5a215948dab083d02bbad08b9552695641afb9f162b1402ea5245a784438c3
+  metadata.gz: 79e57175215f6cfd7d35d202a04d3ac3ca54e2e5b1fdd5728f0256195678f541999801d9d2cb306aeaf1398788796ab0e56658936b353fcf719c2f569da26866
+  data.tar.gz: 02bc47de8761b52b902e3996e00ab3890c1b56f999f71579e2ef3ca868e69aa5dbb040d4b66183abac1cf690e188c17d5eb921433c7e24861b2cd5f9e0acd1b9

data/lib/anon.rb

@@ -1,3 +1,8 @@
 require 'anon/base'
 require 'anon/csv'
 require 'anon/text'
+
+# Anon can be used to replace personal e-mail addresses with anonymous (fake) ones.
+# This is useful when transferring personally sensitive data.
+module Anon
+end

data/lib/anon/base.rb

@@ -3,12 +3,15 @@
 require 'time_difference'
 
 module Anon
-  # Anonymiser base class
+  # Anonymiser base class anonymiser implimentations should inherit from
   class Base
 
     # Performs anonymisation
-    def self.anonymise!(*args)
-      new(*args).anonymise!
+    # @param input [IO, gets] the input stream
+    # @param output [IO, puts] the output stream
+    # @param args [*] class specific options
+    def self.anonymise!(input, output, *args)
+      new(input, output, *args).anonymise!
     end
 
     protected
@@ -18,6 +21,8 @@ module Anon
     #
     # The same personal e-mail will be replaced
     # with the same anonymous e-mail.
+    # @param personal_email [String]
+    # @return [String] anonomised email
     def anonymous_email(personal_email)
       @anonymised_emails ||= {}
 

data/lib/anon/cli.rb

@@ -24,6 +24,10 @@ e.g. 0,1,5 or email-address,other_email, guesses based on header if ommited'
            default: true,
            desc: 'if the csv file to be processed has a header row'
 
+    # The cli command to launch the CSV anonymiser
+    # Input and output may be set to filepaths, or default to stdin and out
+    # The columns to be anonymised can be set, or we default to a detection stratergy if there is a header row
+    # Optionly we can choose to process files without a header row, but then columns must be set
     def csv
       require 'anon/csv'
       Anon::CSV.anonymise!(input, output, options[:columns], options[:header])
@@ -39,6 +43,8 @@ e.g. 0,1,5 or email-address,other_email, guesses based on header if ommited'
            aliases: [:o],
            desc: 'output filename write to, writes to STDOUT if ommited'
 
+    # The cli command to launch the Text anonymiser
+    # Input and output may be set to filepaths, or default to stdin and out
     def text
       require 'anon/text'
       Anon::Text.anonymise!(input, output)

data/lib/anon/csv.rb

@@ -5,8 +5,13 @@ require 'anon/csv/columns'
 require 'csv'
 
 module Anon
-  # Replaces the contents of a set of columns with anonymous e-mails.
+  # Replaces the contents of a set of columns in a CSV stream with anonymous e-mails.
   class CSV < Base
+    # Returns a new instance of the CSV anonymiser
+    # @param input [IO, #gets] the stream to read from
+    # @param output [IO, #puts] the stream to write to
+    # @param columns_to_anonymise [String] a comma seperated list of columns to anonymise, if nil we guess
+    # @param has_header [Boolean] defaults to true
     def initialize(input, output, columns_to_anonymise, has_header = true)
       @input = input
       @output = output

data/lib/anon/csv/columns.rb

@@ -2,11 +2,19 @@ require 'anon/base'
 
 module Anon
   class CSV < Base
+    # Encapsulates the logic required to choose and format the list
+    # of columns to be anonomised
     class Columns
+      # Initialzes a new instance of Columns
+      # @param columns [String] the columns to be anonomised, comma seperated may be names or indexes
+      # @param headers [Array<String>] the full list of headers
       def initialize(columns, headers)
         @columns, @headers = columns, headers
       end
 
+      # Returns the columns that should be anonomised, if the object was initialized without a
+      # predefined list of columns then returns a guess based on the list of headers.
+      # @return [Array<String,Integer>] the columns to be anonomised, indexes are returned as Integer
       def to_anonymise
         @_to_anonymise ||= indexes || columns || best_guess
       end

data/lib/anon/text.rb

@@ -3,15 +3,18 @@
 require 'anon/base'
 
 module Anon
-  # Anonymises any detected e-mail address in a text file.
+  # Anonymises any detected e-mail address in a text stream
   class Text < Base
     # From the email regex research: http://fightingforalostcause.net/misc/2006/compare-email-regex.php
     # Authors: James Watts and Francisco Jose Martin Moreno
     EMAIL_REGEX = /([\w\!\#\z\%\&\'\*\+\-\/\=\?\\A\`{\|\}\~]+\.)*[\w\+-]+@((((([a-z0-9]{1}[a-z0-9\-]{0,62}[a-z0-9]{1})|[a-z])\.)+[a-z]{2,6})|(\d{1,3}\.){3}\d{1,3}(\:\d{1,5})?)/i # rubocop:disable Metrics/LineLength
 
-    def initialize(incoming_filename, outgoing_filename)
-      @input = incoming_filename
-      @output = outgoing_filename
+    # Returns a new instance of the Text anonymiser
+    # @param input [IO, #gets] the stream to read from
+    # @param output [IO, #puts] the stream to write to
+    def initialize(input, output)
+      @input = input
+      @output = output
     end
 
     # Anonymises any e-mail addresses found in the text

data/spec/spec_helper.rb

@@ -1,5 +1,5 @@
-require 'simplecov'
-SimpleCov.start
+require 'codeclimate-test-reporter'
+CodeClimate::TestReporter.start
 
 def capture_stdout
   real_stdout = $stdout

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: anon
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Reevoo Engineering
@@ -14,86 +14,100 @@ dependencies:
   name: time_difference
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.3'
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.19'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.19'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3'
+        version: '3.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3'
+        version: '3.2'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.9'
 - !ruby/object:Gem::Dependency
   name: reevoocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.4'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
 description: Replaces personal data with fake data
 email: developers@reevoo.com
 executables:
@@ -126,7 +140,10 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '1.9'
+  - - "<"
+    - !ruby/object:Gem::Version
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="