maxipago-sdk-ruby: A Ruby repository from noelrocha

Adicionar a GEM na sua aplicação Rails 3 ou Rails 4¶ ↑

Adicione ao Gemfile da sua aplicação a seguinte linha:

gem "maxipago", :git => "git://github.com/brunosoab/maxipago.git", :branch => "1.0.0.rc1"

Instalar inicializador da GEM¶ ↑

rails generate maxipago:install

Maxipago¶ ↑

Usamos o maxipago.net (Maxipago) para relizar transações financeiras dentro do aplicativo da Liga das Torcidas.

A construção da biblioteca foi realizada em cima do manual da *API V1.3* e da API de transação V3.1.1.15. O histórico das revisões pode ser visto no manual. Atualmente cobre as funcionalidades até a versão *API V1.9.3*.

Para baixar o manual: www.maxipago.com/docs/maxiPago_API_Ultima.pdf

Para o ambiente de testes usamos as URLs fornecidas pelo Maxipago:

URL_TEST_TRANSACTION = “https//testapi.maxipago.net/UniversalAPI/postXML”
URL_TEST_API = “testapi.maxipago.net/UniversalAPI/postAPI”
URL_TEST_RAPI = “testapi.maxipago.net/ReportsAPI/servlet/ReportsAPI”

Cartões de teste:

American Express 378282246310005
American Express 371449635398431
MasterCard 5555555555554444
MasterCard 5105105105105100
Visa 4111111111111111
Visa 4012888888881881

O campo CVV pode ser preenchido com qualquer número entre *“3”* e *“4”* dígitos e a data de vencimento precisa ser válida. No futuro. Um cartão de teste já está adicionado ao arquivo de configuração da biblioteca. Veja mais detalhes sobre o uso nas seções posteriores.

No ambiente de testes nenhuma transação será de fato realizada. Todas as funcionalidades podem ser verificadas através dos testes da biblioteca na pasta:

spects/

Credenciamento dos Estabelecimentos¶ ↑

Para realizar uma acão usando a bibioteca maxipago é preciso incluir as credenciais do estabelecimento. Qualquer requisição a API do Maxipago precisa ser autenticada.

O local para incluir essas credenciais bem como dados de teste ficam localizado em:

config/initializers/maxipago_config.rb

Aqui segue um exemplo do seu conteudo:

# Set your key and id
MP_APIKEY = ENV['MP_APIKEY'] #use uma variável de ambiente
MP_ID = ENV['MP_ID'] #use uma variável de ambiente

# Set the Maxipago API version: currently (3.1.1.15)
MP_APIVERSION = "3.1.1.15"

# Maxipago API Urls - production
MP_URL_TRANSACTION = "https://api.maxipago.net/UniversalAPI/postXML"
MP_URL_API = "https://api.maxipago.net/UniversalAPI/postAPI"
MP_URL_RAPI =  "https://api.maxipago.net/ReportsAPI/servlet/ReportsAPI"

# Maxipago API Urls - development and test
URL_TEST_TRANSACTION = "https://testapi.maxipago.net/UniversalAPI/postXML"
URL_TEST_API = "https://testapi.maxipago.net/UniversalAPI/postAPI"
URL_TEST_RAPI = "https://testapi.maxipago.net/ReportsAPI/servlet/ReportsAPI"

Use uma variável de ambiente para sua key do maxipago e seu id.

Tests (Rspec)¶ ↑

rspec spec

Como usar?¶ ↑

Crie um client onde podemos executar comandos:

mp = Maxipago::Client.new
=> #<Maxipago::Client:0x007fb1f3d171d8>

Crie um request do tipo da api que queremos usar (api, transaction ou rapi):

api = Maxipago::RequestBuilder::ApiRequest.new(MAX_ID, MAX_APIKEY)
=> #<Maxipago::RequestBuilder::ApiRequest:0x007fb1f3d2f440 @maxid="100", @apikey="21g8u6gh6szw1gywfs165vui", @api_version="3.1.1.15", @header={"Content-Type"=>"text/xml"}>

Faça o client carregar o request gerado no passo anterior:

mp.use(api)
=> #<Maxipago::RequestBuilder::ApiRequest:0x007fb1f3d2f440 @maxid="100", @apikey="21g8u6gh6szw1gywfs165vui", @api_version="3.1.1.15", @header={"Content-Type"=>"text/xml"}>

Execute um comando da api escolhida:

mp.execute({command: "add_consumer", customer_id_ext: "1", firstname: "Foo", lastname: "Bar"})
=> {:header=>#<Net::HTTPOK 200 OK readbody=true>, :body=>"<?xml version=\"1.0\" encoding=\"UTF-8\" ?><api-response><errorCode>0</errorCode><errorMessage></errorMessage><command>add-consumer</command><time>1371687537124</time><result><customerId>14289</customerId></result></api-response>", :message=>"OK"}

Verifique os testes na pasta spec/ do repositório para ver mais exemplos de uso. Os testes cobrem todos os comandos suportados.

Licença de uso¶ ↑

Licensed under the Apache License, Version 2.0 (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

noelrocha/maxipago-sdk-ruby