string-obfuscator 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a0db290b75d2729aff53d92ddec997c64ed5cb1f
+  data.tar.gz: c1dcf67e4b20c75112ff1f4e7d1d3b0338e0c2d1
+SHA512:
+  metadata.gz: c45e7d6b94f990b8b3647cfd6ddb44e38ebae1d650efacafa460b972c2d674306ac6be085076b513f16469ce81b7c0858a146df13635b9f2a079df7868505ade
+  data.tar.gz: 8da326c3610df514766a212eebe7c2fa619b5c6c410983c7e30dd1cb24c5428c678f557aadfdd31044ca27a10685d51089838b56a19e5c8ddda7b606a63cd87b

data/.gitignore

@@ -0,0 +1,34 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+Gemfile.lock
+.ruby-version
+.ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.12.5

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in string-obfuscator.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Wealthsimple
+
+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,50 @@
+# StringObfuscator [![CircleCI](https://circleci.com/gh/wealthsimple/string-obfuscator.svg?style=svg)](https://circleci.com/gh/wealthsimple/string-obfuscator)
+
+Ruby utility for obfuscating strings, with no dependencies.
+
+Example usage - obfuscating by length from the right:
+
+```ruby
+StringObfuscator.obfuscate("Hello? It's me, Danilo", length: 6, from: :right)
+=> "Hello? It's me, ******"
+```
+
+Example usage - obfuscating by percent, custom obfuscation character:
+
+```ruby
+StringObfuscator.obfuscate("Hello? It's me, Danilo", percent: 50, obfuscation_character: "#")
+=> "########### me, Danilo"
+```
+
+Example usage - custom obfuscation value:
+
+```ruby
+StringObfuscator.obfuscate("Hello? It's me, Danilo", percent: 20, obfuscation_value: "[obfuscated]")
+=> "[obfuscated]? It's me, Danilo"
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'string-obfuscator'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install string-obfuscator
+
+## 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/wealthsimple/string-obfuscator.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "string-obfuscator"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/string-obfuscator.rb

@@ -0,0 +1,34 @@
+require "string-obfuscator/version"
+require "bigdecimal"
+
+module StringObfuscator
+  def self.obfuscate(value, percent: nil, length: nil, from: :left, max_unobfuscated_length: nil, obfuscation_character: "*", obfuscation_value: nil)
+    raise ArgumentError, "must specify percent or length to obfuscate by" if percent.nil? && length.nil?
+    raise ArgumentError, "percent must be between 0 - 100" if !percent.nil? && (percent > 100 || percent < 0)
+    raise ArgumentError, "length must be > 0" if !length.nil? && length < 0
+    return value unless value.is_a?(String)
+
+    if !percent.nil?
+      percent = BigDecimal.new(percent.to_s)
+      obfuscated_length = (value.length * (percent / 100)).ceil
+    else
+      obfuscated_length = [value.length, length].min
+    end
+    visible_length = value.length - obfuscated_length
+
+    # If `max_unobfuscated_length` is set, ensure that we don't show more than that.
+    if !max_unobfuscated_length.nil? && visible_length > max_unobfuscated_length
+      visible_length = max_unobfuscated_length
+      obfuscated_length = value.length - visible_length
+    end
+
+    obfuscation_value ||= obfuscation_character * obfuscated_length
+    if visible_length == 0
+      obfuscation_value
+    elsif from.to_sym == :left
+      obfuscation_value + value[-visible_length..-1]
+    else
+      value[0..(visible_length - 1)] + obfuscation_value
+    end
+  end
+end

data/lib/string-obfuscator/version.rb

@@ -0,0 +1,3 @@
+module StringObfuscator
+  VERSION = "0.1.0"
+end

data/string-obfuscator.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'string-obfuscator/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "string-obfuscator"
+  spec.version       = StringObfuscator::VERSION
+  spec.authors       = ["Peter Graham"]
+  spec.email         = ["peter@wealthsimple.com"]
+
+  spec.summary       = %q{Ruby utility for obfuscating strings}
+  spec.description   = %q{Ruby utility for obfuscating strings, with no dependencies.}
+  spec.homepage      = "https://github.com/wealthsimple/string-obfuscator"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: string-obfuscator
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Peter Graham
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-09-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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'
+description: Ruby utility for obfuscating strings, with no dependencies.
+email:
+- peter@wealthsimple.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/string-obfuscator.rb
+- lib/string-obfuscator/version.rb
+- string-obfuscator.gemspec
+homepage: https://github.com/wealthsimple/string-obfuscator
+licenses: []
+metadata: {}
+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: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Ruby utility for obfuscating strings
+test_files: []