Release 3.2.0

Author: RytisRe

README.md

@@ -20,7 +20,7 @@ $ gem install wallee-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 [wallee
-account dashboard](https://app-wallee.com/account/select). Set `space_id`, `user_id`, and `api_secret` to their values:
+account dashboard](https://app-wallee.com/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
 Wallee.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

lib/wallee-ruby-sdk/api_client.rb

@@ -44,6 +44,9 @@ def initialize(config = Configuration.default)
         '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 @@ def build_request(http_method, path, opts = {})
       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': "wallee",
+        '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] || {}
 

lib/wallee-ruby-sdk/configuration.rb

@@ -90,7 +90,9 @@ class Configuration
 
     attr_accessor :force_ending_format
 
-    def initialize
+    attr_accessor :default_headers
+
+    def initialize(default_headers = {})
       @scheme = 'https'
       @host = 'app-wallee.com:443'
       @base_path = '/api'
@@ -102,6 +104,7 @@ def initialize
       @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

lib/wallee-ruby-sdk/models/transaction_completion.rb

@@ -95,6 +95,9 @@ class TransactionCompletion
     # 
     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 @@ def self.attribute_map
         :'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 @@ def self.swagger_types
         :'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 @@ def initialize(attributes = {})
         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 @@ def list_invalid_properties
         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 @@ def valid?
       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 @@ def invoice_merchant_reference=(invoice_merchant_reference)
       @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 @@ def ==(o)
           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 @@ def eql?(o)
     # 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

lib/wallee-ruby-sdk/models/transaction_completion_request.rb

@@ -32,6 +32,9 @@ class TransactionCompletionRequest
     # 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 @@ def self.attribute_map
         :'invoice_merchant_reference' => :'invoiceMerchantReference',
         :'last_completion' => :'lastCompletion',
         :'line_items' => :'lineItems',
+        :'statement_descriptor' => :'statementDescriptor',
         :'transaction_id' => :'transactionId'
       }
     end
@@ -53,6 +57,7 @@ def self.swagger_types
         :'invoice_merchant_reference' => :'String',
         :'last_completion' => :'BOOLEAN',
         :'line_items' => :'Array<CompletionLineItemCreate>',
+        :'statement_descriptor' => :'String',
         :'transaction_id' => :'Integer'
       }
     end
@@ -83,6 +88,10 @@ def initialize(attributes = {})
         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 @@ def list_invalid_properties
         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 @@ def valid?
       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 @@ def invoice_merchant_reference=(invoice_merchant_reference)
       @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 @@ def ==(o)
           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 @@ def eql?(o)
     # 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

lib/wallee-ruby-sdk/version.rb

@@ -16,5 +16,5 @@
 =end
 
 module Wallee
-  VERSION = '3.1.5'
+  VERSION = '3.2.0'
 end

test/condition_type_service_test.rb

@@ -11,6 +11,7 @@ def test_condition_type_all
     Wallee.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 = Wallee::ConditionTypeService.new

test/transaction_create_service_test.rb

@@ -12,6 +12,7 @@ def test_create
     Wallee.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 = Wallee::TransactionService.new

test/transaction_payment_page_service_test.rb

@@ -12,6 +12,7 @@ def test_payment_page_url
     Wallee.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 = Wallee::TransactionService.new