culqi 1.1.8

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 12bf58ccff76e1bb52736c31d886a25953a4d7f7
+  data.tar.gz: 05d124c23b3a3ecfa44c042f3a095bf757d4cb3e
+SHA512:
+  metadata.gz: 31ed099b08bc11b13ba96decf42509db47a3a8f7c0019a1f0c882c64a19b3189451de8060f05e68f9169a8d295a4cab9631a1f9a3373a792e7b122af822f2c11
+  data.tar.gz: 57508ebdb79c37a27ffacae9c58779f0bdf312888e96ae6ba9d76225849be67f341c10be80e1ecb5a84e69a48b648bc08ef8722afa316d7cc199149688b73aa5

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.env

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2.4
+before_install: gem install bundler -v 1.12.2

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in culqiruby.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Augusto Samame
+
+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,143 @@
+# Culqiruby
+
+This gem allows your Rails or Ruby app to quickly integrate with Culqi Payment processor. It handles Culqi's flavor of encryption, decryption and Culqi ticket creation.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'culqiruby'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install culqiruby
+
+## Versiones
+
+La versión 1.x de este gem podrá ser usada en producción con la versión 1.x del API de Culqi
+
+Compatible con Ruby versiones 1.9.2 y superior
+
+Compatible con Rails versiones 3.2 y superior
+
+
+## Requerimientos
+
+Este gem requiere de la existencia de las siguientes environment variables en el ambiente de Desarrollo / Pruebas / Producción:
+
+CULQI_KEY="llave de encriptación entregada por Culqi"
+
+CULQI_ENDPOINT="dominio del API de Culqi"
+
+CULQI_CODIGO_COMERCIO="código de comercio asignado por Culqi"
+
+
+
+Para definir los environments variables en su ambiente recomendamos:
+
+
+Ruby:
+dotenv gem
+https://github.com/bkeepers/dotenv
+
+
+Rails:
+figaro gem
+https://github.com/laserlemon/figaro
+
+
+## Forma de Uso
+
+Instanciamos el cliente Culqi para exponer sus métodos:
+
+```ruby
+culqi = Culqi.default_client
+```
+
+## Métodos
+
+## crear_venta
+
+Este método permitirá crear una venta en Culqi, para luego invocar el formulario según lo indicado por la documentación de Culqi.
+Para que la creación de la venta sea exitosa, los siguientes atributos le deberán ser pasados al método como un hash:
+
+numero_pedido, moneda, monto, descripcion, correo_electronico, cod_pais, ciudad, direccion, num_tel, id_usuario_comercio, nombres, apellidos
+
+Ejemplo:
+
+```ruby
+#instanciamos el cliente Culqi
+culqi = Culqi.default_client
+
+#creamos la venta
+
+datos_venta = {
+              numero_pedido: '12367',
+              moneda: 'PEN',
+              monto: '5000',
+              descripcion: 'Venta de prueba',
+              correo_electronico: 'augustosamame@gmail.com',
+              cod_pais: 'PE',
+              ciudad: 'Lima',
+              direccion: 'Av Javier Prado 2320, San Borja',
+              num_tel: '986976309',
+              id_usuario_comercio: '2',
+              nombres: 'Augusto',
+              apellidos: 'Samame'
+              }
+              
+venta = culqi.crear_venta(datos_venta) 
+
+```
+
+El método crear_venta devolverá un arreglo con 2 valores: el primer valor es un string con el resultado de la creación de la venta y el segundo valor un hash con la respuesta del API de Culqi
+
+Ej de respuesta exitosa:
+
+{"mensaje_respuesta_usuario"=>"", "monto"=>"5000", "mensaje_respuesta"=>"Venta creada exitosamente.", "ticket"=>"6F6tIyUlOmrMKo3EI5rxcsvamwHRrKAEgsb", "codigo_respuesta"=>"venta_registrada", "numero_pedido"=>"1234", "codigo_comercio"=>"3zMquUkbF5s8", "informacion_venta"=>"EtEfsG1iD1Ur8YYHO98hRX1kXE2KOVlq4vbmmLVkKKX5eCBUFAHeuAhRrefRIwuUAHTWH6tiNWIthJ67Fi11LGkBEF861R2iQNjG5vsHSy8RsFuXfUU_zKTYYwGhaYkR4tAewbDRnBX3YKJOxPcMqA=="}
+
+
+Ej de respuesta con error
+
+{"mensaje_respuesta_usuario"=>"", "mensaje_respuesta"=>"La transacción ya existe. ", "codigo_respuesta"=>"parametro_invalido", "codigo_comercio"=>"3zMquUkbF5s8"}
+
+
+## Encryptor Class
+
+Para poder utilizar los métodos de encriptación y desencriptación de Culqi, debemos instanciar la clase Culqi::Encryptor.
+Recuerde que de acuerdo a los requerimientos del gem indicados arriba, el environment variable CULQI_KEY debe haber sido seteado para que esta clase funcione:
+
+
+```ruby
+encryptor = Culqi::Encryptor.new
+```
+
+Esto expondrá los métodos: encrypt y decrypt
+
+```ruby
+texto_encriptado = encryptor.encrypt('Texto Prueba')
+
+=> "yozxCEGWPDw_uiHdsOXW-4EAuKDfCxCcd0GO2bESegE="
+
+texto_plano = encryptor.decrypt("yozxCEGWPDw_uiHdsOXW-4EAuKDfCxCcd0GO2bESegE=")
+
+=> "Texto Prueba"
+
+(su cadena encriptada será distinta ya que Culqi asigna una llave de encriptación distinta a cada cliente)
+```
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/augustosamame/culqiruby.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "culqiruby"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/culqi.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'culqi/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'culqi'
+  spec.version       = Culqi::VERSION
+  spec.authors       = ['Augusto Samame']
+  spec.email         = ['augustosamame@gmail.com']
+
+  spec.summary       = %q{Facilitates integration with Culqi payment processor}
+  spec.description   = %q{This gem allows your Ruby (1.9.2+) or Rails (3.2+) app to quickly integrate with Culqi Payment processor.
+                          It handles Culqi's flavor of encryption, decryption and Culqi ticket creation.}
+  spec.homepage      = 'https://github.com/augustosamame/culqiruby'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = '>= 1.9.2'
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = %w[ lib ]
+
+  spec.add_development_dependency 'bundler', '~> 1.12'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+end

data/lib/culqi/client.rb

@@ -0,0 +1,51 @@
+require 'net/http'
+require 'json'
+
+module Culqi
+  class Client
+    ERROR_MESSAGES = {
+      failed_request: 'Error al crear venta, HTTP code:'
+    }
+
+    def initialize(key, endpoint, code)
+      @key  = key
+      @url  = URI(endpoint + '/api/v1/web/crear')
+      @code = code
+    end
+
+    def crear_venta(attrs)
+      sale    = Culqi::Sale.new(attrs)
+      request = http_request(sale.payload)
+
+      http_response(request)
+    end
+
+    private
+
+    def http_client
+      http             = Net::HTTP.new(@url.host, @url.port)
+      http.use_ssl     = true
+      http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      http
+    end
+
+    def http_request(payload)
+      request                 = Net::HTTP::Post.new(@url)
+      request['content-type'] = 'application/json'
+      request.body            = { codigo_comercio: @code, informacion_venta: encryptor.encrypt(payload) }.to_json
+      request
+    end
+
+    def http_response(request)
+      response = http_client.request(request)
+
+      raise "#{ ERROR_MESSAGES[:failed_request] } #{ response.code }" unless response.code == '200'
+
+      JSON.parse(encryptor.decrypt(response.body))
+    end
+
+    def encryptor
+      @encryptor ||= Culqi::Encryptor.new
+    end
+  end
+end

data/lib/culqi/encryptor.rb

@@ -0,0 +1,35 @@
+require 'openssl'
+require 'base64'
+
+module Culqi
+  class Encryptor
+    def initialize
+      @key = Base64.urlsafe_decode64(ENV['CULQI_KEY'])
+    end
+
+    def encrypt(plaintext)
+      cipher    = build_cipher(:encrypt)
+      cipher.iv = iv = cipher.random_iv
+      decoded   = iv + cipher.update(plaintext) + cipher.final
+
+      Base64.urlsafe_encode64(decoded)
+    end
+
+    def decrypt(encrypted)
+      decoded     = Base64.urlsafe_decode64(encrypted)
+      decipher    = build_cipher(:decrypt)
+      decipher.iv = decoded.slice!(0, 16)
+
+      decipher.update(decoded) + decipher.final
+    end
+
+    private
+
+    def build_cipher(type)
+      cipher = OpenSSL::Cipher::AES.new(256, :CBC)
+      cipher.send(type)
+      cipher.key = @key
+      cipher
+    end
+  end
+end

data/lib/culqi/sale.rb

@@ -0,0 +1,45 @@
+module Culqi
+  class Sale
+    DEFAULTS = {
+      moneda:   'PEN',
+      cod_pais: 'PE',
+      codigo_comercio: ENV['CULQI_CODIGO_COMERCIO']
+    }
+
+    attr_accessor :codigo_comercio,
+                  :numero_pedido,
+                  :moneda,
+                  :monto,
+                  :descripcion,
+                  :correo_electronico,
+                  :cod_pais,
+                  :ciudad,
+                  :direccion,
+                  :num_tel,
+                  :id_usuario_comercio,
+                  :nombres,
+                  :apellidos
+
+    def initialize(attrs)
+      attrs.each { |key, value| public_send("#{ key }=", value) }
+    end
+
+    def payload
+      {
+        codigo_comercio:      (codigo_comercio || DEFAULTS[:codigo_comercio]),
+        numero_pedido:        numero_pedido,
+        moneda:               (moneda || DEFAULTS[:moneda]),
+        monto:                monto,
+        descripcion:          descripcion[0..79],
+        correo_electronico:   correo_electronico[0..49],
+        cod_pais:             (cod_pais || DEFAULTS[:cod_pais]),
+        ciudad:               ciudad,
+        direccion:            direccion,
+        num_tel:              num_tel[0..14],
+        id_usuario_comercio:  id_usuario_comercio,
+        nombres:              nombres[0..49],
+        apellidos:            apellidos[0..49]
+      }.to_json
+    end
+  end
+end

data/lib/culqi/version.rb

@@ -0,0 +1,3 @@
+module Culqi
+  VERSION = '1.1.8'
+end

data/lib/culqi.rb

@@ -0,0 +1,12 @@
+require 'culqi/encryptor'
+require 'culqi/sale'
+require 'culqi/client'
+
+module Culqi
+  def self.default_client
+    variables = %w{CULQI_KEY CULQI_ENDPOINT CULQI_CODIGO_COMERCIO}
+    missing = variables - ENV.keys
+    raise "The following env vars are missing and are needed to use this gem: #{missing.join(', ')}." unless missing.empty?
+    Client.new(ENV['CULQI_KEY'], ENV['CULQI_ENDPOINT'], ENV['CULQI_CODIGO_COMERCIO'])
+  end
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: culqi
+version: !ruby/object:Gem::Version
+  version: 1.1.8
+platform: ruby
+authors:
+- Augusto Samame
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-05-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: |-
+  This gem allows your Ruby (1.9.2+) or Rails (3.2+) app to quickly integrate with Culqi Payment processor.
+                            It handles Culqi's flavor of encryption, decryption and Culqi ticket creation.
+email:
+- augustosamame@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- culqi.gemspec
+- lib/culqi.rb
+- lib/culqi/client.rb
+- lib/culqi/encryptor.rb
+- lib/culqi/sale.rb
+- lib/culqi/version.rb
+homepage: https://github.com/augustosamame/culqiruby
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.4
+signing_key: 
+specification_version: 4
+summary: Facilitates integration with Culqi payment processor
+test_files: []