kickbox_rails 1.0.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NGYxMTJhY2NjNzU4NDlhZjgzMjZiN2M1NTYyZjMxOWQ2MGMyNzJmNA==
+  data.tar.gz: !binary |-
+    MjdiZjBkY2Q0ZDQ3NWM0Yzg1MjVjNmVmNTA2NjZhZWFjMzg1ODM1NQ==
+SHA512:
+  metadata.gz: !binary |-
+    NWVlYzRkNzAzMjAzNDgzZjZhY2M5Yzg2NDI4MmI0NTMzNmM3NmJkN2Q2ZjBh
+    ZmQzZmM3N2NhNGU2ZDI1OTNiNjMwYWNkYjIyNzBkZTZhZWIwMmY4YzRjNzI1
+    Y2Y4MTgxYjQyYjdhMmI5ZjlkYzhmMjAyNGI5ZDkxM2Q2MzM5ODQ=
+  data.tar.gz: !binary |-
+    YmU4NDMyMmY4MGNjODNmNTA3MzNkNDE4MGE0MWI5NjJhMGEwYTYxODQ2Y2Nj
+    NzA0YzExNzI5Y2VmY2QwODZmZjRmMzJhMzEyYjJlMjVkODQyYzNjZDQyNmY0
+    ZTMyNjJjOTM2MWM3Y2Q5ZGYzY2I1NDQ0NjFlMzkyOWE3MjAwZmE=

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Samuel Navas
+
+MIT License
+
+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,60 @@
+# KickboxRails
+
+Validate emails using Kickbox.io API in Ruby on Rails and fallback to basic syntax email validation if Kickbox.io API fails for any reason
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'kickbox_rails'
+
+And then execute:
+
+    $ bundle
+
+Execute next command for generate initializer kickbox_rails.rb, where you can configure your kickbox.io account api_key:
+
+    $ rails g kickbox_rails:install
+
+## Usage
+
+    # Rails
+    class Person < ActiveRecord::Base
+      validates_kickbox_email_format :email
+      # OR
+      validates :email, kickbox_email_format: { message: 'Email is invalid' }
+    end
+
+    # Non Rails
+    KickboxRails.valid?("example@email.com")
+    KickboxRails.invalid?("example@email.com")
+
+    If you want to get related info from kickbox.io API use validate method
+
+    KickboxRails.validate("bill.lumbergh@gamil.com") =>
+
+    {
+      "result":"invalid",
+      "reason":"rejected_email",
+      "role":false,
+      "free":false,
+      "disposable":false,
+      "accept_all":false,
+      "did_you_mean":"bill.lumbergh@gmail.com",
+      "sendex":0,
+      "email":"bill.lumbergh@gamil.com",
+      "user":"bill.lumbergh",
+      "domain":"gamil.com",
+      "success":true,
+      "message":null
+    }
+
+
+## Contributing
+
+1. Fork it ( http://github.com/the-cocktail/kickbox_rails/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

data/Rakefile

@@ -0,0 +1,3 @@
+require "bundler/gem_tasks"
+
+Dir.glob('tasks/**/*.rake').each(&method(:import))

data/kickbox_rails.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'kickbox_rails/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "kickbox_rails"
+  spec.version       = KickboxRails::VERSION
+  spec.authors       = ["Samuel Navas"]
+  spec.email         = ["samuel.navas@the-cocktail.com"]
+  spec.summary       = %q{email validation using kikbox.io service}
+  spec.description   = %q{Validates email against Kickbox.io service}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+
+  spec.add_dependency 'i18n'
+  spec.add_dependency "faraday"
+  spec.add_dependency "json"
+
+end

data/lib/generators/kickbox_rails/install_generator.rb

@@ -0,0 +1,14 @@
+module KickboxRails
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path("../../templates", __FILE__)
+      desc "Creates KickboxRails initializer for your application"
+
+      def copy_initializer
+        template "kickbox_rails_initializer.rb", "config/initializers/kickbox_rails.rb"
+
+        puts "Install complete!"
+      end
+    end
+  end
+end

data/lib/generators/templates/kickbox_rails_initializer.rb

@@ -0,0 +1,7 @@
+KickboxRails.configure do |config|
+  # Configure validator with Kickbox.io API KEY. Uncomment next lines and keep api_url
+  # and api_resource or change them if kickbox api url has been modified.
+  config.api_url = 'https://api.kickbox.io'
+  config.api_resource = '/v1/verify'
+  config.api_key = 'API_KEY_HERE'
+end

data/lib/kickbox_api.rb

@@ -0,0 +1,29 @@
+class KickboxApi
+  def initialize opts = {}
+    @token = opts[:token]
+    @end_point = opts[:end_point]
+    @url = opts[:url]
+
+    raise ArgumentError if @token.nil? || @end_point.nil? || @url.nil?
+
+    @conn = Faraday.new(@url) do |faraday|
+      faraday.adapter  Faraday.default_adapter
+    end
+  end
+
+  def verify email
+    begin
+      response = @conn.get do |req|
+        req.url "#{@end_point}?email=#{email}&apikey=#{@token}"
+        req.options.timeout = 2
+        req.options.open_timeout = 2
+      end
+
+      if response.status == 200
+        JSON.parse(response.body) if response.body.is_a? String
+      end
+    rescue
+      {'success' => 'false'}
+    end
+  end
+end

data/lib/kickbox_email_format_validator.rb

@@ -0,0 +1,23 @@
+require 'kickbox_rails'
+require 'i18n'
+
+module ActiveModel
+  module Validations
+    class KickboxEmailFormatValidator < EachValidator
+
+      DEFAULT_MESSAGE = "Email is invalid"
+
+      def validate_each(record, attribute, value)
+        if KickboxRails.invalid?(value)
+          record.errors[attribute] << (defined?(I18n) ? I18n.t(:invalid_email_address, :default => (options[:message]||DEFAULT_MESSAGE), :locale => I18n.default_locale) : (options[:message]||DEFAULT_MESSAGE))
+        end
+      end
+    end
+
+    module HelperMethods
+      def validates_kickbox_email_format(*attr_names)
+        validates_with KickboxEmailFormatValidator, _merge_attributes(attr_names)
+      end
+    end
+  end
+end

data/lib/kickbox_rails/version.rb

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

data/lib/kickbox_rails.rb

@@ -0,0 +1,70 @@
+require 'json'
+require 'faraday'
+require 'kickbox_api'
+
+
+module KickboxRails
+  class << self
+    attr_accessor :configuration, :provider
+
+    def configure
+      @configuration ||= Configuration.new
+      yield(configuration)
+      @provider = KickboxApi.new(url: @configuration.api_url,
+                                    end_point: @configuration.api_resource,
+                                    token: @configuration.api_key)
+    end
+
+    def validate email
+      begin
+        response = @provider.verify(email||String.new)
+        # fallbacks if provider return success = false
+        throw Exception unless response['success']
+
+        response
+
+      rescue Exception => e
+        # If Kickbox service respond with Error we do fallback to basic validation
+        basic_email_validation email
+      end
+    end
+
+    def valid? email
+      response = validate(email)
+      response['result'] == 'valid' ? true : false
+    end
+
+    def invalid? email
+      !valid? email
+    end
+
+    private
+
+    # Basic validation with standard regexp for emails
+    def basic_email_validation email, options = {}
+      result = if (email =~ /\A([^@\s]+)@((?:[-a-z0-9]+\.)+[a-z]{2,})\Z/i).nil?
+        {
+          'result' => 'invalid',
+          'reason' => options[:reason] || "invalid_email"
+        }
+      else
+        {
+          'result' => 'valid',
+        }
+      end
+    end
+  end
+
+  class Configuration
+    attr_accessor :api_key, :api_url, :api_resource
+
+    def initialize
+      @api_key = nil
+      @api_url = nil
+      @api_resource = nil
+    end
+  end
+end
+
+
+require 'kickbox_email_format_validator' if defined?(::ActiveModel) && !(ActiveModel::VERSION::MAJOR < 2 || (2 == ActiveModel::VERSION::MAJOR && ActiveModel::VERSION::MINOR < 1))

data/spec/email_validator_spec.rb

@@ -0,0 +1,120 @@
+require 'spec_helper'
+
+describe KickboxRails do
+  subject { KickboxRails.new }
+
+  describe "Configuration" do
+    before do
+      KickboxRails.configure do |config|
+        config.api_key = 'example_key'
+        config.api_url = 'http://example-url.com/'
+        config.api_resource = 'v1/resource'
+      end
+    end
+
+    it 'is configurable' do
+      expect(KickboxRails.configuration.api_key).to eq('example_key')
+      expect(KickboxRails.configuration.api_url).to eq('http://example-url.com/')
+      expect(KickboxRails.configuration.api_resource).to eq('v1/resource')
+    end
+  end
+
+  describe "Email" do
+
+    let(:valid_email) { "example@gmail.com" }
+    let(:invalid_email) { "examplemail.com" }
+    let(:valid_result) { Hash['result','valid'] }
+    let(:invalid_result) { Hash['result','invalid','reason','invalid_email'] }
+    let(:valid_service_result) do
+      {
+        "result" => "valid",
+        "reason" => "accepted_email",
+        "role" => false,
+        "free" => false,
+        "disposable" => false,
+        "accept_all" => true,
+        "did_you_mean" => nil,
+        "sendex" => 0.9,
+        "email" => "example@gmail.com",
+        "user" => "example",
+        "domain" => "gmail.com",
+        "success" => true,
+        "message" => nil
+      }
+    end
+
+    let(:invalid_service_result) do
+      {
+        "result" => "invalid",
+        "reason" => "rejected_email",
+        "role" => false,
+        "free" => false,
+        "disposable" => false,
+        "accept_all" => false,
+        "did_you_mean" => "example@gmail.com",
+        "sendex" => "0",
+        "email" => "example@gamil.com",
+        "user" => "example",
+        "domain" => "gamil.com",
+        "success" => true,
+        "message" => nil
+      }
+    end
+
+    let(:error_service_result) do
+      {
+        "success" => false,
+        "message" => "No email address defined"
+      }
+    end
+
+    it 'is valid with basic validation' do
+      expect(KickboxRails.validate(valid_email)).to eq(valid_result)
+    end
+
+    it 'is invalid with basic validation' do
+      expect(KickboxRails.validate(invalid_email)).to eq(invalid_result)
+    end
+
+    it 'is invalid with nil parameter' do
+      expect(KickboxRails.validate(nil)).to eq(invalid_result)
+    end
+
+    it 'is valid with service validation' do
+      allow(KickboxRails.provider).to receive(:verify).and_return(valid_service_result)
+      expect(KickboxRails.validate(valid_email)).to eq(valid_service_result)
+    end
+
+    it 'is invalid with service validation' do
+      allow(KickboxRails.provider).to receive(:verify).and_return(invalid_service_result)
+      expect(KickboxRails.validate(valid_email)).to eq(invalid_service_result)
+    end
+
+    it 'fallbacks to valid on service error ' do
+      allow(KickboxRails.provider).to receive(:verify).and_return(error_service_result)
+      expect(KickboxRails.validate(valid_email)).to eq(valid_result)
+    end
+
+    it 'fallbacks to invalid on service error ' do
+      allow(KickboxRails.provider).to receive(:verify).and_return(error_service_result)
+      expect(KickboxRails.validate(invalid_email)).to eq(invalid_result)
+    end
+
+    it 'fallbacks to invalid on nil value and service error ' do
+      allow(KickboxRails.provider).to receive(:verify).and_return(error_service_result)
+      expect(KickboxRails.validate(nil)).to eq(invalid_result)
+    end
+
+    it 'is valid? eq true' do
+      expect(KickboxRails.valid?(valid_email)).to eq(true)
+    end
+
+    it 'is valid? eq false' do
+      expect(KickboxRails.valid?(invalid_email)).to eq(false)
+    end
+
+    it 'is valid? eq false with nil parameter' do
+      expect(KickboxRails.valid?(nil)).to eq(false)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+require 'bundler'
+Bundler.setup
+
+require 'kickbox_rails'
+
+Bundler.require(:test)
+
+RSpec.configure do |config|
+  # Use color in STDOUT
+  config.color = true
+
+  # Use color not only in STDOUT but also in pagers and files
+  config.tty = true
+
+  # Use the specified formatter
+  config.formatter = :documentation # :progress, :html, :textmate
+end

data/tasks/rspec.rake

@@ -0,0 +1,3 @@
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification
+name: kickbox_rails
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Samuel Navas
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Validates email against Kickbox.io service
+email:
+- samuel.navas@the-cocktail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- kickbox_rails.gemspec
+- lib/generators/kickbox_rails/install_generator.rb
+- lib/generators/templates/kickbox_rails_initializer.rb
+- lib/kickbox_api.rb
+- lib/kickbox_email_format_validator.rb
+- lib/kickbox_rails.rb
+- lib/kickbox_rails/version.rb
+- spec/email_validator_spec.rb
+- spec/spec_helper.rb
+- tasks/rspec.rake
+homepage: ''
+licenses:
+- MIT
+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.2.2
+signing_key: 
+specification_version: 4
+summary: email validation using kikbox.io service
+test_files:
+- spec/email_validator_spec.rb
+- spec/spec_helper.rb