string-obfuscator 0.1.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: a0db290b75d2729aff53d92ddec997c64ed5cb1f
4
+ data.tar.gz: c1dcf67e4b20c75112ff1f4e7d1d3b0338e0c2d1
5
+ SHA512:
6
+ metadata.gz: c45e7d6b94f990b8b3647cfd6ddb44e38ebae1d650efacafa460b972c2d674306ac6be085076b513f16469ce81b7c0858a146df13635b9f2a079df7868505ade
7
+ data.tar.gz: 8da326c3610df514766a212eebe7c2fa619b5c6c410983c7e30dd1cb24c5428c678f557aadfdd31044ca27a10685d51089838b56a19e5c8ddda7b606a63cd87b
data/.gitignore ADDED
@@ -0,0 +1,34 @@
1
+ /.bundle/
2
+ /.yardoc
3
+ /Gemfile.lock
4
+ /_yardoc/
5
+ /coverage/
6
+ /doc/
7
+ /pkg/
8
+ /spec/reports/
9
+ /tmp/
10
+
11
+ ## Specific to RubyMotion:
12
+ .dat*
13
+ .repl_history
14
+ build/
15
+
16
+ ## Documentation cache and generated files:
17
+ /.yardoc/
18
+ /_yardoc/
19
+ /doc/
20
+ /rdoc/
21
+
22
+ ## Environment normalization:
23
+ /.bundle/
24
+ /vendor/bundle
25
+ /lib/bundler/man/
26
+
27
+ # for a library or gem, you might want to ignore these files since the code is
28
+ # intended to run in multiple environments; otherwise, check them in:
29
+ Gemfile.lock
30
+ .ruby-version
31
+ .ruby-gemset
32
+
33
+ # unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
34
+ .rvmrc
data/.rspec ADDED
@@ -0,0 +1,3 @@
1
+ --format documentation
2
+ --color
3
+ --require spec_helper
data/.travis.yml ADDED
@@ -0,0 +1,5 @@
1
+ sudo: false
2
+ language: ruby
3
+ rvm:
4
+ - 2.3.1
5
+ before_install: gem install bundler -v 1.12.5
data/Gemfile ADDED
@@ -0,0 +1,4 @@
1
+ source 'https://rubygems.org'
2
+
3
+ # Specify your gem's dependencies in string-obfuscator.gemspec
4
+ gemspec
data/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2016 Wealthsimple
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
data/README.md ADDED
@@ -0,0 +1,50 @@
1
+ # StringObfuscator [![CircleCI](https://circleci.com/gh/wealthsimple/string-obfuscator.svg?style=svg)](https://circleci.com/gh/wealthsimple/string-obfuscator)
2
+
3
+ Ruby utility for obfuscating strings, with no dependencies.
4
+
5
+ Example usage - obfuscating by length from the right:
6
+
7
+ ```ruby
8
+ StringObfuscator.obfuscate("Hello? It's me, Danilo", length: 6, from: :right)
9
+ => "Hello? It's me, ******"
10
+ ```
11
+
12
+ Example usage - obfuscating by percent, custom obfuscation character:
13
+
14
+ ```ruby
15
+ StringObfuscator.obfuscate("Hello? It's me, Danilo", percent: 50, obfuscation_character: "#")
16
+ => "########### me, Danilo"
17
+ ```
18
+
19
+ Example usage - custom obfuscation value:
20
+
21
+ ```ruby
22
+ StringObfuscator.obfuscate("Hello? It's me, Danilo", percent: 20, obfuscation_value: "[obfuscated]")
23
+ => "[obfuscated]? It's me, Danilo"
24
+ ```
25
+
26
+ ## Installation
27
+
28
+ Add this line to your application's Gemfile:
29
+
30
+ ```ruby
31
+ gem 'string-obfuscator'
32
+ ```
33
+
34
+ And then execute:
35
+
36
+ $ bundle
37
+
38
+ Or install it yourself as:
39
+
40
+ $ gem install string-obfuscator
41
+
42
+ ## Development
43
+
44
+ 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.
45
+
46
+ 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).
47
+
48
+ ## Contributing
49
+
50
+ Bug reports and pull requests are welcome on GitHub at https://github.com/wealthsimple/string-obfuscator.
data/Rakefile ADDED
@@ -0,0 +1,6 @@
1
+ require "bundler/gem_tasks"
2
+ require "rspec/core/rake_task"
3
+
4
+ RSpec::Core::RakeTask.new(:spec)
5
+
6
+ task :default => :spec
data/bin/console ADDED
@@ -0,0 +1,14 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ require "bundler/setup"
4
+ require "string-obfuscator"
5
+
6
+ # You can add fixtures and/or initialization code here to make experimenting
7
+ # with your gem easier. You can also use a different console, if you like.
8
+
9
+ # (If you use this, don't forget to add pry to your Gemfile!)
10
+ # require "pry"
11
+ # Pry.start
12
+
13
+ require "irb"
14
+ IRB.start
data/bin/setup ADDED
@@ -0,0 +1,8 @@
1
+ #!/usr/bin/env bash
2
+ set -euo pipefail
3
+ IFS=$'\n\t'
4
+ set -vx
5
+
6
+ bundle install
7
+
8
+ # Do any other automated setup that you need to do here
@@ -0,0 +1,34 @@
1
+ require "string-obfuscator/version"
2
+ require "bigdecimal"
3
+
4
+ module StringObfuscator
5
+ def self.obfuscate(value, percent: nil, length: nil, from: :left, max_unobfuscated_length: nil, obfuscation_character: "*", obfuscation_value: nil)
6
+ raise ArgumentError, "must specify percent or length to obfuscate by" if percent.nil? && length.nil?
7
+ raise ArgumentError, "percent must be between 0 - 100" if !percent.nil? && (percent > 100 || percent < 0)
8
+ raise ArgumentError, "length must be > 0" if !length.nil? && length < 0
9
+ return value unless value.is_a?(String)
10
+
11
+ if !percent.nil?
12
+ percent = BigDecimal.new(percent.to_s)
13
+ obfuscated_length = (value.length * (percent / 100)).ceil
14
+ else
15
+ obfuscated_length = [value.length, length].min
16
+ end
17
+ visible_length = value.length - obfuscated_length
18
+
19
+ # If `max_unobfuscated_length` is set, ensure that we don't show more than that.
20
+ if !max_unobfuscated_length.nil? && visible_length > max_unobfuscated_length
21
+ visible_length = max_unobfuscated_length
22
+ obfuscated_length = value.length - visible_length
23
+ end
24
+
25
+ obfuscation_value ||= obfuscation_character * obfuscated_length
26
+ if visible_length == 0
27
+ obfuscation_value
28
+ elsif from.to_sym == :left
29
+ obfuscation_value + value[-visible_length..-1]
30
+ else
31
+ value[0..(visible_length - 1)] + obfuscation_value
32
+ end
33
+ end
34
+ end
@@ -0,0 +1,3 @@
1
+ module StringObfuscator
2
+ VERSION = "0.1.0"
3
+ end
@@ -0,0 +1,24 @@
1
+ # coding: utf-8
2
+ lib = File.expand_path('../lib', __FILE__)
3
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
+ require 'string-obfuscator/version'
5
+
6
+ Gem::Specification.new do |spec|
7
+ spec.name = "string-obfuscator"
8
+ spec.version = StringObfuscator::VERSION
9
+ spec.authors = ["Peter Graham"]
10
+ spec.email = ["peter@wealthsimple.com"]
11
+
12
+ spec.summary = %q{Ruby utility for obfuscating strings}
13
+ spec.description = %q{Ruby utility for obfuscating strings, with no dependencies.}
14
+ spec.homepage = "https://github.com/wealthsimple/string-obfuscator"
15
+
16
+ spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
17
+ spec.bindir = "exe"
18
+ spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
19
+ spec.require_paths = ["lib"]
20
+
21
+ spec.add_development_dependency "bundler", "~> 1.12"
22
+ spec.add_development_dependency "rake", "~> 10.0"
23
+ spec.add_development_dependency "rspec", "~> 3.0"
24
+ end
metadata ADDED
@@ -0,0 +1,97 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: string-obfuscator
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ platform: ruby
6
+ authors:
7
+ - Peter Graham
8
+ autorequire:
9
+ bindir: exe
10
+ cert_chain: []
11
+ date: 2016-09-05 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: bundler
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - "~>"
18
+ - !ruby/object:Gem::Version
19
+ version: '1.12'
20
+ type: :development
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: '1.12'
27
+ - !ruby/object:Gem::Dependency
28
+ name: rake
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - "~>"
32
+ - !ruby/object:Gem::Version
33
+ version: '10.0'
34
+ type: :development
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - "~>"
39
+ - !ruby/object:Gem::Version
40
+ version: '10.0'
41
+ - !ruby/object:Gem::Dependency
42
+ name: rspec
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - "~>"
46
+ - !ruby/object:Gem::Version
47
+ version: '3.0'
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - "~>"
53
+ - !ruby/object:Gem::Version
54
+ version: '3.0'
55
+ description: Ruby utility for obfuscating strings, with no dependencies.
56
+ email:
57
+ - peter@wealthsimple.com
58
+ executables: []
59
+ extensions: []
60
+ extra_rdoc_files: []
61
+ files:
62
+ - ".gitignore"
63
+ - ".rspec"
64
+ - ".travis.yml"
65
+ - Gemfile
66
+ - LICENSE
67
+ - README.md
68
+ - Rakefile
69
+ - bin/console
70
+ - bin/setup
71
+ - lib/string-obfuscator.rb
72
+ - lib/string-obfuscator/version.rb
73
+ - string-obfuscator.gemspec
74
+ homepage: https://github.com/wealthsimple/string-obfuscator
75
+ licenses: []
76
+ metadata: {}
77
+ post_install_message:
78
+ rdoc_options: []
79
+ require_paths:
80
+ - lib
81
+ required_ruby_version: !ruby/object:Gem::Requirement
82
+ requirements:
83
+ - - ">="
84
+ - !ruby/object:Gem::Version
85
+ version: '0'
86
+ required_rubygems_version: !ruby/object:Gem::Requirement
87
+ requirements:
88
+ - - ">="
89
+ - !ruby/object:Gem::Version
90
+ version: '0'
91
+ requirements: []
92
+ rubyforge_project:
93
+ rubygems_version: 2.5.1
94
+ signing_key:
95
+ specification_version: 4
96
+ summary: Ruby utility for obfuscating strings
97
+ test_files: []