sage_pay 0.2.9 → 0.2.10

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 0.2.10
+
+* Authorise support, I hope, which, again I hope, will make repeat actually work.
+
 ## 0.2.9
 
 * Repeat transaction implementation.

data/lib/sage_pay.rb

@@ -7,7 +7,7 @@ require 'md5'
 require 'uuid'
 
 module SagePay
-  VERSION = '0.2.9'
+  VERSION = '0.2.10'
 end
 
 require 'validatable-ext'
@@ -29,4 +29,5 @@ require 'sage_pay/server/refund'
 require 'sage_pay/server/refund_response'
 require 'sage_pay/server/repeat'
 require 'sage_pay/server/repeat_response'
+require 'sage_pay/server/authorise'
 require 'sage_pay/server'

data/lib/sage_pay/server.rb

@@ -68,6 +68,14 @@ module SagePay
       SagePay::Server::Refund.new(defaults.merge(attributes))
     end
 
+    def self.authorise(attributes = {})
+      defaults = {
+        :vendor_tx_code => TransactionCode.random,
+      }.merge(default_options)
+
+      SagePay::Server::Authorise.new(defaults.merge(attributes))
+    end
+
     def self.repeat(attributes = {})
       defaults = {
         :vendor_tx_code => TransactionCode.random,

data/lib/sage_pay/server/abort.rb

@@ -1,6 +1,8 @@
 module SagePay
   module Server
     class Abort < Command
+      self.tx_type = :abort
+
       attr_accessor :vps_tx_id, :security_key, :tx_auth_no
 
       validates_presence_of :vps_tx_id, :security_key, :tx_auth_no
@@ -8,13 +10,6 @@ module SagePay
       validates_length_of :vps_tx_id,    :is => 38
       validates_length_of :security_key, :is => 10
 
-      validates_inclusion_of :tx_type, :allow_blank => true, :in => [ :abort ]
-
-      def initialize(attributes = {})
-        @tx_type = :abort
-        super
-      end
-
       def post_params
         super.merge({
           "VPSTxId" => vps_tx_id,

data/lib/sage_pay/server/authorise.rb

@@ -0,0 +1,44 @@
+module SagePay
+  module Server
+    class Authorise < Command
+      self.tx_type = :authorise
+
+      attr_accessor :description, :related_transaction, :apply_avs_cv2
+      decimal_accessor :amount
+
+      validates_presence_of :amount, :description, :related_transaction
+
+      validates_length_of :description, :maximum => 100
+
+      validates_inclusion_of :apply_avs_cv2, :allow_blank => true, :in => (0..3).to_a
+
+      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 post_params
+        params = super.merge({
+          "Amount"      => ("%.2f" % amount),
+          "Description" => description
+        }).merge(related_transaction.post_params)
+
+        params['ApplyAVSCV2'] = apply_avs_cv2.to_s if apply_avs_cv2.present?
+
+        params
+      end
+
+      def response_from_response_body(response_body)
+        # FIXME: Since RepeatResponse is being shared for repeats and
+        # authorisations, it should probably be renamed.
+        RepeatResponse.from_response_body(response_body)
+      end
+
+      def live_service
+        "authorise"
+      end
+
+      def simulator_service
+        "VendorAuthoriseTx"
+      end
+    end
+  end
+end

data/lib/sage_pay/server/command.rb

@@ -3,8 +3,10 @@ module SagePay
     class Command
       include Validatable
 
-      attr_reader :vps_protocol
-      attr_accessor :mode, :tx_type, :vendor, :vendor_tx_code
+      class_inheritable_accessor :tx_type, :vps_protocol
+      self.vps_protocol = "2.23"
+
+      attr_accessor :mode, :vendor, :vendor_tx_code
 
       validates_presence_of :vps_protocol, :mode, :tx_type, :vendor,
         :vendor_tx_code
@@ -15,9 +17,16 @@ module SagePay
 
       validates_inclusion_of :mode, :allow_blank => true, :in => [ :simulator, :test, :live ]
 
-      def initialize(attributes = {})
-        @vps_protocol = "2.23"
+      def self.decimal_accessor(*attrs)
+        attrs.each do |attr|
+          attr_reader attr
+          define_method("#{attr}=") do |value|
+            instance_variable_set("@#{attr}", value.blank? ? nil : BigDecimal.new(value.to_s))
+          end
+        end
+      end
 
+      def initialize(attributes = {})
         attributes.each do |k, v|
           send("#{k}=", v)
         end
@@ -85,14 +94,6 @@ module SagePay
           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/notification_response.rb

@@ -43,20 +43,11 @@ module SagePay
         ]
 
         # Optional parameters that are only inserted if they are present
-        params << ['StatusDetail', status_detail] if present?(status_detail)
+        params << ['StatusDetail', status_detail] if status_detail.present?
 
         # And return the completed hash
         params
       end
-
-      private
-      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/refund.rb

@@ -1,23 +1,20 @@
 module SagePay
   module Server
     class Refund < Command
-      attr_accessor :amount, :currency, :description, :related_transaction
+      self.tx_type = :refund
+
+      attr_accessor :currency, :description, :related_transaction
+      decimal_accessor :amount
 
       validates_presence_of :amount, :currency, :description, :related_transaction
 
       validates_length_of :currency,    :is      => 3
       validates_length_of :description, :maximum => 100
 
-      validates_inclusion_of :tx_type, :allow_blank => true, :in => [ :refund ]
 
       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 = {})
-        @tx_type = :refund
-        super
-      end
-
       def post_params
         super.merge({
           "Amount"      => ("%.2f" % amount),
@@ -26,10 +23,6 @@ module SagePay
         }).merge(related_transaction.post_params)
       end
 
-      def amount=(value)
-        @amount = blank?(value) ? nil : BigDecimal.new(value.to_s)
-      end
-
       def response_from_response_body(response_body)
         RefundResponse.from_response_body(response_body)
       end

data/lib/sage_pay/server/registration.rb

@@ -1,10 +1,11 @@
 module SagePay
   module Server
     class Registration < Command
-      attr_accessor :amount, :currency, :description, :notification_url,
+      attr_accessor :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
+      decimal_accessor :amount
 
       validates_presence_of :amount, :currency, :description,
         :notification_url, :billing_address, :delivery_address
@@ -74,20 +75,20 @@ module SagePay
         })
 
         # Optional parameters that are only inserted if they are present
-        params['BillingAddress2']  = billing_address.address_2     if present?(billing_address.address_2)
-        params['BillingState']     = billing_address.state         if present?(billing_address.state)
-        params['BillingPhone']     = billing_address.phone         if present?(billing_address.phone)
-        params['DeliveryAddress2'] = delivery_address.address_2    if present?(delivery_address.address_2)
-        params['DeliveryState']    = delivery_address.state        if present?(delivery_address.state)
-        params['DeliveryPhone']    = delivery_address.phone        if present?(delivery_address.phone)
-        params['CustomerEmail']    = customer_email                if present?(customer_email)
-        params['Basket']           = basket                        if present?(basket)
-        params['AllowGiftAid']     = allow_gift_aid ? "1" : "0"    if present?(allow_gift_aid)
-        params['ApplyAVSCV2']      = apply_avs_cv2.to_s            if present?(apply_avs_cv2)
-        params['Apply3DSecure']    = apply_3d_secure.to_s          if present?(apply_3d_secure)
-        params['Profile']          = profile.to_s.upcase           if present?(profile)
-        params['BillingAgreement'] = billing_agreement ? "1" : "0" if present?(billing_agreement)
-        params['AccountType']      = account_type_param            if present?(account_type)
+        params['BillingAddress2']  = billing_address.address_2     if billing_address.address_2.present?
+        params['BillingState']     = billing_address.state         if billing_address.state.present?
+        params['BillingPhone']     = billing_address.phone         if billing_address.phone.present?
+        params['DeliveryAddress2'] = delivery_address.address_2    if delivery_address.address_2.present?
+        params['DeliveryState']    = delivery_address.state        if delivery_address.state.present?
+        params['DeliveryPhone']    = delivery_address.phone        if delivery_address.phone.present?
+        params['CustomerEmail']    = customer_email                if customer_email.present?
+        params['Basket']           = basket                        if basket.present?
+        params['AllowGiftAid']     = allow_gift_aid ? "1" : "0"    if allow_gift_aid.present? || allow_gift_aid == false
+        params['ApplyAVSCV2']      = apply_avs_cv2.to_s            if apply_avs_cv2.present?
+        params['Apply3DSecure']    = apply_3d_secure.to_s          if apply_3d_secure.present?
+        params['Profile']          = profile.to_s.upcase           if profile.present?
+        params['BillingAgreement'] = billing_agreement ? "1" : "0" if billing_agreement.present? || billing_agreement == false
+        params['AccountType']      = account_type_param            if account_type.present?
 
         # And return the completed hash
         params
@@ -97,10 +98,6 @@ module SagePay
         RegistrationResponse.from_response_body(response_body)
       end
 
-      def amount=(value)
-        @amount = blank?(value) ? nil : BigDecimal.new(value.to_s)
-      end
-
       private
       def account_type_param
         case account_type

data/lib/sage_pay/server/release.rb

@@ -1,7 +1,10 @@
 module SagePay
   module Server
     class Release < Command
-      attr_accessor :vps_tx_id, :security_key, :tx_auth_no, :release_amount
+      self.tx_type = :release
+
+      attr_accessor :vps_tx_id, :security_key, :tx_auth_no
+      decimal_accessor :release_amount
 
       validates_presence_of :vps_tx_id, :security_key, :tx_auth_no,
         :release_amount
@@ -9,16 +12,10 @@ module SagePay
       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,
@@ -28,10 +25,6 @@ module SagePay
         })
       end
 
-      def release_amount=(value)
-        @release_amount = blank?(value) ? nil : BigDecimal.new(value.to_s)
-      end
-
       def live_service
         "release"
       end

data/lib/sage_pay/server/repeat.rb

@@ -1,23 +1,19 @@
 module SagePay
   module Server
     class Repeat < Command
-      attr_accessor :amount, :currency, :description, :related_transaction, :cv2
+      self.tx_type = :repeat
+
+      attr_accessor :currency, :description, :related_transaction, :cv2
+      decimal_accessor :amount
 
       validates_presence_of :amount, :currency, :description, :related_transaction
 
       validates_length_of :currency,    :is      => 3
       validates_length_of :description, :maximum => 100
 
-      validates_inclusion_of :tx_type, :allow_blank => true, :in => [ :repeat ]
-
       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 = {})
-        @tx_type = :repeat
-        super
-      end
-
       def post_params
         params = super.merge({
           "Amount"      => ("%.2f" % amount),
@@ -30,10 +26,6 @@ module SagePay
         params
       end
 
-      def amount=(value)
-        @amount = blank?(value) ? nil : BigDecimal.new(value.to_s)
-      end
-
       def response_from_response_body(response_body)
         RepeatResponse.from_response_body(response_body)
       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.9'
+  s.version           = '0.2.10'
   s.date              = '2010-04-25'
   s.rubyforge_project = 'sage_pay'
 
@@ -58,6 +58,7 @@ gateway for accepting credit card payments through your web app.
     lib/sage_pay/server.rb
     lib/sage_pay/server/abort.rb
     lib/sage_pay/server/address.rb
+    lib/sage_pay/server/authorise.rb
     lib/sage_pay/server/command.rb
     lib/sage_pay/server/notification.rb
     lib/sage_pay/server/notification_response.rb

data/spec/sage_pay_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 
 describe SagePay do
-  it "should be version 0.2.9" do
-    SagePay::VERSION.should == '0.2.9'
+  it "should be version 0.2.10" do
+    SagePay::VERSION.should == '0.2.10'
   end
 end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 2
-  - 9
-  version: 0.2.9
+  - 10
+  version: 0.2.10
 platform: ruby
 authors: 
 - Graeme Mathieson
@@ -79,6 +79,7 @@ files:
 - lib/sage_pay/server.rb
 - lib/sage_pay/server/abort.rb
 - lib/sage_pay/server/address.rb
+- lib/sage_pay/server/authorise.rb
 - lib/sage_pay/server/command.rb
 - lib/sage_pay/server/notification.rb
 - lib/sage_pay/server/notification_response.rb