README.md in mundipagg_api-1.0.0 vs README.md in mundipagg_api-1.0.1

@@ -1,7 +1,20 @@
 # mundipagg-one-ruby
 
+### Mundipagg Gem Download
+https://rubygems.org/gems/mundipagg_api
+
+```ruby
+$ gem install mundipagg_api
+```
+
+```ruby
+require 'mundipagg_api'
+```
+
+Ruby DevKit is required.
+
 ### 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.
@@ -17,45 +30,55 @@
 $ gem install rspec
 $ gem install nori
 $ gem install gyoku
 $ gem install nokogiri
 $ gem install ffi
+$ gem install bundler
 ```
 ### Bundler
 Run the following commands to install gems:
 
 Rode os seguintes comandos para instalar as gems:
 ```ruby
 $ gem install bundler
 $ bundle install
 ```
 
-Running tests:
+Running tests with `bundle exec`:
 
-Rodando testes:
+Rodando testes com `bundle exec`:
 ```ruby
 $ bundle exec rspec spec/integration/gateway_spec.rb
 ```
 
+Running tests with `rake`:
+
+Rodando testes com `rake`:
+
+```ruby
+$ rake
+```
+
 ## Code Examples
 
 ### Create a Credit Card Transaction
 ```ruby
-require_relative '../../lib/mundipagg'
+require 'mundipagg_api'
 
 # 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)
+gateway = MundipaggApi.new(:production, merchantKey)
 
 # coleta dados do cartão
 creditCardTransaction = CreditCardTransaction.new
 creditCardTransaction.AmountInCents = 100
 creditCardTransaction.InstallmentCount = 1
 creditCardTransaction.TransactionReference = 'CreditCard One RubySDK Test'
+creditCardTransaction.CreditCardOperation = 'AuthOnly'
 creditCardTransaction.Options.PaymentMethodCode = 1
 creditCardTransaction.Options.SoftDescriptorText = 'My Store Name'
 creditCardTransaction.CreditCard.CreditCardNumber = '5453010000066167'
 creditCardTransaction.CreditCard.ExpMonth = 5
 creditCardTransaction.CreditCard.ExpYear = 18
@@ -72,18 +95,18 @@
 ```
 
 
 ### Create a BoletoTransaction
 ```ruby
-require_relative '../../lib/mundipagg'
+require 'mundipagg_api'
 
 # 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)
+gateway = MundipaggApi.new(:production, merchantKey)
 
 # instancia um objeto de transação de boleto
 boletoTransaction = BoletoTransaction.new
 boletoTransaction.AmountInCents = 100
 boletoTransaction.BankNumber = '237'
@@ -104,17 +127,17 @@
 ```
 
 
 ### Cancel Method
 ```ruby
-require_relative '../../lib/mundipagg'
+require 'mundipagg_api'
 
 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)
+gateway = MundipaggApi.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'
@@ -123,28 +146,25 @@
 # 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'
+require 'mundipagg_api'
 
 # 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)
+gateway = MundipaggApi.new(merchantKey)
 
 # itens necessários para captura da transacão
 captureCreditCardTransactionItem = ManageCreditCardTransaction.new
 captureCreditCardTransactionItem.AmountInCents = 100
 captureCreditCardTransactionItem.TransactionKey = 'transactionKey da transação'
@@ -162,17 +182,17 @@
 ```
 
 
 ### Retry Method
 ```ruby
-require_relative '../../lib/mundipagg'
+require 'mundipagg_api'
 
 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)
+gateway = MundipaggApi.new(:staging, merchantKey)
 
 retrySaleRequest = RetrySaleRequest.new
 retrySaleCreditCardTransactionItem = RetrySaleCreditCardTransaction.new
 
 # preenche um item de coleção
@@ -190,18 +210,18 @@
 ```
 
 
 ### Query Method
 ```ruby
-require_relative '../../lib/mundipagg'
+require 'mundipagg_api'
 
 # 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)
+gateway = MundipaggApi.new(merchantKey)
 
 # inicializa a QuerySaleRequest
 querySaleRequest = QuerySaleRequest.new
 
 # preenche o campo de OrderKey para enviar um request de OrderKey
@@ -223,36 +243,36 @@
 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'
+require 'mundipagg_api'
 
 # 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)
+gateway = MundipaggApi.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'
+require 'mundipagg_api'
 
 # 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)
+gateway = MundipaggApi.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
@@ -263,18 +283,18 @@
 ##### 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'
+require 'mundipagg_api'
 
 # 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)
+gateway = MundipaggApi.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
@@ -287,17 +307,17 @@
 ##### 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'
+require 'mundipagg_api'
 
 # 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)
+gateway = MundipaggApi.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