six_saferpay 1.2.1 → 1.16.2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a4dcccfabf4b881707c8da788ba5029fe21eb7767f25437a7f7e27f34c064dbd
-  data.tar.gz: 1f1bc93b10ee325e2dbe154f5d6029ce453dea1523ebd73da2aa201f36cd2824
+  metadata.gz: acfb2585b43dd7064f81b0485286f48e2c4b554c7f2d0fe1025bc5eb0cbd4c64
+  data.tar.gz: 904a6c58a9da762f04bc601292d89a6dfa27722678f3bcb9ca4146612142184d
 SHA512:
-  metadata.gz: d6cd5b2df26536d3b1097755a3c1fbfbfcc1391200b23d79d89bdf2af6fe1d4820b57910627665c5a4607047b4e994e8331ba430f462f0c3388a6ca423f7d902
-  data.tar.gz: 78593896fb7e48bd4cf92de1f3045fb0071db325bf5d8357c7528d81aa8a7cc637a6a1aed0da3ff9a5e8bfe168f81f9602e926b8b64e58ad57c835ba308cb69b
+  metadata.gz: 835973e42bb94eba81cc077a63318b195c89f4f0c35e287fdb38371b641f62317891b9781070199948454047050af115874b8500ca7f5a5b022906743647241f
+  data.tar.gz: 542f2e7bcd9781054756cd5e623030cecbc0d98b31201e10d3c2f27055101a1e765c7c92483fbb91e7ee163eea3c67f8bf49bb875a8df248617c17a30dfa05f6

data/.ruby-version

@@ -1 +1 @@
-2.5.1
+2.7.2

data/.test.env

@@ -1,5 +1,5 @@
 SIX_SAFERPAY_CUSTOMER_ID='245294'
-SIX_SAFERPAY_TERMINAL_ID='17925560'
+SIX_SAFERPAY_TERMINAL_ID='17925578'
 SIX_SAFERPAY_USERNAME='API_245294_08700063'
 SIX_SAFERPAY_PASSWORD='mei4Xoozle4doi0A'
 SIX_SAFERPAY_FAIL_URL='http://localhost:3004'

data/.travis.yml

@@ -3,8 +3,10 @@ sudo: false
 language: ruby
 cache: bundler
 rvm:
-  - 2.5.0
-before_install: gem install bundler -v 2.0.1
+  - 2.7.2
+
+before_install:
+  - gem install bundler:2.2.8
 
 notifications:
   slack: fadendaten:tWoet2mtObvbwSZSyUAY93jl

data/Gemfile.lock

@@ -1,112 +1,97 @@
 PATH
   remote: .
   specs:
-    six_saferpay (1.2.1)
-      activesupport (~> 5.0, >= 5.0.0.0)
+    six_saferpay (1.16.2.4.0)
+      activesupport (~> 6.1, >= 6.1.3)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (5.2.3)
+    activesupport (6.1.3)
       concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-    addressable (2.6.0)
-      public_suffix (>= 2.0.2, < 4.0)
-    coderay (1.1.2)
-    concurrent-ruby (1.1.5)
-    crack (0.4.3)
-      safe_yaml (~> 1.0.0)
-    diff-lcs (1.3)
-    docile (1.3.1)
-    dotenv (2.7.1)
-    equatable (0.5.0)
-    ffi (1.10.0-java)
-    hashdiff (0.3.8)
-    i18n (1.6.0)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    coderay (1.1.3)
+    concurrent-ruby (1.1.8)
+    crack (0.4.5)
+      rexml
+    diff-lcs (1.4.4)
+    docile (1.3.5)
+    dotenv (2.7.6)
+    hashdiff (1.0.1)
+    i18n (1.8.9)
       concurrent-ruby (~> 1.0)
-    json (2.2.0)
-    json (2.2.0-java)
-    method_source (0.9.2)
-    minitest (5.11.3)
-    necromancer (0.4.0)
-    pastel (0.7.2)
-      equatable (~> 0.5.0)
-      tty-color (~> 0.4.0)
-    pry (0.12.2)
-      coderay (~> 1.1.0)
-      method_source (~> 0.9.0)
-    pry (0.12.2-java)
-      coderay (~> 1.1.0)
-      method_source (~> 0.9.0)
-      spoon (~> 0.0)
-    public_suffix (3.0.3)
-    rake (10.5.0)
-    rspec (3.8.0)
-      rspec-core (~> 3.8.0)
-      rspec-expectations (~> 3.8.0)
-      rspec-mocks (~> 3.8.0)
-    rspec-core (3.8.0)
-      rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.2)
+    method_source (1.0.0)
+    minitest (5.14.3)
+    pastel (0.8.0)
+      tty-color (~> 0.5)
+    pry (0.14.0)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    public_suffix (4.0.6)
+    rake (13.0.3)
+    rexml (3.2.4)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-support (3.8.0)
-    safe_yaml (1.0.5)
-    simplecov (0.16.1)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    simplecov (0.21.2)
       docile (~> 1.1)
-      json (>= 1.8, < 3)
-      simplecov-html (~> 0.10.0)
-    simplecov-html (0.10.2)
-    spinning_wheel (0.2.0)
-      activesupport (~> 5.0, >= 5.0.0.0)
-    spoon (0.0.6)
-      ffi
-    thread_safe (0.3.6)
-    thread_safe (0.3.6-java)
-    timers (4.3.0)
-    tty-color (0.4.3)
-    tty-cursor (0.6.1)
-    tty-prompt (0.18.1)
-      necromancer (~> 0.4.0)
-      pastel (~> 0.7.0)
-      timers (~> 4.0)
-      tty-cursor (~> 0.6.0)
-      tty-reader (~> 0.5.0)
-    tty-reader (0.5.0)
-      tty-cursor (~> 0.6.0)
-      tty-screen (~> 0.6.4)
-      wisper (~> 2.0.0)
-    tty-screen (0.6.5)
-    tzinfo (1.2.5)
-      thread_safe (~> 0.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.2)
+    spinning_wheel (0.2.2)
+      activesupport (>= 5.2.4.3)
+    tty-color (0.6.0)
+    tty-cursor (0.7.1)
+    tty-prompt (0.23.0)
+      pastel (~> 0.8)
+      tty-reader (~> 0.8)
+    tty-reader (0.9.0)
+      tty-cursor (~> 0.7)
+      tty-screen (~> 0.8)
+      wisper (~> 2.0)
+    tty-screen (0.8.1)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
     vcr (4.0.0)
-    webmock (3.5.1)
+    webmock (3.11.2)
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
-      hashdiff
-    wisper (2.0.0)
+      hashdiff (>= 0.4.0, < 2.0.0)
+    wisper (2.0.1)
+    zeitwerk (2.4.2)
 
 PLATFORMS
   java
   ruby
 
 DEPENDENCIES
-  bundler (~> 2.0)
+  bundler (~> 2.1)
   dotenv (~> 2.7, >= 2.7)
-  pry (~> 0.12.0)
-  rake (~> 10.0)
+  pry (~> 0.13)
+  rake (~> 13.0)
   rspec (~> 3.0)
-  simplecov (~> 0.16)
+  simplecov (~> 0.19)
   six_saferpay!
-  spinning_wheel (~> 0.1)
-  tty-prompt (~> 0.18)
+  spinning_wheel (~> 0.2.2)
+  tty-prompt (~> 0.22)
   vcr (~> 4.0, >= 4.0.0)
-  webmock (~> 3.5, >= 3.5.1)
+  webmock (~> 3.10, >= 3.10)
 
 BUNDLED WITH
-   2.0.1
+   2.2.8

data/README.md

@@ -1,11 +1,12 @@
+[![Gem Version](https://badge.fury.io/rb/six_saferpay.svg)](https://badge.fury.io/rb/six_saferpay)
 [![Build Status](https://travis-ci.org/fadendaten/six_saferpay.svg?branch=master)](https://travis-ci.org/fadendaten/six_saferpay)
 [![Maintainability](https://api.codeclimate.com/v1/badges/76c9d1d0f261c276de96/maintainability)](https://codeclimate.com/github/fadendaten/six_saferpay/maintainability)
 
 # SixSaferpay
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/six_saferpay`. To experiment with that code, run `bin/console` for an interactive prompt.
+## Current API Version
 
-TODO: Delete this and the text above, and describe your gem
+This gem is compatible with the SIX API version: `1.16`
 
 ## Installation
 
@@ -23,9 +24,77 @@ Or install it yourself as:
 
     $ gem install six_saferpay
 
+
+## Configuration
+
+Please configure your gem:
+
+```ruby
+SixSaferpay.configure do |config|
+  config.customer_id = YOUR_SIX_SAFERPAY_CUSTOMER_ID
+  config.terminal_id = YOUR_SIX_SAFERPAY_TERMINAL_ID
+  config.username = YOUR_SIX_SAFERPAY_USERNAME
+  config.password = YOUR_SIX_SAFERPAY_PASSWORD
+  config.success_url = YOUR_SIX_SAFERPAY_SUCCESS_URL
+  config.fail_url = YOUR_SIX_SAFERPAY_FAIL_URL
+  config.base_url = YOUR_SIX_SAFERPAY_BASE_URL
+  config.css_url = YOUR_SIX_SAFERPAY_CSS_URL
+end
+
+```
+
 ## Usage
 
-TODO: Write usage instructions here
+SIX Saferpay provides multiple interfaces. We give you a short introduction in the usage of the gem by showing you two examples for the initialize requests.
+
+### SIX Saferpay Payment Page
+
+The SIX Saferpay Payment Page is a simple implementation of the payment gateway of SIX.
+
+#### PaymentPage Initialize
+
+Before we start we have to create a two basic objects. The first object is the ```SixSaferpay::Amount```. This object represents the value of your cart in the currency you sell your products. The second object is the ```SixSaferpay::Payment```. This object represents the payment a user of your shop will do. As you can see, the amount object is includes in this object.
+
+```ruby
+amount = SixSaferpay::Amount.new(value: 100, currency_code: "CHF")
+payment = SixSaferpay::Payment.new(amount: amount, order_id: 1234, description: 'Order #1234')
+```
+
+After we create those two objects, we can create the initialize object for the SIX Saferpay Payment Page.
+
+```ruby
+initialize = SixSaferpay::SixPaymentPage::Initialize.new(payment: payment)
+```
+
+Now we can send the initialize request to the API. We can use the client object to send a post request to the API.
+
+```ruby
+initialize_response = SixSaferpay::Client.post(initialize)
+```
+The client will return a response object. After an initialize request, the client will return you a initialize response object (```SixSaferpay::InitializeResponse```).
+
+If the request goes wrong the client raises a ```SixSaferpay::Error```
+
+#### Other Requests
+
+You will find for all the other requests an predefined object. Feel free to use this according the SIX Saferpay API documentation.
+
+### SIX Saferpay Transaction
+
+TODO
+
+#### SIX Secure PayGate API
+
+If you want to use the SIX Secure PayGate API, you have to use an other Client:
+
+```ruby
+create_offer_request = SixSaferpay::SecurePayGateOffer.new(...)
+create_offer_response = SixSaferpay::SecurePayGateApi::Client.new(create_offer_request)
+```
+
+## Documentation
+
+[SIX Saferpay JSON API](https://saferpay.github.io/jsonapi)
 
 ## Development
 
@@ -37,6 +106,54 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/six_saferpay.
 
+### Implementation Status
+
+#### SIX Payment Page
+
+- [x] Initialize
+- [x] Assert
+
+#### SIX Transaction
+
+- [x] Initialize
+- [x] Authorize
+- [x] QueryPaymentMeans
+- [x] AdjustAmount
+- [x] AuthorizeDirect
+- [x] AuthorizeReferenced
+- [x] Capture
+- [x] MultipartCapture
+- [x] AssertCapture
+- [x] MultipartFinalize
+- [x] Refund
+- [x] AssertRefund
+- [x] RefundDirect
+- [x] Cancel
+- ~~RedirectPayment~~ (Deprecated)
+- ~~AssertRedirectPayment~~ (Deprecated)
+- [x] Inquire
+
+#### SIX Secure Card Data
+
+- [x] Insert
+- [x] AssertInsert
+- [x] InsertDirect
+- [x] Delete
+
+#### SIX Batch
+
+- [x] Close
+
+#### SIX OmniChannel
+
+- [x] InsertAlias
+- [x] AcquireTransaction
+
+#### Secure PayGate API
+
+- [x] CreateOffer
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+

data/lib/six_saferpay/api.rb

@@ -1,5 +1,5 @@
 module SixSaferpay
   module API
-    VERSION = '1.11'
+    VERSION = '1.16'
   end
 end

data/lib/six_saferpay/api/six_batch/requests/close.rb

@@ -0,0 +1,37 @@
+module SixSaferpay
+  module SixBatch
+    class Close
+
+      attr_accessor(:request_header,
+                    :terminal_id
+                   )
+
+      def initialize(request_header: nil,
+                     terminal_id: )
+        @request_header = request_header || SixSaferpay::RequestHeader.new()
+        @terminal_id = terminal_id
+      end
+
+      def to_hash
+        hash = Hash.new
+        hash.merge!(request_header: @request_header.to_h) if @request_header
+        hash.merge!(terminal_id: @terminal_id) if @terminal_id
+        hash
+      end
+      alias_method :to_h, :to_hash
+
+      def to_json
+        to_hash.to_json
+      end
+
+      def url
+        '/Payment/v1/Batch/Close'
+      end
+
+      def response_class
+        SixSaferpay::SixBatch::CloseResponse
+      end
+
+    end
+  end
+end

data/lib/six_saferpay/api/six_batch/responses/close_response.rb

@@ -0,0 +1,20 @@
+module SixSaferpay
+  module SixBatch
+    class CloseResponse
+
+      attr_accessor(:response_header)
+
+      def initialize(response_header:)
+        @response_header = SixSaferpay::ResponseHeader.new(response_header.to_h)
+      end
+
+      def to_hash
+        hash = Hash.new
+        hash.merge!(response_header: @response_header.to_h)
+        hash
+      end
+      alias_method :to_h, :to_hash
+
+    end
+  end
+end

data/lib/six_saferpay/api/six_omni_channel/requests/acquire_transaction.rb

@@ -0,0 +1,46 @@
+module SixSaferpay
+  module SixOmniChannel
+    class AcquireTransaction
+
+      attr_accessor(:request_header,
+                    :terminal_id,
+                    :order_id,
+                    :six_transaction_reference
+                   )
+
+      def initialize(request_header: nil,
+                     terminal_id:,
+                     order_id: nil,
+                     six_transaction_reference:
+                    )
+        @request_header = request_header || SixSaferpay::RequestHeader.new()
+        @terminal_id = terminal_id
+        @order_id = order_id
+        @six_transaction_reference = six_transaction_reference
+      end
+
+      def to_hash
+        hash = Hash.new
+        hash.merge!(request_header: @request_header.to_h) if @request_header
+        hash.merge!(terminal_id: @terminal_id) if @terminal_id
+        hash.merge!(order_id: @order_id) if @order_id
+        hash.merge!(six_transaction_reference: @six_transaction_reference) if @six_transaction_reference
+        hash
+      end
+      alias_method :to_h, :to_hash
+
+      def to_json
+        to_hash.to_json
+      end
+
+      def url
+        '/Payment/v1/OmniChannel/AcquireTransaction'
+      end
+
+      def response_class
+        SixSaferpay::SixOmniChannel::AcquireTransactionResponse
+      end
+
+    end
+  end
+end