class Reuters::Client::Search::Equity
Performs a Equity
Search
Reuters
API request. Equity
searches are intended to vary in complexity but allow you to retrieve financial information about a company on a specific exchange.
@note All
Equity
Search
XML Requests require that the
appropriate xmlns attribute is present on elements inside the request element. This class uses the before_request hook to inject the appropriate attribute.
Public Class Methods
new()
click to toggle source
Calls superclass method
Reuters::Client::Search::Base::new
# File lib/reuters/client/search/equity.rb, line 15 def initialize # process equity request objects before they are sent. before_request do |req| if req.key?(:query_header) req.attributes({ query_header: { 'xmlns' => data_type } }, false) end [:filter, :query].each do |section| if req.key?(section) sec = req.send(section) sec.keys.each do |key| # injext xmlns property only if it does not already exist unless sec.attribute_key? key, 'xmlns' sec.attributes({ key => { 'xmlns' => query_spec } }, false) end sec[key].keys.each do |type| # injext xmlns property only if it does not already exist unless sec[key].attribute_key? type, 'xmlns' sec[key].attributes({ type => { 'xmlns' => data_type } }, false) end end end end end req end super end
Public Instance Methods
data_type()
click to toggle source
query_spec()
click to toggle source
Retrieve the correctly formatted Namespace Query Specification for an Equity-based Search
.
@return [String] the fully resolved namespace endpoint.
# File lib/reuters/client/search/equity.rb, line 62 def query_spec ns_definition(:equity_quote, :query_spec, 1) end