ianfleeton-paypal-express 0.8.2

data/spec/paypal/payment/recurring_spec.rb

@@ -0,0 +1,170 @@
+require 'spec_helper.rb'
+
+describe Paypal::Payment::Recurring do
+  let :keys do
+    Paypal::Payment::Recurring.optional_attributes
+  end
+
+  let :trial_attributes do
+    {}
+  end
+
+  let :attributes do
+    {
+      :identifier => '12345',
+      :description => 'Subscription Payment Profile',
+      :status => 'Active',
+      :start_date => '2011-02-03T15:00:00Z',
+      :name => 'Nov Matake',
+      :auto_bill => 'NoAutoBill',
+      :max_fails => '0',
+      :aggregate_amount => '1000',
+      :aggregate_optional_amount => '0',
+      :final_payment_date => '1970-01-01T00:00:00Z',
+      :billing => {
+        :amount => Paypal::Payment::Common::Amount.new(
+          :total => '1000',
+          :shipping => '0',
+          :tax => '0'
+        ),
+        :currency_code => 'JPY',
+        :period => 'Month',
+        :frequency => '1',
+        :total_cycles => '0',
+        :trial => trial_attributes
+      },
+      :regular_billing => {
+        :amount => '1000',
+        :shipping_amount => '0',
+        :tax_amount => '0',
+        :currency_code => 'JPY',
+        :period => 'Month',
+        :frequency => '1',
+        :total_cycles => '0',
+        :paid => '1000'
+      },
+      :summary => {
+        :next_billing_date => '2011-03-04T10:00:00Z',
+        :cycles_completed => '1',
+        :cycles_remaining => '18446744073709551615',
+        :outstanding_balance => '0',
+        :failed_count => '0',
+        :last_payment_date => '2011-02-04T10:50:56Z',
+        :last_payment_amount => '1000'
+      }
+    }
+  end
+
+  let :instance do
+    Paypal::Payment::Recurring.new attributes
+  end
+
+  describe '.new' do
+    it 'should accept all supported attributes' do
+      expect(instance.identifier).to eq('12345')
+      expect(instance.description).to eq('Subscription Payment Profile')
+      expect(instance.status).to eq('Active')
+      expect(instance.start_date).to eq('2011-02-03T15:00:00Z')
+      expect(instance.billing.trial).to be_nil
+    end
+
+    context 'when optional trial info given' do
+      let :trial_attributes do
+        {
+          :period => 'Month',
+          :frequency => '1',
+          :total_cycles => '0',
+          :currency_code => 'JPY',
+          :amount => '1000',
+          :shipping_amount => '0',
+          :tax_amount => '0'
+        }
+      end
+      it 'should setup trial billing info' do
+        expect(instance.billing.trial).to eq(Paypal::Payment::Recurring::Billing.new(trial_attributes))
+      end
+    end
+  end
+
+  describe '#to_params' do
+    it 'should handle Recurring Profile parameters' do
+      expect(instance.to_params).to eq({
+        :AUTOBILLOUTAMT => 'NoAutoBill',
+        :BILLINGFREQUENCY => 1,
+        :SHIPPINGAMT => '0.00',
+        :DESC => 'Subscription Payment Profile',
+        :SUBSCRIBERNAME => 'Nov Matake',
+        :BILLINGPERIOD => 'Month',
+        :AMT => '1000.00',
+        :MAXFAILEDPAYMENTS => 0,
+        :TOTALBILLINGCYCLES => 0,
+        :TAXAMT => '0.00',
+        :PROFILESTARTDATE => '2011-02-03T15:00:00Z',
+        :CURRENCYCODE => 'JPY'
+      })
+    end
+
+    context 'when start_date is Time' do
+      it 'should be stringfy' do
+        instance = Paypal::Payment::Recurring.new attributes.merge(
+          :start_date => Time.utc(2011, 2, 8, 15, 0, 0)
+        )
+        expect(instance.start_date).to be_instance_of(Time)
+        expect(instance.to_params[:PROFILESTARTDATE]).to eq('2011-02-08 15:00:00')
+      end
+    end
+
+    context 'when optional trial setting given' do
+      let :trial_attributes do
+        {
+          :period => 'Month',
+          :frequency => '1',
+          :total_cycles => '0',
+          :currency_code => 'JPY',
+          :amount => '1000',
+          :shipping_amount => '0',
+          :tax_amount => '0'
+        }
+      end
+      it 'should setup trial billing info' do
+        expect(instance.to_params).to eq({
+          :TRIALBILLINGPERIOD => "Month",
+          :TRIALBILLINGFREQUENCY => 1,
+          :TRIALTOTALBILLINGCYCLES => 0,
+          :TRIALAMT => "1000.00",
+          :TRIALCURRENCYCODE => "JPY",
+          :TRIALSHIPPINGAMT => "0.00",
+          :TRIALTAXAMT => "0.00",
+          :BILLINGPERIOD => "Month",
+          :BILLINGFREQUENCY => 1,
+          :TOTALBILLINGCYCLES => 0,
+          :AMT => "1000.00",
+          :CURRENCYCODE => "JPY",
+          :SHIPPINGAMT => "0.00",
+          :TAXAMT => "0.00",
+          :DESC => "Subscription Payment Profile",
+          :MAXFAILEDPAYMENTS => 0,
+          :AUTOBILLOUTAMT => "NoAutoBill",
+          :PROFILESTARTDATE => "2011-02-03T15:00:00Z",
+          :SUBSCRIBERNAME => "Nov Matake"
+        })
+      end
+    end
+  end
+
+  describe '#numeric_attribute?' do
+    let :numeric_attributes do
+      [:aggregate_amount, :aggregate_optional_amount, :max_fails, :failed_count]
+    end
+
+    it 'should detect numeric attributes' do
+      numeric_attributes.each do |key|
+        expect(instance.numeric_attribute?(key)).to be_truthy
+      end
+      non_numeric_keys = keys - numeric_attributes
+      non_numeric_keys.each do |key|
+        expect(instance.numeric_attribute?(key)).to be_falsey
+      end
+    end
+  end
+end

data/spec/paypal/payment/request/item_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper.rb'
+
+describe Paypal::Payment::Request::Item do
+  let :instance do
+    Paypal::Payment::Request::Item.new(
+      :name => 'Name',
+      :description => 'Description',
+      :amount => 10,
+      :quantity => 5,
+      :category => :Digital,
+      :number => '1'
+    )
+  end
+
+  describe '#to_params' do
+    it 'should handle Recurring Profile activation parameters' do
+      expect(instance.to_params(1)).to eq({
+        :L_PAYMENTREQUEST_1_NAME0 => 'Name',
+        :L_PAYMENTREQUEST_1_DESC0 => 'Description',
+        :L_PAYMENTREQUEST_1_AMT0 => '10.00',
+        :L_PAYMENTREQUEST_1_QTY0 => 5,
+        :L_PAYMENTREQUEST_1_ITEMCATEGORY0 => :Digital,
+        :L_PAYMENTREQUEST_1_NUMBER0 => '1'
+      })
+    end
+  end
+end

data/spec/paypal/payment/request_spec.rb

@@ -0,0 +1,136 @@
+require 'spec_helper.rb'
+
+describe Paypal::Payment::Request do
+  let :instant_request do
+    Paypal::Payment::Request.new(
+      :amount => 25.7,
+      :tax_amount => 0.4,
+      :shipping_amount => 1.5,
+      :currency_code => :JPY,
+      :description => 'Instant Payment Request',
+      :notify_url => 'http://merchant.example.com/notify',
+      :invoice_number => 'ABC123',
+      :custom => 'Custom',
+      :items => [{
+        :quantity => 2,
+        :name => 'Item1',
+        :description => 'Awesome Item 1!',
+        :amount => 10.25
+      }, {
+        :quantity => 3,
+        :name => 'Item2',
+        :description => 'Awesome Item 2!',
+        :amount => 1.1
+      }],
+      :custom_fields => {
+        "l_surveychoice{n}" => 'abcd' # The '{n}' will be replaced with the index
+      }
+    )
+  end
+
+  let :recurring_request do
+    Paypal::Payment::Request.new(
+      :currency_code => :JPY,
+      :billing_type => :RecurringPayments,
+      :billing_agreement_description => 'Recurring Payment Request'
+    )
+  end
+
+  let :reference_transaction_request do
+    Paypal::Payment::Request.new(
+      :currency_code => :JPY,
+      :billing_type => :MerchantInitiatedBillingSingleAgreement,
+      :billing_agreement_description => 'Reference Transaction Request'
+    )
+  end
+
+  describe '.new' do
+    it 'should handle Instant Payment parameters' do
+      expect(instant_request.amount.total).to eq(25.7)
+      expect(instant_request.amount.tax).to eq(0.4)
+      expect(instant_request.amount.shipping).to eq(1.5)
+      expect(instant_request.currency_code).to eq(:JPY)
+      expect(instant_request.description).to eq('Instant Payment Request')
+      expect(instant_request.notify_url).to eq('http://merchant.example.com/notify')
+    end
+
+    it 'should handle Recurring Payment parameters' do
+      expect(recurring_request.currency_code).to eq(:JPY)
+      expect(recurring_request.billing_type).to eq(:RecurringPayments)
+      expect(recurring_request.billing_agreement_description).to eq('Recurring Payment Request')
+    end
+
+    it 'should handle Recurring Payment parameters' do
+      expect(reference_transaction_request.currency_code).to eq(:JPY)
+      expect(reference_transaction_request.billing_type).to eq(:MerchantInitiatedBillingSingleAgreement)
+      expect(reference_transaction_request.billing_agreement_description).to eq('Reference Transaction Request')
+    end
+  end
+
+  describe '#to_params' do
+    it 'should handle Instant Payment parameters' do
+      expect(instant_request.to_params).to eq({
+        :PAYMENTREQUEST_0_AMT => "25.70",
+        :PAYMENTREQUEST_0_TAXAMT => "0.40",
+        :PAYMENTREQUEST_0_SHIPPINGAMT => "1.50",
+        :PAYMENTREQUEST_0_CURRENCYCODE => :JPY,
+        :PAYMENTREQUEST_0_DESC => "Instant Payment Request",
+        :PAYMENTREQUEST_0_NOTIFYURL => "http://merchant.example.com/notify",
+        :PAYMENTREQUEST_0_ITEMAMT => "23.80",
+        :PAYMENTREQUEST_0_INVNUM => "ABC123",
+        :PAYMENTREQUEST_0_CUSTOM => "Custom",
+        :L_PAYMENTREQUEST_0_NAME0 => "Item1",
+        :L_PAYMENTREQUEST_0_DESC0 => "Awesome Item 1!",
+        :L_PAYMENTREQUEST_0_AMT0 => "10.25",
+        :L_PAYMENTREQUEST_0_QTY0 => 2,
+        :L_PAYMENTREQUEST_0_NAME1 => "Item2",
+        :L_PAYMENTREQUEST_0_DESC1 => "Awesome Item 2!",
+        :L_PAYMENTREQUEST_0_AMT1 => "1.10",
+        :L_PAYMENTREQUEST_0_QTY1 => 3,
+        :L_SURVEYCHOICE0 => 'abcd' # Note the 'n' was replaced by the index
+      })
+    end
+
+    it 'should handle Recurring Payment parameters' do
+      expect(recurring_request.to_params).to eq({
+        :PAYMENTREQUEST_0_AMT => "0.00",
+        :PAYMENTREQUEST_0_TAXAMT => "0.00",
+        :PAYMENTREQUEST_0_SHIPPINGAMT => "0.00",
+        :PAYMENTREQUEST_0_CURRENCYCODE => :JPY,
+        :L_BILLINGTYPE0 => :RecurringPayments,
+        :L_BILLINGAGREEMENTDESCRIPTION0 => "Recurring Payment Request"
+      })
+    end
+
+    it 'should handle Reference Transactions parameters' do
+      expect(reference_transaction_request.to_params).to eq({
+        :PAYMENTREQUEST_0_AMT => "0.00",
+        :PAYMENTREQUEST_0_TAXAMT => "0.00",
+        :PAYMENTREQUEST_0_SHIPPINGAMT => "0.00",
+        :PAYMENTREQUEST_0_CURRENCYCODE => :JPY,
+        :L_BILLINGTYPE0 => :MerchantInitiatedBillingSingleAgreement,
+        :L_BILLINGAGREEMENTDESCRIPTION0 => "Reference Transaction Request"
+      })
+    end
+  end
+
+  describe '#items_amount' do
+    context 'when BigDecimal'
+    let(:instance) do
+      Paypal::Payment::Request.new(
+        :items => [{
+          :quantity => 3,
+          :name => 'Item1',
+          :description => 'Awesome Item 1!',
+          :amount => 130.45
+        }]
+      )
+    end
+
+    # NOTE:
+    # 130.45 * 3 => 391.34999999999997 (in ruby 1.9)
+    it 'should calculate total amount correctly' do
+      expect(instance.items_amount).to eq(391.35)
+    end
+  end
+end

data/spec/paypal/payment/response/address_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper.rb'
+
+describe Paypal::Payment::Response::Address do
+  let :keys do
+    Paypal::Payment::Response::Address.optional_attributes
+  end
+
+  describe '.new' do
+    it 'should allow nil for attributes' do
+      payer = Paypal::Payment::Response::Address.new
+      keys.each do |key|
+        expect(payer.send(key)).to be_nil
+      end
+    end
+
+    it 'should treat all attributes as String' do
+      attributes = keys.inject({}) do |attributes, key|
+        attributes.merge!(key => "xyz")
+      end
+      payer = Paypal::Payment::Response::Address.new attributes
+      keys.each do |key|
+        expect(payer.send(key)).to eq("xyz")
+      end
+    end
+  end
+end

data/spec/paypal/payment/response/info_spec.rb

@@ -0,0 +1,93 @@
+require 'spec_helper.rb'
+
+describe Paypal::Payment::Response::Info do
+  let :attribute_mapping do
+    Paypal::Payment::Response::Info.attribute_mapping
+  end
+
+  let :attributes do
+    {
+      :ACK => 'Success',
+      :CURRENCYCODE => 'JPY',
+      :ERRORCODE => 0,
+      :ORDERTIME => '2011-02-08T03:23:54Z',
+      :PAYMENTSTATUS => 'Completed',
+      :PAYMENTTYPE => 'instant',
+      :PENDINGREASON => 'None',
+      :PROTECTIONELIGIBILITY => 'Ineligible',
+      :PROTECTIONELIGIBILITYTYPE => 'None',
+      :REASONCODE => 'None',
+      :TRANSACTIONID => '8NC65222871997739',
+      :TRANSACTIONTYPE => 'expresscheckout',
+      :AMT => '14.00',
+      :FEEAMT => '0.85',
+      :TAXAMT => '0.00',
+      :RECEIPTID => '12345',
+      :SECUREMERCHANTACCOUNTID => '123456789',
+      :PAYMENTREQUESTID => '12345',
+      :SELLERPAYPALACCOUNTID => 'seller@shop.example.com',
+      :EXCHANGERATE => '0.811965'
+    }
+  end
+
+  describe '.new' do
+    context 'when attribute keys are uppercase Symbol' do
+      it 'should accept all without any warning' do
+        expect(Paypal.logger).not_to receive(:warn)
+        from_symbol_uppercase = Paypal::Payment::Response::Info.new attributes
+        attribute_mapping.values.each do |key|
+          expect(from_symbol_uppercase.send(key)).not_to be_nil
+        end
+        expect(from_symbol_uppercase.amount).to eq(Paypal::Payment::Common::Amount.new(
+          :total => 14,
+          :fee => 0.85
+        ))
+      end
+    end
+
+    context 'when attribute keys are lowercase Symbol' do
+      it 'should ignore them and warn' do
+        _attrs_ = attributes.inject({}) do |_attrs_, (k, v)|
+          _attrs_.merge!(k.to_s.downcase.to_sym => v)
+        end
+        _attrs_.each do |key, value|
+          expect(Paypal.logger).to receive(:warn).with(
+            "Ignored Parameter (Paypal::Payment::Response::Info): #{key}=#{value}"
+          )
+        end
+        from_symbol_lowercase = Paypal::Payment::Response::Info.new _attrs_
+        attribute_mapping.values.each do |key|
+          expect(from_symbol_lowercase.send(key)).to be_nil
+        end
+        expect(from_symbol_lowercase.amount).to eq(Paypal::Payment::Common::Amount.new)
+      end
+    end
+
+    context 'when attribute keys are String' do
+      it 'should ignore them and warn' do
+        attributes.stringify_keys.each do |key, value|
+          expect(Paypal.logger).to receive(:warn).with(
+            "Ignored Parameter (Paypal::Payment::Response::Info): #{key}=#{value}"
+          )
+        end
+        from_string = Paypal::Payment::Response::Info.new attributes.stringify_keys
+        attribute_mapping.values.each do |key|
+          expect(from_string.send(key)).to be_nil
+        end
+        expect(from_string.amount).to eq(Paypal::Payment::Common::Amount.new)
+      end
+    end
+
+    context 'when non-supported attributes are given' do
+      it 'should ignore them and warn' do
+        _attr_ = attributes.merge(
+          :ignored => 'Ignore me!'
+        )
+        expect(Paypal.logger).to receive(:warn).with(
+          "Ignored Parameter (Paypal::Payment::Response::Info): ignored=Ignore me!"
+        )
+        Paypal::Payment::Response::Info.new _attr_
+      end
+    end
+  end
+end