mundipagg_api 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4f3af34ad338ba8f6450d017fb564c35536b1314
+  data.tar.gz: 75cd5c0a4a7c72405bbdc4ca9874a4d38442c8b2
+SHA512:
+  metadata.gz: e1449e71011163fea0a6de30e2105bde67230904d466517d0a6625be6594eb432a892c1750ec9e1d077dd02ce700dd44b8297727d8d27ae34e2d10fe74df9310
+  data.tar.gz: dababa97aceb0bfd6717966d414f68f85fb40edc0f68185360b0404dde479cd83bbebd01b78be3f838fd7cd3729c14a4ba81bb094ffbd623ddfcc84c34645dd6

data/LICENSE

@@ -0,0 +1,191 @@
+Apache License
+Version 2.0, January 2004
+http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+"License" shall mean the terms and conditions for use, reproduction, and
+distribution as defined by Sections 1 through 9 of this document.
+
+"Licensor" shall mean the copyright owner or entity authorized by the copyright
+owner that is granting the License.
+
+"Legal Entity" shall mean the union of the acting entity and all other entities
+that control, are controlled by, or are under common control with that entity.
+For the purposes of this definition, "control" means (i) the power, direct or
+indirect, to cause the direction or management of such entity, whether by
+contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the
+outstanding shares, or (iii) beneficial ownership of such entity.
+
+"You" (or "Your") shall mean an individual or Legal Entity exercising
+permissions granted by this License.
+
+"Source" form shall mean the preferred form for making modifications, including
+but not limited to software source code, documentation source, and configuration
+files.
+
+"Object" form shall mean any form resulting from mechanical transformation or
+translation of a Source form, including but not limited to compiled object code,
+generated documentation, and conversions to other media types.
+
+"Work" shall mean the work of authorship, whether in Source or Object form, made
+available under the License, as indicated by a copyright notice that is included
+in or attached to the work (an example is provided in the Appendix below).
+
+"Derivative Works" shall mean any work, whether in Source or Object form, that
+is based on (or derived from) the Work and for which the editorial revisions,
+annotations, elaborations, or other modifications represent, as a whole, an
+original work of authorship. For the purposes of this License, Derivative Works
+shall not include works that remain separable from, or merely link (or bind by
+name) to the interfaces of, the Work and Derivative Works thereof.
+
+"Contribution" shall mean any work of authorship, including the original version
+of the Work and any modifications or additions to that Work or Derivative Works
+thereof, that is intentionally submitted to Licensor for inclusion in the Work
+by the copyright owner or by an individual or Legal Entity authorized to submit
+on behalf of the copyright owner. For the purposes of this definition,
+"submitted" means any form of electronic, verbal, or written communication sent
+to the Licensor or its representatives, including but not limited to
+communication on electronic mailing lists, source code control systems, and
+issue tracking systems that are managed by, or on behalf of, the Licensor for
+the purpose of discussing and improving the Work, but excluding communication
+that is conspicuously marked or otherwise designated in writing by the copyright
+owner as "Not a Contribution."
+
+"Contributor" shall mean Licensor and any individual or Legal Entity on behalf
+of whom a Contribution has been received by Licensor and subsequently
+incorporated within the Work.
+
+2. Grant of Copyright License.
+
+Subject to the terms and conditions of this License, each Contributor hereby
+grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free,
+irrevocable copyright license to reproduce, prepare Derivative Works of,
+publicly display, publicly perform, sublicense, and distribute the Work and such
+Derivative Works in Source or Object form.
+
+3. Grant of Patent License.
+
+Subject to the terms and conditions of this License, each Contributor hereby
+grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free,
+irrevocable (except as stated in this section) patent license to make, have
+made, use, offer to sell, sell, import, and otherwise transfer the Work, where
+such license applies only to those patent claims licensable by such Contributor
+that are necessarily infringed by their Contribution(s) alone or by combination
+of their Contribution(s) with the Work to which such Contribution(s) was
+submitted. If You institute patent litigation against any entity (including a
+cross-claim or counterclaim in a lawsuit) alleging that the Work or a
+Contribution incorporated within the Work constitutes direct or contributory
+patent infringement, then any patent licenses granted to You under this License
+for that Work shall terminate as of the date such litigation is filed.
+
+4. Redistribution.
+
+You may reproduce and distribute copies of the Work or Derivative Works thereof
+in any medium, with or without modifications, and in Source or Object form,
+provided that You meet the following conditions:
+
+You must give any other recipients of the Work or Derivative Works a copy of
+this License; and
+You must cause any modified files to carry prominent notices stating that You
+changed the files; and
+You must retain, in the Source form of any Derivative Works that You distribute,
+all copyright, patent, trademark, and attribution notices from the Source form
+of the Work, excluding those notices that do not pertain to any part of the
+Derivative Works; and
+If the Work includes a "NOTICE" text file as part of its distribution, then any
+Derivative Works that You distribute must include a readable copy of the
+attribution notices contained within such NOTICE file, excluding those notices
+that do not pertain to any part of the Derivative Works, in at least one of the
+following places: within a NOTICE text file distributed as part of the
+Derivative Works; within the Source form or documentation, if provided along
+with the Derivative Works; or, within a display generated by the Derivative
+Works, if and wherever such third-party notices normally appear. The contents of
+the NOTICE file are for informational purposes only and do not modify the
+License. You may add Your own attribution notices within Derivative Works that
+You distribute, alongside or as an addendum to the NOTICE text from the Work,
+provided that such additional attribution notices cannot be construed as
+modifying the License.
+You may add Your own copyright statement to Your modifications and may provide
+additional or different license terms and conditions for use, reproduction, or
+distribution of Your modifications, or for any such Derivative Works as a whole,
+provided Your use, reproduction, and distribution of the Work otherwise complies
+with the conditions stated in this License.
+
+5. Submission of Contributions.
+
+Unless You explicitly state otherwise, any Contribution intentionally submitted
+for inclusion in the Work by You to the Licensor shall be under the terms and
+conditions of this License, without any additional terms or conditions.
+Notwithstanding the above, nothing herein shall supersede or modify the terms of
+any separate license agreement you may have executed with Licensor regarding
+such Contributions.
+
+6. Trademarks.
+
+This License does not grant permission to use the trade names, trademarks,
+service marks, or product names of the Licensor, except as required for
+reasonable and customary use in describing the origin of the Work and
+reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty.
+
+Unless required by applicable law or agreed to in writing, Licensor provides the
+Work (and each Contributor provides its Contributions) on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied,
+including, without limitation, any warranties or conditions of TITLE,
+NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are
+solely responsible for determining the appropriateness of using or
+redistributing the Work and assume any risks associated with Your exercise of
+permissions under this License.
+
+8. Limitation of Liability.
+
+In no event and under no legal theory, whether in tort (including negligence),
+contract, or otherwise, unless required by applicable law (such as deliberate
+and grossly negligent acts) or agreed to in writing, shall any Contributor be
+liable to You for damages, including any direct, indirect, special, incidental,
+or consequential damages of any character arising as a result of this License or
+out of the use or inability to use the Work (including but not limited to
+damages for loss of goodwill, work stoppage, computer failure or malfunction, or
+any and all other commercial damages or losses), even if such Contributor has
+been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability.
+
+While redistributing the Work or Derivative Works thereof, You may choose to
+offer, and charge a fee for, acceptance of support, warranty, indemnity, or
+other liability obligations and/or rights consistent with this License. However,
+in accepting such obligations, You may act only on Your own behalf and on Your
+sole responsibility, not on behalf of any other Contributor, and only if You
+agree to indemnify, defend, and hold each Contributor harmless for any liability
+incurred by, or claims asserted against, such Contributor by reason of your
+accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work
+
+To apply the Apache License to your work, attach the following boilerplate
+notice, with the fields enclosed by brackets "[]" replaced with your own
+identifying information. (Don't include the brackets!) The text should be
+enclosed in the appropriate comment syntax for the file format. We also
+recommend that a file or class name and description of purpose be included on
+the same "printed page" as the copyright notice for easier identification within
+third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   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.

data/README.md

@@ -0,0 +1,308 @@
+# mundipagg-one-ruby
+
+### About Windows
+The recommended Windows version of Ruby is Ruby 2.1.
+For gems work correctly it'll be necessary run the following commands:
+
+No Windows a versão do Ruby recomendada é a 2.1.
+Para que todas as gemas funcionem corretamente é necessário realizar o seguinte processo:
+```ruby
+$ gem install rubygems-update
+$ update_rubygems
+$ gem update --system
+```
+### Required Gems
+```ruby
+$ gem install rest-client
+$ gem install rspec
+$ gem install nori
+$ gem install gyoku
+$ gem install nokogiri
+$ gem install ffi
+```
+### Bundler
+Run the following commands to install gems:
+
+Rode os seguintes comandos para instalar as gems:
+```ruby
+$ gem install bundler
+$ bundle install
+```
+
+Running tests:
+
+Rodando testes:
+```ruby
+$ bundle exec rspec spec/integration/gateway_spec.rb
+```
+
+## Code Examples
+
+### Create a Credit Card Transaction
+```ruby
+require_relative '../../lib/mundipagg'
+
+# passa a merchantKey na variável
+merchantKey = 'sua merchantKey'
+
+# instancia classe com métodos de requisição
+# :staging ou nada para ambiente sandbox e :production para ambiente de produção
+gateway = Gateway.new(:production, merchantKey)
+
+# coleta dados do cartão
+creditCardTransaction = CreditCardTransaction.new
+creditCardTransaction.AmountInCents = 100
+creditCardTransaction.InstallmentCount = 1
+creditCardTransaction.TransactionReference = 'CreditCard One RubySDK Test'
+creditCardTransaction.Options.PaymentMethodCode = 1
+creditCardTransaction.Options.SoftDescriptorText = 'My Store Name'
+creditCardTransaction.CreditCard.CreditCardNumber = '5453010000066167'
+creditCardTransaction.CreditCard.ExpMonth = 5
+creditCardTransaction.CreditCard.ExpYear = 18
+creditCardTransaction.CreditCard.HolderName = 'Maria do Carmo'
+creditCardTransaction.CreditCard.SecurityCode = '123'
+creditCardTransaction.CreditCard.CreditCardBrand = 'Mastercard'
+
+# cria a transação
+createSaleRequest = CreateSaleRequest.new
+createSaleRequest.CreditCardTransactionCollection << creditCardTransaction
+
+# faz a requisição de criação de transação, retorna um hash com a resposta
+response = gateway.CreateSale(createSaleRequest)
+```
+
+
+### Create a BoletoTransaction
+```ruby
+require_relative '../../lib/mundipagg'
+
+# passa a merchantKey na variável
+merchantKey = 'sua merchantKey'
+
+# instancia classe com métodos de requisição
+# :staging ou nada para ambiente sandbox e :production para ambiente de produção
+gateway = Gateway.new(:production, merchantKey)
+
+# instancia um objeto de transação de boleto
+boletoTransaction = BoletoTransaction.new
+boletoTransaction.AmountInCents = 100
+boletoTransaction.BankNumber = '237'
+boletoTransaction.DocumentNumber = '12345678901'
+boletoTransaction.Instructions = 'Pagar antes do vencimento'
+boletoTransaction.TransactionReference = 'BoletoTest#Ruby01'
+boletoTransaction.Options.CurrencyIso = 'BRL'
+boletoTransaction.Options.DaysToAddInBoletoExpirationDate = 5
+
+# instancia um objeto de request para fazer a criação de transação
+createSaleRequest = CreateSaleRequest.new
+
+# incrementa na coleção de boletos a transação de boleto criada
+createSaleRequest.BoletoTransactionCollection << boletoTransaction
+
+# faz a requisição de criação de transação, retorna um hash com a resposta
+response = gateway.CreateSale(createSaleRequest)
+```
+
+
+### Cancel Method
+```ruby
+require_relative '../../lib/mundipagg'
+
+merchantKey = 'Sua Merchant Key'
+
+# instancia classe com métodos de requisição
+# :staging para ambiente sandbox e :production para ambiente de produção
+gateway = Gateway.new(:staging, merchantKey)
+
+# preenche um item de colecao, necessario para cancelamento da transacao de cartao de credito
+cancelCreditCardTransactionItem = ManageCreditCardTransaction.new
+cancelCreditCardTransactionItem.AmountInCents = 100
+cancelCreditCardTransactionItem.TransactionKey = 'TransactionKey da transação'
+cancelCreditCardTransactionItem.TransactionReference = 'RubySDK-CancelTest'
+
+# monta o objeto para cancelamento de transação
+cancelSaleRequest = ManageSaleRequest.new
+cancelSaleRequest.OrderKey = 'OrderKey AQUI'
+cancelSaleRequest.CreditCardTransactionCollection << cancelCreditCardTransactionItem
+
+# incrementa na coleção o item de retry
+retrySaleRequest.RetrySaleCreditCardTransactionCollection << retrySaleCreditCardTransactionItem
+
+# faz a requisição de cancelamento, retorna um hash com a resposta
+response = gateway.Cancel(cancelSaleRequest)
+```
+
+
+### Capture Method
+```ruby
+require_relative '../../lib/mundipagg'
+
+# merchant key 
+merchantKey = 'sua merchantKey'
+
+# inicializa a classe com métodos de requisição
+# :staging ou nada para ambiente de sandbox e :production para ambiente de produção
+gateway = Gateway.new(merchantKey)
+
+# itens necessários para captura da transacão
+captureCreditCardTransactionItem = ManageCreditCardTransaction.new
+captureCreditCardTransactionItem.AmountInCents = 100
+captureCreditCardTransactionItem.TransactionKey = 'transactionKey da transação'
+captureCreditCardTransactionItem.TransactionReference = 'RubySDK-CaptureTest (referência da transação)'
+
+# monta o objeto para captura de transação
+captureSaleRequest = ManageSaleRequest.new
+captureSaleRequest.OrderKey = 'orderkey da transação'
+
+# incrementa na coleção de CreditCardTransactionCollection
+captureSaleRequest.CreditCardTransactionCollection << captureCreditCardTransactionItem
+
+# faz a requisição de captura e salva na variável response
+response = gateway.Capture(captureSaleRequest)
+```
+
+
+### Retry Method
+```ruby
+require_relative '../../lib/mundipagg'
+
+merchantKey = 'Sua Merchant Key'
+
+# instancia classe com métodos de requisição
+# :staging para ambiente sandbox e :production para ambiente de produção
+gateway = Gateway.new(:staging, merchantKey)
+
+retrySaleRequest = RetrySaleRequest.new
+retrySaleCreditCardTransactionItem = RetrySaleCreditCardTransaction.new
+
+# preenche um item de coleção
+retrySaleCreditCardTransactionItem.SecurityCode = '123'
+retrySaleCreditCardTransactionItem.TransactionKey = 'Transaction Key AQUI'
+
+# monta o objeto de retentativa
+retrySaleRequest.OrderKey = 'OrderKey AQUI'
+
+# incrementa na coleção o item de retry
+retrySaleRequest.RetrySaleCreditCardTransactionCollection << retrySaleCreditCardTransactionItem
+
+# faz a requisição de retentativa, retorna um hash com a resposta
+response = gateway.Retry(retrySaleRequest)
+```
+
+
+### Query Method
+```ruby
+require_relative '../../lib/mundipagg'
+
+# merchant key 
+merchantKey = 'sua merchantKey'
+
+# inicializa a classe com métodos de requisição
+# :staging ou nada para ambiente de sandbox e :production para ambiente de produção
+gateway = Gateway.new(merchantKey)
+
+# inicializa a QuerySaleRequest
+querySaleRequest = QuerySaleRequest.new
+
+# preenche o campo de OrderKey para enviar um request de OrderKey
+querySaleRequest.OrderKey = 'sua OrderKey'
+
+# faz a requisição de Query passando QuerySaleRequest.QuerySaleRequestEnum[:OrderKey] para indicar
+# que o método irá procurar por OrderKey e passa a OrderKey como segundo parâmetro
+# retorna um hash com a resposta
+responseQuery = gateway.Query(QuerySaleRequest.QuerySaleRequestEnum[:OrderKey], querySaleRequest.OrderKey)
+
+# se a requisição for por OrderReference ela é bem parecida com a de cima, mudando apenas algumas coisas:
+querySaleRequest.OrderReference = 'sua OrderReference'
+
+responseQuery = gateway.Query(QuerySaleRequest.QuerySaleRequestEnum[:OrderReference], querySaleRequest.OrderReference)
+```
+
+
+### ParseXmlToNotification
+The ParseXmlToNotification takes an XML and convert it to a hash variable.
+
+O ParseXmlToNotification converte um XML para uma variável hash.
+
+```ruby
+require_relative '../../lib/mundipagg'
+
+# merchant key 
+merchantKey = 'sua merchantKey'
+
+# inicializa a classe com métodos de requisição
+# :staging ou nada para ambiente de sandbox e :production para ambiente de produção
+gateway = Gateway.new(merchantKey)
+
+xml = 'xml que será passsado na variável'
+
+# faz a requisição de PostNotification (parse do XML) e retorna um hash do XML passado
+response = gateway.ParseXmlToNotification(xml)
+```
+
+
+### TransactionReportFile Method
+```ruby
+require_relative '../../lib/mundipagg'
+
+# merchant key 
+merchantKey = 'sua merchantKey'
+
+# inicializa a classe com métodos de requisição
+# :staging ou nada para ambiente de sandbox e :production para ambiente de produção
+gateway = Gateway.new(merchantKey)
+
+# cria uma variável do tipo Date, passando apenas o ano, mês e dia (nessa ordem)
+date = Date.new(2014, 12, 10)
+
+# faz a requisição do TransactionReportFile e retorna uma string com os dados do report
+response = gateway.TransactionReportFile(date)
+```
+
+
+##### TransactionReportFileParser
+If you want the string that is received from TransactionReportFile Method to be parsed, there is a method for that.
+
+Este método faz um parse na string recebida do método TransactionReportFile e retorna um hash.
+```ruby
+require_relative '../../lib/mundipagg'
+
+# merchant key 
+merchantKey = 'sua merchantKey'
+
+# inicializa a classe com métodos de requisição
+# :staging ou nada para ambiente de sandbox e :production para ambiente de produção
+gateway = Gateway.new(merchantKey)
+
+# cria uma variável do tipo Date, passando apenas o ano, mês e dia (nessa ordem)
+date = Date.new(2014, 12, 10)
+
+# faz a requisição do TransactionReportFile e retorna uma string com os dados do report
+request_to_parse = gateway.TransactionReportFile(date)
+
+# faz um parse da string do TransactionReportFile e retorna um hash com a resposta
+response = gateway.TransactionReportFileParser(request_to_parse)
+```
+
+##### TransactionReportFileDownloader
+This method download and save the TransactionReportFile to a '.txt' file.
+
+Este método faz o download e salva o TransactionReportFile em um arquivo '.txt' no local indicado.
+```ruby
+require_relative '../../lib/mundipagg'
+
+# merchant key 
+merchantKey = 'sua merchantKey'
+
+# inicializa a classe com métodos de requisição
+# :staging ou nada para ambiente de sandbox e :production para ambiente de produção
+gateway = Gateway.new(merchantKey)
+
+# cria uma variável do tipo Date, passando apenas o ano, mês e dia (nessa ordem)
+date = Date.new(2015, 9, 15)
+
+# faz a requisição do transaction report file e salva no destino passado como parâmetro
+# o segundo parâmetro é o nome do arquivo, e o terceiro é o local onde será salvo o arquivo
+# é salvo um arquivo em .txt no local indicado
+response = gateway.TransactionReportFileDownloader(date, 'Teste', "C:\\Users\\YourUser\\Desktop\\")
+```