sepafm 0.1.5 → 1.0.0

data/lib/sepa/banks/danske/soap_danske.rb

@@ -1,8 +1,15 @@
 module Sepa
+  
+  # Contains Danske Bank specific soap building functionality
   module DanskeSoapRequest
 
     private
 
+      # Determines which kind of request to build depending on command. Certificate requests differ
+      # from generic requests.
+      #
+      # @return [Nokogiri::XML] the built soap as a nokogiri document
+      # @todo remove `:get_user_info` since Danske Bank doesn't support it
       def find_correct_build
         case @command
         when :create_certificate
@@ -14,6 +21,12 @@ module Sepa
         end
       end
 
+      # Encrypts the application request with the public key of the bank encryption certificate got
+      # from the parameters. The actual encryption is done by {#encrypt_ar} and {#encrypt_key}
+      # methods. After the encryption, the encrypted application request xml is built by
+      # {#build_encrypted_ar} method
+      #
+      # @return [Nokogiri::XML] the encrypted application request as a nokogiri document
       def encrypt_application_request
         encryption_certificate = x509_certificate(@bank_encryption_certificate)
         encryption_public_key = encryption_certificate.public_key
@@ -24,14 +37,23 @@ module Sepa
       end
 
       # Encrypts a given symmetric encryption key with a public key and returns it in base64 encoded
-      # format
+      # format.
+      #
+      # @param key [String] the key that will be encrypted
+      # @param public_key [OpenSSL::PKey::RSA] the public key that will be used to do the encryption
+      # @return [String] the encrypted key as a base64 encoded string
+      # @todo make more generic and move to utilities
       def encrypt_key(key, public_key)
         encrypted_key = public_key.public_encrypt(key)
         encode encrypted_key
       end
 
-      # Encrypts the application request and returns it in base64 encoded format.
-      # Also returns the key needed to decrypt it
+      # Encrypts the application request and returns it in base64 encoded format. Also returns the
+      # key needed to decrypt it. The encryption algorithm is 'DES-EDE3-CBC' and the iv is prepended
+      # to the encrypted data.
+      #
+      # @return [Array(String, String)] the encrypted application request and the key needed to
+      #   decrypt it
       def encrypt_ar
         cipher = OpenSSL::Cipher.new('DES-EDE3-CBC').encrypt
 
@@ -46,6 +68,15 @@ module Sepa
         return encrypted_data, key
       end
 
+      # Builds the xml structure for the encrypted application request that can be base64 encoded
+      # and embedded to the soap.
+      #
+      # @param cert [#to_s] the certificate which public key was used for the asymmetric encryption
+      # @param encrypted_data [#to_s] the encrypted application request
+      # @param encrypted_key [#to_s] the encrypted key that was used for the symmetric encryption
+      # @return [Nokogiri::XML] the encrypted application request xml structure as a nokogiri
+      #   document
+      # @todo rename
       def build_encrypted_ar(cert, encrypted_data, encrypted_key)
         ar = Nokogiri::XML File.open "#{AR_TEMPLATE_PATH}/encrypted_request.xml"
         set_node(ar, 'dsig|X509Certificate', cert)
@@ -54,6 +85,12 @@ module Sepa
         ar
       end
 
+      # Sets contents for generic request's nodes. Generic requests are:
+      # * Upload file
+      # * Download file
+      # * Download file list
+      #
+      # @todo make ReceiverId dynamic
       def set_generic_request_contents
         set_node(@template, 'bxd|SenderId', @customer_id)
         set_node(@template, 'bxd|RequestId', request_id)
@@ -63,6 +100,9 @@ module Sepa
         set_node(@template, 'bxd|ReceiverId', "DABAFIHH")
       end
 
+      # Sets contents for create certificate requests.
+      #
+      # @todo rename
       def set_create_cert_contents
         set_node(@template, 'pkif|SenderId', @customer_id)
         set_node(@template, 'pkif|CustomerId', @customer_id)
@@ -72,6 +112,9 @@ module Sepa
         set_node(@template, 'pkif|Environment', @environment)
       end
 
+      # Sets contents for get bank certificate requests
+      #
+      # @todo rename
       def set_bank_certificate_contents
         set_node(@template, 'pkif|SenderId', @customer_id)
         set_node(@template, 'pkif|CustomerId', @customer_id)
@@ -80,6 +123,14 @@ module Sepa
         set_node(@template, 'pkif|InterfaceVersion', 1)
       end
 
+      # Builds Danske Bank's generic request soap. The processing order is as follows:
+      # 1. The contents of the soap are set
+      # 2. The application request is encrypted
+      # 3. The encrypted application request xml structure is embedded in the soap
+      # 4. The header is processed
+      # 5. The body is added to the header
+      #
+      # @return [Nokogiri::XML] the complete soap
       def build_danske_generic_request
         set_generic_request_contents
         encrypted_request = encrypt_application_request
@@ -89,6 +140,11 @@ module Sepa
         add_body_to_header
       end
 
+      # Builds Danske Bank's create certificate request soap. Environment is set to `:customertest`
+      # if set to `:test`. This request is encrypted but not signed.
+      #
+      # @return [Nokogiri::XML] the complete soap
+      # @todo rename
       def build_certificate_request
         @environment = :customertest if @environment == :test
         set_create_cert_contents
@@ -96,11 +152,20 @@ module Sepa
         add_encrypted_request_to_soap(encrypted_request)
       end
 
+      # Builds get bank certificate request soap. This request is neither signed nor encrypted.
+      #
+      # @return [Nokogiri::XML] the complete soap
       def build_get_bank_certificate_request
         set_bank_certificate_contents
         add_bank_certificate_body_to_soap
       end
 
+      # Adds encrypted application request xml structure to the soap. This method is used when
+      # building create certificate requests and the encrypted application request xml structure
+      # will not be base64 encoded.
+      #
+      # @param encrypted_request [Nokogiri::XML] the encrypted application request xml structure
+      # @return [Nokogiri::XML] the soap with the encrypted application request added to it
       def add_encrypted_request_to_soap(encrypted_request)
         encrypted_request = Nokogiri::XML(encrypted_request.to_xml)
         encrypted_request = encrypted_request.root
@@ -109,6 +174,12 @@ module Sepa
         @template
       end
 
+      # Adds the encrypted application request xml structure to generic request soap.
+      # The application request is base64 encoded before it is added to the soap.
+      #
+      # @param encrypted_request [Nokogiri::XML] the encrypted application request xml structure
+      # @return [Nokogiri::XML] the soap with the encrypted application request added to it
+      # @todo refactor possible unnecessary conversion away and rename
       def add_encrypted_generic_request_to_soap(encrypted_request)
         encrypted_request = Nokogiri::XML(encrypted_request.to_xml)
         encrypted_request = encrypted_request.root
@@ -118,6 +189,9 @@ module Sepa
         @template
       end
 
+      # Adds get bank certificate application request to the soap
+      #
+      # @return [Nokogiri::XML] the soap with the application request added to it
       def add_bank_certificate_body_to_soap
         ar = @application_request.to_nokogiri
 
@@ -127,6 +201,10 @@ module Sepa
         @template
       end
 
+      # Generates a random 10-character request id for Danske Bank's requests.
+      #
+      # @return [String] 10-character hexnumeric request id
+      # @todo move to utilities
       def request_id
         SecureRandom.hex(5)
       end

data/lib/sepa/banks/nordea/nordea_response.rb

@@ -1,7 +1,13 @@
 module Sepa
+
+  # Handles Nordea specific response logic. Mainly certificate specific stuff.
   class NordeaResponse < Response
     include Utilities
 
+    # Extracts own signing certificate from the response.
+    #
+    # @return [String] own signing certificate as string it it is found
+    # @return [nil] if the certificate cannot be found
     def own_signing_certificate
       application_response = extract_application_response(NORDEA_PKI)
       at = 'xmlns|Certificate > xmlns|Certificate'
@@ -14,6 +20,12 @@ module Sepa
       cert.to_s
     end
 
+    # Returns the response code in the response. Overrides {Response#response_code} if {#command} is
+    # `:get_certificate`, because the namespace is different with that command.
+    #
+    # @return [String] response code if it is found
+    # @return [nil] if response code cannot be found
+    # @see Response#response_code
     def response_code
       return super unless command == :get_certificate
 
@@ -21,6 +33,12 @@ module Sepa
       node.content if node
     end
 
+    # Checks whether the certificate embedded in the response soap has been signed with Nordea's
+    # root certificate.
+    #
+    # @return [true] if certificate is trusted
+    # @return [false] if certificate fails to verify
+    # @see DanskeResponse#certificate_is_trusted?
     def certificate_is_trusted?
       verify_certificate_against_root_certificate(certificate, NORDEA_ROOT_CERTIFICATE)
     end

data/lib/sepa/banks/nordea/soap_nordea.rb

@@ -1,8 +1,14 @@
 module Sepa
+
+  # Contains Nordea specific soap building functionality
   module NordeaSoapRequest
 
     private
 
+      # Determines which soap request to build based on command. Certificate requests are built
+      # differently than generic requests.
+      #
+      # @return [Nokogiri::XML] the soap as a nokogiri document
       def find_correct_build
         case @command
         when :get_certificate
@@ -12,11 +18,17 @@ module Sepa
         end
       end
 
-      # Builds : Get Certificate
+      # Sets contents for certificate request
+      #
+      # @return [Nokogiri::XML] the template with contents added to it
       def build_certificate_request
         set_body_contents
       end
 
+      # Sets soap body contents. Application request is base64 encoded here.
+      #
+      # @return [Nokogiri::XML] the soap with contents added to it
+      # @todo rename, because apparently only sets certificate contents
       def set_body_contents
         set_node(@template, 'cer|ApplicationRequest', @application_request.to_base64)
         set_node(@template, 'cer|SenderId', @customer_id)
@@ -26,13 +38,20 @@ module Sepa
         @template
       end
 
-      # Builds : Get User Info, Download File, Download File List, Upload File
+      # Builds generic request which is a request made with commands:
+      # * Get User Info
+      # * Download File
+      # * Download File List
+      # * Upload File
+      #
+      # @return [Nokogiri::XML] the generic request soap
       def build_common_request
         common_set_body_contents
         process_header
         add_body_to_header
       end
 
+      # Sets nodes for generic requests, application request is base64 encoded here.
       def common_set_body_contents
         set_node(@template, 'bxd|ApplicationRequest', @application_request.to_base64)
         set_node(@template, 'bxd|SenderId', @customer_id)
@@ -43,6 +62,10 @@ module Sepa
         set_node(@template, 'bxd|ReceiverId', @target_id)
       end
 
+      # Generates a random request id for Nordea request
+      #
+      # @return [String] hexnumeric request id
+      # @todo move to utilities
       def request_id
         SecureRandom.hex(17)
       end

data/lib/sepa/client.rb

@@ -1,31 +1,181 @@
+# Main module for this gem
 module Sepa
+
+  # Handles parameter validation, key initialization, {SoapBuilder} initialization, communicating
+  # with the bank and {Response} initialization.
   class Client
     include ActiveModel::Validations
     include Utilities
     include ErrorMessages
     include AttributeChecks
 
-    attr_accessor :bank,
-                  :command,
-                  :content,
-                  :customer_id,
-                  :target_id,
-                  :environment,
-                  :file_reference,
-                  :file_type,
-                  :language,
-                  :status,
-                  :pin,
-                  :signing_private_key,
-                  :own_signing_certificate,
-                  :signing_csr,
-                  :encryption_private_key,
-                  :bank_encryption_certificate,
-                  :encryption_csr
 
+    # The bank that is used in this client. One of {BANKS}.
+    #
+    # @return [Symbol]
+    attr_accessor :bank
+
+    # The command that is used with this client. One of {AttributeChecks#allowed_commands}.
+    #
+    # @return [Symbol]
+    attr_accessor :command
+
+    # The payload in base64 encoded form. Used with upload file command.
+    #
+    # @return [String]
+    # @example Dummy payload
+    #   'a2lzc2E='
+    attr_accessor :content
+
+    # Customer id got from the bank.
+    #
+    # @return [String]
+    # @example Nordea's testing customer id
+    #   '11111111'
+    attr_accessor :customer_id
+
+    # A file categorization id used by Nordea. Can be retrieved with get_user_info request. Not
+    # used with Danske Bank
+    #
+    # @return [String]
+    # @example Nordea's testing target id
+    #   '11111111A1'
+    attr_accessor :target_id
+
+    # The environment to be used. One of {ENVIRONMENTS}.
+    #
+    # @return [Symbol]
+    attr_accessor :environment
+
+    # File reference number used in download_file requests.
+    #
+    # @return [String]
+    # @example
+    #   '11111111A12006030319503000000010'
+    attr_accessor :file_reference
+
+    # The file type of the file that is about to be uploaded or downloaded. These vary by bank.
+    #
+    # @return [String]
+    # @example Nordea's electronic bank statement
+    #   'TITO'
+    attr_accessor :file_type
+
+    # The language to be used in this client. One of {LANGUAGES}.
+    #
+    # @return [String]
+    attr_accessor :language
+
+    # Used to filter files in download_file_list request. One of {STATUSES}.
+    #
+    # @return [String]
+    attr_accessor :status
+
+    # The one-time pin got for bank. Used with certificate requests.
+    #
+    # @return [String]
+    # @example Danske Bank's testing pin
+    #   '1234'
+    attr_accessor :pin
+
+    # Signing private key which is used to sign the request
+    #
+    # @return [String]
+    # @example Nordea's testing private key
+    #   '-----BEGIN RSA PRIVATE KEY-----
+    #   MIICXQIBAAKBgQDC0UR8C1sm4bNDDBG6ZmS9iHYGMZhWwAxR6Iq06d7dtlJ6Kx8K
+    #   r5NeovWAj0uh/J4BD0j+wObq0vzTKsPmJpJSpWboDvf0yyalb+LJlxV/uazzEA3n
+    #   URJSA3pqTBkJT2kfraeAkOPaBSyS1jR+myhWwBF2u84WTR9NJRcpZ3ottwIDAQAB
+    #   AoGBAKrfddv+8eI2kE68ZUhCyxVafXqNQXrFU4j8F7z6bBm28rxo2f87ZFzbPc2W
+    #   4dWghs2TJIkdlOxeRpbIqa5SIn+HBel8+6wo2gLO4g0bfT44Y1bqjRkdiPlSCJW0
+    #   PV1hSd5SRVt7+0yGfCWy559Fzhc/mQQUkhkytc0zYeEwULYxAkEA3uTN7rvZuEcE
+    #   sPUehmg8PyBUGYK9KFkr9FiI0cL8FpxZ0l9pW5DQI7pT9HWhrJp+78SKamcT8cHK
+    #   1OMBakxeXQJBAN/A52wpt2H6IM8Cxza3toQZhqo1mq4bcarUWq65IJ5jnfFtGdR2
+    #   9XUh65YlElUqyDWyuWXRFdeUabu1Qznj8yMCQDzLJUvvGpQDcskdIiVAuuXw2F9Y
+    #   5GTj5XQwzaiAyScVn/4cHe1mkw6bnJh5mQ4t2V9mOOaKlMsEs2DbRaCLkdUCQGWF
+    #   Gbsqpkiu+0nRgd+itQ30ovQBREAwtX8DwG08E7+phRTwImMS4kWV8VT7VvkLYzFx
+    #   +MpodleMv/hpwqm2ci8CQQCUEgwDBEp+FM+2Y5N1KwSGzGBL9LtpnAsqcLG9JxhO
+    #   f4Mwz4xhPXMVlvq1wESLPrDUFQpZ4eOZ4XX2MTo4GH39
+    #   -----END RSA PRIVATE KEY-----'
+    attr_accessor :signing_private_key
+
+    # Own signing certificate in "pem" format. Embedded in the request
+    #
+    # @return [String]
+    # @example Nordea's testing signing certificate
+    #   '-----BEGIN CERTIFICATE-----
+    #   MIIDwTCCAqmgAwIBAgIEAX1JuTANBgkqhkiG9w0BAQUFADBkMQswCQYDVQQGEwJT
+    #   RTEeMBwGA1UEChMVTm9yZGVhIEJhbmsgQUIgKHB1YmwpMR8wHQYDVQQDExZOb3Jk
+    #   ZWEgQ29ycG9yYXRlIENBIDAxMRQwEgYDVQQFEws1MTY0MDYtMDEyMDAeFw0xMzA1
+    #   MDIxMjI2MzRaFw0xNTA1MDIxMjI2MzRaMEQxCzAJBgNVBAYTAkZJMSAwHgYDVQQD
+    #   DBdOb3JkZWEgRGVtbyBDZXJ0aWZpY2F0ZTETMBEGA1UEBRMKNTc4MDg2MDIzODCB
+    #   nzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEAwtFEfAtbJuGzQwwRumZkvYh2BjGY
+    #   VsAMUeiKtOne3bZSeisfCq+TXqL1gI9LofyeAQ9I/sDm6tL80yrD5iaSUqVm6A73
+    #   9MsmpW/iyZcVf7ms8xAN51ESUgN6akwZCU9pH62ngJDj2gUsktY0fpsoVsARdrvO
+    #   Fk0fTSUXKWd6LbcCAwEAAaOCAR0wggEZMAkGA1UdEwQCMAAwEQYDVR0OBAoECEBw
+    #   2cj7+XMAMBMGA1UdIAQMMAowCAYGKoVwRwEDMBMGA1UdIwQMMAqACEALddbbzwun
+    #   MDcGCCsGAQUFBwEBBCswKTAnBggrBgEFBQcwAYYbaHR0cDovL29jc3Aubm9yZGVh
+    #   LnNlL0NDQTAxMA4GA1UdDwEB/wQEAwIFoDCBhQYDVR0fBH4wfDB6oHigdoZ0bGRh
+    #   cCUzQS8vbGRhcC5uYi5zZS9jbiUzRE5vcmRlYStDb3Jwb3JhdGUrQ0ErMDElMkNv
+    #   JTNETm9yZGVhK0JhbmsrQUIrJTI4cHVibCUyOSUyQ2MlM0RTRSUzRmNlcnRpZmlj
+    #   YXRlcmV2b2NhdGlvbmxpc3QwDQYJKoZIhvcNAQEFBQADggEBACLUPB1Gmq6286/s
+    #   ROADo7N+w3eViGJ2fuOTLMy4R0UHOznKZNsuk4zAbS2KycbZsE5py4L8o+IYoaS8
+    #   8YHtEeckr2oqHnPpz/0Eg7wItj8Ad+AFWJqzbn6Hu/LQhlnl5JEzXzl3eZj9oiiJ
+    #   1q/2CGXvFomY7S4tgpWRmYULtCK6jode0NhgNnAgOI9uy76pSS16aDoiQWUJqQgV
+    #   ydowAnqS9h9aQ6gedwbOdtkWmwKMDVXU6aRz9Gvk+JeYJhtpuP3OPNGbbC5L7NVd
+    #   no+B6AtwxmG3ozd+mPcMeVuz6kKLAmQyIiBSrRNa5OrTkq/CUzxO9WUgTnm/Sri7
+    #   zReR6mU=
+    #     -----END CERTIFICATE-----'
+    attr_accessor :own_signing_certificate
+
+    # The signing certificate signing request. Used in certificate requests.
+    #
+    # @return [String]
+    # @example
+    #   '-----BEGIN CERTIFICATE REQUEST-----
+    #   MIIBczCB3QIBADA0MRIwEAYDVQQDEwlEZXZsYWIgT3kxETAPBgNVBAUTCDExMTEx
+    #   MTExMQswCQYDVQQGEwJGSTCBnzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEAo9wU
+    #   c2Ys5hSso4nEanbc+RIhL71aS6GBGiWAegXjhlyb6dpwigrZBFPw4u6UZV/Vq7Y7
+    #   Ku3uBq5rfZwk+lA+c/B634Eu0zWdI+EYfQxKVRrBrmhiGplKEtglHXbNmmMOn07e
+    #   LPUaB0Ipx/6h/UczJGBINdtcuIbYVu0r7ZfyWbUCAwEAAaAAMA0GCSqGSIb3DQEB
+    #   BQUAA4GBAIhh2o8mN4Byn+w1jdbhq6lxEXYqdqdh1F6GCajt2lQMUBgYP23I5cS/
+    #   Z+SYNhu8vbj52cGQPAwEDN6mm5yLpcXu40wYzgWyfStLXV9d/b4hMy9qLMW00Dzb
+    #   jo2ekdSDdw8qxKyxj1piv8oYzMd4fCjCpL+WDZtq7mdLErVZ92gH
+    #   -----END CERTIFICATE REQUEST-----'
+    attr_accessor :signing_csr
+
+    # Own encryption private key. Used to decrypt the response. In "pem" format.
+    #
+    # @return [String]
+    # @see #signing_private_key The format is the same as in signing private key
+    attr_accessor :encryption_private_key
+
+    # Bank's encryption certificate. The request is encrypted with this so that the bank can decrypt
+    # the request with their private key. In "pem" format.
+    #
+    # @return [String]
+    # @see #own_signing_certificate The format is the same as in own signing certificate
+    attr_accessor :bank_encryption_certificate
+
+    # Encryption certificate signing request. This needs to be generated and is then sent to the
+    # bank to be signed.
+    #
+    # @return [String]
+    # @see #signing_csr The format is the same as in signing csr
+    attr_accessor :encryption_csr
+
+    # The list of banks that are currently supported by this gem
     BANKS = [:nordea, :danske]
+
+    # Languages that are currently supported by the gem
     LANGUAGES = ['FI', 'SE', 'EN']
+
+    # Environments that are currently supported by the gem
     ENVIRONMENTS = [:production, :test]
+
+    # Statuses that can be given to download file list command. When NEW is given, only those files
+    # that have not yet been downloaded will be listed. DOWNLOADED will list only downloaded files
+    # and ALL will list every file
     STATUSES = ['NEW', 'DOWNLOADED', 'ALL']
 
     validates :bank, inclusion: { in: BANKS }
@@ -46,6 +196,10 @@ module Sepa
     validate :check_file_reference
     validate :check_encryption_private_key
 
+    # Initializes the class. An optional hash of attributes can be given. Environment is set to
+    # production if not given, language to 'EN' and status to 'NEW'.
+    #
+    # @param hash [Hash] All the attributes of the client can be given to the construcor in a hash
     def initialize(hash = {})
       self.attributes hash
       self.environment ||= :production
@@ -67,12 +221,29 @@ module Sepa
       @environment = value.downcase.to_sym
     end
 
+    # Sets the attributes given in a hash
+    #
+    # @param hash [Hash] Hash of parameters
+    # @example
+    #   {
+    #     bank: :nordea,
+    #     command: :download_file_list
+    #   }
     def attributes(hash)
       hash.each do |name, value|
         send("#{name}=", value)
       end
     end
 
+    # Sends request to the bank specified in the attributes. First a new {SoapBuilder} class is
+    # initialized with a hash of the parameters given to the client with the {#create_hash} method.
+    # After this, a Savon client is initialized with a WSDL file got from {#wsdl}. After this, the
+    # Savon client makes the actual call to the server with the {#command} and the constructed
+    # {SoapBuilder}. After the call, the xml is extracted from the Savon response and the response
+    # is then checked for any Savon::Error errors. After this a {Response} is initialized using
+    # the {#initialize_response} method with the xml response and possible errors.
+    # @raise [ArgumentError] if some of the parameters are not valid
+    # @return [Response]
     def send_request
       raise ArgumentError, errors.messages unless valid?
 
@@ -93,6 +264,11 @@ module Sepa
 
     private
 
+      # Creates a hash of all instance variables and their values. Before the actual hash is
+      # created, the {#signing_private_key} is converted to OpenSSL::PKey::RSA using
+      # {#initialize_signing_private_key} method.
+      #
+      # @return [Hash] All instance variables in a hash with their names as symbols as keys
       def create_hash
         initialize_signing_private_key
         iv = {}
@@ -108,11 +284,14 @@ module Sepa
         iv
       end
 
+      # Converts the {#signing_private_key} from String to OpenSSL::PKey::RSA
+      # @return [OpenSSL::PKey::RSA]
       def initialize_signing_private_key
         @signing_private_key = rsa_key(@signing_private_key) if @signing_private_key
       end
 
-      # Returns path to WSDL file
+      # Returns path to WSDL file according to {#bank} and {#command}
+      # @return [String] Path to the WSDL file of the bank and command
       def wsdl
         case bank
         when :nordea
@@ -132,6 +311,12 @@ module Sepa
         "#{WSDL_PATH}/#{file}"
       end
 
+      # Initializes {Response} as correct class for a bank. Also converts possible
+      # {#encryption_private_key} from String to OpenSSL::PKey::RSA.
+      #
+      # @param error [String] Possible error got from {#send_request}
+      # @param response [String] A soap response in plain xml
+      # @return [Response] A {Response} with a correct class for a bank
       def initialize_response(error, response)
         options = {
           response: response,

data/lib/sepa/error_messages.rb

@@ -1,27 +1,68 @@
 module Sepa
+
+  # Contains error messages used in this gem
   module ErrorMessages
-    CUSTOMER_ID_ERROR_MESSAGE = 'Customer Id needs to be present and needs to have a length of less than 17 characters'
+
+    # Error message which is shown when {Client#customer_id} validation fails
+    CUSTOMER_ID_ERROR_MESSAGE =
+      'Customer Id needs to be present and needs to have a length of less than 17 characters'
+
+    # Error message which is shown when {Client#environment} validation fails
     ENVIRONMENT_ERROR_MESSAGE = 'Environment needs to be either production or test'
+
+    # Error message which is shown when {Client#target_id} validation fails
     TARGET_ID_ERROR_MESSAGE = 'Target Id needs to be present and under 80 characters'
+
+    # Error message which is shown when {Client#file_type} validation fails
     FILE_TYPE_ERROR_MESSAGE = 'File type needs to be present and under 35 characters'
+
+    # Error message which is shown when {Client#content} validation fails
     CONTENT_ERROR_MESSAGE = 'Content needs to be present for this command'
+
+    # Error message which is shown when {Client#signing_csr} validation fails
     SIGNING_CERT_REQUEST_ERROR_MESSAGE = 'Invalid signing certificate request'
+
+    # Error message which is shown when {Client#encryption_csr} validation fails
     ENCRYPTION_CERT_REQUEST_ERROR_MESSAGE = 'Invalid encryption certificate request'
-    PIN_ERROR_MESSAGE = 'Pin needs to be present for this command and cannot be more than 10 characters'
+
+    # Error message which is shown when {Client#pin} validation fails
+    PIN_ERROR_MESSAGE =
+      'Pin needs to be present for this command and cannot be more than 10 characters'
+
+    # Error message which is shown when {Client#bank_encryption_certificate} validation fails
     ENCRYPTION_CERT_ERROR_MESSAGE = 'Invalid encryption certificate'
-    STATUS_ERROR_MESSAGE = 'Status is required for this command and must be either NEW, DOWNLOADED or ALL'
-    FILE_REFERENCE_ERROR_MESSAGE = 'File reference is required for this command and must be under 33 characters'
-    ENCRYPTION_PRIVATE_KEY_ERROR_MESSAGE = 'Encryption private key is needed for this bank and this command'
-    NOT_OK_RESPONSE_CODE_ERROR_MESSAGE = 'The response from the bank suggested there was ' \
-    'something wrong with your request, check your parameters and try again'
 
-    DECRYPTION_ERROR_MESSAGE = 'The response could not be decrypted with the private key ' \
-    'that you gave. Check that the key is the private key of your own encryption certificate'
+    # Error message which is shown when {Client#status} validation fails
+    STATUS_ERROR_MESSAGE =
+      'Status is required for this command and must be either NEW, DOWNLOADED or ALL'
+
+    # Error message which is shown when {Client#file_reference} validation fails
+    FILE_REFERENCE_ERROR_MESSAGE =
+      'File reference is required for this command and must be under 33 characters'
+
+    # Error message which is shown when {Client#encryption_private_key} validation fails
+    ENCRYPTION_PRIVATE_KEY_ERROR_MESSAGE =
+      'Encryption private key is needed for this bank and this command'
+
+    # Error message which is shown when {Response#response_code} validation fails
+    NOT_OK_RESPONSE_CODE_ERROR_MESSAGE =
+      'The response from the bank suggested there was something wrong with your request, check ' \
+      'your parameters and try again'
+
+    # Error message which is shown when the response got from the bank cannot be decrypted with the
+    # private key that is given to the client
+    DECRYPTION_ERROR_MESSAGE =
+      'The response could not be decrypted with the private key that you gave. Check that the ' \
+      'key is the private key of your own encryption certificate'
 
-    HASH_ERROR_MESSAGE = 'The hashes in the response did not match which means that the data in ' \
-    'the response is not intact'
+    # Error message which is shown when the hash embedded in the {Response} soap doesn't match the
+    # locally calculated one.
+    HASH_ERROR_MESSAGE =
+      'The hashes in the response did not match which means that the data in the response is not ' \
+      'intact'
 
-    SIGNATURE_ERROR_MESSAGE = 'The signature in the response did not verify and the response ' \
-    'cannot be trusted'
+    # Error message which is shown when the signature in {Response} cannot be verified.
+    SIGNATURE_ERROR_MESSAGE =
+      'The signature in the response did not verify and the response cannot be trusted'
   end
 end