partner_friendly 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: afba1f950014ce8ebfdd465be9c9ace06c86d9b4
+  data.tar.gz: 24315e95c2d43d01367c1357981fa40974119f61
+SHA512:
+  metadata.gz: bc00473b8bec1e41dc6d07815dd0166d2e05af7a35f745fe94a23e25b55e95753fa343811e5342780654c927436bcc07de7b5fe6f41feb0f58b15d38b82499b0
+  data.tar.gz: 969b1fb23bbea4a3f0fdd5963145a1170d9c67636471fb799db1098c06ab47eb8fe008f9d7c6c7e420c80ad2a1bceefd8480076b60444cde2f3c35e9ffa0dab3

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.1.5
+before_install: gem install bundler -v 1.10.6

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Ryan Kulp
+
+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,74 @@
+# PartnerFriendly
+
+Are you a marketer? PartnerFriendly is for you.
+
+When savvy users register for applications, they append their email with strings like "*+yourapp*" preceding their domain.
+
+Users do this to identify your organization if they receive unsolicited email from one of your marketing partners, such as a co-branded newsletter.
+
+PartnerFriendly neutralizes this issue by removing such identifiers, transforming
+
+![Before Validation](https://github.com/ryanckulp/PartnerFriendly/blob/screenshots/screenshots/before-validation.png?raw=true)
+--->
+![After Validation](https://github.com/ryanckulp/PartnerFriendly/blob/screenshots/screenshots/after-database-entry.png?raw=true)
+
+upon entry to your database.
+
+## Installation
+
+Add to your application's Gemfile:
+
+```ruby
+gem 'partner_friendly'
+```
+
+Then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install partner_friendly
+
+## Usage
+
+In your User model, add:
+```
+...
+    before_validation :clean
+...
+    def clean
+        PartnerFriendly::Process.clean(self)
+    end
+```
+
+## FAQ
+
+The user may try to trick the system with multiple identifiers,
+
+![Multiple Identifier Example](https://github.com/ryanckulp/PartnerFriendly/blob/screenshots/screenshots/multiple-identifier-example.png?raw=true)
+
+however this just yields:
+
+![After Validation](https://github.com/ryanckulp/PartnerFriendly/blob/screenshots/screenshots/multiple-identifier-error.png?raw=true)
+
+ProTip: opting for before_save or before_create instead of before_validation may throw a nasty database error:
+
+![PG Unique Violation](https://github.com/ryanckulp/PartnerFriendly/blob/screenshots/screenshots/pg-unique-violation.png?raw=true)
+
+In this case, simply rescue from the error with a redirect or existing authentication flash for "user already exists."
+
+## Contributing
+
+Bug reports and pull requests are welcome.
+
+1. Fork it ( http://github.com/ryanckulp/partnerfriendly/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "partner_friendly"
+
+# 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,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/partner_friendly.rb

@@ -0,0 +1,17 @@
+require "partner_friendly/version"
+
+module PartnerFriendly
+  class Process
+
+    def self.clean(user)
+      if user.email.include?('+')
+        e = []
+        e = user.email.split(/[+@]/)
+        user.email = e[0] + '@' + e[2]
+      else
+        user.email
+      end
+    end
+
+  end
+end

data/lib/partner_friendly/version.rb

@@ -0,0 +1,3 @@
+module PartnerFriendly
+  VERSION = "1.0.0"
+end

data/partner_friendly.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'partner_friendly/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "partner_friendly"
+  spec.version       = PartnerFriendly::VERSION
+  spec.authors       = ["Ryan Kulp"]
+  spec.email         = ["ryanckulp@gmail.com"]
+
+  spec.summary       = %q{Remove trailing email identifiers from new user registrations.}
+  spec.description   = %q{Effortlessly share your userbase email addresses without fear of being traced.}
+  spec.homepage      = "https://github.com/ryanckulp/PartnerFriendly"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  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.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: partner_friendly
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Ryan Kulp
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-09-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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'
+description: Effortlessly share your userbase email addresses without fear of being
+  traced.
+email:
+- ryanckulp@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/partner_friendly.rb
+- lib/partner_friendly/version.rb
+- partner_friendly.gemspec
+homepage: https://github.com/ryanckulp/PartnerFriendly
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Remove trailing email identifiers from new user registrations.
+test_files: []