sage_pay 0.2.5 → 0.2.6

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 0.2.6
+
+* Is release implemented?
+
 ## 0.2.5
 
 * Carriage return and line feed. These will all be compressed into a 0.3

data/lib/sage_pay.rb

@@ -1,3 +1,4 @@
+require 'active_support'
 require 'validatable'
 require 'bigdecimal'
 require 'net/https'
@@ -6,7 +7,7 @@ require 'md5'
 require 'uuid'
 
 module SagePay
-  VERSION = '0.2.5'
+  VERSION = '0.2.6'
 end
 
 require 'validatable-ext'
@@ -15,8 +16,11 @@ require 'sage_pay/uri_fixups'
 require 'sage_pay/server/address'
 require 'sage_pay/server/transaction_code'
 require 'sage_pay/server/signature_verification_details'
-require 'sage_pay/server/transaction_registration'
-require 'sage_pay/server/transaction_registration_response'
-require 'sage_pay/server/transaction_notification'
-require 'sage_pay/server/transaction_notification_response'
+require 'sage_pay/server/command'
+require 'sage_pay/server/response'
+require 'sage_pay/server/registration'
+require 'sage_pay/server/registration_response'
+require 'sage_pay/server/notification'
+require 'sage_pay/server/notification_response'
+require 'sage_pay/server/release'
 require 'sage_pay/server'

data/lib/sage_pay/server.rb

@@ -15,17 +15,38 @@ module SagePay
     # of your environment files, if you're doing this with a Rails app.
     self.default_registration_options = {}
 
+    # The notification URL is only relevant to registration options, but the
+    # rest are relevant to all requests.
+    def self.default_options
+      @default_options ||= default_registration_options.except(:notification_url)
+    end
+
     def self.payment(attributes = {})
       registration({ :tx_type => :payment }.merge(attributes))
     end
 
+    def self.deferred(attributes = {})
+      registration({ :tx_type => :deferred }.merge(attributes))
+    end
+
+    def self.authenticate(attributes = {})
+      registration({ :tx_type => :authenticate }.merge(attributes))
+    end
+
     def self.registration(attributes)
       defaults = {
         :vendor_tx_code   => TransactionCode.random,
         :delivery_address => attributes[:billing_address]
       }.merge(default_registration_options)
 
-      SagePay::Server::TransactionRegistration.new(defaults.merge(attributes))
+      SagePay::Server::Registration.new(defaults.merge(attributes))
+    end
+
+    def self.release(attributes = {})
+      defaults = {
+      }.merge(default_options)
+
+      SagePay::Server::Release.new(defaults.merge(attributes))
     end
   end
 end

data/lib/sage_pay/server/command.rb

@@ -0,0 +1,98 @@
+module SagePay
+  module Server
+    class Command
+      include Validatable
+
+      attr_reader :vps_protocol
+      attr_accessor :mode, :tx_type, :vendor, :vendor_tx_code
+
+      validates_presence_of :vps_protocol, :mode, :tx_type, :vendor,
+        :vendor_tx_code
+
+      validates_length_of :vps_protocol,     :is      => 4
+      validates_length_of :vendor,           :maximum => 15
+      validates_length_of :vendor_tx_code,   :maximum => 40
+
+      validates_inclusion_of :mode, :allow_blank => true, :in => [ :simulator, :test, :live ]
+
+      def initialize(attributes = {})
+        @vps_protocol = "2.23"
+
+        attributes.each do |k, v|
+          send("#{k}=", v)
+        end
+      end
+
+      def run!
+        @response ||= handle_response(post)
+      end
+
+      def live_service
+        raise NotImplementedError, "Subclass of command implement live_service with tail of the URL used for that command in the test & live systems."
+      end
+
+      def simulator_service
+        raise NotImplementedError, "Subclass of command implement simulator_service with tail of the URL used for that command in the simulator."
+      end
+
+      def url
+        case mode
+        when :simulator
+          "https://test.sagepay.com/simulator/VSPServerGateway.asp?Service=#{simulator_service}"
+        when :test
+          "https://test.sagepay.com/gateway/service/#{live_service}.vsp"
+        when :live
+          "https://live.sagepay.com/gateway/service/#{live_service}.vsp"
+        else
+          raise ArgumentError, "Invalid transaction mode"
+        end
+      end
+
+      def post_params
+        raise ArgumentError, "Invalid transaction registration options (see errors hash for details)" unless valid?
+
+        {
+          "VPSProtocol"        => vps_protocol,
+          "TxType"             => tx_type.to_s.upcase,
+          "Vendor"             => vendor,
+          "VendorTxCode"       => vendor_tx_code,
+        }
+      end
+
+      def response_from_response_body(response_body)
+        Response.from_response_body(response_body)
+      end
+
+      private
+      def post
+        parsed_uri = URI.parse(url)
+        request = Net::HTTP::Post.new(parsed_uri.request_uri)
+        request.form_data = post_params
+
+        http = Net::HTTP.new(parsed_uri.host, parsed_uri.port)
+        http.use_ssl = true if parsed_uri.scheme == "https"
+        http.start { |http|
+          http.request(request)
+        }
+      end
+
+      def handle_response(response)
+        case response.code.to_i
+        when 200
+          response_from_response_body(response.body)
+        else
+          # FIXME: custom error response would be nice.
+          raise RuntimeError, "I guess SagePay doesn't like us today."
+        end
+      end
+
+      def present?(value)
+        !blank?(value)
+      end
+
+      def blank?(value)
+        value.nil? || (value.respond_to?(:empty?) && value.empty?)
+      end
+    end
+  end
+end

data/lib/sage_pay/server/{transaction_notification.rb → notification.rb}

@@ -1,6 +1,6 @@
 module SagePay
   module Server
-    class TransactionNotification
+    class Notification
       attr_reader :vps_protocol, :tx_type, :vendor_tx_code, :vps_tx_id,
         :status, :status_detail, :tx_auth_no, :avs_cv2, :address_result,
         :post_code_result, :cv2_result, :gift_aid, :threed_secure_status,
@@ -180,9 +180,9 @@ module SagePay
 
       def response(redirect_url)
         if valid_signature?
-          SagePay::Server::TransactionNotificationResponse.new(:status => :ok, :redirect_url => redirect_url)
+          SagePay::Server::NotificationResponse.new(:status => :ok, :redirect_url => redirect_url)
         else
-          SagePay::Server::TransactionNotificationResponse.new(:status => :invalid, :redirect_url => redirect_url, :status_detail => "Signature did not match our expectations")
+          SagePay::Server::NotificationResponse.new(:status => :invalid, :redirect_url => redirect_url, :status_detail => "Signature did not match our expectations")
         end.response
       end
     end

data/lib/sage_pay/server/{transaction_notification_response.rb → notification_response.rb}

@@ -1,6 +1,6 @@
 module SagePay
   module Server
-    class TransactionNotificationResponse
+    class NotificationResponse
       include Validatable
 
       attr_accessor :status, :status_detail, :redirect_url

data/lib/sage_pay/server/{transaction_registration.rb → registration.rb}

@@ -1,29 +1,20 @@
 module SagePay
   module Server
-    class TransactionRegistration
-      include Validatable
+    class Registration < Command
+      attr_accessor :amount, :currency, :description, :notification_url,
+        :billing_address, :delivery_address, :customer_email, :basket,
+        :allow_gift_aid, :apply_avs_cv2, :apply_3d_secure, :profile,
+        :billing_agreement, :account_type
 
-      attr_reader :vps_protocol
-      attr_accessor :mode, :tx_type, :vendor, :vendor_tx_code,
-        :amount, :currency, :description, :notification_url, :billing_address,
-        :delivery_address, :customer_email, :basket, :allow_gift_aid,
-        :apply_avs_cv2, :apply_3d_secure, :profile, :billing_agreement,
-        :account_type
+      validates_presence_of :amount, :currency, :description,
+        :notification_url, :billing_address, :delivery_address
 
-      validates_presence_of :mode, :vps_protocol, :tx_type, :vendor,
-        :vendor_tx_code, :amount, :currency, :description, :notification_url,
-        :billing_address, :delivery_address
-
-      validates_length_of :vps_protocol,     :is      => 4
-      validates_length_of :vendor,           :maximum => 15
-      validates_length_of :vendor_tx_code,   :maximum => 40
       validates_length_of :currency,         :is      => 3
       validates_length_of :description,      :maximum => 100
       validates_length_of :notification_url, :maximum => 255
       validates_length_of :customer_email,   :maximum => 255
       validates_length_of :basket,           :maximum => 7_500
 
-      validates_inclusion_of :mode,              :allow_blank => true, :in => [ :simulator, :test, :live ]
       validates_inclusion_of :tx_type,           :allow_blank => true, :in => [ :payment, :deferred, :authenticate ]
       validates_inclusion_of :allow_gift_aid,    :allow_blank => true, :in => [ true, false ]
       validates_inclusion_of :apply_avs_cv2,     :allow_blank => true, :in => (0..3).to_a
@@ -35,16 +26,7 @@ module SagePay
       validates_true_for :amount, :key => :amount_minimum_value, :logic => lambda { amount.nil? || amount >= BigDecimal.new("0.01")   }, :message => "is less than the minimum value (0.01)"
       validates_true_for :amount, :key => :amount_maximum_value, :logic => lambda { amount.nil? || amount <= BigDecimal.new("100000") }, :message => "is greater than the maximum value (100,000.00)"
 
-      def initialize(attributes = {})
-        # Effectively hard coded for now
-        @vps_protocol = "2.23"
-
-        attributes.each do |k, v|
-          send("#{k}=", v)
-        end
-      end
-
-      def register!
+      def run!
         if @response.nil? || (@vendor_tx_code_sent != vendor_tx_code)
           @vendor_tx_code_sent = vendor_tx_code
           @response = handle_response(post)
@@ -55,36 +37,24 @@ module SagePay
 
       def signature_verification_details
         if @response.nil?
-          raise RuntimeError, "Transaction not yet registered"
+          raise RuntimeError, "Not yet registered"
         elsif @response.failed?
-          raise RuntimeError, "Transaction registration failed"
+          raise RuntimeError, "Registration failed"
         else
           @signature_verification_details ||= SignatureVerificationDetails.new(vendor, @response.security_key)
         end
       end
 
-      def url
-        case mode
-        when :simulator
-          "https://test.sagepay.com/simulator/VSPServerGateway.asp?Service=VendorRegisterTx"
-        when :test
-          "https://test.sagepay.com/gateway/service/vspserver-register.vsp"
-        when :live
-          "https://live.sagepay.com/gateway/service/vspserver-register.vsp"
-        else
-          raise ArgumentError, "Invalid transaction mode"
-        end
+      def live_service
+        "vspserver-register"
       end
 
-      def post_params
-        raise ArgumentError, "Invalid transaction registration options (see errors hash for details)" unless valid?
+      def simulator_service
+        "VendorRegisterTx"
+      end
 
-        # Mandatory parameters that we've already validated are present
-        params = {
-          "VPSProtocol"        => vps_protocol,
-          "TxType"             => tx_type.to_s.upcase,
-          "Vendor"             => vendor,
-          "VendorTxCode"       => vendor_tx_code,
+      def post_params
+        params = super.merge({
           "Amount"             => ("%.2f" % amount),
           "Currency"           => currency.upcase,
           "Description"        => description,
@@ -101,7 +71,7 @@ module SagePay
           "DeliveryCity"       => delivery_address.city,
           "DeliveryPostCode"   => delivery_address.post_code,
           "DeliveryCountry"    => delivery_address.country,
-        }
+        })
 
         # Optional parameters that are only inserted if they are present
         params['BillingAddress2']  = billing_address.address_2     if present?(billing_address.address_2)
@@ -123,34 +93,15 @@ module SagePay
         params
       end
 
+      def response_from_response_body(response_body)
+        RegistrationResponse.from_response_body(response_body)
+      end
+
       def amount=(value)
         @amount = blank?(value) ? nil : BigDecimal.new(value.to_s)
       end
 
       private
-
-      def post
-        parsed_uri = URI.parse(url)
-        request = Net::HTTP::Post.new(parsed_uri.request_uri)
-        request.form_data = post_params
-
-        http = Net::HTTP.new(parsed_uri.host, parsed_uri.port)
-        http.use_ssl = true if parsed_uri.scheme == "https"
-        http.start { |http|
-          http.request(request)
-        }
-      end
-
-      def handle_response(response)
-        case response.code.to_i
-        when 200
-          TransactionRegistrationResponse.from_response_body(response.body)
-        else
-          # FIXME: custom error response would be nice.
-          raise RuntimeError, "I guess SagePay doesn't like us today."
-        end
-      end
-
       def account_type_param
         case account_type
         when :ecommerce
@@ -163,14 +114,6 @@ module SagePay
           raise ArgumentError, "account type is an invalid value: #{account_type}"
         end
       end
-
-      def present?(value)
-        !blank?(value)
-      end
-
-      def blank?(value)
-        value.nil? || (value.respond_to?(:empty?) && value.empty?)
-      end
     end
   end
 end

data/lib/sage_pay/server/registration_response.rb

@@ -0,0 +1,35 @@
+module SagePay
+  module Server
+    class RegistrationResponse < Response
+      self.key_converter = key_converter.merge({
+        "VPSTxId"      => :vps_tx_id,
+        "SecurityKey"  => :security_key,
+        "NextURL"      => :next_url
+      })
+
+      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/lib/sage_pay/server/release.rb

@@ -0,0 +1,48 @@
+module SagePay
+  module Server
+    class Release < Command
+      attr_accessor :vps_tx_id, :security_key, :tx_auth_no, :release_amount
+
+      validates_presence_of :vps_tx_id, :security_key, :tx_auth_no,
+        :release_amount
+
+      validates_length_of :vps_tx_id,        :is      => 38
+      validates_length_of :security_key,     :is      => 10
+
+      validates_inclusion_of :tx_type, :allow_blank => true, :in => [ :release ]
+
+      validates_true_for :release_amount, :key => :release_amount_minimum_value, :logic => lambda { release_amount.nil? || release_amount >= BigDecimal.new("0.01")   }, :message => "is less than the minimum value (0.01)"
+      validates_true_for :release_amount, :key => :release_amount_maximum_value, :logic => lambda { release_amount.nil? || release_amount <= BigDecimal.new("100000") }, :message => "is greater than the maximum value (100,000.00)"
+
+      def initialize(attributes = {})
+        @tx_type = :release
+        super
+      end
+
+      def post_params
+        super.merge({
+          "VPSTxId" => vps_tx_id,
+          "SecurityKey" => security_key,
+          "TxAuthNo" => tx_auth_no,
+          "ReleaseAmount" => ("%.2f" % amount)
+        })
+      end
+
+      def release_amount=(value)
+        @release_amount = blank?(value) ? nil : BigDecimal.new(value.to_s)
+      end
+
+      def live_service
+        "release"
+      end
+
+      def simulator_service
+        "VendorReleaseTx"
+      end
+
+      def response_from_response_body(response_body)
+        SagePay::Server::ReleaseResponse.from_response_body(response_body)
+      end
+    end
+  end
+end