email_munger 0.0.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: a658e19a322766d1d4fa7637f92de04b423beeb3
4
+ data.tar.gz: 3167b89d655c11b4ec209b5ff34078ba84e138ac
5
+ SHA512:
6
+ metadata.gz: ef1cac176187ef0ae72a7443cf1c2a30054a44cf5ca13580a4d2b37b8ae81d38deba3356e1a2a58aae7a16e330586909a058bd400c8f64795d7854c9c4da26fb
7
+ data.tar.gz: ff7c60c8f261ee430d975d0b26d2486f610d10cf0b8c245ea0d4ba8f6f99830c61ab00976ec32a6dbc35eb5c853191c12e12262f8efe128ddfc85db6e660bde6
data/.gitignore ADDED
@@ -0,0 +1,14 @@
1
+ /.bundle/
2
+ /.yardoc
3
+ /Gemfile.lock
4
+ /_yardoc/
5
+ /coverage/
6
+ /doc/
7
+ /pkg/
8
+ /spec/reports/
9
+ /tmp/
10
+
11
+ log/
12
+ tmp*
13
+ .DS_Store
14
+ *.gem
data/.rspec ADDED
@@ -0,0 +1,2 @@
1
+ --format documentation
2
+ --color
data/.rubocop.yml ADDED
@@ -0,0 +1,3 @@
1
+ Metrics/LineLength:
2
+ Exclude:
3
+ - email_munger.gemspec
data/.travis.yml ADDED
@@ -0,0 +1,6 @@
1
+ language: ruby
2
+ rvm:
3
+ - 2.2.3
4
+ - 2.1.7
5
+ - 2.0.0-p647
6
+ before_install: gem install bundler -v 1.10.6
@@ -0,0 +1,13 @@
1
+ # Contributor Code of Conduct
2
+
3
+ As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
4
+
5
+ We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
6
+
7
+ Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
8
+
9
+ 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. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
10
+
11
+ Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
12
+
13
+ This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)
data/Gemfile ADDED
@@ -0,0 +1,4 @@
1
+ source 'https://rubygems.org'
2
+
3
+ # Specify your gem's dependencies in email_munger.gemspec
4
+ gemspec
data/LICENSE.txt ADDED
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2015 Jason Hsu
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
13
+ all 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
21
+ THE SOFTWARE.
data/README-to_do.txt ADDED
@@ -0,0 +1,17 @@
1
+ BADGES for README.md
2
+ * Version Badge: http://badge.fury.io/
3
+
4
+ Convert every character in an email address into unicode.
5
+ Put the "@" and "." in the email address inside italics (<i> tag).
6
+
7
+ For every character in a string:
8
+ 1. If it's "@", ".", a numeral, or a lowercase letter, get the ascii code.
9
+ 2. Replace this character with &#[number]; ('a' becomes '&#97')
10
+
11
+ AT http://wbwip.com/wbw/emailencoder.html
12
+ abcdefghijklmnopqrstuvwxyz0123456789@example.com becomes
13
+ &#97;&#98;&#99;&#100;&#101;&#102;&#103;&#104;&#105;&#106;&#107;&#108;&#109;&#110;&#111;&#112;&#113;&#114;&#115;&#116;&#117;&#118;&#119;&#120;&#121;&#122;&#48;&#49;&#50;&#51;&#52;&#53;&#54;&#55;&#56;&#57;<i>&#64;</i>&#101;&#120;&#97;&#109;&#112;&#108;&#101;<i>&#46;</i>&#99;&#111;&#109;
14
+
15
+ EMAIL ADDRESS OBFUSCATION
16
+ 1. Use mail_to (https://github.com/reed/actionview-encoded_mail_to)
17
+ 2. Testing example: http://blog.ivanstorck.com/unttesting-ruby-on-rails-obfuscated-email-addresses-with-rspecitled/
data/README.md ADDED
@@ -0,0 +1,63 @@
1
+ [![Dependency Status](https://gemnasium.com/jhsu802701/email_munger.svg)](https://gemnasium.com/jhsu802701/email_munger)
2
+ [![Build Status](https://travis-ci.org/jhsu802701/email_munger.svg?branch=master)](https://travis-ci.org/jhsu802701/email_munger)
3
+ [![Code Climate](https://codeclimate.com/github/jhsu802701/email_munger/badges/gpa.svg)](https://codeclimate.com/github/jhsu802701/email_munger)
4
+ [![Test Coverage](https://codeclimate.com/github/jhsu802701/email_munger/badges/coverage.svg)](https://codeclimate.com/github/jhsu802701/email_munger/coverage)
5
+ [![security](https://hakiri.io/github/jhsu802701/email_munger/master.svg)](https://hakiri.io/github/jhsu802701/email_munger/master)
6
+
7
+ # EmailMunger
8
+
9
+ Use the EmailMunger gem in your Rails app to encode displayed email addresses on web pages so that they are much less likely to be harvested by bots and bombarded with spam, yet still visible in web browsers. Each character in an email address is converted into its HTML5 UTF-8 character code. Additionally, the '@' and '.' characters are presented in italics. For example, the address
10
+ `abcdefghijklmnopqrstuvwxyz0123456789@example.com` becomes `&#97;&#98;&#99;&#100;&#101;&#102;&#103;&#104;&#105;&#106;&#107;&#108;&#109;&#110;&#111;&#112;&#113;&#114;&#115;&#116;&#117;&#118;&#119;&#120;&#121;&#122;&#48;&#49;&#50;&#51;&#52;&#53;&#54;&#55;&#56;&#57;<i>&#64;</i>&#101;&#120;&#97;&#109;&#112;&#108;&#101;<i>&#46;</i>&#99;&#111;&#109;`
11
+
12
+ ## Installation
13
+
14
+ Add this line to your application's Gemfile:
15
+
16
+ ```ruby
17
+ gem 'email_munger'
18
+ ```
19
+
20
+ And then execute:
21
+
22
+ $ bundle
23
+
24
+ Or install it yourself as:
25
+
26
+ $ gem install email_munger
27
+
28
+ ## Usage
29
+
30
+ To encode the email address abcdefghijklmnopqrstuvwxyz0123456789@example.com in a Ruby environment, enter the following command:
31
+ `EmailMunger.encode('abcdefghijklmnopqrstuvwxyz0123456789@example.com')`
32
+
33
+ The result is:
34
+ `&#97;&#98;&#99;&#100;&#101;&#102;&#103;&#104;&#105;&#106;&#107;&#108;&#109;&#110;&#111;&#112;&#113;&#114;&#115;&#116;&#117;&#118;&#119;&#120;&#121;&#122;&#48;&#49;&#50;&#51;&#52;&#53;&#54;&#55;&#56;&#57;<i>&#64;</i>&#101;&#120;&#97;&#109;&#112;&#108;&#101;<i>&#46;</i>&#99;&#111;&#109;`
35
+
36
+ ## Development
37
+
38
+ 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.
39
+
40
+ 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).
41
+
42
+ ## Contributing
43
+
44
+ Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/email_munger. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
45
+
46
+
47
+ ## License
48
+
49
+ The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
50
+
51
+ ## Bash Scripts
52
+ ### Testing this gem
53
+ After you download this source code, enter `sh gem_test.sh` to set up and test this gem.
54
+
55
+ ### Testing this gem's source code
56
+ Enter `sh code_test.sh` to test the quality of this gem's source code.
57
+ ### Running this gem in irb
58
+ Enter `sh gem_console.sh`.
59
+
60
+ ### Installing this gem
61
+ Enter `sh gem_install.sh`.
62
+ ### Testing the gem, source code, and installation process
63
+ Enter `sh all.sh` to run the gem_test.sh, code_test.sh, and gem_install.sh scripts.
data/Rakefile ADDED
@@ -0,0 +1,10 @@
1
+ require 'bundler/gem_tasks'
2
+ require 'rspec/core/rake_task'
3
+
4
+ RSpec::Core::RakeTask.new
5
+
6
+ task default: :spec
7
+ task test: :spec
8
+
9
+ # TEST GEM: Enter "rake".
10
+ # INSTALL GEM: Enter "rake install".
data/all.sh ADDED
@@ -0,0 +1,17 @@
1
+ #!/bin/bash
2
+
3
+ mkdir -p log
4
+ FILE_TEST_GEM='log/1-test-gem.log'
5
+ FILE_TEST_CODE='log/2-test-code.log'
6
+ FILE_INSTALL_GEM='log/3-install-gem.log'
7
+ sh gem_test.sh 2>&1 | tee $FILE_TEST_GEM
8
+ sh code_test.sh 2>&1 | tee $FILE_TEST_CODE
9
+ sh gem_install.sh 2>&1 | tee $FILE_INSTALL_GEM
10
+
11
+ echo 'Results are logged in:'
12
+ echo $FILE_TEST_GEM
13
+ echo $FILE_TEST_CODE
14
+ echo $FILE_INSTALL_GEM
15
+ echo
16
+ echo 'Gemsurance Report: log/gemsurance_report.html'
17
+ echo 'Gem dependency diagram: log/diagram-gems.svg'
data/bin/console ADDED
@@ -0,0 +1,14 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ require 'bundler/setup'
4
+ require 'email_munger'
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,7 @@
1
+ #!/bin/bash
2
+ set -euo pipefail
3
+ IFS=$'\n\t'
4
+
5
+ bundle install
6
+
7
+ # Do any other automated setup that you need to do here
data/code_test.sh ADDED
@@ -0,0 +1,35 @@
1
+ #!/bin/bash
2
+
3
+ DIR_PARENT="${PWD%/*}"
4
+ DIR_TMP="$DIR_PARENT/tmp"
5
+ mkdir -p log
6
+ rm -rf tmp
7
+
8
+ echo '--------------'
9
+ echo 'bundle install'
10
+ bin/setup >/dev/null
11
+
12
+ echo
13
+ echo '-------'
14
+ echo 'rubocop'
15
+ rubocop
16
+
17
+ echo
18
+ echo '-----------'
19
+ echo 'sandi_meter'
20
+ sandi_meter
21
+
22
+ echo
23
+ echo '------------'
24
+ echo 'bundle-audit'
25
+ bundle-audit
26
+
27
+ echo '----------------------------------------------'
28
+ echo 'gemsurance --output log/gemsurance_report.html'
29
+ gemsurance --output log/gemsurance_report.html
30
+ echo 'Gemsurance Report: log/gemsurance_report.html'
31
+
32
+ echo '------------------------------------------------------------------------'
33
+ echo 'bundle viz --file=log/diagram-gems --format=svg --requirements --version'
34
+ bundle viz --file=log/diagram-gems --format=svg --requirements --version
35
+ echo 'Gem dependency diagram: log/diagram-gems.svg'
@@ -0,0 +1,32 @@
1
+ # coding: utf-8
2
+ lib = File.expand_path('../lib', __FILE__)
3
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
+ require 'email_munger/version'
5
+
6
+ Gem::Specification.new do |spec|
7
+ spec.name = 'email_munger'
8
+ spec.version = EmailMunger::VERSION
9
+ spec.authors = ['Jason Hsu']
10
+ spec.email = ['rubygems@jasonhsu.com']
11
+
12
+ spec.summary = 'Stop the spam!'
13
+ spec.description = 'Use this gem to encode each character in an email address.'
14
+ spec.homepage = 'https://github.com/jhsu802701/email_munger'
15
+ spec.license = 'MIT'
16
+
17
+ spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
18
+ spec.bindir = 'exe'
19
+ spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
20
+ spec.require_paths = ['lib']
21
+
22
+ spec.add_development_dependency 'bundler', '~> 1.10'
23
+ spec.add_development_dependency 'rake', '~> 10.0'
24
+ spec.add_development_dependency 'rspec'
25
+ spec.add_development_dependency 'simplecov'
26
+ spec.add_development_dependency 'ruby-graphviz'
27
+ spec.add_development_dependency 'gemsurance'
28
+ spec.add_development_dependency 'bundler-audit'
29
+ spec.add_development_dependency 'sandi_meter'
30
+ spec.add_development_dependency 'rubocop'
31
+ spec.add_development_dependency 'codeclimate-test-reporter'
32
+ end
data/gem_console.sh ADDED
@@ -0,0 +1,5 @@
1
+ #!/bin/bash
2
+
3
+ gem uninstall email_munger
4
+ bin/setup
5
+ bin/console
data/gem_install.sh ADDED
@@ -0,0 +1,5 @@
1
+ #!/bin/bash
2
+
3
+ gem uninstall email_munger
4
+ bin/setup
5
+ rake install
data/gem_test.sh ADDED
@@ -0,0 +1,9 @@
1
+ #!/bin/bash
2
+
3
+ gem uninstall email_munger
4
+ bin/setup
5
+ echo '-----------------'
6
+ echo 'BEGIN TESTING gem'
7
+ rake
8
+ echo 'FINISHED TESTING gem'
9
+ echo '--------------------'
@@ -0,0 +1,15 @@
1
+ require 'email_munger/version'
2
+
3
+ #
4
+ module EmailMunger
5
+ def self.encode(str_input)
6
+ str_output = ''
7
+ str_input.each_char do |c|
8
+ str_c = '&#' + c.ord.to_s + ';'
9
+ str_c = "<i>#{str_c}</i>" if c == '@' || c == '.'
10
+ str_output += str_c
11
+ end
12
+ str_output
13
+ end
14
+ end
15
+ # Your new gem is a module by default. You may wish to use a class instead.
@@ -0,0 +1,4 @@
1
+ #
2
+ module EmailMunger
3
+ VERSION = '0.0.0'
4
+ end
metadata ADDED
@@ -0,0 +1,204 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: email_munger
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.0.0
5
+ platform: ruby
6
+ authors:
7
+ - Jason Hsu
8
+ autorequire:
9
+ bindir: exe
10
+ cert_chain: []
11
+ date: 2015-12-06 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.10'
20
+ type: :development
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: '1.10'
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: '0'
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - ">="
53
+ - !ruby/object:Gem::Version
54
+ version: '0'
55
+ - !ruby/object:Gem::Dependency
56
+ name: simplecov
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - ">="
60
+ - !ruby/object:Gem::Version
61
+ version: '0'
62
+ type: :development
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - ">="
67
+ - !ruby/object:Gem::Version
68
+ version: '0'
69
+ - !ruby/object:Gem::Dependency
70
+ name: ruby-graphviz
71
+ requirement: !ruby/object:Gem::Requirement
72
+ requirements:
73
+ - - ">="
74
+ - !ruby/object:Gem::Version
75
+ version: '0'
76
+ type: :development
77
+ prerelease: false
78
+ version_requirements: !ruby/object:Gem::Requirement
79
+ requirements:
80
+ - - ">="
81
+ - !ruby/object:Gem::Version
82
+ version: '0'
83
+ - !ruby/object:Gem::Dependency
84
+ name: gemsurance
85
+ requirement: !ruby/object:Gem::Requirement
86
+ requirements:
87
+ - - ">="
88
+ - !ruby/object:Gem::Version
89
+ version: '0'
90
+ type: :development
91
+ prerelease: false
92
+ version_requirements: !ruby/object:Gem::Requirement
93
+ requirements:
94
+ - - ">="
95
+ - !ruby/object:Gem::Version
96
+ version: '0'
97
+ - !ruby/object:Gem::Dependency
98
+ name: bundler-audit
99
+ requirement: !ruby/object:Gem::Requirement
100
+ requirements:
101
+ - - ">="
102
+ - !ruby/object:Gem::Version
103
+ version: '0'
104
+ type: :development
105
+ prerelease: false
106
+ version_requirements: !ruby/object:Gem::Requirement
107
+ requirements:
108
+ - - ">="
109
+ - !ruby/object:Gem::Version
110
+ version: '0'
111
+ - !ruby/object:Gem::Dependency
112
+ name: sandi_meter
113
+ requirement: !ruby/object:Gem::Requirement
114
+ requirements:
115
+ - - ">="
116
+ - !ruby/object:Gem::Version
117
+ version: '0'
118
+ type: :development
119
+ prerelease: false
120
+ version_requirements: !ruby/object:Gem::Requirement
121
+ requirements:
122
+ - - ">="
123
+ - !ruby/object:Gem::Version
124
+ version: '0'
125
+ - !ruby/object:Gem::Dependency
126
+ name: rubocop
127
+ requirement: !ruby/object:Gem::Requirement
128
+ requirements:
129
+ - - ">="
130
+ - !ruby/object:Gem::Version
131
+ version: '0'
132
+ type: :development
133
+ prerelease: false
134
+ version_requirements: !ruby/object:Gem::Requirement
135
+ requirements:
136
+ - - ">="
137
+ - !ruby/object:Gem::Version
138
+ version: '0'
139
+ - !ruby/object:Gem::Dependency
140
+ name: codeclimate-test-reporter
141
+ requirement: !ruby/object:Gem::Requirement
142
+ requirements:
143
+ - - ">="
144
+ - !ruby/object:Gem::Version
145
+ version: '0'
146
+ type: :development
147
+ prerelease: false
148
+ version_requirements: !ruby/object:Gem::Requirement
149
+ requirements:
150
+ - - ">="
151
+ - !ruby/object:Gem::Version
152
+ version: '0'
153
+ description: Use this gem to encode each character in an email address.
154
+ email:
155
+ - rubygems@jasonhsu.com
156
+ executables: []
157
+ extensions: []
158
+ extra_rdoc_files: []
159
+ files:
160
+ - ".gitignore"
161
+ - ".rspec"
162
+ - ".rubocop.yml"
163
+ - ".travis.yml"
164
+ - CODE_OF_CONDUCT.md
165
+ - Gemfile
166
+ - LICENSE.txt
167
+ - README-to_do.txt
168
+ - README.md
169
+ - Rakefile
170
+ - all.sh
171
+ - bin/console
172
+ - bin/setup
173
+ - code_test.sh
174
+ - email_munger.gemspec
175
+ - gem_console.sh
176
+ - gem_install.sh
177
+ - gem_test.sh
178
+ - lib/email_munger.rb
179
+ - lib/email_munger/version.rb
180
+ homepage: https://github.com/jhsu802701/email_munger
181
+ licenses:
182
+ - MIT
183
+ metadata: {}
184
+ post_install_message:
185
+ rdoc_options: []
186
+ require_paths:
187
+ - lib
188
+ required_ruby_version: !ruby/object:Gem::Requirement
189
+ requirements:
190
+ - - ">="
191
+ - !ruby/object:Gem::Version
192
+ version: '0'
193
+ required_rubygems_version: !ruby/object:Gem::Requirement
194
+ requirements:
195
+ - - ">="
196
+ - !ruby/object:Gem::Version
197
+ version: '0'
198
+ requirements: []
199
+ rubyforge_project:
200
+ rubygems_version: 2.4.5.1
201
+ signing_key:
202
+ specification_version: 4
203
+ summary: Stop the spam!
204
+ test_files: []