xhash_client 0.3.1 → 0.3.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e41e823bbfa41b059071bc5a93fbb98502d941bfa147b96cf5c3495b114bc847
-  data.tar.gz: 1193d96715a223e5628c9b8677e5bfebd08208a9094658d34b60368e61cdc716
+  metadata.gz: 7a9138a8aa4d278ebdf067d812d06a9f87ef30390ee0f86a33fb07f49f140dd4
+  data.tar.gz: 4be4b3647acfa20a10b42ab3b9b0c6f0548825d2d5a2120916b8ddc000f62e3f
 SHA512:
-  metadata.gz: 2695f2a228913f1602a7ffa4b18176e23b1b15a61cece17c001e5d5ef1270cbd9681adb487f97f0ae7ca640316964aaeeb99020c8ce0b2674120fcef497d694a
-  data.tar.gz: be7111ccbf7ff8dba07d3881c18d31c1e0e7b25992ceec868073e40c09aa3966f811f8cce663f095bfee4b41fa6a46eb23e398acb7bd8da1ace27cd6e34af406
+  metadata.gz: e43d879d10faf34886641bc1e0ccd20387e92017c0818ad8b77306b403f71182ac8e0e46890ec2a04febb7625f58e49bf460b7df164f915dfeb0fff7c61df95f
+  data.tar.gz: 3d13a691f4e44acc2958837ce3094f388409504dd1fbaee8c8c2d38d98f8ad82f7b25a1ee9f7f57e7a2b1450080e3402169536adef82f8a9fee6eac49bd338e6

data/Gemfile.lock

@@ -1,22 +1,15 @@
 PATH
   remote: .
   specs:
-    xhash (0.3.0)
-      activesupport (~> 5.2)
+    xhash_client (0.3.5)
       httparty (~> 0.16.0)
       json (~> 2.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (5.2.4.1)
-      concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
     addressable (2.7.0)
       public_suffix (>= 2.0.2, < 5.0)
-    concurrent-ruby (1.1.5)
     crack (0.4.3)
       safe_yaml (~> 1.0.0)
     diff-lcs (1.3)
@@ -25,13 +18,10 @@ GEM
     httparty (0.16.4)
       mime-types (~> 3.0)
       multi_xml (>= 0.5.2)
-    i18n (1.7.0)
-      concurrent-ruby (~> 1.0)
     json (2.2.0)
     mime-types (3.3.1)
       mime-types-data (~> 3.2015)
-    mime-types-data (3.2019.1009)
-    minitest (5.13.0)
+    mime-types-data (3.2020.0512)
     multi_xml (0.6.0)
     public_suffix (4.0.1)
     rspec (3.8.0)
@@ -53,9 +43,6 @@ GEM
       json (>= 1.8, < 3)
       simplecov-html (~> 0.10.0)
     simplecov-html (0.10.2)
-    thread_safe (0.3.6)
-    tzinfo (1.2.6)
-      thread_safe (~> 0.1)
     webmock (3.7.2)
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
@@ -68,7 +55,7 @@ DEPENDENCIES
   rspec (~> 3.8)
   simplecov (~> 0.17)
   webmock (~> 3.7)
-  xhash!
+  xhash_client!
 
 BUNDLED WITH
    1.17.3

data/lib/xhash.rb

@@ -40,4 +40,12 @@ module Xhash
   def self.api_key=(api_key)
     @api_key = api_key
   end
+
+  def self.timeout
+    @timeout
+  end
+
+  def self.timeout=(timeout)
+    @timeout = timeout
+  end
 end

data/lib/xhash/client/api_client.rb

@@ -23,5 +23,13 @@ module Xhash
     def self.api_key=(api_key)
       @api_key = api_key
     end
+
+    def self.timeout
+      @timeout
+    end
+
+    def self.api_key=(timeout)
+      @timeout = timeout
+    end
   end
 end

data/lib/xhash/client/json_api.rb

@@ -11,9 +11,15 @@ module Xhash
 
       def api_get(url:, headers: {})
         custom_headers = headers.merge(default_headers)
-        response = HTTParty.get(Xhash.api_base + url, headers: custom_headers)
+        response = HTTParty.get(Xhash.api_base + url, headers: custom_headers, timeout: Xhash.timeout)
 
-        JSON.parse(response.body, symbolize_names: true)
+        raise Xhash::Error.new(response) unless response_ok?(response)
+
+        begin
+          JSON.parse(response.body, symbolize_names: true)
+        rescue => exception
+          raise Xhash::MalformedResponse.new
+        end
       end
 
       def api_post(url:, body: {}, headers: {})
@@ -22,10 +28,16 @@ module Xhash
         response =
           HTTParty.post(
             Xhash.api_base + url,
-            body: body.to_json, headers: custom_headers
+            body: body.to_json, headers: custom_headers, timeout: Xhash.timeout
           )
 
-        JSON.parse(response.body, symbolize_names: true)
+        raise Xhash::Error.new(response) unless response_ok?(response)
+
+        begin
+          JSON.parse(response.body, symbolize_names: true)
+        rescue => exception
+          raise Xhash::MalformedResponse.new
+        end
       end
 
       def api_post_multipart(url:, body: {}, headers: {})
@@ -34,11 +46,16 @@ module Xhash
         response =
           HTTParty.post(
             Xhash.api_base + url,
-            multipart: true, body: body, headers: custom_headers
+            multipart: true, body: body, headers: custom_headers, timeout: Xhash.timeout
           )
 
+        raise Xhash::Error.new(response) unless response_ok?(response)
         response.body
       end
+
+      def response_ok?(response)
+        !(response.code == 404 || response.code >= 500)
+      end
     end
 
     def self.included(base)

data/lib/xhash/error.rb

@@ -3,8 +3,14 @@ module Xhash
     attr_reader :message, :response
 
     def initialize(options = {})
-      @message = options[:message]
-      @response = options[:response]
+      if options.is_a? Hash
+        @message = options[:message]
+        @response = options[:response]
+      else
+        @message = "Server error"
+        @response = options
+      end
+
       super
     end
   end
@@ -12,4 +18,6 @@ module Xhash
   class MissingRequiredFieldError < Error; end
 
   class InvalidFieldError < Error; end
+
+  class MalformedResponse < Error; end
 end

data/lib/xhash/ocr.rb

@@ -96,7 +96,7 @@ module Xhash
     )
       body = {
         'document_url' => document_url, 'document_file' => document_file
-      }
+      }.compact
 
       response =
         if document_file.nil?

data/lib/xhash/structs/curp.rb

@@ -1,15 +1,16 @@
 module Xhash
   CURP =
     Struct.new(
+      :country_of_birth,
+      :created_at,
       :curp,
-      :name,
+      :day_of_birth,
+      :gender,
+      :id,
       :last_name,
       :mothers_last_name,
-      :gender,
+      :name,
       :province_of_birth,
-      :day_of_birth,
-      :updated_at,
-      :created_at,
-      :id
+      :updated_at
     )
 end

data/lib/xhash/version.rb

@@ -1,3 +1,3 @@
 module Xhash
-  VERSION = '0.3.1'
+  VERSION = '0.3.6'
 end

data/spec/spec_helper.rb

@@ -6,4 +6,7 @@ require 'xhash'
 
 SimpleCov.start { add_filter '/spec/' }
 
-RSpec.configure { |config| config.before(:all) { Xhash.api_key = 'api_key' } }
+RSpec.configure { |config| config.before(:all) {
+  Xhash.api_key = 'api_key'
+  Xhash.timeout = 10
+} }

data/spec/xhash/database_lookup_spec.rb

@@ -76,6 +76,19 @@ describe Xhash::SAT do
       end
     end
 
+    it 'fails with html error' do
+      curp = 'JIQJ890611HDFXNN04'
+
+      stub_request(:post, 'https://xhash.dev/api/database-lookup/renapo')
+        .to_return(body: '<p>bad</p>', status: 200)
+
+      begin
+        Xhash::DatabaseLookup.renapo(curp)
+      rescue => exception
+        expect(exception).to be_a(Xhash::MalformedResponse)
+      end
+    end
+
     it 'fails with malformed CURP' do
       curp = 'asdf'
 

data/spec/xhash/ocr_spec.rb

@@ -7,6 +7,8 @@ describe Xhash::OCR do
         body:
           JSON.dump(
             {
+              result: true,
+              execution_time: 2.7695868015289307,
               payload: {
                 name: 'MARGARITA',
                 last_name: 'GOMEZ',
@@ -16,7 +18,8 @@ describe Xhash::OCR do
                 neighborhood: 'NACIO PITAGORAS 1253',
                 zip_code: 'INT 4',
                 city: 'COL. MORELOS 04800',
-                type: 'INE'
+                type: 'INE',
+                control: "2"
               }
             }
           ),
@@ -46,6 +49,8 @@ describe Xhash::OCR do
         body:
           JSON.dump(
             {
+              result: true,
+              execution_time: 2.7695868015289307,
               payload: {
                 name: 'MARGARITA',
                 last_name: 'GOMEZ',
@@ -55,7 +60,8 @@ describe Xhash::OCR do
                 neighborhood: 'NACIO PITAGORAS 1253',
                 zip_code: 'INT 4',
                 city: 'COL. MORELOS 04800',
-                type: 'INE'
+                type: 'INE',
+                control: "2"
               }
             }
           ),
@@ -88,7 +94,8 @@ describe Xhash::OCR do
               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',
+                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',
@@ -112,7 +119,9 @@ describe Xhash::OCR do
       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')
+      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
@@ -158,7 +167,7 @@ describe Xhash::OCR do
               'https://kyc-xhash.s3-us-west-2.amazonaws.com/documents/7cd6994d9ad52e8943be1ae00bac60c461430cdf2af6159afa4b9be749706472.png'
           )
       rescue => exception
-        expect(exception).to be_a(JSON::ParserError)
+        expect(exception).to be_a(Xhash::MalformedResponse)
       end
     end
 
@@ -178,6 +187,8 @@ describe Xhash::OCR do
         body:
           JSON.dump(
             {
+              result: true,
+              execution_time: 2.7695868015289307,
               payload: {
                 name: 'MARGARITA',
                 last_name: 'GOMEZ',
@@ -187,7 +198,8 @@ describe Xhash::OCR do
                 neighborhood: 'NACIO PITAGORAS 1253',
                 zip_code: 'INT 4',
                 city: 'COL. MORELOS 04800',
-                type: 'INE'
+                type: 'INE',
+                control: "2"
               }
             }
           ),
@@ -292,6 +304,24 @@ describe Xhash::OCR do
         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

data/xhash_client.gemspec

@@ -20,7 +20,6 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'httparty', "~> 0.16.0"
   spec.add_dependency "json", "~> 2.0"
-  spec.add_dependency 'activesupport', "~> 5.2"
 
   spec.add_development_dependency "rspec", "~> 3.8"
   spec.add_development_dependency "webmock", "~> 3.7"

metadata

@@ -1,11 +1,11 @@
 --- !ruby/object:Gem::Specification
 name: xhash_client
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.6
 platform: ruby
 authors:
 - Yellowme
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
 date: 2019-10-10 00:00:00.000000000 Z
@@ -38,20 +38,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
-- !ruby/object:Gem::Dependency
-  name: activesupport
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.2'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.2'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -137,7 +123,7 @@ homepage: https://rubygems.org/gems/xhash-ruby
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -152,9 +138,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: Ruby library built for Xhash API
 test_files: