pagseguro-oficial 2.2.0 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 195f2fa2ef3756e03ccdde0b6e0d6dd6f632edf3
-  data.tar.gz: 159f0ddf89ed6d5bd3e25e13d8c292456466be3d
+  metadata.gz: a980612b48482830bbc795d21b5e9b42c93fa734
+  data.tar.gz: d6d5239ec8867b09b90f1c916e57caeda56542f6
 SHA512:
-  metadata.gz: 4e648a26a4dedcc676c19a3f2f9158db9672993529d18889af97bf3bcd9314a2428dbca8c8e3232b78b33d63d852791a5d55c2c5aae83d33e040035d9072cbac
-  data.tar.gz: c265b5e829a21f3ecf99e8fcc3efd6cb956f252bc5806c8e23fd8fa64474e5a1eb74600333641bd1d60285fee6201256896ed1036e2ae7f494d2bee93eadc597
+  metadata.gz: ecb011aceae73b1cc57da82e3ab009b17608c07304b776775cea35f00fa8dfd4ef95139ecf164c22ab3bf268cfeafa9c7251b57d257c89c0e5a330ba5ef393e7
+  data.tar.gz: 9bd96ab418caf1824bdcecf0b9301ebf1d5440eeb7fc9bedec9a1fb638a788e9c7b897b92fcde4cc39c3f95253d5d637f454fa86641a16d0ba9a0a92f3c89342

data/.travis.yml

@@ -1,14 +1,12 @@
 language: ruby
 rvm:
-  - 2.2.2
-  - 2.1.6
+  - 2.2.3
+  - 2.1.7
   - 2.0.0
   - 1.9.3
   - jruby-19mode
 notifications:
   email:
-  - lucas.renan@codeminer42.com
-  - vitor.kusiaki@codeminer42.com
-  - dmitry.rocha@codeminer42.com
-  slack:
-    secure: H7PR+eH28CRGZ7E71EQ2xAjkbLX53eXbJ8nadHgx6W2gggNSB8UPw6gqQg/UC0lCbK6ejQ0wE/pEPfLBnCJkqL8mfBr7ADTqZe2fM/YxXQktdOlldJtZaxUikDwOWZSXdOG+3ITdbv/MQW/wehi8UWzFC+XkhJCudOPW1n+9bqs=
+    - lucas.renan@codeminer42.com
+    - dmitry.rocha@codeminer42.com
+    - rafael.belo@codeminer42.com

data/CHANGELOG.md

@@ -1,8 +1,14 @@
-## Next release - 2.2.0
+## Stable
 
-- Checkout transparente
+2.3.0
 
-## Stable
+- Modelo de aplicações (autenticação na api como vendedor ou como aplicação)
+- Removendo utilização de threads para armazenar o objeto de configuração (a abordagem com threads não funciona no Rails 4, que é threadsafe)
+- Adicionando deprecation warnings para configuration writers do módulo PagSeguro. Será removido no futuro. Utilizar o bloco de configuração.
+
+2.2.0
+
+- Checkout transparente
 
 2.1.1
 

data/README.md

@@ -1,8 +1,7 @@
 # Biblioteca de integração PagSeguro em Ruby
 
-[![Build Status](https://travis-ci.org/pagseguro/ruby.png?branch=master)](https://travis-ci.org/pagseguro/ruby)
-
-[![Code Climate](https://codeclimate.com/github/pagseguro/ruby.png)](https://codeclimate.com/github/pagseguro/ruby)
+[![Build Status](https://travis-ci.org/pagseguro/ruby.svg?branch=master)](https://travis-ci.org/pagseguro/ruby)
+[![Code Climate](https://codeclimate.com/github/pagseguro/ruby/badges/gpa.svg)](https://codeclimate.com/github/pagseguro/ruby)
 
 ## Descrição
 
@@ -26,7 +25,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.2.0"
+gem "pagseguro-oficial", "~> 2.3.0"
 ```
 
  - Execute o comando `bundle install`.
@@ -37,8 +36,10 @@ Para fazer a autenticação, você precisará configurar as credenciais do PagSe
 
 ```ruby
 PagSeguro.configure do |config|
-  config.token = "seu token"
-  config.email = "seu e-mail"
+  config.token       = "seu token"
+  config.email       = "seu e-mail"
+  config.environment = :production # ou :sandbox. O padrão é production.
+  config.encoding    = "UTF-8" # ou ISO-8859-1. O padrão é UTF-8.
 end
 ```
 
@@ -200,6 +201,24 @@ visa_installments.each do |installment|
 end
 ```
 
+## Modelo de aplicações
+
+### Setando autorizações
+
+```ruby
+  options = {
+    credentials: PagSeguro::ApplicationCredentials.new("app4521929942", "1D47384E6565EBE664DAEF9AD690438B"),
+    permissions: [:searches, :notifications],
+    notification_url: 'foo.com.br',
+    redirect_url: 'bar.com.br'
+  }
+  response = PagSeguro::Authorization.new(options).authorize
+```
+Em seguida, acesse o link para confirmar as autorizações
+```ruby
+  response.url
+```
+
 ## API
 
 ### PagSeguro::PaymentRequest (utiliza versão V2)
@@ -287,10 +306,9 @@ payment.max_uses = 100
 payment.max_age = 3600  # em segundos
 ```
 
-#### Definindo environment e/ou encoding
+#### Definindo encoding
 
 ```ruby
-PagSeguro.environment = "production" # production ou sandbox
 PagSeguro.encoding = "UTF-8" # UTF-8 ou ISO-8859-1
 ```
 

data/examples/abandoned_transactions.rb

@@ -1,10 +1,22 @@
 require_relative "boot"
 require "active_support/all"
 
-report = PagSeguro::Transaction.find_abandoned(
-  starts_at: 30.days.ago,
-  size: 1
-)
+# Abandoned Transactions
+#
+#   The acount credentials (EMAIL, TOKEN) are required
+#
+#   You can pass the credentials parameters to PagSeguro::Transaction#find_abandoned
+
+options = {
+  credentials: PagSeguro::AccountCredentials.new('EMAIL', 'TOKEN')
+  # You can pass more arguments by params, look (/lib/pagseguro/transaction.rb)
+}
+
+report = PagSeguro::Transaction.find_abandoned(options)
+
+# OR through the application settings like the boot file example (/examples/boot.rb)
+#
+# report = PagSeguro::Transaction.find_abandoned
 
 while report.next_page?
   report.next_page!

data/examples/authorization.rb

@@ -0,0 +1,31 @@
+require_relative "boot"
+
+# Authorization
+#
+#   You need to give:
+#     - notification_url
+#     - redirect_url
+#     - permissions defaults to all permissions
+#     - applications credentials (APP_ID, APP_KEY)
+#
+#   You can pass this parameters to PagSeguro::AuthorizationRequest#new
+#
+# PS: For more details look the class PagSeguro::AuthorizationRequest
+
+credentials = PagSeguro::ApplicationCredentials.new('APP_ID', 'APP_KEY')
+
+options = {
+  credentials: credentials, # Unnecessary if you set in application config
+  permissions: [:searches, :notifications],
+  notification_url: 'http://example.com/',
+  redirect_url: 'http://example.com/'
+}
+
+authorization_request = PagSeguro::AuthorizationRequest.new(options)
+
+if authorization_request.create
+  print "Use this link to confirm authorizations: "
+  puts authorization_request.url
+else
+  puts authorization_request.errors.join("\n")
+end

data/examples/authorization_by_code.rb

@@ -0,0 +1,29 @@
+require_relative 'boot'
+
+# Authorization by code
+#
+#   You need to give:
+#     - authorization code
+#     - application credentials (APP_ID, APP_KEY) OR account credentials (EMAIL, TOKEN)
+#
+#   You can pass this parameters to PagSeguro::Authorization#find_by_code
+#
+# PS: For more details look the class PagSeguro::Authorization#find_by_code
+
+# credentials = PagSeguro::AccountCredentials.new("EMAIL", "TOKEN")
+credentials = PagSeguro::ApplicationCredentials.new("APP_ID", "APP_KEY")
+
+options = { credentials: credentials } # Unnecessary if you set in application config
+
+authorization = PagSeguro::Authorization.find_by_code('AUTHORIZATION_CODE', options)
+
+if authorization.errors.any?
+  puts authorization.errors.join("\n")
+else
+  authorization.permissions.each do |permission, index|
+    puts "Permission #{index}: "
+    puts "  code: #{permission.code}"
+    puts "  status: #{permission.status}"
+  end
+  puts
+end

data/examples/authorization_by_notification_code.rb

@@ -0,0 +1,30 @@
+require_relative 'boot'
+
+# Authorization by notification code
+#
+#   You need to give:
+#     - authorization code
+#     - application credentials (APP_ID, APP_KEY)
+#
+#   You can pass this parameters to PagSeguro::Authorization#find_by_notification_code
+#
+# PS: For more details look the class PagSeguro::Authorization#find_by_notification_code
+
+
+credentials = PagSeguro::ApplicationCredentials.new('APP_ID', 'APP_KEY')
+
+options = { credentials: credentials } # Unnecessary if you set in application config
+
+authorization = PagSeguro::Authorization.find_by_notification_code('NOTIFICATION_CODE', options)
+
+puts authorization.errors.inspect
+
+if authorization.errors.any?
+  puts authorization.errors.join("\n")
+else
+  authorization.permissions.each do |permission|
+    puts "Permission: "
+    puts permission.code
+    puts permission.status
+  end
+end

data/examples/boleto_transaction_request.rb

@@ -1,5 +1,11 @@
 require_relative "boot"
 
+# Credit card transaction request
+#
+# You need to set your AccountCredentials (EMAIL, TOKEN) in the application config
+#
+# P.S: See the boot file example for more details
+
 payment = PagSeguro::BoletoTransactionRequest.new
 payment.notification_url = "http://www.meusite.com.br/notification"
 payment.payment_mode = "default"

data/examples/boot.rb

@@ -4,6 +4,23 @@ require "pagseguro"
 I18n.locale = "pt-BR"
 
 PagSeguro.configure do |config|
-  config.token = ENV.fetch("PAGSEGURO_TOKEN")
-  config.email = ENV.fetch("PAGSEGURO_EMAIL")
+  # You can setup with Application Credentials trough TOKEN and EMAIL
+  #   config.token = ENV.fetch("PAGSEGURO_TOKEN")
+  #   config.email = ENV.fetch("PAGSEGURO_EMAIL")
+  #
+  # OR with Application Credentials through APP_ID and APP_KEY
+  #   config.app_id = ENV.fetch("PAGSEGURO_APP_ID")
+  #   config.app_key = ENV.fetch("PAGSEGURO_APP_KEY")
+  #
+  #
+  # Ps: You can set the credentials when you to call some service like:
+  #   For Account credentials based on EMAIL and TOKEN
+  #     - PagSeguro::ApplicationCredentials.new("appteste_1", "TESTE11111")
+  #
+  #   OR
+  #
+  #   For Application credentials based on APP_KEY and APP_ID
+  #     - PagSeguro::AccountCredentials.new("user@example.com", "token")
+
+  config.environment = :sandbox
 end

data/examples/create_session.rb

@@ -1,5 +1,11 @@
 require_relative "boot"
 
+# Create Session
+#
+# You need to set your AccountCredentials (EMAIL, TOKEN) in the application config
+#
+# P.S: See the boot file example for more details.
+
 session = PagSeguro::Session.create
 
 if session.errors.any?

data/examples/credit_card_transaction_request.rb

@@ -1,5 +1,11 @@
 require_relative "boot"
 
+# Credit card transaction request
+#
+# You need to set your AccountCredentials (EMAIL, TOKEN) in the application config
+#
+# P.S: See the boot file example for more details.
+
 payment = PagSeguro::CreditCardTransactionRequest.new
 payment.notification_url = "http://www.meusite.com.br/notification"
 payment.payment_mode = "gateway"

data/examples/installment.rb

@@ -1,30 +1,40 @@
 require_relative "boot"
 
-installments = PagSeguro::Installment.find("100.00")
+# Installment
+#
+# Required AccountCredentials
+#
+#   You need to give:
+#     - amount
+#     - brand_card
+#     - account credentials (EMAIL, TOKEN)
+#
+#   You can pass this parameters to PagSeguro::Installment#find
+
+credentials = PagSeguro::AccountCredentials.new('EMAIL', 'TOKEN')
+
+options = {
+  credentials: credentials # Unnecessary if you set in application config
+}
+
+installments = PagSeguro::Installment.find("100.00", nil, options)
 
 if installments.errors.any?
-  puts "=> ERRORS"
   puts installments.errors.join("\n")
-  puts installments.inspect
 else
   puts "=> INSTALLMENTS"
   puts
   installments.each do |installment|
     puts installment.inspect
   end
-end
 
-visa_installments = PagSeguro::Installment.find("100.00", "visa")
+  visa_installments = PagSeguro::Installment.find("100.00", :visa, options)
 
-puts
-if installments.errors.any?
-  puts "=> ERRORS"
-  puts installments.errors.join("\n")
-  puts installments.inspect
-else
+  puts
   puts "=> VISA INSTALLMENTS"
   puts
   visa_installments.each do |installment|
     puts installment.inspect
   end
 end
+

data/examples/invalid_transaction_by_notification_code.rb

@@ -1,6 +1,19 @@
 require_relative "boot"
 
-transaction = PagSeguro::Transaction.find_by_notification_code("Invalid")
+# Invalid transaction by notification code
+#
+#   You need to give:
+#     - notification code (invalid)
+#     - account credentials (EMAIL, TOKEN) OR application credentials (APP_ID, APP_KEY)
+#
+#   You can pass this parameters to PagSeguro::Transaction#find_by_notification_code
+
+# credentials = PagSeguro::ApplicationCredentials.new('APP_ID', 'APP_KEY')
+credentials = PagSeguro::AccountCredentials.new('EMAIL', 'TOKEN')
+
+options = { credentials: credentials } # Unnecessary if you set in application config
+
+transaction = PagSeguro::Transaction.find_by_notification_code("Invalid", options)
 
 if transaction.errors.any?
   puts transaction.errors.join("\n")

data/examples/online_debit_transaction.rb

@@ -1,5 +1,11 @@
 require_relative "boot"
 
+# Credit card transaction request
+#
+# You need to set your AccountCredentials (EMAIL, TOKEN) in the application config
+#
+# P.S: See the boot file example for more details.
+
 payment = PagSeguro::OnlineDebitTransactionRequest.new
 payment.notification_url = "http://www.meusite.com.br/notification"
 payment.payment_mode = "gateway"

data/examples/payment_request.rb

@@ -1,11 +1,22 @@
 # -*- encoding : utf-8 -*-
 require_relative "boot"
 
+# Payment request
+#
+# You need to set your AccountCredentials (EMAIL, TOKEN) in the application config
+#
+# P.S: See the boot file example for more details.
+
 payment = PagSeguro::PaymentRequest.new
 payment.abandon_url = "http://dev.simplesideias.com.br/?abandoned"
 payment.notification_url = "http://dev.simplesideias.com.br/?notification"
 payment.redirect_url = "http://dev.simplesideias.com.br/?redirect"
 
+# if you don't want use the application config, can give your credentials object to payment request
+#
+# payment.credentials = PagSeguro::AccountCredentials.new('rafaelrpbelo@gmail.com', 'E280E0A9B6FA48A2AA9E4E73B5A6FC60')
+
+
 payment.items << {
   id: 1234,
   description: %[Televisão 19" Sony],

data/examples/transaction_by_code.rb

@@ -1,9 +1,22 @@
 require_relative "boot"
 
-transaction = PagSeguro::Transaction.find_by_code("E69FCE5813A142C29EB9B9652BCDC1A8")
+# Transaction by code
+#
+#   You need to give:
+#     - transaction code
+#     - account credentials (EMAIL, TOKEN) OR application credentials (APP_ID, APP_KEY)
+#
+#   You can pass this parameters to PagSeguro::Transaction#find_by_code
+
+# credentials = PagSeguro::ApplicationCredentials.new('APP_ID', 'APP_KEY')
+credentials = PagSeguro::AccountCredentials.new('EMAIL', 'TOKEN')
+
+options = { credentials: credentials } # Unnecessary if you set in application config
+
+transaction = PagSeguro::Transaction.find_by_code("TRANSACTION_CODE", options)
 
 if transaction.errors.any?
-  transaction.errors.join("\n")
+  puts transaction.errors.join("\n")
 else
   puts "=> Transaction"
   puts "  code: #{transaction.code}"
@@ -19,18 +32,19 @@ else
   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 "  installment count: #{transaction.installments}"
 
-  puts "    => Payment Release"
+  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}"
+    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"

data/examples/transaction_by_notification_code.rb

@@ -1,9 +1,22 @@
 require_relative "boot"
 
-transaction = PagSeguro::Transaction.find_by_notification_code("739D69-79C052C05280-55542D9FBB33-4AB2D0")
+# Transaction by notification code
+#
+#   You need to give:
+#     - transaction notification code
+#     - account credentials (EMAIL, TOKEN) OR application credentials (APP_ID, APP_KEY)
+#
+#   You can pass this parameters to PagSeguro::Transaction#find_by_code
+
+# credentials = PagSeguro::ApplicationCredentials.new('APP_ID', 'APP_KEY')
+credentials = PagSeguro::AccountCredentials.new('EMAIL', 'TOKEN')
+
+options = { credentials: credentials } # Unnecessary if you set in application config
+
+transaction = PagSeguro::Transaction.find_by_notification_code("NOTIFICATION_CODE", options)
 
 if transaction.errors.any?
-  transaction.errors.join("\n")
+  puts transaction.errors.join("\n")
 else
   puts "=> Transaction"
   puts "  code: #{transaction.code}"
@@ -23,15 +36,15 @@ else
   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 "  installment count: #{transaction.installments}"
 
-  puts "    => Payment Release"
+  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}"
+    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"

data/examples/transaction_by_reference.rb

@@ -1,6 +1,18 @@
 require_relative 'boot'
 
-transaction = PagSeguro::Transaction.find_by_reference("REF1234")
+# Transaction by reference
+#
+#   You need to give:
+#     - reference code
+#     - account credentials (EMAIL, TOKEN)
+#
+#   You can pass this parameters to PagSeguro::Transaction#find_by_reference
+
+credentials = PagSeguro::AccountCredentials.new('EMAIL', 'TOKEN')
+
+options = { credentials: credentials } # Unnecessary if you set in application config
+
+transaction = PagSeguro::Transaction.find_by_reference("REFERENCE_CODE", options)
 
 while transaction.next_page?
   transaction.next_page!

data/examples/transactions_by_date.rb

@@ -1,7 +1,23 @@
 require_relative "boot"
 require "active_support/all"
 
-report = PagSeguro::Transaction.find_by_date(starts_at: 29.days.ago, per_page: 1)
+# Transactions by date
+#
+#   You need to give:
+#     - reference code
+#     - account credentials (EMAIL, TOKEN)
+#
+#   You can pass this parameters to PagSeguro::Transaction#find_by_date
+
+credentials = PagSeguro::AccountCredentials.new('EMAIL', 'TOKEN')
+
+options = {
+  starts_at: 29.days.ago,
+  per_page: 1,
+  credentials: credentials # Unnecessary if you set in application config
+}
+
+report = PagSeguro::Transaction.find_by_date(options)
 
 while report.next_page?
   report.next_page!

data/lib/pagseguro/account_credentials.rb

@@ -0,0 +1,14 @@
+module PagSeguro
+  class AccountCredentials
+    # The user email
+    attr_accessor :email
+
+    # The token related to the user
+    attr_accessor :token
+
+    def initialize(email, token)
+      @email = email
+      @token = token
+    end
+  end
+end

data/lib/pagseguro/application_credentials.rb

@@ -0,0 +1,18 @@
+module PagSeguro
+  class ApplicationCredentials
+    # The application id
+    attr_accessor :app_id
+
+    # The token related to the application
+    attr_accessor :app_key
+
+    # The application authorization code
+    attr_accessor :authorization_code
+
+    def initialize(app_id, app_key, authorization_code = nil)
+      @app_id = app_id
+      @app_key = app_key
+      @authorization_code = authorization_code
+    end
+  end
+end

data/lib/pagseguro/authorization/collection.rb

@@ -0,0 +1,26 @@
+module PagSeguro
+  class Authorization
+    class Collection
+      extend Forwardable
+
+      def_delegators :@authorizations, :each, :empty?, :any?
+
+      def initialize(options)
+        @errors = options[:errors] if options[:errors]
+        @authorizations = instantiate_authorizations(options[:authorizations])
+      end
+
+      def errors
+        @errors ||= Errors.new
+      end
+
+      private
+      def instantiate_authorizations(authorizations)
+        return [] unless authorizations
+        authorizations.map do |authorization|
+          Authorization.new(authorization)
+        end
+      end
+    end
+  end
+end

data/lib/pagseguro/authorization/request_serializer.rb

@@ -0,0 +1,24 @@
+module PagSeguro
+  class Authorization
+    class RequestSerializer
+      attr_reader :authorization
+
+      def initialize(authorization)
+        @authorization = authorization
+      end
+
+      def to_params
+        params[:credentials] = authorization.credentials if authorization.respond_to? :credentials
+        params[:initialDate] = authorization.initial_date if authorization.respond_to? :initial_date
+        params[:finalDate]   = authorization.final_date if authorization.respond_to? :final_date
+
+        params
+      end
+
+      private
+      def params
+        @params ||= {}
+      end
+    end
+  end
+end