pago_efectivo 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 39d4e1696f5621391ae6c184b9f361fb5a837293
+  data.tar.gz: dee69c3b22cb4d91cb1fcf331261d8667b5dc513
+SHA512:
+  metadata.gz: 92b20589adb941888b28791e2c57f2b77f656d00d4734df02a57ebd7c2ada89682a1380aaf9cf6e8f6c985e2eb0ee1c5eca303e8e258b2e47daee0a80bdd5ddf
+  data.tar.gz: 5de31c49270265974383de9f171673d3c1662d746266d81df72c35f6cb8922ed0e65293706caf3cbf5c18708da3e992ddf3bea884639509dfaa6375a4266b090

data/.gitignore

@@ -0,0 +1,3 @@
+settings.rb
+*.1pz
+Gemfile.lock

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'gyoku', git: 'https://github.com/ccarruitero/gyoku.git', branch: 'except_convert'
+gem 'savon'
+gem 'nokogiri'

data/Makefile

@@ -0,0 +1,4 @@
+.PHONY: test
+
+test:
+	cutest test/*.rb

data/README.mkd

@@ -0,0 +1,93 @@
+# Pago efectivo
+Ruby SOAP Client to connect with [pago efectivo](https://pagoefectivo.pe/) api.
+
+## Install
+You can install via
+```
+gem install pago_efectivo
+```
+or by adding to your Gemfile
+```
+gem 'pago_efectivo'
+```
+
+## Usage
+
+To use this gem you need a service code and keys provided by pago efectivo.
+
+The first step to use is init a client and set keys
+
+``` ruby
+require 'pago_efectivo'
+
+# init client
+pago_client = PagoEfectivo::Client.new
+
+# set keys
+pago_client.set_key type_of_key, path_to_your_key
+```
+
+To generate a cip
+
+``` ruby
+# generate xml
+xml = pago_client.generate_xml('RSI', PagoEfectivo::CURRENCIES[:soles], '22.00', 1, 'OR001024', 'mail@example.com', {first_name: 'Jweopan', last_name: 'Jnshska', doc_type: 'DNI', doc_num: '37283937', id: 293, email: 'nanan@mail.com'},'', '31/10/2014 17:00:00', {loc: 'San Isidro', prov: 'Lima', country: 'Peru'}, 'some order reference', '','')
+
+# get sign with xml
+sign = pago_client.signature xml
+
+# get encrypted xml
+encrypt = pago_client.encrypt_text xml
+
+# generate cip itself
+cip = pago_client.generate_cip 'RSI', sign, encrypt
+
+# decrypt cip result
+decrypted_cip = pago_client.unencrypt cip
+
+# parse decrypted cip
+cip_result = pago_client.parse_cip_result decrypted_cip
+```
+
+To consult cip
+``` ruby
+# encrypt cip number
+encrypted_cip = pago_client.encrypt_text '1086648'
+
+# sign cip number
+signed_cip = pago_client.signature '1086648'
+
+# consult cip
+consulted_result = pago_client.consult_cip 'RSI', signed_cip, encrypted_cip
+
+# decrypt result
+uncrypted = pago_client.unencrypt consulted_result[:xml]
+
+# parse cip
+cip = pago_client.parse_consult_cip_result uncrypted
+```
+
+To update expiration date
+``` ruby
+# encrypt cip number
+encrypted_cip = pago_client.encrypt_text '1086648'
+
+# sign cip number
+signed_cip = pago_client.signature '1086648'
+
+# update cip
+pago_client.update_cip 'RSI', signed_cip, encrypted_cip, new_date
+```
+Note: new_date should be DateTime class
+
+To delete cip
+``` ruby
+# encrypt cip number
+encrypted_cip = pago_client.encrypt_text '1086648'
+
+# sign cip number
+signed_cip = pago_client.signature '1086648'
+
+# delete cip
+pago_client.delete_cip 'RSI', signed_cip, encrypted_cip
+```

data/lib/pago_efectivo.rb

@@ -0,0 +1,218 @@
+require 'savon'
+require 'gyoku'
+require 'nokogiri'
+
+module PagoEfectivo
+  CURRENCIES = {soles: {id: 1, symbol: 'S/.'}, dolares: {id: 2, symbol: '$'}}
+  PAY_METHODS = [1,2] #[{'bancos' => 1}, {'cuenta_virtual' => 2}]
+
+  class Client
+    SCHEMA_TYPES = {
+      'xmlns:xsd' => 'http://www.w3.org/2001/XMLSchema',
+      'xmlns:xsi' => 'http://www.w3.org/2001/XMLSchema-instance',
+      'xmlns:soap' => 'http://schemas.xmlsoap.org/soap/envelope/'
+    }
+
+    def initialize env=nil
+      if env == 'production'
+        @api_server = 'https://pagoefectivo.pe'
+      else
+        @api_server = 'http://pre.pagoefectivo.pe'
+      end
+
+      if ENV['PROXY_URL'] != nil
+        @proxy = ENV['PROXY_URL']
+      end
+      @crypto_path = '/PagoEfectivoWSCrypto/WSCrypto.asmx?WSDL'
+      @cip_path = '/PagoEfectivoWSGeneralv2/service.asmx?WSDL'
+    end
+
+    def set_key type, path
+      raise 'path to your key is not valid' unless File.exists?(path)
+      if type == 'private'
+        @private_key = File.open(path, 'rb') {|f| Base64.encode64(f.read)}
+      elsif type == 'public'
+        @public_key = File.open(path, 'rb') {|f| Base64.encode64(f.read)}
+      end
+    end
+
+   def create_markup(body)
+     xml_markup = Nokogiri.XML(body).to_xml
+   end
+
+    def signature(text)
+      server = @api_server + @crypto_path
+      client = Savon.client(wsdl: server, proxy: @proxy)
+      response = client.call(:signer, message: {
+                              plain_text: text, private_key: @private_key
+                            })
+      response.to_hash[:signer_response][:signer_result]
+    end
+
+    def encrypt_text(text)
+      server = @api_server + @crypto_path
+      client = Savon.client(wsdl: server, proxy: @proxy)
+      response = client.call(:encrypt_text, message: {
+                              plain_text: text, public_key: @public_key
+                            })
+      response.to_hash[:encrypt_text_response][:encrypt_text_result]
+    end
+
+    def unencrypt enc_text
+      server = @api_server + @crypto_path
+      client = Savon.client(wsdl: server, proxy: @proxy)
+      response = client.call(:decrypt_text, message: {
+                              encrypt_text: enc_text, private_key: @private_key
+                            })
+      response.to_hash[:decrypt_text_response][:decrypt_text_result]
+    end
+
+    # after unencrypt cip result this return like string so we need parse this
+    # for access cip data in more easy way
+    def parse_cip_result uncrypt_text
+      parser = Nori.new
+      cip = parser.parse uncrypt_text
+      cip['ConfirSolPago']['CIP']
+    end
+
+    def generate_xml(cod_serv, currency, total, pay_methods, cod_trans, email,
+                     user, additional_data, exp_date, place, pay_concept,
+                     origin_code, origin_type)
+      # cod_serv => código de servicio asignado
+      # signer => trama firmada con llave privada
+      child_hash = { sol_pago: {
+                 id_moneda: currency[:id],
+                 total: total, # 18 enteros, 2 decimales. Separados por `,`
+                 metodos_pago: pay_methods,
+                 cod_servicio: cod_serv,
+                 codtransaccion: cod_trans, # referencia al pago
+                 email_comercio: email,
+                 fecha_a_expirar: exp_date, # (DateTime.now + 4).to_s(:db)
+                 usuario_id: user[:id],
+                 data_adicional: additional_data,
+                 usuario_nombre: user[:first_name],
+                 usuario_apellidos: user[:last_name],
+                 usuario_localidad: place[:loc],
+                 usuario_provincia: place[:prov],
+                 usuario_pais: place[:country],
+                 usuario_alias: '',
+                 usuario_tipo_doc: user[:doc_type], # tipo de documento DNI, LE, RUC
+                 usuario_numero_doc: user[:doc_num],
+                 usuario_email: user[:email],
+                 concepto_pago: pay_concept,
+                 detalles: {
+                   detalle: {
+                     cod_origen: origin_code,
+                     tipo_origen: origin_type,
+                     concepto_pago: pay_concept,
+                     importe: total,
+                     campo1: '',
+                     campo2: '',
+                     campo3: '',
+                   }
+                 },
+                 params_url: {
+                   param_url: {
+                     nombre: 'IDCliente',
+                     valor: user[:id]
+                   },
+                   params_email: {
+                     param_email: {
+                       nombre: '[UsuarioNombre]',
+                       valor: user[:first_name]
+                     },
+                     param_email: {
+                       nombre: '[Moneda]',
+                       valor: currency[:symbol]
+                     }
+                   }
+                 }
+               }
+             }
+      child_options = { key_converter: :camelcase}
+      gyoku_xml = Gyoku.xml(child_hash, child_options)
+      xml_child = create_markup(gyoku_xml)
+    end
+
+    def generate_cip(cod_serv, signer, xml)
+      server = @api_server + @cip_path
+      client = Savon.client(wsdl: server, proxy: @proxy)
+      response = client.call(:generar_cip_mod1, message: {
+                              request: {
+                                'CodServ' => cod_serv,
+                                'Firma' => signer,
+                                'Xml' => xml
+                            }})
+      response.to_hash[:generar_cip_mod1_response][:generar_cip_mod1_result]
+    end
+
+    # cod_serv: service code, provided by pago efectivo
+    # cips: string of cips separated with comma (,)
+    # signed_cips: cips passed by signer method
+    # encrypted_cips: cips passed by encrypted method
+    # info_request: no specified in pago efectivo documentation, send blank
+    #               for now
+    def consult_cip cod_serv, signed_cips, encrypted_cips, info_request=''
+      server = @api_server + @cip_path
+      client = Savon.client(wsdl: server, proxy: @proxy)
+      response = client.call(:consultar_cip_mod1, message: {
+                   'request' => {
+                     'CodServ' => cod_serv,
+                     'Firma' => signed_cips,
+                     'CIPS' => encrypted_cips,
+                     info_request: info_request
+                   }
+                 })
+      response.to_hash[:consultar_cip_mod1_response][:consultar_cip_mod1_result]
+    end
+
+    # after unencrypt consult cip result this return string so we need parse
+    # this for access cip data in more easy way
+    def parse_consult_cip_result uncrypt_text
+      parser = Nori.new
+      cip = parser.parse uncrypt_text
+      # TODO: parse response for multiple cips
+      cip['ConfirSolPagos']['ConfirSolPago']['CIP']
+    end
+
+    # cod_serv: service code, provided by pago efectivo
+    # signed_cip: number of cip to delete passed by signer method
+    # encrypted_cip: number of cip to delete passed by encrypted method
+    # info_request: no specified in pago efectivo documentation, send blank
+    #               for now
+    def delete_cip cod_serv, signed_cip, encrypted_cip, info_request=''
+      server = @api_server + @cip_path
+      client = Savon.client(wsdl: server, proxy: @proxy)
+      response = client.call(:eliminar_cip_mod1, message: {
+                   'request' => {
+                     'CodServ' => cod_serv,
+                     'Firma' => signed_cip,
+                     'CIP' => encrypted_cip,
+                     'InfoRequest' => info_request
+                   }
+                 })
+      response.to_hash[:eliminar_cip_mod1_response][:eliminar_cip_mod1_result]
+    end
+
+    # cod_serv: service code, provided by pago efectivo
+    # signed_cip: number of cip to modify passed by signer method
+    # encrypted_cip: number of cip to modify passed by encrypted method
+    # exp_date: new expiration date, should be DateTime class
+    # info_request: no specified in pago efectivo documentation, send blank
+    #               for now
+    def update_cip cod_serv,signed_cip,encrypted_cip,exp_date,info_request=''
+      server = @api_server + @cip_path
+      client = Savon.client(wsdl: server, proxy: @proxy)
+      response = client.call(:actualizar_cip_mod1, message: {
+                   'request' => {
+                     'CodServ' => cod_serv,
+                     'Firma' => signed_cip,
+                     'CIP' => encrypted_cip,
+                     'FechaExpira' => exp_date,
+                     'InfoRequest' => info_request
+                   }
+                 })
+      response.to_hash[:actualizar_cip_mod1_response][:actualizar_cip_mod1_result]
+    end
+  end
+end

data/lib/vars.rb

@@ -0,0 +1,9 @@
+# Pago Efectivo variables
+
+CURRENCIES = [{soles: {id: 1, symbol: 'S/.'}}, {dólares: {id: 2, symbol: '$'}}]
+PAY_METHODS = [{'bancos': 1}, {'cuenta_virtual': 2}]
+ORIGIN_TYPE = [
+                {'orden': 'OP'},
+                {'boleta': 'BOL'},
+                {'factura': 'FAC'}
+              ]

data/pago_efectivo.gemspec

@@ -0,0 +1,17 @@
+Gem::Specification.new do |s|
+  s.name = "pago_efectivo"
+  s.version = "0.0.1"
+  s.summary = "SOAP client to use Pago Efectivo"
+  s.description = s.summary
+  s.authors = ["César Carruitero"]
+  s.email = ["cesar@mozilla.pe"]
+  s.homepage = "https://github.com/ccarruitero/pago_efectivo"
+  s.license = "MPL"
+
+  s.files = `git ls-files`.split("\n")
+
+  s.add_runtime_dependency "gyoku"
+  s.add_runtime_dependency "savon"
+
+  s.add_development_dependency "cutest"
+end

data/test/app_test.rb

@@ -0,0 +1,26 @@
+require_relative 'helper'
+include PagoEfectivo
+
+scope do
+  test 'should set dev api_server when initialize without option' do
+    client = PagoEfectivo::Client.new
+    api_server = client.instance_variable_get(:@api_server)
+    assert api_server == 'http://pre.pagoefectivo.pe'
+  end
+
+  test 'should set prod api_server when initialize if you set option' do
+    client = PagoEfectivo::Client.new('production')
+    api_server = client.instance_variable_get(:@api_server)
+    assert api_server == 'https://pagoefectivo.pe'
+  end
+
+  test 'create_markup generate valid xml' do
+    client = PagoEfectivo::Client.new
+    xml = Gyoku.xml({key: 'value'})
+    markup = client.create_markup(xml)
+    assert markup.include?('?xml')
+  end
+
+  test 'set_key should keep key like binary' do
+  end
+end

data/test/helper.rb

@@ -0,0 +1,2 @@
+require "cutest"
+require_relative "../lib/pago_efectivo"

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: pago_efectivo
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- César Carruitero
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-09-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: gyoku
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: savon
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: cutest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: SOAP client to use Pago Efectivo
+email:
+- cesar@mozilla.pe
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Makefile
+- README.mkd
+- lib/pago_efectivo.rb
+- lib/vars.rb
+- pago_efectivo.gemspec
+- test/app_test.rb
+- test/fake_key
+- test/helper.rb
+homepage: https://github.com/ccarruitero/pago_efectivo
+licenses:
+- MPL
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: SOAP client to use Pago Efectivo
+test_files: []