sage_pay 0.2.5 → 0.2.6

data/lib/sage_pay/server/{transaction_registration_response.rb → response.rb}

@@ -1,28 +1,28 @@
 module SagePay
   module Server
-    class TransactionRegistrationResponse
-      attr_reader :vps_protocol, :status, :status_detail
+    class Response
+      class_inheritable_hash :key_converter, :value_converter, :instance_writer => false
 
-      def self.from_response_body(response_body)
-        key_converter = {
-          "VPSProtocol"  => :vps_protocol,
-          "Status"       => :status,
-          "StatusDetail" => :status_detail,
-          "VPSTxId"      => :vps_tx_id,
-          "SecurityKey"  => :security_key,
-          "NextURL"      => :next_url
-        }
+      self.key_converter = {
+        "VPSProtocol"  => :vps_protocol,
+        "Status"       => :status,
+        "StatusDetail" => :status_detail,
+      }
 
-        value_converter = {
-          :status => {
-            "OK"        => :ok,
-            "MALFORMED" => :malformed,
-            "INVALID"   => :invalid,
-            "ERROR"     => :error
-          }
+      self.value_converter = {
+        :status => {
+          "OK"        => :ok,
+          "MALFORMED" => :malformed,
+          "INVALID"   => :invalid,
+          "ERROR"     => :error
         }
+      }
+
+      attr_reader :vps_protocol, :status, :status_detail
 
+      def self.from_response_body(response_body)
         attributes = {}
+
         response_body.each_line do |line|
           key, value = line.split('=', 2)
           unless key.nil? || value.nil?
@@ -65,30 +65,6 @@ module SagePay
       def error?
         status == :error
       end
-
-      def vps_tx_id
-        if ok?
-          @vps_tx_id
-        else
-          raise RuntimeError, "Unable to retrieve the transaction id as the status was not OK."
-        end
-      end
-
-      def security_key
-        if ok?
-          @security_key
-        else
-          raise RuntimeError, "Unable to retrieve the security key as the status was not OK."
-        end
-      end
-
-      def next_url
-        if ok?
-          @next_url
-        else
-          raise RuntimeError, "Unable to retrieve the next URL as the status was not OK."
-        end
-      end
     end
   end
 end

data/sage_pay.gemspec

@@ -7,7 +7,7 @@ Gem::Specification.new do |s|
   ## If your rubyforge_project name is different, then edit it and comment out
   ## the sub! line in the Rakefile
   s.name              = 'sage_pay'
-  s.version           = '0.2.5'
+  s.version           = '0.2.6'
   s.date              = '2010-04-25'
   s.rubyforge_project = 'sage_pay'
 
@@ -56,24 +56,27 @@ gateway for accepting credit card payments through your web app.
     lib/sage_pay.rb
     lib/sage_pay/server.rb
     lib/sage_pay/server/address.rb
+    lib/sage_pay/server/command.rb
+    lib/sage_pay/server/notification.rb
+    lib/sage_pay/server/notification_response.rb
+    lib/sage_pay/server/registration.rb
+    lib/sage_pay/server/registration_response.rb
+    lib/sage_pay/server/release.rb
+    lib/sage_pay/server/response.rb
     lib/sage_pay/server/signature_verification_details.rb
     lib/sage_pay/server/transaction_code.rb
-    lib/sage_pay/server/transaction_notification.rb
-    lib/sage_pay/server/transaction_notification_response.rb
-    lib/sage_pay/server/transaction_registration.rb
-    lib/sage_pay/server/transaction_registration_response.rb
     lib/sage_pay/uri_fixups.rb
     lib/validatable-ext.rb
     lib/validations/validates_inclusion_of.rb
     sage_pay.gemspec
     spec/integration/sage_pay/server_spec.rb
     spec/sage_pay/server/address_spec.rb
+    spec/sage_pay/server/notification_response_spec.rb
+    spec/sage_pay/server/notification_spec.rb
+    spec/sage_pay/server/registration_response_spec.rb
+    spec/sage_pay/server/registration_spec.rb
     spec/sage_pay/server/signature_verification_details_spec.rb
     spec/sage_pay/server/transaction_code_spec.rb
-    spec/sage_pay/server/transaction_notification_response_spec.rb
-    spec/sage_pay/server/transaction_notification_spec.rb
-    spec/sage_pay/server/transaction_registration_response_spec.rb
-    spec/sage_pay/server/transaction_registration_spec.rb
     spec/sage_pay/server_spec.rb
     spec/sage_pay_spec.rb
     spec/spec_helper.rb

data/spec/integration/sage_pay/server_spec.rb

@@ -2,14 +2,20 @@ require 'spec_helper'
 
 if run_integration_specs?
   describe SagePay::Server, "integration specs" do
+    before(:each) do
+      SagePay::Server.default_registration_options = {
+        :mode => :simulator,
+        :vendor => "rubaidh",
+        :notification_url => "http://test.host/notification"
+      }
+    end
+
+    after(:each) do
+      SagePay::Server.default_registration_options = {}
+    end
+
     describe ".payment" do
       before(:each) do
-        SagePay::Server.default_registration_options = {
-          :mode => :simulator,
-          :vendor => "rubaidh",
-          :notification_url => "http://test.host/notification"
-        }
-
         @payment = SagePay::Server.payment(
           :description => "Demo payment",
           :amount => 12.34,
@@ -18,26 +24,67 @@ if run_integration_specs?
         )
       end
 
-      after(:each) do
-        SagePay::Server.default_registration_options = {}
-      end
-
       it "should successfully register the payment with SagePay" do
-        @payment.register!.should_not be_nil
+        @payment.run!.should_not be_nil
       end
 
       it "should be a valid registered payment" do
-        registration = @payment.register!
+        registration = @payment.run!
+        registration.should be_ok
+      end
+
+      it "should have a next URL" do
+        registration = @payment.run!
+        registration.next_url.should_not be_nil
+      end
+
+      it "should allow us to follow the next URL and the response should be successful" do
+        registration = @payment.run!
+        uri = URI.parse(registration.next_url)
+        request = Net::HTTP::Get.new(uri.request_uri)
+        http = Net::HTTP.new(uri.host, uri.port)
+        http.use_ssl = true if uri.scheme == "https"
+        http.start { |http|
+          http.request(request)
+        }
+      end
+
+      it "should allow us to retrieve signature verification details" do
+        @payment.run!
+        sig_details = @payment.signature_verification_details
+
+        sig_details.should_not                be_nil
+        sig_details.security_key.should_not   be_nil
+        sig_details.vendor.should_not         be_nil
+      end
+    end
+
+    describe ".deferred" do
+      before(:each) do
+        @payment = SagePay::Server.deferred(
+          :description => "Demo payment",
+          :amount => 12.34,
+          :currency => "GBP",
+          :billing_address => address_factory
+        )
+      end
+
+      it "should successfully register the deferred payment with SagePay" do
+        @payment.run!.should_not be_nil
+      end
+
+      it "should be a valid deferred payment" do
+        registration = @payment.run!
         registration.should be_ok
       end
 
       it "should have a next URL" do
-        registration = @payment.register!
+        registration = @payment.run!
         registration.next_url.should_not be_nil
       end
 
       it "should allow us to follow the next URL and the response should be successful" do
-        registration = @payment.register!
+        registration = @payment.run!
         uri = URI.parse(registration.next_url)
         request = Net::HTTP::Get.new(uri.request_uri)
         http = Net::HTTP.new(uri.host, uri.port)
@@ -48,7 +95,7 @@ if run_integration_specs?
       end
 
       it "should allow us to retrieve signature verification details" do
-        @payment.register!
+        @payment.run!
         sig_details = @payment.signature_verification_details
 
         sig_details.should_not                be_nil

data/spec/sage_pay/server/notification_response_spec.rb

@@ -0,0 +1,75 @@
+require 'spec_helper'
+
+include SagePay::Server
+
+describe NotificationResponse do
+  it "should work straight from the factory" do
+    lambda {
+      notification_response_factory.should be_valid
+    }.should_not raise_error
+  end
+
+  describe "validations" do
+    it { validates_the_presence_of(:notification_response, :status) }
+    it { validates_the_presence_of(:notification_response, :redirect_url) }
+
+    it "validates the presence of the status_detail field only if the status is something other than OK" do
+      notification_response = notification_response_factory(:status => :ok, :status_detail => nil)
+      notification_response.should be_valid
+
+      notification_response = notification_response_factory(:status => :invalid, :status_detail => "Invalid request!")
+      notification_response.should be_valid
+
+      notification_response = notification_response_factory(:status => :invalid, :status_detail => "")
+      notification_response.should_not be_valid
+      notification_response.errors.on(:status_detail).should include("can't be empty")
+    end
+
+    it { validates_the_length_of(:notification_response, :redirect_url,  :max => 255) }
+    it { validates_the_length_of(:notification_response, :status_detail, :max => 255) }
+
+    it "should allow the status to be one of :ok, :invalid or :error" do
+      notification_response = notification_response_factory(:status => :ok)
+      notification_response.should be_valid
+
+      notification_response = notification_response_factory(:status => :invalid)
+      notification_response.should be_valid
+
+      notification_response = notification_response_factory(:status => :error)
+      notification_response.should be_valid
+
+      notification_response = notification_response_factory(:status => :chickens)
+      notification_response.should_not be_valid
+      notification_response.errors.on(:status).should include("is not in the list")
+    end
+  end
+
+  describe "#response" do
+    it "should produce the expected response for an OK status" do
+      notification_response = notification_response_factory(
+        :status => :ok,
+        :redirect_url => "http://test.host/some/redirect",
+        :status_detail => nil
+      )
+      notification_response.response.should == <<-RESPONSE.chomp
+Status=OK\r
+RedirectURL=http://test.host/some/redirect
+      RESPONSE
+    end
+
+    it "should produce the expected response for an invalid status" do
+      notification_response = notification_response_factory(
+        :status => :invalid,
+        :redirect_url => "http://test.host/some/redirect",
+        :status_detail => "Totally didn't expect that notification, dude."
+      )
+      # FIXME: I'm asserting here that I don't have to URI-encode the body
+      # here. OK?
+      notification_response.response.should == <<-RESPONSE.chomp
+Status=INVALID\r
+RedirectURL=http://test.host/some/redirect\r
+StatusDetail=Totally didn't expect that notification, dude.\r
+      RESPONSE
+    end
+  end
+end

data/spec/sage_pay/server/{transaction_notification_spec.rb → notification_spec.rb}

@@ -2,14 +2,40 @@ require 'spec_helper'
 
 include SagePay::Server
 
-describe TransactionNotification do
+describe Notification do
   it "should work straight from the factory" do
     lambda {
-      transaction_notification_factory.should_not be_nil
+      notification_factory.should_not be_nil
     }.should_not raise_error
   end
 
   describe ".from_params" do
+    before(:each) do
+      @params = {
+        "VPSProtocol"    => "2.23",
+        "TxType"         => "PAYMENT",
+        "VendorTxCode"   => "unique-tx-code",
+        "VPSTxId"        => "{728A5721-B45F-4570-937E-90A16B0A5000}",
+        "Status"         => "OK",
+        "StatusDetail"   => "2000 : Card processed successfully.", # FIXME: Make this match reality
+        "TxAuthNo"       => "1234567890",
+        "AVSCV2"         => "ALL MATCH",
+        "AddressResult"  => "MATCHED",
+        "PostCodeResult" => "MATCHED",
+        "CV2Result"      => "MATCHED",
+        "GiftAid"        => "0",
+        "3DSecureStatus" => "OK",
+        "CAVV"           => "Something?",
+        "AddressStatus"  => "CONFIRMED",
+        "PayerStatus"    => "VERIFIED",
+        "CardType"       => "VISA",
+        "Last4Digits"    => "1234",
+        # FIXME: Calculated manually using the information above. Should
+        # really get one from a sample transaction...
+        "VPSSignature"   => "6AB7A7FFB5369AF953CD57A84D5C2979"
+      }
+    end
+
     context "with an OK status" do
       before(:each) do
         signature_verification_details = mock("Signature verification details",
@@ -17,36 +43,12 @@ describe TransactionNotification do
           :security_key   => "17F13DCBD8"
         )
 
-        @params = {
-          "VPSProtocol"    => "2.23",
-          "TxType"         => "PAYMENT",
-          "VendorTxCode"   => "unique-tx-code",
-          "VPSTxId"        => "{728A5721-B45F-4570-937E-90A16B0A5000}",
-          "Status"         => "OK",
-          "StatusDetail"   => "2000 : Card processed successfully.", # FIXME: Make this match reality
-          "TxAuthNo"       => "1234567890",
-          "AVSCV2"         => "ALL MATCH",
-          "AddressResult"  => "MATCHED",
-          "PostCodeResult" => "MATCHED",
-          "CV2Result"      => "MATCHED",
-          "GiftAid"        => "0",
-          "3DSecureStatus" => "OK",
-          "CAVV"           => "Something?",
-          "AddressStatus"  => "CONFIRMED",
-          "PayerStatus"    => "VERIFIED",
-          "CardType"       => "VISA",
-          "Last4Digits"    => "1234",
-          # FIXME: Calculated manually using the information above. Should
-          # really get one from a sample transaction...
-          "VPSSignature"   => "6AB7A7FFB5369AF953CD57A84D5C2979"
-        }
-
-        @notification = TransactionNotification.from_params(@params, signature_verification_details)
+        @notification = Notification.from_params(@params, signature_verification_details)
       end
 
       it "should successfully parse the params" do
         lambda {
-          TransactionNotification.from_params(@params).should_not be_nil
+          Notification.from_params(@params).should_not be_nil
         }.should_not raise_error
       end
 
@@ -149,6 +151,42 @@ describe TransactionNotification do
       it "should report that the vps signature is valid" do
         @notification.should be_valid_signature
       end
+
+      it "should generate a successful response" do
+        mock_notification_response = mock(NotificationResponse, :response => "some response")
+        NotificationResponse.should_receive(:new).with(:status => :ok, :redirect_url => "mock redirect url").and_return(mock_notification_response)
+        @notification.response("mock redirect url").should == "some response"
+      end
+    end
+
+    context "with an invalid signature" do
+      before(:each) do
+        signature_verification_details = mock("Signature verification details",
+          :vendor         => "rubaidh",
+          :security_key   => "different security key"
+        )
+
+        @notification = Notification.from_params(@params, signature_verification_details)
+      end
+
+      it "should generate a failed response" do
+        mock_notification_response = mock(NotificationResponse, :response => "can haz failure")
+        NotificationResponse.should_receive(:new).with(:status => :invalid, :redirect_url => "mock redirect url", :status_detail => "Signature did not match our expectations").and_return(mock_notification_response)
+        @notification.response("mock redirect url").should == "can haz failure"
+      end
+    end
+
+    context "with a block supplied for the signature verification details" do
+      it "should still validate the signature correctly" do
+        notification = Notification.from_params(@params) do |attributes|
+          mock("Signature verification details",
+            :vendor         => "rubaidh",
+            :security_key   => "17F13DCBD8"
+          )
+        end
+
+        notification.should be_valid_signature
+      end
     end
   end
 end

data/spec/sage_pay/server/{transaction_registration_response_spec.rb → registration_response_spec.rb}

@@ -2,10 +2,10 @@ require 'spec_helper'
 
 include SagePay::Server
 
-describe TransactionRegistrationResponse do
+describe RegistrationResponse do
   it "should work straight from the factory" do
     lambda {
-      transaction_registration_response_factory.should_not be_nil
+      registration_response_factory.should_not be_nil
     }.should_not raise_error
   end
 
@@ -17,12 +17,12 @@ VPSProtocol=2.23
 Status=INVALID
 StatusDetail=4000 : The VendorName is invalid or the account is not active.
         RESPONSE
-        @response = TransactionRegistrationResponse.from_response_body(@response_body)
+        @response = RegistrationResponse.from_response_body(@response_body)
       end
 
       it "should successfully parse the body" do
         lambda {
-          TransactionRegistrationResponse.from_response_body(@response_body)
+          RegistrationResponse.from_response_body(@response_body)
         }.should_not raise_error
       end
 
@@ -72,12 +72,12 @@ VPSProtocol=2.23
 Status=MALFORMED
 StatusDetail=5000 : Your request had too many toes.
         RESPONSE
-        @response = TransactionRegistrationResponse.from_response_body(@response_body)
+        @response = RegistrationResponse.from_response_body(@response_body)
       end
 
       it "should successfully parse the body" do
         lambda {
-          TransactionRegistrationResponse.from_response_body(@response_body)
+          RegistrationResponse.from_response_body(@response_body)
         }.should_not raise_error
       end
 
@@ -127,12 +127,12 @@ VPSProtocol=2.23
 Status=ERROR
 StatusDetail=5000 : SagePay blew up.
         RESPONSE
-        @response = TransactionRegistrationResponse.from_response_body(@response_body)
+        @response = RegistrationResponse.from_response_body(@response_body)
       end
 
       it "should successfully parse the body" do
         lambda {
-          TransactionRegistrationResponse.from_response_body(@response_body)
+          RegistrationResponse.from_response_body(@response_body)
         }.should_not raise_error
       end
 
@@ -186,12 +186,12 @@ SecurityKey=17F13DCBD8
 NextURL=https://test.sagepay.com/Simulator/VSPServerPaymentPage.asp?TransactionID={728A5721-B45F-4570-937E-90A16B0A5000}
         RESPONSE
 
-        @response = TransactionRegistrationResponse.from_response_body(@response_body)
+        @response = RegistrationResponse.from_response_body(@response_body)
       end
 
       it "should successfully parse the body" do
         lambda {
-          TransactionRegistrationResponse.from_response_body(@response_body)
+          RegistrationResponse.from_response_body(@response_body)
         }.should_not raise_error
       end