six_saferpay 1.2.1 → 1.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a4dcccfabf4b881707c8da788ba5029fe21eb7767f25437a7f7e27f34c064dbd
-  data.tar.gz: 1f1bc93b10ee325e2dbe154f5d6029ce453dea1523ebd73da2aa201f36cd2824
+  metadata.gz: 1ea96a4a1b6b8e55b6efead411c804f3d1f53988abb0aa6e5ca28b0621045c7f
+  data.tar.gz: 822a87104aee2873660031adc16ebd3cbecbf5158264a0249b8b8862f79756d9
 SHA512:
-  metadata.gz: d6cd5b2df26536d3b1097755a3c1fbfbfcc1391200b23d79d89bdf2af6fe1d4820b57910627665c5a4607047b4e994e8331ba430f462f0c3388a6ca423f7d902
-  data.tar.gz: 78593896fb7e48bd4cf92de1f3045fb0071db325bf5d8357c7528d81aa8a7cc637a6a1aed0da3ff9a5e8bfe168f81f9602e926b8b64e58ad57c835ba308cb69b
+  metadata.gz: 4fa4163aa019b661c4c3a4b7b76905e9bdfe12178b7a49f1c367ca8f1a0b6a786bf59e81278a1fafefd2845ced703a0ad18c46dd25c53b24ff4ae67a7589eeed
+  data.tar.gz: 47316d2aa1028ac01f58bfab01d4f3ad7125bdbc00c4304882c64f33c969617179fc379b73456fe3523aafdcc3bb9b76afc62b6f792535944c24c3bce6617bee

data/README.md

@@ -3,10 +3,6 @@
 
 # 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.
-
-TODO: Delete this and the text above, and describe your gem
-
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -23,9 +19,69 @@ 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.
+
+## Documentation
+
+### SIX Saferpay Transaction
+
+TODO
+
+
+[https://saferpay.github.io/jsonapi](Saferpay JSON API)
 
 ## Development
 

data/lib/six_saferpay/api/six_transaction/requests/authorize.rb

@@ -25,7 +25,7 @@ module SixSaferpay
 
       def to_hash
         hash = Hash.new
-        hash.merge!(request_header: @request_header.to_h) if @register_alias
+        hash.merge!(request_header: @request_header.to_h) if @request_header
         hash.merge!(token: @token) if @token
         hash.merge!(condition: @condition) if @condition
         hash.merge!(verification_code: @verification_code) if @verification_code

data/lib/six_saferpay/version.rb

@@ -1,3 +1,3 @@
 module SixSaferpay
-  VERSION = "1.2.1"
+  VERSION = "1.2.3"
 end

data/six_saferpay.gemspec

@@ -6,12 +6,12 @@ require "six_saferpay/version"
 Gem::Specification.new do |spec|
   spec.name          = "six_saferpay"
   spec.version       = SixSaferpay::VERSION
-  spec.authors       = ["Felix Langenegger"]
+  spec.authors       = ["Fadendaten GmbH", "Felix Langenegger"]
   spec.email         = ["felix.langenegger@fadendaten.ch"]
 
-  spec.summary       = %q{Write a short summary, because RubyGems requires one.}
-  spec.description   = %q{Write a longer description or delete this line.}
-  spec.homepage      = "https://github.com/fadendaten/six_saferpa://github.com/fadendaten/six_saferpay"
+  spec.summary       = %q{Gem for the SIX Saferpay API}
+  spec.description   = %q{This Gem helps you consume the SIX Saferpay API. Accoring the documentation of API of SIX Saferpay you can define your request models and get a response object back.}
+  spec.homepage      = "https://github.com/fadendaten/six_saferpay"
   spec.license       = "MIT"
 
   # Specify which files should be added to the gem when it is released.

metadata

@@ -1,9 +1,10 @@
 --- !ruby/object:Gem::Specification
 name: six_saferpay
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.2.3
 platform: ruby
 authors:
+- Fadendaten GmbH
 - Felix Langenegger
 autorequire: 
 bindir: exe
@@ -188,7 +189,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.1'
-description: Write a longer description or delete this line.
+description: This Gem helps you consume the SIX Saferpay API. Accoring the documentation
+  of API of SIX Saferpay you can define your request models and get a response object
+  back.
 email:
 - felix.langenegger@fadendaten.ch
 executables: []
@@ -295,7 +298,7 @@ files:
 - lib/six_saferpay/models/wallet.rb
 - lib/six_saferpay/version.rb
 - six_saferpay.gemspec
-homepage: https://github.com/fadendaten/six_saferpa://github.com/fadendaten/six_saferpay
+homepage: https://github.com/fadendaten/six_saferpay
 licenses:
 - MIT
 metadata: {}
@@ -318,5 +321,5 @@ rubyforge_project:
 rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
-summary: Write a short summary, because RubyGems requires one.
+summary: Gem for the SIX Saferpay API
 test_files: []