sage_pay 0.2.13 → 1.0.0

data/.rbenv-version

@@ -0,0 +1 @@
+1.9.3-p194

data/.rspec

@@ -0,0 +1 @@
+--color --format n

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 # Changelog
 
+## 1.0.0
+
+* Ruby 1.9 compatibility. Note that Ruby 1.8.x is no longer supported due to
+  the different way in which `URI` needs to be patched to support `{` and `}`
+  in the URLs. Thanks to @jairodiaz, @moomerman and @gato-omega for
+  contributing!
+
+* The validation regular expressions have been pulled out into a module so that
+  you can also use them in your higher level models. Thanks, @lenary!
+
 ## 0.2.13
 
 * If the country for an address is the US, then the US state is required.

data/Gemfile

@@ -1,11 +1,6 @@
 # Source gems from the default public repository
 source :rubygems
 
-gem 'activesupport', '>= 2.3.8'
-gem 'validatable',   '>= 1.6.7'
-gem 'uuid',          '>= 2.3.1'
+gem 'simplecov'
 
-group :development do
-  gem 'rake'
-  gem 'rspec'
-end
+gemspec

data/README.md

@@ -1,7 +1,9 @@
-SagePay
-=======
+# SagePay
 
-# Description
+[![Build Status](https://secure.travis-ci.org/mathie/sage_pay.png?branch=master)](http://travis-ci.org/mathie/sage_pay)
+[![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/mathie/sage_pay)
+
+## Description
 
 This is a Ruby library for integrating with SagePay. SagePay is a payment
 gateway for accepting credit card payments through your web app. It offers
@@ -23,17 +25,34 @@ The current client app I'm writing is using SagePay Server, so that's where
 the current implementation will be focused. Direct will follow when I (or
 somebody else) has the impetus to do so.
 
-# Installation
+## Installation
 
-You should be able to install the gem directly from Gemcutter, the newly
-default Rubygems repository. Simply do:
+You should be able to install the gem directly from Rubygems. Simply do:
 
     (sudo) gem install sage_pay
 
-and you're good to go.
+and you're good to go. If you're adding it as a dependency to an existing
+project and you're using bundler, simply add:
+
+    gem 'sage_pay'
 
-# Assumptions
+to your `Gemfile` and you're also good to go.
+
+## Assumptions
 
 This gem currently implements SagePay protocol version 2.23. The client app
 I'm writing is in Rails, so there are probably some assumptions around that,
 too.
+
+## Test Configuration
+
+For running the integration tests, you'll need a valid SagePay account on the
+simulator. If you want to run the integration tests, pass in your vendor name
+with the environment variable `VENDOR_NAME`. If you don't supply a vendor name,
+the integration tests will be skipped. For example:
+
+    VENDOR_NAME=rubaidh bundle exec rake spec
+
+Please note that you need to include your current IP address in the Sage Pay
+Simulator portal.  The Simulator only accepts calls from white listed IP
+addresses.

data/Rakefile

@@ -1,129 +1,20 @@
 require 'rubygems'
 require 'rake'
-require 'spec/rake/spectask'
-require 'date'
-
-#############################################################################
-#
-# Helper functions
-#
-#############################################################################
-
-def name
-  @name ||= Dir['*.gemspec'].first.split('.').first
-end
-
-def version
-  line = File.read("lib/#{name}.rb")[/^\s*VERSION\s*=\s*.*/]
-  line.match(/.*VERSION\s*=\s*['"](.*)['"]/)[1]
-end
-
-def date
-  Date.today.to_s
-end
-
-def rubyforge_project
-  name
-end
-
-def gemspec_file
-  "#{name}.gemspec"
-end
-
-def gem_file
-  "#{name}-#{version}.gem"
-end
-
-def replace_header(head, header_name)
-  head.sub!(/(\.#{header_name}\s*= ').*'/) { "#{$1}#{send(header_name)}'"}
-end
-
-#############################################################################
-#
-# Standard tasks
-#
-#############################################################################
+require 'rdoc/task'
+require 'rspec/core/rake_task'
+require 'bundler/gem_tasks'
 
 task :default => :spec
 
-Spec::Rake::SpecTask.new
+RSpec::Core::RakeTask.new
 
-Spec::Rake::SpecTask.new(:coverage) do |coverage|
-  coverage.rcov = true
-  coverage.rcov_opts << '--exclude' << '\.rvm,spec'
-end
-
-require 'rake/rdoctask'
 Rake::RDocTask.new do |rdoc|
   rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "#{name} #{version}"
   rdoc.rdoc_files.include('README*')
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
 
 desc "Open an irb session preloaded with this library"
 task :console do
-  sh "irb -rubygems -Ilib -r ./lib/#{name}.rb -r spec/support/factories.rb"
-end
-
-#############################################################################
-#
-# Custom tasks (add your own tasks here)
-#
-#############################################################################
-
-
-
-#############################################################################
-#
-# Packaging tasks
-#
-#############################################################################
-
-desc "Release the new version of the gem into the wild"
-task :release => :build do
-  unless `git branch` =~ /^\* master$/
-    puts "You must be on the master branch to release!"
-    exit!
-  end
-  sh "git commit --allow-empty -a -m 'Release #{version}'"
-  sh "git tag v#{version}"
-  sh "git push origin master"
-  sh "git push origin v#{version}"
-  sh "gem push pkg/#{name}-#{version}.gem"
-end
-
-desc "Build the gem"
-task :build => [:spec, :gemspec] do
-  sh "mkdir -p pkg"
-  sh "gem build #{gemspec_file}"
-  sh "mv #{gem_file} pkg"
-end
-
-task :gemspec do
-  # read spec file and split out manifest section
-  spec = File.read(gemspec_file)
-  head, manifest, tail = spec.split("  # = MANIFEST =\n")
-
-  # replace name version and date
-  replace_header(head, :name)
-  replace_header(head, :version)
-  replace_header(head, :date)
-  #comment this out if your rubyforge_project has a different name
-  replace_header(head, :rubyforge_project)
-
-  # determine file list from git ls-files
-  files = `git ls-files`.
-    split("\n").
-    sort.
-    reject { |file| file =~ /^\./ }.
-    reject { |file| file =~ /^(rdoc|pkg)/ }.
-    map { |file| "    #{file}" }.
-    join("\n")
-
-  # piece file back together and write
-  manifest = "  s.files = %w[\n#{files}\n  ]\n"
-  spec = [head, manifest, tail].join("  # = MANIFEST =\n")
-  File.open(gemspec_file, 'w') { |io| io.write(spec) }
-  puts "Updated #{gemspec_file}"
+  ruby "-S irb -rubygems -Ilib -r ./lib/sage_pay.rb -r ./spec/support/factories.rb"
 end

data/config/locales/en.yml

@@ -0,0 +1,8 @@
+en:
+  errors:
+    messages:
+      blank: "can't be empty"
+      inclusion: 'is not in the list'
+      invalid: 'is invalid'
+      too_long: 'is invalid'
+      wrong_length: 'is invalid'

data/lib/sage_pay.rb

@@ -1,18 +1,22 @@
-require 'active_support'
-require 'validatable'
+require 'active_support/core_ext/class'
 require 'bigdecimal'
 require 'net/https'
 require 'uri'
-require 'md5'
+require 'digest/md5'
 require 'uuid'
 
+require 'active_model/naming'
+require 'active_model/validator'
+require 'active_model/validations'
+require 'active_model/translation'
+
 module SagePay
-  VERSION = '0.2.13'
 end
 
-require 'validatable-ext'
-
+require 'sage_pay/version'
 require 'sage_pay/uri_fixups'
+require 'sage_pay/locale_initializer'
+require 'sage_pay/validators'
 require 'sage_pay/server/address'
 require 'sage_pay/server/transaction_code'
 require 'sage_pay/server/signature_verification_details'

data/lib/sage_pay/locale_initializer.rb

@@ -0,0 +1,3 @@
+# Loads the i18n translations file for validation errors
+translation_dir = [File.expand_path("../../../config/locales/en.yml", __FILE__)]
+I18n.load_path += translation_dir

data/lib/sage_pay/server/address.rb

@@ -1,13 +1,8 @@
 module SagePay
   module Server
     class Address
-      include Validatable
-
-      class << self
-        attr_accessor :us_states, :iso_3166_country_codes
-      end
-      self.us_states = ["AK", "AL", "AR", "AS", "AZ", "CA", "CO", "CT", "DC", "DE", "FL", "FM", "GA", "GU", "HI", "IA", "ID", "IL", "IN", "KS", "KY", "LA", "MA", "MD", "ME", "MH", "MI", "MN", "MO", "MS", "MT", "NC", "ND", "NE", "NH", "NJ", "NM", "NV", "NY", "OH", "OK", "OR", "PA", "PR", "PW", "RI", "SC", "SD", "TN", "TX", "UT", "VA", "VI", "VT", "WA", "WI", "WV", "WY"]
-      self.iso_3166_country_codes = ["AF", "AX", "AL", "DZ", "AS", "AD", "AO", "AI", "AQ", "AG", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BY", "BE", "BZ", "BJ", "BM", "BT", "BO", "BA", "BW", "BV", "BR", "IO", "BN", "BG", "BF", "BI", "KH", "CM", "CA", "CV", "KY", "CF", "TD", "CL", "CN", "CX", "CC", "CO", "KM", "CG", "CD", "CK", "CR", "CI", "HR", "CU", "CY", "CZ", "DK", "DJ", "DM", "DO", "EC", "EG", "SV", "GQ", "ER", "EE", "ET", "FK", "FO", "FJ", "FI", "FR", "GF", "PF", "TF", "GA", "GM", "GE", "DE", "GH", "GI", "GR", "GL", "GD", "GP", "GU", "GT", "GG", "GN", "GW", "GY", "HT", "HM", "VA", "HN", "HK", "HU", "IS", "IN", "ID", "IR", "IQ", "IE", "IM", "IL", "IT", "JM", "JP", "JE", "JO", "KZ", "KE", "KI", "KP", "KR", "KW", "KG", "LA", "LV", "LB", "LS", "LR", "LY", "LI", "LT", "LU", "MO", "MK", "MG", "MW", "MY", "MV", "ML", "MT", "MH", "MQ", "MR", "MU", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MA", "MZ", "MM", "NA", "NR", "NP", "NL", "AN", "NC", "NZ", "NI", "NE", "NG", "NU", "NF", "MP", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PH", "PN", "PL", "PT", "PR", "QA", "RE", "RO", "RU", "RW", "BL", "SH", "KN", "LC", "MF", "PM", "VC", "WS", "SM", "ST", "SA", "SN", "RS", "SC", "SL", "SG", "SK", "SI", "SB", "SO", "ZA", "GS", "ES", "LK", "SD", "SR", "SJ", "SZ", "SE", "CH", "SY", "TW", "TJ", "TZ", "TH", "TL", "TG", "TK", "TO", "TT", "TN", "TR", "TM", "TC", "TV", "UG", "UA", "AE", "GB", "US", "UM", "UY", "UZ", "VU", "VE", "VN", "VG", "VI", "WF", "EH", "YE", "ZM", "ZW"]
+      include ActiveModel::Validations
+      include SagePay::Validators
 
       attr_accessor :first_names, :surname, :address_1, :address_2, :city,
         :post_code, :country, :state, :phone
@@ -16,10 +11,10 @@ module SagePay
 
       # FIXME: This regexp isn't correctly matching accented characters. I
       # think it's a Ruby version issue so I'm punting for the moment.
-      validates_format_of :first_names, :surname, :with => /^[[:alpha:] \\\/&'\.\-]*$/
-      validates_format_of :address_1, :address_2, :city, :with => /^[[:alnum:][:space:]\+\\\/&'\.:,\(\)\-]*$/
-      validates_format_of :post_code, :with => /^[[:alnum:] -]*$/
-      validates_format_of :phone, :with => /^[[:alnum:] \+\(\)-]*$/
+      validates_format_of :first_names, :surname, :with => NAME_FORMAT
+      validates_format_of :address_1, :address_2, :city, :with => ADDRESS_FORMAT
+      validates_format_of :post_code, :with => POST_CODE_FORMAT
+      validates_format_of :phone, :with => PHONE_FORMAT
 
       validates_length_of :first_names, :surname, :maximum => 20
       validates_length_of :address_1, :address_2, :maximum => 100
@@ -32,13 +27,14 @@ module SagePay
       # contains two-character strings, so this validation has no real win.
       # validates_length_of :country, :state, :maximum => 2
 
-      validates_inclusion_of :state,   :in => us_states,              :allow_blank => true, :message => "is not a US state"
-      validates_inclusion_of :country, :in => iso_3166_country_codes, :allow_blank => true, :message => "is not an ISO3166-1 country code"
+      validates_inclusion_of :state,   :in => US_STATE_OPTIONS, :allow_blank => true, :message => "is not a US state"
+      validates_inclusion_of :country, :in => COUNTRY_OPTIONS, :allow_blank => true, :message => "is not an ISO3166-1 country code"
 
       # The state's presence is required if the country is the US, and
       # verboten otherwise.
-      validates_true_for :state, :key => :state_required_in_us, :logic => lambda { in_us? ? state.present? : true }, :message => "is required if the country is US"
-      validates_true_for :state, :key => :verboten_outside_us,  :logic => lambda { in_us? ? true : !state.present? }, :message => "is present but the country is not US"
+
+      validates :state, :presence => {:message => "is required if the country is US"}, :if => :in_us?
+      validates_inclusion_of :state, :in => ['', nil], :message => "is present but the country is not US", :unless => :in_us?
 
       def initialize(attributes = {})
         attributes.each do |k, v|

data/lib/sage_pay/server/authorise.rb

@@ -12,8 +12,8 @@ module SagePay
 
       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)"
+      validates :amount, :numericality => {:message => "is less than the minimum value (0.01)", :greater_than_or_equal_to => BigDecimal.new("0.01")}
+      validates :amount, :numericality => {:message => "is greater than the maximum value (100,000.00)", :less_than_or_equal_toi => BigDecimal.new("100000")}
 
       def post_params
         params = super.merge({

data/lib/sage_pay/server/command.rb

@@ -1,9 +1,10 @@
 module SagePay
   module Server
     class Command
-      include Validatable
+      include ActiveModel::Validations
+
+      class_attribute :tx_type, :vps_protocol
 
-      class_inheritable_accessor :tx_type, :vps_protocol
       self.vps_protocol = "2.23"
 
       attr_accessor :mode, :vendor, :vendor_tx_code
@@ -15,7 +16,7 @@ module SagePay
       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 ]
+      validates_inclusion_of :mode, :allow_blank => true, :in => [ :showpost, :simulator, :test, :live ]
 
       def self.decimal_accessor(*attrs)
         attrs.each do |attr|
@@ -46,6 +47,8 @@ module SagePay
 
       def url
         case mode
+        when :showpost
+          "https://test.sagepay.com/showpost/showpost.asp?Service=#{simulator_service}"
         when :simulator
           "https://test.sagepay.com/simulator/VSPServerGateway.asp?Service=#{simulator_service}"
         when :test
@@ -91,7 +94,7 @@ module SagePay
           response_from_response_body(response.body)
         else
           # FIXME: custom error response would be nice.
-          raise RuntimeError, "I guess SagePay doesn't like us today."
+          raise RuntimeError, "I guess SagePay doesn't like us today: #{response.inspect}"
         end
       end
     end

data/lib/sage_pay/server/notification.rb

@@ -136,7 +136,7 @@ module SagePay
             params["CardType"],
             params["Last4Digits"]
           ]
-          attributes[:calculated_hash] = MD5.md5(fields_used_in_signature.join).to_s.upcase
+          attributes[:calculated_hash] = Digest::MD5.hexdigest(fields_used_in_signature.join).upcase
         end
 
         new(attributes)

data/lib/sage_pay/server/notification_response.rb

@@ -1,7 +1,7 @@
 module SagePay
   module Server
     class NotificationResponse
-      include Validatable
+      include ActiveModel::Validations
 
       attr_accessor :status, :status_detail, :redirect_url
 

data/lib/sage_pay/server/refund.rb

@@ -11,9 +11,8 @@ module SagePay
       validates_length_of :currency,    :is      => 3
       validates_length_of :description, :maximum => 100
 
-
-      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)"
+      validates :amount, :numericality => {:message => "is less than the minimum value (0.01)", :greater_than_or_equal_to => BigDecimal.new("0.01")}
+      validates :amount, :numericality => {:message => "is greater than the maximum value (100,000.00)", :less_than_or_equal_to => BigDecimal.new("100000")}
 
       def post_params
         super.merge({

data/lib/sage_pay/server/registration.rb

@@ -24,8 +24,8 @@ module SagePay
       validates_inclusion_of :billing_agreement, :allow_blank => true, :in => [true, false]
       validates_inclusion_of :account_type,      :allow_blank => true, :in => [:ecommerce, :continuous_authority, :mail_order]
 
-      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)"
+      validates :amount, :numericality => {:message => "is less than the minimum value (0.01)", :greater_than_or_equal_to => BigDecimal.new("0.01")}
+      validates :amount, :numericality => {:message => "is greater than the maximum value (100,000.00)", :less_than_or_equal_to => BigDecimal.new("100000")}
 
       def run!
         if @response.nil? || (@vendor_tx_code_sent != vendor_tx_code)

data/lib/sage_pay/server/related_transaction.rb

@@ -1,7 +1,7 @@
 module SagePay
   module Server
     class RelatedTransaction
-      include Validatable
+      include ActiveModel::Validations
 
       attr_accessor :vps_tx_id, :vendor_tx_code, :security_key, :tx_auth_no
 

data/lib/sage_pay/server/release.rb

@@ -12,9 +12,8 @@ module SagePay
       validates_length_of :vps_tx_id,        :is      => 38
       validates_length_of :security_key,     :is      => 10
 
-
-      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)"
+      validates :amount, :numericality => {:message => "is less than the minimum value (0.01)", :greater_than_or_equal_to => BigDecimal.new("0.01")}
+      validates :amount, :numericality => {:message => "is greater than the maximum value (100,000.00)", :less_than_or_equal_to => BigDecimal.new("100000")}
 
       def post_params
         super.merge({

data/lib/sage_pay/server/repeat.rb

@@ -11,8 +11,8 @@ module SagePay
       validates_length_of :currency,    :is      => 3
       validates_length_of :description, :maximum => 100
 
-      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)"
+      validates :amount, :numericality => {:message => "is less than the minimum value (0.01)", :greater_than_or_equal_to => BigDecimal.new("0.01")}
+      validates :amount, :numericality => {:message => "is greater than the maximum value (100,000.00)", :less_than_or_equal_toi => BigDecimal.new("100000")}
 
       def post_params
         params = super.merge({