sage_pay 0.1.0 → 0.2.0

data/Rakefile

@@ -1,5 +1,6 @@
 require 'rubygems'
 require 'rake'
+require 'spec/rake/spectask'
 require 'date'
 
 #############################################################################
@@ -43,21 +44,13 @@ end
 #
 #############################################################################
 
-task :default => :test
+task :default => :spec
 
-require 'rake/testtask'
-Rake::TestTask.new(:test) do |test|
-  test.libs << 'lib' << 'test'
-  test.pattern = 'test/**/test_*.rb'
-  test.verbose = true
-end
+Spec::Rake::SpecTask.new
 
-desc "Generate RCov test coverage and open in your browser"
-task :coverage do
-  require 'rcov'
-  sh "rm -fr coverage"
-  sh "rcov test/test_*.rb"
-  sh "open coverage/index.html"
+Spec::Rake::SpecTask.new(:coverage) do |coverage|
+  coverage.rcov = true
+  coverage.rcov_opts << '--exclude' << '\.rvm,spec'
 end
 
 require 'rake/rdoctask'
@@ -70,7 +63,7 @@ end
 
 desc "Open an irb session preloaded with this library"
 task :console do
-  sh "irb -rubygems -r ./lib/#{name}.rb"
+  sh "irb -rubygems -Ilib -r ./lib/#{name}.rb -r spec/support/factories.rb"
 end
 
 #############################################################################
@@ -87,6 +80,7 @@ end
 #
 #############################################################################
 
+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!"
@@ -99,13 +93,14 @@ task :release => :build do
   sh "gem push pkg/#{name}-#{version}.gem"
 end
 
+desc "Build the gem"
 task :build => :gemspec do
   sh "mkdir -p pkg"
   sh "gem build #{gemspec_file}"
   sh "mv #{gem_file} pkg"
 end
 
-task :gemspec => :validate do
+task :gemspec do
   # read spec file and split out manifest section
   spec = File.read(gemspec_file)
   head, manifest, tail = spec.split("  # = MANIFEST =\n")
@@ -132,15 +127,3 @@ task :gemspec => :validate do
   File.open(gemspec_file, 'w') { |io| io.write(spec) }
   puts "Updated #{gemspec_file}"
 end
-
-task :validate do
-  libfiles = Dir['lib/*'] - ["lib/#{name}.rb", "lib/#{name}"]
-  unless libfiles.empty?
-    puts "Directory `lib` should only contain a `#{name}.rb` file and `#{name}` dir."
-    exit!
-  end
-  unless Dir['VERSION*'].empty?
-    puts "A `VERSION` file at root level violates Gem best practices."
-    exit!
-  end
-end

data/lib/sage_pay/server/address.rb

@@ -0,0 +1,45 @@
+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"]
+
+      attr_accessor :first_names, :surname, :address_1, :address_2, :city,
+        :post_code, :country, :state, :phone
+
+      validates_presence_of :first_names, :surname, :address_1, :city, :post_code, :country
+
+      # 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_length_of :first_names, :surname, :maximum => 20
+      validates_length_of :address_1, :address_2, :maximum => 100
+      validates_length_of :city, :maximum => 40
+      validates_length_of :post_code, :maximum => 10
+      validates_length_of :phone, :maximum => 20
+
+      # While the spec specifies the lengths of these columns, we're
+      # validating that they're included in our list, and our list only
+      # 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"
+
+      def initialize(attributes = {})
+        attributes.each do |k, v|
+          send("#{k}=", v)
+        end
+      end
+    end
+  end
+end

data/lib/sage_pay/server/signature_verification_details.rb

@@ -0,0 +1,14 @@
+module SagePay
+  module Server
+    class SignatureVerificationDetails
+      attr_reader :vps_tx_id, :vendor_tx_code, :vendor, :security_key
+
+      def initialize(transaction_registration, transaction_registration_response)
+        @vendor_tx_code = transaction_registration.vendor_tx_code
+        @vendor         = transaction_registration.vendor
+        @vps_tx_id      = transaction_registration_response.vps_tx_id
+        @security_key   = transaction_registration_response.security_key
+      end
+    end
+  end
+end

data/lib/sage_pay/server/transaction_code.rb

@@ -0,0 +1,18 @@
+module SagePay
+  module Server
+    class TransactionCode
+      def self.random
+        new.random
+      end
+
+      def random
+        uuid.generate
+      end
+
+      protected
+      def uuid
+        @uuid ||= UUID.new
+      end
+    end
+  end
+end

data/lib/sage_pay/server/transaction_notification.rb

@@ -0,0 +1,169 @@
+module SagePay
+  module Server
+    class TransactionNotification
+      attr_reader :vps_protocol, :status, :status_detail, :tx_auth_no,
+        :avs_cv2, :address_result, :post_code_result, :cv2_result, :gift_aid,
+        :threed_secure_status, :cavv, :address_status, :payer_status,
+        :card_type, :last_4_digits, :vps_signature
+
+      def self.from_params(params, signature_verification_details = nil)
+        key_converter = {
+          "VPSProtocol"    => :vps_protocol,
+          "Status"         => :status,
+          "StatusDetail"   => :status_detail,
+          "TxAuthNo"       => :tx_auth_no,
+          "AVSCV2"         => :avs_cv2,
+          "AddressResult"  => :address_result,
+          "PostCodeResult" => :post_code_result,
+          "CV2Result"      => :cv2_result,
+          "GiftAid"        => :gift_aid,
+          "3DSecureStatus" => :threed_secure_status,
+          "CAVV"           => :cavv,
+          "AddressStatus"  => :address_status,
+          "PayerStatus"    => :payer_status,
+          "CardType"       => :card_type,
+          "Last4Digits"    => :last_4_digits,
+          "VPSSignature"   => :vps_signature
+        }
+
+        match_converter = {
+          "NOTPROVIDED" => :not_provided,
+          "NOTCHECKED"  => :not_checked,
+          "MATCHED"     => :matched,
+          "NOTMATCHED"  => :not_matched
+        }
+
+        true_false_converter = {
+          "0" => false,
+          "1" => true
+        }
+
+        value_converter = {
+          :status => {
+            "OK"            => :ok,
+            "NOTAUTHED"     => :not_authed,
+            "ABORT"         => :abort,
+            "REJECTED"      => :rejected,
+            "AUTHENTICATED" => :authenticated,
+            "REGISTERED"    => :registered,
+            "ERROR"         => :error
+          },
+          :avs_cv2 => {
+            "ALL MATCH"                => :all_match,
+            "SECURITY CODE MATCH ONLY" => :security_code_match_only,
+            "ADDRESS MATCH ONLY"       => :address_match_only,
+            "NO DATA MATCHES"          => :no_data_matches,
+            "DATA NOT CHECKED"         => :data_not_checked
+          },
+          :address_result   => match_converter,
+          :post_code_result => match_converter,
+          :cv2_result       => match_converter,
+          :gift_aid         => true_false_converter,
+          :threed_secure_status => {
+            "OK"           => :ok,
+            "NOTCHECKED"   => :not_checked,
+            "NOTAVAILABLE" => :not_available,
+            "NOTAUTHED"    => :not_authed,
+            "INCOMPLETE"   => :incomplete,
+            "ERROR"        => :error
+          },
+          :address_status => {
+            "NONE"        => :none,
+            "CONFIRMED"   => :confirmed,
+            "UNCONFIRMED" => :unconfirmed
+          },
+          :payer_status => {
+            "VERIFIED"   => :verified,
+            "UNVERIFIED" => :unverified
+          },
+          :card_type => {
+            "VISA"    => :visa,
+            "MC"      => :mastercard,
+            "DELTA"   => :visa_delta,
+            "SOLO"    => :solo,
+            "MAESTRO" => :maestro,
+            "UKE"     => :visa_electron,
+            "AMEX"    => :american_express,
+            "DC"      => :diners,
+            "JCB"     => :jcb,
+            "LASER"   => :laser,
+            "PAYPAL"  => :paypal
+          }
+        }
+
+        attributes = {}
+        params.each do |key, value|
+          unless value.nil?
+            converted_key = key_converter[key]
+            converted_value = value_converter[converted_key].nil? ? value : value_converter[converted_key][value]
+
+            attributes[converted_key] = converted_value
+          end
+        end
+
+        unless signature_verification_details.nil?
+          # We need to calculate the VPS signature from the values passed in as
+          # additional params from the original registration and notification.
+          fields_used_in_signature = [
+            signature_verification_details.vps_tx_id,
+            signature_verification_details.vendor_tx_code,
+            params["Status"],
+            params["TxAuthNo"],
+            signature_verification_details.vendor,
+            params["AVSCV2"],
+            signature_verification_details.security_key,
+            params["AddressResult"],
+            params["PostCodeResult"],
+            params["CV2Result"],
+            params["GiftAid"],
+            params["3DSecureStatus"],
+            params["CAVV"],
+            params["AddressStatus"],
+            params["PayerStatus"],
+            params["CardType"],
+            params["Last4Digits"]
+          ]
+          attributes[:calculated_hash] = MD5.md5(fields_used_in_signature.join).to_s.upcase
+        end
+
+        new(attributes)
+      end
+
+      def initialize(attributes = {})
+        attributes.each do |k, v|
+          # We're only providing readers, not writers, so we have to directly
+          # set the instance variable.
+          instance_variable_set("@#{k}", v)
+        end
+      end
+
+      def ok?
+        status == :ok
+      end
+
+      def avs_cv2_matched?
+        avs_cv2 == :all_match
+      end
+
+      def address_matched?
+        address_result == :matched
+      end
+
+      def post_code_matched?
+        post_code_result == :matched
+      end
+
+      def cv2_matched?
+        cv2_result == :matched
+      end
+
+      def threed_secure_status_ok?
+        threed_secure_status == :ok
+      end
+
+      def valid_signature?
+        @calculated_hash == vps_signature
+      end
+    end
+  end
+end

data/lib/sage_pay/server/transaction_notification_response.rb

@@ -0,0 +1,62 @@
+module SagePay
+  module Server
+    class TransactionNotificationResponse
+      include Validatable
+
+      attr_accessor :status, :status_detail, :redirect_url
+
+      validates_presence_of :status, :redirect_url
+      validates_presence_of :status_detail,        :if => lambda { |response| !response.ok? }
+
+      validates_length_of :redirect_url,  :maximum => 255
+      validates_length_of :status_detail, :maximum => 255
+
+      validates_inclusion_of :status, :allow_blank => true, :in => [ :ok, :invalid, :error ]
+
+      def initialize(attributes = {})
+        attributes.each do |k, v|
+          send("#{k}=", v)
+        end
+      end
+
+      def ok?
+        status == :ok
+      end
+
+      def response
+        response_params.map do |tuple|
+          key, value = tuple
+          "#{key}=#{value}"
+        end.join("\n")
+      end
+
+
+      def response_params
+        raise ArgumentError, "Invalid transaction registration options (see errors hash for details)" unless valid?
+
+        # Mandatory parameters that we've already validated are present. Note
+        # that the order of parameters is important (Status must be first!) so
+        # we're using a list of lists this time around...
+        params = [
+          ["Status",      status.to_s.upcase],
+          ["RedirectURL", redirect_url]
+        ]
+
+        # Optional parameters that are only inserted if they are present
+        params << ['StatusDetail', status_detail] if present?(status_detail)
+
+        # 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/transaction_registration.rb

@@ -0,0 +1,176 @@
+module SagePay
+  module Server
+    class TransactionRegistration
+      include Validatable
+
+      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 :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
+      validates_inclusion_of :apply_3d_secure,   :allow_blank => true, :in => (0..3).to_a
+      validates_inclusion_of :profile,           :allow_blank => true, :in => [:normal, :low]
+      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)"
+
+      def initialize(attributes = {})
+        # Effectively hard coded for now
+        @vps_protocol = "2.23"
+
+        attributes.each do |k, v|
+          send("#{k}=", v)
+        end
+      end
+
+      def register!
+        if @response.nil? || (@vendor_tx_code_sent != vendor_tx_code)
+          @vendor_tx_code_sent = vendor_tx_code
+          @response = handle_response(post)
+        else
+          raise RuntimeError, "This vendor transaction code has already been registered"
+        end
+      end
+
+      def signature_verification_details
+        if @response.nil?
+          raise RuntimeError, "Transaction not yet registered"
+        elsif @response.failed?
+          raise RuntimeError, "Transaction registration failed"
+        else
+          SignatureVerificationDetails.new(self, @response)
+        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
+      end
+
+      def post_params
+        raise ArgumentError, "Invalid transaction registration options (see errors hash for details)" unless valid?
+
+        # 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,
+          "Amount"             => ("%.2f" % amount),
+          "Currency"           => currency.upcase,
+          "Description"        => description,
+          "NotificationURL"    => notification_url,
+          "BillingSurname"     => billing_address.surname,
+          "BillingFirstnames"  => billing_address.first_names,
+          "BillingAddress1"    => billing_address.address_1,
+          "BillingCity"        => billing_address.city,
+          "BillingPostCode"    => billing_address.post_code,
+          "BillingCountry"     => billing_address.country,
+          "DeliverySurname"    => delivery_address.surname,
+          "DeliveryFirstnames" => delivery_address.first_names,
+          "DeliveryAddress1"   => delivery_address.address_1,
+          "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)
+        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)
+
+        # And return the completed hash
+        params
+      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
+          'E'
+        when :continuous_authority
+          'C'
+        when :mail_order
+          'M'
+        else
+          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/transaction_registration_response.rb

@@ -0,0 +1,94 @@
+module SagePay
+  module Server
+    class TransactionRegistrationResponse
+      attr_reader :vps_protocol, :status, :status_detail
+
+      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
+        }
+
+        value_converter = {
+          :status => {
+            "OK"        => :ok,
+            "MALFORMED" => :malformed,
+            "INVALID"   => :invalid,
+            "ERROR"     => :error
+          }
+        }
+
+        attributes = {}
+        response_body.each_line do |line|
+          key, value = line.split('=', 2)
+          unless key.nil? || value.nil?
+            value = value.chomp
+
+            converted_key = key_converter[key]
+            converted_value = value_converter[converted_key].nil? ? value : value_converter[converted_key][value]
+
+            attributes[converted_key] = converted_value
+          end
+        end
+
+        new(attributes)
+      end
+
+      def initialize(attributes = {})
+        attributes.each do |k, v|
+          # We're only providing readers, not writers, so we have to directly
+          # set the instance variable.
+          instance_variable_set("@#{k}", v)
+        end
+      end
+
+      def ok?
+        status == :ok
+      end
+
+      def failed?
+        !ok?
+      end
+
+      def invalid?
+        status == :invalid
+      end
+
+      def malformed?
+        status == :malformed
+      end
+
+      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