pag_seguro 0.2.3 → 0.3.0

data/README.md

@@ -11,26 +11,28 @@ Esta gem foi desenvolvida para utilizar Ruby 1.9.2 ou superior, e não têm comp
 Adicione a `gem "pag_seguro"` ao seu Gemfile:
 
     gem 'pag_seguro'
-	
+
 Além disso, é necessário que tenha uma conta no pag seguro, e que habilite as seguintes configurações:
 
-    Em Integrações -> Token de segurança clique em Gerar novo token e guarde esta informação em local seguro
-    Em Integrações -> Pagamentos via API é necessário ativar a opção "Quero receber somente pagamentos via API."
-    Em Integrações -> Notificação de transações é necessário ativar a notificação de transações e definir a url de retorno
-	
+    Em [Integrações -> Token](https://pagseguro.uol.com.br/integracao/token-de-seguranca.jhtml) de segurança clique em Gerar novo token e guarde esta informação em local seguro
+    Em [Integrações -> Pagamentos via API](https://pagseguro.uol.com.br/integracao/pagamentos-via-api.jhtml) é necessário ativar a opção "Quero receber somente pagamentos via API."
+    Em [Integrações -> Notificação de transações](https://pagseguro.uol.com.br/integracao/notificacao-de-transacoes.jhtml) é necessário ativar a notificação de transações e definir a url de retorno
+
 ## Documentação
+
 ### Classes e Atributos
 
 A nomenclatura dos atributos e recursos (classes) esperados pelo PagSeguro foram mantidas porém usando o padrão de nomenclatura do ruby (ao invés do camelcase utilizado pelo pagseguro). Seguem os links das documentações dos atributos no pagseguro:
 
 * [API de pagamentos](https://pagseguro.uol.com.br/v2/guia-de-integracao/api-de-pagamentos.html#v2-item-api-de-pagamentos-parametros-api)
 * [API de notificação](https://pagseguro.uol.com.br/v2/guia-de-integracao/api-de-notificacoes.html)
+* [API de transações](https://pagseguro.uol.com.br/v2/guia-de-integracao/consulta-de-transacoes-por-codigo.html)
 
 ###  API de Pagamento
 
 Segue um exemplo de uso para criação de um pagamento no PagSeguro:
 
-    payment = PagSeguro::Payment.new(EMAIL, TOKEN)
+    payment = PagSeguro::Payment.new(email, token, id: invoice.id)
     
     payment.items = [
       PagSeguro::Item.new(id: 25, description: "A Bic Pen", amount: "1.50",  quantity: "4", shipping_cost: "1.00",  weight: 10),
@@ -45,7 +47,7 @@ Além dos items presentes no exemplo acima, é possível configurar `payment.sen
 
 Segue um exemplo mais completo do uso da api de pagamentos:
 
-    payment = PagSeguro::Payment.new(EMAIL, TOKEN)
+    payment = PagSeguro::Payment.new(email, token, id: invoice.id)
     
     payment.items = [
       PagSeguro::Item.new(id: 25, description: "A Bic Pen", amount: "1.50",  quantity: "4", shipping_cost: "1.00",  weight: 10),
@@ -71,21 +73,21 @@ Com exceção do atributo response (que é utilizado para armazenar a resposta e
 
 ### API de Notificação
 
-As notificações de alteração no status da compra no PagSeguro serão enviadas para a URL que tiver configurado na Notificação de transações (vide Instalação). Obs.: Até o momento o PagSeguro não permite configurar uma url dinâmica para envio das notificação ( e apenas permite uma url por conta ), então provavelemente será necessário que crie uma conta diferente no PagSeguro para cada sistema que desenvolver.
+As notificações de alteração no status da compra no PagSeguro serão enviadas para a URL que tiver configurado na [Notificação de transações](https://pagseguro.uol.com.br/v2/guia-de-integracao/consulta-de-transacoes-por-codigo.html). Obs.: Até o momento o PagSeguro não permite configurar uma url dinâmica para envio das notificação ( e apenas permite uma url por conta ), então provavelemente será necessário que crie uma conta diferente no PagSeguro para cada sistema que desenvolver.
 
 O código da notificação é enviado pelo PagSeguro através do parâmentro `notificationCode` em uma requisição do tipo POST. Segue um exemplo de uso da notificação em uma aplicação rails (este exemplo supõe a existência de um `resources :notifications` em suas rotas, e um modelo `Invoice` responsável pelos pagamentos):
 
     class NotificationsController < ApplicationController
       def create
-        EMAIL = "seu_email_cadastrado@nopagseguro.com.br"
-        TOKEN = "SEU_TOKEN_GERADO_NO_PAG_SEGURO"
-        NOTIFICATION_CODE = params(:notificationCode)
+        email = "seu_email_cadastrado@nopagseguro.com.br"
+        token = "SEU_TOKEN_GERADO_NO_PAG_SEGURO"
+        notification_code = params(:notificationCode)
         
-        notification = PagSeguro::Notification.new(EMAIL, TOKEN, NOTIFICATION_CODE)
+        notification = PagSeguro::Notification.new(email, token, notification_code)
         
         if notification.approved?
           # Idealmente faça alguns testes de sanidade, como notification.gross_amount, notification.item_count, etc
-          # notification.id referencia o id do payment, caso tenha sido configurado
+          # notification.id referencia o id do payment/invoice, caso tenha sido configurado
           # transacation_id identifica o código da transação no pag seguro
           Invoice.find(notification.id).approve!(notification.transaction_id)
         end
@@ -96,6 +98,26 @@ O código da notificação é enviado pelo PagSeguro através do parâmentro `no
       end
     end
 
+Para este exemplo, o url configurada na [Notificação de transações](https://pagseguro.uol.com.br/v2/guia-de-integracao/consulta-de-transacoes-por-codigo.html) poderia ser algo como `http://lojamodelo.com.br/notifications`
+
+### Consulta de Transações
+
+Para realizar a consulta de uma transação é preciso obter o código da transação. Este código é enviado nas Notificações de Transações do PagSeguro (de forma assíncrona), através do método `notification.transaction_id` ou de forma síncrona assim que o usuário retorna à loja após ter concluído a compra.
+
+Para buscar informações da transação de forma síncrona, é necessário que acesse sua conta no PagSeguro, e clique em [Integrações > Página de redirecionamento](https://pagseguro.uol.com.br/integracao/pagina-de-redirecionamento.jhtml) e ative o redirecionamento com o código da transação, definindo o nome do parâmetro que será enviado para sua aplicação (e.g.: http://lojamodelo.com.br/checkout?transaction_id=E884542-81B3-4419-9A75-BCC6FB495EF1 ). O redirecionamento para esta página é executado através de uma requisição GET.
+
+Caso queira utilizar uma URL dinâmica de retorno, é necessário ativar a página de redirecionamento dinâmico em [Integrações > Página de redirecionamento](https://pagseguro.uol.com.br/integracao/pagina-de-redirecionamento.jhtml), e passar o argumento `redirect_url` para o objeto PagSeguro::Payment:
+
+    PagSeguro::Payment.new(email, token, id: invoice.id, redirect_url: "http://lojamodelo.com.br/checkout")
+
+Você pode consultar as informações da transação através do `PagSeguro::Query`, que possui os mesmos attributos e métodos que `PagSeguro::Notification` para consulta da transação:
+
+    query = PagSeguro::Query.new(email, token, "E884542-81B3-4419-9A75-BCC6FB495EF1")
+
+    if query.approved?
+      # ...
+    end
+
 ## Validações
 
 Os modelos utilizados nesta gem utilizam as validações do ActiveModel (semelhantes às presentes em ActiveRecord/Rails) e incluem diversas validações, permitindo que se verifique a validade (utilizando object.valid?) dos dados antes de enviá-los ao PagSeguro. A gem não bloqueia o envio das informações caso os dados estejam inválidos, deixando este passo a cargo da sua aplicação, mas levanta erros caso o pag seguro retorne algum erro relativo às informações enviadas.
@@ -107,14 +129,18 @@ Esta gem possui testes extensivos utilizando Rspec. Para rodar os testes, altere
     bundle
     guard
 
+## Todo
+
+Adicionar código para realizar consultas ao [Histórico de Transações](https://pagseguro.uol.com.br/v2/guia-de-integracao/consulta-de-transacoes-por-intervalo-de-datas.html)
+
 ## Contribuindo
 
 Caso queira contribuir, faça um fork desta gem no [github](https://github.com/heavenstudio/pag_seguro), escreva os testes respectivos ao bug/feature desejados e faça um merge request.
 
-## TODO
+## Sobre
 
-Permitir realizar [consultas de transações](https://pagseguro.uol.com.br/v2/guia-de-integracao/consultas.html)
+Desenvolvida por [Stefano Diem Benatti](mailto:stefano@heavenstudio.com.br)
 
-## Sobre
+## Colaboradores
 
-Desenvolvida por [Stefano Diem Benatti](mailto:stefano@heavenstudio.com.br)
+Rafael Castilho (<http://github.com/castilhor>)

data/lib/pag_seguro/notification.rb

@@ -1,174 +1,16 @@
-# encoding: utf-8
-require 'net/https'
-
 module PagSeguro
-  class Notification
-    attr_accessor :data
-    
-    # possible status values
-    PAGSEGURO_PROCESSING        = 1
-    PAGSEGURO_IN_ANALYSIS       = 2
-    PAGSEGURO_APPROVED          = 3
-    PAGSEGURO_AVAILABLE         = 4
-    PAGSEGURO_DISPUTED          = 5
-    PAGSEGURO_RETURNED          = 6
-    PAGSEGURO_CANCELLED         = 7
-    
-    # possible type values
-    PAGSEGURO_PAYMENT           = 1
-    PAGSEGURO_TRANSFER          = 2
-    PAGSEGURO_ADDITION_OF_FUNDS = 3
-    PAGSEGURO_CHARGE            = 4
-    PAGSEGURO_BONUS             = 5
+  class Notification < Transaction
   
     def initialize(email = nil, token = nil, notification_code=nil)
       raise "Needs a notification code" if notification_code.blank?
       raise "Needs an email" if email.blank?
       raise "Needs a token" if token.blank?
-      @data = Nokogiri::XML(notification_data(email, token, notification_code))
+      @data = transaction_data(email, token, notification_code)
     end
       
-    def id
-      @data.css("reference").first.content
-    end
-    
-    def gross_amount
-      @data.css("grossAmount").first.content
-    end
-
-    def discount_amount
-      @data.css("discountAmount").first.content
-    end
-
-    def fee_amount
-      @data.css("feeAmount").first.content
-    end
-
-    def net_amount
-      @data.css("feeAmount").first.content
-    end
-
-    def extra_amount
-      @data.css("feeAmount").first.content
-    end
-
-    def installment_count
-      @data.css("itemCount").first.content.to_i
-    end
-    
-    def item_count
-      @data.css("itemCount").first.content.to_i
-    end
-    
-    def transaction_id
-      @data.css("code").first.content
-    end
-    
-    def date
-      DateTime.iso8601( @data.css("date").first.content )
-    end
-  
-    def items
-      @data.css("items item").map do |i|
-        Item.new(id: parse_item(i, "id"), description: parse_item(i, "description"), quantity: parse_item(i, "quantity"), amount: parse_item(i, "amount"))
-      end
-    end
-    
-    def payment_method
-      pm = PaymentMethod.new(code: parse_css("paymentMethod code"), type: parse_css("paymentMethod type"))
-    end
-    
-    def sender
-      sn = Sender.new
-      sn.name = parse_css("sender name")
-      sn.email = parse_css("sender email")
-      sn.phone_ddd = parse_css("sender phone areaCode")
-      sn.phone_number = parse_css("sender phone number")
-      sn
-    end
-    
-    def shipping
-      sh = Shipping.new
-      sh.type = parse_css("shipping type")
-      sh.cost = parse_css("shipping cost")
-      sh.state = parse_css("shipping address state")
-      sh.city = parse_css("shipping address city")
-      sh.postal_code = parse_css("shipping address postalCode")
-      sh.district = parse_css("shipping address district")
-      sh.street = parse_css("shipping address street")
-      sh.number = parse_css("shipping address number")
-      sh.complement = parse_css("shipping address complement")
-      sh
-    end
-    
-    def status
-      @data.css("status").first.content.to_i
-    end
-
-    def type
-      @data.css("type").first.content.to_i
-    end
-
-    def processing?
-      PAGSEGURO_PROCESSING == status
-    end
-    
-    def in_analysis?
-      PAGSEGURO_IN_ANALYSIS == status
-    end
-
-    def approved?
-      PAGSEGURO_APPROVED == status
-    end
-    
-    def available?
-      PAGSEGURO_AVAILABLE == status
-    end
-    
-    def disputed?
-      PAGSEGURO_DISPUTED == status
-    end
-    
-    def returned?
-      PAGSEGURO_RETURNED == status
-    end
-    
-    def cancelled?
-      PAGSEGURO_CANCELLED == status
-    end
-    
-    def payment?
-      PAGSEGURO_PAYMENT == type
-    end
-    
-    def transfer?
-      PAGSEGURO_TRANSFER == type
-    end
-    
-    def addition_of_funds?
-      PAGSEGURO_ADDITION_OF_FUNDS == type
-    end
-    
-    def charge?
-      PAGSEGURO_CHARGE == type
-    end
-    
-    def bonus?
-      PAGSEGURO_BONUS == type
-    end
-  
     private
-      def notification_data(email, token, notification_code)
-        RestClient.get("https://ws.pagseguro.uol.com.br/v2/transactions/notifications/#{notification_code}?email=#{email}&token=#{token}")
+      def transaction_data(email, token, notification_code)
+        super(RestClient.get("#{PAGSEGURO_TRANSACTIONS_URL}/notifications/#{notification_code}?email=#{email}&token=#{token}"))
       end
-
-      def parse_item(data, attribute)
-        data.css(attribute).first.content
-      end
-      
-      def parse_css(selector)
-        value = @data.css(selector).first
-        value.nil? ? nil : value.content
-      end      
   end
-end
+end

data/lib/pag_seguro/query.rb

@@ -0,0 +1,16 @@
+module PagSeguro
+  class Query < Transaction
+  
+    def initialize(email = nil, token = nil, transaction_code=nil)
+      raise "Needs a transaction code" if transaction_code.blank?
+      raise "Needs an email" if email.blank?
+      raise "Needs a token" if token.blank?
+      @data = transaction_data(email, token, transaction_code)
+    end
+      
+    private
+      def transaction_data(email, token, transaction_code)
+        super(RestClient.get("#{PAGSEGURO_TRANSACTIONS_URL}/#{transaction_code}?email=#{email}&token=#{token}"))
+      end
+  end
+end

data/lib/pag_seguro/transaction.rb

@@ -0,0 +1,173 @@
+# encoding: utf-8
+require 'net/https'
+
+module PagSeguro
+  class Transaction
+    attr_accessor :data
+
+    PAGSEGURO_TRANSACTIONS_URL  = "https://ws.pagseguro.uol.com.br/v2/transactions"
+    
+    # possible status values
+    PAGSEGURO_PROCESSING        = 1
+    PAGSEGURO_IN_ANALYSIS       = 2
+    PAGSEGURO_APPROVED          = 3
+    PAGSEGURO_AVAILABLE         = 4
+    PAGSEGURO_DISPUTED          = 5
+    PAGSEGURO_RETURNED          = 6
+    PAGSEGURO_CANCELLED         = 7
+    
+    # possible type values
+    PAGSEGURO_PAYMENT           = 1
+    PAGSEGURO_TRANSFER          = 2
+    PAGSEGURO_ADDITION_OF_FUNDS = 3
+    PAGSEGURO_CHARGE            = 4
+    PAGSEGURO_BONUS             = 5
+  
+    def initialize(transaction_xml)
+      @data = transaction_data(transaction_xml)
+    end
+
+    def id
+      @data.css("reference").first.content
+    end
+    
+    def gross_amount
+      @data.css("grossAmount").first.content
+    end
+
+    def discount_amount
+      @data.css("discountAmount").first.content
+    end
+
+    def fee_amount
+      @data.css("feeAmount").first.content
+    end
+
+    def net_amount
+      @data.css("feeAmount").first.content
+    end
+
+    def extra_amount
+      @data.css("feeAmount").first.content
+    end
+
+    def installment_count
+      @data.css("itemCount").first.content.to_i
+    end
+    
+    def item_count
+      @data.css("itemCount").first.content.to_i
+    end
+    
+    def transaction_id
+      @data.css("code").first.content
+    end
+    
+    def date
+      DateTime.iso8601( @data.css("date").first.content )
+    end
+  
+    def items
+      @data.css("items item").map do |i|
+        Item.new(id: parse_item(i, "id"), description: parse_item(i, "description"), quantity: parse_item(i, "quantity"), amount: parse_item(i, "amount"))
+      end
+    end
+    
+    def payment_method
+      pm = PaymentMethod.new(code: parse_css("paymentMethod code"), type: parse_css("paymentMethod type"))
+    end
+    
+    def sender
+      sn = Sender.new
+      sn.name = parse_css("sender name")
+      sn.email = parse_css("sender email")
+      sn.phone_ddd = parse_css("sender phone areaCode")
+      sn.phone_number = parse_css("sender phone number")
+      sn
+    end
+    
+    def shipping
+      sh = Shipping.new
+      sh.type = parse_css("shipping type")
+      sh.cost = parse_css("shipping cost")
+      sh.state = parse_css("shipping address state")
+      sh.city = parse_css("shipping address city")
+      sh.postal_code = parse_css("shipping address postalCode")
+      sh.district = parse_css("shipping address district")
+      sh.street = parse_css("shipping address street")
+      sh.number = parse_css("shipping address number")
+      sh.complement = parse_css("shipping address complement")
+      sh
+    end
+    
+    def status
+      @data.css("status").first.content.to_i
+    end
+
+    def type
+      @data.css("type").first.content.to_i
+    end
+
+    def processing?
+      PAGSEGURO_PROCESSING == status
+    end
+    
+    def in_analysis?
+      PAGSEGURO_IN_ANALYSIS == status
+    end
+
+    def approved?
+      PAGSEGURO_APPROVED == status
+    end
+    
+    def available?
+      PAGSEGURO_AVAILABLE == status
+    end
+    
+    def disputed?
+      PAGSEGURO_DISPUTED == status
+    end
+    
+    def returned?
+      PAGSEGURO_RETURNED == status
+    end
+    
+    def cancelled?
+      PAGSEGURO_CANCELLED == status
+    end
+    
+    def payment?
+      PAGSEGURO_PAYMENT == type
+    end
+    
+    def transfer?
+      PAGSEGURO_TRANSFER == type
+    end
+    
+    def addition_of_funds?
+      PAGSEGURO_ADDITION_OF_FUNDS == type
+    end
+    
+    def charge?
+      PAGSEGURO_CHARGE == type
+    end
+    
+    def bonus?
+      PAGSEGURO_BONUS == type
+    end
+  
+    protected
+      def transaction_data(transaction_xml)
+        Nokogiri::XML(transaction_xml)
+      end
+
+      def parse_item(data, attribute)
+        data.css(attribute).first.content
+      end
+      
+      def parse_css(selector)
+        value = @data.css(selector).first
+        value.nil? ? nil : value.content
+      end      
+  end
+end

data/lib/pag_seguro/version.rb

@@ -1,3 +1,3 @@
 module PagSeguro
-  VERSION = "0.2.3"
+  VERSION = "0.3.0"
 end

data/lib/pag_seguro.rb

@@ -14,7 +14,9 @@ require "payment"
 require "payment_method"
 require "sender"
 require "shipping"
+require "transaction"
 require "notification"
+require "query"
 
 # Error classes
 require "errors/unauthorized"

data/spec/pag_seguro/integration/config.yml

@@ -1,3 +1,4 @@
 email: seu_email_cadastrado@nopagseguro.com.br
 token: SEU_TOKEN_GERADO_NO_PAG_SEGURO
 notification_code: SEU_CODIGO_DE_NOTIFICACAO
+transaction_id: UM_CODIGO_DE_TRANSACAO

data/spec/pag_seguro/integration/query_spec.rb

@@ -0,0 +1,44 @@
+# encoding: utf-8
+require 'spec_helper'
+
+describe PagSeguro::Query do
+  before :all do
+    if EMAIL == "seu_email_cadastrado@nopagseguro.com.br"
+      pending "You need to set your email for your PagSeguro account in spec/pag_seguro/integration/config.yml in order to run this spec"
+    elsif TOKEN == "SEU_TOKEN_GERADO_NO_PAG_SEGURO"
+      pending "You need to set your token for your PagSeguro account in spec/pag_seguro/integration/config.yml in order to run this spec"
+    elsif TRANSACTION_ID == "UM_CODIGO_DE_TRANSACAO"
+      pending "You need to set one transaction id for your PagSeguro account in spec/pag_seguro/integration/config.yml in order to run this spec"
+    else
+      @query = PagSeguro::Query.new(EMAIL, TOKEN, TRANSACTION_ID)
+    end
+  end
+  
+  it { @query.transaction_id.should be_present }
+  it { @query.date.should be_present }
+  it { @query.id.should be_present }
+  it { @query.type.should be_present }
+  it { @query.status.should be_present }
+  it { @query.payment_method.type.should be_present }
+  it { @query.payment_method.code.should be_present }
+  it { @query.gross_amount.should be_present }
+  it { @query.discount_amount.should be_present }
+  it { @query.fee_amount.should be_present }
+  it { @query.net_amount.should be_present }
+  it { @query.extra_amount.should be_present }
+  it { @query.installment_count.should be_present }
+  it { @query.item_count.should be_present }
+  it { @query.items.should be_present }
+
+  it "should have all required item attributes" do
+    @query.items.each do |item|
+      item.id.should be_present
+      item.description.should be_present
+      item.amount.should be_present
+      item.quantity.should be_present
+    end
+  end
+  
+  it { @query.sender.email.should be_present }
+  it { @query.shipping.type.should be_present }
+end

data/spec/pag_seguro/notification_spec.rb

@@ -3,184 +3,8 @@
 require 'spec_helper'
 
 describe PagSeguro::Notification do
-  before do
-    notification_xml_mock = File.open( File.expand_path( File.dirname(__FILE__) + '/../fixtures/notification.xml') )
-    PagSeguro::Notification.any_instance.stub(:notification_data){ notification_xml_mock }
-    @notification = PagSeguro::Notification.new("mail", "token", "not_code")
-  end
-  
-  it "should have an id" do
-    @notification.id.should == "REF1234"
-  end
-  
-  it "should have a transaction id" do
-    @notification.transaction_id.should == "9E884542-81B3-4419-9A75-BCC6FB495EF1"
-  end
-  
-  it "should have a gross amount" do
-    @notification.gross_amount.should be_present
-    @notification.gross_amount.should match(/^\d+\.\d{2}$/)
-  end
+  before { PagSeguro::Notification.any_instance.stub(transaction_data: transaction_data) }
+  let(:transaction){ PagSeguro::Notification.new("mail", "token", "not_code") }
 
-  it "should have a discount amount" do
-    @notification.discount_amount.should be_present
-    @notification.discount_amount.should match(/^\d+\.\d{2}$/)
-  end
-
-  it "should have a fee amount" do
-    @notification.fee_amount.should be_present
-    @notification.fee_amount.should match(/^\d+\.\d{2}$/)
-  end
-  
-  it "should have a net amount" do
-    @notification.net_amount.should be_present
-    @notification.net_amount.should match(/^\d+\.\d{2}$/)
-  end
-
-  it "should have an extra amount" do
-    @notification.extra_amount.should be_present
-    @notification.extra_amount.should match(/^\d+\.\d{2}$/)
-  end
-
-  it "should have an installment count" do
-    @notification.installment_count.should be_present
-    @notification.installment_count.should be_an_integer
-  end
-  
-  it "should have an item count" do
-    @notification.item_count.should be_present
-    @notification.item_count.should be_an_integer
-    @notification.item_count.should == @notification.items.count
-  end
-  
-  it "should be approved in this case" do
-    @notification.should be_approved
-  end
-  
-  it "should have a sender" do
-    @sender = @notification.sender
-    @sender.name.should == "José Comprador"
-    @sender.email.should == "comprador@uol.com.br"
-    @sender.phone_ddd.should == "11"
-    @sender.phone_number == "56273440"
-  end
-  
-  it "should have a date" do
-    @notification.date.should be_present
-    @notification.date.should be_an_instance_of(DateTime)
-    @notification.date.year.should == 2011
-    @notification.date.month.should == 2
-    @notification.date.day.should == 10
-  end
-  
-  it "should have a shipping" do
-    @shipping = @notification.shipping
-    @shipping.type.should == 1
-    @shipping.cost.should == "21.50"
-    @shipping.state.should == "SP"
-    @shipping.city.should == "Sao Paulo"
-    @shipping.postal_code.should == "01452002"
-    @shipping.district.should == "Jardim Paulistano"
-    @shipping.street.should == "Av. Brig. Faria Lima"
-    @shipping.number.should == "1384"
-    @shipping.complement.should == "5o andar"
-  end
-  
-  it "should have a payment method" do
-    @payment_method = @notification.payment_method
-    @payment_method.code.should == 101
-    @payment_method.type.should == 1
-  end
-  
-  it "should have items" do
-    @items = @notification.items
-    @items.size.should == 2
-
-    @items[0].id.should == "0001"
-    @items[0].description.should == "Notebook Prata"
-    @items[0].quantity.should == "1"
-    @items[0].amount.should == "24300.00"
-
-    @items[1].id.should == "0002"
-    @items[1].description.should == "Notebook Rosa"
-    @items[1].quantity.should == "1"
-    @items[1].amount.should == "25600.00"
-  end
-  
-  describe "status" do
-    it "should have a status" do
-      @notification.status.should == 3
-    end
-    
-    it "should be processing if its status is 1" do
-      @notification.stub(:status){ 1 }
-      @notification.should be_processing
-    end
-
-    it "should be in analysis if its status is 2" do
-      @notification.stub(:status){ 2 }
-      @notification.should be_in_analysis
-    end
-
-    it "should be approved if its status is 3" do
-      @notification.stub(:status){ 3 }
-      @notification.should be_approved
-    end
-
-    it "should be available if its status is 4" do
-      @notification.stub(:status){ 4 }
-      @notification.should be_available
-    end
-
-    it "should be disputed if its status is 5" do
-      @notification.stub(:status){ 5 }
-      @notification.should be_disputed
-    end
-
-    it "should be disputed if its status is 5" do
-      @notification.stub(:status){ 5 }
-      @notification.should be_disputed
-    end
-
-    it "should be returned if its status is 6" do
-      @notification.stub(:status){ 6 }
-      @notification.should be_returned
-    end
-
-    it "should be cancelled if its status is 7" do
-      @notification.stub(:status){ 7 }
-      @notification.should be_cancelled
-    end
-  end
-  
-  describe "type" do
-    it "should have a type" do
-      @notification.type.should == 1
-    end
-    
-    it "should be payment if type is 1" do
-      @notification.stub(:type){ 1 }
-      @notification.should be_payment
-    end
-
-    it "should be transfer if type is 2" do
-      @notification.stub(:type){ 2 }
-      @notification.should be_transfer
-    end
-
-    it "should be addition of funds if type is 3" do
-      @notification.stub(:type){ 3 }
-      @notification.should be_addition_of_funds
-    end
-
-    it "should be charge if type is 4" do
-      @notification.stub(:type){ 4 }
-      @notification.should be_charge
-    end
-
-    it "should be bonus if type is 5" do
-      @notification.stub(:type){ 5 }
-      @notification.should be_bonus
-    end
-  end
-end
+  it_behaves_like "a transaction"
+end

data/spec/pag_seguro/query_spec.rb

@@ -0,0 +1,10 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe PagSeguro::Query do
+  before { PagSeguro::Query.any_instance.stub(transaction_data: transaction_data) }
+  let(:transaction){ PagSeguro::Query.new("mail", "token", "trans_code") }
+
+  it_behaves_like "a transaction"
+end

data/spec/pag_seguro/transaction_spec.rb

@@ -0,0 +1,9 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe PagSeguro::Transaction do
+  let(:transaction){ PagSeguro::Transaction.new(transaction_xml) }
+  
+  it_behaves_like "a transaction"
+end

data/spec/spec_helper.rb

@@ -5,11 +5,13 @@ end
 
 require 'yaml'
 require File.dirname(__FILE__) + "/../lib/pag_seguro"
+Dir[File.dirname(__FILE__) + "/support/**/*.rb"].each {|f| require f}
 
 config = YAML.load_file(File.dirname(__FILE__) + "/pag_seguro/integration/config.yml")
 EMAIL = config["email"]
 TOKEN = config["token"]
 NOTIFICATION_CODE = config["notification_code"]
+TRANSACTION_ID = config["transaction_id"]
 
 class HaveAttributeAccessor
   def initialize(attribute)

data/spec/support/transaction_shared_examples.rb

@@ -0,0 +1,180 @@
+# encoding: UTF-8
+shared_examples_for "a transaction" do
+  let(:transaction_xml){ File.open( File.expand_path( File.dirname(__FILE__) + '/../fixtures/transaction.xml') ) }
+  let(:transaction_data){ Nokogiri::XML(transaction_xml) }
+  
+  it "should have an id" do
+    transaction.id.should == "REF1234"
+  end
+  
+  it "should have a transaction id" do
+    transaction.transaction_id.should == "9E884542-81B3-4419-9A75-BCC6FB495EF1"
+  end
+  
+  it "should have a gross amount" do
+    transaction.gross_amount.should be_present
+    transaction.gross_amount.should match(/^\d+\.\d{2}$/)
+  end
+
+  it "should have a discount amount" do
+    transaction.discount_amount.should be_present
+    transaction.discount_amount.should match(/^\d+\.\d{2}$/)
+  end
+
+  it "should have a fee amount" do
+    transaction.fee_amount.should be_present
+    transaction.fee_amount.should match(/^\d+\.\d{2}$/)
+  end
+  
+  it "should have a net amount" do
+    transaction.net_amount.should be_present
+    transaction.net_amount.should match(/^\d+\.\d{2}$/)
+  end
+
+  it "should have an extra amount" do
+    transaction.extra_amount.should be_present
+    transaction.extra_amount.should match(/^\d+\.\d{2}$/)
+  end
+
+  it "should have an installment count" do
+    transaction.installment_count.should be_present
+    transaction.installment_count.should be_an_integer
+  end
+  
+  it "should have an item count" do
+    transaction.item_count.should be_present
+    transaction.item_count.should be_an_integer
+    transaction.item_count.should == transaction.items.count
+  end
+  
+  it "should be approved in this case" do
+    transaction.should be_approved
+  end
+  
+  it "should have a sender" do
+    @sender = transaction.sender
+    @sender.name.should == "José Comprador"
+    @sender.email.should == "comprador@uol.com.br"
+    @sender.phone_ddd.should == "11"
+    @sender.phone_number == "56273440"
+  end
+  
+  it "should have a date" do
+    transaction.date.should be_present
+    transaction.date.should be_an_instance_of(DateTime)
+    transaction.date.year.should == 2011
+    transaction.date.month.should == 2
+    transaction.date.day.should == 10
+  end
+  
+  it "should have a shipping" do
+    @shipping = transaction.shipping
+    @shipping.type.should == 1
+    @shipping.cost.should == "21.50"
+    @shipping.state.should == "SP"
+    @shipping.city.should == "Sao Paulo"
+    @shipping.postal_code.should == "01452002"
+    @shipping.district.should == "Jardim Paulistano"
+    @shipping.street.should == "Av. Brig. Faria Lima"
+    @shipping.number.should == "1384"
+    @shipping.complement.should == "5o andar"
+  end
+  
+  it "should have a payment method" do
+    @payment_method = transaction.payment_method
+    @payment_method.code.should == 101
+    @payment_method.type.should == 1
+  end
+  
+  it "should have items" do
+    @items = transaction.items
+    @items.size.should == 2
+
+    @items[0].id.should == "0001"
+    @items[0].description.should == "Notebook Prata"
+    @items[0].quantity.should == "1"
+    @items[0].amount.should == "24300.00"
+
+    @items[1].id.should == "0002"
+    @items[1].description.should == "Notebook Rosa"
+    @items[1].quantity.should == "1"
+    @items[1].amount.should == "25600.00"
+  end
+  
+  describe "status" do
+    it "should have a status" do
+      transaction.status.should == 3
+    end
+    
+    it "should be processing if its status is 1" do
+      transaction.stub(:status){ 1 }
+      transaction.should be_processing
+    end
+
+    it "should be in analysis if its status is 2" do
+      transaction.stub(:status){ 2 }
+      transaction.should be_in_analysis
+    end
+
+    it "should be approved if its status is 3" do
+      transaction.stub(:status){ 3 }
+      transaction.should be_approved
+    end
+
+    it "should be available if its status is 4" do
+      transaction.stub(:status){ 4 }
+      transaction.should be_available
+    end
+
+    it "should be disputed if its status is 5" do
+      transaction.stub(:status){ 5 }
+      transaction.should be_disputed
+    end
+
+    it "should be disputed if its status is 5" do
+      transaction.stub(:status){ 5 }
+      transaction.should be_disputed
+    end
+
+    it "should be returned if its status is 6" do
+      transaction.stub(:status){ 6 }
+      transaction.should be_returned
+    end
+
+    it "should be cancelled if its status is 7" do
+      transaction.stub(:status){ 7 }
+      transaction.should be_cancelled
+    end
+  end
+  
+  describe "type" do
+    it "should have a type" do
+      transaction.type.should == 1
+    end
+    
+    it "should be payment if type is 1" do
+      transaction.stub(:type){ 1 }
+      transaction.should be_payment
+    end
+
+    it "should be transfer if type is 2" do
+      transaction.stub(:type){ 2 }
+      transaction.should be_transfer
+    end
+
+    it "should be addition of funds if type is 3" do
+      transaction.stub(:type){ 3 }
+      transaction.should be_addition_of_funds
+    end
+
+    it "should be charge if type is 4" do
+      transaction.stub(:type){ 4 }
+      transaction.should be_charge
+    end
+
+    it "should be bonus if type is 5" do
+      transaction.stub(:type){ 5 }
+      transaction.should be_bonus
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pag_seguro
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-15 00:00:00.000000000 Z
+date: 2012-06-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -97,11 +97,13 @@ files:
 - lib/pag_seguro/notification.rb
 - lib/pag_seguro/payment.rb
 - lib/pag_seguro/payment_method.rb
+- lib/pag_seguro/query.rb
 - lib/pag_seguro/sender.rb
 - lib/pag_seguro/shipping.rb
+- lib/pag_seguro/transaction.rb
 - lib/pag_seguro/version.rb
 - pag_seguro.gemspec
-- spec/fixtures/notification.xml
+- spec/fixtures/transaction.xml
 - spec/pag_seguro/checkout_xml_spec.rb
 - spec/pag_seguro/errors/invalid_data_spec.rb
 - spec/pag_seguro/errors/unauthorized_spec.rb
@@ -109,14 +111,18 @@ files:
 - spec/pag_seguro/integration/checkout_spec.rb
 - spec/pag_seguro/integration/config.yml
 - spec/pag_seguro/integration/notification_spec.rb
+- spec/pag_seguro/integration/query_spec.rb
 - spec/pag_seguro/item_spec.rb
 - spec/pag_seguro/notification_spec.rb
 - spec/pag_seguro/payment_method_spec.rb
 - spec/pag_seguro/payment_spec.rb
+- spec/pag_seguro/query_spec.rb
 - spec/pag_seguro/sender_spec.rb
 - spec/pag_seguro/shipping_spec.rb
+- spec/pag_seguro/transaction_spec.rb
 - spec/pag_seguro/version_spec.rb
 - spec/spec_helper.rb
+- spec/support/transaction_shared_examples.rb
 homepage: http://github.com/heavenstudio/pag_seguro
 licenses: []
 post_install_message: 
@@ -142,7 +148,7 @@ signing_key:
 specification_version: 3
 summary: A ruby gem to handle PagSeguro's API version 2
 test_files:
-- spec/fixtures/notification.xml
+- spec/fixtures/transaction.xml
 - spec/pag_seguro/checkout_xml_spec.rb
 - spec/pag_seguro/errors/invalid_data_spec.rb
 - spec/pag_seguro/errors/unauthorized_spec.rb
@@ -150,11 +156,16 @@ test_files:
 - spec/pag_seguro/integration/checkout_spec.rb
 - spec/pag_seguro/integration/config.yml
 - spec/pag_seguro/integration/notification_spec.rb
+- spec/pag_seguro/integration/query_spec.rb
 - spec/pag_seguro/item_spec.rb
 - spec/pag_seguro/notification_spec.rb
 - spec/pag_seguro/payment_method_spec.rb
 - spec/pag_seguro/payment_spec.rb
+- spec/pag_seguro/query_spec.rb
 - spec/pag_seguro/sender_spec.rb
 - spec/pag_seguro/shipping_spec.rb
+- spec/pag_seguro/transaction_spec.rb
 - spec/pag_seguro/version_spec.rb
 - spec/spec_helper.rb
+- spec/support/transaction_shared_examples.rb
+has_rdoc: false