verifalia 1.0.3 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2c358b49dba6da5733e1237ac5720e346841e86d
-  data.tar.gz: 719bab74ee4ad157eb5ee0dd43c770acd88d7ae6
+  metadata.gz: cc088dd144b948e544784c59efe27b5ccb8fe225
+  data.tar.gz: 1164f7c900fce6f4d16eddad18c9fefe3f87b345
 SHA512:
-  metadata.gz: 4a3229ddab59f599439431eb78da0a2db5f75ce200f8cc1d328d51e19e273da8a91d588d055c7cade4f8059af7a5681c487da79a1a25ae4f413ff7b6a1de27cd
-  data.tar.gz: 868e9a260e23e6f883b9c10ecfb421bb13c9c50a09d17b60238682f04fb47026ec27978500f78e4829a3a5997cdac6534bce6239ccba62495783ddb47a70f828
+  metadata.gz: 1c2b30d6e970065d07f88be34ad8a393c16aea08497054dcbd8ed21f3e9183b03fc4b89f1950ed033eaee4562db3aa36a9cfe7c3f58cd0a3ff7c93150676ec0a
+  data.tar.gz: 91e06b91158db5bff1465e86d318603a7c39278611cfe009c5e916f21fa7f8d7cb84e9549445dd1126b10a61da1f8de0c1961361b6654cd18e33411b956307e1

data/README.md

@@ -64,6 +64,40 @@ else
   error = @client.email_validations.error
 end
 
+##with additional email data
+emails = [
+    { inputData: 'alice@example.com', custom: 'custom data' }, #view verifalia API documentation
+    { inputData: 'bob@example.net', custom: 'custom data' } #view verifalia API documentation
+  ]
+if (unique_id = @client.email_validations.verify(emails))
+  #response is an hash with all the values returned
+  response = @client.email_validations.query
+  @client.email_validations.destroy
+else
+  #error is HTTP status code in symbol (:bad_request)
+  error = @client.email_validations.error
+end
+
+##with additional options data
+emails = [
+    { inputData: 'alice@example.com', custom: 'custom data' }, #view verifalia API documentation
+    { inputData: 'bob@example.net', custom: 'custom data' } #view verifalia API documentation
+  ]
+options = { #view verifalia API documentation
+  quality: 'high',
+  priority: 100,
+  deduplication: 'safe'
+}
+
+if (unique_id = @client.email_validations.verify(emails, options))
+  #response is an hash with all the values returned
+  response = @client.email_validations.query
+  @client.email_validations.destroy
+else
+  #error is HTTP status code in symbol (:bad_request)
+  error = @client.email_validations.error
+end
+
 
 ##with previous unique id
 unique_id = "example-example"
@@ -71,7 +105,7 @@ unique_id = "example-example"
 #query job  
 response = @client.email_validations(unique_id: unique_id).query
 
-#delete job 
+#delete job
 @client.email_validations(unique_id: unique_id).destroy
 
 # checking job status

data/lib/rest/client.rb

@@ -19,16 +19,16 @@ module Verifalia
     # ==== @client.email_validations
     #
     class Client
-      
+
       attr_reader :account_sid, :account_token
-      
-      API_VERSION = 'v1.1'
-      
+
+      API_VERSION = 'v1.4'
+
       DEFAULTS = {
         host: 'https://api.verifalia.com',
-        api_version: 'v1.1'
+        api_version: 'v1.4'
       }
-      
+
       ##
       # Instantiate a new HTTP client to talk to Verifalia. The parameters
       # +account_sid+ and +auth_token+ are required, unless you have configured
@@ -46,17 +46,17 @@ module Verifalia
         @config = DEFAULTS.merge! options
         @account_sid = args[0] || Verifalia.account_sid
         @auth_token = args[1] || Verifalia.auth_token
-        
+
         if @account_sid.nil? || @auth_token.nil?
           raise ArgumentError, 'Account SID and auth token are required'
         end
-        
+
       end
-      
+
       ##
-      # Instantiate a new HTTP client to talk to Verifalia Email Validation Api. 
+      # Instantiate a new HTTP client to talk to Verifalia Email Validation Api.
       # The +args+ parameter is a hash of configuration
-      # The following keys are supported: 
+      # The following keys are supported:
       #
       # === <tt>unique_id: 'example-example'</tt>
       #
@@ -69,7 +69,7 @@ module Verifalia
           EmailValidations.new @config, @account_sid, @auth_token, args
         end
       end
-      
+
     end
   end
-end
+end

data/lib/rest/email_validations.rb

@@ -25,10 +25,20 @@ module Verifalia
       #
       # An array of emails to validate
       #
-      def verify(emails)
-        raise ArgumentError, 'emails must be not empty' if (emails.nil? || emails.empty?)
-        data = emails.map { |email| { inputData: email }}
-        content = { entries: data }.to_json
+      def verify(inputs, options = {})
+        raise ArgumentError, 'inputs must be not empty' if (inputs.nil? || inputs.empty?)
+        raise ArgumentError, 'options must be hash' if (!options.is_a?(Hash))
+        data = inputs.map do |input|
+          if (input.is_a? String)
+            { inputData: input }
+          elsif (input.is_a? Hash)
+            raise ArgumentError, 'if inputs content is a Hash you need to supply :inputData as key' if (!input.has_key?(:inputData))
+            input
+          else
+            raise ArgumentError, 'inputs content must be a String or a Hash'
+          end
+        end
+        content = ({ entries: data }.merge(options)).to_json
         begin
           r = @resource.post content
           @unique_id = JSON.parse(r)["uniqueID"]

data/lib/verifalia/version.rb

@@ -1,3 +1,3 @@
 module Verifalia
-  VERSION = "1.0.3"
+  VERSION = "1.1.0"
 end

data/spec/rest/email_validations_spec.rb

@@ -51,7 +51,25 @@ describe Verifalia::REST::EmailValidations do
         expect{ @email_validations.verify([]) }.to raise_error(ArgumentError)
       end
 
-      it 'call #post on @resources with correct parameters' do
+      it 'raise ArgumentError with unvalid options' do
+        emails = ['first', 'second']
+        expect{ @email_validations.verify(emails, 'a string') }.to raise_error(ArgumentError)
+      end
+
+
+      it 'raise ArgumentError with with hash array parameters with invalid value' do
+        inputs = [
+          {
+            fakeKey: 'fake second'
+          },
+          {
+            fakeKey: 'fake second'
+          }
+        ]
+        expect{ @email_validations.verify(inputs) }.to raise_error(ArgumentError)
+      end
+
+      it 'call #post on @resources with string array parameters' do
         emails = ['first', 'second']
         data = emails.map { |email| { inputData: email }}
         content = { entries: data }.to_json
@@ -60,6 +78,31 @@ describe Verifalia::REST::EmailValidations do
         @email_validations.verify(emails)
       end
 
+      it 'call #post on @resources with string array parameters and options' do
+        emails = ['first', 'second']
+        options = { option_1: 'test' }
+        data = emails.map { |email| { inputData: email }}
+        content = { entries: data, option_1: 'test' }.to_json
+        expect(resource).to receive(:post).with(content).and_return(response)
+        expect(JSON).to receive(:parse).with(response).and_return(response_json)
+        @email_validations.verify(emails, options)
+      end
+
+      it 'call #post on @resources with hash array parameters with valid value' do
+        data = [
+          {
+            inputData: 'first'
+          },
+          {
+            inputData: 'second'
+          }
+        ]
+        content = { entries: data }.to_json
+        expect(resource).to receive(:post).with(content).and_return(response)
+        expect(JSON).to receive(:parse).with(response).and_return(response_json)
+        @email_validations.verify(data)
+      end
+
       it 'associate @unique_id and clear @response and @error' do
         emails = ['first', 'second']
         unique_id = 'fake'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: verifalia
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.1.0
 platform: ruby
 authors:
 - Verifalia