pp-adaptive 0.0.2

data/spec/public/get_payment_options_response_spec.rb

@@ -0,0 +1,141 @@
+require "spec_helper"
+
+describe AdaptivePayments::GetPaymentOptionsResponse do
+  it_behaves_like "a ResponseEnvelope"
+  it_behaves_like "a FaultMessage"
+
+  let(:response) do
+    AdaptivePayments::GetPaymentOptionsResponse.from_json(
+      {
+        :initiatingEntity  => {
+          :institutionCustomer => {
+            :institutionId         => "inst123",
+            :firstName             => "Bob",
+            :lastName              => "Cat",
+            :displayName           => "Bobcat",
+            :institutionCustomerId => "77",
+            :countryCode           => "AU",
+            :email                 => "bob@site.com"
+          }
+        },
+        :displayOptions => {
+          :emailHeaderImageUrl    => "http://site.com/email.png",
+          :emailMarketingImageUrl => "http://site.com/marketing.png",
+          :headerImageUrl         => "http://site.com/header.png",
+          :businessName           => "Bobcats R us"
+        },
+        :shippingAddressId => "addr123",
+        :senderOptions => {
+          :requireShippingAddressSelection => true
+        },
+        :receiverOptions => [
+          {
+            :description => "Primary receiver",
+            :customId    => "cust123",
+            :invoiceData => {
+              :item           => [
+                {
+                  :name       => "Video Game",
+                  :identifier => "ident123",
+                  :price      => "20.00",
+                  :item_price => "10.00",
+                  :item_count => "2"
+                }
+              ],
+              :total_tax      => "2.00",
+              :total_shipping => "0.00"
+            }
+          }
+        ]
+      }.to_json
+    )
+  end
+
+  it "maps ['initiatingEntity']['institutionCustomer']['institutionId'] to #institution_id" do
+    response.institution_id.should == "inst123"
+  end
+
+  it "maps ['initiatingEntity']['institutionCustomer']['firstName'] to #customer_first_name" do
+    response.customer_first_name.should == "Bob"
+  end
+
+  it "maps ['initiatingEntity']['institutionCustomer']['lastName'] to #customer_last_name" do
+    response.customer_last_name.should == "Cat"
+  end
+
+  it "maps ['initiatingEntity']['institutionCustomer']['displayName'] to #customer_display_name" do
+    response.customer_display_name.should == "Bobcat"
+  end
+
+  it "maps ['initiatingEntity']['institutionCustomer']['institutionCustomerId'] to #institution_customer_id" do
+    response.institution_customer_id.should == "77"
+  end
+
+  it "maps ['initiatingEntity']['institutionCustomer']['countryCode'] to #customer_country_code" do
+    response.customer_country_code.should == "AU"
+  end
+
+  it "maps ['initiatingEntity']['institutionCustomer']['email'] to #customer_email" do
+    response.customer_email.should == "bob@site.com"
+  end
+
+  it "maps ['displayOptions']['emailHeaderImageUrl'] to #email_header_image_url" do
+    response.email_header_image_url.should == "http://site.com/email.png"
+  end
+
+  it "maps ['displayOptions']['emailMarketingImageUrl'] to #email_marketing_image_url" do
+    response.email_marketing_image_url.should == "http://site.com/marketing.png"
+  end
+
+  it "maps ['displayOptions']['headerImageUrl'] to #header_image_url" do
+    response.header_image_url.should == "http://site.com/header.png"
+  end
+
+  it "maps ['displayOptions']['businessName'] to #business_na,e" do
+    response.business_name.should == "Bobcats R us"
+  end
+
+  it "maps ['shippingAddressId'] to #shipping_address_id" do
+    response.shipping_address_id.should == "addr123"
+  end
+
+  it "maps ['senderOptions']['requireShippingAddressSelection'] to #require_shipping_address_selection? " do
+    response.require_shipping_address_selection?.should be_true
+  end
+
+  it "maps ['receiverOptions'][0]['description'] to #receiver_options.first.description" do
+    response.receiver_options.first.description.should == "Primary receiver"
+  end
+
+  it "maps ['receiverOptions'][0]['customId'] to #receiver_options.first.custom_id" do
+    response.receiver_options.first.custom_id.should == "cust123"
+  end
+
+  it "maps ['receiverOptions'][0]['invoiceData']['totalTax'] to #receiver_options.first.invoice_data.total_tax" do
+    response.receiver_options.first.invoice_data.total_tax.should == BigDecimal("2.00")
+  end
+
+  it "maps ['receiverOptions'][0]['invoiceData']['totalShipping'] to #receiver_options.first.invoice_data.total_shipping" do
+    response.receiver_options.first.invoice_data.total_shipping.should == BigDecimal("0.00")
+  end
+
+  it "maps ['receiverOptions'][0]['invoiceData']['item'][0]['name'] to #receiver_options.first.invoice_data.items.first.name" do
+    response.receiver_options.first.invoice_data.items.first.name.should == "Video Game"
+  end
+
+  it "maps ['receiverOptions'][0]['invoiceData']['item'][0]['identifier'] to #receiver_options.first.invoice_data.items.first.identifier" do
+    response.receiver_options.first.invoice_data.items.first.identifier.should == "ident123"
+  end
+
+  it "maps ['receiverOptions'][0]['invoiceData']['item'][0]['price'] to #receiver_options.first.invoice_data.items.first.price" do
+    response.receiver_options.first.invoice_data.items.first.price.should == BigDecimal("20.00")
+  end
+
+  it "maps ['receiverOptions'][0]['invoiceData']['item'][0]['itemPrice'] to #receiver_options.first.invoice_data.items.first.item_price" do
+    response.receiver_options.first.invoice_data.items.first.item_price.should == BigDecimal("10.00")
+  end
+
+  it "maps ['receiverOptions'][0]['invoiceData']['item'][0]['itemCount'] to #receiver_options.first.invoice_data.items.first.item_count" do
+    response.receiver_options.first.invoice_data.items.first.item_count.should == 2
+  end
+end

data/spec/public/json_model_spec.rb

@@ -0,0 +1,56 @@
+require "spec_helper"
+require "virtus"
+
+describe AdaptivePayments::JsonModel do
+  let(:model) do
+    Class.new(AdaptivePayments::JsonModel) do
+      attribute :an_example, Virtus::Attribute::String, :param => "anExample"
+      attribute :simple,     Virtus::Attribute::String
+      attribute :numeric,    Virtus::Attribute::Decimal
+      attribute :optional,   Virtus::Attribute::String, :default => "test"
+    end
+  end
+
+  describe "coercion" do
+    let(:object) { model.new(:an_example => "string", :numeric => 20) }
+
+    it "casts inputs to the correct type" do
+      object.an_example.should == "string"
+      object.numeric.should == BigDecimal("20.00")
+    end
+  end
+
+  describe "default values" do
+    let(:object) { model.new }
+
+    it "reads the :default option for a default value" do
+      object.optional.should == "test"
+    end
+  end
+
+  describe "#to_json" do
+    context "with empty values" do
+      let(:json) { model.new.to_json }
+
+      it "omits the empty values" do
+        json.should == '{"optional":"test"}'
+      end
+    end
+
+    context "with decimal values" do
+      let(:json) { model.new(:numeric => 10).to_json }
+
+      it "formats the decimal to scale 2" do
+        json.should == '{"numeric":"10.00","optional":"test"}'
+      end
+    end
+
+    context "with a :param option" do
+      let(:json) { model.new(:an_example => "whatever").to_json }
+
+      it "uses the param as the key" do
+        json.should == '{"anExample":"whatever","optional":"test"}'
+      end
+    end
+  end
+end

data/spec/public/node_list_spec.rb

@@ -0,0 +1,58 @@
+require "spec_helper"
+
+describe AdaptivePayments::NodeList do
+  let(:child_model) do
+    Class.new(AdaptivePayments::JsonModel) do
+      attribute :example, String
+    end
+  end
+
+  let(:model) do
+    klass = child_model
+    Class.new(AdaptivePayments::JsonModel) do
+      attribute :children, AdaptivePayments::NodeList[klass]
+    end
+  end
+
+  describe "default type" do
+    it "is a kind of Array" do
+      model.new.children.should be_a_kind_of(Array)
+    end
+  end
+
+  describe "coercion" do
+    context "when appending to" do
+      let(:object) { model.new.tap { |o| o.children << { :example => "anything" } } }
+
+      it "coerces hash to instances of the given type" do
+        object.children.first.should be_an_instance_of(child_model)
+      end
+    end
+
+    context "when overwriting" do
+      let(:object) { model.new.tap { |o| o.children = [{ :example => "anything" }] } }
+
+      it "coerces each member to instances of the given type" do
+        object.children.first.should be_an_instance_of(child_model)
+      end
+    end
+  end
+
+  describe "#to_json" do
+    context "when not empty" do
+      let(:json) { model.new(:children => [{ :example => "whatever" }]).to_json }
+
+      it "is present as a child in the output" do
+        json.should == '{"children":[{"example":"whatever"}]}'
+      end
+    end
+
+    context "when empty" do
+      let(:json) { model.new.to_json }
+
+      it "is omitted from the output" do
+        json.should == '{}'
+      end
+    end
+  end
+end

data/spec/public/node_spec.rb

@@ -0,0 +1,54 @@
+require "spec_helper"
+
+describe AdaptivePayments::Node do
+  let(:child_model) do
+    Class.new(AdaptivePayments::JsonModel) do
+      attribute :example, String
+    end
+  end
+
+  let(:model) do
+    klass = child_model
+    Class.new(AdaptivePayments::JsonModel) do
+      attribute :child, AdaptivePayments::Node[klass]
+    end
+  end
+
+  describe "default type" do
+    let(:child) { model.new.child }
+
+    it "is an instance of the boxed type" do
+      child.should be_an_instance_of(child_model)
+    end
+  end
+
+  describe "coercion" do
+    let(:object) { model.new(:child => { :example => "anything" }) }
+
+    it "coerces hash to instances of the given type" do
+      object.child.should be_an_instance_of(child_model)
+    end
+
+    it "maintains the original keys" do
+      object.child.example.should == "anything"
+    end
+  end
+
+  describe "#to_json" do
+    context "when not empty" do
+      let(:json) { model.new(:child => { :example => "whatever" }).to_json }
+
+      it "is present as a child in the output" do
+        json.should == '{"child":{"example":"whatever"}}'
+      end
+    end
+
+    context "when empty" do
+      let(:json) { model.new.to_json }
+
+      it "is omitted from the output" do
+        json.should == '{}'
+      end
+    end
+  end
+end

data/spec/public/pay_request_spec.rb

@@ -0,0 +1,150 @@
+require "spec_helper"
+
+describe AdaptivePayments::PayRequest do
+  it_behaves_like "a RequestEnvelope"
+
+  subject         { AdaptivePayments::PayRequest }
+  its(:operation) { should == :Pay }
+
+  let(:request) do
+    AdaptivePayments::PayRequest.new(
+      :receivers                 => [ { :email => "receiver1@site.com", :amount => 20 }, { :email => "receiver2@site.com", :amount => 5, :primary => true } ],
+      :action_type               => "PAY",
+      :payment_type              => "DIGITALGOODS",
+      :allowed_funding_types     => ["CREDITCARD", "BALANCE"],
+      :invoice_id                => "42",
+      :preapproval_key           => "ABCD-1234",
+      :pin                       => "1234",
+      :currency_code             => "USD",
+      :cancel_url                => "http://site.com/cancelled",
+      :return_url                => "http://site.com/success",
+      :ipn_notification_url      => "http://site.com/ipn",
+      :sender_email              => "sender@site.com",
+      :sender_phone_country_code => "61",
+      :sender_phone_number       => "0431300200",
+      :sender_phone_extension    => "033",
+      :reverse_parallel_payments_on_error => false,
+      :tracking_id               => "anything.id",
+      :memo                      => "a personal note"
+    )
+  end
+
+  let(:json) { JSON.parse(request.to_json) }
+
+  it "maps #receivers.first.email to ['receiverList']['receiver'][0]['email']" do
+    json["receiverList"]["receiver"][0]["email"].should == "receiver1@site.com"
+  end
+
+  it "maps #receivers.last.email to ['receiverList']['receiver'][1]['email']" do
+    json["receiverList"]["receiver"][1]["email"].should == "receiver2@site.com"
+  end
+
+  it "maps #receivers.first.amount to ['receiverList']['receiver'][0]['amount']" do
+    json["receiverList"]["receiver"][0]["amount"].should == "20.00"
+  end
+
+  it "maps #receivers.last.amount to ['receiverList']['receiver'][1]['amount']" do
+    json["receiverList"]["receiver"][1]["amount"].should == "5.00"
+  end
+
+  it "maps #receivers.last.primary to ['receiverList']['receiver'][1]['primary']" do
+    json["receiverList"]["receiver"][1]["primary"].should == true
+  end
+
+  it "maps #payment_type to ['receiverList']['receiver'][0]['paymentType']" do
+    json["receiverList"]["receiver"][0]["paymentType"].should == "DIGITALGOODS"
+  end
+
+  it "maps #allowed_funding_types.first to ['fundingConstraint']['allowedFundingType']['fundingTypeInfo'][0]['fundingType']" do
+    json["fundingConstraint"]["allowedFundingType"]["fundingTypeInfo"][0]["fundingType"].should == "CREDITCARD"
+  end
+
+  it "maps #allowed_funding_types.last to ['fundingConstraint']['allowedFundingType']['fundingTypeInfo'][1]['fundingType']" do
+    json["fundingConstraint"]["allowedFundingType"]["fundingTypeInfo"][1]["fundingType"].should == "BALANCE"
+  end
+
+  it "maps #invoice_id to ['receiverList']['receiver'][0]['invoiceId']" do
+    json["receiverList"]["receiver"][0]["invoiceId"].should == "42"
+  end
+
+  it "allows setting the first receiver email with #receiver_email" do
+    request.receiver_email = "another@receiver.com"
+    json["receiverList"]["receiver"][0]["email"].should == "another@receiver.com"
+  end
+
+  it "allows setting the first receiver amount with #receiver_amount" do
+    request.receiver_amount = 30
+    json["receiverList"]["receiver"][0]["amount"].should == "30.00"
+  end
+
+  it "allows setting the first receiver phone number with #receiver_phone_number" do
+    request.receiver_phone_number = "0431301201"
+    json["receiverList"]["receiver"][0]["phone"]["phoneNumber"].should == "0431301201"
+  end
+
+  it "allows setting the first receiver phone country code with #receiver_phone_country_code" do
+    request.receiver_phone_country_code = "61"
+    json["receiverList"]["receiver"][0]["phone"]["countryCode"].should == "61"
+  end
+
+  it "allows setting the first receiver phone extension with #receiver_phone_extension" do
+    request.receiver_phone_extension = "033"
+    json["receiverList"]["receiver"][0]["phone"]["extension"].should == "033"
+  end
+
+  it "maps #action_type to ['actionType']" do
+    json["actionType"].should == "PAY"
+  end
+
+  it "maps #preapproval_key to ['preapprovalKey']" do
+    json["preapprovalKey"].should == "ABCD-1234"
+  end
+
+  it "maps #pin to ['pin']" do
+    json["pin"].should == "1234"
+  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/success"
+  end
+
+  it "maps #ipn_notification_url to ['ipnNotificationUrl']" do
+    json["ipnNotificationUrl"].should == "http://site.com/ipn"
+  end
+
+  it "maps #sender_email to ['sender']['email']" do
+    json["sender"]["email"].should == "sender@site.com"
+  end
+
+  it "maps #sender_phone_country_code to ['sender']['phone']['countryCode']" do
+    json["sender"]["phone"]["countryCode"].should == "61"
+  end
+
+  it "maps #sender_phone_number to ['sender']['phone']['phoneNumber']" do
+    json["sender"]["phone"]["phoneNumber"].should == "0431300200"
+  end
+
+  it "maps #sender_phone_extension to ['sender']['phone']['extension']" do
+    json["sender"]["phone"]["extension"].should == "033"
+  end
+
+  it "maps #reverse_parallel_payments_on_error to ['reverseAllParallelPaymentsOnError']" do
+    json["reverseAllParallelPaymentsOnError"].should == false
+  end
+
+  it "maps #tracking_id to ['trackingId']" do
+    json["trackingId"].should == "anything.id"
+  end
+
+  it "maps #memo to 'memo'" do
+    json["memo"].should == "a personal note"
+  end
+end

data/spec/public/pay_response_spec.rb

@@ -0,0 +1,197 @@
+require "spec_helper"
+
+describe AdaptivePayments::PayResponse do
+  it_behaves_like "a ResponseEnvelope"
+  it_behaves_like "a FaultMessage"
+
+  let(:response) do
+    AdaptivePayments::PayResponse.from_json(
+      {
+        :payKey => "ABCD-1234",
+        :paymentExecStatus  => "COMPLETED",
+        :defaultFundingPlan => {
+          :fundingPlanId => "XXX123",
+          :fundingAmount => {
+            :amount => "100.00",
+            :code   => "USD"
+          },
+          :senderFees => {
+            :amount => "6.00",
+            :code   => "USD"
+          },
+          :backupFundingSource => {
+            :fundingSourceId => "9876",
+            :lastFourOfAccountNumber => "0000",
+            :displayName => "Primary Account",
+            :type => "CREDITCARD",
+            :allowed => true
+          },
+          :currencyConversion => {
+            :from => {
+              :amount => "83.33",
+              :code => "GBP"
+            },
+            :to => {
+              :amount => "100.00",
+              :code => "USD"
+            },
+            :exchangeRate => "0.8333"
+          },
+          :charge => [
+            :charge => {
+              :amount => "5.00",
+              :code => "USD"
+            },
+            :fundingSource => {
+              :fundingSourceId => "1234"
+            }
+          ]
+        },
+        :payErrorList => {
+          :payError => [
+            {
+              :receiver => {
+                :email => "bob@site.com",
+                :amount => "5.00"
+              },
+              :error => {
+                :domain => "APPLICATION",
+                :message => "there was an error"
+              }
+            },
+            {
+              :receiver => {
+                :email => "sally@site.com",
+                :amount => "10.00"
+              },
+              :error => {
+                :domain => "APPLICATION",
+                :message => "there was another error"
+              }
+            }
+          ]
+        }
+      }.to_json
+    )
+  end
+
+  it "maps ['payKey'] to #pay_key" do
+    response.pay_key.should == "ABCD-1234"
+  end
+
+  it "maps ['paymentExecStatus'] to #payment_exec_status" do
+    response.payment_exec_status.should == "COMPLETED"
+  end
+
+  it "maps ['defaultFundingPlan']['fundingPlanId'] to #funding_plan_id" do
+    response.funding_plan_id.should == "XXX123"
+  end
+
+  it "maps ['defaultFundingPlan']['fundingAmount']['amount'] to #funding_amount" do
+    response.funding_amount.should == BigDecimal("100.00")
+  end
+
+  it "maps ['defaultFundingPlan']['fundingAmount']['code'] to #funding_currency_code" do
+    response.funding_currency_code.should == "USD"
+  end
+
+  it "maps ['defaultFundingPlan']['senderFees']['amount'] to #sender_fees_amount" do
+    response.sender_fees_amount.should == BigDecimal("6.00")
+  end
+
+  it "maps ['defaultFundingPlan']['senderFees']['code'] to #sender_fees_currency_code" do
+    response.sender_fees_currency_code.should == "USD"
+  end
+
+  it "maps ['defaultFundingPlan']['backupFundingSource']['fundingSourceId'] to #backup_funding_source.id" do
+    response.backup_funding_source.id.should == "9876"
+  end
+
+  it "maps ['defaultFundingPlan']['backupFundingSource']['lastFourOfAccountNumber'] to #backup_funding_source.last_four_digits_of_account" do
+    response.backup_funding_source.last_four_digits_of_account.should == "0000"
+  end
+
+  it "maps ['defaultFundingPlan']['backupFundingSource']['displayName'] to #backup_funding_source.display_name" do
+    response.backup_funding_source.display_name.should == "Primary Account"
+  end
+
+  it "maps ['defaultFundingPlan']['backupFundingSource']['type'] to #backup_funding_source.type" do
+    response.backup_funding_source.type.should == "CREDITCARD"
+  end
+
+  it "maps ['defaultFundingPlan']['backupFundingSource']['allowed'] to #backup_funding_source.allowed? " do
+    response.backup_funding_source.should be_allowed
+  end
+
+  it "maps ['defaultFundingPlan']['currencyConversion']['from']['amount'] to #from_currency_amount" do
+    response.from_currency_amount.should == BigDecimal("83.33")
+  end
+
+  it "maps ['defaultFundingPlan']['currencyConversion']['from']['code'] to #from_currency_code" do
+    response.from_currency_code.should == "GBP"
+  end
+
+  it "maps ['defaultFundingPlan']['currencyConversion']['to']['amount'] to #to_currency_amount" do
+    response.to_currency_amount.should == BigDecimal("100.00")
+  end
+
+  it "maps ['defaultFundingPlan']['currencyConversion']['to']['code'] to #to_currency_code" do
+    response.to_currency_code.should == "USD"
+  end
+
+  it "maps ['defaultFundingPlan']['currencyConversion']['exchangeRate'] to #exchange_rate" do
+    response.exchange_rate.should == BigDecimal("0.8333")
+  end
+
+  it "maps ['defaultFundingPlan']['charge'][0]['charge']['amount'] to #charges.first.amount" do
+    response.charges.first.amount.should == BigDecimal("5.00")
+  end
+
+  it "maps ['defaultFundingPlan']['charge'][0]['charge']['code'] to #charges.first.currency_code" do
+    response.charges.first.currency_code.should == "USD"
+  end
+
+  it "maps ['defaultFundingPlan']['charge'][0]['fundingSource']['fundingSourceId'] to #charges.first.funding_source.id" do
+    response.charges.first.funding_source.id.should == "1234"
+  end
+
+  it "maps ['payErrorList']['payError'][0]['receiver']['email'] to #pay_errors.first.receiver.email" do
+    response.pay_errors.first.receiver.email.should == "bob@site.com"
+  end
+
+  it "allows access to ['payErrorList']['payError'][0]['receiver']['email'] with #pay_errors.first.receiver_email" do
+    response.pay_errors.first.receiver_email.should == "bob@site.com"
+  end
+
+  it "maps ['payErrorList']['payError'][0]['receiver']['amount'] to #pay_errors.first.receiver.amount" do
+    response.pay_errors.first.receiver.amount.should == BigDecimal("5.00")
+  end
+
+  it "allows access to ['payErrorList']['payError'][0]['receiver']['amount'] with #pay_errors.first.receiver_amount" do
+    response.pay_errors.first.receiver_amount.should == BigDecimal("5.00")
+  end
+
+  it "maps ['payErrorList']['payError'][0]['error']['domain'] to #pay_errors.first.error.domain" do
+    response.pay_errors.first.error.domain.should == "APPLICATION"
+  end
+
+  it "allows access to ['payErrorList']['payError'][0]['error']['domain'] with #pay_errors.first.error_domain" do
+    response.pay_errors.first.error_domain.should == "APPLICATION"
+  end
+
+  it "maps ['payErrorList']['payError'][0]['error']['message'] to #pay_errors.first.error.message" do
+    response.pay_errors.first.error.message.should == "there was an error"
+  end
+
+  it "allows access to ['payErrorList']['payError'][0]['error']['message'] with #pay_errors.first.error_message" do
+    response.pay_errors.first.error_message.should == "there was an error"
+  end
+
+  it "maps ['payErrorList']['payError'][1]['receiver']['email'] to #pay_errors.last.receiver.email" do
+    response.pay_errors.last.receiver.email.should == "sally@site.com"
+  end
+
+  it "maps ['payErrorList']['payError'][0]['error']['message'] to #pay_errors.last.error.message" do
+    response.pay_errors.last.error.message.should == "there was another error"
+  end
+end