Module: PagSeguro

Extended by:
Forwardable
Defined in:
lib/pagseguro.rb,
lib/pagseguro/bank.rb,
lib/pagseguro/item.rb,
lib/pagseguro/items.rb,
lib/pagseguro/phone.rb,
lib/pagseguro/config.rb,
lib/pagseguro/errors.rb,
lib/pagseguro/holder.rb,
lib/pagseguro/person.rb,
lib/pagseguro/phones.rb,
lib/pagseguro/sender.rb,
lib/pagseguro/account.rb,
lib/pagseguro/address.rb,
lib/pagseguro/company.rb,
lib/pagseguro/partner.rb,
lib/pagseguro/request.rb,
lib/pagseguro/session.rb,
lib/pagseguro/version.rb,
lib/pagseguro/document.rb,
lib/pagseguro/receiver.rb,
lib/pagseguro/shipping.rb,
lib/pagseguro/documents.rb,
lib/pagseguro/exceptions.rb,
lib/pagseguro/permission.rb,
lib/pagseguro/installment.rb,
lib/pagseguro/transaction.rb,
lib/pagseguro/creditor_fee.rb,
lib/pagseguro/notification.rb,
lib/pagseguro/subscription.rb,
lib/pagseguro/authorization.rb,
lib/pagseguro/payment_method.rb,
lib/pagseguro/payment_status.rb,
lib/pagseguro/receiver_split.rb,
lib/pagseguro/payment_release.rb,
lib/pagseguro/payment_request.rb,
lib/pagseguro/payment_releases.rb,
lib/pagseguro/session/response.rb,
lib/pagseguro/subscription_plan.rb,
lib/pagseguro/subscription_retry.rb,
lib/pagseguro/transaction/search.rb,
lib/pagseguro/transaction_refund.rb,
lib/pagseguro/transaction_status.rb,
lib/pagseguro/account_credentials.rb,
lib/pagseguro/transaction_request.rb,
lib/pagseguro/installment/response.rb,
lib/pagseguro/transaction/response.rb,
lib/pagseguro/authorization_request.rb,
lib/pagseguro/subscription/response.rb,
lib/pagseguro/subscription_discount.rb,
lib/pagseguro/authorization/response.rb,
lib/pagseguro/extensions/ensure_type.rb,
lib/pagseguro/installment/collection.rb,
lib/pagseguro/subscription_canceller.rb,
lib/pagseguro/transaction/collection.rb,
lib/pagseguro/transaction/serializer.rb,
lib/pagseguro/application_credentials.rb,
lib/pagseguro/extensions/credentiable.rb,
lib/pagseguro/transaction_installment.rb,
lib/pagseguro/authorization/collection.rb,
lib/pagseguro/notification/transaction.rb,
lib/pagseguro/payment_request/response.rb,
lib/pagseguro/subscription_transaction.rb,
lib/pagseguro/transaction_cancellation.rb,
lib/pagseguro/subscription_transactions.rb,
lib/pagseguro/boleto_transaction_request.rb,
lib/pagseguro/extensions/mass_assignment.rb,
lib/pagseguro/notification/authorization.rb,
lib/pagseguro/subscription_change_status.rb,
lib/pagseguro/subscription_payment_order.rb,
lib/pagseguro/subscription_plan/response.rb,
lib/pagseguro/manual_subscription_charger.rb,
lib/pagseguro/session/response_serializer.rb,
lib/pagseguro/subscription_change_payment.rb,
lib/pagseguro/subscription_payment_method.rb,
lib/pagseguro/subscription_retry/response.rb,
lib/pagseguro/transaction_refund/response.rb,
lib/pagseguro/extensions/collection_object.rb,
lib/pagseguro/transaction_request/response.rb,
lib/pagseguro/authorization_request/response.rb,
lib/pagseguro/installment/request_serializer.rb,
lib/pagseguro/subscription_discount/response.rb,
lib/pagseguro/credit_card_transaction_request.rb,
lib/pagseguro/installment/response_serializer.rb,
lib/pagseguro/subscription/request_serializer.rb,
lib/pagseguro/subscription_canceller/response.rb,
lib/pagseguro/authorization/request_serializer.rb,
lib/pagseguro/online_debit_transaction_request.rb,
lib/pagseguro/subscription/response_serializer.rb,
lib/pagseguro/subscription/subscription_search.rb,
lib/pagseguro/authorization/response_serializer.rb,
lib/pagseguro/transaction/search/search_by_date.rb,
lib/pagseguro/transaction_cancellation/response.rb,
lib/pagseguro/payment_request/request_serializer.rb,
lib/pagseguro/subscription_search_payment_orders.rb,
lib/pagseguro/subscription_change_status/response.rb,
lib/pagseguro/subscription_payment_order/response.rb,
lib/pagseguro/transaction/search/search_abandoned.rb,
lib/pagseguro/manual_subscription_charger/response.rb,
lib/pagseguro/subscription_change_payment/response.rb,
lib/pagseguro/subscription_plan/request_serializer.rb,
lib/pagseguro/subscription_plan/response_serializer.rb,
lib/pagseguro/transaction_refund/request_serializer.rb,
lib/pagseguro/transaction/search/search_by_reference.rb,
lib/pagseguro/transaction_refund/response_serializer.rb,
lib/pagseguro/transaction_request/request_serializer.rb,
lib/pagseguro/transaction_request/response_serializer.rb,
lib/pagseguro/authorization_request/request_serializer.rb,
lib/pagseguro/subscription_discount/request_serializer.rb,
lib/pagseguro/authorization_request/response_serializer.rb,
lib/pagseguro/transaction_cancellation/request_serializer.rb,
lib/pagseguro/transaction_cancellation/response_serializer.rb,
lib/pagseguro/subscription_change_status/request_serializer.rb,
lib/pagseguro/manual_subscription_charger/request_serializer.rb,
lib/pagseguro/subscription_change_payment/request_serializer.rb,
lib/pagseguro/subscription_payment_order/response_serializer.rb,
lib/pagseguro/manual_subscription_charger/response_serializer.rb

Defined Under Namespace

Modules: Extensions, Request Classes: Account, AccountCredentials, Address, ApplicationCredentials, Authorization, AuthorizationRequest, Bank, BoletoTransactionRequest, Company, Config, CreditCardTransactionRequest, CreditorFee, Document, Documents, Errors, Holder, Installment, Item, Items, ManualSubscriptionCharger, Notification, OnlineDebitTransactionRequest, Partner, PaymentMethod, PaymentRelease, PaymentReleases, PaymentRequest, PaymentStatus, Permission, Person, Phone, Phones, Receiver, ReceiverSplit, Search, SearchAbandoned, SearchByDate, SearchByReference, Sender, Session, Shipping, Subscription, SubscriptionCanceller, SubscriptionChangePayment, SubscriptionChangeStatus, SubscriptionDiscount, SubscriptionPaymentMethod, SubscriptionPaymentOrder, SubscriptionPlan, SubscriptionRetry, SubscriptionSearch, SubscriptionSearchPaymentOrders, SubscriptionTransaction, SubscriptionTransactions, Transaction, TransactionCancellation, TransactionInstallment, TransactionRefund, TransactionRequest, TransactionStatus

Constant Summary collapse

VERSION = 
"2.6.3"
InvalidEnvironmentError = 
Class.new(StandardError)

Class Method Summary collapse

Class Method Details

.account_credentials ⇒ Object

Returns an object with the configured account credentials



163
164
165
 
# File 'lib/pagseguro.rb', line 163

def self.
  PagSeguro::AccountCredentials.new(PagSeguro.email, PagSeguro.token)
end

.api_url(path) ⇒ Object

The API endpoint.



213
214
215
 
# File 'lib/pagseguro.rb', line 213

def self.api_url(path)
  File.join(root_uri(:api), path)
end

.application_credentials ⇒ Object

Returns an object with the configured application credentials



168
169
170
 
# File 'lib/pagseguro.rb', line 168

def self.application_credentials
  PagSeguro::ApplicationCredentials.new(PagSeguro.app_id, PagSeguro.app_key)
end

.configuration ⇒ Object

The configuration instance



194
195
196
 
# File 'lib/pagseguro.rb', line 194

def self.configuration
  @configuration ||= PagSeguro::Config.new
end

.configure {|configuration| ... } ⇒ Object

Set the global configuration.

PagSeguro.configure do |config|
  config.email = "[email protected]"
  config.token = "abc"
  config.app_id = "app12345"
  config.app_key = "adju3cmADc52C"
  config.environment = :sandbox
end

Yields:



208
209
210
 
# File 'lib/pagseguro.rb', line 208

def self.configure(&block)
  yield configuration
end

.email=(email) ⇒ Object 



136
137
138
139
 
# File 'lib/pagseguro.rb', line 136

def email=(email)
  warn "[DEPRECATION] `email=` is deprecated and will be removed. Please use configuration block instead."
  configuration.email = email
end

.encoding=(encoding) ⇒ Object 



156
157
158
159
 
# File 'lib/pagseguro.rb', line 156

def encoding=(encoding)
  warn "[DEPRECATION] `encoding=` is deprecated and will be removed. Please use configuration block instead."
  configuration.encoding = encoding
end

.environment=(environment) ⇒ Object 



151
152
153
154
 
# File 'lib/pagseguro.rb', line 151

def environment=(environment)
  warn "[DEPRECATION] `environment=` is deprecated and will be removed. Please use configuration block instead."
  configuration.environment = environment
end

.receiver_email=(receiver_email) ⇒ Object 



141
142
143
144
 
# File 'lib/pagseguro.rb', line 141

def receiver_email=(receiver_email)
  warn "[DEPRECATION] `receiver_email=` is deprecated and will be removed. Please use configuration block instead."
  configuration.receiver_email = receiver_email
end

.root_uri(type) ⇒ Object

Return the root uri based on its type. Current types are :api or :site



188
189
190
191
 
# File 'lib/pagseguro.rb', line 188

def self.root_uri(type)
  root = uris.fetch(environment.to_sym) { raise InvalidEnvironmentError }
  root[type.to_sym]
end

.site_url(path) ⇒ Object

The site url.



218
219
220
 
# File 'lib/pagseguro.rb', line 218

def self.site_url(path)
  File.join(root_uri(:site), path)
end

.token=(token) ⇒ Object 



146
147
148
149
 
# File 'lib/pagseguro.rb', line 146

def token=(token)
  warn "[DEPRECATION] `token=` is deprecated and will be removed. Please use configuration block instead."
  configuration.token = token
end

.uris ⇒ Object

Register endpoints by environment.



173
174
175
176
177
178
179
180
181
182
183
184
 
# File 'lib/pagseguro.rb', line 173

def self.uris
  @uris ||= {
    production: {
      api: "https://ws.pagseguro.uol.com.br/",
      site: "https://pagseguro.uol.com.br/"
    },
    sandbox: {
      site: 'https://sandbox.pagseguro.uol.com.br/',
      api:  'https://ws.sandbox.pagseguro.uol.com.br/'
    }
  }
end