rails_email_checker 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8e99f8a15584efbbfe72bdd987c0b536ca53873dfab58d581c79c37107161754
-  data.tar.gz: 03b26be23b4bb692781c43396526df1d4ecce7cf450c0da24c90b7ad60db2286
+  metadata.gz: 1f2b0c96266900173ed82fc4ec68d6bebfebae8c6f1396abb1d51acab04eccbb
+  data.tar.gz: ab4f7b894904731b4cdc8622ca263b1192cd6e0162f6a64b3c362e2574a9efae
 SHA512:
-  metadata.gz: 8adb0084265a8b35e5c9d581f42c5691014690e9de2f8f343f164a06e26b172e75f39185abc6b3326e59c0f446030643b7d4306a18585824b53df97a578704fc
-  data.tar.gz: 0a3b2e0618d0bf19c99972986fe7f54a82101aebd58f53a0860011d5549acdbd313ef4b44f68e9ffef60e5d20fa31e979ed2e5bead04246f935a23d4f3c0aa0c
+  metadata.gz: 25268d069850488ebadad8deeb78bb0d7b91c8c0f9a66b2506bc9ae8aeecd19faacf825558dae8dbeed6b97aebd79d18a056455255d7b45783a4bfe6019950ec
+  data.tar.gz: 507818fcc7dbb885894e17c4e94889950c56b7ad726397d8e6752b65d091e53945aef567c9754726e8080727e4b58f4cf11c78b15df86fffb1057017914ce1cf

data/.coveralls.yml

@@ -0,0 +1,2 @@
+service_name: travis-pro
+repo_token: 7nKS8dACFw7pKCDfK5m9Ic7ya5MA9v2tb

data/.travis.yml

@@ -1,7 +1,15 @@
 ---
-sudo: false
+os: linux
 language: ruby
 cache: bundler
 rvm:
+  - 2.5.5
   - 2.6.3
-before_install: gem install bundler -v 2.0.2
+  - 2.7.0
+gemfile:
+  - gemfiles/Gemfile-4-0
+  - gemfiles/Gemfile-5-0
+  - gemfiles/Gemfile-6-0
+before_install: gem install bundler
+before_script: bundle install
+script: bundle exec rspec

data/Gemfile.lock

@@ -2,7 +2,7 @@ PATH
   remote: .
   specs:
     rails_email_checker (0.1.0)
-      activemodel (~> 4.2)
+      activemodel (>= 4.2, < 7)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -1,8 +1,13 @@
 # RailsEmailChecker
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/rails_email_checker`. To experiment with that code, run `bin/console` for an interactive prompt.
+[![Gem Version](https://badge.fury.io/rb/rails_email_checker.svg)](https://badge.fury.io/rb/redis_web_manager)
+[![Maintainability](https://api.codeclimate.com/v1/badges/eecf90541668432d4d41/maintainability)](https://codeclimate.com/github/OpenGems/rails_email_checker/maintainability)
+[![Build Status](https://travis-ci.org/OpenGems/rails_email_checker.svg?branch=master)](https://travis-ci.org/OpenGems/redis_web_manager)
+[![security](https://hakiri.io/github/OpenGems/rails_email_checker/master.svg)](https://hakiri.io/github/OpenGems/redis_web_manager/master)
+![Gem](https://img.shields.io/gem/dt/rails_email_checker)
+[![Coverage Status](https://coveralls.io/repos/github/OpenGems/rails_email_checker/badge.svg?branch=master)](https://coveralls.io/github/OpenGems/rails_email_checker?branch=master)
 
-TODO: Delete this and the text above, and describe your gem
+ActiveModel email validation. Checks MX records, sub address, regex, whitelisted and blacklisted check
 
 ## Installation
 
@@ -22,17 +27,49 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+### Use with ActiveModel
 
-## Development
+To validate that the domain has a good format (regex):
+```ruby
+class User < ActiveRecord::Base
+  validates_email :email, formatted: true
+end
+```
+
+To validate that the domain is not blacklisted:
+```ruby
+class User < ActiveRecord::Base
+  validates_email :email, blacklisted: true
+end
+```
+
+To validate that the domain has a MX record:
+```ruby
+class User < ActiveRecord::Base
+  validates_email :email, recorded: true
+end
+```
 
-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 validate that email is not sub addressed:
+```ruby
+class User < ActiveRecord::Base
+  validates_email :email, no_sub_addressed: true
+end
+```
 
-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).
+### Use without ActiveModel
+```ruby
+address = RailsEmailChecker.address('test@gmail.com') # or RailsEmailChecker::Address.new('test@gmail.com')
+address.formatted? # => true
+address.sub_addressed? # => false
+address.recorded? # => true
+address.whitelisted? # => false
+address.blacklisted? # => false
+```
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/rails_email_checker.
+Bug reports and pull requests are welcome on GitHub at https://github.com/OpenGems/rails_email_checker. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.
 
 ## License
 

data/gemfiles/Gemfile-4-0

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gem 'activemodel', '~> 4.2.0'
+
+gemspec path: '..'

data/gemfiles/Gemfile-5-0

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gem 'activemodel', '~> 5.2.0'
+
+gemspec path: '..'

data/gemfiles/Gemfile-6-0

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gem 'activemodel', '~> 6.0.2'
+
+gemspec path: '..'

data/lib/rails_email_checker/configuration.rb

@@ -15,21 +15,15 @@ module RailsEmailChecker
     end
 
     def add_blacklist_domains(path: nil, domains: nil)
-      raise ListArgument, 'Path & domains are nil' if valid_argument?(path, domains)
-      @blacklist_domains << load_domains(path) unless path.nil?
-      unless domains.nil?
-        @blacklist_domains.concat(domains) if domains.is_a?(Array)
-        @blacklist_domains << domains if domains.is_a?(String)
-      end
+      raise ListArgument, 'Path or domains are nil' if valid_argument?(path, domains)
+      add_blacklist(load_domains(path)) unless path.nil?
+      add_blacklist(domains) unless domains.nil?
     end
 
     def add_whitelist_domains(path: nil, domains: nil)
-      raise ListArgument, 'Path & domains are nil' if valid_argument?(path, domains)
-      @whitelist_domains << load_domains(path) unless path.nil?
-      unless domains.nil?
-        @whitelist_domains.concat(domains) if domains.is_a?(Array)
-        @whitelist_domains << domains if domains.is_a?(String)
-      end
+      raise ListArgument, 'Path or domains are nil' if valid_argument?(path, domains)
+      add_whitelist(load_domains(path)) unless path.nil?
+      add_whitelist(domains) unless domains.nil?
     end
 
     private
@@ -57,5 +51,15 @@ module RailsEmailChecker
     rescue StandardError => e
       raise FileNotFound, "File not found: #{e}"
     end
+
+    def add_blacklist(domains)
+      @blacklist_domains.concat(domains) if domains.is_a?(Array)
+      @blacklist_domains << domains if domains.is_a?(String)
+    end
+
+    def add_whitelist(domains)
+      @whitelist_domains.concat(domains) if domains.is_a?(Array)
+      @whitelist_domains << domains if domains.is_a?(String)
+    end
   end
 end

data/lib/rails_email_checker/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RailsEmailChecker
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
 end

data/rails_email_checker.gemspec

@@ -31,5 +31,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'simplecov', '~> 0.16'
 
-  spec.add_dependency 'activemodel', '~> 4.2'
+  spec.add_dependency 'activemodel', '>= 4.2', '< 7'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails_email_checker
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Boris BRESCIANI
@@ -84,16 +84,22 @@ dependencies:
   name: activemodel
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '4.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '4.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
 description: ActiveModel email validation. Checks MX records, sub address, regex,
   whitelisted and blacklisted check
 email:
@@ -102,6 +108,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".coveralls.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
@@ -113,6 +120,9 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- gemfiles/Gemfile-4-0
+- gemfiles/Gemfile-5-0
+- gemfiles/Gemfile-6-0
 - lib/rails_email_checker.rb
 - lib/rails_email_checker/address.rb
 - lib/rails_email_checker/configuration.rb