dfg-paypal 0.8.2

data/spec/paypal/exception/api_error_spec.rb

@@ -0,0 +1,78 @@
+require 'spec_helper.rb'
+
+describe Paypal::Exception::APIError do
+  let(:error) { Paypal::Exception::APIError.new(params) }
+
+  context 'when Hash is given' do
+    let :params do
+      {
+        :VERSION=>"66.0",
+        :TIMESTAMP=>"2011-03-03T06:33:51Z",
+        :CORRELATIONID=>"758ebdc546b9c",
+        :BUILD=>"1741654",
+        :ACK=>"Failure",
+        :L_SEVERITYCODE0=>"Error",
+        :L_ERRORCODE0=>"10411",
+        :L_LONGMESSAGE0=>"This Express Checkout session has expired.  Token value is no longer valid.",
+        :L_SHORTMESSAGE0=>"This Express Checkout session has expired.",
+        :L_SEVERITYCODE1=>"Error",
+        :L_ERRORCODE1=>"2468",
+        :L_LONGMESSAGE1=>"Sample of a long message for the second item.",
+        :L_SHORTMESSAGE1=>"Second short message.",
+      }
+    end
+
+    describe "#message" do
+      it "aggregates short messages" do
+        error.message.should ==
+          "PayPal API Error: 'This Express Checkout session has expired.', 'Second short message.'"
+      end
+    end
+
+    describe '#subject' do
+      subject { error.response }
+      its(:raw) { should == params }
+      Paypal::Exception::APIError::Response.attribute_mapping.each do |key, attribute|
+        its(attribute) { should == params[key] }
+      end
+
+      describe '#details' do
+        subject { error.response.details.first }
+        Paypal::Exception::APIError::Response::Detail.attribute_mapping.each do |key, attribute|
+          its(attribute) { should == params[:"L_#{key}0"] }
+        end
+      end
+    end
+  end
+
+  context 'when unknown params given' do
+    let :params do
+      {
+        :UNKNOWN => 'Unknown',
+        :L_UNKNOWN0 => 'Unknown Detail'
+      }
+    end
+
+    it 'should warn' do
+      Paypal.logger.should_receive(:warn).with(
+        "Ignored Parameter (Paypal::Exception::APIError::Response): UNKNOWN=Unknown"
+      )
+      Paypal.logger.should_receive(:warn).with(
+        "Ignored Parameter (Paypal::Exception::APIError::Response::Detail): UNKNOWN=Unknown Detail"
+      )
+      error
+    end
+    describe '#response' do
+      subject { error.response }
+      its(:raw) { should == params }
+    end
+    its(:message) { should == "PayPal API Error" }
+  end
+
+  context 'otherwise' do
+    subject { error }
+    let(:params) { 'Failure' }
+    its(:response) { should == params }
+    its(:message) { should == "PayPal API Error" }
+  end
+end

data/spec/paypal/exception/http_error_spec.rb

@@ -0,0 +1,8 @@
+require 'spec_helper.rb'
+
+describe Paypal::Exception::HttpError do
+  subject { Paypal::Exception::HttpError.new(400, 'BadRequest', 'You are bad man!') }
+  its(:code)    { should == 400 }
+  its(:message) { should == 'BadRequest' }
+  its(:body)    { should == 'You are bad man!' }
+end

data/spec/paypal/express/request_spec.rb

@@ -0,0 +1,602 @@
+require 'spec_helper.rb'
+
+describe Paypal::Express::Request do
+  class Paypal::Express::Request
+    attr_accessor :_sent_params_, :_method_
+    def post_with_logging(method, params)
+      self._method_ = method
+      self._sent_params_ = params
+      post_without_logging method, params
+    end
+    alias_method_chain :post, :logging
+  end
+
+  let(:return_url) { 'http://example.com/success' }
+  let(:cancel_url) { 'http://example.com/cancel' }
+  let(:nvp_endpoint) { Paypal::NVP::Request::ENDPOINT[:production] }
+  let :attributes do
+    {
+      :username => 'nov',
+      :password => 'password',
+      :signature => 'sig'
+    }
+  end
+
+  let :instance do
+    Paypal::Express::Request.new attributes
+  end
+
+  let :instant_payment_request do
+    Paypal::Payment::Request.new(
+      :amount => 1000,
+      :description => 'Instant Payment Request'
+    )
+  end
+
+  let :many_items do
+    items = Array.new
+    (1..20).each do |index|
+      items << Paypal::Payment::Request::Item.new(
+        :name => "Item#{index.to_s}",
+        :description => "A new Item #{index.to_s}",
+        :amount => 50.00,
+        :quantity => 1
+      )
+    end
+  end
+
+  let :instant_payment_request_with_many_items do
+       Paypal::Payment::Request.new(
+      :amount => 1000,
+      :description => 'Instant Payment Request',
+      :items => many_items
+    )
+  end
+
+  let :recurring_payment_request do
+    Paypal::Payment::Request.new(
+      :billing_type => :RecurringPayments,
+      :billing_agreement_description => 'Recurring Payment Request'
+    )
+  end
+
+  let :recurring_profile do
+    Paypal::Payment::Recurring.new(
+      :start_date => Time.utc(2011, 2, 8, 9, 0, 0),
+      :description => 'Recurring Profile',
+      :billing => {
+        :period => :Month,
+        :frequency => 1,
+        :amount => 1000
+      }
+    )
+  end
+
+  let :reference_transaction_request do
+    Paypal::Payment::Request.new(
+      :billing_type => :MerchantInitiatedBilling,
+      :billing_agreement_description => 'Billing Agreement Request'
+    )
+  end
+
+  describe '.new' do
+    context 'when any required parameters are missing' do
+      it 'should raise AttrRequired::AttrMissing' do
+        attributes.keys.each do |missing_key|
+          insufficient_attributes = attributes.reject do |key, value|
+            key == missing_key
+          end
+          expect do
+            Paypal::Express::Request.new insufficient_attributes
+          end.to raise_error AttrRequired::AttrMissing
+        end
+      end
+    end
+
+    context 'when all required parameters are given' do
+      it 'should succeed' do
+        expect do
+          Paypal::Express::Request.new attributes
+        end.not_to raise_error AttrRequired::AttrMissing
+      end
+    end
+  end
+
+  describe '#setup' do
+    it 'should return Paypal::Express::Response' do
+      fake_response 'SetExpressCheckout/success'
+      response = instance.setup recurring_payment_request, return_url, cancel_url
+      response.should be_instance_of Paypal::Express::Response
+    end
+
+    it 'should support no_shipping option' do
+      expect do
+        instance.setup instant_payment_request, return_url, cancel_url, :no_shipping => true
+      end.to request_to nvp_endpoint, :post
+      instance._method_.should == :SetExpressCheckout
+      instance._sent_params_.should == {
+        :PAYMENTREQUEST_0_DESC => 'Instant Payment Request',
+        :RETURNURL => return_url,
+        :CANCELURL => cancel_url,
+        :PAYMENTREQUEST_0_AMT => '1000.00',
+        :PAYMENTREQUEST_0_TAXAMT => "0.00",
+        :PAYMENTREQUEST_0_SHIPPINGAMT => "0.00",
+        :REQCONFIRMSHIPPING => 0,
+        :NOSHIPPING => 1,
+        :version => Paypal.api_version
+      }
+    end
+
+    it 'should support allow_note=false option' do
+      expect do
+        instance.setup instant_payment_request, return_url, cancel_url, :allow_note => false
+      end.to request_to nvp_endpoint, :post
+      instance._method_.should == :SetExpressCheckout
+      instance._sent_params_.should == {
+        :PAYMENTREQUEST_0_DESC => 'Instant Payment Request',
+        :RETURNURL => return_url,
+        :CANCELURL => cancel_url,
+        :PAYMENTREQUEST_0_AMT => '1000.00',
+        :PAYMENTREQUEST_0_TAXAMT => "0.00",
+        :PAYMENTREQUEST_0_SHIPPINGAMT => "0.00",
+        :ALLOWNOTE => 0,
+        :version => Paypal.api_version
+      }
+    end
+
+    {
+      :solution_type => :SOLUTIONTYPE,
+      :landing_page => :LANDINGPAGE,
+      :email => :EMAIL,
+      :brand => :BRANDNAME,
+      :locale => :LOCALECODE,
+      :logo => :LOGOIMG,
+      :cart_border_color => :CARTBORDERCOLOR,
+      :payflow_color => :PAYFLOWCOLOR
+    }.each do |option_key, param_key|
+      it "should support #{option_key} option" do
+        expect do
+          instance.setup instant_payment_request, return_url, cancel_url, option_key => 'some value'
+        end.to request_to nvp_endpoint, :post
+        instance._method_.should == :SetExpressCheckout
+        instance._sent_params_.should include param_key
+        instance._sent_params_[param_key].should == 'some value'
+      end
+    end
+
+    context 'when instance payment request given' do
+      it 'should call SetExpressCheckout' do
+        expect do
+          instance.setup instant_payment_request, return_url, cancel_url
+        end.to request_to nvp_endpoint, :post
+        instance._method_.should == :SetExpressCheckout
+        instance._sent_params_.should == {
+          :PAYMENTREQUEST_0_DESC => 'Instant Payment Request',
+          :RETURNURL => return_url,
+          :CANCELURL => cancel_url,
+          :PAYMENTREQUEST_0_AMT => '1000.00',
+          :PAYMENTREQUEST_0_TAXAMT => "0.00",
+          :PAYMENTREQUEST_0_SHIPPINGAMT => "0.00",
+          :version => Paypal.api_version
+        }
+      end
+    end
+
+    context 'when recurring payment request given' do
+      it 'should call SetExpressCheckout' do
+        expect do
+          instance.setup recurring_payment_request, return_url, cancel_url
+        end.to request_to nvp_endpoint, :post
+        instance._method_.should == :SetExpressCheckout
+        instance._sent_params_.should == {
+          :L_BILLINGTYPE0 => :RecurringPayments,
+          :L_BILLINGAGREEMENTDESCRIPTION0 => 'Recurring Payment Request',
+          :RETURNURL => return_url,
+          :CANCELURL => cancel_url,
+          :PAYMENTREQUEST_0_AMT => '0.00',
+          :PAYMENTREQUEST_0_TAXAMT => "0.00",
+          :PAYMENTREQUEST_0_SHIPPINGAMT => "0.00",
+          :version => Paypal.api_version
+        }
+      end
+    end
+
+    context 'when reference transaction request given' do
+      it 'should call SetExpressCheckout' do
+        expect do
+          instance.setup reference_transaction_request, return_url, cancel_url
+        end.to request_to nvp_endpoint, :post
+        instance._method_.should == :SetExpressCheckout
+        instance._sent_params_.should == {
+          :L_BILLINGTYPE0 => :MerchantInitiatedBilling,
+          :L_BILLINGAGREEMENTDESCRIPTION0 => 'Billing Agreement Request',
+          :RETURNURL => return_url,
+          :CANCELURL => cancel_url,
+          :PAYMENTREQUEST_0_AMT => '0.00',
+          :PAYMENTREQUEST_0_TAXAMT => "0.00",
+          :PAYMENTREQUEST_0_SHIPPINGAMT => "0.00",
+          :version => Paypal.api_version
+        }
+      end
+    end
+  end
+
+  describe '#details' do
+    it 'should return Paypal::Express::Response' do
+      fake_response 'GetExpressCheckoutDetails/success'
+      response = instance.details 'token'
+      response.should be_instance_of Paypal::Express::Response
+    end
+
+    it 'should call GetExpressCheckoutDetails' do
+      expect do
+        instance.details 'token'
+      end.to request_to nvp_endpoint, :post
+      instance._method_.should == :GetExpressCheckoutDetails
+      instance._sent_params_.should == {
+        :TOKEN => 'token',
+        :version => Paypal.api_version
+      }
+    end
+  end
+
+  describe '#transaction_details' do
+    it 'should return Paypal::Express::Response' do
+      fake_response 'GetTransactionDetails/success'
+      response = instance.transaction_details 'transaction_id'
+      response.should be_instance_of Paypal::Express::Response
+    end
+
+    it 'should call GetTransactionDetails' do
+      expect do
+        instance.transaction_details 'transaction_id'
+      end.to request_to nvp_endpoint, :post
+      instance._method_.should == :GetTransactionDetails
+      instance._sent_params_.should == {
+        :TRANSACTIONID=> 'transaction_id'
+      }
+    end
+
+    it 'should fail with bad transaction id' do
+      expect do
+        fake_response 'GetTransactionDetails/failure'
+        response = instance.transaction_details 'bad_transaction_id'
+      end.to raise_error(Paypal::Exception::APIError)
+    end
+
+    it 'should handle all attributes' do
+      Paypal.logger.should_not_receive(:warn)
+      fake_response 'GetTransactionDetails/success'
+      response = instance.transaction_details 'transaction_id'
+    end
+  end
+
+  describe "#capture!" do
+    it 'should return Paypal::Express::Response' do
+      fake_response 'DoCapture/success'
+      response = instance.capture! 'authorization_id', 181.98, :BRL
+      response.should be_instance_of Paypal::Express::Response
+    end
+
+    it 'should call DoExpressCheckoutPayment' do
+      expect do
+        instance.capture! 'authorization_id', 181.98, :BRL
+      end.to request_to nvp_endpoint, :post
+
+      instance._method_.should == :DoCapture
+      instance._sent_params_.should == {
+        :AUTHORIZATIONID => 'authorization_id',
+        :COMPLETETYPE => 'Complete',
+        :AMT => 181.98,
+        :CURRENCYCODE => :BRL
+      }
+    end
+
+    it 'should call DoExpressCheckoutPayment with NotComplete capture parameter' do
+      expect do
+        instance.capture! 'authorization_id', 181.98, :BRL, 'NotComplete'
+      end.to request_to nvp_endpoint, :post
+
+      instance._method_.should == :DoCapture
+      instance._sent_params_.should == {
+        :AUTHORIZATIONID => 'authorization_id',
+        :COMPLETETYPE => 'NotComplete',
+        :AMT => 181.98,
+        :CURRENCYCODE => :BRL
+      }
+    end
+  end
+
+  describe "#void!" do
+    it 'should return Paypal::Express::Response' do
+      fake_response 'DoVoid/success'
+      response = instance.void! 'authorization_id', note: "note"
+      response.should be_instance_of Paypal::Express::Response
+    end
+
+    it 'should call DoVoid' do
+      expect do
+        instance.void! 'authorization_id', note: "note"
+      end.to request_to nvp_endpoint, :post
+
+      instance._method_.should == :DoVoid
+      instance._sent_params_.should == {
+        :AUTHORIZATIONID => 'authorization_id',
+        :NOTE => "note"
+      }
+    end
+  end
+
+  describe '#checkout!' do
+    it 'should return Paypal::Express::Response' do
+      fake_response 'DoExpressCheckoutPayment/success'
+      response = instance.checkout! 'token', 'payer_id', instant_payment_request
+      response.should be_instance_of Paypal::Express::Response
+    end
+
+    it 'should call DoExpressCheckoutPayment' do
+      expect do
+        instance.checkout! 'token', 'payer_id', instant_payment_request
+      end.to request_to nvp_endpoint, :post
+      instance._method_.should == :DoExpressCheckoutPayment
+      instance._sent_params_.should == {
+        :PAYERID => 'payer_id',
+        :TOKEN => 'token',
+        :PAYMENTREQUEST_0_DESC => 'Instant Payment Request',
+        :PAYMENTREQUEST_0_AMT => '1000.00',
+        :PAYMENTREQUEST_0_TAXAMT => "0.00",
+        :PAYMENTREQUEST_0_SHIPPINGAMT => "0.00",
+        :version => Paypal.api_version
+      }
+    end
+
+    context "with many items" do
+      before do
+        fake_response 'DoExpressCheckoutPayment/success_with_many_items'
+      end
+
+      it 'should handle all attributes' do
+        Paypal.logger.should_not_receive(:warn)
+        response = instance.checkout! 'token', 'payer_id', instant_payment_request_with_many_items
+      end
+
+      it 'should return Paypal::Express::Response' do
+        response = instance.checkout! 'token', 'payer_id', instant_payment_request_with_many_items
+        response.should be_instance_of Paypal::Express::Response
+      end
+
+      it 'should return twenty items' do
+        response = instance.checkout! 'token', 'payer_id', instant_payment_request_with_many_items
+        instance._method_.should == :DoExpressCheckoutPayment
+        response.items.count.should == 20
+      end
+    end
+  end
+
+  describe '#subscribe!' do
+    it 'should return Paypal::Express::Response' do
+      fake_response 'CreateRecurringPaymentsProfile/success'
+      response = instance.subscribe! 'token', recurring_profile
+      response.should be_instance_of Paypal::Express::Response
+    end
+
+    it 'should call CreateRecurringPaymentsProfile' do
+      expect do
+        instance.subscribe! 'token', recurring_profile
+      end.to request_to nvp_endpoint, :post
+      instance._method_.should == :CreateRecurringPaymentsProfile
+      instance._sent_params_.should == {
+        :DESC => 'Recurring Profile',
+        :TOKEN => 'token',
+        :SHIPPINGAMT => '0.00',
+        :AMT => '1000.00',
+        :BILLINGFREQUENCY => 1,
+        :MAXFAILEDPAYMENTS => 0,
+        :BILLINGPERIOD => :Month,
+        :TAXAMT => '0.00',
+        :PROFILESTARTDATE => '2011-02-08 09:00:00',
+        :TOTALBILLINGCYCLES => 0,
+        :version => Paypal.api_version
+      }
+    end
+  end
+
+  describe '#subscription' do
+    it 'should return Paypal::Express::Response' do
+      fake_response 'GetRecurringPaymentsProfileDetails/success'
+      response = instance.subscription 'profile_id'
+      response.should be_instance_of(Paypal::Express::Response)
+    end
+
+    it 'should call GetRecurringPaymentsProfileDetails' do
+      expect do
+        instance.subscription 'profile_id'
+      end.to request_to nvp_endpoint, :post
+      instance._method_.should == :GetRecurringPaymentsProfileDetails
+      instance._sent_params_.should == {
+        :PROFILEID => 'profile_id',
+        :version => Paypal.api_version
+      }
+    end
+  end
+
+  describe '#renew!' do
+    it 'should return Paypal::Express::Response' do
+      fake_response 'ManageRecurringPaymentsProfileStatus/success'
+      response = instance.renew! 'profile_id', :Cancel
+      response.should be_instance_of Paypal::Express::Response
+    end
+
+    it 'should call ManageRecurringPaymentsProfileStatus' do
+      expect do
+        instance.renew! 'profile_id', :Cancel
+      end.to request_to nvp_endpoint, :post
+      instance._method_.should == :ManageRecurringPaymentsProfileStatus
+      instance._sent_params_.should == {
+        :ACTION => :Cancel,
+        :PROFILEID => 'profile_id',
+        :version => Paypal.api_version
+      }
+    end
+  end
+
+  describe '#cancel!' do
+    it 'should return Paypal::Express::Response' do
+      fake_response 'ManageRecurringPaymentsProfileStatus/success'
+      response = instance.cancel! 'profile_id'
+      response.should be_instance_of(Paypal::Express::Response)
+    end
+
+    it 'should call ManageRecurringPaymentsProfileStatus' do
+      expect do
+        instance.cancel! 'profile_id'
+      end.to request_to nvp_endpoint, :post
+      instance._method_.should == :ManageRecurringPaymentsProfileStatus
+      instance._sent_params_.should == {
+        :ACTION => :Cancel,
+        :PROFILEID => 'profile_id',
+        :version => Paypal.api_version
+      }
+    end
+  end
+
+  describe '#suspend!' do
+    it 'should return Paypal::Express::Response' do
+      fake_response 'ManageRecurringPaymentsProfileStatus/success'
+      response = instance.cancel! 'profile_id'
+      response.should be_instance_of Paypal::Express::Response
+    end
+
+    it 'should call ManageRecurringPaymentsProfileStatus' do
+      expect do
+        instance.suspend! 'profile_id'
+      end.to request_to nvp_endpoint, :post
+      instance._method_.should == :ManageRecurringPaymentsProfileStatus
+      instance._sent_params_.should == {
+        :ACTION => :Suspend,
+        :PROFILEID => 'profile_id',
+        :version => Paypal.api_version 
+      }
+    end
+  end
+
+  describe '#reactivate!' do
+    it 'should return Paypal::Express::Response' do
+      fake_response 'ManageRecurringPaymentsProfileStatus/success'
+      response = instance.cancel! 'profile_id'
+      response.should be_instance_of Paypal::Express::Response
+    end
+
+    it 'should call ManageRecurringPaymentsProfileStatus' do
+      expect do
+        instance.reactivate! 'profile_id'
+      end.to request_to nvp_endpoint, :post
+      instance._method_.should == :ManageRecurringPaymentsProfileStatus
+      instance._sent_params_.should == {
+        :ACTION => :Reactivate,
+        :PROFILEID => 'profile_id',
+        :version => Paypal.api_version
+      }
+    end
+  end
+
+  describe '#agree!' do
+    it 'should return Paypal::Express::Response' do
+      fake_response 'CreateBillingAgreement/success'
+      response = instance.agree! 'token'
+      response.should be_instance_of Paypal::Express::Response
+    end
+
+    it 'should call CreateBillingAgreement' do
+      expect do
+        instance.agree! 'token'
+      end.to request_to nvp_endpoint, :post
+      instance._method_.should == :CreateBillingAgreement
+      instance._sent_params_.should == {
+        :TOKEN => 'token',
+        :version => Paypal.api_version
+      }
+    end
+  end
+
+  describe '#agreement' do
+    it 'should return Paypal::Express::Response' do
+      fake_response 'BillAgreementUpdate/fetch'
+      response = instance.agreement 'reference_id'
+      response.should be_instance_of Paypal::Express::Response
+    end
+
+    it 'should call BillAgreementUpdate' do
+      expect do
+        instance.agreement 'reference_id'
+      end.to request_to nvp_endpoint, :post
+      instance._method_.should == :BillAgreementUpdate
+      instance._sent_params_.should == {
+        :REFERENCEID => 'reference_id',
+        :version => Paypal.api_version
+      }
+    end
+  end
+
+  describe '#charge!' do
+    it 'should return Paypal::Express::Response' do
+      fake_response 'DoReferenceTransaction/success'
+      response = instance.charge! 'billing_agreement_id', 1000
+      response.should be_instance_of Paypal::Express::Response
+    end
+
+    it 'should call DoReferenceTransaction' do
+      expect do
+        instance.charge! 'billing_agreement_id', 1000, :currency_code => :JPY
+      end.to request_to nvp_endpoint, :post
+      instance._method_.should == :DoReferenceTransaction
+      instance._sent_params_.should == {
+        :REFERENCEID => 'billing_agreement_id',
+        :AMT => '1000.00',
+        :PAYMENTACTION => :Sale,
+        :CURRENCYCODE => :JPY,
+        :version => Paypal.api_version
+      }
+    end
+  end
+
+  describe '#revoke!' do
+    it 'should return Paypal::Express::Response' do
+      fake_response 'BillAgreementUpdate/revoke'
+      response = instance.revoke! 'reference_id'
+      response.should be_instance_of Paypal::Express::Response
+    end
+
+    it 'should call BillAgreementUpdate' do
+      expect do
+        instance.revoke! 'reference_id'
+      end.to request_to nvp_endpoint, :post
+      instance._method_.should == :BillAgreementUpdate
+      instance._sent_params_.should == {
+        :REFERENCEID => 'reference_id',
+        :BillingAgreementStatus => :Canceled,
+        :version => Paypal.api_version
+      }
+    end
+  end
+
+  describe '#refund!' do
+    it 'should return Paypal::Express::Response' do
+      fake_response 'RefundTransaction/full'
+      response = instance.refund! 'transaction_id'
+      response.should be_instance_of Paypal::Express::Response
+    end
+
+    it 'should call RefundTransaction' do
+      expect do
+        instance.refund! 'transaction_id'
+      end.to request_to nvp_endpoint, :post
+      instance._method_.should == :RefundTransaction
+      instance._sent_params_.should == {
+        :TRANSACTIONID => 'transaction_id',
+        :REFUNDTYPE => :Full,
+        :version => Paypal.api_version
+      }
+    end
+  end
+end