Module: Soaspec::RestParametersDefaults

Included in:
RestHandler
Defined in:
lib/soaspec/exchange_handlers/rest_parameters_defaults.rb

Overview

Defaults for Soaspec RestParameters methods

Instance Method Summary collapse

Instance Method Details

#base_url_value ⇒ String

This must be overridden by using ‘base_url’ method within class definition

Returns:

  • (String) —

    Set through following method. Base URL in REST requests.



8
9
10
 
# File 'lib/soaspec/exchange_handlers/rest_parameters_defaults.rb', line 8

def base_url_value
  nil
end

#parent_url ⇒ String

This returns the base url that can be accessed by a subclass. It is set by the ‘base_url’ method

Examples:

class Parent < Soaspec::RestHandler
  base_url 'parent'
end

class Child < Parent
  base_url "#{parent_url}/child_path"
end

Child.new.base_url_value # => 'parent/child_path'

Returns:

  • (String) —

    Base url that can be accessed by a subclass.



26
27
28
 
# File 'lib/soaspec/exchange_handlers/rest_parameters_defaults.rb', line 26

def parent_url
  raise 'This needs to be set through base_url method'
end

#pascal_keys? ⇒ Boolean

Whether to convert each key in the request to PascalCase It will also auto convert simple XPath, JSONPath where ‘//’ or ‘..’ not specified

Returns:

  • (Boolean) —

    Whether to convert to PascalCase



38
39
40
 
# File 'lib/soaspec/exchange_handlers/rest_parameters_defaults.rb', line 38

def pascal_keys?
  false
end

#rest_client_headers ⇒ Hash

Returns Headers used in RestClient.

Returns:

  • (Hash) —

    Headers used in RestClient



31
32
33
 
# File 'lib/soaspec/exchange_handlers/rest_parameters_defaults.rb', line 31

def rest_client_headers
  {}
end