Class: GenesisRuby::Api::Request

Inherits:

Object

• Object
• GenesisRuby::Api::Request

Includes:

Mixins::Requests::AttributeValidation, Mixins::Requests::RestrictedSetter

Defined in:

lib/genesis_ruby/api/request.rb

Overview

Base Request Class

Direct Known Subclasses

GenesisRuby::Api::Requests::Base::Financial, GenesisRuby::Api::Requests::Base::Versioned, GenesisRuby::Api::Requests::Financial::Cards::Threeds::V2::MethodContinue, GenesisRuby::Api::Requests::Financial::Void, GenesisRuby::Api::Requests::NonFinancial::Fraud::Chargeback::DateRange, GenesisRuby::Api::Requests::NonFinancial::Fraud::Chargeback::Transaction, GenesisRuby::Api::Requests::NonFinancial::Fraud::Reports::DateRange, GenesisRuby::Api::Requests::NonFinancial::Fraud::Reports::Transaction, GenesisRuby::Api::Requests::NonFinancial::Fraud::Retrieval::DateRange, GenesisRuby::Api::Requests::NonFinancial::Fraud::Retrieval::Transaction, GenesisRuby::Api::Requests::NonFinancial::ProcessedTransactions::DateRange, GenesisRuby::Api::Requests::NonFinancial::ProcessedTransactions::PostDateRange, GenesisRuby::Api::Requests::NonFinancial::ProcessedTransactions::Transaction, GenesisRuby::Api::Requests::NonFinancial::Reconcile::DateRange, GenesisRuby::Api::Requests::NonFinancial::Reconcile::Transaction, GenesisRuby::Api::Requests::Wpf::Create, GenesisRuby::Api::Requests::Wpf::Reconcile

Constant Summary

PROTOCOL_HTTPS =

'https'

PORT_HTTPS =

443

METHOD_POST =

'POST'

METHOD_GET =

'GET'

METHOD_PUT =

'PUT'

METHOD_PATCH =

'PATCH'

AUTH_TYPE_BASIC =

'basic'

AUTH_TYPE_TOKEN =

'bearer'

Instance Attribute Summary

• #api_config ⇒ Object readonly

  Returns the value of attribute api_config.

Instance Method Summary

• #build_document ⇒ Object

  Generate the Request Document based on the builder_interface.

• #initialize(configuration, builder_interface = 'xml') ⇒ Request constructor

  A new instance of Request.

Constructor Details

#initialize(configuration, builder_interface = 'xml') ⇒ Request

Returns a new instance of Request.

# File 'lib/genesis_ruby/api/request.rb', line 30

def initialize(configuration, builder_interface = 'xml')
  @configuration     = configuration
  @builder_interface = builder_interface
  @api_config        = GenesisRuby::Utils::Options::ApiConfig.new

  init_configuration
  init_field_validations
end

Instance Attribute Details

#api_config ⇒ Object (readonly)

Returns the value of attribute api_config.

# File 'lib/genesis_ruby/api/request.rb', line 28

def api_config
  @api_config
end

Instance Method Details

#build_document ⇒ Object

Generate the Request Document based on the builder_interface

# File 'lib/genesis_ruby/api/request.rb', line 40

def build_document
  process_request_parameters

  if tree_structure.instance_of?(Hash)
    @builder_context = GenesisRuby::Builder.new(builder_interface)
    builder_context.parse_structure(tree_structure.clone)

    return builder_context.document
  end

  nil
end