redex 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4cf86d74ee9fea2686018fceeb710d82307c04cc
+  data.tar.gz: b6724f7205af4724e07253e192eba751d6ce2cd3
+SHA512:
+  metadata.gz: 2aae59ffbc39d9a03ad04efcf110dfa79389fabddf8a614b6a5d680b372c322c6204b8a62263fbf93d66256166b86602fecebe94b8dd8b55bc3f4d94c1067905
+  data.tar.gz: 19db95288a1573e6c3c446eae92b5783c35c05c65b077ffec531e4ec038e917ac409cb4351bfa669f1572d155f9f256de602249783d8b6e8d2b350f78b797a25

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+docker-compose.yml

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

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

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in redex.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 REDEX
+
+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,105 @@
+# Redex
+
+Uma refatoração da gem de integração para o sistema de pagamentos [eRede](https://www.userede.com.br/nossos-produtos/e-rede/)
+
+O objetivo desta gem é normalizar nomes de campos, permitir o uso de classes do ruby na chamada serviços e mascarar a comunicação com um servidor SOAP (utilizando a gem [canned_soap](http://github.com/gknedo/canned_soap))
+
+## Funcionalidades
+Resumo das operações suportadas pelo Redex.
+
+### Transações de Crédito
+
+Todas as transações com autorização (captura) automática são suportadas. Apesar de transações de pré-autorização (sem captura) automática serem suportadas, a trasanção de captura ainda não foi desenvolvida.
+
+### Cancelamento
+
+O cancelamento de transações de crédito são suportadas, mas assim como o serviço SOAP da eRede elas devem ser feitas no mesmo dia da captura. Transações de pré-autorização são suportadas e podem ser canceladas em até 29 dias da pré-autorização, após esse período elas são canceladas automaticamente
+
+### Consulta
+
+Consultas são suportadas.
+
+## Funcionalidades não desenvolvidas ou em desenvolvimento
+
+### Transações Autenticadas (3D Security)
+
+Transações autenticadas, seja de débito ou crédito, ainda não são suportadas.
+
+
+## Instalação
+
+Adicione esta linha no seu Gemfile:
+
+```ruby
+gem 'redex'
+```
+
+Então execute:
+
+    $ bundle
+
+Para instalar sem o bundle:
+
+    $ gem install redex
+
+## Utilização
+
+### Guia Rápido
+
+Todas as requisições suportadas são utilizadas via sua respectiva classe, que ficam dentro do modulo `Redex::Request`, elas são inicializadas como um objeto padrão do ruby e são executadas ao chamar o método `result` e retornaram objetos do tipo response, que são do módulo `Redex::Response`.
+
+*Objetos do tipo Request executam o request somente na primeira chamada do método result!*
+
+Exemplo de uso:
+
+```ruby
+request = Redex::Request::QueryRequest.new(transaction: 123456789)
+response = request.result #Redex::Response::QueryResponse
+response.credit_card_authorization_id
+```
+### Configuração
+
+Antes de iniciar, é necessário configurar a autorização e a URL do servidor. Esta configuração pode ser sobrescrita em qualquer lugar do seu código.
+
+```ruby
+Redex.configuration do |config|
+  config.secret_pv = 123456789 # Seu Numero de Filiacao
+  config.secret_token = "1a2b3c4d5f6f7g8h90" # Sua senha
+  config.service_url = 'https://scommerce.userede.com.br/example'
+end
+```
+
+Por padrão o `service_url` vem configurado com o ambiente de testes do eRede.
+
+### Transação de Crédito
+
+Requests são feitas utilizando a classe `Redex::Request::TransactionRequest`.
+
+| Redex | Tipo do Campo | Equivalente SOAP | Observações |
+| --- | --- | --- | --- |
+| order_id | String | NUMPEDIDO |
+| amount | Integer ou Float | TOTAL
+| card_number | Integer ou String | NRCARTAO |
+| card_holder_name | String | PORTADOR |
+| card_cvc | Integer ou String | CVC2 |
+| card_expiration_month | Integer ou String | MÊS
+| card_expiration_year | Integer ou String | ANO
+| installments | Integer ou String | PARCELAS | Padrão: 1
+| recorrence | Boolean | RECORRENTE | Padrão: false
+| | | ORIGEM | Sempre será 01 (eRede)
+| | | TRANSACAO | Calculado pela gem
+
+
+## Desenvolvimento
+
+Após clonar o repositório, execute `bin/setup` para instalar as dependências. Para rodar os testes execute `rake spec`. Você também pode executar `bin/console` para um console interativo.
+
+Para instalar essa gem na sua máquina local execute `bundle exec rake install`. Para gerar uma nova versão atualize o arquivo `version.rb` e então execute `bundle exec rake release`, isto irá criar uma tag do git para a versão, faça o commit e o push do repositório, e então envie o arquivo `.gem` para [rubygems.org](https://rubygems.org).
+
+## Contribua
+
+Bug reports e pull requests são bem vindos no nosso GitHub at https://github.com/gknedo/redex. Este projeto visa ser um lugar seguro e receptivo para novos colaborados e é esperado que os contribuidores sigam o [Código de Conduta](http://contributor-covenant.org).
+
+## 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,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "redex"
+
+# 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(__FILE__)

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/lib/helpers/configuration.rb

@@ -0,0 +1,23 @@
+module Configuration
+
+	def configuration
+		yield self
+	end
+
+	def define_setting(name, default = nil)
+		class_variable_set("@@#{name}", default)
+		define_class_method "#{name}=" do |value|
+			class_variable_set("@@#{name}", value)
+		end
+		define_class_method name do
+			class_variable_get("@@#{name}")
+		end
+	end
+
+	private
+	def define_class_method(name, &block)
+		(class << self; self; end).instance_eval do
+			define_method name, &block
+		end
+	end
+end

data/lib/redex.rb

@@ -0,0 +1,14 @@
+require 'canned_soap'
+
+require "redex/version"
+require "redex/request/base_request"
+require "redex/response/base_response"
+require "helpers/configuration"
+
+module Redex
+	extend Configuration
+
+	define_setting :secret_pv
+	define_setting :secret_token
+	define_setting :service_url, 'https://scommerce.userede.com.br/Redecard.Komerci.External.WcfKomerci/KomerciWcf.svc'
+end

data/lib/redex/request/base_request.rb

@@ -0,0 +1,33 @@
+module Redex::Request
+	class BaseRequest
+		def self.client
+    	@client ||= CannedSoap::Client.new(Redex.service_url)
+  	end
+
+		def authorization_params
+			{
+				Filiacao: Redex.secret_pv.to_s,
+				Senha: Redex.secret_token.to_s
+			}
+		end
+
+		def result
+			@result ||= do_request
+		end
+
+		def sanitize(field)
+			return nil if send(field).nil?
+			return "%.2f" % send(field) if [:amount].include?(field)
+			return "%02d" % send(field) if [:installments, :card_expiration_month, :origin].include?(field)
+			return card_expiration_year_sanitized if [:card_expiration_year].include?(field)
+			return send(field) ? "1" : "0" if [:recorrence].include?(field)
+			return send(field).to_s if [:order_id, :credit_card_authorization_id, :sequential_id, :transaction_id, :card_number].include?(field)
+			return send(field).strftime("%Y%m%d") if [:transaction_date].include?(field)
+			send(field)
+		end
+	end
+end
+
+require 'redex/request/transaction_request'
+require 'redex/request/cancel_request'
+require 'redex/request/query_request'

data/lib/redex/request/cancel_request.rb

@@ -0,0 +1,29 @@
+module Redex
+	module Request
+		class CancelRequest < BaseRequest
+			attr_accessor :transaction_date, :credit_card_authorization_id, :sequential_id, :transaction_id
+
+      def initialize(params = {})
+				@transaction_date = params[:transaction_date]
+				@credit_card_authorization_id = params[:credit_card_authorization_id]
+				@sequential_id = params[:sequential_id]
+				@transaction_id = params[:transaction_id]
+      end
+
+			def sanitized_fields
+				{
+					Data: sanitize(:transaction_date),
+					NumAutor: sanitize(:credit_card_authorization_id),
+					NumSqn: sanitize(:sequential_id),
+					Tid: sanitize(:transaction_id)
+				}.merge(authorization_params).sort.to_h.select { |k, v| !v.to_s.empty?  }
+			end
+
+			private
+			def do_request
+				raw_response = BaseRequest.client.VoidTransactionTID(request: sanitized_fields)
+				Redex::Response::CancelResponse.new(raw_response.result)
+			end
+    end
+  end
+end

data/lib/redex/request/query_request.rb

@@ -0,0 +1,25 @@
+module Redex
+	module Request
+		class QueryRequest < BaseRequest
+			attr_accessor :order_id, :transaction_id
+
+      def initialize(params = {})
+				@order_id = params[:order_id]
+				@transaction_id = params[:transaction_id]
+      end
+
+			def sanitized_fields
+				{
+          NumPedido: sanitize(:order_id),
+          Tid: sanitize(:transaction_id),
+				}.merge(authorization_params).sort.to_h.select { |k, v| !v.to_s.empty?  }
+			end
+
+			private
+			def do_request
+				raw_response = BaseRequest.client.Query(request: sanitized_fields)
+				Redex::Response::QueryResponse.new(raw_response.result)
+			end
+    end
+  end
+end

data/lib/redex/request/transaction_request.rb

@@ -0,0 +1,62 @@
+module Redex
+	module Request
+		class TransactionRequest < BaseRequest
+			attr_accessor :order_id, :amount, :installments, :invoice_note,
+										:card_number, :card_cvc, :card_holder_name,
+										:card_expiration_month, :card_expiration_year,
+										:auto_capture
+			attr_reader :recorrence, :origin
+
+	    def initialize(params = {})
+				@order_id = params[:order_id]
+				@amount = params[:amount]
+				@installments = params.fetch(:installments, 1)
+				@invoice_note = params[:invoice_note]
+				@card_number = params[:card_number]
+				@card_cvc = params[:card_cvc]
+				@card_holder_name = params[:card_holder_name]
+				@card_expiration_month = params[:card_expiration_month]
+				@card_expiration_year = params[:card_expiration_year]
+				@auto_capture = params.fetch(:auto_capture, true)
+	      @recorrence = params.fetch(:recorrence, false)
+	      @origin = 1
+	    end
+
+			def sanitized_fields
+				{
+					NumPedido: sanitize(:order_id),
+					Total: sanitize(:amount),
+					Parcelas: sanitize(:installments),
+					IdentificacaoFatura: sanitize(:invoice_note),
+					Nrcartao: sanitize(:card_number),
+					Cvc2: sanitize(:card_cvc),
+					Portador: sanitize(:card_holder_name),
+					Mes: sanitize(:card_expiration_month),
+					Ano: sanitize(:card_expiration_year),
+					Recorrente: sanitize(:recorrence),
+					Origem: sanitize(:origin),
+					Transacao: transaction_type
+				}.merge(authorization_params).sort.to_h.select { |k, v| !v.to_s.empty?  }
+			end
+
+			private
+
+			def do_request
+				raw_response = BaseRequest.client.GetAuthorizedCredit(request: sanitized_fields)
+				Redex::Response::TransactionResponse.new(raw_response.result)
+			end
+
+			def transaction_type
+				return "74" unless @auto_capture
+				return "08" if installments > 1
+				"04"
+			end
+
+			def card_expiration_year_sanitized
+				year = card_expiration_year
+				year += 2000 if year < 100
+				year.to_s
+			end
+		end
+	end
+end

data/lib/redex/response/base_response.rb

@@ -0,0 +1,43 @@
+module Redex
+	module Response
+		class BaseResponse
+			attr_reader :raw, :code, :message, :sequential_id, :transaction_id
+
+			def initialize(raw_response)
+				@raw = clear(raw_response)
+			end
+
+			def clear(httpi_result)
+				httpi_result = Hash[httpi_result.map { |k, v| [k.to_sym, v] }]
+				httpi_result.select! {|k,v| v != [{"i:nil"=>"true"}]}
+				httpi_result.each { |k, v| httpi_result[k] = v.first }
+			end
+
+			def code
+				@code ||= @raw[:CodRet].to_i
+			end
+
+			def message
+				@message ||= @raw[:Msgret]
+			end
+
+			def sequential_id
+				@sequential_id ||= @raw[:NumSqn].to_i
+			end
+
+			def transaction_id
+				@transaction_id ||= @raw[:Tid].to_i
+			end
+
+			def datetime_sanitize(raw_date, raw_time)
+				if raw_date && raw_time
+					DateTime.strptime(raw_date + raw_time + '-03:00', '%Y%m%d%H:%M:%S%z')
+				end
+			end
+		end
+	end
+end
+
+require 'redex/response/transaction_response'
+require 'redex/response/cancel_response'
+require 'redex/response/query_response'

data/lib/redex/response/cancel_response.rb

@@ -0,0 +1,14 @@
+module Redex
+	module Response
+		class CancelResponse < BaseResponse
+			attr_reader :canceled_at
+			def initialize(httpi_response)
+				super(httpi_response)
+			end
+
+			def canceled_at
+				@canceled_at ||= datetime_sanitize(@raw[:Data], @raw[:Hora])
+			end
+		end
+	end
+end

data/lib/redex/response/query_response.rb

@@ -0,0 +1,86 @@
+module Redex
+	module Response
+		class QueryResponse < BaseResponse
+			attr_reader :canceled_at, :amount, :transaction_type, :installments, :order_id,
+				:card_number, :transaction_id, :card_expiration_month, :card_holder_name,
+				:invoice_note, :origin, :status, :transaction_created_at, :credit_card_authorization_id,
+				:code, :message
+			def initialize(httpi_response)
+				super(httpi_response["REGISTRO"])
+			end
+
+			def amount
+				@amount ||= @raw[:TOTAL].to_f
+			end
+
+			def transaction_type
+				@transaction_type ||= @raw[:TRANSACAO].to_f
+			end
+
+			def installments
+				@installments ||= @raw[:PARCELAS].to_f
+			end
+
+			def order_id
+				@order_id ||= @raw[:NUMPEDIDO]
+			end
+
+			def card_number
+				@card_number ||= @raw[:NR_CARTAO]
+			end
+
+			def sequential_id
+				@sequential_id ||= @raw[:NUMSQN].to_i
+			end
+
+			def card_expiration_month
+				@card_expiration_month ||= @raw[:MES].to_i
+			end
+
+			def invoice_note
+				@invoice_note ||= @raw[:IDENTIFICACAOFATURA]
+			end
+
+			def card_holder_name
+				@card_holder_name ||= @raw[:NOM_PORTADOR]
+			end
+
+			def origin
+				@origin ||= @raw[:ORIGEM].to_i
+			end
+
+			def status
+				@status ||= @raw[:STATUS].to_i
+			end
+
+			def code
+				@code ||= @raw[:COD_RET].to_i
+			end
+
+			def message
+				@message ||= @raw[:MSG_RET]
+			end
+
+			def credit_card_authorization_id
+				@credit_card_authorization_id ||= @raw[:NUMAUTOR].to_i
+			end
+
+			def transaction_created_at
+				@transaction_created_at ||= datetime_sanitize(@raw[:DATA], @raw[:HORA])
+			end
+
+			def transaction_canceled_at
+				@transaction_canceled_at ||= datetime_sanitize(@raw[:DATA], "00:00:00")
+			end
+
+
+			def clear(httpi_result)
+				httpi_result = httpi_result.first
+				httpi_result.delete("AVS")
+				httpi_result = Hash[httpi_result.map { |k, v| [k.to_sym, v] }]
+				httpi_result.select! {|k,v| v != [{}] && v!= [{"i:nil"=>"true"}]}
+				httpi_result.each { |k, v| httpi_result[k] = v.first }
+			end
+		end
+	end
+end

data/lib/redex/response/transaction_response.rb

@@ -0,0 +1,19 @@
+module Redex
+	module Response
+		class TransactionResponse < BaseResponse
+			attr_reader :order_id, :created_at, :credit_card_authorization_id
+
+			def order_id
+				@order_id ||= @raw[:NumPedido]
+			end
+
+			def credit_card_authorization_id
+				@credit_card_authorization_id ||= @raw[:NumAutor].to_i
+			end
+
+			def created_at
+				@created_at ||= datetime_sanitize(@raw[:Data], @raw[:Hora])
+			end
+		end
+	end
+end

data/lib/redex/version.rb

@@ -0,0 +1,3 @@
+module Redex
+  VERSION = "0.1.0"
+end

data/redex.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "redex/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "redex"
+  spec.version       = Redex::VERSION
+  spec.authors       = ["Ateliê de Software - Webgoal", "Aluan Henrique" "Gustavo Canedo"]
+  spec.email         = ["contato@atelie.software"]
+
+  spec.summary       = %q{Uma gem para integração com o sistema de pagamentos eRede}
+  spec.homepage      = "https://github.com/webgoal/redex"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_dependency "canned_soap", "~>0.1", ">=0.1.2"
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: redex
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ateliê de Software - Webgoal
+- Aluan HenriqueGustavo Canedo
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-08-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: canned_soap
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.2
+description: 
+email:
+- contato@atelie.software
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/helpers/configuration.rb
+- lib/redex.rb
+- lib/redex/request/base_request.rb
+- lib/redex/request/cancel_request.rb
+- lib/redex/request/query_request.rb
+- lib/redex/request/transaction_request.rb
+- lib/redex/response/base_response.rb
+- lib/redex/response/cancel_response.rb
+- lib/redex/response/query_response.rb
+- lib/redex/response/transaction_response.rb
+- lib/redex/version.rb
+- redex.gemspec
+homepage: https://github.com/webgoal/redex
+licenses:
+- MIT
+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.6.12
+signing_key: 
+specification_version: 4
+summary: Uma gem para integração com o sistema de pagamentos eRede
+test_files: []