Class: SecApi::Collections::FulltextResults

Inherits:
Object
  • Object
show all
Includes:
Enumerable
Defined in:
lib/sec_api/collections/fulltext_results.rb

Overview

A collection of full-text search results with Enumerable support.

FulltextResults collections are returned from full-text search operations and support iteration over matching documents.

Examples:

Iterating through results

results = client.query.fulltext("merger acquisition")
results.each { |r| puts "#{r.ticker}: #{r.description}" }

Using Enumerable methods

results.map(&:url)
results.select { |r| r.form_type == "8-K" }

See Also:

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(data) ⇒ FulltextResults

Initialize a new FulltextResults collection.

Parameters:

  • data (Hash) —

    API response data containing filings array



39
40
41
42
43
 
# File 'lib/sec_api/collections/fulltext_results.rb', line 39

def initialize(data)
  @_data = data
  build_objects
  build_metadata
end

Instance Attribute Details

#metadata ⇒ Hash, Array<Objects::FulltextResult> (readonly)

Returns:

  • (Hash) —

    Collection metadata (currently unused, reserved for future API enhancements)

  • (Array<Objects::FulltextResult>) —

    Result objects



33
34
35
 
# File 'lib/sec_api/collections/fulltext_results.rb', line 33

def metadata
  @metadata
end

#objects ⇒ Hash, Array<Objects::FulltextResult> (readonly)

Returns:

  • (Hash) —

    Collection metadata (currently unused, reserved for future API enhancements)

  • (Array<Objects::FulltextResult>) —

    Result objects



33
34
35
 
# File 'lib/sec_api/collections/fulltext_results.rb', line 33

def objects
  @objects
end

Instance Method Details

#each {|result| ... } ⇒ Enumerator

Yields each FulltextResult to the block. Required for Enumerable support.

Yields:

  • (result) —

    each result in the collection

Yield Parameters:

Returns:

  • (Enumerator) —

    if no block given



60
61
62
 
# File 'lib/sec_api/collections/fulltext_results.rb', line 60

def each(&block)
  @objects.each(&block)
end

#fulltext_results ⇒ Array<Objects::FulltextResult>

Returns the array of FulltextResult objects.

Returns:



49
50
51
 
# File 'lib/sec_api/collections/fulltext_results.rb', line 49

def fulltext_results
  @objects
end