verifalia 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8f62d7d052459f6b915e2a063e82f365a193efef
-  data.tar.gz: 56664aa94a510c5d84f8c57f2a2b3426e133e74d
+  metadata.gz: a9268cdfd8adf22bf8c53aaccb317df2ca89c73d
+  data.tar.gz: 0c875f61b52640e85ea599761af5eba0894d431e
 SHA512:
-  metadata.gz: 3c7bdd1bd0b2f787bd7103f678b16a6c9707e943d9eee5625c55f4a40d8beaaaa1073657a0fdb1d45266e526cb340e2d8308de5c7791e1084ca945d96b017de4
-  data.tar.gz: ebf691e4f825735b3b491ed0767598416ba3742fa2669f9db862d5c201898123d72de33c9e6e89c76823c3f351fb833b0f6553ee9e69454de75203e55df4e5b0
+  metadata.gz: 1fba2b844ea0d21a932f734804954ab41b9422ea4554edd340ac297283e463c5b29752cd62065541180c8f1f452e67e50377d3eaa5eebf646679af085ede140d
+  data.tar.gz: f35f86c72f10877bd0de0442241ac93284e5cd4cf49862420b01646f5a19c1d2abcf2a9840509dc6626463398f7051e3b6a5d5ed4a19ddba5c101129383375c5

data/Gemfile

@@ -4,8 +4,6 @@ source 'https://rubygems.org'
 gemspec
 
 group :test do
-  #gem 'rake', '~> 10.1'
   gem 'rspec', '~> 3.0'
-  #gem 'fakeweb', '~> 1.3'
-  #gem 'rack', '~> 1.3'
-end
+  gem 'coveralls', require: false
+end

data/README.md

@@ -1,3 +1,10 @@
+[![Circle CI](https://circleci.com/gh/verifalia/verifalia-ruby-sdk.svg?style=shield)](https://circleci.com/gh/verifalia/verifalia-ruby-sdk)
+[![Gem Version](https://badge.fury.io/rb/verifalia.svg)](https://badge.fury.io/rb/verifalia)
+[![Dependency Status](https://gemnasium.com/verifalia/verifalia-ruby-sdk.svg)](https://gemnasium.com/verifalia/verifalia-ruby-sdk)
+[![Code Climate](https://codeclimate.com/github/verifalia/verifalia-ruby-sdk/badges/gpa.svg)](https://codeclimate.com/github/verifalia/verifalia-ruby-sdk)
+[![Coverage Status](https://coveralls.io/repos/verifalia/verifalia-ruby-sdk/badge.svg?branch=master&service=github)](https://coveralls.io/github/verifalia/verifalia-ruby-sdk?branch=master)
+[![Inline docs](http://inch-ci.org/github/verifalia/verifalia-ruby-sdk.svg?branch=master)](http://inch-ci.org/github/verifalia/verifalia-ruby-sdk)
+
 # Verifalia RESTful API - Ruby gem
 
 Verifalia provides a simple HTTPS-based API for validating email addresses and checking whether or not they are deliverable;
@@ -46,7 +53,7 @@ end
 ### Email Validations ###
 
 ```ruby
-#from scratch
+##from scratch
 emails = ['alice@example.com', 'bob@example.net']
 if (unique_id = @client.email_validations.verify(emails))
   #response is an hash with all the values returned
@@ -58,11 +65,18 @@ else
 end
 
 
-#with previous unique id
+##with previous unique id
 unique_id = "example-example"
 
-respone = @client.email_validations(unique_id: unique_id).query
+#query job  
+response = @client.email_validations(unique_id: unique_id).query
 
+#delete job 
 @client.email_validations(unique_id: unique_id).destroy
 
+# checking job status
+if @client.email_validations(unique_id: unique_id).completed?
+  response = @client.email_validations(unique_id: unique_id).query
+end
+
 ```

data/lib/rest/email_validations.rb

@@ -2,22 +2,21 @@ require 'rest_client'
 module Verifalia
   module REST
     class EmailValidations
-      
       ##
       # The Verifalia::REST::EmailValidations class allow you to comminucate
       # with Email Validations Api. You don't need to instantiate this class, but
       # use the client for autoconfiguration. # The +args+ parameter is a hash of configuration
-      # The following keys are supported: 
+      # The following keys are supported:
       #
       # === <tt>unique_id: 'example-example'</tt>
       #
       # The unique if of the Verifalia Email Validation resource
       #
       def initialize(config, account_sid, account_token, args = {})
-        @resource = RestClient::Resource.new "#{config[:host]}/#{config[:api_version]}/email-validations", account_sid, account_token
+        @resource = build_resource(config, account_sid, account_token)
         @unique_id = args[:unique_id] if args[:unique_id]
       end
-      
+
       ##
       # Query the Email Validations Api with:
       #
@@ -30,7 +29,7 @@ module Verifalia
         data = emails.map { |email| { inputData: email }}
         content = { entries: data }.to_json
         begin
-          r = @resource.post content, content_type: :json
+          r = @resource.post content
           @unique_id = JSON.parse(r)["uniqueID"]
           @response = nil
           @error = nil
@@ -40,7 +39,7 @@ module Verifalia
           false
         end
       end
-      
+
       ##
       # Query the Email Validations Api for specific result. In order to use
       # this method you need to supply unique_id uring initialization or call verify first. If request fail,
@@ -49,8 +48,8 @@ module Verifalia
       def query
         raise ArgumentError, 'You must call verify first or supply and uniqueId' unless @unique_id
         unless @response
-          begin 
-            r = @resource[@unique_id].get content_type: :json
+          begin
+            r = @resource[@unique_id].get
             @response = JSON.parse(r)
             @error = nil
           rescue => e
@@ -60,7 +59,7 @@ module Verifalia
         end
         @response
       end
-      
+
       ##
       # Destroy an Email Validations entity. In order to use
       # this method you need to supply unique_id during initialization or call verify first. If request fail,
@@ -69,7 +68,7 @@ module Verifalia
       def destroy
         raise ArgumentError, 'You must call verify first or supply and uniqueId' unless @unique_id
         begin
-          r = @resource[@unique_id].delete content_type: :json
+          r = @resource[@unique_id].delete
           @error = nil
           @response = nil
           @unique_id = nil
@@ -79,22 +78,27 @@ module Verifalia
           return false
         end
       end
-      
+
       ##
       # Check if the Email validation entity is completed processed. In order to use
-      # this method you need to supply unique_id during initialization or call verify first. 
+      # this method you need to supply unique_id during initialization or call verify first.
       #
       def completed?
-        query["noOfTotalEntries"] == query["noOfCompletedEntries"]
+        query_progress = query["progress"]
+        query_progress["noOfTotalEntries"] == query_progress["noOfCompletedEntries"]
       end
-      
+
       def error
         @error
       end
-      
-      private 
+
+      private
         def compute_error(e)
-          case e.response.code
+          unless e.is_a? RestClient::Exception
+            @error = :internal_server_error
+          end
+
+          case e.http_code
             when 400
               @error = :bad_request
             when 401
@@ -111,6 +115,16 @@ module Verifalia
               @error = :internal_server_error
             end
         end
+
+        def build_resource(config, account_sid, account_token)
+          api_url = "#{config[:host]}/#{config[:api_version]}/email-validations"
+          opts = {
+            user: account_sid, 
+            password: account_token, 
+            headers: { content_type: :json }
+          }
+          return RestClient::Resource.new api_url, opts
+        end
     end
   end
-end
+end

data/lib/verifalia/version.rb

@@ -1,3 +1,3 @@
 module Verifalia
-  VERSION = "1.0.1"
+  VERSION = "1.0.2"
 end

data/spec/rest/{email_validations.spec.rb → email_validations_spec.rb}

@@ -2,29 +2,36 @@ require 'spec_helper'
 
 describe Verifalia::REST::EmailValidations do
   let(:config) { { host: 'https://api.fake.com', api_version: "v" } }
-  
+
   describe '#initialize' do
-    
+
     it 'create RestClient::Resource with correct parameters' do
-      expect(RestClient::Resource).to receive(:new).with("#{config[:host]}/#{config[:api_version]}/email-validations", 'someSid', 'someToken')
+      api_url = "#{config[:host]}/#{config[:api_version]}/email-validations"
+      opts = {
+        user: 'someSid', 
+        password: 'someToken', 
+        headers: { content_type: :json }
+      }
+
+      expect(RestClient::Resource).to receive(:new).with(api_url, opts)
       Verifalia::REST::EmailValidations.new(config, 'someSid', 'someToken')
     end
-    
+
     it 'associate RestClient::Resource to @resource' do
       resource = double()
       allow(RestClient::Resource).to receive(:new).and_return(resource)
       email_validations = Verifalia::REST::EmailValidations.new(config, 'someSid', 'someToken')
       expect(email_validations.instance_variable_get('@resource')).to eq(resource)
     end
-    
+
     it 'associate :unique_id to @unique_id' do
       unique_id = double()
       email_validations = Verifalia::REST::EmailValidations.new(config, 'someSid', 'someToken', unique_id: unique_id)
       expect(email_validations.instance_variable_get('@unique_id')).to eq(unique_id)
     end
-    
+
   end
-  
+
   context 'initialized' do
     let(:resource) { double().as_null_object }
     let(:response) { double().as_null_object }
@@ -32,26 +39,26 @@ describe Verifalia::REST::EmailValidations do
       @email_validations = Verifalia::REST::EmailValidations.new(config, 'someSid', 'someToken')
       @email_validations.instance_variable_set('@resource', resource)
     end
-    
+
     describe '#verify' do
-      
+
       it 'raise ArgumentError with nil emails' do
         expect{ @email_validations.verify(nil) }.to raise_error(ArgumentError)
       end
-      
+
       it 'raise ArgumentError with empty emails' do
         expect{ @email_validations.verify([]) }.to raise_error(ArgumentError)
       end
-      
+
       it 'call #post on @resources with correct parameters' do
         emails = ['first', 'second']
         data = emails.map { |email| { inputData: email }}
         content = { entries: data }.to_json
-        expect(resource).to receive(:post).with(content, content_type: :json).and_return(response)
+        expect(resource).to receive(:post).with(content).and_return(response)
         expect(JSON).to receive(:parse).with(response).and_return(response)
         @email_validations.verify(emails)
       end
-      
+
       it 'associate @unique_id and clear @response and @error' do
         emails = ['first', 'second']
         unique_id = 'fake'
@@ -63,7 +70,7 @@ describe Verifalia::REST::EmailValidations do
         expect(@email_validations.instance_variable_get('@response')).to eq(nil)
         expect(@email_validations.instance_variable_get('@error')).to eq(nil)
       end
-      
+
       it 'return @unique_id' do
         emails = ['first', 'second']
         unique_id = 'fake'
@@ -73,38 +80,46 @@ describe Verifalia::REST::EmailValidations do
         result = @email_validations.verify(emails)
         expect(result).to eq(unique_id)
       end
-      
+
       context 'request failed' do
-        
+
         it 'raise exception, call #compute_error and return false' do
           emails = ['first', 'second']
           expect(resource).to receive(:post).and_raise(RestClient::Exception)
-          expect(@email_validations).to receive(:compute_error).and_return(double())
           result = @email_validations.verify(emails)
           expect(result).to eq(false)
+          expect(@email_validations.error).to eq(:internal_server_error)
+        end
+
+        it 'raise exception, call #compute_error and return correct error' do
+          emails = ['first', 'second']
+          exception = RestClient::Exception.new(nil, 402)
+          expect(resource).to receive(:post).and_raise(exception)
+          result = @email_validations.verify(emails)
+          expect(result).to eq(false)
+          expect(@email_validations.error).to eq(:payment_required)
         end
-        
       end
     end
-    
+
     describe '#query' do
       it 'raise ArgumentError without @unique_id' do
         expect{ @email_validations.query }.to raise_error(ArgumentError)
       end
-      
+
       context 'with @unique_id' do
         before(:each) do
           @email_validations.instance_variable_set('@unique_id', 'fake')
         end
-        
+
         it 'call #get on @resource[@uniqueId] with correct parameters' do
           request = double()
           expect(resource).to receive(:[]).with('fake').and_return(request)
-          expect(request).to receive(:get).with(content_type: :json).and_return(double().as_null_object)
+          expect(request).to receive(:get).and_return(double().as_null_object)
           expect(JSON).to receive(:parse)
           @email_validations.query
         end
-        
+
         it 'return parsed json' do
           parsed = double()
           expect(resource).to receive(:[]).with('fake')
@@ -112,39 +127,58 @@ describe Verifalia::REST::EmailValidations do
           result = @email_validations.query
           expect(result).to eq(parsed)
         end
-        
+
         context 'request failed' do
-        
+
           it 'raise exception, call #compute_error and return false' do
             request = double()
             expect(resource).to receive(:[]).with('fake').and_return(request)
-            expect(request).to receive(:get).with(content_type: :json).and_raise(RestClient::Exception)
+            expect(request).to receive(:get).and_raise(RestClient::Exception)
             expect(@email_validations).to receive(:compute_error).and_return(double())
             result = @email_validations.query
             expect(result).to eq(false)
           end
         end
-        
+
+      end
+    end
+
+    describe '#completed?' do
+      let(:completed_query) do
+        { "progress"=> { "noOfTotalEntries" => 1, "noOfCompletedEntries" => 1 } }
+      end
+      let(:incompleted_query) do
+        { "progress"=> { "noOfTotalEntries" => 0, "noOfCompletedEntries" => 1 } }
+      end
+
+      it 'should return true if completed' do
+        expect(@email_validations).to receive(:query).and_return(completed_query)
+        expect(@email_validations.completed?).to be true
+      end
+
+      it 'should return false if not completed' do
+        expect(@email_validations).to receive(:query).and_return(incompleted_query)
+        expect(@email_validations.completed?).to be false
       end
     end
-    
+
     describe '#destroy' do
       it 'raise ArgumentError without @unique_id' do
         expect{ @email_validations.destroy }.to raise_error(ArgumentError)
       end
-      
+
       context 'with @unique_id' do
         before(:each) do
           @email_validations.instance_variable_set('@unique_id', 'fake')
         end
-        
+
         it 'call #delete on @resource[@uniqueId]' do
           request = double()
           expect(resource).to receive(:[]).with('fake').and_return(request)
           expect(request).to receive(:delete).and_return(double().as_null_object)
           @email_validations.destroy
         end
-        
+
         it 'clear @response, @unique_id and @error' do
           request = double()
           expect(resource).to receive(:[]).with('fake').and_return(request)
@@ -157,5 +191,5 @@ describe Verifalia::REST::EmailValidations do
       end
     end
   end
-  
-end
+
+end

data/spec/spec_helper.rb

@@ -3,12 +3,19 @@ $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 require 'bundler'
 Bundler.setup
 
-Dir.glob(File.expand_path("../support/**/*.rb", __FILE__), &method(:require))
-
 require 'verifalia'
 
 RSpec.configure do |config|
   config.expect_with :rspec do |c|
     c.syntax = :expect
   end
-end
+end
+
+if ENV["CI"]
+  require 'coveralls'
+  Coveralls.wear!
+else
+  require "simplecov"
+  SimpleCov.start
+end
+

data/verifalia.gemspec

@@ -18,14 +18,12 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.extra_rdoc_files = ['README.md', 'LICENSE']
+  spec.extra_rdoc_files = ['README.md']
   spec.rdoc_options = ['--line-numbers', '--inline-source', '--title', '--main', 'README.md']
 
   spec.add_dependency('builder', '>= 2.1.2')
-  spec.add_dependency('rest-client', '~> 1.8.0')
+  spec.add_dependency('rest-client', '> 1.8.0')
 
   spec.add_development_dependency "bundler", "~> 1.6"
   spec.add_development_dependency "rake"
-
-
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: verifalia
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Verifalia
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-07 00:00:00.000000000 Z
+date: 2017-07-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: builder
@@ -28,14 +28,14 @@ dependencies:
   name: rest-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
       - !ruby/object:Gem::Version
         version: 1.8.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
       - !ruby/object:Gem::Version
         version: 1.8.0
 - !ruby/object:Gem::Dependency
@@ -74,7 +74,6 @@ executables: []
 extensions: []
 extra_rdoc_files:
 - README.md
-- LICENSE
 files:
 - ".gitignore"
 - Gemfile
@@ -87,7 +86,7 @@ files:
 - lib/verifalia/util/configuration.rb
 - lib/verifalia/version.rb
 - spec/rest/client_spec.rb
-- spec/rest/email_validations.spec.rb
+- spec/rest/email_validations_spec.rb
 - spec/spec_helper.rb
 - spec/util/configuration_spec.rb
 - spec/verifalia_spec.rb
@@ -117,13 +116,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Verifalia API wrapper (email validation, list cleaning and scrubbing)
 test_files:
 - spec/rest/client_spec.rb
-- spec/rest/email_validations.spec.rb
+- spec/rest/email_validations_spec.rb
 - spec/spec_helper.rb
 - spec/util/configuration_spec.rb
 - spec/verifalia_spec.rb