module EarthTools

Constants

VERSION: The gem version

Public Class Methods

configure(&block) click to toggle source

This method can be used to change some functional aspects, like the cache client or the units of calculations. See {include:Configuration}.

# File lib/earth_tools/configuration.rb, line 8
def self.configure(&block)
  if block_given?
    block.call(Configuration.instance)
  else
    Configuration.instance
  end
end

Public Instance Methods

height(latitude, longitude) click to toggle source

Retrieve the land height for a given latitude and longitude. @return [EarthTools::Result::Height] the height result

# File lib/earth_tools.rb, line 25
def height(latitude, longitude)
  get_lookup(:height).search(latitude, longitude)
end

sunrise_sunset(latitude, longitude, month, day, timezone = 99, dst = false) click to toggle source

Retrieve the sunrise & sunset values. @return [EarthTools::Result::SunriseSunset] the sunrise/sunset result

# File lib/earth_tools.rb, line 18
def sunrise_sunset(latitude, longitude, month, day, timezone = 99, dst = false)
  get_lookup(:sunrise_sunset).search(latitude, longitude, day, month, timezone, dst ? 1 : 0)
end

time_zone(latitude, longitude) click to toggle source

Retrieve for time zone based on latitude and longitude. @returns [EarthTools::Result::TimeZone] the time zone result

# File lib/earth_tools.rb, line 11
def time_zone(latitude, longitude)
  get_lookup(:time_zone).search(latitude, longitude) if valid_input?(latitude, longitude)
end

Private Instance Methods

blank?(value) click to toggle source

Determine if given value is blank. @return [Boolean] true, if value is nil or empty

# File lib/earth_tools.rb, line 81
def blank?(value)
  value.nil? || value.to_s.empty?
end

coordinate?(value) click to toggle source

Determine if given value is a coordinate. @return [Boolean] true, if given value is a coordinate

# File lib/earth_tools.rb, line 74
def coordinate?(value)
  !! value.to_f
end

coordinates?(latitude, longitude) click to toggle source

Validates a pair of coordinates. @return [Boolean] true, if latitute and longitude are (sort of) valid coordinates

# File lib/earth_tools.rb, line 67
def coordinates?(latitude, longitude)
  coordinate?(latitude) && coordinate?(longitude)
end

get_lookup(name) click to toggle source

Retrieve a lookup object from the store. @return [? extends EarthTools::Lookup::Base]

# File lib/earth_tools.rb, line 34
def get_lookup(name)
  @lookups = {} unless defined?(@lookups)
  @lookups[name] = spawn_lookup(name) unless @lookups.include?(name)
  @lookups[name]
end

spawn_lookup(name) click to toggle source

Spawn a lookup of the given name. @return [? extends EarthTools::Lookup::Base] new lookup helper

# File lib/earth_tools.rb, line 43
def spawn_lookup(name)
  name = name.to_s
  require "earth_tools/lookup/#{name}"
  klass = name.split("_").map{ |i| i[0...1].upcase + i[1..-1] }.join
  EarthTools::Lookup.const_get(klass).new
end

valid_full_input?(latitude, longitude, day, month, timezone, dst) click to toggle source

Validates input. @return [Boolean] true, if all values are valid

# File lib/earth_tools.rb, line 60
def valid_full_input?(latitude, longitude, day, month, timezone, dst)
  coordinates?(latitude, longitude) && !blank?(day) && !blank(month) && !blank?(timezone) && !blank?(dst)
end

valid_input?(latitude, longitude) click to toggle source

Validates input. @return [Boolean] true, if coordinates are valid

# File lib/earth_tools.rb, line 53
def valid_input?(latitude, longitude)
  coordinates?(latitude, longitude)
end