mailboxlayer 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c6b0d758b4c2457dfcdf6de3499c167b45470e11
+  data.tar.gz: 0ab60b3d43373287ea7da40e1deecf41ba01cfe7
+SHA512:
+  metadata.gz: 1adbcb31b89752f050476d8dd33e2ec447a3894d5e85b944cb1fa1a28e82f67ba1b1327f1ebed1353d7f390df76f177819946aeb5fd0b8aecde739b1a98616b6
+  data.tar.gz: ce15fd8c66c8dac7d4098b5a9a95394d4aa98ac9d918b6e31ef4df96638db37d92942830ece0cdad64e0d8bbc64883e3a213c4c645bb8a65f65ee02ecbad7bb4

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (C) 2016 Alex Fong http://www.github.com/actfong
+
+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.rdoc

@@ -0,0 +1,58 @@
+== mailboxlayer
+
+Ruby wrapper for mailboxlayer of apilayer.
+See https://mailboxlayer.com/ and http://apilayer.com for more details.
+
+=== Introduction
+Connect to mailboxlayer.com to verify email addresses.
+Mailboxlayer verifies the existence of email-addresses by first checking MX-records (to see whether the specified domain is configured to receive emails), then by contacting the corresponding email server through SMTP, to see whether the provided email exists.
+
+While the *mailboxlayer* gem focuses on the functionalities offered by mailboxlayer, it depends on the *apilayer* gem to configure and create connections to apilayer.net
+
+=== Installation
+
+==== Using Bundler
+
+Add apilayer in your <tt>Gemfile</tt>:
+
+  gem "mailboxlayer"
+
+Run the following in your console:
+
+  $ bundle install
+
+=== Usage
+
+==== Add to your application
+  require "mailboxlayer"
+
+==== Set up mailboxlayer
+Once you have signed up for *mailboxlayer.com*, you will receive an access_key.
+Then configure your Apilayer::Mailbox module like this:
+
+  Apilayer::Mailbox.configure do |configs|
+    configs.access_key = "my_access_key_123"
+    configs.https = true
+  end
+
+Please note that the https configuration is optional and only available to paid-accounts.
+If unset, these configuration-values are just nil.
+
+You can always review you configurations with:
+
+  Apilayer::Mailbox.configs
+
+Once your configurations are set, you are ready to go
+
+==== mailboxlayer
+After setting the access_key for *mailboxlayer*, you can use Apilayer::Mailbox to call *mailboxlayer*'s API
+
+  Apilayer::Mailbox.check("support@apilayer.com")
+
+==== Re-Configure access_key and https
+If you happened to have forgotten to set or entered an incorrect value, you can re-configure your Apilayer module by:
+
+  # Example: reconfigure https
+  Apilayer::Mailbox.configure do |configs|
+    configs.https = true
+  end

data/Rakefile

@@ -0,0 +1,5 @@
+require 'rspec/core/rake_task'
+task :default => :spec
+desc 'Run test suite'
+
+RSpec::Core::RakeTask.new(:spec)

data/lib/apilayer/mailbox.rb

@@ -0,0 +1,41 @@
+##
+# Ruby wrapper for mailboxlayer. See https://mailboxlayer.com/documentation for more info
+module Apilayer
+  module Mailbox
+    extend ConnectionHelper
+
+    INVALID_OPTIONS_MSG = 'You have provided an invalid option. Only :smtp is allowed'
+
+    ## Validations
+    #
+    def self.validate_options(options)
+      options.keys.each do |key|
+        unless [:smtp].include? key
+          raise Apilayer::Error.new(INVALID_OPTIONS_MSG)
+        end
+      end
+    end
+
+    ##
+    # Api-Method: Calls the /check endpoint to verify the existence of an email address
+    #
+    # Examples:
+    #   Apilayer::Mailbox.check('support@apilayer.com')
+    #   Apilayer::Mailbox.check('support@apilayer.com', {smtp: false}) # If you don't want to perform smtp checks
+    def self.check(email, opts={})
+      validate_options(opts)
+      opts = assign_smtp_value(opts)
+      params = { email: email }.merge(opts)
+      get_and_parse("check", params)
+    end
+
+    private
+    def self.assign_smtp_value(opts)
+      if opts[:smtp] == false
+        { smtp: 0 }
+      else
+        { smtp: 1 }
+      end
+    end
+  end
+end

data/lib/mailboxlayer.rb

@@ -0,0 +1,4 @@
+require 'rubygems'
+require 'apilayer'
+
+require "apilayer/mailbox"

metadata

@@ -0,0 +1,214 @@
+--- !ruby/object:Gem::Specification
+name: mailboxlayer
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Alex Fong
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-10-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: apilayer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.10.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.10.1
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.10.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.10.1
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.7.9
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.7.9
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.11.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.11.0
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.1
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+description: Ruby wrapper for mailboxlayer by apilayer. This gem depends on the apilayer
+  gem, which provides a common connection-interface to various services of apilayer.net
+  (such as currencylayer and mailboxlayer). See https://mailboxlayer.com/ and https://apilayer.com/
+  for more details.
+email:
+- actfong@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE
+- README.rdoc
+- Rakefile
+- lib/apilayer/mailbox.rb
+- lib/mailboxlayer.rb
+homepage: https://github.com/actfong/mailboxlayer
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Ruby wrapper for mailboxlayer by apilayer. See https://mailboxlayer.com/
+  and https://apilayer.com/ for more details.
+test_files: []