addressfinder 1.9.1 → 1.10.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 38a7d7f3a73582add0efdff05e575601015d7530e87a475b720c14f150455b97
-  data.tar.gz: 0230c13f16b6a48eecb940baf8a344d64fc832d9bc508649c4ff215675c4b2ae
+  metadata.gz: 85227fdfa94c38218cb23aa0f2d637270f5fba6f1e3101c1303404de467e4c72
+  data.tar.gz: 44987ff360e797b67691494785388fcdd51c12f08cbc925eb445ac3251a20102
 SHA512:
-  metadata.gz: edcb4c8d68f2162090406e40dd9d624f73dff86ed3ebff5dad7d1937715df402ed0a2d568165feb286ba1b703dea73f112f0f1a27604bb90a1aad24477534062
-  data.tar.gz: ead725e66314a35081276a6f5e2d37c23a709f99af3920aad208a76da711cc45d83e9d067493079b25251db81795ccff98a4ff3a4d05f5f8017346c34aee4b47
+  metadata.gz: 132e29b1da5bad8864aa136edfbb37cae2925610a767465cd3c027b70ec61492b9c55ed884e628b85fa87191d86c128153ba5f7476c8728ac09e866e131d7fc9
+  data.tar.gz: 6b64c5fd1de404b594e3e077b62bb3104e0aa9cf17e2f50a6ae2c688e449ce5dfd7cf214f677d8add6e32477d4dc562ab8cbc2a49031b9b37310aa3bdf1acfaf

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+# AddressFinder 1.10.0 (August 2023) #
+
+* Add support for Email Verification
+* Add support for Phone Verification
+* Add support for Bulk Email Verification
+* Add support for Bulk Phone Verification
+
 # AddressFinder 1.9.1 (October 2022) #
 
 * Add missing kwarg `**` for ruby 3

data/README.md

@@ -157,6 +157,28 @@ rescue AddressFinder::RequestRejectedError => e
 end
 ```
 
+#### Email Verification
+```ruby
+begin
+  result = AddressFinder.email_verification(email: 'john.doe')
+  $stdout.puts "This email address is verified: #{result.is_verified}"
+rescue AddressFinder::RequestRejectedError => e
+  response = JSON.parse(e.body)
+  $stdout.puts response['message']
+end
+```
+
+#### Phone Verification
+```ruby
+begin
+  result = AddressFinder.phone_verification(phone_number: '1800 152 363', default_country_code: 'AU')
+  $stdout.puts "This phone number is verified: #{result.is_verified}"
+rescue AddressFinder::RequestRejectedError => e
+  response = JSON.parse(e.body)
+  $stdout.puts response['message']
+end
+```
+
 ## Advanced Usage
 
 #### Bulk Operations
@@ -164,7 +186,7 @@ end
 If you have a series of API requests, you can use the
 bulk method to re-use the HTTP connection.
 
-**Note:** The bulk method is currently only available for Address Verification (`#verification`).
+**Note:** The bulk method is currently only available for Address Verification, Email Verification and Phone Verification (`#verification`, `#email_verification`, `#phone_verifiction`).
 
 ```ruby
 AddressFinder.bulk do |af|

data/addressfinder.gemspec

@@ -11,13 +11,14 @@ Gem::Specification.new do |gem|
   gem.summary       = 'Provides easy access to AddressFinder APIs'
   gem.homepage      = 'https://github.com/AddressFinder/addressfinder-ruby'
 
-  gem.files         = `git ls-files`.split($/)
+  gem.files         = `git ls-files`.split($/).select{|f| f.match(%r{^lib|\.gemspec$|\.md$})}
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
   gem.test_files    = gem.files.grep(%r{^(spec|features)/})
   gem.require_paths = ['lib']
 
-  gem.required_ruby_version = '>= 2.1'
+  gem.required_ruby_version = '>= 2.6'
   gem.add_dependency 'multi_json', '~> 1.15'
+
   gem.add_development_dependency 'guard-rspec', '~> 4.7'
   gem.add_development_dependency 'listen', '~> 3.7'
   gem.add_development_dependency 'rake', '~> 13.0'

data/lib/addressfinder/bulk.rb

@@ -36,6 +36,14 @@ module AddressFinder
         end
       end
 
+      def email_verification(args={})
+        AddressFinder::V1::Email::Verification.new(**args.merge(http: http)).perform.result
+      end
+
+      def phone_verification(args={})
+        AddressFinder::V1::Phone::Verification.new(**args.merge(http: http)).perform.result
+      end
+
       private
 
       attr_reader :http, :verification_version, :default_country

data/lib/addressfinder/v1/base.rb

@@ -0,0 +1,71 @@
+require 'ostruct'
+
+module AddressFinder
+  module V1
+    class Base
+      attr_reader :result
+
+      def initialize(params:, path:, http:)
+        @params = params
+        @params[:domain] ||= config.domain if config.domain
+        @params[:key] ||= config.api_key
+        @params[:secret] ||= config.api_secret
+        @params[:format] ||= 'json'
+
+        @path = path
+        @http = http
+      end
+
+      def perform
+        build_request
+        execute_request
+        build_result
+  
+        self
+      end
+
+      private
+  
+      attr_reader :request_uri, :params, :http, :path
+      attr_accessor :response_body, :response_status
+      attr_writer :result
+
+      def build_request
+        @request_uri = "#{path}?#{encoded_params}"
+      end
+  
+      def encoded_params
+        Util.encode_and_join_params(params)
+      end
+  
+      def execute_request
+        request = Net::HTTP::Get.new(request_uri)
+  
+        response = http.request(request)
+  
+        self.response_body = response.body
+        self.response_status = response.code
+      end
+  
+      def build_result
+        case response_status
+        when '200'
+          self.result = Result.new(response_hash)
+        else
+          raise AddressFinder::RequestRejectedError.new(response_status, response_body)
+        end
+      end
+  
+      def response_hash
+        @_response_hash ||= MultiJson.load(response_body)
+      end
+  
+      def config
+        @_config ||= AddressFinder.configuration
+      end
+  
+      class Result < OpenStruct
+      end
+    end
+  end
+end

data/lib/addressfinder/v1/email/verification.rb

@@ -0,0 +1,16 @@
+require 'addressfinder/v1/base'
+
+module AddressFinder
+  module V1
+    module Email
+      class Verification < AddressFinder::V1::Base
+        attr_reader :result
+    
+        def initialize(email:, http:, **args)
+          params = {email: email}.merge(args)
+          super(params: params, path: "/api/email/v1/verification", http: http)
+        end
+      end
+    end
+  end
+end

data/lib/addressfinder/v1/phone/verification.rb

@@ -0,0 +1,16 @@
+require 'addressfinder/v1/base'
+
+module AddressFinder
+  module V1
+    module Phone
+      class Verification < AddressFinder::V1::Base
+        attr_reader :result
+    
+        def initialize(phone_number:, default_country_code:, http:, **args)
+          params = {phone_number: phone_number, default_country_code: default_country_code}.merge(args)
+          super(params: params, path: "/api/phone/v1/verification", http: http)
+        end
+      end
+    end
+  end
+end

data/lib/addressfinder/version.rb

@@ -1,3 +1,3 @@
 module AddressFinder
-  VERSION = '1.9.1'
+  VERSION = '1.10.1'
 end

data/lib/addressfinder.rb

@@ -9,6 +9,8 @@ require 'addressfinder/address_info'
 require 'addressfinder/address_search'
 require 'addressfinder/address_autocomplete'
 require 'addressfinder/bulk'
+require 'addressfinder/v1/email/verification'
+require 'addressfinder/v1/phone/verification'
 require 'addressfinder/errors'
 require 'addressfinder/util'
 require 'addressfinder/http'
@@ -61,6 +63,14 @@ module AddressFinder
       AddressFinder::AddressInfo.new(params: args, http: AddressFinder::HTTP.new(configuration)).perform.result
     end
 
+    def email_verification(args={})
+      AddressFinder::V1::Email::Verification.new(**args.merge(http: AddressFinder::HTTP.new(configuration))).perform.result
+    end
+
+    def phone_verification(args={})
+      AddressFinder::V1::Phone::Verification.new(**args.merge(http: AddressFinder::HTTP.new(configuration))).perform.result
+    end
+
     def bulk(&block)
       AddressFinder::Bulk.new(http: AddressFinder::HTTP.new(configuration), verification_version: configuration.verification_version, default_country: configuration.default_country, &block).perform
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: addressfinder
 version: !ruby/object:Gem::Version
-  version: 1.9.1
+  version: 1.10.1
 platform: ruby
 authors:
 - Nigel Ramsay
@@ -12,7 +12,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-10-12 00:00:00.000000000 Z
+date: 2023-09-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -109,17 +109,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".travis.yml"
 - CHANGELOG.md
-- Dockerfile
-- Gemfile
-- Guardfile
 - LICENSE.md
 - README.md
-- Rakefile
 - addressfinder.gemspec
-- docker-compose.yml
 - lib/addressfinder.rb
 - lib/addressfinder/address_autocomplete.rb
 - lib/addressfinder/address_info.rb
@@ -131,20 +124,12 @@ files:
 - lib/addressfinder/location_info.rb
 - lib/addressfinder/location_search.rb
 - lib/addressfinder/util.rb
+- lib/addressfinder/v1/base.rb
+- lib/addressfinder/v1/email/verification.rb
+- lib/addressfinder/v1/phone/verification.rb
 - lib/addressfinder/v2/au/verification.rb
 - lib/addressfinder/verification.rb
 - lib/addressfinder/version.rb
-- spec/lib/addressfinder/address_autocomplete_spec.rb
-- spec/lib/addressfinder/address_info_spec.rb
-- spec/lib/addressfinder/address_search_spec.rb
-- spec/lib/addressfinder/bulk_spec.rb
-- spec/lib/addressfinder/location_info_spec.rb
-- spec/lib/addressfinder/location_search_spec.rb
-- spec/lib/addressfinder/util_spec.rb
-- spec/lib/addressfinder/v2/au/verification_spec.rb
-- spec/lib/addressfinder/verification_spec.rb
-- spec/lib/addressfinder_spec.rb
-- spec/spec_helper.rb
 homepage: https://github.com/AddressFinder/addressfinder-ruby
 licenses:
 - MIT
@@ -157,26 +142,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.1'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.2.33
 signing_key:
 specification_version: 4
 summary: Provides easy access to AddressFinder APIs
-test_files:
-- spec/lib/addressfinder/address_autocomplete_spec.rb
-- spec/lib/addressfinder/address_info_spec.rb
-- spec/lib/addressfinder/address_search_spec.rb
-- spec/lib/addressfinder/bulk_spec.rb
-- spec/lib/addressfinder/location_info_spec.rb
-- spec/lib/addressfinder/location_search_spec.rb
-- spec/lib/addressfinder/util_spec.rb
-- spec/lib/addressfinder/v2/au/verification_spec.rb
-- spec/lib/addressfinder/verification_spec.rb
-- spec/lib/addressfinder_spec.rb
-- spec/spec_helper.rb
+test_files: []

data/.gitignore

@@ -1,11 +0,0 @@
-*.gem
-*.rbc
-/.config
-/coverage/
-/spec/reports/
-
-# for a library or gem, you might want to ignore these files since the code is
-# intended to run in multiple environments; otherwise, check them in:
-Gemfile.lock
-.ruby-version
-.ruby-gemset

data/.travis.yml

@@ -1,6 +0,0 @@
-language: ruby
-rvm:
-  - 2.2.7
-  - 2.3.1
-  - 2.4.1
-  - 2.6.3

data/Dockerfile

@@ -1,28 +0,0 @@
-# Use the barebones version of Ruby 2.7.x
-FROM ruby:2.7
-
-# Install dependencies:
-# - build-essential: To ensure certain gems can be compiled
-# - nodejs: Compile assets
-# - bundler: ensure most recent version is installed
-RUN apt-get update && apt-get install -qq -y build-essential --fix-missing --no-install-recommends
-RUN gem install bundler
-
-# Set an environment variable to store where the app is installed to inside
-# of the Docker image.
-ENV LANG C.UTF-8
-ENV BUNDLE_PATH /bundle
-ENV INSTALL_PATH /addressfinder-ruby
-RUN mkdir -p $INSTALL_PATH
-
-# Create address verification directories
-RUN mkdir -p $INSTALL_PATH/verification/originals
-RUN mkdir -p $INSTALL_PATH/verification/verified
-
-# This sets the context of where commands will be ran in and is documented
-# on Docker's website extensively.
-WORKDIR $INSTALL_PATH
-
-ADD . $INSTALL_PATH
-
-RUN bundle install

data/Gemfile

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

data/Guardfile

@@ -1,5 +0,0 @@
-guard :rspec, cmd: 'bundle exec rspec' do
-  watch(%r{^spec/.+_spec\.rb$})
-  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
-  watch('spec/spec_helper.rb')  { "spec" }
-end

data/Rakefile

@@ -1,7 +0,0 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
-
-RSpec::Core::RakeTask.new
-
-task :default => :spec
-task :test => :spec

data/docker-compose.yml

@@ -1,11 +0,0 @@
-version: '3'
-services:
-  ruby:
-    build: .
-    volumes:
-      - .:/addressfinder-ruby
-      - bundle-cache:/bundle
-    command: bundle exec rspec
-
-volumes:
-  bundle-cache: {}

data/spec/lib/addressfinder/address_autocomplete_spec.rb

@@ -1,95 +0,0 @@
-require 'spec_helper'
-
-RSpec.describe AddressFinder::AddressAutocomplete do
-  before do
-    AddressFinder.configure do |af|
-      af.api_key = 'XXX'
-      af.api_secret = 'YYY'
-      af.default_country = 'au'
-    end
-  end
-
-  describe '#build_request' do
-    let(:locator){ AddressFinder::AddressAutocomplete.new(params: args, http: http) }
-    let(:http){ AddressFinder::HTTP.new(AddressFinder.configuration) }
-
-    subject(:request_uri){ locator.send(:build_request) }
-
-    context 'with minimal arguments' do
-      let(:args){ {q: '186 willis'} }
-
-      it { expect(request_uri).to eq('/api/au/address/autocomplete.json?q=186+willis&key=XXX&secret=YYY') }
-    end
-
-    context 'with more arguments' do
-      let(:args){ {q: '186 willis st', au_paf: 1, max: 10} }
-
-      it { expect(request_uri).to eq('/api/au/address/autocomplete.json?q=186+willis+st&au_paf=1&max=10&key=XXX&secret=YYY') }
-    end
-
-    context 'with a country override' do
-      let(:args){ {q: '186 willis st', country: 'au'} }
-
-      it { expect(request_uri).to eq('/api/au/address/autocomplete.json?q=186+willis+st&key=XXX&secret=YYY') }
-    end
-
-    context 'with a key override' do
-      let(:args){ {q: '186 willis st', key: 'AAA'} }
-
-      it { expect(request_uri).to eq('/api/au/address/autocomplete.json?q=186+willis+st&key=AAA&secret=YYY') }
-    end
-
-    context 'with a secret override' do
-      let(:args){ {q: '186 willis st', secret: 'BBB'} }
-
-      it { expect(request_uri).to eq('/api/au/address/autocomplete.json?q=186+willis+st&secret=BBB&key=XXX') }
-    end
-  end
-
-  describe '#validate_params' do
-    let(:locator){ AddressFinder::AddressAutocomplete.new(params: args, http: http) }
-    let(:http){ AddressFinder::HTTP.new(AddressFinder.configuration) }
-
-    subject(:validate_params){ locator.send(:validate_params) }
-
-    context 'with wrong country' do
-      let(:args){ {q: '186 willis st', country: 'nz'} }
-
-      it { expect{validate_params}.to raise_error(AddressFinder::RequestRejectedError) }
-    end
-
-    context 'with correct country' do
-      let(:args){ {q: '186 willis st', country: 'au'} }
-
-      it { expect{validate_params}.not_to raise_error }
-    end
-  end
-
-  describe '#build_result' do
-    let(:locator){ AddressFinder::AddressSearch.new(params: {q: 'ignored'}, http: nil) }
-
-    before do
-      locator.send('response_body=', body)
-      locator.send('response_status=', status)
-      locator.send(:build_result)
-    end
-
-    subject(:results){ locator.results }
-
-    context 'with completions' do
-      let(:body){ '{"completions":[{"a":"184 William Jones Drive, Otangarei, Whangarei 0112","pxid":"2-.9.2U.F.F.2I","v":1},{"a":"184 Williams Street, Kaiapoi 7630","pxid":"2-.3.1q.2.4G.4c","v":0},{"a":"184 Willis Street, Te Aro, Wellington 6011","pxid":"2-.F.1W.p.1D.1W","v":0}],"paid":true}' }
-      let(:status){ '200' }
-
-      it { expect(results.size).to eq(3) }
-      it { expect(results.first.class).to eq(AddressFinder::AddressSearch::Result) }
-      it { expect(results.first.a).to eq("184 William Jones Drive, Otangarei, Whangarei 0112") }
-    end
-
-    context 'with no completions' do
-      let(:body){ '{"completions":[],"paid":true}' }
-      let(:status){ '200' }
-
-      it { expect(results).to eq([]) }
-    end
-  end
-end

data/spec/lib/addressfinder/address_info_spec.rb

@@ -1,62 +0,0 @@
-require 'spec_helper'
-
-RSpec.describe AddressFinder::AddressInfo do
-  before do
-    AddressFinder.configure do |af|
-      af.api_key = 'XXX'
-      af.api_secret = 'YYY'
-      af.default_country = 'au'
-    end
-  end
-
-  describe '#build_request' do
-    let(:locator){ AddressFinder::AddressInfo.new(params: args, http: http) }
-    let(:http){ AddressFinder::HTTP.new(AddressFinder.configuration) }
-
-    subject(:request_uri){ locator.send(:build_request) }
-
-    context 'with a simple PXID' do
-      let(:args){ {pxid: '123'} }
-
-      it { expect(request_uri).to eq('/api/au/address/info.json?pxid=123&key=XXX&secret=YYY') }
-    end
-
-    context 'with a country override' do
-      let(:args){ {pxid: '123', country: 'nz'} }
-
-      it { expect(request_uri).to eq('/api/nz/address/info.json?pxid=123&key=XXX&secret=YYY') }
-    end
-
-    context 'with a key override' do
-      let(:args){ {pxid: '123', key:'AAA'} }
-
-      it { expect(request_uri).to eq('/api/au/address/info.json?pxid=123&key=AAA&secret=YYY') }
-    end
-
-    context 'with a secret override' do
-      let(:args){ {pxid: '123', secret: 'BBB'} }
-
-      it { expect(request_uri).to eq('/api/au/address/info.json?pxid=123&secret=BBB&key=XXX') }
-    end
-  end
-
-  describe '#build_result' do
-    let(:locator){ AddressFinder::AddressInfo.new(params: {q: 'ignored'}, http: nil) }
-
-    before do
-      locator.send('response_body=', body)
-      locator.send('response_status=', status)
-    end
-
-    subject(:result){ locator.send(:build_result) }
-
-    context 'with a successful result' do
-      let(:body){ '{"pxid":"2-.9.2U.F.F.2I","number":"184","container_only":"false","x":"174.314855382547","y":"-35.6946659390092","postcode":"0112","a":"184 William Jones Drive, Otangarei, Whangarei 0112","postal":"184 William Jones Drive, Otangarei, Whangarei 0112","mailtown":"Whangarei","post_suburb":"Otangarei","ta":"Whangarei District","sufi":932755,"street_type":"drive","city":"Whangarei","suburb":"Otangarei","region":"Northland Region","street":"William Jones Drive","postal_line_1":"184 William Jones Drive","postal_line_2":"Otangarei","postal_line_3":"Whangarei 0112","meshblock":"93700","dpid":"681856"}' }
-      let(:status){ '200' }
-
-      it { expect(result.class).to eq(AddressFinder::AddressInfo::Result) }
-      it { expect(result.a).to eq("184 William Jones Drive, Otangarei, Whangarei 0112") }
-      it { expect(result.pxid).to eq("2-.9.2U.F.F.2I") }
-    end
-  end
-end

data/spec/lib/addressfinder/address_search_spec.rb

@@ -1,76 +0,0 @@
-require 'spec_helper'
-
-RSpec.describe AddressFinder::AddressSearch do
-  before do
-    AddressFinder.configure do |af|
-      af.api_key = 'XXX'
-      af.api_secret = 'YYY'
-      af.default_country = 'nz'
-    end
-  end
-
-  describe '#build_request' do
-    let(:locator){ AddressFinder::AddressSearch.new(params: args, http: http) }
-    let(:http){ AddressFinder::HTTP.new(AddressFinder.configuration) }
-
-    subject(:request_uri){ locator.send(:build_request) }
-
-    context 'with minimal arguments' do
-      let(:args){ {q: '186 willis'} }
-
-      it { expect(request_uri).to eq('/api/nz/address.json?q=186+willis&key=XXX&secret=YYY') }
-    end
-
-    context 'with more arguments' do
-      let(:args){ {q: '186 willis st', delivered: 1, max: 10} }
-
-      it { expect(request_uri).to eq('/api/nz/address.json?q=186+willis+st&delivered=1&max=10&key=XXX&secret=YYY') }
-    end
-
-    context 'with a country override' do
-      let(:args){ {q: '186 willis st', country: 'au'} }
-
-      it { expect(request_uri).to eq('/api/au/address.json?q=186+willis+st&key=XXX&secret=YYY') }
-    end
-
-    context 'with a key override' do
-      let(:args){ {q: '186 willis st', key: 'AAA'} }
-
-      it { expect(request_uri).to eq('/api/nz/address.json?q=186+willis+st&key=AAA&secret=YYY') }
-    end
-
-    context 'with a secret override' do
-      let(:args){ {q: '186 willis st', secret: 'BBB'} }
-
-      it { expect(request_uri).to eq('/api/nz/address.json?q=186+willis+st&secret=BBB&key=XXX') }
-    end
-  end
-
-  describe '#build_result' do
-    let(:locator){ AddressFinder::AddressSearch.new(params: {q: 'ignored'}, http: nil) }
-
-    before do
-      locator.send('response_body=', body)
-      locator.send('response_status=', status)
-      locator.send(:build_result)
-    end
-
-    subject(:results){ locator.results }
-
-    context 'with completions' do
-      let(:body){ '{"completions":[{"a":"184 William Jones Drive, Otangarei, Whangarei 0112","pxid":"2-.9.2U.F.F.2I","v":1},{"a":"184 Williams Street, Kaiapoi 7630","pxid":"2-.3.1q.2.4G.4c","v":0},{"a":"184 Willis Street, Te Aro, Wellington 6011","pxid":"2-.F.1W.p.1D.1W","v":0}],"paid":true}' }
-      let(:status){ '200' }
-
-      it { expect(results.size).to eq(3) }
-      it { expect(results.first.class).to eq(AddressFinder::AddressSearch::Result) }
-      it { expect(results.first.a).to eq("184 William Jones Drive, Otangarei, Whangarei 0112") }
-    end
-
-    context 'with no completions' do
-      let(:body){ '{"completions":[],"paid":true}' }
-      let(:status){ '200' }
-
-      it { expect(results).to eq([]) }
-    end
-  end
-end