xhash_client 0.3.0 → 0.3.5

data/spec/xhash/ocr_spec.rb

@@ -0,0 +1,395 @@
+require 'spec_helper'
+
+describe Xhash::OCR do
+  describe '.generic' do
+    it 'successfully serialize INE to document by url' do
+      stub_request(:post, 'https://xhash.dev/api/ocr').to_return(
+        body:
+          JSON.dump(
+            {
+              result: true,
+              execution_time: 2.7695868015289307,
+              payload: {
+                name: 'MARGARITA',
+                last_name: 'GOMEZ',
+                mothers_last_name: 'VELAZQUEZ',
+                expiration_date: '2024-12-31',
+                street: 'C',
+                neighborhood: 'NACIO PITAGORAS 1253',
+                zip_code: 'INT 4',
+                city: 'COL. MORELOS 04800',
+                type: 'INE',
+                control: "2"
+              }
+            }
+          ),
+        status: 200
+      )
+
+      ine =
+        Xhash::OCR.generic(
+          document_url:
+            'https://kyc-xhash.s3-us-west-2.amazonaws.com/documents/7cd6994d9ad52e8943be1ae00bac60c461430cdf2af6159afa4b9be749706472.png'
+        )
+
+      expect(ine).to be_a(Xhash::Identification)
+      expect(ine.name).to eq('MARGARITA')
+      expect(ine.last_name).to eq('GOMEZ')
+      expect(ine.mothers_last_name).to eq('VELAZQUEZ')
+      expect(ine.expiration_date).to eq('2024-12-31')
+      expect(ine.street).to eq('C')
+      expect(ine.neighborhood).to eq('NACIO PITAGORAS 1253')
+      expect(ine.zip_code).to eq('INT 4')
+      expect(ine.city).to eq('COL. MORELOS 04800')
+      expect(ine.type).to eq('INE')
+    end
+
+    it 'successfully serialize INE to document by file' do
+      stub_request(:post, 'https://xhash.dev/api/ocr').to_return(
+        body:
+          JSON.dump(
+            {
+              result: true,
+              execution_time: 2.7695868015289307,
+              payload: {
+                name: 'MARGARITA',
+                last_name: 'GOMEZ',
+                mothers_last_name: 'VELAZQUEZ',
+                expiration_date: '2024-12-31',
+                street: 'C',
+                neighborhood: 'NACIO PITAGORAS 1253',
+                zip_code: 'INT 4',
+                city: 'COL. MORELOS 04800',
+                type: 'INE',
+                control: "2"
+              }
+            }
+          ),
+        status: 200
+      )
+
+      document = File.open('spec/files/ife_front.png')
+
+      ine = Xhash::OCR.generic(document_file: document)
+
+      document.close
+
+      expect(ine).to be_a(Xhash::Identification)
+      expect(ine.name).to eq('MARGARITA')
+      expect(ine.last_name).to eq('GOMEZ')
+      expect(ine.mothers_last_name).to eq('VELAZQUEZ')
+      expect(ine.expiration_date).to eq('2024-12-31')
+      expect(ine.street).to eq('C')
+      expect(ine.neighborhood).to eq('NACIO PITAGORAS 1253')
+      expect(ine.zip_code).to eq('INT 4')
+      expect(ine.city).to eq('COL. MORELOS 04800')
+      expect(ine.type).to eq('INE')
+    end
+
+    it 'successfully serialize proof of address to document by url' do
+      stub_request(:post, 'https://xhash.dev/api/ocr').to_return(
+        body:
+          JSON.dump(
+            {
+              payload: {
+                full_name: 'Prof Francesco Reichert',
+                neighborhood: 'Parkerchester',
+                full_address:
+                  'CLL 59 E DIAGONAL 623\n76 Y 74 A Y RED CANALIZA\nLAS AMERICAS\nMERIDA, MERIDA YU\nC.P. 97302-CR -97111',
+                zip_code: '97302',
+                province: 'Port Rosemarieview,VT',
+                date: '2019-09-01',
+                type: 'TELMEX'
+              }
+            }
+          ),
+        status: 200
+      )
+
+      proof_of_address =
+        Xhash::OCR.generic(
+          document_url:
+            'https://kyc-xhash.s3-us-west-2.amazonaws.com/documents/c7d40899ab9ed7aa689837e39b64a6eb07117353f88ce3f8b9d1ca73bea3d80e.png'
+        )
+
+      expect(proof_of_address).to be_a(Xhash::ProofOfAddress)
+      expect(proof_of_address.full_name).to eq('Prof Francesco Reichert')
+      expect(proof_of_address.neighborhood).to eq('Parkerchester')
+      expect(proof_of_address.province).to eq('Port Rosemarieview,VT')
+      expect(proof_of_address.type).to eq('TELMEX')
+      expect(proof_of_address.date).to eq('2019-09-01')
+      expect(proof_of_address.zip_code).to eq('97302')
+      expect(proof_of_address.full_address).to eq(
+        'CLL 59 E DIAGONAL 623\n76 Y 74 A Y RED CANALIZA\nLAS AMERICAS\nMERIDA, MERIDA YU\nC.P. 97302-CR -97111'
+      )
+    end
+
+    it 'successfully serialize proof of address to document by file' do
+      stub_request(:post, 'https://xhash.dev/api/ocr').to_return(
+        body:
+          JSON.dump(
+            {
+              payload: {
+                full_name: 'Prof Francesco Reichert',
+                neighborhood: 'Parkerchester',
+                province: 'Port Rosemarieview,VT',
+                type: 'TELMEX'
+              }
+            }
+          ),
+        status: 200
+      )
+
+      document = File.open('spec/files/telmex.png')
+
+      proof_of_address = Xhash::OCR.generic(document_file: document)
+
+      document.close
+
+      expect(proof_of_address).to be_a(Xhash::ProofOfAddress)
+      expect(proof_of_address.full_name).to eq('Prof Francesco Reichert')
+      expect(proof_of_address.neighborhood).to eq('Parkerchester')
+      expect(proof_of_address.province).to eq('Port Rosemarieview,VT')
+      expect(proof_of_address.type).to eq('TELMEX')
+    end
+
+    it 'fails to serialize INE to document with html error' do
+      stub_request(:post, 'https://xhash.dev/api/ocr').to_return(
+        body: '<p>error</p>',
+        status: 200,
+        headers: { 'Content-Type' => 'text/html; charset=UTF-8' }
+      )
+
+      begin
+        ine =
+          Xhash::OCR.generic(
+            document_url:
+              'https://kyc-xhash.s3-us-west-2.amazonaws.com/documents/7cd6994d9ad52e8943be1ae00bac60c461430cdf2af6159afa4b9be749706472.png'
+          )
+      rescue => exception
+        expect(exception).to be_a(Xhash::MalformedResponse)
+      end
+    end
+
+    it 'fails with missing file or url' do
+      begin
+        ine = Xhash::OCR.generic
+      rescue => exception
+        expect(exception).to be_a(Xhash::MissingRequiredFieldError)
+        expect(exception.message).to eq(Xhash::ErrorMessage::MISSING_FILE)
+      end
+    end
+  end
+
+  describe '.identification' do
+    it 'successfully serialize INE to document' do
+      stub_request(:post, 'https://xhash.dev/api/ocr/identification').to_return(
+        body:
+          JSON.dump(
+            {
+              result: true,
+              execution_time: 2.7695868015289307,
+              payload: {
+                name: 'MARGARITA',
+                last_name: 'GOMEZ',
+                mothers_last_name: 'VELAZQUEZ',
+                expiration_date: '2024-12-31',
+                street: 'C',
+                neighborhood: 'NACIO PITAGORAS 1253',
+                zip_code: 'INT 4',
+                city: 'COL. MORELOS 04800',
+                type: 'INE',
+                control: "2"
+              }
+            }
+          ),
+        status: 200
+      )
+
+      ine_anverse =
+        Xhash::OCR.identification(
+          document_url:
+            'https://kyc-xhash.s3-us-west-2.amazonaws.com/documents/7cd6994d9ad52e8943be1ae00bac60c461430cdf2af6159afa4b9be749706472.png'
+        )
+
+      expect(ine_anverse).to be_a(Xhash::Identification)
+      expect(ine_anverse.name).to eq('MARGARITA')
+      expect(ine_anverse.last_name).to eq('GOMEZ')
+      expect(ine_anverse.mothers_last_name).to eq('VELAZQUEZ')
+      expect(ine_anverse.expiration_date).to eq('2024-12-31')
+      expect(ine_anverse.street).to eq('C')
+      expect(ine_anverse.neighborhood).to eq('NACIO PITAGORAS 1253')
+      expect(ine_anverse.zip_code).to eq('INT 4')
+      expect(ine_anverse.city).to eq('COL. MORELOS 04800')
+      expect(ine_anverse.type).to eq('INE')
+    end
+
+    it 'fails with missing file or url' do
+      begin
+        ine = Xhash::OCR.identification
+      rescue => exception
+        expect(exception).to be_a(Xhash::MissingRequiredFieldError)
+      end
+    end
+
+    it 'fails with invalid INE document' do
+      stub_request(:post, 'https://xhash.dev/api/ocr').to_return(
+        body: JSON.dump({ result: false, payload: nil }), status: 200
+      )
+
+      begin
+        ine =
+          Xhash::OCR.generic(
+            document_url:
+              'https://kyc-xhash.s3-us-west-2.amazonaws.com/documents/7cd6994d9ad52e8943be1ae00bac60c461430cdf2af6159afa4b9be749706472.png'
+          )
+      rescue => exception
+        expect(exception).to be_a(Xhash::InvalidFieldError)
+      end
+    end
+  end
+
+  describe '.proof_of_address' do
+    it 'successfully serialize proof of address to document' do
+      stub_request(:post, 'https://xhash.dev/api/ocr/proof-of-address')
+        .to_return(
+        body:
+          JSON.dump(
+            {
+              payload: {
+                full_name: 'Prof Francesco Reichert',
+                neighborhood: 'Parkerchester',
+                province: 'Port Rosemarieview,VT',
+                type: 'TELMEX'
+              }
+            }
+          ),
+        status: 200
+      )
+
+      proof_of_address =
+        Xhash::OCR.proof_of_address(
+          document_url:
+            'https://kyc-xhash.s3-us-west-2.amazonaws.com/documents/c7d40899ab9ed7aa689837e39b64a6eb07117353f88ce3f8b9d1ca73bea3d80e.png'
+        )
+
+      expect(proof_of_address).to be_a(Xhash::ProofOfAddress)
+      expect(proof_of_address.full_name).to eq('Prof Francesco Reichert')
+      expect(proof_of_address.neighborhood).to eq('Parkerchester')
+      expect(proof_of_address.province).to eq('Port Rosemarieview,VT')
+      expect(proof_of_address.type).to eq('TELMEX')
+    end
+
+    it 'fails with missing file or url' do
+      begin
+        proof_of_address = Xhash::OCR.proof_of_address
+      rescue => exception
+        expect(exception).to be_a(Xhash::MissingRequiredFieldError)
+      end
+    end
+
+    it 'fails with invalid proof of address document' do
+      stub_request(:post, 'https://xhash.dev/api/ocr/proof-of-address')
+        .to_return(
+        body: JSON.dump({ result: false, payload: nil }), status: 200
+      )
+
+      begin
+        ine =
+          Xhash::OCR.proof_of_address(
+            document_url:
+              'https://kyc-xhash.s3-us-west-2.amazonaws.com/documents/7cd6994d9ad52e8943be1ae00bac60c461430cdf2af6159afa4b9be749706472.png'
+          )
+      rescue => exception
+        expect(exception).to be_a(Xhash::InvalidFieldError)
+      end
+    end
+
+    it 'fails to serialize to document with html error' do
+      stub_request(:post, 'https://xhash.dev/api/ocr/proof-of-address').to_return(
+        body: '<p>error</p>',
+        status: 500,
+        headers: { 'Content-Type' => 'text/html; charset=UTF-8' }
+      )
+
+      begin
+        ine =
+          Xhash::OCR.proof_of_address(
+            document_url:
+              'https://kyc-xhash.s3-us-west-2.amazonaws.com/documents/7cd6994d9ad52e8943be1ae00bac60c461430cdf2af6159afa4b9be749706472.png'
+          )
+      rescue => exception
+        expect(exception).to be_a(Xhash::Error)
+      end
+    end
+  end
+
+  describe '.ine_reverse' do
+    it 'successfully serialize INE (reverse) to document' do
+      stub_request(:post, 'https://xhash.dev/api/ocr/ine-reverse').to_return(
+        body:
+          JSON.dump(
+            {
+              is_consistentent: false,
+              payload: {
+                lines: [
+                  'IDMEX1836577170<<0747116375842',
+                  '8007057M1812315MEX<02<<12345<7',
+                  'GOMEZ<VELAZzQUEZ<<MARGARITA<',
+                  ''
+                ],
+                cic: '183657717',
+                cic_digit_check: '0',
+                is_cic_digit_check_consistent: false,
+                section_and_consecutive: '0747116375842',
+                date: '800705',
+                date_check_digit: '7',
+                gender: 'M',
+                expiration_date: '181231',
+                expiration_date_digit: '5',
+                nationality: 'MEX',
+                emission_and_fuar: '02-12345',
+                name: 'MARGARITA ',
+                mothers_last_name: 'VELAZzQUEZ',
+                last_name: 'GOMEZ',
+                last_names: 'GOMEZ VELAZzQUEZ'
+              }
+            }
+          ),
+        status: 200
+      )
+
+      ine_reverse =
+        Xhash::OCR.ine_reverse(
+          document_url:
+            'https://kyc-xhash.s3-us-west-2.amazonaws.com/documents/b3f43a31929437c35b8fb22580119fe389d2e758bad8718387701ee8363caee7.jpg'
+        )
+
+      expect(ine_reverse).to be_a(Xhash::Identification)
+    end
+
+    it 'fails with missing file or url' do
+      begin
+        ine_reverse = Xhash::OCR.ine_reverse
+      rescue => exception
+        expect(exception).to be_a(Xhash::MissingRequiredFieldError)
+      end
+    end
+
+    it 'fails with invalid INE reverse document' do
+      stub_request(:post, 'https://xhash.dev/api/ocr/ine-reverse').to_return(
+        body: JSON.dump({ result: false, payload: nil }), status: 200
+      )
+
+      begin
+        ine =
+          Xhash::OCR.ine_reverse(
+            document_url:
+              'https://kyc-xhash.s3-us-west-2.amazonaws.com/documents/7cd6994d9ad52e8943be1ae00bac60c461430cdf2af6159afa4b9be749706472.png'
+          )
+      rescue => exception
+        expect(exception).to be_a(Xhash::InvalidFieldError)
+      end
+    end
+  end
+end

data/spec/xhash/sat_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+
+describe Xhash::SAT do
+  describe '.get_rfc' do
+    it 'successfully gets rfc by user data' do
+      stub_request(:post, 'https://xhash.dev/api/sat/get-rfc').to_return(
+        body:
+          JSON.dump(
+            {
+              name: 'Bernardo',
+              last_name: 'Suarez',
+              mothers_last_name: 'sepulveda',
+              birth_date: '1994-03-19',
+              rfc: 'SUSB940319BA5'
+            }
+          ),
+        status: 200
+      )
+
+      rfc =
+        Xhash::SAT.get_rfc(
+          name: 'Bernardo',
+          last_name: 'Suarez',
+          mothers_last_name: 'sepulveda',
+          birth_date: '1994-03-19'
+        )
+
+      expect(rfc).to be_a(Xhash::RFC)
+      expect(rfc.name).to eq('Bernardo')
+      expect(rfc.last_name).to eq('Suarez')
+      expect(rfc.mothers_last_name).to eq('sepulveda')
+      expect(rfc.birth_date).to eq('1994-03-19')
+      expect(rfc.rfc).to eq('SUSB940319BA5')
+    end
+  end
+end

data/spec/xhash_ruby_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe Xhash do
+  describe '.config' do
+    it 'sets the api key initializer style' do
+      Xhash.config { |c| c.api_key = 'abc' }
+
+      expect(Xhash.api_key).to eq('abc')
+    end
+  end
+end

data/xhash_client.gemspec

@@ -0,0 +1,27 @@
+$:.push File.expand_path("lib", __dir__)
+
+# Maintain your gem's version:
+require "xhash/version"
+
+# Describe your gem and declare its dependencies:
+Gem::Specification.new do |spec|
+  spec.name        = "xhash_client"
+  spec.version     = Xhash::VERSION
+  spec.date        = '2019-10-10'
+  spec.description = "Ruby Bindings for Xhash API"
+  spec.summary     = "Ruby library built for Xhash API"
+  spec.files       = `git ls-files`.split($/)
+  spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files  = `git ls-files -- {test,spec,features}/*`.split("\n")
+  spec.authors     = ["Yellowme"]
+  spec.email       = 'hola@yellowme.mx'
+  spec.homepage    = 'https://rubygems.org/gems/xhash-ruby'
+  spec.license      = 'MIT'
+
+  spec.add_dependency 'httparty', "~> 0.16.0"
+  spec.add_dependency "json", "~> 2.0"
+
+  spec.add_development_dependency "rspec", "~> 3.8"
+  spec.add_development_dependency "webmock", "~> 3.7"
+  spec.add_development_dependency "simplecov", "~> 0.17"
+end