pagseguro-oficial 2.2.0 → 2.3.0

data/lib/pagseguro.rb

@@ -6,12 +6,24 @@ require "nokogiri"
 require "aitch"
 require "i18n"
 
-require "pagseguro/version"
-require "pagseguro/config"
-
 require "pagseguro/extensions/mass_assignment"
 require "pagseguro/extensions/ensure_type"
+require "pagseguro/extensions/credentiable"
+
+require "pagseguro/version"
+require "pagseguro/config"
 
+require "pagseguro/account_credentials"
+require "pagseguro/application_credentials"
+require "pagseguro/authorization"
+require "pagseguro/authorization/collection"
+require "pagseguro/authorization/request_serializer"
+require "pagseguro/authorization/response_serializer"
+require "pagseguro/authorization/response"
+require "pagseguro/authorization_request"
+require "pagseguro/authorization_request/request_serializer"
+require "pagseguro/authorization_request/response_serializer"
+require "pagseguro/authorization_request/response"
 require "pagseguro/creditor_fee"
 require "pagseguro/errors"
 require "pagseguro/exceptions"
@@ -36,12 +48,15 @@ require "pagseguro/payment_request"
 require "pagseguro/payment_request/serializer"
 require "pagseguro/payment_request/response"
 require "pagseguro/payment_status"
+require "pagseguro/permission"
 require "pagseguro/request"
 require "pagseguro/sender"
 require "pagseguro/session"
 require "pagseguro/session/response"
 require "pagseguro/session/response_serializer"
 require "pagseguro/notification"
+require "pagseguro/notification/authorization"
+require "pagseguro/notification/transaction"
 require "pagseguro/transaction"
 require "pagseguro/transaction/response"
 require "pagseguro/transaction/serializer"
@@ -64,19 +79,44 @@ module PagSeguro
   class << self
     # Delegates some calls to the config object
     extend Forwardable
-    def_delegators :configuration, :email, :receiver_email, :token
-    def_delegators :configuration, :email=, :receiver_email=, :token=
+    def_delegators :configuration, :email, :receiver_email, :token,
+      :environment, :encoding, :app_id, :app_key
 
-    # The encoding that will be used.
-    attr_accessor :encoding
+    def email=(email)
+      warn "[DEPRECATION] `email=` is deprecated and will be removed. Please use configuration block instead."
+      configuration.email = email
+    end
 
-    # The PagSeguro environment.
-    # +production+ or +sandbox+.
-    attr_accessor :environment
+    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
+
+    def token=(token)
+      warn "[DEPRECATION] `token=` is deprecated and will be removed. Please use configuration block instead."
+      configuration.token = token
+    end
+
+    def environment=(environment)
+      warn "[DEPRECATION] `environment=` is deprecated and will be removed. Please use configuration block instead."
+      configuration.environment = environment
+    end
+
+    def encoding=(encoding)
+      warn "[DEPRECATION] `encoding=` is deprecated and will be removed. Please use configuration block instead."
+      configuration.encoding = encoding
+    end
   end
 
-  self.encoding = "UTF-8"
-  self.environment = :production
+  # Returns an object with the configured account credentials
+  def self.account_credentials
+    PagSeguro::AccountCredentials.new(PagSeguro.email, PagSeguro.token)
+  end
+
+  # Returns an object with the configured application credentials
+  def self.application_credentials
+    PagSeguro::ApplicationCredentials.new(PagSeguro.app_id, PagSeguro.app_key)
+  end
 
   # Register endpoints by environment.
   def self.uris
@@ -99,9 +139,9 @@ module PagSeguro
     root[type.to_sym]
   end
 
-  # The configuration intance for the thread
+  # The configuration instance
   def self.configuration
-    Thread.current[:pagseguro_config] ||= PagSeguro::Config.new
+    @configuration ||= PagSeguro::Config.new
   end
 
   # Set the global configuration.
@@ -109,6 +149,9 @@ module PagSeguro
   #   PagSeguro.configure do |config|
   #     config.email = "john@example.com"
   #     config.token = "abc"
+  #     config.app_id = "app12345"
+  #     config.app_key = "adju3cmADc52C"
+  #     config.environment = :sandbox
   #   end
   #
   def self.configure(&block)

data/locales/pt-BR.yml

@@ -2,6 +2,7 @@ pt-BR:
   pagseguro:
     errors:
       unauthorized: "Não autorizado."
+      not_found: "Não encontrado."
       "10001": "O parâmetro email deve ser informado."
       "10002": "O parâmetro token deve ser informado."
       "10003": "O valor informado no parâmetro email é inválido."

data/pagseguro-oficial.gemspec

@@ -26,7 +26,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec"
   spec.add_development_dependency "autotest-standalone"
-  spec.add_development_dependency "test_notifier"
   spec.add_development_dependency "simplecov"
   spec.add_development_dependency "fakeweb"
 end

data/spec/fixtures/authorization/find_authorization.xml

@@ -0,0 +1,17 @@
+<authorization>
+  <code>9D7FF2E921216F1334EE9FBEB7B4EBBC</code>
+  <creationDate>2011-03-30T14:20:13.000-03:00</creationDate>
+  <reference>ref1234</reference>
+  <permissions>
+    <permission>
+      <code>CREATE_CHECKOUTS</code>
+      <status>APPROVED</status>
+      <lastUpdate>2011-03-30T15:35:44.000-03:00</lastUpdate>
+    </permission>
+    <permission>
+      <code>SEARCH_TRANSACTIONS</code>
+      <status>APPROVED</status>
+      <lastUpdate>2011-03-30T14:20:13.000-03:00</lastUpdate>
+    </permission>
+  </permissions>
+</authorization>

data/spec/fixtures/authorization_request/success.xml

@@ -0,0 +1,4 @@
+<authorizationRequest>
+  <code>D8DD848AC9C98D9EE44C5FB3A1E53913</code>
+  <date>2011-02-25T11:40:50.000-03:00</date>
+</authorizationRequest>

data/spec/pagseguro/account_credentials_spec.rb

@@ -0,0 +1,10 @@
+require 'spec_helper'
+
+describe PagSeguro::AccountCredentials do
+  describe 'credentials attributes' do
+    credentials = PagSeguro::AccountCredentials.new('foo@bar.com', 'token')
+
+    it { expect(credentials.email).to eq('foo@bar.com') }
+    it { expect(credentials.token).to eq('token') }
+  end
+end

data/spec/pagseguro/application_credentials_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe PagSeguro::ApplicationCredentials do
+  describe 'credentials attributes' do
+    credentials = PagSeguro::ApplicationCredentials.new('app123', 'qwerty')
+
+    it { expect(credentials.app_id).to eq('app123') }
+    it { expect(credentials.app_key).to eq('qwerty') }
+    it { expect(credentials.authorization_code).to be_nil }
+  end
+end

data/spec/pagseguro/authorization/collection_spec.rb

@@ -0,0 +1,49 @@
+require 'spec_helper'
+
+describe PagSeguro::Authorization::Collection do
+  let(:permission) { double(:permission) }
+  let(:authorizations) do
+    [
+      { code: '1234', created_at: Date.today,  permissions: [permission] },
+      { code: '4321', created_at: Date.today,  permissions: [permission, permission] }
+    ]
+  end
+  subject { described_class.new({authorizations: authorizations}) }
+
+  describe "initialization" do
+    context "when options[:errors] is present" do
+      let(:errors) { double(:errors) }
+      subject { described_class.new({errors: errors}) }
+
+      it "sets errors" do
+        expect(subject.errors).to eq(errors)
+      end
+
+      it "has no authorizations" do
+        expect(subject).to be_empty
+      end
+    end
+
+    context "when options[:authorizations] is present" do
+      it { expect(subject).to be_any }
+      it { expect(subject).not_to be_empty }
+
+      it "has authorizations instances" do
+        subject.each do |installment|
+          expect(installment).to be_a(PagSeguro::Authorization)
+        end
+      end
+    end
+  end
+
+  describe "#errors" do
+    it { expect(subject.errors).to be_a(PagSeguro::Errors) }
+    it { expect(subject.errors).to be_empty }
+  end
+
+  describe "method delegation" do
+    it { subject.respond_to? (:each) }
+    it { subject.respond_to? (:empty?) }
+    it { subject.respond_to? (:any?) }
+  end
+end

data/spec/pagseguro/authorization/request_serializer_spec.rb

@@ -0,0 +1,11 @@
+require "spec_helper"
+
+describe PagSeguro::Authorization::RequestSerializer do
+  let(:credentials) { PagSeguro::ApplicationCredentials.new('app11', 'sada') }
+  let(:options) { { credentials: credentials } }
+  let(:authorization) { PagSeguro::Authorization.new(options) }
+  let(:serializer) { described_class.new(authorization) }
+  let(:params) { serializer.to_params }
+
+  it{ expect(params).to include(credentials: credentials) }
+end

data/spec/pagseguro/authorization/response_serializer_spec.rb

@@ -0,0 +1,19 @@
+require "spec_helper"
+
+describe PagSeguro::Authorization::ResponseSerializer do
+  context "when payment request is created" do
+    let(:source) { File.read("./spec/fixtures/authorization/find_authorization.xml") }
+    let(:xml) { Nokogiri::XML(source) }
+    let(:serializer) { described_class.new(xml.css("authorization").first) }
+
+    subject(:data) { serializer.serialize }
+
+    it { expect(data[:code]).to eql("9D7FF2E921216F1334EE9FBEB7B4EBBC") }
+    it { expect(data[:created_at]).to eql(Time.parse("2011-03-30T14:20:13.000-03:00")) }
+    it { expect(data[:reference]).to eql("ref1234") }
+    it { expect(data[:permissions]).to be_a(Array) }
+    it { expect(data[:permissions].first.code).to eq("CREATE_CHECKOUTS") }
+    it { expect(data[:permissions].first.status).to eq("APPROVED") }
+  end
+end
+

data/spec/pagseguro/authorization/response_spec.rb

@@ -0,0 +1,35 @@
+require "spec_helper"
+
+describe PagSeguro::Authorization::Response do
+  let(:xml) { File.read("./spec/fixtures/authorization/find_authorization.xml") }
+  let(:http_response) do
+    response = double(body: xml, code: 200, content_type: "text/xml", "[]" => nil)
+    Aitch::Response.new({xml_parser: Aitch::XMLParser}, response)
+  end
+
+
+  describe "#serialize" do
+    subject { described_class.new(http_response, authorization) }
+    let(:authorization) { PagSeguro::Authorization.new }
+
+    context "when request succeeds" do
+      let(:serializer) { double(:serializer) }
+      let(:serialized_data) { { code: "1234"} }
+
+      it "returns a hash with serialized response data" do
+        expect(subject.serialize).to eq(authorization)
+      end
+    end
+
+    context "when request fails" do
+      before do
+        expect(http_response).to receive(:success?).and_return(false)
+      end
+
+      it "returns a hash with an errors object" do
+        expect(subject.serialize.errors).to be_a(PagSeguro::Errors)
+      end
+    end
+  end
+end
+

data/spec/pagseguro/authorization_request/request_serializer_spec.rb

@@ -0,0 +1,23 @@
+require "spec_helper"
+
+describe PagSeguro::AuthorizationRequest::RequestSerializer do
+  let(:credentials) { PagSeguro::ApplicationCredentials.new('app11', 'sada') }
+  let(:options) do
+    {
+      credentials: credentials,
+      permissions: [:checkouts, :notifications],
+      notification_url: 'foo.com',
+      redirect_url: 'bar.com',
+      reference: 'ref1234'
+    }
+  end
+  let(:authorization) { PagSeguro::AuthorizationRequest.new(options) }
+  let(:serializer) { described_class.new(authorization) }
+  let(:params) { serializer.to_params }
+
+  it{ expect(params).to include(credentials: credentials) }
+  it{ expect(params).to include(permissions: 'CREATE_CHECKOUTS,RECEIVE_TRANSACTION_NOTIFICATIONS') }
+  it{ expect(params).to include(notificationURL: 'foo.com') }
+  it{ expect(params).to include(redirectURL: 'bar.com') }
+  it{ expect(params).to include(reference: 'ref1234') }
+end

data/spec/pagseguro/authorization_request/response_serializer_spec.rb

@@ -0,0 +1,15 @@
+require "spec_helper"
+
+describe PagSeguro::AuthorizationRequest::ResponseSerializer do
+  context "when payment request is created" do
+    let(:source) { File.read("./spec/fixtures/authorization_request/success.xml") }
+    let(:xml) { Nokogiri::XML(source) }
+    let(:serializer) { described_class.new(xml.css("authorizationRequest").first) }
+
+    subject(:data) { serializer.serialize }
+
+    it { expect(data[:code]).to eql("D8DD848AC9C98D9EE44C5FB3A1E53913") }
+    it { expect(data[:date]).to eql(Time.parse("2011-02-25T11:40:50.000-03:00")) }
+  end
+end
+

data/spec/pagseguro/authorization_request/response_spec.rb

@@ -0,0 +1,36 @@
+require "spec_helper"
+
+describe PagSeguro::AuthorizationRequest::Response do
+  let(:http_response) do
+    response = double(body: "", code: 200, content_type: "text/xml", "[]" => nil)
+    Aitch::Response.new({xml_parser: Aitch::XMLParser}, response)
+  end
+
+  subject { described_class.new(http_response) }
+
+  describe "#serialize" do
+    context "when request succeeds" do
+      let(:serializer) { double(:serializer) }
+      let(:serialized_data) { double(:serialized_data) }
+
+      it "returns a hash with serialized response data" do
+        expect(PagSeguro::AuthorizationRequest::ResponseSerializer).to receive(:new)
+          .and_return(serializer)
+        expect(serializer).to receive(:serialize).and_return(serialized_data)
+
+        expect(subject.serialize).to eq(serialized_data)
+      end
+    end
+
+    context "when request fails" do
+      before do
+        expect(http_response).to receive(:success?).and_return(false)
+      end
+
+      it "returns a hash with an errors object" do
+        expect(subject.serialize[:errors]).to be_a(PagSeguro::Errors)
+      end
+    end
+  end
+end
+

data/spec/pagseguro/authorization_request_spec.rb

@@ -0,0 +1,62 @@
+require 'spec_helper'
+
+describe PagSeguro::AuthorizationRequest do
+  it_assigns_attribute :permissions
+  it_assigns_attribute :reference
+  it_assigns_attribute :notification_url
+  it_assigns_attribute :redirect_url
+
+  describe "#create" do
+    let(:request) { double(:request) }
+    let(:response) { double(:response) }
+    let(:options) do
+      {
+        notification_url: "foo",
+        redirect_url: "bar",
+        permissions: [:notifications, :searches]
+      }
+    end
+
+    let(:params) do
+      {
+        notificationURL: "foo",
+        redirectURL: "bar",
+        permissions: "RECEIVE_TRANSACTION_NOTIFICATIONS,SEARCH_TRANSACTIONS"
+      }
+    end
+
+    subject { described_class.new(options) }
+
+    before do
+      expect(PagSeguro::Request).to receive(:post)
+        .with("authorizations/request", 'v2', params)
+        .and_return(request)
+      expect(PagSeguro::AuthorizationRequest::Response).to receive(:new)
+        .with(request)
+        .and_return(response)
+      expect(response).to receive(:serialize).and_return(serialized_data)
+    end
+
+    context "when request succeeds" do
+      let(:serialized_data) { {code: "123"} }
+
+      it "creates a transaction request" do
+        expect(response).to receive(:success?).and_return(true)
+
+        expect(subject.create).to be_truthy
+        expect(subject.code).to eq(serialized_data[:code])
+      end
+    end
+
+    context "when request fails" do
+      let(:serialized_data) { {errors: PagSeguro::Errors.new} }
+
+      it "does not create a transaction request" do
+        expect(response).to receive(:success?).and_return(false)
+
+        expect(subject.create).to be_falsey
+        expect(subject.code).to be_nil
+      end
+    end
+  end
+end

data/spec/pagseguro/authorization_spec.rb

@@ -0,0 +1,69 @@
+require 'spec_helper'
+
+describe PagSeguro::Authorization do
+  let(:code) { "1234" }
+  let(:notification_code) { "4321" }
+  let(:crendentials) { double(:crendentials) }
+  let(:options) { { crendentials: crendentials} }
+  let(:request) { double(:request) }
+  let(:response) { double(:response) }
+  let(:serialized_data) { { code: 1234 } }
+  let(:authorization) { double(:authorization) }
+  let(:collection) { double(:collection) }
+
+  describe ".find_by_notification_code" do
+    before do
+      expect(PagSeguro::Request).to receive(:get)
+        .with("authorizations/notifications/4321", 'v2', options)
+        .and_return(request)
+      expect(PagSeguro::Authorization).to receive(:new)
+        .and_return(authorization)
+      expect(PagSeguro::Authorization::Response).to receive(:new)
+        .with(request, authorization)
+        .and_return(response)
+      expect(response).to receive(:serialize)
+    end
+
+    it "finds authorization by the given notificationCode" do
+      expect(PagSeguro::Authorization.find_by_notification_code(notification_code, options))
+        .to eq(authorization)
+    end
+  end
+
+  describe ".find_by_code" do
+    before do
+      expect(PagSeguro::Request).to receive(:get)
+        .with("authorizations/1234", 'v2', options)
+        .and_return(request)
+      expect(PagSeguro::Authorization).to receive(:new)
+        .and_return(authorization)
+      expect(PagSeguro::Authorization::Response).to receive(:new)
+        .with(request, authorization)
+        .and_return(response)
+      expect(response).to receive(:serialize)
+    end
+
+    it "finds authorization by the given notificationCode" do
+      expect(PagSeguro::Authorization.find_by_code(code, options)).to eq(authorization)
+    end
+  end
+
+  describe "find_by_date" do
+    let(:date_options) { { initial_date: Date.today, final_date: Date.today + 1 } }
+    before do
+      expect(PagSeguro::Request).to receive(:get)
+        .with("authorizations", 'v2', {})
+        .and_return(request)
+      expect(PagSeguro::Authorization::Collection).to receive(:new)
+        .and_return(collection)
+      expect(PagSeguro::Authorization::Response).to receive(:new)
+        .with(request, collection)
+        .and_return(response)
+      expect(response).to receive(:serialize_collection)
+    end
+
+    it 'finds authorizations by a date range' do
+      expect(PagSeguro::Authorization.find_by_date(date_options)).to eq (collection)
+    end
+  end
+end

data/spec/pagseguro/errors_spec.rb

@@ -3,7 +3,7 @@ require "spec_helper"
 
 describe PagSeguro::Errors do
   let(:response) { double }
-  let(:http_response) { double(:http_response, unauthorized?: true, bad_request?: false) }
+  let(:http_response) { double(:http_response, unauthorized?: true, bad_request?: false, not_found?: false) }
 
   context "when have no response" do
     it "returns errors" do
@@ -16,7 +16,7 @@ describe PagSeguro::Errors do
     subject(:errors) { PagSeguro::Errors.new(response) }
 
     before do
-      response.stub unauthorized?: true, bad_request?: false
+      response.stub unauthorized?: true, bad_request?: false, not_found?: false
       errors.add(http_response)
     end
 
@@ -24,6 +24,18 @@ describe PagSeguro::Errors do
     it { expect(errors).to include(I18n.t("pagseguro.errors.unauthorized")) }
   end
 
+  context "when not found" do
+    subject(:errors) { PagSeguro::Errors.new(response) }
+
+    before do
+      response.stub unauthorized?: true, bad_request?: false, not_found?: true
+      errors.add(http_response)
+    end
+
+    it { expect(errors).not_to be_empty }
+    it { expect(errors).to include(I18n.t("pagseguro.errors.not_found")) }
+  end
+
   context "when message can't be translated" do
     let(:error) {
       <<-XML
@@ -40,7 +52,7 @@ describe PagSeguro::Errors do
     subject(:errors) { PagSeguro::Errors.new(response) }
 
     before do
-      response.stub data: xml, unauthorized?: false, bad_request?: true
+      response.stub data: xml, unauthorized?: false, bad_request?: true, not_found?: true
     end
 
     it { expect(errors).to include("Sample message") }
@@ -62,7 +74,7 @@ describe PagSeguro::Errors do
     subject(:errors) { PagSeguro::Errors.new(response) }
 
     before do
-      response.stub data: xml, unauthorized?: false, bad_request?: true
+      response.stub data: xml, unauthorized?: false, bad_request?: true, not_found?: false
     end
 
     it { expect(errors).to include("O parâmetro email deve ser informado.") }
@@ -85,7 +97,7 @@ describe PagSeguro::Errors do
     subject(:errors) { PagSeguro::Errors.new(response) }
 
     before do
-      response.stub data: xml, unauthorized?: false, bad_request?: true
+      response.stub data: xml, unauthorized?: false, bad_request?: true, not_found?: true
       errors.add(http_response)
     end
 

data/spec/pagseguro/installment/response_spec.rb

@@ -2,7 +2,8 @@ require "spec_helper"
 
 RSpec.describe PagSeguro::Installment::Response do
   let(:http_response) do
-    double(:request, success?: true, xml?: true, data: xml_parsed, body: raw_xml, unauthorized?: false)
+    double(:request, success?: true, xml?: true, data: xml_parsed,
+           body: raw_xml, unauthorized?: false, :not_found? => false)
   end
   let(:xml_parsed) { Nokogiri::XML(raw_xml) }
   let(:collection) { PagSeguro::Installment::Collection.new }
@@ -40,6 +41,7 @@ RSpec.describe PagSeguro::Installment::Response do
       before do
         allow(http_response).to receive(:success?).and_return(false)
         allow(http_response).to receive(:bad_request?).and_return(true)
+        allow(http_response).to receive(:not_found?).and_return(false)
       end
 
       let(:raw_xml) { File.read("./spec/fixtures/invalid_code.xml") }

data/spec/pagseguro/installment_spec.rb

@@ -8,7 +8,7 @@ describe PagSeguro::Installment do
   it_assigns_attribute :interest_free
 
   let(:request) do
-    double(:request, success?: true, xml?: true, body: raw_xml, data: xml_parsed, unauthorized?: false)
+    double(:request, success?: true, xml?: true, body: raw_xml, data: xml_parsed, unauthorized?: false, not_found?: false)
   end
 
   let(:xml_parsed) { Nokogiri::XML(raw_xml) }

data/spec/pagseguro/notification_spec.rb

@@ -3,16 +3,4 @@ require "spec_helper"
 describe PagSeguro::Notification do
   it_assigns_attribute :code
   it_assigns_attribute :type
-
-  it "detects notification as transaction" do
-    expect(PagSeguro::Notification.new(type: "transaction")).to be_transaction
-  end
-
-  it "fetches transaction by its notificationCode" do
-    PagSeguro::Transaction
-      .should_receive(:find_by_notification_code)
-      .with("CODE")
-
-    PagSeguro::Notification.new(code: "CODE").transaction
-  end
 end