postfinancecheckout-ruby-sdk 3.1.5 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ce058a5c6ddfdfc656822dede786073211a0b7a9
-  data.tar.gz: a4b0ab764fca6ebcbfc4e21496884e5c69b30d5c
+  metadata.gz: fe47f059c81b6761cfd9fb7e0a42401b2009d8cf
+  data.tar.gz: c0203015d18d0ac365b42f4b98dd3566c73cb0c9
 SHA512:
-  metadata.gz: 279f8f01b37d57ddffd60ebec243c23c96591927ccd7009a32aae090dfc86c5cea1f45f8e66906ec0bddbb73128a33a96b7f989cd6959248902eca8127b51838
-  data.tar.gz: 7f9a4bbd8a33349a81aa606cf7841952d39839ebcab3fbd1519fc8e8a8e5850e4991f93a8bdfc1c606692bc470a6e0498dcd431747352a04dcbac0817d8116fd
+  metadata.gz: ef7c006c7e6ba469ed5aad3b05125cccc20b3227ea3d47f7a31696af6f37f548c75a5a39ce900c6f45018e527a7f7eef8285ecb2c6699eb0585820587422883b
+  data.tar.gz: 07fbccd5c3b759f19c52e151857b1847c06043252ab972452e77de4b1bdcd732eb8d32867d8043347c38bb1a23ca4c4ae083aee6ec4d79bf647b13499debd555

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    postfinancecheckout-ruby-sdk (3.1.5)
+    postfinancecheckout-ruby-sdk (3.2.0)
       addressable (~> 2.3, >= 2.3.0)
       json (~> 2.3, >= 2.3.0)
       typhoeus (~> 1.0, >= 1.0.1)

data/README.md

@@ -20,7 +20,7 @@ $ gem install postfinancecheckout-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 [PostFinance Checkout
-account dashboard](https://checkout.postfinance.ch/account/select). Set `space_id`, `user_id`, and `api_secret` to their values:
+account dashboard](https://checkout.postfinance.ch/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
 
@@ -31,9 +31,11 @@ space_id = 405
 app_user_id = 512
 app_user_key = "FKrO76r5VwJtBrqZawBspljbBNOxp5veKQQkOnZxucQ="
 
+# default_headers is an optional param, that represents headers sent to all requests
 PostFinanceCheckout.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'}
 end
 
 # TransactionService

data/lib/postfinancecheckout-ruby-sdk/api_client.rb

@@ -44,6 +44,9 @@ module PostFinanceCheckout
         'Content-Type' => "application/json",
         'User-Agent' => @user_agent
       }
+      config.default_headers.each do |key, value|
+        @default_headers[key] = value
+      end
     end
 
     def self.default
@@ -98,7 +101,16 @@ module PostFinanceCheckout
       url = build_request_url(path)
       http_method = http_method.to_sym.downcase
 
+      default_headers = {
+        'x-meta-sdk-version': "3.2.0",
+        'x-meta-sdk-language': "ruby",
+        'x-meta-sdk-provider': "PostFinance Checkout",
+        'x-meta-sdk-language-version': RUBY_VERSION
+      }
+
       header_params = @default_headers.merge(opts[:header_params] || {})
+      header_params = header_params.merge(default_headers)
+
       query_params = opts[:query_params] || {}
       form_params = opts[:form_params] || {}
 

data/lib/postfinancecheckout-ruby-sdk/configuration.rb

@@ -90,7 +90,9 @@ module PostFinanceCheckout
 
     attr_accessor :force_ending_format
 
-    def initialize
+    attr_accessor :default_headers
+
+    def initialize(default_headers = {})
       @scheme = 'https'
       @host = 'checkout.postfinance.ch:443'
       @base_path = '/api'
@@ -102,6 +104,7 @@ module PostFinanceCheckout
       @inject_format = false
       @force_ending_format = false
       @logger = defined?(Rails) ? Rails.logger : Logger.new(STDOUT)
+      @default_headers = default_headers
 
       yield(self) if block_given?
     end

data/lib/postfinancecheckout-ruby-sdk/models/transaction_completion.rb

@@ -95,6 +95,9 @@ module PostFinanceCheckout
     # 
     attr_accessor :state
 
+    # The statement descriptor explain charges or payments on bank statements.
+    attr_accessor :statement_descriptor
+
     # 
     attr_accessor :succeeded_on
 
@@ -138,6 +141,7 @@ module PostFinanceCheckout
         :'remaining_line_items' => :'remainingLineItems',
         :'space_view_id' => :'spaceViewId',
         :'state' => :'state',
+        :'statement_descriptor' => :'statementDescriptor',
         :'succeeded_on' => :'succeededOn',
         :'tax_amount' => :'taxAmount',
         :'time_zone' => :'timeZone',
@@ -174,6 +178,7 @@ module PostFinanceCheckout
         :'remaining_line_items' => :'Array<LineItem>',
         :'space_view_id' => :'Integer',
         :'state' => :'TransactionCompletionState',
+        :'statement_descriptor' => :'String',
         :'succeeded_on' => :'DateTime',
         :'tax_amount' => :'Float',
         :'time_zone' => :'String',
@@ -298,6 +303,10 @@ module PostFinanceCheckout
         self.state = attributes[:'state']
       end
 
+      if attributes.has_key?(:'statementDescriptor')
+        self.statement_descriptor = attributes[:'statementDescriptor']
+      end
+
       if attributes.has_key?(:'succeededOn')
         self.succeeded_on = attributes[:'succeededOn']
       end
@@ -335,6 +344,10 @@ module PostFinanceCheckout
         invalid_properties.push('invalid value for "invoice_merchant_reference", the character length must be smaller than or equal to 100.')
       end
 
+      if !@statement_descriptor.nil? && @statement_descriptor.to_s.length > 22
+        invalid_properties.push('invalid value for "statement_descriptor", the character length must be smaller than or equal to 22.')
+      end
+
       invalid_properties
     end
 
@@ -344,6 +357,7 @@ module PostFinanceCheckout
       return false if !@external_id.nil? && @external_id.to_s.length > 100
       return false if !@external_id.nil? && @external_id.to_s.length < 1
       return false if !@invoice_merchant_reference.nil? && @invoice_merchant_reference.to_s.length > 100
+      return false if !@statement_descriptor.nil? && @statement_descriptor.to_s.length > 22
       true
     end
 
@@ -371,6 +385,16 @@ module PostFinanceCheckout
       @invoice_merchant_reference = invoice_merchant_reference
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] statement_descriptor Value to be assigned
+    def statement_descriptor=(statement_descriptor)
+      if !statement_descriptor.nil? && statement_descriptor.to_s.length > 22
+        fail ArgumentError, 'invalid value for "statement_descriptor", the character length must be smaller than or equal to 22.'
+      end
+
+      @statement_descriptor = statement_descriptor
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
@@ -401,6 +425,7 @@ module PostFinanceCheckout
           remaining_line_items == o.remaining_line_items &&
           space_view_id == o.space_view_id &&
           state == o.state &&
+          statement_descriptor == o.statement_descriptor &&
           succeeded_on == o.succeeded_on &&
           tax_amount == o.tax_amount &&
           time_zone == o.time_zone &&
@@ -417,7 +442,7 @@ module PostFinanceCheckout
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [id, linked_space_id, linked_transaction, amount, base_line_items, created_by, created_on, external_id, failed_on, failure_reason, invoice_merchant_reference, labels, language, last_completion, line_item_version, line_items, mode, next_update_on, payment_information, planned_purge_date, processing_on, processor_reference, remaining_line_items, space_view_id, state, succeeded_on, tax_amount, time_zone, timeout_on, version].hash
+      [id, linked_space_id, linked_transaction, amount, base_line_items, created_by, created_on, external_id, failed_on, failure_reason, invoice_merchant_reference, labels, language, last_completion, line_item_version, line_items, mode, next_update_on, payment_information, planned_purge_date, processing_on, processor_reference, remaining_line_items, space_view_id, state, statement_descriptor, succeeded_on, tax_amount, time_zone, timeout_on, version].hash
     end
 
     # Builds the object from hash

data/lib/postfinancecheckout-ruby-sdk/models/transaction_completion_request.rb

@@ -32,6 +32,9 @@ module PostFinanceCheckout
     # The line items which will be used to complete the transaction.
     attr_accessor :line_items
 
+    # The statement descriptor explain charges or payments on bank statements.
+    attr_accessor :statement_descriptor
+
     # The ID of the transaction which should be completed.
     attr_accessor :transaction_id
 
@@ -42,6 +45,7 @@ module PostFinanceCheckout
         :'invoice_merchant_reference' => :'invoiceMerchantReference',
         :'last_completion' => :'lastCompletion',
         :'line_items' => :'lineItems',
+        :'statement_descriptor' => :'statementDescriptor',
         :'transaction_id' => :'transactionId'
       }
     end
@@ -53,6 +57,7 @@ module PostFinanceCheckout
         :'invoice_merchant_reference' => :'String',
         :'last_completion' => :'BOOLEAN',
         :'line_items' => :'Array<CompletionLineItemCreate>',
+        :'statement_descriptor' => :'String',
         :'transaction_id' => :'Integer'
       }
     end
@@ -83,6 +88,10 @@ module PostFinanceCheckout
         end
       end
 
+      if attributes.has_key?(:'statementDescriptor')
+        self.statement_descriptor = attributes[:'statementDescriptor']
+      end
+
       if attributes.has_key?(:'transactionId')
         self.transaction_id = attributes[:'transactionId']
       end
@@ -112,6 +121,10 @@ module PostFinanceCheckout
         invalid_properties.push('invalid value for "last_completion", last_completion cannot be nil.')
       end
 
+      if !@statement_descriptor.nil? && @statement_descriptor.to_s.length > 22
+        invalid_properties.push('invalid value for "statement_descriptor", the character length must be smaller than or equal to 22.')
+      end
+
       if @transaction_id.nil?
         invalid_properties.push('invalid value for "transaction_id", transaction_id cannot be nil.')
       end
@@ -127,6 +140,7 @@ module PostFinanceCheckout
       return false if @external_id.to_s.length < 1
       return false if !@invoice_merchant_reference.nil? && @invoice_merchant_reference.to_s.length > 100
       return false if @last_completion.nil?
+      return false if !@statement_descriptor.nil? && @statement_descriptor.to_s.length > 22
       return false if @transaction_id.nil?
       true
     end
@@ -159,6 +173,16 @@ module PostFinanceCheckout
       @invoice_merchant_reference = invoice_merchant_reference
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] statement_descriptor Value to be assigned
+    def statement_descriptor=(statement_descriptor)
+      if !statement_descriptor.nil? && statement_descriptor.to_s.length > 22
+        fail ArgumentError, 'invalid value for "statement_descriptor", the character length must be smaller than or equal to 22.'
+      end
+
+      @statement_descriptor = statement_descriptor
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
@@ -168,6 +192,7 @@ module PostFinanceCheckout
           invoice_merchant_reference == o.invoice_merchant_reference &&
           last_completion == o.last_completion &&
           line_items == o.line_items &&
+          statement_descriptor == o.statement_descriptor &&
           transaction_id == o.transaction_id
     end
 
@@ -180,7 +205,7 @@ module PostFinanceCheckout
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [external_id, invoice_merchant_reference, last_completion, line_items, transaction_id].hash
+      [external_id, invoice_merchant_reference, last_completion, line_items, statement_descriptor, transaction_id].hash
     end
 
     # Builds the object from hash

data/lib/postfinancecheckout-ruby-sdk/version.rb

@@ -16,5 +16,5 @@ limitations under the License.
 =end
 
 module PostFinanceCheckout
-  VERSION = '3.1.5'
+  VERSION = '3.2.0'
 end

data/test/condition_type_service_test.rb

@@ -11,6 +11,7 @@ class TestConditionTypeAll < Test::Unit::TestCase
     PostFinanceCheckout.configure do |config|
       config.user_id = app_user_id
       config.authentication_key = app_user_key
+      config.default_headers = {"x-meta-header-ruby": 'value', "x-meta-header-ruby-2": 'value2'}
     end
 
     condition_type_service = PostFinanceCheckout::ConditionTypeService.new

data/test/transaction_create_service_test.rb

@@ -12,6 +12,7 @@ class TestTransactionCreate < Test::Unit::TestCase
     PostFinanceCheckout.configure do |config|
       config.user_id = app_user_id
       config.authentication_key = app_user_key
+      config.default_headers = {"x-meta-header-ruby": 'value', "x-meta-header-ruby-2": 'value2'}
     end
 
     transaction_service = PostFinanceCheckout::TransactionService.new

data/test/transaction_payment_page_service_test.rb

@@ -12,6 +12,7 @@ class TestTransactionCreate < Test::Unit::TestCase
     PostFinanceCheckout.configure do |config|
       config.user_id = app_user_id
       config.authentication_key = app_user_key
+      config.default_headers = {"x-meta-header-ruby": 'value', "x-meta-header-ruby-2": 'value2'}
     end
 
     transaction_service = PostFinanceCheckout::TransactionService.new

data/vendor/bundle/ruby/2.4.0/extensions/x86_64-linux/2.4.0/ffi-1.15.5/gem_make.out

@@ -1,5 +1,5 @@
 current directory: /home/runner/work/ruby-sdk/ruby-sdk/vendor/bundle/ruby/2.4.0/gems/ffi-1.15.5/ext/ffi_c
-/opt/hostedtoolcache/Ruby/2.4.1/x64/bin/ruby -r ./siteconf20220920-1751-lscnl2.rb extconf.rb
+/opt/hostedtoolcache/Ruby/2.4.1/x64/bin/ruby -r ./siteconf20221004-1672-1r0gzc9.rb extconf.rb
 checking for ffi.h... yes
 checking for ffi_prep_closure_loc() in -lffi... yes
 checking for ffi_prep_cif_var()... yes
@@ -367,4 +367,4 @@ linking shared-object ffi_c.so
 
 current directory: /home/runner/work/ruby-sdk/ruby-sdk/vendor/bundle/ruby/2.4.0/gems/ffi-1.15.5/ext/ffi_c
 make "DESTDIR=" install
-/usr/bin/install -c -m 0755 ffi_c.so ./.gem.20220920-1751-qm4buv
+/usr/bin/install -c -m 0755 ffi_c.so ./.gem.20221004-1672-e9ihcz

data/vendor/bundle/ruby/2.4.0/extensions/x86_64-linux/2.4.0/json-2.6.2/gem_make.out

@@ -1,5 +1,5 @@
 current directory: /home/runner/work/ruby-sdk/ruby-sdk/vendor/bundle/ruby/2.4.0/gems/json-2.6.2/ext/json
-/opt/hostedtoolcache/Ruby/2.4.1/x64/bin/ruby -r ./siteconf20220920-1751-1bldj0t.rb extconf.rb
+/opt/hostedtoolcache/Ruby/2.4.1/x64/bin/ruby -r ./siteconf20221004-1672-1xl6znz.rb extconf.rb
 creating Makefile
 
 current directory: /home/runner/work/ruby-sdk/ruby-sdk/vendor/bundle/ruby/2.4.0/gems/json-2.6.2/ext/json

data/vendor/bundle/ruby/2.4.0/extensions/x86_64-linux/2.4.0/json-2.6.2/mkmf.log

@@ -176,7 +176,7 @@ In file included from /opt/hostedtoolcache/Ruby/2.4.1/x64/include/ruby-2.4.0/rub
 cc1: warning: unrecognized command line option ‘-Wno-self-assign’
 cc1: warning: unrecognized command line option ‘-Wno-constant-logical-operand’
 cc1: warning: unrecognized command line option ‘-Wno-parentheses-equality’
-/usr/bin/ld: /tmp/ccVSR7ZN.o: in function `t':
+/usr/bin/ld: /tmp/cczRQGNV.o: in function `t':
 /home/runner/work/ruby-sdk/ruby-sdk/vendor/bundle/ruby/2.4.0/gems/json-2.6.2/ext/json/ext/parser/conftest.c:16: undefined reference to `rb_enc_interned_str'
 collect2: error: ld returned 1 exit status
 checked program was:

data/vendor/bundle/ruby/2.4.0/gems/ffi-1.15.5/ext/ffi_c/Makefile

@@ -31,8 +31,8 @@ rubyhdrdir = $(includedir)/$(RUBY_VERSION_NAME)
 vendorarchdir = $(vendorlibdir)/$(sitearch)
 vendorlibdir = $(vendordir)/$(ruby_version)
 vendordir = $(rubylibprefix)/vendor_ruby
-sitearchdir = $(DESTDIR)./.gem.20220920-1751-qm4buv
-sitelibdir = $(DESTDIR)./.gem.20220920-1751-qm4buv
+sitearchdir = $(DESTDIR)./.gem.20221004-1672-e9ihcz
+sitelibdir = $(DESTDIR)./.gem.20221004-1672-e9ihcz
 sitedir = $(rubylibprefix)/site_ruby
 rubyarchdir = $(rubylibdir)/$(arch)
 rubylibdir = $(rubylibprefix)/$(ruby_version)
@@ -138,7 +138,7 @@ LIBS = $(LIBRUBYARG_SHARED) -lffi  -lpthread -lgmp -ldl -lcrypt -lm   -lc
 ORIG_SRCS = AbstractMemory.c ArrayType.c Buffer.c Call.c ClosurePool.c DynamicLibrary.c Function.c FunctionInfo.c LastError.c LongDouble.c MappedType.c MemoryPointer.c MethodHandle.c Platform.c Pointer.c Struct.c StructByValue.c StructLayout.c Thread.c Type.c Types.c Variadic.c ffi.c
 SRCS = $(ORIG_SRCS) 
 OBJS = AbstractMemory.o ArrayType.o Buffer.o Call.o ClosurePool.o DynamicLibrary.o Function.o FunctionInfo.o LastError.o LongDouble.o MappedType.o MemoryPointer.o MethodHandle.o Platform.o Pointer.o Struct.o StructByValue.o StructLayout.o Thread.o Type.o Types.o Variadic.o ffi.o
-HDRS = $(srcdir)/Struct.h $(srcdir)/DynamicLibrary.h $(srcdir)/MemoryPointer.h $(srcdir)/LongDouble.h $(srcdir)/Types.h $(srcdir)/ArrayType.h $(srcdir)/LastError.h $(srcdir)/ClosurePool.h $(srcdir)/compat.h $(srcdir)/rbffi.h $(srcdir)/rbffi_endian.h $(srcdir)/AbstractMemory.h $(srcdir)/Type.h $(srcdir)/Platform.h $(srcdir)/Thread.h $(srcdir)/StructByValue.h $(srcdir)/MethodHandle.h $(srcdir)/Pointer.h $(srcdir)/Call.h $(srcdir)/extconf.h $(srcdir)/Function.h $(srcdir)/MappedType.h
+HDRS = $(srcdir)/Struct.h $(srcdir)/Type.h $(srcdir)/LastError.h $(srcdir)/Platform.h $(srcdir)/Function.h $(srcdir)/Thread.h $(srcdir)/ClosurePool.h $(srcdir)/MappedType.h $(srcdir)/LongDouble.h $(srcdir)/ArrayType.h $(srcdir)/rbffi.h $(srcdir)/MethodHandle.h $(srcdir)/Call.h $(srcdir)/Pointer.h $(srcdir)/MemoryPointer.h $(srcdir)/DynamicLibrary.h $(srcdir)/extconf.h $(srcdir)/Types.h $(srcdir)/compat.h $(srcdir)/StructByValue.h $(srcdir)/AbstractMemory.h $(srcdir)/rbffi_endian.h
 LOCAL_HDRS = 
 TARGET = ffi_c
 TARGET_NAME = ffi_c

data/vendor/bundle/ruby/2.4.0/gems/json-2.6.2/ext/json/Makefile

@@ -31,8 +31,8 @@ rubyhdrdir = $(includedir)/$(RUBY_VERSION_NAME)
 vendorarchdir = $(vendorlibdir)/$(sitearch)
 vendorlibdir = $(vendordir)/$(ruby_version)
 vendordir = $(rubylibprefix)/vendor_ruby
-sitearchdir = $(DESTDIR)./.gem.20220920-1751-1koanh5
-sitelibdir = $(DESTDIR)./.gem.20220920-1751-1koanh5
+sitearchdir = $(DESTDIR)./.gem.20221004-1672-yz8rc4
+sitelibdir = $(DESTDIR)./.gem.20221004-1672-yz8rc4
 sitedir = $(rubylibprefix)/site_ruby
 rubyarchdir = $(rubylibdir)/$(arch)
 rubylibdir = $(rubylibprefix)/$(ruby_version)

data/vendor/bundle/ruby/2.4.0/gems/json-2.6.2/ext/json/ext/generator/Makefile

@@ -31,8 +31,8 @@ rubyhdrdir = $(includedir)/$(RUBY_VERSION_NAME)
 vendorarchdir = $(vendorlibdir)/$(sitearch)
 vendorlibdir = $(vendordir)/$(ruby_version)
 vendordir = $(rubylibprefix)/vendor_ruby
-sitearchdir = $(DESTDIR)./.gem.20220920-1751-t626ps
-sitelibdir = $(DESTDIR)./.gem.20220920-1751-t626ps
+sitearchdir = $(DESTDIR)./.gem.20221004-1672-e9d8ff
+sitelibdir = $(DESTDIR)./.gem.20221004-1672-e9d8ff
 sitedir = $(rubylibprefix)/site_ruby
 rubyarchdir = $(rubylibdir)/$(arch)
 rubylibdir = $(rubylibprefix)/$(ruby_version)

data/vendor/bundle/ruby/2.4.0/gems/json-2.6.2/ext/json/ext/parser/Makefile

@@ -31,8 +31,8 @@ rubyhdrdir = $(includedir)/$(RUBY_VERSION_NAME)
 vendorarchdir = $(vendorlibdir)/$(sitearch)
 vendorlibdir = $(vendordir)/$(ruby_version)
 vendordir = $(rubylibprefix)/vendor_ruby
-sitearchdir = $(DESTDIR)./.gem.20220920-1751-184tgs3
-sitelibdir = $(DESTDIR)./.gem.20220920-1751-184tgs3
+sitearchdir = $(DESTDIR)./.gem.20221004-1672-16heldf
+sitelibdir = $(DESTDIR)./.gem.20221004-1672-16heldf
 sitedir = $(rubylibprefix)/site_ruby
 rubyarchdir = $(rubylibdir)/$(arch)
 rubylibdir = $(rubylibprefix)/$(ruby_version)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: postfinancecheckout-ruby-sdk
 version: !ruby/object:Gem::Version
-  version: 3.1.5
+  version: 3.2.0
 platform: ruby
 authors:
 - wallee AG
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-09-20 00:00:00.000000000 Z
+date: 2022-10-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus