xhash_client 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d7744b9f0b562d4f040b9bc1dd81c9410005c1ec9d8390cd4325c1befe6effcd
-  data.tar.gz: b2a5b8a32776005f55b6d8f3fade17713994f978a4c666f8c4c093a7faf377d5
+  metadata.gz: e41e823bbfa41b059071bc5a93fbb98502d941bfa147b96cf5c3495b114bc847
+  data.tar.gz: 1193d96715a223e5628c9b8677e5bfebd08208a9094658d34b60368e61cdc716
 SHA512:
-  metadata.gz: cfa44d85264d7d0a57444efa14171c9fc6ab7dcd683dfd63203623d6cd9d46c5c70c1a1dcf646bbc67e6f06a773167d0a45bfe822637e28ff9935804957c92eb
-  data.tar.gz: 7cf8944d01ae81a9d95231ccad0ea53bbe75402a99c3ef8831e0bbe6c2f25880ff2cfb624818f439fb67449cd41890f1c1052adbfd57ff283f3c98125bf21353
+  metadata.gz: 2695f2a228913f1602a7ffa4b18176e23b1b15a61cece17c001e5d5ef1270cbd9681adb487f97f0ae7ca640316964aaeeb99020c8ce0b2674120fcef497d694a
+  data.tar.gz: be7111ccbf7ff8dba07d3881c18d31c1e0e7b25992ceec868073e40c09aa3966f811f8cce663f095bfee4b41fa6a46eb23e398acb7bd8da1ace27cd6e34af406

data/.gitignore

@@ -0,0 +1,59 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# 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
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# Mac
+.DS_Store
+
+# Windows
+Thumbs.db
+
+# WebStorm
+.idea/

data/Gemfile

@@ -0,0 +1,12 @@
+source 'https://rubygems.org'
+git_source(:github) { |repo| "https://github.com/#{repo}.git" }
+
+# Declare your gem's dependencies in commons.gemspec.
+# Bundler will treat runtime dependencies like base dependencies, and
+# development dependencies will be added by default to the :development group.
+gemspec
+
+# Declare any dependencies that are still in development here instead of in
+# your gemspec. These might include edge Rails or gems from your path or
+# Git. Remember to move these dependencies to your gemspec before releasing
+# your gem to rubygems.org.

data/Gemfile.lock

@@ -0,0 +1,74 @@
+PATH
+  remote: .
+  specs:
+    xhash (0.3.0)
+      activesupport (~> 5.2)
+      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)
+    docile (1.3.2)
+    hashdiff (1.0.0)
+    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)
+    multi_xml (0.6.0)
+    public_suffix (4.0.1)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.2)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.2)
+    safe_yaml (1.0.5)
+    simplecov (0.17.0)
+      docile (~> 1.1)
+      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)
+      hashdiff (>= 0.4.0, < 2.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rspec (~> 3.8)
+  simplecov (~> 0.17)
+  webmock (~> 3.7)
+  xhash!
+
+BUNDLED WITH
+   1.17.3

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Yellowme
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,2 @@
+# xhash-ruby
+Ruby Bindings for Xhash API

data/Rakefile

@@ -0,0 +1,7 @@
+require 'rspec/core/rake_task'
+require 'bundler/gem_tasks'
+
+# Default directory to look in is `/spec`
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/xhash/client/api_client.rb

@@ -0,0 +1,27 @@
+require 'singleton'
+
+module Xhash
+  class ApiClient
+    include Xhash::JsonApi
+
+    def self.config
+      yield self
+    end
+
+    def self.api_base
+      @api_base
+    end
+
+    def self.api_base=(api_base)
+      @api_base = api_base
+    end
+
+    def self.api_key
+      @api_key
+    end
+
+    def self.api_key=(api_key)
+      @api_key = api_key
+    end
+  end
+end

data/lib/xhash/client/json_api.rb

@@ -0,0 +1,48 @@
+require 'httparty'
+
+module Xhash
+  module JsonApi
+    module ClassMethods
+      def default_headers
+        {
+          'Content-type' => 'application/json', 'Authorization' => Xhash.api_key
+        }
+      end
+
+      def api_get(url:, headers: {})
+        custom_headers = headers.merge(default_headers)
+        response = HTTParty.get(Xhash.api_base + url, headers: custom_headers)
+
+        JSON.parse(response.body, symbolize_names: true)
+      end
+
+      def api_post(url:, body: {}, headers: {})
+        custom_headers = headers.merge(default_headers)
+
+        response =
+          HTTParty.post(
+            Xhash.api_base + url,
+            body: body.to_json, headers: custom_headers
+          )
+
+        JSON.parse(response.body, symbolize_names: true)
+      end
+
+      def api_post_multipart(url:, body: {}, headers: {})
+        custom_headers = headers.merge(default_headers)
+
+        response =
+          HTTParty.post(
+            Xhash.api_base + url,
+            multipart: true, body: body, headers: custom_headers
+          )
+
+        response.body
+      end
+    end
+
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+  end
+end

data/lib/xhash/database_lookup.rb

@@ -0,0 +1,28 @@
+module Xhash
+  class DatabaseLookup < ApiClient
+    def self.renapo(curp)
+      url = 'database-lookup/renapo'
+      body = { curp: curp }
+      response = api_post(url: url, body: body)
+      payload = response[:payload]
+
+      if payload.nil?
+        raise Xhash::MissingRequiredFieldError.new(
+                {
+                  message: Xhash::ErrorMessage::MISSING_CURP, response: response
+                }
+              )
+      end
+
+      if payload[:name] == 'CURP INVALIDO'
+        raise Xhash::InvalidFieldError.new(
+                {
+                  message: Xhash::ErrorMessage::INVALID_CURP, response: response
+                }
+              )
+      end
+
+      Xhash::CURP.new(*payload.values_at(*Xhash::CURP.members))
+    end
+  end
+end

data/lib/xhash/document_types.rb

@@ -0,0 +1,15 @@
+module Xhash
+  module DocumentType
+    module ID
+      INE_FRONT = 1
+      PASSPORT = 2
+      INE_REVERSE = 7
+      MILITARY_ID = 6
+    end
+    module ProofOfAddress
+      CFE = 3
+      AXTEL = 4
+      TELMEX = 5
+    end
+  end
+end

data/lib/xhash/error.rb

@@ -0,0 +1,15 @@
+module Xhash
+  class Error < StandardError
+    attr_reader :message, :response
+
+    def initialize(options = {})
+      @message = options[:message]
+      @response = options[:response]
+      super
+    end
+  end
+
+  class MissingRequiredFieldError < Error; end
+
+  class InvalidFieldError < Error; end
+end

data/lib/xhash/error_messages.rb

@@ -0,0 +1,8 @@
+module Xhash
+  module ErrorMessage
+    INVALID_CURP = 'The selected CURP is invalid'
+    MISSING_CURP = 'The selected CURP is required'
+    INVALID_FILE = 'The selected document is invalid'
+    MISSING_FILE = 'The selected document is required'
+  end
+end

data/lib/xhash/formatters.rb

@@ -0,0 +1,9 @@
+module Xhash
+  module Formatters
+    def self.invalid_field_message_to_s(hash)
+      message = ''
+      hash.each { |key, value| message += value[0] + ' ' }
+      message.strip
+    end
+  end
+end

data/lib/xhash/general.rb

@@ -0,0 +1,63 @@
+module Xhash
+  class General < ApiClient
+    def self.store_data(*user_body)
+      url = 'store-data'
+      body = Hash[*user_body]
+      response = api_post(url: url, body: body)
+
+      unless response[:id]
+        raise Xhash::MissingRequiredFieldError.new(
+                {
+                  message:
+                    Xhash::Formatters.invalid_field_message_to_s(response),
+                  response: response
+                }
+              )
+      end
+
+      Xhash::Customer.new(*response.values_at(*Xhash::Customer.members))
+    end
+
+    def self.get_customer(customer_id:)
+      url = "get-customer/#{customer_id}"
+      response = api_get(url: url)
+      payload = response[:payload]
+
+      if payload.nil?
+        raise Xhash::MissingRequiredFieldError.new(
+                {
+                  message:
+                    Xhash::Formatters.invalid_field_message_to_s(response),
+                  response: response
+                }
+              )
+      end
+
+      Xhash::Customer.new(*payload.values_at(*Xhash::Customer.members))
+    end
+
+    def self.store_file(customer_id:, document_type:, document:)
+      url = 'store-file'
+      headers = { 'boundary' => '---011000010111000001101001' }
+      body = {
+        'customer_id' => customer_id,
+        'document_type' => document_type,
+        'document' => document
+      }
+
+      response = api_post_multipart(url: url, body: body, headers: headers)
+
+      unless response == 'Image stored'
+        error = JSON.parse(response, symbolize_names: true)
+        raise Xhash::MissingRequiredFieldError.new(
+                {
+                  message: Xhash::Formatters.invalid_field_message_to_s(error),
+                  response: error
+                }
+              )
+      end
+
+      response
+    end
+  end
+end

data/lib/xhash/ocr.rb

@@ -0,0 +1,124 @@
+module Xhash
+  class OCR < ApiClient
+    IDENTIFICATION_TYPES = ['INE', 'CARTILLA MILITAR', 'PASAPORTE']
+
+    def self.generic(document_url: nil, document_file: nil)
+      url = 'ocr'
+
+      if document_url.nil? and document_file.nil?
+        raise Xhash::MissingRequiredFieldError.new(
+                { message: Xhash::ErrorMessage::MISSING_FILE }
+              )
+      end
+
+      payload =
+        request_by_file_or_url(
+          url: url, document_url: document_url, document_file: document_file
+        )
+
+      is_identification = IDENTIFICATION_TYPES.include? payload[:type]
+
+      document =
+        if is_identification
+          Xhash::Identification.new(
+            *payload.values_at(*Xhash::Identification.members)
+          )
+        else
+          Xhash::ProofOfAddress.new(
+            *payload.values_at(*Xhash::ProofOfAddress.members)
+          )
+        end
+
+      document
+    end
+
+    def self.identification(document_url: nil, document_file: nil)
+      url = 'ocr/identification'
+
+      if document_url.nil? and document_file.nil?
+        raise Xhash::MissingRequiredFieldError.new(
+                { message: Xhash::ErrorMessage::MISSING_FILE }
+              )
+      end
+
+      payload =
+        request_by_file_or_url(
+          url: url, document_url: document_url, document_file: document_file
+        )
+
+      Xhash::Identification.new(
+        *payload.values_at(*Xhash::Identification.members)
+      )
+    end
+
+    def self.proof_of_address(document_url: nil, document_file: nil)
+      url = 'ocr/proof-of-address'
+
+      if document_url.nil? and document_file.nil?
+        raise Xhash::MissingRequiredFieldError.new(
+                { message: Xhash::ErrorMessage::MISSING_FILE }
+              )
+      end
+
+      payload =
+        request_by_file_or_url(
+          url: url, document_url: document_url, document_file: document_file
+        )
+
+      Xhash::ProofOfAddress.new(
+        *payload.values_at(*Xhash::ProofOfAddress.members)
+      )
+    end
+
+    def self.ine_reverse(document_url: nil, document_file: nil)
+      url = 'ocr/ine-reverse'
+
+      if document_url.nil? and document_file.nil?
+        raise Xhash::MissingRequiredFieldError.new(
+                { message: Xhash::ErrorMessage::MISSING_FILE }
+              )
+      end
+
+      payload =
+        request_by_file_or_url(
+          url: url, document_url: document_url, document_file: document_file
+        )
+
+      Xhash::Identification.new(
+        *payload.values_at(*Xhash::Identification.members)
+      )
+    end
+
+    private
+
+    def self.request_by_file_or_url(
+      url: nil, document_url: nil, document_file: nil
+    )
+      body = {
+        'document_url' => document_url, 'document_file' => document_file
+      }
+
+      response =
+        if document_file.nil?
+          api_post(
+            url: url,
+            body: body,
+            headers: { 'boundary' => '---011000010111000001101001' }
+          )
+        else
+          data = api_post_multipart(url: url, body: body)
+          JSON.parse(data, symbolize_names: true)
+        end
+
+      payload = response[:payload]
+
+      if payload.nil?
+        raise Xhash::InvalidFieldError.new(
+                { message: Xhash::ErrorMessage::INVALID_FILE }
+              )
+      end
+
+      payload
+    end
+  end
+end

data/lib/xhash/sat.rb

@@ -0,0 +1,18 @@
+module Xhash
+  class SAT < ApiClient
+    def self.get_rfc(
+      name: nil, last_name: nil, mothers_last_name: nil, birth_date: nil
+    )
+      url = 'sat/get-rfc'
+      body = {
+        name: name,
+        last_name: last_name,
+        mothers_last_name: mothers_last_name,
+        birth_date: birth_date
+      }
+      response = api_post(url: url, body: body)
+      raise Xhash::MissingRequiredFieldError.new(response) unless response[:rfc]
+      Xhash::RFC.new(*response.values_at(*Xhash::RFC.members))
+    end
+  end
+end

data/lib/xhash/structs/curp.rb

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

data/lib/xhash/structs/customer.rb

@@ -0,0 +1,49 @@
+module Xhash
+  Customer =
+    Struct.new(
+      :id,
+      :name,
+      :last_name,
+      :mothers_last_name,
+      :gender,
+      :birth_date,
+      :birth_city,
+      :birth_country,
+      :curp,
+      :renapo_match,
+      :rfc,
+      :rfc_match,
+      :rfc_is_cancelled,
+      :zip_code,
+      :neighborhood,
+      :province,
+      :city,
+      :country,
+      :address,
+      :activity,
+      :electoral_key,
+      :clabe,
+      :ext_address,
+      :email,
+      :phone_number,
+      :in_black_list,
+      :black_list_name,
+      :liveness_video,
+      :liveness_check,
+      :document_id,
+      :client_id,
+      :external_customer_id,
+      :update_key,
+      :device_fingerprint_id,
+      :token_email,
+      :email_verified_at,
+      :token_sm,
+      :sms_verified_at,
+      :deleted_at,
+      :created_at,
+      :updated_at,
+      :ip_uniqueness,
+      :fingerprint_uniqueness,
+      :documents
+    )
+end

data/lib/xhash/structs/identification.rb

@@ -0,0 +1,30 @@
+module Xhash
+  Identification =
+    Struct.new(
+      :lines,
+      :cic,
+      :cic_digit_check,
+      :is_cic_digit_check_consistent,
+      :section_and_consecutive,
+      :date,
+      :date_check_digit,
+      :expiration_date,
+      :expiration_date_digit,
+      :nationality,
+      :emission_and_fuar,
+      :name,
+      :mothers_last_name,
+      :last_name,
+      :last_names,
+      :birth_date,
+      :gender,
+      :elector_key,
+      :curp,
+      :street,
+      :neighborhood,
+      :zip_code,
+      :city,
+      :province,
+      :type
+    )
+end

data/lib/xhash/structs/proof_of_address.rb

@@ -0,0 +1,15 @@
+module Xhash
+  ProofOfAddress =
+    Struct.new(
+      :full_name,
+      :full_address,
+      :street,
+      :neighborhood,
+      :zip_code,
+      :city,
+      :province,
+      :type,
+      :date,
+      :exception
+    )
+end

data/lib/xhash/structs/rfc.rb

@@ -0,0 +1,3 @@
+module Xhash
+  RFC = Struct.new(:name, :last_name, :mothers_last_name, :birth_date, :rfc)
+end

data/lib/xhash/version.rb

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