NeverBounce 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8492e9c134b40ff99656c55e7d180f7ea04e3642
-  data.tar.gz: 176866a8866313cbdd51eea24c0e53541faac9c3
+  metadata.gz: 57427c26eb66a91d464cd020859972f70ec54d80
+  data.tar.gz: 3714505d7c65b576642e5215133be7f845096333
 SHA512:
-  metadata.gz: 62ca86d3887e2d878755bc3eca7f45129b1bcd9f0b08bc4568e218d0c2f5f0c6be079a2bcc883a6415852e02914573e57aa1edca04c1a0ba9b951c7880891461
-  data.tar.gz: d6bb824b93ec119e010164a8533b79989152b373187d8b9eeff1983ce4f19a0535da03c8ec85be8e70d84c179a770456c67ce9b90a7c3bb630eaa5e3a2bf384a
+  metadata.gz: 0021aa5387a14f5d3d9f7c908972118ac63ecf37cb61ac904caa20feda63bcefcd2bba455cf5012c31d1839ce58fa364717a47e54a46b68bb833f4420658e999
+  data.tar.gz: 37f82550311dee9e9fd0c078bbc9575e0cbcb5a2d212300d6b2afb41ed811d848209683fd095e27c1d993e1dc511df385b6f2f61a731b61298efa2d41e1b3656

data/.gitignore

@@ -0,0 +1,95 @@
+# Created by .ignore support plugin (hsz.mobi)
+### Node template
+# Logs
+logs
+*.log
+npm-debug.log*
+
+# Runtime data
+pids
+*.pid
+*.seed
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+
+# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (http://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directory
+# https://docs.npmjs.com/misc/faq#should-i-check-my-node-modules-folder-into-git
+node_modules
+### SublimeText template
+# cache files for sublime text
+*.tmlanguage.cache
+*.tmPreferences.cache
+*.stTheme.cache
+
+# workspace files are user-specific
+*.sublime-workspace
+
+# project files should be checked into the repository, unless a significant
+# proportion of contributors will probably not be using SublimeText
+# *.sublime-project
+
+# sftp configuration file
+sftp-config.json
+### JetBrains template
+# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio
+
+*.iml
+
+## Directory-based project format:
+.idea/
+# if you remove the above rule, at least ignore the following:
+
+# User-specific stuff:
+# .idea/workspace.xml
+# .idea/tasks.xml
+# .idea/dictionaries
+
+# Sensitive or high-churn files:
+# .idea/dataSources.ids
+# .idea/dataSources.xml
+# .idea/sqlDataSources.xml
+# .idea/dynamic.xml
+# .idea/uiDesigner.xml
+
+# Gradle:
+# .idea/gradle.xml
+# .idea/libraries
+
+# Mongo Explorer plugin:
+# .idea/mongoSettings.xml
+
+## File-based project format:
+*.ipr
+*.iws
+
+## Plugin-specific files:
+
+# IntelliJ
+/out/
+
+# mpeltonen/sbt-idea plugin
+.idea_modules/
+
+# JIRA plugin
+atlassian-ide-plugin.xml
+
+# Crashlytics plugin (for Android Studio and IntelliJ)
+com_crashlytics_export_strings.xml
+crashlytics.properties
+crashlytics-build.properties
+
+examples/
+*.gem

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1
+  - 2.2

data/Gemfile

@@ -0,0 +1,6 @@
+# A sample Gemfile
+source "https://rubygems.org"
+
+gem "httparty"
+gem "rspec"
+gem "rake"

data/NeverBounce.gemspec

@@ -0,0 +1,21 @@
+require './NeverBounce'
+
+Gem::Specification.new do |s|
+  s.name        = 'NeverBounce'
+  s.version     = NeverBounce::VERSION
+  s.date        = '2016-02-22'
+  s.summary     = "The official NeverBounce API library for Ruby"
+  s.description = "The official NeverBounce API library for Ruby"
+  s.authors     = ["Mike Mollick"]
+  s.email       = ['mike@neverbounce.com']
+  s.homepage    = 'https://neverbounce.com'
+  s.license     = 'MIT'
+  s.files       = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- spec/*`.split("\n")
+  s.required_ruby_version     = '>= 1.9.3'
+
+  s.add_dependency('httparty', '~> 0.13.7')
+
+  s.add_development_dependency('rspec', '~> 3.4.0')
+  s.add_development_dependency('rake')
+end

data/NeverBounce.rb

@@ -6,7 +6,7 @@ require './NeverBounce/Single'
 
 module NeverBounce
 
-	VERSION = "0.1.1"
+	VERSION = "0.1.2"
 
 	class API 
 	    include HTTParty

data/README.md

@@ -0,0 +1,37 @@
+NeverBounce API Ruby Wrapper
+---
+
+This is the official NeverBounce API Ruby wrapper. It provides helpful methods to quickly implement our API in your Ruby applications.
+
+Installation
+===
+
+>TODO: Make into a gem
+
+Usage
+===
+
+To start using the wrapper sign up for an account [here](https://app.neverbounce.com/register) and get your api keys [here](https://app.neverbounce.com/settings/api).
+
+To initialize the wrapper use the following snippet, substituting in your `api key` and `api secret key`...
+
+```
+neverbounce = NeverBounce::API.new(API_KEY, API_SECRET_KEY)
+```
+
+You can now access the verify method from this class. To validate a single email use the following...
+
+```
+result = neverbounce.single.verify(EMAIL)
+```
+
+The `result` will contain a VerificationResult class instance. It provides several helper methods documented below...
+
+```
+result.getResultCode # Numeric result code; ex: 0, 1, 2, 3, 4
+result.getResultTextCode # Textual result code; ex: valid, invalid, disposable, catchall, unknown
+result.is(0) # Returns true if result is valid
+result.is([0,3,4]) # Returns true if result is valid, catchall, or unknown
+result.not(1) # Returns true if result is not invalid
+result.not([1,2]) # Returns true if result is not invalid or disposable
+```

data/Rakefile

@@ -0,0 +1,9 @@
+require 'rake'
+require 'rspec/core/rake_task'
+ 
+RSpec::Core::RakeTask.new(:spec) do |t|
+	t.pattern = Dir.glob('spec/**/*_spec.rb')
+	t.rspec_opts = '--format documentation'
+end
+
+task :default => :spec

data/spec/VerifiedEmail_spec.rb

@@ -0,0 +1,37 @@
+require './NeverBounce/Single'
+require 'spec_helper'
+
+
+
+describe "VerifiedEmail" do
+	context "will create new instance from response"  do
+		x = NeverBounce::VerifiedEmail.new({
+                'success' => true,
+                'result' => 0,
+                'result_details' => 0,
+                'execution_time' => 0.22115206718445
+            })
+		
+		it "and getResultCode will return 0" do
+            expect(x.getResultCode).to eq 0
+		end
+
+		it "and getResultTextCode will return 'valid'" do
+            expect(x.getResultTextCode).to eq 'valid'
+		end
+
+		it "and is will return expected result" do
+            expect(x.is(0)).to eq true
+            expect(x.is([0])).to eq true
+            expect(x.is(1)).to eq false
+            expect(x.is([1,2,3])).to eq false
+		end
+
+		it "and not will return expected result" do
+            expect(x.not(0)).to eq false
+            expect(x.not([0])).to eq false
+            expect(x.not(1)).to eq true
+            expect(x.not([1,2,3])).to eq true
+		end
+	end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,96 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Allows RSpec to persist some state between runs in order to support
+  # the `--only-failures` and `--next-failure` CLI options. We recommend
+  # you configure your source control system to ignore this file.
+  config.example_status_persistence_file_path = "spec/examples.txt"
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/
+  #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#zero-monkey-patching-mode
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: NeverBounce
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Mike Mollick
@@ -59,9 +59,18 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ./NeverBounce.rb
-- ./NeverBounce/Errors.rb
-- ./NeverBounce/Single.rb
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- NeverBounce.gemspec
+- NeverBounce.rb
+- NeverBounce/Errors.rb
+- NeverBounce/Single.rb
+- README.md
+- Rakefile
+- spec/VerifiedEmail_spec.rb
+- spec/spec_helper.rb
 homepage: https://neverbounce.com
 licenses:
 - MIT
@@ -86,4 +95,6 @@ rubygems_version: 2.0.14
 signing_key: 
 specification_version: 4
 summary: The official NeverBounce API library for Ruby
-test_files: []
+test_files:
+- spec/VerifiedEmail_spec.rb
+- spec/spec_helper.rb