pp-adaptive 0.0.2

data/spec/public/payment_details_request_spec.rb

@@ -0,0 +1,30 @@
+require "spec_helper"
+
+describe AdaptivePayments::PaymentDetailsRequest do
+  it_behaves_like "a RequestEnvelope"
+
+  subject         { AdaptivePayments::PaymentDetailsRequest }
+  its(:operation) { should == :PaymentDetails }
+
+  let(:request) do
+    AdaptivePayments::PaymentDetailsRequest.new(
+      :pay_key        => "ABCDEFG-1234",
+      :transaction_id => "PPX-123ABC",
+      :tracking_id    => "personal.id"
+    )
+  end
+
+  let(:json) { JSON.parse(request.to_json) }
+
+  it "maps #pay_key to ['payKey']" do
+    json["payKey"].should == "ABCDEFG-1234"
+  end
+
+  it "maps #transaction_id to ['transactionId']" do
+    json["transactionId"].should == "PPX-123ABC"
+  end
+
+  it "maps #tracking_id to ['trackingId']" do
+    json["trackingId"].should == "personal.id"
+  end
+end

data/spec/public/payment_details_response_spec.rb

@@ -0,0 +1,211 @@
+require "spec_helper"
+
+describe AdaptivePayments::PaymentDetailsResponse do
+  it_behaves_like "a ResponseEnvelope"
+  it_behaves_like "a FaultMessage"
+
+  let(:response) do
+    AdaptivePayments::PaymentDetailsResponse.from_json(
+      {
+        :cancelUrl          => "http://site.com/cancelled",
+        :returnUrl          => "http://site.com/success",
+        :ipnNotificationUrl => "http://site.com/ipn",
+        :memo               => "a note to self",
+        :currencyCode       => "AUD",
+        :paymentInfoList    => {
+          :paymentInfo => [
+            {
+              :transactionId           => "ABC123",
+              :transactionStatus       => "Completed",
+              :receiver => {
+                :email          => "bob@site.com",
+                :amount         => "20.00",
+                :paymentType    => "DIGITALGOODS",
+                :paymentSubType => "SOFTWARE",
+                :invoiceId      => "77"
+              },
+              :refundedAmount          => "0.00",
+              :pendingRefund           => true,
+              :senderTransactionId     => "66",
+              :senderTransactionStatus => "Completed",
+              :pendingReason           => "none"
+            },
+            {
+              :transactionId           => "ABC456",
+              :transactionStatus       => "Pending",
+              :receiver => {
+                :email          => "another@site.com",
+                :amount         => "10.00",
+              },
+              :pendingReason           => "anything"
+            }
+          ]
+        },
+        :status             => "Completed",
+        :trackingId         => "tracking123",
+        :payKey             => "pay123",
+        :actionType         => "PAY",
+        :feesPayer          => "SENDER",
+        :reverseAllParallelPaymentsOnError => true,
+        :preapprovalKey     => "PREAPP123",
+        :fundingConstraint  => {
+          :allowedFundingType => {
+            :fundingTypeInfo => [
+              {
+                :fundingType => "CREDITCARD"
+              },
+              {
+                :fundingType => "BALANCE"
+              }
+            ]
+          }
+        },
+        :sender             => {
+          :email          => "sender@site.com",
+          :useCredentials => false,
+          :phone          => {
+            :countryCode => "1",
+            :phoneNumber => "456789123",
+            :extension   => "444"
+          }
+        }
+      }.to_json
+    )
+  end
+
+  it "maps ['cancelUrl'] to #cancel_url" do
+    response.cancel_url.should == "http://site.com/cancelled"
+  end
+
+  it "maps ['returnUrl'] to #return_url" do
+    response.return_url.should == "http://site.com/success"
+  end
+
+  it "maps ['ipnNotificationUrl'] to #ipn_notification_url" do
+    response.ipn_notification_url.should == "http://site.com/ipn"
+  end
+
+  it "maps ['memo'] to #memo" do
+    response.memo.should == "a note to self"
+  end
+
+  it "maps ['currencyCode'] to #currencyCode" do
+    response.currency_code.should == "AUD"
+  end
+
+  it "maps ['paymentInfoList']['paymentInfo'][0]['transactionId'] to #payments.first.transaction_id" do
+    response.payments.first.transaction_id.should == "ABC123"
+  end
+
+  it "maps ['paymentInfoList']['paymentInfo'][0]['transactionStatus'] to #payments.first.transaction_status" do
+    response.payments.first.transaction_status.should == "Completed"
+  end
+
+  it "maps ['paymentInfoList']['paymentInfo'][0]['receiver']['email'] to #payments.first.receiver_email" do
+    response.payments.first.receiver_email.should == "bob@site.com"
+  end
+
+  it "maps ['paymentInfoList']['paymentInfo'][0]['receiver']['amount'] to #payments.first.receiver_amount" do
+    response.payments.first.receiver_amount.should == BigDecimal("20.00")
+  end
+
+  it "maps ['paymentInfoList']['paymentInfo'][0]['receiver']['paymentType'] to #payments.first.payment_type" do
+    response.payments.first.payment_type.should == "DIGITALGOODS"
+  end
+
+  it "maps ['paymentInfoList']['paymentInfo'][0]['receiver']['paymentSubType'] to #payments.first.payment_subtype" do
+    response.payments.first.payment_subtype.should == "SOFTWARE"
+  end
+
+  it "maps ['paymentInfoList']['paymentInfo'][0]['receiver']['invoiceId'] to #payments.first.invoice_id" do
+    response.payments.first.invoice_id.should == "77"
+  end
+
+  it "maps ['paymentInfoList']['paymentInfo'][0]['refundedAmount'] to #payments.first.refunded_amount" do
+    response.payments.first.refunded_amount.should == BigDecimal("0.00")
+  end
+
+  it "maps ['paymentInfoList']['paymentInfo'][0]['pendingRefund'] to #payments.first.pending_refund? " do
+    response.payments.first.should be_pending_refund
+  end
+
+  it "maps ['paymentInfoList']['paymentInfo'][0]['senderTransactionId'] to #payments.first.sender_transaction_id" do
+    response.payments.first.sender_transaction_id.should == "66"
+  end
+
+  it "maps ['paymentInfoList']['paymentInfo'][0]['senderTransactionStatus'] to #payments.first.sender_transaction_status" do
+    response.payments.first.sender_transaction_status.should == "Completed"
+  end
+
+  it "maps ['paymentInfoList']['paymentInfo'][0]['pendingReason'] to #payments.first.pending_reason" do
+    response.payments.first.pending_reason.should == "none"
+  end
+
+  it "maps ['paymentInfoList']['paymentInfo'][1]['transactionId'] to #payments.last.transaction_id" do
+    response.payments.last.transaction_id.should == "ABC456"
+  end
+
+  it "maps ['paymentInfoList']['paymentInfo'][1]['transactionStatus'] to #payments.last.transaction_status" do
+    response.payments.last.transaction_status.should == "Pending"
+  end
+
+  it "maps ['paymentInfoList']['paymentInfo'][1]['receiver']['email'] to #payments.last.receiver_email" do
+    response.payments.last.receiver_email.should == "another@site.com"
+  end
+
+  it "maps ['status'] to #status" do
+    response.status.should == "Completed"
+  end
+
+  it "maps ['trackingId'] to #tracking_id" do
+    response.tracking_id.should == "tracking123"
+  end
+
+  it "maps ['payKey'] to #pay_key" do
+    response.pay_key.should == "pay123"
+  end
+
+  it "maps ['actionType'] to #actionType" do
+    response.action_type.should == "PAY"
+  end
+
+  it "maps ['feesPayer'] to #fees_payer" do
+    response.fees_payer.should == "SENDER"
+  end
+
+  it "maps ['reverseAllParallelPaymentsOnError'] to #reverse_parallel_payments_on_error? " do
+    response.reverse_parallel_payments_on_error?.should be_true
+  end
+
+  it "maps ['preapprovalKey'] to #preapproval_key" do
+    response.preapproval_key.should == "PREAPP123"
+  end
+
+  it "maps ['fundingConstraint']['allowedFundingType']['fundingTypeInfo'][0]['fundingType'] to #allowed_funding_types.first" do
+    response.allowed_funding_types.first.should == "CREDITCARD"
+  end
+
+  it "maps ['fundingConstraint']['allowedFundingType']['fundingTypeInfo'][1]['fundingType'] to #allowed_funding_types.last" do
+    response.allowed_funding_types.last.should == "BALANCE"
+  end
+
+  it "maps ['sender']['email'] to #sender_email" do
+    response.sender_email.should == "sender@site.com"
+  end
+
+  it "maps ['sender']['useCredentials'] to #use_sender_credentials? " do
+    response.use_sender_credentials?.should be_false
+  end
+
+  it "maps ['sender']['phone']['countryCode'] to #sender_phone_country_code" do
+    response.sender_phone_country_code.should == "1"
+  end
+
+  it "maps ['sender']['phone']['phoneNumber'] to #sender_phone_number" do
+    response.sender_phone_number.should == "456789123"
+  end
+
+  it "maps ['sender']['phone']['extension'] to #sender_phone_extension" do
+    response.sender_phone_extension.should == "444"
+  end
+end

data/spec/public/preapproval_details_request_spec.rb

@@ -0,0 +1,25 @@
+require "spec_helper"
+
+describe AdaptivePayments::PreapprovalDetailsRequest do
+  it_behaves_like "a RequestEnvelope"
+
+  subject         { AdaptivePayments::PreapprovalDetailsRequest }
+  its(:operation) { should == :PreapprovalDetails }
+
+  let(:request) do
+    AdaptivePayments::PreapprovalDetailsRequest.new(
+      :preapproval_key     => "ABCDEFG-1234",
+      :get_billing_address => true
+    )
+  end
+
+  let(:json) { JSON.parse(request.to_json) }
+
+  it "maps #preapproval_key to ['preapprovalKey']" do
+    json["preapprovalKey"].should == "ABCDEFG-1234"
+  end
+
+  it "maps #get_billing_address to ['getBillingAddress']" do
+    json["getBillingAddress"].should == true
+  end
+end

data/spec/public/preapproval_details_response_spec.rb

@@ -0,0 +1,200 @@
+require "spec_helper"
+
+describe AdaptivePayments::PreapprovalDetailsResponse do
+  it_behaves_like "a ResponseEnvelope"
+  it_behaves_like "a FaultMessage"
+
+  let(:response) do
+    AdaptivePayments::PreapprovalDetailsResponse.from_json(
+      {
+        :approved                    => false,
+        :cancelUrl                   => "http://site.com/cancelled",
+        :returnUrl                   => "http://site.com/success",
+        :ipnNotificationUrl          => "http://site.com/ipn",
+        :currencyCode                => "USD",
+        :maxTotalAmountOfAllPayments => "680.00",
+        :startingDate                => "2011-09-22T12:37:07+00:00",
+        :endingDate                  => "2012-09-22T12:37:07+00:00",
+        :maxAmountPerPayment         => "60.00",
+        :paymentPeriod               => "MONTHLY",
+        :curPayments                 => 2,
+        :curPaymentsAmount           => "100.00",
+        :curPeriodAttempts           => 1,
+        :curPeriodEndingDate         => "2011-09-30T12:37:07+00:00",
+        :dateOfMonth                 => 15,
+        :dayOfWeek                   => "FRIDAY",
+        :pinType                     => "NOT_REQUIRED",
+        :senderEmail                 => "bob@gmail.com",
+        :memo                        => "some memo",
+        :status                      => "ACTIVE",
+        :feesPayer                   => "SENDER",
+        :displayMaxTotalAmount       => true,
+        :addressList                 => {
+          :address => [
+            {
+              :addressId      => "abc123",
+              :addressee_name => "Bob Cat",
+              :base_address   => {
+                :line1        => "56 Bobcat St",
+                :line2        => "Some estate",
+                :city         => "Bobcaton",
+                :state        => "BCT",
+                :postal_code  => "BC1 BC2",
+                :country_code => "BC",
+                :type         => "Home"
+              }
+            },
+            {
+              :addressId      => "abc456",
+              :addressee_name => "Pete Mouse",
+              :base_address   => {
+                :line1        => "2 Le Hole",
+                :city         => "Cheese City",
+                :state        => "MCT",
+                :postal_code  => "3000",
+                :country_code => "MM",
+                :type         => "Business"
+              }
+            }
+          ]
+        }
+      }.to_json
+    )
+  end
+
+  it "maps ['approved'] to #approved" do
+    response.approved.should be_false
+  end
+
+  it "maps ['cancelUrl'] to #cancel_url" do
+    response.cancel_url.should == "http://site.com/cancelled"
+  end
+
+  it "maps ['returnUrl'] to #return_url" do
+    response.return_url.should == "http://site.com/success"
+  end
+
+  it "maps ['ipnNotificationUrl'] to #ipn_notification_url" do
+    response.ipn_notification_url.should == "http://site.com/ipn"
+  end
+
+  it "maps ['currencyCode'] to #currency_code" do
+    response.currency_code.should == "USD"
+  end
+
+  it "maps ['maxTotalAmountOfAllPayments'] to #max_total_amount" do
+    response.max_total_amount.should == BigDecimal('680.00')
+  end
+
+  it "maps ['startingDate'] to #starting_date" do
+    response.starting_date.should == DateTime.new(2011, 9, 22, 12, 37, 7)
+  end
+
+  it "maps ['endingDate'] to #ending_date" do
+    response.ending_date.should == DateTime.new(2012, 9, 22, 12, 37, 7)
+  end
+
+  it "maps ['maxAmountPerPayment'] to #max_amount_per_payment" do
+    response.max_amount_per_payment.should == BigDecimal('60.00')
+  end
+
+  it "maps ['paymentPeriod'] to #payment_period" do
+    response.payment_period.should == "MONTHLY"
+  end
+
+  it "maps ['curPayments'] to #current_payments" do
+    response.current_payments.should == 2
+  end
+
+  it "maps ['curPaymentsAmount'] to #current_payments_amount" do
+    response.current_payments_amount.should == BigDecimal('100.00')
+  end
+
+  it "maps ['curPeriodAttempts'] to #current_period_attempts" do
+    response.current_period_attempts.should == 1
+  end
+
+  it "maps ['curPeriodEndingDate'] to #current_period_ending_date" do
+    response.current_period_ending_date.should == DateTime.new(2011, 9, 30, 12, 37, 7)
+  end
+
+  it "maps ['dateOfMonth'] to #date_of_month" do
+    response.date_of_month.should == 15
+  end
+
+  it "maps ['dayOfWeek'] to #day_of_week" do
+    response.day_of_week.should == "FRIDAY"
+  end
+
+  it "maps ['pinType'] to #pin_type" do
+    response.pin_type.should == "NOT_REQUIRED"
+  end
+
+  it "maps ['senderEmail'] to #sender_email" do
+    response.sender_email.should == "bob@gmail.com"
+  end
+
+  it "maps ['memo'] to #memo" do
+    response.memo.should == "some memo"
+  end
+
+  it "maps ['status'] to #status" do
+    response.status.should == "ACTIVE"
+  end
+
+  it "maps ['feesPayer'] to #fees_payer" do
+    response.fees_payer.should == "SENDER"
+  end
+
+  it "maps ['displayMaxTotalAmount'] to #display_max_total_amount? " do
+    response.display_max_total_amount.should be_true
+  end
+
+  it "maps ['addressList']['address'][0]['addressId'] to #addresses.first.id" do
+    response.addresses.first.id.should == "abc123"
+  end
+
+  it "maps ['addressList']['address'][0]['addresseeName'] to #addresses.first.addressee_name" do
+    response.addresses.first.addressee_name.should == "Bob Cat"
+  end
+
+  it "maps ['addressList']['address'][0]['baseAddress']['line1'] to #addresses.first.line1" do
+    response.addresses.first.line1.should == "56 Bobcat St"
+  end
+
+  it "maps ['addressList']['address'][0]['baseAddress']['line2'] to #addresses.first.line2" do
+    response.addresses.first.line2.should == "Some estate"
+  end
+
+  it "maps ['addressList']['address'][0]['baseAddress']['city'] to #addresses.first.city" do
+    response.addresses.first.city.should == "Bobcaton"
+  end
+
+  it "maps ['addressList']['address'][0]['baseAddress']['state'] to #addresses.first.state" do
+    response.addresses.first.state.should == "BCT"
+  end
+
+  it "maps ['addressList']['address'][0]['baseAddress']['postalCode'] to #addresses.first.postal_code" do
+    response.addresses.first.postal_code.should == "BC1 BC2"
+  end
+
+  it "maps ['addressList']['address'][0]['baseAddress']['countryCode'] to #addresses.first.country_code" do
+    response.addresses.first.country_code.should == "BC"
+  end
+
+  it "maps ['addressList']['address'][0]['baseAddress']['type'] to #addresses.first.type" do
+    response.addresses.first.type.should == "Home"
+  end
+
+  it "maps ['addressList']['address'][1]['addressId'] to #addresses.last.id" do
+    response.addresses.last.id.should == "abc456"
+  end
+
+  it "maps ['addressList']['address'][1]['addresseeName'] to #addresses.last.addressee_name" do
+    response.addresses.last.addressee_name.should == "Pete Mouse"
+  end
+
+  it "maps ['addressList']['address'][1]['baseAddress']['line1'] to #addresses.last.line1" do
+    response.addresses.last.line1.should == "2 Le Hole"
+  end
+end

data/spec/public/preapproval_request_spec.rb

@@ -0,0 +1,110 @@
+require "spec_helper"
+
+describe AdaptivePayments::PreapprovalRequest do
+  it_behaves_like "a RequestEnvelope"
+
+  subject         { AdaptivePayments::PreapprovalRequest }
+  its(:operation) { should == :Preapproval }
+
+  let(:request) do
+    AdaptivePayments::PreapprovalRequest.new(
+      :ending_date              => DateTime.new(2011, 9, 20, 7, 57, 2, Rational(10, 24)),
+      :starting_date            => DateTime.new(2011, 9, 20, 7, 49, 2, Rational(5, 24)),
+      :max_total_amount         => 720,
+      :currency_code            => "USD",
+      :cancel_url               => "http://site.com/cancelled",
+      :return_url               => "http://site.com/succeeded",
+      :ipn_notification_url     => "http://site.com/ipn",
+      :date_of_month            => 15,
+      :day_of_week              => "friday",
+      :max_amount_per_payment   => 60,
+      :max_payments             => 12,
+      :max_payments_per_period  => 1,
+      :payment_period           => "monthly",
+      :memo                     => "some memo",
+      :sender_email             => "sender@site.com",
+      :pin_type                 => "required",
+      :fees_payer               => "sender",
+      :display_max_total_amount => false
+    )
+  end
+
+  let(:json) { JSON.parse(request.to_json) }
+
+  it "maps #ending_date to ['endingDate']" do
+    json["endingDate"].should == "2011-09-20T07:57:02+10:00"
+  end
+
+  it "maps #starting_date to ['startingDate']" do
+    json["startingDate"].should == "2011-09-20T07:49:02+05:00"
+  end
+
+  it "maps #max_total_amount to ['maxTotalAmountOfAllPayments']" do
+    json["maxTotalAmountOfAllPayments"].should == "720.00"
+  end
+
+  it "maps #currency_code to ['currencyCode']" do
+    json["currencyCode"].should == "USD"
+  end
+
+  it "maps #cancel_url to ['cancelUrl']" do
+    json["cancelUrl"].should == "http://site.com/cancelled"
+  end
+
+  it "maps #return_url to ['returnUrl']" do
+    json["returnUrl"].should == "http://site.com/succeeded"
+  end
+
+  it "maps #ipn_notification_url to ['ipnNotificationUrl']" do
+    json["ipnNotificationUrl"].should == "http://site.com/ipn"
+  end
+
+  it "maps #date_of_month to ['dateOfMonth']" do
+    json["dateOfMonth"].should == 15
+  end
+
+  it "maps #day_of_week to ['dayOfWeek']" do
+    json["dayOfWeek"].should == "friday"
+  end
+
+  it "maps #max_amount_per_payment to ['maxAmountPerPayment']" do
+    json["maxAmountPerPayment"].should == "60.00"
+  end
+
+  it "maps #max_payments to ['maxNumberOfPayments']" do
+    json["maxNumberOfPayments"].should == 12
+  end
+
+  it "maps #max_payments_per_period to ['maxNumberOfPaymentsPerPeriod']" do
+    json["maxNumberOfPaymentsPerPeriod"].should == 1
+  end
+
+  it "maps #payment_period to ['paymentPeriod']" do
+    json["paymentPeriod"].should == "monthly"
+  end
+
+  it "maps #memo to ['memo']" do
+    json["memo"].should == "some memo"
+  end
+
+  it "maps #sender_email to ['senderEmail']" do
+    json["senderEmail"].should == "sender@site.com"
+  end
+
+  it "maps #pin_type to ['pinType']" do
+    json["pinType"].should == "required"
+  end
+
+  it "maps #fees_payer to ['feesPayer']" do
+    json["feesPayer"].should == "sender"
+  end
+
+  it "maps #display_max_total_amount to ['displayMaxTotalAmount']" do
+    json["displayMaxTotalAmount"].should == false
+  end
+
+  it "does not include omitted parameters" do
+    request.max_amount_per_payment = nil
+    json.should_not have_key("maxAmountPerPayment")
+  end
+end

data/spec/public/preapproval_response_spec.rb

@@ -0,0 +1,14 @@
+require "spec_helper"
+
+describe AdaptivePayments::PreapprovalResponse do
+  it_behaves_like "a ResponseEnvelope"
+  it_behaves_like "a FaultMessage"
+
+  let(:response) do
+    AdaptivePayments::PreapprovalResponse.from_json('{"preapprovalKey":"SOME-KEY"}')
+  end
+
+  it "maps ['preapprovalKey'] to #preapproval_key" do
+    response.preapproval_key.should == "SOME-KEY"
+  end
+end

data/spec/public/refund_request_spec.rb

@@ -0,0 +1,57 @@
+require "spec_helper"
+
+describe AdaptivePayments::RefundRequest do
+  it_behaves_like "a RequestEnvelope"
+
+  subject         { AdaptivePayments::RefundRequest }
+  its(:operation) { should == :Refund }
+
+  let(:request) do
+    AdaptivePayments::RefundRequest.new(
+      :currency_code        => "USD",
+      :pay_key              => "ABCD-1234",
+      :tracking_id          => "some.id",
+      :transaction_id       => "trans123",
+      :ipn_notification_url => "http://site.com/ipn",
+      :receivers            => [{ :email => "first@site.com", :amount => 10 }, { :email => "other@site.com", :amount => 2 }]
+    )
+  end
+
+  let(:json) { JSON.parse(request.to_json) }
+
+  it "maps #currency_code to ['currencyCode']" do
+    json["currencyCode"].should == "USD"
+  end
+
+  it "maps #pay_key to ['payKey']" do
+    json["payKey"].should == "ABCD-1234"
+  end
+
+  it "maps #tracking_id to ['trackingId']" do
+    json["trackingId"].should == "some.id"
+  end
+
+  it "maps #transaction_id to ['transactionId']" do
+    json["transactionId"].should == "trans123"
+  end
+
+  it "maps #ipn_notification_url to ['ipnNotificationUrl']" do
+    json["ipnNotificationUrl"].should == "http://site.com/ipn"
+  end
+
+  it "maps #receivers.first.email to ['receiverList']['receiver'][0]['email']" do
+    json["receiverList"]["receiver"][0]["email"].should == "first@site.com"
+  end
+
+  it "maps #receivers.first.amount to ['receiverList']['receiver'][0]['amount']" do
+    json["receiverList"]["receiver"][0]["amount"].should == "10.00"
+  end
+
+  it "maps #receivers.last.email to ['receiverList']['receiver'][1]['email']" do
+    json["receiverList"]["receiver"][1]["email"].should == "other@site.com"
+  end
+
+  it "maps #receivers.last.amount to ['receiverList']['receiver'][1]['amount']" do
+    json["receiverList"]["receiver"][1]["amount"].should == "2.00"
+  end
+end