class Geocodio::AddressSet

Attributes

query[R]

Returns the query that retrieved this result set.

@return [String] the original query

Public Class Methods

new(query, *addresses, input: nil) click to toggle source
# File lib/geocodio/address_set.rb, line 14
def initialize(query, *addresses, input: nil)
  @query           = query
  @addresses       = addresses
  @formatted_input = input
end

Public Instance Methods

best() click to toggle source

Returns the result that geocod.io deemed the most accurate for the query.

@return [Geocodio::Address] the most accurate address

# File lib/geocodio/address_set.rb, line 27
def best
  best = @addresses.find { |address| address.to_s == @formatted_input }
  return best if best

  max_by(&:accuracy)
end
each(&block) click to toggle source
# File lib/geocodio/address_set.rb, line 20
def each(&block)
  @addresses.each(&block)
end
empty?() click to toggle source

Returns whether or not there are any addresses in this result set.

@return [Boolean] if there were any results returned by Geocodio

# File lib/geocodio/address_set.rb, line 44
def empty?
  @addresses.empty?
end
size() click to toggle source

Returns the number of addresses contained in this result set.

@return [Integer] the number of addresses

# File lib/geocodio/address_set.rb, line 37
def size
  @addresses.size
end