Se agrega validación de còdigo de Estado (#26)

Author: ketsalkuetspalin

.formatter.exs

@@ -0,0 +1,3 @@
+[
+  inputs: ["mix.exs", "{config,lib,test}/**/*.{ex,exs}"]
+]

.gitignore

@@ -20,3 +20,6 @@ erl_crash.dump
 *.ez
 .idea/
 *.iml
+
+# Variables de Entorno
+.env

lib/burox.ex

@@ -5,6 +5,7 @@ defmodule Burox do
   alias Burox.Request.Encoder
   alias Burox.Response.Parser
   alias Burox.Utils
+  alias Burox.Utils.Validator
 
   require Logger
 
@@ -16,12 +17,11 @@ defmodule Burox do
   {:ok, term}
 
   """
-  @spec solicitar(Request.t) :: {:ok, term} | {:error, term}
+  @spec solicitar(Request.t()) :: {:ok, term} | {:error, term}
   def solicitar(peticion) do
     solicitar(peticion, "507")
   end
 
-
   @doc """
   Solicita la información crediticia de una persona al buró de crédito
   ## Ejemplos
@@ -30,34 +30,24 @@ defmodule Burox do
       {:ok, term}
 
   """
-  @spec solicitar(Request.t, String.t) :: {:ok, term} | {:error, term}
+  @spec solicitar(Request.t(), String.t()) :: {:ok, term} | {:error, term}
   def solicitar(data, codigo_producto) do
-    peticion = Utils.to_struct(data, Burox.Request)
-    Logger.info "Petición:\n#{inspect peticion}"
-
-    request_string = Encoder.encode_buro(peticion, codigo_producto)
-    Logger.info "Cadena de petición:\n#{inspect request_string}"
-
-    buro_service = Application.get_env(:burox, :buro_service)
 
-    with {:ok, buro_response} <- buro_service.post(request_string, codigo_producto) do
-      Logger.info "Respuesta del buro: \n #{buro_response}"
+    with {:ok, request} <- Validator.valid?(data) do
+      request_string = Encoder.encode_buro(request, codigo_producto)
+      buro_service = Application.get_env(:burox, :buro_service)
 
-      response = Parser.process_response(buro_response)
-      Logger.info "Respuesta:\n#{inspect response}"
+      with {:ok, buro_response} <- buro_service.post(request_string, codigo_producto) do
+        response = Parser.process_response(buro_response)
 
-      retorno = %{
-        cadena_peticion: request_string,
-        respuesta: response,
-        cadena_respuesta: String.slice(buro_response, 0..-2)
-      }
+        retorno = %{
+          cadena_peticion: request_string,
+          respuesta: response,
+          cadena_respuesta: String.slice(buro_response, 0..-2)
+        }
 
-      case peticion do
-        %Request{} -> {:ok, retorno}
-        _ -> {:error, retorno}
+        {:ok, retorno}
       end
     end
-
   end
-
 end

lib/burox/buro_service_socket.ex lib/burox/service/buro_service_socket.exlib/burox/buro_service_socket.ex renamed to lib/burox/service/buro_service_socket.ex

@@ -11,19 +11,16 @@ defmodule Burox.BuroService.Socket do
   Función para consultar información del Buró de Crédito
   De manera síncrona
   """
-  @spec post(String.t, String.t) :: String.t
+  @spec post(String.t(), String.t()) :: String.t()
   def post(data, codigo_producto) do
-
     config_url = if codigo_producto == "107", do: :buro_url_prospector, else: :buro_url
     buro_url = Application.get_env(:burox, config_url)
-    Logger.info "URL del Buró: #{buro_url}"
 
     if is_nil(buro_url) do
       raise Burox.Error, message: "Debe configurarse la url del Buró de Crédito"
     end
 
     with {:ok, sock} <- Socket.connect(buro_url) do
-      Logger.info "Connected"
       Socket.Stream.send!(sock, data <> <<19>>)
       response = get_response(sock)
 
@@ -34,19 +31,18 @@ defmodule Burox.BuroService.Socket do
       end
     else
       {:error, reason} -> {:error, reason}
-       _ -> {:error, %{error: %{message: "No se puede conectar al Buró de Crédito"}}}
+      _ -> {:error, %{error: %{message: "No se puede conectar al Buró de Crédito"}}}
     end
   end
 
   # Concatena toda la respuesta del Stream
   defp get_response(sock) do
     response = Socket.Stream.recv!(sock)
 
-    if String.ends_with? response, <<19>> do
+    if String.ends_with?(response, <<19>>) do
       response
     else
       response <> get_response(sock)
     end
   end
-
 end

lib/burox/service.ex lib/burox/service/service.exlib/burox/service.ex renamed to lib/burox/service/service.ex

@@ -3,5 +3,5 @@ defmodule Burox.BuroService do
   Este módulo contiene la lógica para mandar y
   recibir información del buro de crédito
   """
-  @callback post(String.t(), String.t) :: String.t()
+  @callback post(String.t(), String.t()) :: String.t()
 end

lib/burox/utils/state_code.ex

@@ -0,0 +1,63 @@
+defmodule Burox.Utils.StateCode do
+  @moduledoc """
+  Módulo que ayuda a asignar el código correcto para cada Estado o
+  vaidar si un código dado en correcto
+  """
+
+  @states_codes [
+    Aguascalientes: "AGS",
+    "Baja California": "BCN",
+    "Baja California Sur": "BCN",
+    Campeche: "CAM",
+    Chiapas: "CHS",
+    Chihuahua: "CHI",
+    "Ciudad de México": "CDMX",
+    Coahuila: "COA",
+    Colima: "COL",
+    Durango: "DGO",
+    "Estado de México": "EM",
+    Guanajuato: "GTO",
+    Guerrero: "GRO",
+    Hidalgo: "HGO",
+    Jalisco: "JAL",
+    "Michoacán": "MICH",
+    Morelos: "MOR",
+    Nayarit: "NAY",
+    "Nuevo León": "NL",
+    Oaxaca: "OAX",
+    Puebla: "PUE",
+    "Querétaro": "QRO",
+    "Quintana Roo": "QR",
+    "San Luis Potosí": "SLP",
+    Sinaloa: "SIN",
+    Sonora: "SON",
+    Tabasco: "TAB",
+    Tamaulipas: "TAM",
+    Tlaxcala: "TLAX",
+    Veracruz: "VER",
+    "Yucatán": "YUC",
+    Zacatecas: "ZAC"
+  ]
+
+  @doc """
+  Retorna el código del Estado que más se parezca al nombre enviado
+  """
+  @spec assign(String.t()) :: String.t()
+  def assign(state_name) do
+    @states_codes
+    |> Enum.max_by(fn {name, code} ->
+      String.jaro_distance(state_name, to_string(name))
+    end)
+    |> elem(1)
+  end
+
+  @doc """
+  Valida si el código pertenece a un Estado
+  """
+  @spec valid?(String.t()) :: bool
+  def valid?(untested_code) do
+    @states_codes
+    |> Enum.find(fn {_name, code} -> code == untested_code end)
+    |> Kernel.!=(nil)
+  end
+end

lib/burox/utils/validator.ex

@@ -0,0 +1,58 @@
+defmodule Burox.Utils.Validator do
+  @moduledoc """
+  Sirve para validar los parámetros en la petición del Buró
+  """
+  alias Burox.Request
+  alias Burox.Request.Direccion
+  alias Burox.Utils.StateCode
+  alias Burox.Utils
+
+  require Logger
+
+  @doc """
+  Valida si los datos de la petición son correctos, de lo contrario regresa
+  los errores
+  """
+  @spec valid?(map()) :: {:ok, term} | {:error, term}
+  def valid?(data) do
+    request = Utils.to_struct(data, Request)
+
+    case request do
+      %Request{} ->
+        if Vex.valid?(request) do
+          request
+          |> validate_state()
+          |> validate_address()
+        else
+          {:error, Vex.errors(request)}
+        end
+
+      error ->
+        {:error, error}
+    end
+  end
+
+  @doc """
+  Valida el código del estado, si es incorrecto lo cambia por uno que si lo sea
+  """
+  @spec validate_state(Request.t()) :: Request.t()
+  def validate_state(request) do
+    with %Request{direccion: address} <- request,
+         %{estado: state_code} <- address do
+      address = struct(Direccion, address)
+
+      new_code = if StateCode.valid?(state_code), do: state_code, else: StateCode.assign(state_code)
+        %Request{request | direccion: %Direccion{address | estado: new_code}}
+     end
+  end
+
+  # Valida si los datos enviados en la dirección son correctos
+  defp validate_address(request) do
+    if Direccion.valid?(request.direccion) do
+      {:ok, request}
+    else
+      {:error, Vex.errors(request.direccion)}
+    end
+  end
+
+end

lib/request/request.ex

@@ -1,23 +1,22 @@
 defmodule Burox.Request.Encabezado do
   @moduledoc false
-
   defstruct [
     :codigo_de_producto,
     :pais,
-    :clave_del_usuario,
+    :clave_del_usuario
   ]
 end
 
 defmodule Burox.Request.Autenticacion do
-@moduledoc false
+  @moduledoc false
   defstruct [
     :tipo_reporte,
     :tipo_salida,
     :referencia_del_operador,
     :cuenta_con_tarjeta_de_credito,
     :ultimos_cuatro_digitos,
     :ha_ejercido_un_credito_hipotecario,
-    :ha_ejercido_un_credito_automotriz_en_los_ultimos_24_meses,
+    :ha_ejercido_un_credito_automotriz_en_los_ultimos_24_meses
   ]
 end
 
@@ -32,6 +31,8 @@ defmodule Burox.Request.Persona do
     :fecha_de_nacimiento,
     :rfc
   ]
+
+  use Vex.Struct
 end
 
 defmodule Burox.Request.Direccion do
@@ -46,6 +47,50 @@ defmodule Burox.Request.Direccion do
     :codigo_postal,
     :origen_del_domicilio
   ]
+
+  use Vex.Struct
+
+  validates(:primera_linea_de_direccion,
+    presence: true,
+    length: [max: 40],
+    format: ~r(^[[:alnum:]\s]+$)
+  )
+
+  validates(:colonia,
+    presence: true,
+    length: [max: 40],
+    format: ~r(^[[:alpha:]\s]+$)
+  )
+
+  validates(:municipio,
+    presence: true,
+    length: [max: 40],
+    format: ~r(^[[:alpha:]\s]+$)
+  )
+
+  validates(:ciudad,
+    presence: true,
+    length: [max: 40],
+    format: ~r(^[[:alpha:]\s]+$)
+  )
+
+  validates(:estado,
+    presence: true,
+    length: [max: 4],
+    format: ~r(^[[:alpha:]\s]+$)
+  )
+
+  validates(:codigo_postal,
+    presence: true,
+    length: [is: 5],
+    format: ~r(^[[:digit:]]+$)
+  )
+
+  validates(:origen_del_domicilio,
+    presence: true,
+    length: [is: 2],
+    format: ~r(^[A-Z]+$)
+  )
 end
 
 defmodule Burox.Request do
@@ -56,10 +101,13 @@ defmodule Burox.Request do
 
   @enforce_keys [:persona, :direccion]
 
-  defstruct [
-    autenticacion: %Request.Autenticacion{},
-    encabezado: %Request.Encabezado{},
-    persona: %Request.Persona{},
-    direccion: %Request.Direccion{}
-  ]
+  defstruct autenticacion: %Request.Autenticacion{},
+            encabezado: %Request.Encabezado{},
+            persona: %Request.Persona{},
+            direccion: %Request.Direccion{}
+
+  use Vex.Struct
+
+  validates(:persona, presence: true)
+  validates(:direccion, presence: true)
 end

mix.exs

@@ -4,9 +4,9 @@ defmodule Burox.Mixfile do
   def project do
     [
       app: :burox,
-      version: "0.1.0",
-      elixir: "~> 1.5",
-      start_permanent: Mix.env == :prod,
+      version: "0.2.0",
+      elixir: "~> 1.7",
+      start_permanent: Mix.env() == :prod,
       deps: deps()
     ]
   end
@@ -19,10 +19,11 @@ defmodule Burox.Mixfile do
 
   defp deps do
     [
-      {:credo,                    "~> 0.9.0-rc1", only: [:dev, :test], runtime: false},
-      {:ex_doc,                   "~> 0.16", only: :dev, runtime: false},
-      {:socket,                   "~> 0.3.2"},
-      {:mox,                     "~> 0.3", only: :test}
+      {:credo, "~> 0.10.0", only: [:dev, :test], runtime: false},
+      {:ex_doc, "~> 0.19", only: :dev, runtime: false},
+      {:socket, "~> 0.3.2"},
+      {:mox, "~> 0.4", only: :test},
+      {:vex, "~> 0.7"}
     ]
   end
 end