wirecard_sepa 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d6f8ab6d149ae746b1da4e8c9dee77c03bdb64ac
+  data.tar.gz: bbddcf297b2f0c1c7417ff5658ae1203215f0df7
+SHA512:
+  metadata.gz: 36d6830f071919380ddd9719eb37a676526b1dd9b7b2eea500650297ee61eb564b3454ea3419c5f45c609ebd01f394bc3f1c96ddfbad5c977ccdce5dd8b772b4
+  data.tar.gz: c9bf7b247c5b6c68c5ef0220c68056c7438faf5ab1052df93131875d93e4054648e6d62a48b6f26d677d045d1a91aa299126a6a3bb2350b0253ad4ba108c7763

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,54 @@
+PATH
+  remote: .
+  specs:
+    wirecard_sepa (0.0.1)
+      nokogiri
+      typhoeus
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    byebug (4.0.5)
+      columnize (= 0.9.0)
+    columnize (0.9.0)
+    diff-lcs (1.2.5)
+    docile (1.1.5)
+    ethon (0.7.3)
+      ffi (>= 1.3.0)
+    ffi (1.9.8)
+    json (1.8.2)
+    mini_portile (0.6.2)
+    nokogiri (1.6.6.2)
+      mini_portile (~> 0.6.0)
+    rake (10.4.2)
+    rspec (3.2.0)
+      rspec-core (~> 3.2.0)
+      rspec-expectations (~> 3.2.0)
+      rspec-mocks (~> 3.2.0)
+    rspec-core (3.2.3)
+      rspec-support (~> 3.2.0)
+    rspec-expectations (3.2.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.2.0)
+    rspec-mocks (3.2.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.2.0)
+    rspec-support (3.2.2)
+    simplecov (0.10.0)
+      docile (~> 1.1.0)
+      json (~> 1.8)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
+    typhoeus (0.7.1)
+      ethon (>= 0.7.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.9)
+  byebug
+  rake (~> 10.4)
+  rspec
+  simplecov
+  wirecard_sepa!

data/LICENSE

@@ -0,0 +1,202 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright {yyyy} {name of copyright owner}
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+

data/README.md

@@ -0,0 +1,9 @@
+# Wirecard SEPA
+A WORK IN PROGRESS PROJECT
+
+## Contributing
+1. Fork it ( https://github.com/betterplace/wirecard_sepa/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,14 @@
+require 'bundler/gem_tasks'
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+task default: :spec
+
+desc 'Open an irb session preloaded with this library'
+task :console do
+  require 'irb'
+  require 'irb/completion'
+  require 'wirecard_giropay'
+  ARGV.clear
+  IRB.start
+end

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

@@ -0,0 +1,23 @@
+<payment xmlns="http://www.elastic-payments.com/schema/payment">
+  <merchant-account-id>{{MERCHANT_ACCOUNT_ID}}</merchant-account-id>
+  <request-id>{{REQUEST_ID}}</request-id>
+  <transaction-type>pending-debit</transaction-type>
+  <requested-amount currency="EUR">{{REQUESTED_AMOUNT}}</requested-amount>
+  <account-holder>
+    <first-name>{{ACCOUNT_HOLDER_FIRST_NAME}}</first-name>
+    <last-name>{{ACCOUNT_HOLDER_LAST_NAME}}</last-name>
+  </account-holder>
+  <payment-methods>
+    <payment-method name="sepadirectdebit"/>
+  </payment-methods>
+  <bank-account>
+    <iban>{{BANK_ACCOUNT_IBAN}}</iban>
+    <bic>{{BANK_ACCOUNT_BIC}}</bic>
+  </bank-account>
+ <mandate>
+    <mandate-id>{{MANDATE_ID}}</mandate-id>
+    <signed-date>{{MANDATE_SIGNED_DATE}}</signed-date>
+  </mandate>
+  <creditor-id>{{CREDITOR_ID}}</creditor-id>
+</payment>
+

data/lib/templates/wirecard_sepa/recurring/first_request.xml

@@ -0,0 +1,27 @@
+<payment xmlns="http://www.elastic-payments.com/schema/payment">
+  <merchant-account-id>{{MERCHANT_ACCOUNT_ID}}</merchant-account-id>
+  <request-id>{{REQUEST_ID}}</request-id>
+  <transaction-type>debit</transaction-type>
+  <requested-amount currency="EUR">{{REQUESTED_AMOUNT}}</requested-amount>
+  <account-holder>
+    <first-name>{{ACCOUNT_HOLDER_FIRST_NAME}}</first-name>
+    <last-name>{{ACCOUNT_HOLDER_LAST_NAME}}</last-name>
+  </account-holder>
+  <payment-methods>
+    <payment-method name="sepadirectdebit" />
+  </payment-methods>
+  <bank-account>
+    <iban>{{BANK_ACCOUNT_IBAN}}</iban>
+    <bic>{{BANK_ACCOUNT_BIC}}</bic>
+  </bank-account>
+  <mandate>
+    <mandate-id>{{MANDATE_ID}}</mandate-id>
+    <signed-date>{{MANDATE_SIGNED_DATE}}</signed-date>
+  </mandate>
+  <creditor-id>{{CREDITOR_ID}}</creditor-id>
+  <periodic>
+    <periodic-type>recurring</periodic-type>
+    <sequence-type>first</sequence-type>
+  </periodic>
+</payment>
+

data/lib/templates/wirecard_sepa/recurring/recurring_request.xml

@@ -0,0 +1,13 @@
+<payment xmlns="http://www.elastic-payments.com/schema/payment">
+  <merchant-account-id>{{MERCHANT_ACCOUNT_ID}}</merchant-account-id>
+  <request-id>{{REQUEST_ID}}</request-id>
+  <transaction-type>debit</transaction-type>
+  <parent-transaction-id>{{PARENT_TRANSACTION_ID}}</parent-transaction-id>
+  <payment-methods>
+    <payment-method name="sepadirectdebit" />
+  </payment-methods>
+  <periodic>
+    <periodic-type>recurring</periodic-type>
+    <sequence-type>recurring</sequence-type>
+  </periodic>
+</payment>

data/lib/wirecard_sepa/config.rb

@@ -0,0 +1,61 @@
+module WirecardSepa
+  # Usage:
+  # WirecardSepa::Config.new({
+  #   http_auth_username: 'foo',
+  #   http_auth_password: 'bar',
+  #   …
+  # })
+  # => 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
+    end
+  end
+end

data/lib/wirecard_sepa/direct_debit/request.rb

@@ -0,0 +1,24 @@
+module WirecardSepa
+  module DirectDebit
+    class Request
+      attr_reader :params
+
+      def initialize(params = {})
+        Utils::ParamsValidator.validate!(params, expected_params)
+        @params = params
+      end
+
+      def to_xml
+        Utils::Template.new(self).to_xml
+      end
+
+      private
+
+      def expected_params
+        %i( merchant_account_id request_id requested_amount
+          account_holder_first_name account_holder_last_name bank_account_iban
+          bank_account_bic mandate_id mandate_signed_date creditor_id )
+      end
+    end
+  end
+end

data/lib/wirecard_sepa/direct_debit/response.rb

@@ -0,0 +1,58 @@
+module WirecardSepa
+  module DirectDebit
+    class Response
+      attr_reader :xml
+
+      def initialize(xml)
+        @xml = xml
+      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,
+          original_response_xml: xml,
+        }
+      end
+
+      def success?
+        status_code == '201.0000'
+      end
+
+      private
+
+      def transaction_id
+        xml_doc.at_css('transaction-id').text
+      end
+
+      def transaction_state
+        xml_doc.at_css('transaction-state').text
+      end
+
+      def status_code
+        xml_doc.at_css('status')[:code]
+      end
+
+      def status_description
+        xml_doc.at_css('status')[:description]
+      end
+
+      def due_date
+        xml_doc.at_css('due-date').text
+      end
+
+      def provider_transaction_reference_id
+        xml_doc.at_css('provider-transaction-reference-id').text
+      end
+
+      def xml_doc
+        @xml_doc ||= Nokogiri::XML xml
+      end
+    end
+  end
+end

data/lib/wirecard_sepa/errors.rb

@@ -0,0 +1,5 @@
+module WirecardSepa
+  module Errors
+    InvalidParamsError = Class.new StandardError
+  end
+end

data/lib/wirecard_sepa/gateway.rb

@@ -0,0 +1,76 @@
+require 'securerandom'
+require 'typhoeus'
+
+module WirecardSepa
+  # Usage:
+  # config = WirecardSepa::Config.new(...)
+  # gateway = WirecardSepa::Gateway.new(config)
+  #
+  # gateway.debit({ requested_amount: 12.12, .. })
+  # => response
+  #
+  # gateway.recurring_init
+  # => response
+  class Gateway
+    attr_accessor :config
+
+    def initialize(config)
+      @config = config
+    end
+
+    def debit(params)
+      request_params = params.merge({
+        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
+    end
+
+    def recurring_init(params)
+      request_params = params.merge({
+        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
+    end
+
+    def recurring_process(params)
+      request_params = params.merge({
+        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
+    end
+
+    private
+
+    def post(request_xml)
+      Typhoeus.post(
+        WirecardSepa.gateway_url,
+        body: request_xml,
+        userpwd: http_auth_credentials,
+      )
+    end
+
+    def request_id
+      # From the Wirecard processing spec:
+      # Type: Alphanumeric, Length: 150
+      # 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
+    end
+
+    def http_auth_credentials
+      [config.http_auth_username, config.http_auth_password].join(':')
+    end
+  end
+end

data/lib/wirecard_sepa/recurring/first_request.rb

@@ -0,0 +1,24 @@
+module WirecardSepa
+  module Recurring
+    class FirstRequest
+      attr_reader :params
+
+      def initialize(params = {})
+        Utils::ParamsValidator.validate!(params, expected_params)
+        @params = params
+      end
+
+      def to_xml
+        Utils::Template.new(self).to_xml
+      end
+
+      private
+
+      def expected_params
+        %i( merchant_account_id request_id requested_amount
+          account_holder_first_name account_holder_last_name bank_account_iban
+          bank_account_bic mandate_id mandate_signed_date creditor_id )
+      end
+    end
+  end
+end

data/lib/wirecard_sepa/recurring/first_response.rb

@@ -0,0 +1,6 @@
+module WirecardSepa
+  module Recurring
+    class FirstResponse < DirectDebit::Response
+    end
+  end
+end

data/lib/wirecard_sepa/recurring/recurring_request.rb

@@ -0,0 +1,22 @@
+module WirecardSepa
+  module Recurring
+    class RecurringRequest
+      attr_reader :params
+
+      def initialize(params = {})
+        Utils::ParamsValidator.validate!(params, expected_params)
+        @params = params
+      end
+
+      def to_xml
+        Utils::Template.new(self).to_xml
+      end
+
+      private
+
+      def expected_params
+        %i( merchant_account_id request_id parent_transaction_id )
+      end
+    end
+  end
+end

data/lib/wirecard_sepa/recurring/recurring_response.rb

@@ -0,0 +1,6 @@
+module WirecardSepa
+  module Recurring
+    class RecurringResponse < DirectDebit::Response
+    end
+  end
+end

data/lib/wirecard_sepa/utils/params_validator.rb

@@ -0,0 +1,18 @@
+module WirecardSepa
+  module Utils
+    module ParamsValidator
+      module_function
+
+      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" +
+            "Unexpected params: #{params.keys - expected_params}"
+          )
+        end
+      end
+    end
+  end
+end