wirecard_sepa 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d6f8ab6d149ae746b1da4e8c9dee77c03bdb64ac
-  data.tar.gz: bbddcf297b2f0c1c7417ff5658ae1203215f0df7
+  metadata.gz: 04e43db72ba035b59d9e26101b5c84664fdd745f
+  data.tar.gz: 2e174adf77802fce273870d8f72a57b7a1cf9cf7
 SHA512:
-  metadata.gz: 36d6830f071919380ddd9719eb37a676526b1dd9b7b2eea500650297ee61eb564b3454ea3419c5f45c609ebd01f394bc3f1c96ddfbad5c977ccdce5dd8b772b4
-  data.tar.gz: c9bf7b247c5b6c68c5ef0220c68056c7438faf5ab1052df93131875d93e4054648e6d62a48b6f26d677d045d1a91aa299126a6a3bb2350b0253ad4ba108c7763
+  metadata.gz: 449083675e209e5aa7956326e0a448a7fb41e444c9ce6b86f18ffaf6dd29cdc0e67862940e6f92e2ef00b7039270004f9a0e71db0d824a525146ade84d7cd8d9
+  data.tar.gz: 2edcc3b230df93a2cf7e740e70a72a17c180beab3897c7fdda76536d94e4cce13004e819968d1bc1b8ea7f7980a5b3c915d349587f537c080b22ba2492949bfc

data/.gitignore

@@ -0,0 +1,2 @@
+Gemfile.lock
+/pkg/

data/.travis.yml

@@ -0,0 +1,3 @@
+rvm:
+  - 2.1
+  - 2.2

data/README.md

@@ -1,6 +1,15 @@
 # Wirecard SEPA
+[![Build Status](https://api.travis-ci.org/betterplace/wirecard_sepa.svg?branch=master)](http://travis-ci.org/betterplace/wirecard_sepa)
+[![Code Climate](https://codeclimate.com/repos/55494936e30ba04e91005d6e/badges/cd0d22df220babab1b66/gpa.svg)](https://codeclimate.com/repos/55494936e30ba04e91005d6e/feed)
+
 A WORK IN PROGRESS PROJECT
 
+## TODOS
+1. Error Handling
+1. Maybe cache template files (are they loaded from disk each request?)
+1. Docs for usage in README.md
+1. Check Recurring Request/Response
+
 ## Contributing
 1. Fork it ( https://github.com/betterplace/wirecard_sepa/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)

data/lib/templates/wirecard_sepa/direct_debit/request.xml

@@ -14,7 +14,7 @@
     <iban>{{BANK_ACCOUNT_IBAN}}</iban>
     <bic>{{BANK_ACCOUNT_BIC}}</bic>
   </bank-account>
- <mandate>
+  <mandate>
     <mandate-id>{{MANDATE_ID}}</mandate-id>
     <signed-date>{{MANDATE_SIGNED_DATE}}</signed-date>
   </mandate>

data/lib/wirecard_sepa/config.rb

@@ -1,61 +1,22 @@
 module WirecardSepa
   # Usage:
   # WirecardSepa::Config.new({
+  #   api_url: 'https://api-test.wirecard.com/engine/rest/paymentmethods',
   #   http_auth_username: 'foo',
   #   http_auth_password: 'bar',
-  #   …
+  #   merchant_account_id: '123',
+  #   credit_id: '987',
   # })
   # => config
-  #
-  # For sandbox testing the config provides a hardcoded config object
-  # WirecardSepa::Config.for_sandbox
-  # => config # Object with all necessary infos for sandbox testing
   class Config
-    AUTH_PARAMS     = %i(http_auth_username http_auth_password)
-    REQUEST_PARAMS  = %i(merchant_account_id creditor_id)
-    EXPECTED_PARAMS = AUTH_PARAMS + REQUEST_PARAMS
-
-    attr_accessor *EXPECTED_PARAMS
-    attr_reader :params
-
-    def initialize(params = {})
-      if params.keys.sort != EXPECTED_PARAMS.sort
-        raise Errors::InvalidParamsError.new(
-          "Please provide a hash exactly with the following keys: #{EXPECTED_PARAMS}\n" +
-          "Missing params: #{EXPECTED_PARAMS - params.keys}\n" +
-          "Unexpected params: #{params.keys - EXPECTED_PARAMS}"
-        )
-      end
-      @params = params
-    end
-
-    def self.for_sandbox
-      new(
-        http_auth_username: '70000-APITEST-AP',
-        http_auth_password: 'qD2wzQ_hrc!8',
-        merchant_account_id: '4c901196-eff7-411e-82a3-5ef6b6860d64',
-        creditor_id: 'abcdef'
-      )
-    end
-
-    def http_auth_username
-      params[:http_auth_username]
-    end
-
-    def http_auth_password
-      params[:http_auth_password]
-    end
-
-    def [](key)
-      params[key]
-    end
-
-    def request_params
-      REQUEST_PARAMS.each_with_object({}) { |key, h| h[key] = params[key] }
-    end
-
-    def to_hash
-      params
+    attr_reader :api_url, :http_auth_username, :http_auth_password, :merchant_account_id, :creditor_id
+
+    def initialize(api_url:, http_auth_username:, http_auth_password:, merchant_account_id:, creditor_id:)
+      @api_url = api_url
+      @http_auth_username = http_auth_username
+      @http_auth_password = http_auth_password
+      @merchant_account_id = merchant_account_id
+      @creditor_id = creditor_id
     end
   end
 end

data/lib/wirecard_sepa/direct_debit/response.rb

@@ -1,21 +1,26 @@
 module WirecardSepa
   module DirectDebit
     class Response
-      attr_reader :xml
+      attr_reader :xml, :request
 
-      def initialize(xml)
+      def self.for_request(request)
+        new(request.body, request: request)
+      end
+
+      def initialize(xml, request: nil)
         @xml = xml
+        @request = request
       end
 
       def params
         {
-          success: success?,
-          transaction_id: transaction_id,
-          transaction_state: transaction_state,
-          status_code: status_code,
-          status_description: status_description,
-          due_date: due_date,
-          reference_id: provider_transaction_reference_id,
+          success:               success?,
+          transaction_id:        transaction_id,
+          transaction_state:     transaction_state,
+          status_code:           status_code,
+          status_description:    status_description,
+          due_date:              due_date,
+          reference_id:          provider_transaction_reference_id,
           original_response_xml: xml,
         }
       end
@@ -24,8 +29,6 @@ module WirecardSepa
         status_code == '201.0000'
       end
 
-      private
-
       def transaction_id
         xml_doc.at_css('transaction-id').text
       end
@@ -50,6 +53,8 @@ module WirecardSepa
         xml_doc.at_css('provider-transaction-reference-id').text
       end
 
+      private
+
       def xml_doc
         @xml_doc ||= Nokogiri::XML xml
       end

data/lib/wirecard_sepa/gateway.rb

@@ -1,6 +1,3 @@
-require 'securerandom'
-require 'typhoeus'
-
 module WirecardSepa
   # Usage:
   # config = WirecardSepa::Config.new(...)
@@ -20,43 +17,41 @@ module WirecardSepa
 
     def debit(params)
       request_params = params.merge({
-        merchant_account_id: config[:merchant_account_id],
-        creditor_id: config[:creditor_id],
+        merchant_account_id: config.merchant_account_id,
+        creditor_id: config.creditor_id,
         request_id: request_id,
       })
       request_xml = DirectDebit::Request.new(request_params).to_xml
-      response_xml = post(request_xml).body
-      DirectDebit::Response.new response_xml
+      DirectDebit::Response.for_request post(request_xml)
     end
 
     def recurring_init(params)
       request_params = params.merge({
-        merchant_account_id: config[:merchant_account_id],
-        creditor_id: config[:creditor_id],
+        merchant_account_id: config.merchant_account_id,
+        creditor_id: config.creditor_id,
         request_id: request_id,
       })
       request_xml = Recurring::FirstRequest.new(request_params).to_xml
-      response_xml = post(request_xml).body
-      Recurring::FirstResponse.new response_xml
+      Recurring::FirstResponse.for_request post(request_xml)
     end
 
     def recurring_process(params)
       request_params = params.merge({
-        merchant_account_id: config[:merchant_account_id],
+        merchant_account_id: config.merchant_account_id,
         request_id: request_id,
       })
       request_xml = Recurring::RecurringRequest.new(request_params).to_xml
-      response_xml = post(request_xml).body
-      Recurring::RecurringResponse.new response_xml
+      Recurring::RecurringResponse.for_request post(request_xml)
     end
 
     private
 
     def post(request_xml)
       Typhoeus.post(
-        WirecardSepa.gateway_url,
+        config.api_url,
         body: request_xml,
         userpwd: http_auth_credentials,
+        headers: { 'Content-Type' => 'application/xml' }
       )
     end
 
@@ -66,6 +61,8 @@ module WirecardSepa
       # This is the identification number of the request on the merchants side.
       # It must be unique for each request.
       # Sample Request-ID: 048b27e0-9c31-4cab-9eab-3b72b1b4d498
+      # SecureRandom.uuid
+      # SecureRandom.uuid
       SecureRandom.uuid
     end
 

data/lib/wirecard_sepa/utils/params_validator.rb

@@ -5,7 +5,6 @@ module WirecardSepa
 
       def validate!(params, expected_params)
         if params.keys.sort != expected_params.sort
-          # TODO: Provide link to official wirecard spec which explains the use of the keys
           raise Errors::InvalidParamsError.new(
             "Please provide a hash exactly with the following keys: #{expected_params}\n" +
             "Missing params: #{expected_params - params.keys}\n" +

data/lib/wirecard_sepa/utils/template.rb

@@ -8,8 +8,8 @@ module WirecardSepa
       end
 
       def to_xml
-        xml_template = File.read template_path
-        xml_template.gsub /{{\w+}}/, request_params
+        xml_template = File.open template_path, "r:UTF-8", &:read
+        xml_template.gsub(/{{\w+}}/, request_params)
       end
 
       private

data/lib/wirecard_sepa/version.rb

@@ -1,3 +1,3 @@
 module WirecardSepa
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
 end

data/lib/wirecard_sepa.rb

@@ -1,4 +1,7 @@
+require 'securerandom'
+require 'typhoeus'
 require 'nokogiri'
+
 require 'wirecard_sepa/version'
 require 'wirecard_sepa/errors'
 require 'wirecard_sepa/utils/template'
@@ -13,18 +16,4 @@ require 'wirecard_sepa/config'
 require 'wirecard_sepa/gateway'
 
 module WirecardSepa
-  SANDBOX_URL = 'https://api-test.wirecard.com/engine/rest/paymentmethods/'
-  LIVE_URL    = ''
-
-  def self.sandbox!
-    @live = true
-  end
-
-  def self.sandboxed?
-    !@live
-  end
-
-  def self.gateway_url
-    sandboxed? ? SANDBOX_URL : LIVE_URL
-  end
 end

data/spec/lib/wirecard_sepa/config_spec.rb

@@ -4,6 +4,7 @@ describe WirecardSepa::Config do
   let(:config) { described_class.new(valid_params) }
   let(:valid_params) do
     {
+      api_url: 'http://example.com',
       http_auth_username: 'alice',
       http_auth_password: 'secret',
       merchant_account_id: '123',
@@ -11,23 +12,6 @@ describe WirecardSepa::Config do
     }
   end
 
-  describe '#initialize' do
-    it 'raises an Error when unexpected param keys are provided' do
-      expect {
-        described_class.new(valid_params.merge({ unexpected_key: 'foo' }))
-      }.to raise_error WirecardSepa::Errors::InvalidParamsError
-    end
-  end
-
-  describe '#request_params' do
-    it 'returns the params for the request' do
-      expect(config.request_params).to eq({
-        merchant_account_id: '123',
-        creditor_id: '31415',
-      })
-    end
-  end
-
   describe '#http_auth_username' do
     it 'returns the http auth username' do
       expect(config.http_auth_username).to eq 'alice'
@@ -39,14 +23,4 @@ describe WirecardSepa::Config do
       expect(config.http_auth_password).to eq 'secret'
     end
   end
-
-  describe '.for_sandbox' do
-    it 'returns a config object with the correct sandbox settings' do
-      config = described_class.for_sandbox
-      expect(config[:http_auth_username]).to eq '70000-APITEST-AP'
-      expect(config[:http_auth_password]).to eq 'qD2wzQ_hrc!8'
-      expect(config[:merchant_account_id]).to eq '4c901196-eff7-411e-82a3-5ef6b6860d64'
-      expect(config[:creditor_id]).to eq 'abcdef'
-    end
-  end
 end

data/spec/lib/wirecard_sepa/direct_debit/request_spec.rb

@@ -30,5 +30,13 @@ describe WirecardSepa::DirectDebit::Request do
       expected_xml = read_support_file('direct_debit/success/request.xml')
       expect(subject.to_xml).to eq expected_xml
     end
+
+    it 'builds a valid request' do
+      xsd = Nokogiri::XML::Schema(read_support_file('payment.xsd'))
+      doc = Nokogiri::XML(subject.to_xml)
+
+      errors = xsd.validate(doc)
+      expect(errors).to be_empty
+    end
   end
 end

data/spec/lib/wirecard_sepa/direct_debit/response_spec.rb

@@ -7,6 +7,19 @@ describe WirecardSepa::DirectDebit::Response do
   let(:success_response) { described_class.new success_xml }
   let(:failure_response) { described_class.new failure_xml }
 
+  describe '.for_request(request)' do
+    let(:request) { double('Fake Typhoeus request', body: '</xml>') }
+    let(:response) { described_class.for_request(request) }
+
+    it 'takes a uses the requests body to create a response' do
+      expect(response.xml).to eq '</xml>'
+    end
+
+    it 'stores the request object for debugging cases' do
+      expect(response.request).to eq request
+    end
+  end
+
   describe '#params' do
     context 'for a successful response' do
       let(:params) { success_response.params }

data/spec/lib/wirecard_sepa/gateway_spec.rb

@@ -1,8 +1,7 @@
 require 'spec_helper'
 
 describe WirecardSepa::Gateway do
-  let(:config)  { WirecardSepa::Config.for_sandbox }
-  let(:gateway) { described_class.new(config) }
+  let(:gateway) { described_class.new(sandbox_gateway_config) }
 
   describe '#debit(params)' do
     let(:params) do
@@ -24,6 +23,7 @@ describe WirecardSepa::Gateway do
       # "The Request Identifier has not been provided.  Please check your input and try again."
       # Status-Code: 400.1010
       # expect(response).to be_success
+      expect(response.request.headers['Content-Type']).to eq 'application/xml;charset=UTF-8'
     end
   end
 

data/spec/lib/wirecard_sepa/recurring/first_response_spec.rb

@@ -4,6 +4,19 @@ describe WirecardSepa::Recurring::FirstResponse do
   let(:success_xml) { read_support_file('recurring/success/first_response.xml') }
   let(:success_response) { described_class.new success_xml }
 
+  describe '.for_request(request)' do
+    let(:request) { double('Fake Typhoeus request', body: '</xml>') }
+    let(:response) { described_class.for_request(request) }
+
+    it 'takes a uses the requests body to create a response' do
+      expect(response.xml).to eq '</xml>'
+    end
+
+    it 'stores the request object for debugging cases' do
+      expect(response.request).to eq request
+    end
+  end
+
   describe '#params' do
     context 'for a successful response' do
       let(:params) { success_response.params }

data/spec/lib/wirecard_sepa/recurring/recurring_response_spec.rb

@@ -4,6 +4,19 @@ describe WirecardSepa::Recurring::RecurringResponse do
   let(:success_xml) { read_support_file('recurring/success/recurring_response.xml') }
   let(:success_response) { described_class.new success_xml }
 
+  describe '.for_request(request)' do
+    let(:request) { double('Fake Typhoeus request', body: '</xml>') }
+    let(:response) { described_class.for_request(request) }
+
+    it 'takes a uses the requests body to create a response' do
+      expect(response.xml).to eq '</xml>'
+    end
+
+    it 'stores the request object for debugging cases' do
+      expect(response.request).to eq request
+    end
+  end
+
   describe '#params' do
     context 'for a successful response' do
       let(:params) { success_response.params }

data/spec/spec_helper.rb

@@ -9,7 +9,17 @@ require 'byebug'
 # end
 # SimpleCov.start 'gem'
 def read_support_file(file_path)
-  File.read File.expand_path("../support/#{file_path}", __FILE__)
+  File.open File.expand_path("../support/#{file_path}", __FILE__), "r:UTF-8", &:read
+end
+
+def sandbox_gateway_config
+  WirecardSepa::Config.new({
+    api_url:             'https://api-test.wirecard.com/engine/rest/paymentmethods/',
+    http_auth_username:  '70000-APITEST-AP',
+    http_auth_password:  'qD2wzQ_hrc!8',
+    merchant_account_id: '4c901196-eff7-411e-82a3-5ef6b6860d64',
+    creditor_id:         'abcdef',
+  })
 end
 
 require 'wirecard_sepa'