pagseguro-oficial 2.0.8 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e774d4d23c27502385d14f5e9bc90ada28317325
-  data.tar.gz: 6000c710d322c4faae2c4d95d0b3a03c34045d2e
+  metadata.gz: 970a3da0c4b529d8b515308272485707678b7328
+  data.tar.gz: f90deafb204fbc64dcd6d1bee51b30fc781a704a
 SHA512:
-  metadata.gz: fd59c649d168459fb7864fb2a30c34a3ef381c3355c7ff4455058f20b37905447a7f5095bc1e17e775d2d5f340a15a27cc21c3052d853f57dad85c004a01f80f
-  data.tar.gz: ef3e534a97d8e8486f44099d80f82f76c2f14c05303aee1a2ffe3456df4f8cfb0025ede3b50ce68aa7128e564004950dfd41821326a1dfb10ad34dc5cea01a19
+  metadata.gz: 1b9d0a5be5c4fb8bb7ab30d8847273ec821a99b40a11169b257c1f34dafe1d5d0832d3d4f9fa4d2346907850b58b8a776491ba32f83f82e50fd4f58dfc3ae4d7
+  data.tar.gz: 14ccedf76ac30be67909c144fda0d7dbd97e5042db8f8245d676b97d98c77f84c59732ceb4ab35fb3e9bca39e754a7bc3542b5c2780dff49e4132d64d12d0065

data/CHANGELOG.md

@@ -1,13 +1,23 @@
-## Next release - 2.0.8
+## Next release - 2.2.0
+
+- Checkout transparente
+
+## Stable
+
+2.1.0
+
+- Utilização da versão 3 da api de notificações e consultas (OBS.: o serviço de consulta a transações abandonadas ainda utiliza a versão 2)
+- O serviço de parcelas (installment) usará fixamente a versão 2 da api
+- Correção de um bug que concatenava o status da transação com o status de um pagamento
+
+2.0.8
 
 - Consulta de opções de parcelamento
 
-## Next release - 2.0.7
+2.0.7
 
  - Suporte para adicionar parâmetros dinamicamente na criação de requisições de pagamentos (isso possibilita a utilização de parâmetros da api que ainda não foram mapeados na gem)
 
-## Stable
-
 2.0.6
 
  - Adicionando environment sandbox, entre outras melhorias

data/README.md

@@ -8,12 +8,11 @@
 
 A biblioteca PagSeguro em Ruby é um conjunto de classes de domínio que facilitam, para o desenvolvedor Ruby, a utilização das funcionalidades que o PagSeguro oferece na forma de APIs. Com a biblioteca instalada e configurada, você pode facilmente integrar funcionalidades como:
 
- - Criar [requisições de pagamentos]
- - Consultar [transações por código]
- - Consultar [transações por intervalo de datas]
- - Consultar [transações abandonadas]
- - Consultar opções de parcelamento
- - Receber [notificações]
+ - Criar [requisições de pagamentos] \(este serviço utiliza a versão **V2** da API\)
+ - Consultar [transações por código] \(este serviço utiliza a versão **V3** da API\)
+ - Consultar [transações por intervalo de datas] \(este serviço utiliza a versão **V3** da API)
+ - Consultar [transações abandonadas] \(este serviço utiliza a versão **V2** da API\)
+ - Receber [notificações] \(este serviço utiliza a versão **V3** da API\)
 
 
 ## Requisitos
@@ -27,7 +26,7 @@ A biblioteca PagSeguro em Ruby é um conjunto de classes de domínio que facilit
  - Adicione a biblioteca ao seu Gemfile.
 
 ```ruby
-gem "pagseguro-oficial", "~> 2.0.8"
+gem "pagseguro-oficial", "~> 2.1.0"
 ```
 
  - Execute o comando `bundle install`.
@@ -45,7 +44,7 @@ end
 
 O token de segurança está disponível em sua [conta do PagSeguro](https://pagseguro.uol.com.br/integracao/token-de-seguranca.jhtml).
 
-## Pagamentos
+## Pagamentos (API V2)
 
 Para iniciar uma requisição de pagamento, você precisa instanciar a classe `PagSeguro::PaymentRequest`. Isso normalmente será feito em seu controller de checkout.
 
@@ -100,7 +99,7 @@ class CheckoutController < ApplicationController
 end
 ```
 
-## Notificações
+## Notificações (API V3)
 
 O PagSeguro irá notificar a URL informada no processo de checkout. Isso é feito através do método `PagSeguro::PaymentRequest#notification_url`. Esta URL irá receber o código da notificação e tipo de notificação. Com estas informações, podemos recuperar as informações detalhadas sobre o pagamento.
 
@@ -122,9 +121,9 @@ class NotificationsController < ApplicationController
 end
 ```
 
-## Consultas
+## Consultas (API V3)
 
-### Transações abandonadas
+### Transações abandonadas (API V2)
 
 Para quantificar o número de transações abandonadas, você pode solicitar uma lista com histórico dessas transações.
 
@@ -203,7 +202,7 @@ end
 
 ## API
 
-### PagSeguro::PaymentRequest
+### PagSeguro::PaymentRequest (utiliza versão V2)
 
 #### Definindo identificador do pedido
 
@@ -335,10 +334,10 @@ Se seu Pull Request for relacionado a uma versão específica, o Pull Request n
 
 
   [requisições de pagamentos]: https://pagseguro.uol.com.br/v2/guia-de-integracao/api-de-pagamentos.html
-  [notificações]: https://pagseguro.uol.com.br/v2/guia-de-integracao/api-de-notificacoes.html
-  [transações por código]: https://pagseguro.uol.com.br/v2/guia-de-integracao/consulta-de-transacoes-por-codigo.html
-  [transações por intervalo de datas]: https://pagseguro.uol.com.br/v2/guia-de-integracao/consulta-de-transacoes-por-intervalo-de-datas.html
-  [transações abandonadas]: https://pagseguro.uol.com.br/v2/guia-de-integracao/consulta-de-transacoes-abandonadas.html
+  [notificações]: https://pagseguro.uol.com.br/v3/guia-de-integracao/api-de-notificacoes.html
+  [transações por código]: https://pagseguro.uol.com.br/v3/guia-de-integracao/consulta-de-transacoes-por-codigo.html
+  [transações por intervalo de datas]: https://pagseguro.uol.com.br/v3/guia-de-integracao/consulta-de-transacoes-por-intervalo-de-datas.html
+  [transações abandonadas]: https://pagseguro.uol.com.br/v3/guia-de-integracao/consulta-de-transacoes-abandonadas.html
   [fórum]: http://forum.pagseguro.uol.com.br/
   [Ruby]: http://www.ruby-lang.org/pt/
   [GitHub]: https://github.com/pagseguro/ruby/

data/examples/abandoned_transactions.rb

@@ -20,7 +20,7 @@ while report.next_page?
     puts "   created at: #{transaction.created_at}"
     puts "   code: #{transaction.code}"
     puts "   type_id: #{transaction.type_id}"
-    puts "   gross amount: #{transaction.gross_amount}"
+    puts "   gross amount: #{transaction.gross_amount.to_f}"
     puts
   end
 end

data/examples/transaction_by_notification_code.rb

@@ -2,4 +2,58 @@ require_relative "boot"
 
 transaction = PagSeguro::Transaction.find_by_notification_code("739D69-79C052C05280-55542D9FBB33-4AB2D0")
 
-puts transaction
+puts "=> Transaction"
+puts "  code: #{transaction.code}"
+puts "  type: #{transaction.type_id}"
+puts "  status: #{transaction.status.status}"
+puts "  cancellation source: #{transaction.cancellation_source}"
+puts "  escrow end date: #{transaction.escrow_end_date}"
+puts "  payment method type: #{transaction.payment_method.type}"
+puts "  gross amount: #{transaction.gross_amount.to_f}"
+puts "  discount amount: #{transaction.discount_amount.to_f}"
+puts "  operational fee amount: #{transaction.creditor_fees.operational_fee_amount.to_f}"
+puts "  installment fee amount: #{transaction.creditor_fees.installment_fee_amount.to_f}"
+puts "  intermediation rate amount: #{transaction.creditor_fees.intermediation_rate_amount.to_f}"
+puts "  intermediation fee amount: #{transaction.creditor_fees.intermediation_fee_amount.to_f}"
+puts "  commission fee amount: #{transaction.creditor_fees.commission_fee_amount.to_f}"
+puts "  commission fee amount: #{transaction.creditor_fees.commission_fee_amount.to_f}"
+puts "  efrete: #{transaction.creditor_fees.efrete.to_f}"
+puts "  net amount: #{transaction.net_amount.to_f}"
+puts "  extra amount: #{transaction.extra_amount.to_f}"
+
+puts "    => Payments"
+puts "      installment count: #{transaction.installments}"
+transaction.payment_releases.each do |release|
+  puts "    current installment: #{release.installment}"
+  puts "    total amount: #{release.total_amount.to_f}"
+  puts "    release amount: #{release.release_amount.to_f}"
+  puts "    status: #{release.status}"
+  puts "    release date: #{release.release_date}"
+end
+
+puts "    => Items"
+puts "      items count: #{transaction.items.size}"
+transaction.items.each do |item|
+  puts "      item id: #{item.id}"
+  puts "      description: #{item.description}"
+  puts "      quantity: #{item.quantity}"
+  puts "      amount: #{item.amount.to_f}"
+  puts "      weight: #{item.weight}g"
+end
+
+puts "    => Sender"
+puts "      name: #{transaction.sender.name}"
+puts "      email: #{transaction.sender.email}"
+puts "      phone: (#{transaction.sender.phone.area_code}) #{transaction.sender.phone.number}"
+puts "      document: #{transaction.sender.document.type}: #{transaction.sender.document.value}"
+
+puts "    => Shipping"
+puts "      street: #{transaction.shipping.address.street}, #{transaction.shipping.address.number}"
+puts "      complement: #{transaction.shipping.address.complement}"
+puts "      postal code: #{transaction.shipping.address.postal_code}"
+puts "      district: #{transaction.shipping.address.district}"
+puts "      city: #{transaction.shipping.address.city}"
+puts "      state: #{transaction.shipping.address.state}"
+puts "      country: #{transaction.shipping.address.country}"
+puts "      type: #{transaction.shipping.type_name}"
+puts "      cost: #{transaction.shipping.cost}"

data/examples/transaction_by_reference.rb

@@ -0,0 +1,24 @@
+require_relative 'boot'
+
+transaction = PagSeguro::Transaction.find_by_reference("REF1234")
+
+while transaction.next_page?
+  transaction.next_page!
+  puts "== Page #{transaction.page}"
+  abort "=> Errors: #{transaction.errors.join("\n")}" unless transaction.valid?
+  puts "Report created on #{transaction.created_at}"
+  puts
+
+  transaction.transactions.each do |transaction|
+    puts "=> Transaction"
+    puts "   created_at: #{transaction.created_at}"
+    puts "   code: #{transaction.code}"
+    puts "   cancellation_source: #{transaction.cancellation_source}"
+    puts "   payment method: #{transaction.payment_method.type}"
+    puts "   gross amount: #{transaction.gross_amount.to_f}"
+    puts "   updated at: #{transaction.updated_at}"
+    puts "   status: #{transaction.status.status}"
+    puts
+  end
+end
+

data/examples/transactions_by_date.rb

@@ -15,9 +15,15 @@ while report.next_page?
     puts "   created_at: #{transaction.created_at}"
     puts "   code: #{transaction.code}"
     puts "   cancellation_source: #{transaction.cancellation_source}"
+    puts "   type: #{transaction.type_id}"
+    puts "   status: #{transaction.status.status}"
     puts "   payment method: #{transaction.payment_method.type}"
-    puts "   gross amount: #{transaction.gross_amount}"
+    puts "   gross amount: #{transaction.gross_amount.to_f}"
+    puts "   discount amount: #{transaction.discount_amount.to_f}"
+    puts "   net amount: #{transaction.net_amount.to_f}"
+    puts "   extra amount: #{transaction.extra_amount.to_f}"
     puts "   updated at: #{transaction.updated_at}"
+    puts "   status: #{transaction.status.status}"
     puts
   end
 end

data/lib/pagseguro/creditor_fee.rb

@@ -0,0 +1,23 @@
+module PagSeguro
+  class CreditorFee
+    include Extensions::MassAssignment
+
+    # Set the current transaction intermidiation rate amount
+    attr_accessor :intermediation_rate_amount
+
+    # Set the current transaction intermediation fee amount
+    attr_accessor :intermediation_fee_amount
+
+    # Set the current transaction installment amount
+    attr_accessor :installment_fee_amount
+
+    # Set the current transaction operational fee amount
+    attr_accessor :operational_fee_amount
+
+    # Set the current transaction commission fee amount
+    attr_accessor :commission_fee_amount
+
+    # Set the current transaction freight amount
+    attr_accessor :efrete
+  end
+end

data/lib/pagseguro/document.rb

@@ -0,0 +1,11 @@
+module PagSeguro
+  class Document
+    include Extensions::MassAssignment
+
+    # the type of the document
+    attr_accessor :type
+
+    # the value of the document
+    attr_accessor :value
+  end
+end

data/lib/pagseguro/installment.rb

@@ -24,7 +24,7 @@ module PagSeguro
     def self.find(amount, card_brand = nil)
       string = "installments?amount=#{amount}"
       string += "&cardBrand=#{card_brand}" if card_brand
-      load_from_response Request.get(string)
+      load_from_response Request.get(string, 'v2')
     end
 
     # Serialize the HTTP response into data.

data/lib/pagseguro/payment_release.rb

@@ -0,0 +1,21 @@
+module PagSeguro
+  class PaymentRelease
+    include Extensions::MassAssignment
+    include Extensions::EnsureType
+
+    # Set the number of installments
+    attr_accessor :installment
+
+    # Set the total amount
+    attr_accessor :total_amount
+
+    # Set the total amount of the current release
+    attr_accessor :release_amount
+
+    # Set the status of current release
+    attr_accessor :status
+
+    # Set the release date
+    attr_accessor :release_date
+  end
+end

data/lib/pagseguro/payment_releases.rb

@@ -0,0 +1,25 @@
+module PagSeguro
+  class PaymentReleases
+    include Enumerable
+    extend Forwardable
+    include Extensions::EnsureType
+
+    def_delegators :@payments, :each, :size
+
+    def initialize
+      @payments = []
+    end
+
+    def <<(payment)
+      payment = ensure_type(PaymentRelease, payment)
+
+      @payments << payment unless @payments.include? payment
+    end
+
+    def include?(payment)
+      self.find do |included_payment|
+        included_payment.installment == ensure_type(PaymentRelease, payment).installment
+      end
+    end
+  end
+end

data/lib/pagseguro/payment_request/response.rb

@@ -15,7 +15,7 @@ module PagSeguro
       end
 
       def url
-        PagSeguro.site_url("checkout/payment.html?code=#{code}") if code
+        PagSeguro.site_url("#{api_version}/checkout/payment.html?code=#{code}") if code
       end
 
       def code
@@ -25,6 +25,11 @@ module PagSeguro
       def created_at
         @created_at ||= Time.parse(response.data.css("checkout > date").text) if success?
       end
+
+      # Default PagSeguro API version for payments
+      def api_version
+        'v2'
+      end
     end
   end
 end

data/lib/pagseguro/payment_request.rb

@@ -81,7 +81,7 @@ module PagSeguro
         email: email,
         token: token
       })
-      Response.new Request.post("checkout", params)
+      Response.new Request.post("checkout", api_version, params)
     end
 
     private
@@ -92,8 +92,9 @@ module PagSeguro
       self.token    = PagSeguro.token
     end
 
-    def endpoint
-      PagSeguro.api_url("checkout")
+    # The default PagSeguro API version
+    def api_version
+      'v2'
     end
   end
 end

data/lib/pagseguro/payment_status.rb

@@ -9,6 +9,8 @@ module PagSeguro
       "5" => :in_dispute,
       "6" => :refunded,
       "7" => :cancelled,
+      "8" => :chargeback_charged,
+      "9" => :contested
     }.freeze
 
     # The payment status id.

data/lib/pagseguro/request.rb

@@ -10,29 +10,31 @@ module PagSeguro
     # Perform a GET request.
     #
     # # +path+: the path that will be requested. Must be something like <tt>"transactions/code/739D69-79C052C05280-55542D9FBB33-CAB2B1"</tt>.
+    # # +api_version+: the current PagSeguro API version of the requested service
     # # +data+: the data that will be sent as query string. Must be a Hash.
     # # +headers+: any additional header that will be sent through the request.
     #
-    def get(path, data = {}, headers = {})
-      execute :get, path, data, headers
+    def get(path, api_version, data = {}, headers = {})
+      execute :get, path, api_version, data, headers
     end
 
     # Perform a POST request.
     #
     # # +path+: the path that will be requested. Must be something like <tt>"checkout"</tt>.
+    # # +api_version+: the current PagSeguro API version of the requested service
     # # +data+: the data that will be sent as body data. Must be a Hash.
     # # +headers+: any additional header that will be sent through the request.
     #
-    def post(path, data = {}, headers = {})
-      execute :post, path, data, headers
+    def post(path, api_version, data = {}, headers = {})
+      execute :post, path, api_version, data, headers
     end
 
     # Perform the specified HTTP request. It will include the API credentials,
-    # encoding and additional headers.
-    def execute(request_method, path, data, headers) # :nodoc:
+    # api_version, encoding and additional headers.
+    def execute(request_method, path, api_version, data, headers) # :nodoc:
       request.public_send(
         request_method,
-        PagSeguro.api_url(path),
+        PagSeguro.api_url("#{api_version}/#{path}"),
         extended_data(data),
         extended_headers(request_method, headers)
       )

data/lib/pagseguro/sender.rb

@@ -6,6 +6,9 @@ module PagSeguro
     # Get the sender phone.
     attr_reader :phone
 
+    # Get the sender document
+    attr_reader :document
+
     # Set the sender name.
     attr_accessor :name
 
@@ -19,5 +22,10 @@ module PagSeguro
     def phone=(phone)
       @phone = ensure_type(Phone, phone)
     end
+
+    # Set the sender document.
+    def document=(document)
+      @document = ensure_type(Document, document)
+    end
   end
 end

data/lib/pagseguro/transaction/search/search_abandoned.rb

@@ -0,0 +1,19 @@
+module PagSeguro
+  class SearchAbandoned < PagSeguro::Search
+    private
+    def perform_request_and_serialize
+      @response = Request.get(@path, api_version,
+        {
+          initialDate: options[:starts_at].xmlschema,
+          finalDate: options[:ends_at].xmlschema,
+          page: page,
+          maxPageResults: options.fetch(:per_page, 50)
+        })
+      @errors = Errors.new(@response)
+    end
+
+    def api_version
+      'v2'
+    end
+  end
+end

data/lib/pagseguro/transaction/search/search_by_date.rb

@@ -0,0 +1,15 @@
+module PagSeguro
+  class SearchByDate < PagSeguro::Search
+    private
+    def perform_request_and_serialize
+      @response = Request.get(@path, api_version,
+        {
+          initialDate: options[:starts_at].xmlschema,
+          finalDate: options[:ends_at].xmlschema,
+          page: page,
+          maxPageResults: options.fetch(:per_page, 50)
+        })
+      @errors = Errors.new(@response)
+    end
+  end
+end

data/lib/pagseguro/transaction/search/search_by_reference.rb

@@ -0,0 +1,12 @@
+module PagSeguro
+  class SearchByReference < PagSeguro::Search
+    private
+    def perform_request_and_serialize
+      @response = Request.get(@path, api_version,
+        {
+          reference: options[:reference],
+        })
+      @errors = Errors.new(@response)
+    end
+  end
+end

data/lib/pagseguro/{report.rb → transaction/search.rb}

@@ -1,5 +1,5 @@
 module PagSeguro
-  class Report
+  class Search
     # Set the report options.
     #
     # # +per_page+: the page size.
@@ -14,8 +14,7 @@ module PagSeguro
     # Return the current page.
     attr_reader :page
 
-    def initialize(item_class, path, options, page = 0)
-      @item_class = item_class
+    def initialize(path, options, page = 0)
       @path = path
       @options = options
       @page = page
@@ -86,14 +85,12 @@ module PagSeguro
 
     private
     def perform_request_and_serialize
-      @response = Request.get(@path, {
-        initialDate: options[:starts_at].xmlschema,
-        finalDate: options[:ends_at].xmlschema,
-        page: page,
-        maxPageResults: options.fetch(:per_page, 50)
-      })
-
-      @errors = Errors.new(@response)
+      raise NotImplementedError.new("'.perform_request_and_serialize' must be implemented in specific search class")
+    end
+
+    # The default PagSeguro API version
+    def api_version
+      'v3'
     end
 
     def fetched?

data/lib/pagseguro/transaction/serializer.rb

@@ -12,6 +12,8 @@ module PagSeguro
           serialize_general(data)
           serialize_amounts(data)
           serialize_dates(data)
+          serialize_creditor(data)
+          serialize_payments(data)
           serialize_items(data)
           serialize_sender(data)
           serialize_shipping(data) if xml.css("shipping").any?
@@ -19,11 +21,11 @@ module PagSeguro
       end
 
       def serialize_general(data)
-        data[:code] = xml.css(">code").text
+        data[:code] = xml.css("> code").text
         data[:reference] = xml.css("reference").text
-        data[:type_id] = xml.css(">type").text
+        data[:type_id] = xml.css("> type").text
         data[:payment_link] = xml.css("paymentLink").text
-        data[:status] = xml.css("status").text
+        data[:status] = xml.css("> status").text
 
         cancellation_source = xml.css("cancellationSource")
         data[:cancellation_source] = cancellation_source.text if cancellation_source.any?
@@ -47,12 +49,37 @@ module PagSeguro
       def serialize_amounts(data)
         data[:gross_amount] = BigDecimal(xml.css("grossAmount").text)
         data[:discount_amount] = BigDecimal(xml.css("discountAmount").text)
-        data[:fee_amount] = BigDecimal(xml.css("feeAmount").text)
         data[:net_amount] = BigDecimal(xml.css("netAmount").text)
         data[:extra_amount] = BigDecimal(xml.css("extraAmount").text)
         data[:installments] = xml.css("installmentCount").text.to_i
       end
 
+      def serialize_creditor(data)
+        data[:creditor_fees] = {
+          intermediation_rate_amount: BigDecimal(xml.css("creditorFees > intermediationRateAmount").text),
+          intermediation_fee_amount: BigDecimal(xml.css("creditorFees > intermediationFeeAmount").text),
+          installment_fee_amount: BigDecimal(xml.css("creditorFees > installmentFeeAmount").text),
+          operational_fee_amount: BigDecimal(xml.css("creditorFees > operationalFeeAmount").text),
+          commission_fee_amount: BigDecimal(xml.css("creditorFees > commissionFeeAmount").text),
+          efrete: BigDecimal(xml.css("creditorFees > efrete").text)
+        }
+      end
+
+      def serialize_payments(data)
+        data[:payment_releases] = []
+
+        xml.css("paymentReleases > paymentRelease").each do |node|
+          payment_release = {}
+          payment_release[:installment] = node.css("installment").text
+          payment_release[:total_amount] = BigDecimal(node.css("totalAmount").text)
+          payment_release[:release_amount] = BigDecimal(node.css("releaseAmount").text)
+          payment_release[:status] = node.css("status").text
+          payment_release[:release_date] = Time.parse(node.css("releaseDate").text)
+
+          data[:payment_releases] << payment_release
+        end
+      end
+
       def serialize_items(data)
         data[:items] = []
 
@@ -74,9 +101,17 @@ module PagSeguro
         }
 
         serialize_phone(sender)
+        serialize_document(sender)
         data[:sender] = sender
       end
 
+      def serialize_document(data)
+        data[:document] = {
+          type: xml.css("sender > documents > document > type").text,
+          value: xml.css("sender > documents > document > value").text
+        }
+      end
+
       def serialize_phone(data)
         data[:phone] = {
           area_code: xml.css("sender > phone > areaCode").text,