cobro_digital 0.1.0 → 1.0.0

data/README.md

@@ -1,8 +1,8 @@
 # CobroDigital
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/cobro_digital`. To experiment with that code, run `bin/console` for an interactive prompt.
+Adaptador para comunicarse con el servicio WS de CobroDigital (Version 3.0).
 
-Para poder hacer uso de la gema. Require previamente comunicarse con CobroDigital para dar de alta el comercio que se hara uso del servicio. Ellos haran entrega de:
+Para poder hacer uso de la gema. Requiere previamente comunicarse con CobroDigital para dar de alta el comercio que se hará uso del servicio (Es posible solicitar datos de prueba). Ellos harán entrega de:
 
 * id del comercio (requerido para cualquier comunicación con el webservice, es la manera de identificarse con el webservice)
 * sid del comercio (requerido para cualquier comunicación con el webservice, es la manera de identificarse con el webservice)
@@ -37,10 +37,10 @@ Los Pagadores son los clientes a los que se les facturará, las acciones posible
 Consiste en crear un pagador en el webservice de CobroDigital, para ello es necesario:
 
 * Comunicarse con CobroDigital para definir la estructura de pagador que se quiera notificar.
-* Es importante determinar un identificador unico por pagador.
+* Es importante determinar un identificador único por pagador.
 * El webservice de CobroDigital solo verifica que la estructura sea correcta, pero no realiza ninguna tipo de validación, por lo tanto es importante llevar el control de si un pagador ya fue dado de alta o no. Ya que es posible dar de alta eternamente el mismo pagador.
 
-Para la creación de un pagador simplemente es neceario comunicar:
+Para la creación de un pagador simplemente es necesario comunicar:
 * Estructura de un pagador.
 
 ```ruby
@@ -48,12 +48,13 @@ comercio_id = 'HA765587' #Brindado por cobrodigital para realizar pruebas
 comercio_sid = 'wsZ0ya68K791phuu76gQ5L662J6F2Y4j7zqE2Jxa3Mvd22TWNn4iip6L9yq' #Brindado por cobrodigital para realizar pruebas
 estructura_pagador = 'Apellido y nombres' => "Santos Torrealba", 'Id' => 1234, 'Documento' => 33123456, 'Direccion del cliente' => "Falsa 1234", 'Telefono' => "222314", 'E-mail' => "santos.torrealba@who.com" # Estructura brindada por cobrodigital para realizar pruebas
 pagador = CobroDigital.Pagador.crear(estructura_pagador)
-response = pagador.call(comercio_id, comercio_sid)
+pagador.call(comercio_id, comercio_sid)
+pagador.response # Obtengo el resultado.
 ```
 
 #### Editar un Pagador
 
-Consiste en editar algun dato dentro de la estructura de pagador de uno especifico.
+Consiste en editar algún dato dentro de la estructura de pagador de uno especifico.
 
 Para la edición de un pagador simplemente es necesario comunicar:
 * Nombre del identificador.
@@ -65,7 +66,8 @@ comercio_id = 'HA765587' #Brindado por cobrodigital para realizar pruebas
 comercio_sid = 'wsZ0ya68K791phuu76gQ5L662J6F2Y4j7zqE2Jxa3Mvd22TWNn4iip6L9yq' #Brindado por cobrodigital para realizar pruebas
 estructura_pagador = 'Apellido y nombres' => "Probando Probando", 'Id' => 1234, 'Documento' => 33123456, 'Direccion del cliente' => "Falsa 1234", 'Telefono' => "222314", 'E-mail' => "santos.torrealba@who.com" # Estructura brindada por cobrodigital para realizar pruebas
 pagador = CobroDigital.Pagador.editar('id', 1234, estructura_pagador)
-response = pagador.call(comercio_id, comercio_sid)
+pagador.call(comercio_id, comercio_sid)
+pagador.response # Obtengo el resultado.
 ```
 
 #### Verificar Pagador
@@ -80,41 +82,43 @@ Para la verificación de un pagador simplemente es necesario comunicar:
 comercio_id = 'HA765587' #Brindado por cobrodigital para realizar pruebas
 comercio_sid = 'wsZ0ya68K791phuu76gQ5L662J6F2Y4j7zqE2Jxa3Mvd22TWNn4iip6L9yq' #Brindado por cobrodigital para realizar pruebas
 pagador = CobroDigital.Pagador.verificar('id', 1234)
-response = pagador.call(comercio_id, comercio_sid)
+pagador.call(comercio_id, comercio_sid)
+pagador.response # Obtengo el resultado.
 ```
 
 #### Codigo Electronico
 
-Para obtener el codigo electronico con el cual le posibilitara a las personas realizar pagos por medio de pagosmiscuentas y linkpagos.
+Para obtener el código electrónico con el cual le posibilitara a las personas realizar pagos por medio de pagosmiscuentas y linkpagos. Cabe que aclarar que este codigo solo sera posible obtener una vez generada la primer boleta.
 
 Para la verificación de un pagador simplemente es necesario comunicar:
 * Nombre del identificador.
 * Valor del identificador.
 
-Retorno el numero de codigo electronico.
+Retorno el numero de código electrónico.
 
 ```ruby
 comercio_id = 'HA765587' #Brindado por cobrodigital para realizar pruebas
 comercio_sid = 'wsZ0ya68K791phuu76gQ5L662J6F2Y4j7zqE2Jxa3Mvd22TWNn4iip6L9yq' #Brindado por cobrodigital para realizar pruebas
 pagador = CobroDigital.Pagador.codigo_electronico('id', 1234)
-response = pagador.call(comercio_id, comercio_sid)
+pagador.call(comercio_id, comercio_sid)
+pagador.response # Obtengo el resultado.
 ```
 
 ### Boleta
 
-Las boletas es la menera de informar la factura a CobroDigital para poder realizar el cobro por algunos de los medios proporcionados por ellos, las acciones posibles son las de `generar boleta`, `inhabilitar boleta`, `obtener codigo de barras`.
+Las boletas es la manera de informar la factura a CobroDigital para poder realizar el cobro por algunos de los medios proporcionados por ellos, las acciones posibles son las de `generar boleta`, `inhabilitar boleta`, `obtener codigo de barras`.
 
 #### Generar Boleta
 
-Es la menera de informar una factura a cobrar.
+Es la manera de informar una factura a cobrar.
 
 Para la generación de una boleta es necesario comunicar:
 * nombre del identificador.
 * el valor del identificador.
-* Array de vencimientos como maximo 4. Siempre la primera fecha deberá ser la fecha de emisión. ejemplo: [Date.today, Date.today+10.days, Date.today+20.days]
-* Array de importes como maximo 4. Siempre el primer monto es el valor de la factura, los siguientes son con los recargos. [100, 110, 120]
+* Array de vencimientos como máximo 4. Siempre la primera fecha deberá ser la fecha de emisión. ejemplo: [Date.today, Date.today+10.days, Date.today+20.days]
+* Array de importes como máximo 4. Siempre el primer monto es el valor de la factura, los siguientes son con los recargos. [100, 110, 120]
 * concepto, una simple leyenda.
-* plantilla, es la plantilla de la boleta (Cada comercio debe proporcionar esta plantilla)
+* plantilla, es la plantilla de estilo de la boleta (Cada comercio debe proporcionar esta plantilla, comunicarse con CobroDigital para mas detalle)
 
 Retorna un numero de boleta.
 
@@ -128,7 +132,8 @@ importes = [100,110,120]
 concepto = "Factura A 10"
 plantilla = 'init_273' #Proporcionado por CobroDigital para realizar pruebas.
 boleta = CobroDigital.Boleta.generar(nombre_identificador, valor_identificador, vencimientos, importes, concepto, plantilla)
-response = boleta.call(comercio_id, comercio_sid)
+boleta.call(comercio_id, comercio_sid)
+boleta.response # Obtengo el resultado.
 ```
 
 #### Inhabilitar Boleta
@@ -143,14 +148,15 @@ comercio_id = 'HA765587' #Brindado por cobrodigital para realizar pruebas
 comercio_sid = 'wsZ0ya68K791phuu76gQ5L662J6F2Y4j7zqE2Jxa3Mvd22TWNn4iip6L9yq' #Brindado por cobrodigital para realizar pruebas
 numero_boleta = 123
 boleta = CobroDigital.Boleta.inhabilitar(numero_boleta)
-response = boleta.call(comercio_id, comercio_sid)
+boleta.call(comercio_id, comercio_sid)
+boleta.response # Obtengo el resultado.
 ```
 
 #### Obtener codigo de barras
 
-Obtener el string de los codigos de barras. Seran tantos como vencimientos e importes informados. En caso de querer renderizarlo a imagen debera de hacer uso del codigo 128b, para ello se puede hacer uso de la gema barby.
+Obtener el string de los códigos de barras. Serán tantos como vencimientos e importes informados. En caso de querer renderizarlo a imagen deberá de hacer uso del código 128b, para ello se puede hacer uso de la gema barby.
 
-Para la obtención de los codigos de barra es necesario comunicar:
+Para la obtención de los códigos de barra es necesario comunicar:
 * numero de boleta (obtenida en la generación)
 
 
@@ -159,9 +165,51 @@ comercio_id = 'HA765587' #Brindado por cobrodigital para realizar pruebas
 comercio_sid = 'wsZ0ya68K791phuu76gQ5L662J6F2Y4j7zqE2Jxa3Mvd22TWNn4iip6L9yq' #Brindado por cobrodigital para realizar pruebas
 numero_boleta = 123
 boleta = CobroDigital.Boleta.obtener_codigo_de_barras(numero_boleta)
-response = boleta.call(comercio_id, comercio_sid)
+boleta.call(comercio_id, comercio_sid)
+boleta.response # Obtengo el resultado.
 ```
 
+### Transacciones
+
+Es posible realizar todas los movimientos ya sea de ingreso y egreso en la cuenta proporcionada a cobrodigital.
+
+Para poder realizar las consulta de las transacciones es necesario comunicar:
+* fecha_desde: Comienzo desde donde se quiere obtener las transacciones.
+* fecha_hasta: Fin desde donde se quiere obtener las transacciones.
+* filtros: Los filtros nos permiten obtener transacciones mas especificas:
+
+Para consultar los tipos de filtros, se puede consultar las siguientes constantes:
+
+```ruby
+CobroDigital.Transaccion::FILTRO_TIPO          => 'tipo'
+CobroDigital.Transaccion::FILTRO_NOMBRE        => 'nombre'
+CobroDigital.Transaccion::FILTRO_CONCEPTO      => 'concepto'
+CobroDigital.Transaccion::FILTRO_NRO_BOLETA    => 'nro_boleta'
+CobroDigital.Transaccion::FILTRO_IDENTIFICADOR => 'identificador'
+
+CobroDigital.Transaccion::FILTRO_TIPO_EGRESO            => 'egresos'           # Transacciones de retiro del dinero depositado por los pagadores.
+CobroDigital.Transaccion::FILTRO_TIPO_INGRESO           => 'ingresos'          # Todo lo que incremente el saldo de la cuenta CobroDigital. Generalmente son sólo las cobranzas.
+CobroDigital.Transaccion::FILTRO_TIPO_TARJETA_CREDITO   => 'tarjeta_credito'   # Solo aquellas cobranzas abonadas con tarjeta de crédito.
+CobroDigital.Transaccion::FILTRO_TIPO_DEBITO_AUTOMATICO => 'debito_automatico' # Está relacionado a los débitos realizados por CBU.
+
+filtro = { CobroDigital.Transaccion::FILTRO_TIPO          => CobroDigital.Transaccion::FILTRO_TIPO_INGRESO,
+           CobroDigital.Transaccion::FILTRO_NOMBRE        => "Algun nombre",
+           CobroDigital.Transaccion::FILTRO_CONCEPTO      => "Algun concepto"
+           CobroDigital.Transaccion::FILTRO_NRO_BOLETA    => "Algun numero de boleta",
+           CobroDigital.Transaccion::FILTRO_IDENTIFICADOR => "Algun identificar" }
+```
+
+```ruby
+comercio_id = 'HA765587' #Brindado por cobrodigital para realizar pruebas
+comercio_sid = 'wsZ0ya68K791phuu76gQ5L662J6F2Y4j7zqE2Jxa3Mvd22TWNn4iip6L9yq' #Brindado por cobrodigital para realizar pruebas
+numero_boleta = 123
+filtro = { CobroDigital.Transaccion::FILTRO_TIPO => CobroDigital.Transaccion::FILTRO_TIPO_INGRESO} # Solo consulta por transacciones de ingreso
+transacciones = CobroDigital.Transaccion.consultar(Date.today - 1.year, Date.today)
+transacciones.call(comercio_id, comercio_sid)
+transacciones.response # Obtengo el resultado.
+```
+
+## SOAP vs HTTPS
 
 ## Development
 
@@ -177,4 +225,3 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/[USERN
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-

data/lib/cobro_digital/transaccion.rb

@@ -1,14 +1,27 @@
+# coding: utf-8
 module CobroDigital
   class Transaccion < CobroDigital::Operador
 
     CONSULTAR_TRANSACCIONES_WS = 'consultar_transacciones'
 
+    FILTRO_TIPO          = 'tipo'
+    FILTRO_NOMBRE        = 'nombre'
+    FILTRO_CONCEPTO      = 'concepto'
+    FILTRO_NRO_BOLETA    = 'nro_boleta'
+    FILTRO_IDENTIFICADOR = 'identificador'
+
+    FILTRO_TIPO_EGRESO            = 'egresos'           # Transacciones de retiro del dinero depositado por los pagadores.
+    FILTRO_TIPO_INGRESO           = 'ingresos'          # Todo lo que incremente el saldo de la cuenta CobroDigital. Generalmente son sólo las cobranzas.
+    FILTRO_TIPO_TARJETA_CREDITO   = 'tarjeta_credito'   # Solo aquellas cobranzas abonadas con tarjeta de crédito.
+    FILTRO_TIPO_DEBITO_AUTOMATICO = 'debito_automatico' # Está relacionado a los débitos realizados por CBU.
+
     # { 'desde'=>'20160932', 'hasta'=>'20161001' }
-    def self.consultar(desde, hasta)
+    def self.consultar(desde, hasta, filtros={})
       CobroDigital::Transaccion.new( :http_method => CobroDigital::Https::GET,
                                      :webservice  => CONSULTAR_TRANSACCIONES_WS,
-                                     :render      => { :desde => desde.strftime('%Y%m%d'),
-                                                       :hasta => hasta.strftime('%Y%m%d') } )
+                                     :render      => { :desde   => desde.strftime('%Y%m%d'),
+                                                       :hasta   => hasta.strftime('%Y%m%d'),
+                                                       :filtros => filtros } )
     end
 
   end

data/lib/cobro_digital/version.rb

@@ -1,3 +1,3 @@
 module CobroDigital
-  VERSION = "0.1.0"
+  VERSION = "1.0.0"
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: cobro_digital
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 23
   prerelease: 
   segments: 
-  - 0
   - 1
   - 0
-  version: 0.1.0
+  - 0
+  version: 1.0.0
 platform: ruby
 authors: 
 - g.edera
@@ -15,7 +15,7 @@ autorequire:
 bindir: exe
 cert_chain: []
 
-date: 2016-10-28 00:00:00 -03:00
+date: 2016-11-09 00:00:00 -03:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency