README.markdown in pagseguro_client-0.2.0 vs README.markdown in pagseguro_client-0.3.0
- old
+ new
@@ -5,26 +5,28 @@
## Changelog
* Adicionado gerador para instalação da biblioteca em projetos Rails
* Adicionada opção para URL de retorno dinâmica
* Implementação parcial da [API de pagamentos](https://pagseguro.uol.com.br/v2/guia-de-integracao/api-de-pagamentos.html)
* Implementação parcial da [API de notificações](https://pagseguro.uol.com.br/v2/guia-de-integracao/notificacoes.html)
+* Implementação parcial da [API de
+ transações](https://pagseguro.uol.com.br/v2/guia-de-integracao/consulta-de-transacoes-por-codigo.html)
## Como usar
### Instalação
Adicione a biblioteca ao arquivo Gemfile:
```ruby
-gem 'pagseguro_client', git: "git://github.com/fknappe/pagseguro_client.git"
+gem 'pagseguro_client'
```
Depois de realizar a instalação da biblioteca, você precisará gerar o arquivo de configuração, que deve residir em config/pagseguro.yml. Para gerar o arquivo a partir de um modelo execute
rails generate pagseguro_client:install
-O arquivo de configuração gerado será parecido com isso:
+O arquivo de configuração gerado será parecido com isso:
```yaml
development: &development
ws_url: "http://localhost:4000"
ps_url: "http://localhost:4000"
@@ -99,11 +101,33 @@
* `PagseguroClient::Notification#code`: Código da notificação
* `PagseguroClient::Notification#order_id`: Código da sua ordem de pagamento
* `PagseguroClient::Notification#status`: Status da ordem de pagamento atual
* `PagseguroClient::Notification#payment_method`: Método utilizado para o pagamento
+* `PagseguroClient::Notification#client`: Dados do comprador
+* `PagseguroClient::Notification#address`: Endereço do comprador
+### Consultando Transações
+
+```ruby
+# No seu controller
+def complete
+
+ @transaction = PagseguroClient::Transaction.retrieve(params[:transaction_id_])
+ # Seu código para utilizar a transaction
+end
+```
+
+O objeto `transaction` possui os seguintes métodos:
+
+* `PagseguroClient::Transaction#code`: Código da notificação
+* `PagseguroClient::Transaction#order_id`: Código da sua ordem de pagamento
+* `PagseguroClient::Transaction#status`: Status da ordem de pagamento atual
+* `PagseguroClient::Transaction#payment_method`: Método utilizado para o pagamento
+* `PagseguroClient::Transaction#client`: Dados do comprador
+* `PagseguroClient::Transaction#address`: Endereço do comprador
+
#### Métodos de pagamento
* `credit_card`: Cartão de crédito
* `invoice`: Boleto
* `online_transfer`: Pagamento online
@@ -119,9 +143,11 @@
* `refunded`: Devolvido
* `canceled`: Cancelado
## Autor
Matheus Tardivo (<http://matheustardivo.com>)
+Raphael Costa (<http://raphaelcosta.net>)
+André Kupkovski (<http://kupkovski.github.com>)
## Licença:
(The MIT License)