NeverBounce 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 750d0e93775760d313217a7b614a3c8b4ce8f240
+  data.tar.gz: bdaa1506374b3943afb32656f23dceebf100bace
+SHA512:
+  metadata.gz: 87b28a0bbe4af34d05be84a8d3709e13c6d566bcead7f7fd146f49c69fd4b0ff3f7fbe89bdfd131ff1491ecf82707fabe4595c4a325c55bcb939e381e1f7713f
+  data.tar.gz: e74d3be74eb2bdc15b5d0879b3bf84b00716c0ba699c9f19e5c3b537486ab2fb99fd8353fc6f19a5e1628bb7fc4357307ad7c41707bc52da0e76ddec106a898e

data/NeverBounce.rb

@@ -0,0 +1,107 @@
+require 'HTTParty'
+require 'json';
+
+require './NeverBounce/Errors'
+require './NeverBounce/Single'
+
+module NeverBounce
+
+	VERSION = "0.1.0"
+
+	class API 
+	    include HTTParty
+        attr_accessor :host, :path, :apikey, :apiSecret, :accessToken, :options
+        base_uri 'https://api.neverbounce.com'
+        # base_uri 'http://localhost:8000'
+
+		def initialize(apiKey, apiSecret)
+            @apiKey = apiKey;
+			@apiSecret = apiSecret;
+			@accessToken = nil;
+    		@options = {:headers => {
+    			"Content-Type" => "application/x-www-form-urlencoded",
+    			"User-Agent" => "NeverBounce-Ruby/" + VERSION}
+    		}
+
+            raise AuthError, "You must provide a NeverBounce API key" unless @apiKey
+            raise AuthError, "You must provide a NeverBounce API secret key" unless @apiSecret
+        end
+
+        # Rescuable json parser
+	    parser(
+	      proc do |body, format|
+	        begin
+	          JSON.parse(body)
+	        rescue JSON::ParserError => e
+	          raise ResponseError, "The response from NeverBounce was unable " \
+                                	"to be parsed as json. Try the request " \
+                                	"again, if this error persists " \
+                                	"let us know at support@neverbounce.com." \
+                                	"\n\n(Internal error)"
+	        end
+	      end
+	    )
+
+	    # Call api endpoint
+	    def call(endpoint, body)
+	    	begin
+	    		opts = body.merge({:access_token => getAccessToken})
+	    		request(endpoint, {:body => opts})
+	    	# If access token is expired we'll retry the request
+	    	rescue AccessTokenExpired
+	    		@accessToken = nil
+	    		opts = body.merge({:access_token => getAccessToken})
+	    		request(endpoint, {:body => opts})
+	    	end
+	    end
+
+	    # Makes the actual api request
+	    def request(endpoint, params)
+	      opts = options.merge(params)
+	      response = self.class.post(endpoint, opts)
+
+	      # Handle non successful requests
+	      if response['success'] === false
+	      	if response['msg'] === 'Authentication failed'
+	      		raise AccessTokenExpired
+	      	end
+
+	        raise RequestError, "We were unable to complete your request. " \
+	              				"The following information was supplied: " \
+				              	"#{response['msg']} " \
+				            	"\n\n(Request error)"
+	      end
+	      response
+	    end
+
+	    # Lets get the access token
+	    # If we don't have one available
+	    # already we'll request a new one
+	    def getAccessToken
+	      # Get existing access token if available
+	      if @accessToken != nil 
+	        return @accessToken
+	      end
+
+	      # Perform request if no existing access token
+	      response = request('/v3/access_token', 
+	        :body => {:grant_type => 'client_credentials', :scope => 'basic user'},
+	        :basic_auth => {:username => @apiKey, :password => @apiSecret}
+		  )
+
+	      if response['error'] != nil
+	      	raise AuthError,	"We were unable to complete your request. " \
+                        		"The following information was supplied: " \
+                        		"#{response['error_description']}" \
+                        		"\n\n(Request error [#{response['error']}])"
+	      end
+
+	      @accessToken = response['access_token']
+	    end
+
+	    # Initializes the single method
+	    def single
+	    	Single.new(self)
+	    end
+	end
+end

data/NeverBounce/Errors.rb

@@ -0,0 +1,15 @@
+module NeverBounce
+    class Error < StandardError
+    end
+    class AccessTokenExpired < Error
+    end
+    class ApiError < Error
+    end
+    class AuthError < Error
+    end
+    class ResponseError < Error
+    end
+    class RequestError < Error
+    end
+end
+

data/NeverBounce/Single.rb

@@ -0,0 +1,53 @@
+module NeverBounce 
+	class Single
+		attr_accessor :master
+
+        def initialize(master)
+            @master = master
+        end
+
+        # Makes verification request
+        # Returns VerifiedEmail instance
+		def verify(email)
+			VerifiedEmail.new(@master.call('/v3/single', {:email => email}))
+		end
+	end
+	class VerifiedEmail
+
+		def initialize(response)
+			@response = response
+			@textCodes = ['valid','invalid','disposable','catchall','unknown']
+		end
+
+		# Returns numeric result code
+		def getResultCode
+			@response['result']
+		end
+
+		# Returns textual result code
+		def getResultTextCode
+			@textCodes[@response['result']]
+		end
+
+		# Returns true if result is in the specified codes
+		# Accepts either array of result codes or single result code
+		def is(codes)
+			if codes.kind_of?(Array)
+				codes.include?(@response['result'])
+			else
+				codes === @response['result']
+			end
+		end
+
+		# Returns true if result is NOT in the specified codes
+		# Accepts either array of result codes or single result code
+		def not(codes)
+			if codes.kind_of?(Array)
+				!codes.include?(@response['result'])
+			else
+				codes != @response['result']
+			end
+		end
+
+	end
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: NeverBounce
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Mike Mollick
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-02-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.13.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.13.7
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.4.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.4.0
+- !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'
+description: 'This offers '
+email:
+- mike@neverbounce.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ./NeverBounce.rb
+- ./NeverBounce/Errors.rb
+- ./NeverBounce/Single.rb
+homepage: https://neverbounce.com
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.14
+signing_key: 
+specification_version: 4
+summary: The official NeverBounce API library for Ruby
+test_files: []