vrpayment-ruby-sdk 5.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1f391ee7e34c75488002ff31aa08da22cfc39fcf7c8c2a9c907cea789a88191c
+  data.tar.gz: 220d81e324fe237eaad173ccc0aa782ce529de5e2e0d4ea259ea4f6561c98b0b
+SHA512:
+  metadata.gz: 80ad219acfccf681c7f794d9b0f66e254998af48fbf835f2359fc093e8e98505bc8d3055b5d86e44f873b566eb3887eef13cba70c9119bebc512cbb2c130ff5a
+  data.tar.gz: 5ff938f866c7ac9a92fda7d59bc887c8ebc321cd3206537ff8783a2108d041124af3263f5bae94897b281fe75117f7dbf3520fc7d3efc812ef547ee94df4fd59

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem 'rake', '~> 13.0.3'
+  gem 'test-unit', '~> 3.3.9'
+end

data/Gemfile.lock

@@ -0,0 +1,55 @@
+PATH
+  remote: .
+  specs:
+    vrpayment-ruby-sdk (5.0.1)
+      addressable (~> 2.3, >= 2.3.0)
+      json (~> 2.3, >= 2.3.0)
+      typhoeus (~> 1.0, >= 1.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.8.7)
+      public_suffix (>= 2.0.2, < 7.0)
+    ethon (0.16.0)
+      ffi (>= 1.15.0)
+    ffi (1.17.2)
+    ffi (1.17.2-aarch64-linux-gnu)
+    ffi (1.17.2-aarch64-linux-musl)
+    ffi (1.17.2-arm-linux-gnu)
+    ffi (1.17.2-arm-linux-musl)
+    ffi (1.17.2-arm64-darwin)
+    ffi (1.17.2-x86-linux-gnu)
+    ffi (1.17.2-x86-linux-musl)
+    ffi (1.17.2-x86_64-darwin)
+    ffi (1.17.2-x86_64-linux-gnu)
+    ffi (1.17.2-x86_64-linux-musl)
+    json (2.13.0)
+    power_assert (2.0.5)
+    public_suffix (6.0.2)
+    rake (13.0.6)
+    test-unit (3.3.9)
+      power_assert
+    typhoeus (1.4.1)
+      ethon (>= 0.9.0)
+
+PLATFORMS
+  aarch64-linux-gnu
+  aarch64-linux-musl
+  arm-linux-gnu
+  arm-linux-musl
+  arm64-darwin
+  ruby
+  x86-linux-gnu
+  x86-linux-musl
+  x86_64-darwin
+  x86_64-linux-gnu
+  x86_64-linux-musl
+
+DEPENDENCIES
+  rake (~> 13.0.3)
+  test-unit (~> 3.3.9)
+  vrpayment-ruby-sdk!
+
+BUNDLED WITH
+   2.5.3

data/LICENSE

@@ -0,0 +1,201 @@
+                                 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 2025 wallee AG
+
+   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,176 @@
+# VR Payment Ruby Library
+
+The VR Payment Ruby library wraps around the VR Payment API. This library facilitates your interaction with various services such as transactions, accounts, and subscriptions.
+
+## Documentation
+
+[VR Payment Web Service API](https://gateway.vr-payment.de/doc/api/web-service)
+
+## Requirements
+
+- Ruby 3.0.0+
+
+## Installation
+
+# RubyGem install (recommended)
+
+```sh
+$ gem install vrpayment-ruby-sdk
+```
+
+## Usage
+The library needs to be configured with your account's space id, user id, and secret key which are available in your [VR Payment
+account dashboard](https://gateway.vr-payment.de/account/select). Set `space_id`, `user_id`, and `api_secret` to their values. You can also optionally set `default_headers` to set some headers that will be sent to all requests:
+
+### Configuring a Service
+
+```ruby
+require 'vrpayment-ruby-sdk'
+
+space_id = 405
+app_user_id = 512
+app_user_key = "FKrO76r5VwJtBrqZawBspljbBNOxp5veKQQkOnZxucQ="
+
+# default_headers is an optional param, that represents headers sent to all requests
+# timeout is an optional param, that allows to configure custom timeout (default is 25 seconds)
+VRPayment.configure do |config|
+  config.user_id = app_user_id
+  config.authentication_key = app_user_key
+  config.default_headers = {"x-meta-custom-header": 'value-1', "x-meta-custom-header-2": 'value-2'}
+  config.timeout = 60
+end
+
+# TransactionService
+transaction_service = VRPayment::TransactionService.new
+# TransactionPaymentPageService
+transaction_payment_page_service = VRPayment::TransactionPaymentPageService.new
+```
+
+To get stated with sending transactions you can review the example below:
+
+```ruby
+require 'vrpayment-ruby-sdk'
+
+space_id = 405
+app_user_id = 512
+app_user_key = "FKrO76r5VwJtBrqZawBspljbBNOxp5veKQQkOnZxucQ="
+
+# timeout is an optional param, that allows to configure custom timeout (default is 25 seconds)
+VRPayment.configure do |config|
+    config.user_id = app_user_id
+    config.authentication_key = app_user_key
+    config.timeout = 60
+end
+
+# TransactionService
+transaction_service = VRPayment::TransactionService.new
+# TransactionPaymentPageService
+transaction_payment_page_service = VRPayment::TransactionPaymentPageService.new
+
+transaction = VRPayment::TransactionCreate.new({
+    billingAddress: VRPayment::AddressCreate.new({
+        city: "City",
+        country: "US",
+        emailAddress: "billing@address.com",
+        familyName: "Family",
+        givenName: "Given",
+        postCode: "98100",
+        postalState: "WA",
+        street: "Street"
+    }),
+    currency: 'EUR',
+    customerEmailAddress: "test@example.com",
+    customerPresence: VRPayment::CustomersPresence::VIRTUAL_PRESENT,
+    failedUrl: "http://localhost/failure",
+    invoiceMerchantReference: "order-1",
+    language: "en_US",
+    lineItems: [
+        VRPayment::LineItemCreate.new({
+            amountIncludingTax: 29.60,
+            name: "Item 1",
+            quantity: 1,
+            shippingRequired: true,
+            sku: "sku-1",
+            taxes: [
+                VRPayment::TaxCreate.new({
+                    rate: 8,
+                    title: "VAT"
+                })
+            ],
+            type: VRPayment::LineItemType::PRODUCT,
+            uniqueId: "unique-id-item-1",
+        }),
+        VRPayment::LineItemCreate.new({
+            amountIncludingTax: 5.60,
+            name: "Test Shipping",
+            quantity: 1,
+            shippingRequired: false,
+            sku: "test-shipping",
+            taxes: [
+                VRPayment::TaxCreate.new({
+                    rate: 8,
+                    title: "VAT"
+                })
+            ],
+            type: VRPayment::LineItemType::SHIPPING,
+            uniqueId: "unique-id-shipping-1",
+        }),
+    ],
+    merchantReference: "order-1",
+    shippingAddress: VRPayment::AddressCreate.new({
+        city: "City",
+        country: "US",
+        emailAddress: "shipping@address.com",
+        familyName: "Family",
+        givenName: "Given",
+        postCode: "98100",
+        postalState: "WA",
+        street: "Street"
+    }),
+    shippingMethod: "Test Shipping",
+    successUrl: "http://localhost/success"
+})
+
+transaction = transaction_service.create(space_id, transaction)
+payment_page_url = transaction_payment_page_service.payment_page_url(space_id, transaction.id)
+# redirect to payment_page_url
+```
+
+### Integrating Webhook Payload Signing Mechanism into webhook callback handler
+
+The HTTP request which is sent for a state change of an entity now includes an additional field `state`, which provides information about the update of the monitored entity's state. This enhancement is a result of the implementation of our webhook encryption mechanism.
+
+Payload field `state` provides direct information about the state update of the entity, making additional API calls to retrieve the entity state redundant.
+
+#### ⚠️ Warning: Generic Pseudocode
+
+> **The provided pseudocode is intentionally generic and serves to illustrate the process of enhancing your API to leverage webhook payload signing. It is not a complete implementation.**
+>
+> Please ensure that you adapt and extend this code to meet the specific needs of your application, including appropriate security measures and error handling.
+For a detailed webhook payload signing mechanism understanding we highly recommend referring to our comprehensive
+[Webhook Payload Signing Documentation](https://gateway.vr-payment.de/doc/webhooks#_webhook_payload_signing_mechanism).
+
+```ruby
+post '/webhook/callback' do
+    request_payload = request.body.read
+    signature = request.env['HTTP_X_SIGNATURE']
+
+    if signature.nil? || signature.empty?
+        # Make additional API call to retrieve the entity state
+        # ...
+    else
+        if webhook_encryption_service.is_content_valid(signature, request_payload)
+            # Parse request_payload to extract 'state' value
+            # Process entity's state change
+            # ...
+        end
+    end
+
+    # Process the received webhook data
+    # ...
+end
+```
+
+## License
+
+Please see the [license file](https://github.com/vr-payment/ruby-sdk/blob/master/LICENSE) for more information.

data/Rakefile

@@ -0,0 +1,14 @@
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs = ["lib"]
+  t.warning = true
+  t.verbose = true
+  t.test_files = FileList['test/*_test.rb']
+  t.options = "-v --stop-on-failure"
+end
+
+
+task default: %w[test]
+
+