earth_tools 0.0.1

data/lib/earth_tools/configuration.rb

@@ -0,0 +1,73 @@
+require 'singleton'
+module EarthTools
+
+  ## This method can be used to change some functional aspects, like,
+  # the geocoding service provider, or the units of calculations.
+  # Please see {include:Configuration}
+  def self.configure(&block)
+    if block_given?
+      block.call(Configuration.instance)
+    else
+      Configuration.instance
+    end
+  end
+  
+  class Configuration
+    include Singleton
+    
+    OPTIONS = [
+      :timeout,
+      :proxy,
+      :cache,
+      :cache_prefix,
+      :always_raise,
+      :units
+    ]
+    
+    attr_accessor *OPTIONS
+    
+    def initialize  # :nodoc
+      set_defaults
+    end
+
+    # This method will set the configuration options to the default values
+    def set_defaults
+      @timeout      = 3               # geocoding service timeout (secs)
+      @proxy        = nil             # HTTP proxy server (user:pass@host:port)
+      @cache        = nil             # cache object (must respond to #[], #[]=, and #keys)
+      @cache_prefix = "earth_tools:"  # prefix (string) to use for all cache keys
+
+      # exceptions that should not be rescued by default
+      # (if you want to implement custom error handling);
+      # supports SocketError and Timeout::Error
+      @always_raise = []
+
+      # calculation options
+      @units     = :english # :metric or :english
+    end
+    
+
+    # Delegates getters and setters for all configuration settings,
+    # and +set_defaults+ to the singleton instance.
+    instance_eval(OPTIONS.map do |option|
+      o = option.to_s
+      <<-EOS
+      def #{o}
+        instance.#{o}
+      end
+
+      def #{o}=(value)
+        instance.#{o} = value
+      end
+      EOS
+    end.join("\n\n"))
+
+    class << self
+      # This method will set the configuration options to the default values
+      def set_defaults
+        instance.set_defaults
+      end
+    end
+    
+  end
+end

data/lib/earth_tools/exceptions.rb

@@ -0,0 +1,30 @@
+module EarthTools
+
+  class Error < StandardError
+  end
+
+  ##
+  #
+  #
+  class ConfigurationError < Error
+  end
+
+  ##
+  #
+  #
+  class OverQueryLimitError < Error
+  end
+  
+  ##
+  #
+  #
+  class InvalidInputError < Error
+  end
+  
+  ##
+  #
+  #
+  class UnsupportedOperationError < Error
+  end
+  
+end

data/lib/earth_tools/lookup/base.rb

@@ -0,0 +1,104 @@
+require 'rest_client'
+require 'xmlsimple'
+require 'earth_tools/configuration'
+
+module EarthTools
+  module Lookup
+    
+    ##
+    #
+    #
+    class Base
+      
+      ##
+      # Query the Earth Tools service and return a EarthTools::Result object.
+      # @return [EarthTools::Result, nil] 
+      def search(*options)
+        begin
+          Timeout::timeout(EarthTools::Configuration.timeout) do
+            raw_results = retrieve(query(options))
+            parse_results(raw_results, :xml)
+          end
+        rescue Timeout::Error => err
+          raise_error(err) or warn "Earth Tools API took too long to respond. See EarthTools::Configuration to set the timeout time (currently set to #{EarthTools::Configuration.timeout} seconds)."
+        end
+      end
+    
+      private
+      
+      ##
+      # The base URL for the web service endpoint (protocol and server)
+      # @return [String] the base URL
+      def base_service_url
+        "http://www.earthtools.org"
+      end
+      
+      ##
+      # URL to use for querying the geocoding engine.
+      # @return [String]
+      def query(*options)
+        base_service_url + query_base + options.join('/')
+      end
+      
+      ##
+      # Parse results depending on if xml or json
+      #
+      def parse_results(raw_results, type)
+        case type
+        when :xml
+          parse_xml(XmlSimple.xml_in( raw_results, { 'ForceArray' => false } ))
+        when :json
+          raise UnsupportedOperationError, "JSON is not supported"
+        end
+      end
+      
+      ##
+      # Handle XML results by validating them
+      #
+      def parse_xml(xml)
+        if xml['location']
+          result_class.new(xml)
+        else
+          warn "Invalid request."
+          puts xml
+        end
+      end
+      
+      ##
+      # Handles running query
+      #
+      def retrieve(query)
+        RestClient.proxy = EarthTools::Configuration.proxy if EarthTools::Configuration.proxy
+        #puts "Trying to connect to endpoint(#{query})"
+        #puts "Using proxy (#{RestClient.proxy})" if RestClient.proxy
+        RestClient.get query
+      end
+      
+      ##
+      # Raise exception if configuration specifies it should be raised.
+      # Return false if exception not raised.
+      #
+      def raise_error(error, message = nil)
+        if EarthTools::Configuration.always_raise.include?( error.is_a?(Class) ? error : error.class )
+          raise error, message
+        else
+          false
+        end
+      end
+      
+      ##
+      # 
+      #
+      def query_base
+        raise NotImplementedError
+      end
+      
+      ##
+      #
+      # 
+      def result_class
+        EarthTools::Result.const_get(self.class.to_s.split(":").last)
+      end
+    end
+  end
+end

data/lib/earth_tools/lookup/height.rb

@@ -0,0 +1,18 @@
+require 'earth_tools/lookup/base'
+require 'earth_tools/result/height'
+
+module EarthTools::Lookup
+  
+  ##
+  #
+  #
+  class Height < Base
+    
+    private
+
+    def query_base
+      "/height/"
+    end
+    
+  end
+end

data/lib/earth_tools/lookup/sunrise_sunset.rb

@@ -0,0 +1,14 @@
+require 'earth_tools/lookup/base'
+require 'earth_tools/result/sunrise_sunset'
+
+module EarthTools::Lookup
+  class SunriseSunset < Base
+    
+    private
+
+    def query_base
+      "/sun/"
+    end
+    
+  end
+end

data/lib/earth_tools/lookup/time_zone.rb

@@ -0,0 +1,14 @@
+require 'earth_tools/lookup/base'
+require 'earth_tools/result/time_zone'
+
+module EarthTools::Lookup
+  class TimeZone < Base
+    
+    private
+
+    def query_base
+      "/timezone/"
+    end
+    
+  end
+end

data/lib/earth_tools/result/base.rb

@@ -0,0 +1,49 @@
+module EarthTools
+  module Result
+  
+    ##
+    #
+    #
+    class Base
+      attr_accessor :data
+
+      ##
+      # Takes a hash of result data from a parsed Google result document.
+      #
+      def initialize(data)
+        @data = data
+      end
+
+      ##
+      # Get the geographical location
+      # @returns [Array] a two-element array: [latitude, longitude]
+      def location
+        [latitude, longitude]
+      end
+
+      ##
+      # Get the latitude
+      # See {http://en.wikipedia.org/wiki/Latitude}.
+      # @returns [Float] the latitude
+      def latitude
+        @data['latitude'].to_f
+      end
+
+      ##
+      # Get the longitude
+      # See {http://en.wikipedia.org/wiki/Longitude}.
+      # @returns the longitude
+      def longitude
+        @data['longitude'].to_f
+      end
+      
+      ##
+      # The version of the response format
+      # @returns [Float] the version
+      def version
+        @data['version'].to_f
+      end
+
+    end
+  end
+end

data/lib/earth_tools/result/height.rb

@@ -0,0 +1,39 @@
+require 'earth_tools/result/base'
+require 'earth_tools/configuration'
+
+module EarthTools::Result
+  
+  ##
+  #
+  #  
+  class Height < Base
+
+    ##
+    # Returns height based on unit requested in configuration
+    # @return [float] 
+    def height
+      if EarthTools::Configuration.units == :metric
+        meters
+      else
+        feet
+      end
+    end
+    
+    ##
+    # The height above sea level in meters
+    # See {http://en.wikipedia.org/wiki/Meter}.
+    # @return [float] the height above sea level in meters
+    def meters
+      @data['meters'].to_f
+    end
+    
+    ##
+    # The height above sea level in feet
+    # See {http://en.wikipedia.org/wiki/Foot_(unit)}.
+    # @return [float] the height above sea level in feet
+    def feet
+      @data['feet'].to_f
+    end
+    
+  end
+end

data/lib/earth_tools/result/sunrise_sunset.rb

@@ -0,0 +1,119 @@
+require 'earth_tools/result/base'
+
+module EarthTools::Result
+
+  ##
+  # The sunrise/sunset result object
+  #
+  class SunriseSunset < Base
+  
+    ##
+    # The date of the sunrise/sunset data as a hash
+    # @return [Hash] Hash containing year, month, and day as integers
+    def date
+      { :year => Time.now.year, :month => @data['date']['month'].to_i, :day => @data['date']['day'].to_i }
+    end
+
+    ##
+    # The sunrise time
+    # @return [Time] the sunrise time
+    def sunrise
+      create_time @data['morning']['sunrise']
+    end
+    
+    ##
+    # The sunset time
+    # @return [Time] the sunset time
+    def sunset
+      create_time @data['evening']['sunset']
+    end
+    
+    ##
+    # The twilight time for the specified time and type
+    # @param [Symbol] the time (:morning or :evening)
+    # @param [Symbol] the type (:astronomical, :civil, or :nautical)
+    # @return [Time] the requested twilight time
+    def twilight(time, type)
+      time = time.to_sym if time.is_a?(String)
+      type = type.to_sym if type.is_a?(String)
+      send "#{time}_#{type}_twilight" if [:morning, :evening].include?(time) && [:astronomical, :civil, :nautical].include?(type)
+    end
+    
+    ##
+    # The morning twilight time for the specified type
+    # @param [Symbol] the type of morning twilight time
+    # @return [Time] the specified morning twilight time
+    def morning_twilight(type)
+      twilight :morning, type
+    end
+    
+    ##
+    # The evening twilight time for the specified type
+    # @param [Symbol] the type of evening twilight time
+    # @return [Time] the specified evening twilight time
+    def evening_twilight(type)
+      twilight :evening, type
+    end
+    
+    ##
+    # The evening astronomical twilight time
+    # @return [Time] the astronomical twilight time for the evening
+    def evening_astronomical_twilight
+      create_time @data['evening']['twilight']['astronomical']
+    end
+    
+    ##
+    # The evening civil twilight time
+    # @return [Time] the civil twilight time for the evening
+    def evening_civil_twilight
+      create_time @data['evening']['twilight']['civil']
+    end
+    
+    ##
+    # The evening nautical twilight time
+    # @return [Time] the nautical twilight time for the evening
+    def evening_nautical_twilight
+      create_time @data['evening']['twilight']['nautical']
+    end
+    
+    ##
+    # The morning astronomical twilight time
+    # @return [Time] the astronomical twilight time for the morning
+    def morning_astronomical_twilight
+      create_time @data['morning']['twilight']['astronomical']
+    end
+    
+    ##
+    # The morning civil twilight time
+    # @return [Time] the civil twilight time for the morning
+    def morning_civil_twilight
+      create_time @data['morning']['twilight']['civil']
+    end
+    
+    ##
+    # The morning nautical twilight time
+    # @return [Time] the nautical twilight time for the morning
+    def morning_nautical_twilight
+      create_time @data['morning']['twilight']['nautical']
+    end
+    
+    ##
+    # The number of hours offset from UTC disregarding any correction for daylight saving time
+    # See {http://en.wikipedia.org/wiki/UTC_offset}.
+    # @return [Integer] the UTC offset
+    def utc_offset
+      @data['date']['timezone'].to_i
+    end
+    
+    private 
+    
+    ##
+    # Parses time
+    # @returns [Time] The parse time
+    def create_time(time)
+      times = time.split(':').collect{|s| s.to_i}
+      Time.new(date[:year], date[:month], date[:day], times[0], times[1], times[2], utc_offset * 3600)
+    end
+    
+  end
+end

data/lib/earth_tools/result/time_zone.rb

@@ -0,0 +1,78 @@
+require 'earth_tools/result/base'
+
+module EarthTools::Result
+  
+  ##
+  #
+  #
+  class TimeZone < Base
+
+    ##
+    # Whether or not the {#local_time} and {#iso_time} is currently in DST. If they do, the value of this element will be 'True'. If they do not, the value will be 'False'. If it can't be determined whether or not daylight saving time should be used, the value will be 'Unknown'. 
+    # @return [String] 'True' || 'False' || 'Unknown'
+    def dst
+      @data['dst']
+    end
+    
+    ##
+    # Whether or not the {#local_time} and {#iso_time} is currently in DST
+    # @return [boolean] true || false || nil
+    def dst?
+      case @data['dst']
+      when 'True' then 
+        true
+      when 'False'
+        false
+      else
+        nil
+      end
+    end
+    
+    ##
+    # The same value as {#local_time} but in ISO 8601 format instead
+    # See {http://en.wikipedia.org/wiki/ISO_8601}.
+    # @return [String] the ISO time
+    def iso_time
+      create_time @data['isotime']
+    end
+    
+    ##
+    # The local time taking into account the time zone offset and any local daylight saving time in effect
+    # @return [String] the local time
+    def local_time
+      iso_time
+    end
+  
+    ##
+    # The number of hours offset from UTC disregarding any correction for daylight saving time
+    # See {http://en.wikipedia.org/wiki/UTC_offset}.
+    # @return [Integer] the UTC offset
+    def utc_offset
+      @data['offset'].to_i
+    end
+
+    ##
+    # The nautical suffix for the time zone
+    # See {http://en.wikipedia.org/wiki/Nautical_time}
+    # @return [String] the nautical suffix for the time zone
+    def suffix
+      @data['suffix']
+    end
+    
+    ##
+    # The reference UTC time
+    # See {http://en.wikipedia.org/wiki/Coordinated_Universal_Time}.
+    # @return [String] the UTC time
+    def utc_time
+      create_time @data['utctime'], "%Y-%m-%d %H:%M:%S"
+    end
+    
+    private
+    
+    def create_time(time, format = "%Y-%m-%d %H:%M:%S %z")
+      require 'date'
+      DateTime.strptime(time, format).to_time
+    end
+    
+  end
+end

data/lib/earth_tools/version.rb

@@ -0,0 +1,4 @@
+module EarthTools
+  # The gem version
+  VERSION = "0.0.1"
+end

data/lib/earth_tools.rb

@@ -0,0 +1,91 @@
+##
+#
+#
+#
+module EarthTools
+  extend self
+   
+  ##
+  # Retrieve for time zone based on latitude and longitude.
+  #
+  # @returns [EarthTools::Result::TimeZone]
+  #
+  def time_zone(latitude, longitude)
+    get_lookup(:time_zone).search(latitude, longitude) if valid_input?(latitude, longitude)
+  end
+  
+  ##
+  # Retrieve the sunrise & sunset values
+  #
+  # @returns [EarthTools::Result::SunriseSunset]
+  #
+  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
+  
+  ##
+  # Retrieve the land height for a given latitude and longitude
+  # 
+  # @returns [EarthTools::Result::Height]
+  #
+  def height(latitude, longitude)
+    get_lookup(:height).search(latitude, longitude)
+  end
+  
+  private
+  
+  ##
+  # Retrieve a lookup object from the store.
+  #
+  def get_lookup(name)
+    @lookups = {} unless defined?(@lookups)
+    @lookups[name] = spawn_lookup(name) unless @lookups.include?(name)
+    @lookups[name]
+  end
+  
+  ##
+  # Spawn a lookup of the given name.
+  #
+  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
+  
+  ##
+  # Validates input
+  #
+  def valid_input?(latitude, longitude)
+    coordinates?(latitude, longitude)
+  end
+  
+  ##
+  # Validates input
+  #
+  def valid_full_input?(latitude, longitude, day, month, timezone, dst)
+    coordinates?(latitude, longitude) && !blank?(day) && !blank(month) && !blank?(timezone) && !blank?(dst)
+  end
+  
+  ##
+  # Validates a pair of coordinates
+  #
+  def coordinates?(latitude, longitude)
+    coordinate?(latitude) && coordinate?(longitude)
+  end
+  
+  ##
+  # Determine if given value is a coordinate
+  #
+  def coordinate?(value)
+    !! value.to_f
+  end
+  
+  ##
+  # Determine if given value is blank
+  #
+  def blank?(value)
+    value.nil? || value.to_s.empty?
+  end
+  
+end

data/test/configuration_test.rb

@@ -0,0 +1,51 @@
+# encoding: utf-8
+require 'test_helper'
+ 
+class ConfigurationTest < MiniTest::Unit::TestCase
+  
+  def setup
+    EarthTools::Configuration.set_defaults
+  end
+ 
+  # --- class method configuration ---
+  def test_configurated_by_class_method
+    EarthTools::Configuration.units = :metric
+    assert_equal EarthTools::Configuration.units, :metric
+    result = EarthTools.height(52.4822, -1.8946)
+    if result.height == 0
+      assert_equal result.height, result.feet
+    else
+      refute_equal result.height, result.feet
+    end
+  end
+ 
+  # --- EarthTools#configure distances configuration ---
+  def test_configuration
+    
+    # DSL
+    EarthTools.configure do |config|
+      config.units  = :metric
+    end
+ 
+    assert_equal EarthTools::Configuration.units, :metric
+    result = EarthTools.height(52.4822, -1.8946)
+    if result.height == 0
+      assert_equal result.height, result.feet
+    else
+      refute_equal result.height, result.feet
+    end
+ 
+    # Direct
+    EarthTools.configure.units  = :metric
+ 
+    assert_equal EarthTools::Configuration.units, :metric
+    result = EarthTools.height(52.4822, -1.8946)
+    assert_equal result.height, result.meters
+    if result.height == 0
+      assert_equal result.height, result.feet
+    else
+      refute_equal result.height, result.feet
+    end
+  end
+  
+end

data/test/earth_tools_test.rb

@@ -0,0 +1,24 @@
+# encoding: utf-8
+
+require 'test_helper'
+require 'earth_tools'
+require 'earth_tools/result/height'
+require 'earth_tools/result/sunrise_sunset'
+require 'earth_tools/result/time_zone'
+require 'mock_lookup'
+
+class EarthToolsTest < MiniTest::Unit::TestCase
+  
+  def test_time_zone_method_returns_result_object
+    assert EarthTools.time_zone(40.71417, -74.00639).is_a?(EarthTools::Result::TimeZone)
+  end
+  
+  def test_sunrise_sunset_method_returns_result_object
+    assert EarthTools.sunrise_sunset(40.71417, -74.00639, 12, 4).is_a?(EarthTools::Result::SunriseSunset)
+  end
+  
+  def test_height_method_returns_result_object
+    assert EarthTools.height(52.4822, -1.8946).is_a?(EarthTools::Result::Height)
+  end
+  
+end

data/test/fixtures/height_(52.4822,-1.8946).xml

@@ -0,0 +1,10 @@
+<?xml version="1.0" encoding="ISO-8859-1" ?>
+<height xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="http://www.earthtools.org/height.xsd">
+  <version>1.0</version>
+  <location>
+    <latitude>52.4822</latitude>
+    <longitude>-1.8946</longitude>
+  </location>
+  <meters>141</meters>
+  <feet>462.6</feet>
+</height>

data/test/fixtures/sun_(40.71417,-74.00639,4,12,99,0).xml

@@ -0,0 +1,30 @@
+<?xml version="1.0" encoding="ISO-8859-1" ?>
+<sun xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="http://www.earthtools.org/sun.xsd">
+  <version>1.0</version>
+  <location>
+    <latitude>40.71417</latitude>
+    <longitude>-74.00639</longitude>
+  </location>
+  <date>
+    <day>4</day>
+    <month>12</month>
+    <timezone>-5</timezone>
+    <dst>0</dst>
+  </date>
+  <morning>
+    <sunrise>07:05:50</sunrise>
+    <twilight>
+      <civil>06:35:06</civil>
+      <nautical>06:00:50</nautical>
+      <astronomical>05:27:39</astronomical>
+    </twilight>
+  </morning>
+  <evening>
+    <sunset>16:26:59</sunset>
+    <twilight>
+      <civil>16:57:43</civil>
+      <nautical>17:31:59</nautical>
+      <astronomical>18:05:10</astronomical>
+    </twilight>
+  </evening>
+</sun>

data/test/fixtures/timezone_(40.71417,-74.00639).xml

@@ -0,0 +1,14 @@
+<?xml version="1.0" encoding="ISO-8859-1" ?>
+<timezone xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="http://www.earthtools.org/timezone-1.1.xsd">
+  <version>1.1</version>
+  <location>
+    <latitude>40.71417</latitude>
+    <longitude>-74.00639</longitude>
+  </location>
+  <offset>-5</offset>
+  <suffix>R</suffix>
+  <localtime>14 Jun 2012 13:29:06</localtime>
+  <isotime>2012-06-14 13:29:06 -0500</isotime>
+  <utctime>2012-06-14 18:29:06</utctime>
+  <dst>Unknown</dst>
+</timezone>

data/test/height_test.rb

@@ -0,0 +1,39 @@
+# encoding: utf-8
+
+require 'test_helper'
+require 'earth_tools'
+require 'earth_tools/result/height'
+require 'mock_lookup'
+
+##
+#
+#
+class HeightTest < MiniTest::Unit::TestCase
+
+  def setup
+    @result = EarthTools.height(52.4822, -1.8946)
+  end
+  
+  def test_height_is_float
+    assert @result.height.is_a?(Float), 'Height should be a float'
+  end
+  
+  # Tests for height configuration in configuration_test.rb
+  
+  def test_feet_is_float
+    assert @result.feet.is_a?(Float), 'Feet should be a float'
+  end
+  
+  def test_feet_parsed_correctly
+    assert_equal 462.6, @result.feet, 'Feet was not parsed correctly'
+  end
+  
+  def test_meters_is_float
+    assert @result.meters.is_a?(Float), 'Meters should be a float'
+  end
+  
+  def test_meters_parsed_correctly
+    assert_equal 141, @result.meters, 'Meters was not parsed correctly'
+  end
+  
+end

data/test/integration/height_smoke_test.rb

@@ -0,0 +1,30 @@
+require 'rubygems'
+require 'minitest/autorun'
+require 'earth_tools'
+require 'test_helper'
+
+class HeightSmokeTest < MiniTest::Unit::TestCase
+
+  def test_height_search
+    result = EarthTools.height(52.4822, -1.8946)
+    
+    default_units = EarthTools::Configuration.units
+    begin
+      
+      # Default as :english
+      assert_equal 462.6, result.height
+      
+      # Set to :metric units
+      EarthTools::Configuration.units = :metric
+      assert_equal 141, result.height
+      
+      # Set to :english units
+      EarthTools::Configuration.units = :english
+      assert_equal 462.6, result.height
+    ensure
+      EarthTools::Configuration.units = default_units
+    end
+    
+  end
+
+end

data/test/integration/sunrise_sunset_smoke_test.rb

@@ -0,0 +1,15 @@
+require 'rubygems'
+require 'minitest/autorun'
+require 'earth_tools'
+require 'test_helper'
+
+class SunriseSunsetSmokeTest < MiniTest::Unit::TestCase
+
+  def test_sunrise_sunset_search
+    result = EarthTools.sunrise_sunset(40.71417, -74.00639, 11, 9, 0, 0)
+    
+    assert_equal Time.utc(Time.now.year, 11, 9, 11, 37, 32), result.sunrise
+    assert_equal Time.utc(Time.now.year, 11, 9, 21, 41, 12), result.sunset
+  end
+
+end

data/test/integration/time_zone_smoke_test.rb

@@ -0,0 +1,13 @@
+require 'rubygems'
+require 'minitest/autorun'
+require 'earth_tools'
+require 'test_helper'
+
+class TimeZoneSmokeTest < MiniTest::Unit::TestCase
+
+  def test_time_zone_search
+    result = EarthTools.time_zone(40.71417, -74.00639)
+    assert_equal -5, result.offset
+  end
+
+end

data/test/mock_lookup.rb

@@ -0,0 +1,18 @@
+require 'earth_tools/lookup/base'
+class EarthTools::Lookup::Base
+
+  private
+  
+  def read_fixture(file)
+    File.read(File.join("test", "fixtures", file)).strip.gsub(/\n\s*/, "")
+  end
+  
+  ##
+  # Handles running query
+  #
+  def retrieve(query)
+    query = query.split('/')
+    read_fixture "#{ query[3] }_(#{ query[4, query.size-1].join(',') }).xml"
+  end
+
+end

data/test/sunrise_sunset_test.rb

@@ -0,0 +1,92 @@
+# encoding: utf-8
+
+require 'test_helper'
+require 'earth_tools'
+require 'earth_tools/result/sunrise_sunset'
+require 'mock_lookup'
+
+class SunriseSunsetTest < MiniTest::Unit::TestCase
+
+  def setup
+    @result = EarthTools.sunrise_sunset(40.71417, -74.00639, 12, 4)
+  end
+  
+  # ---------------------------------------------------------------------------
+  # sunrise
+  # ---------------------------------------------------------------------------
+  
+  def test_sunrise_is_time
+    assert @result.sunrise.is_a?(Time), 'Sunrise should be a time'
+  end
+  
+  def test_sunrise_parsed_correctly
+    assert_equal Time.new(2012, 12, 4, 7, 5, 50, '-05:00'), @result.sunrise, 'Sunrise was not parsed correctly'
+  end
+  
+  # ---------------------------------------------------------------------------
+  # sunset
+  # ---------------------------------------------------------------------------
+  
+  def test_sunset_is_time
+    assert @result.sunset.is_a?(Time), 'Sunset should be a time'
+  end
+  
+  def test_sunset_parsed_correctly
+    assert_equal Time.new(2012, 12, 4, 16, 26, 59, '-05:00'), @result.sunset, 'Sunset was not parsed correctly'
+  end
+  
+  # ---------------------------------------------------------------------------
+  # twilight :time, :type
+  # ---------------------------------------------------------------------------
+  
+  def test_twilight_is_time
+    assert @result.twilight(:morning, :astronomical).is_a?(Time), 'Twilight should be a time'
+    assert @result.twilight(:morning, :civil).is_a?(Time), 'Twilight should be a time'
+    assert @result.twilight(:morning, :nautical).is_a?(Time), 'Twilight should be a time'
+    assert @result.twilight(:evening, :astronomical).is_a?(Time), 'Twilight should be a time'
+    assert @result.twilight(:evening, :civil).is_a?(Time), 'Twilight should be a time'
+    assert @result.twilight(:evening, :nautical).is_a?(Time), 'Twilight should be a time'
+  end
+  
+  def test_twilight_parsed_correctly
+    assert_equal Time.new(2012, 12, 4, 5, 27, 39, '-05:00'), @result.twilight(:morning, :astronomical), 'Twilight was not parsed correctly'
+    assert_equal Time.new(2012, 12, 4, 6, 35, 6, '-05:00'), @result.twilight(:morning, :civil), 'Twilight was not parsed correctly'
+    assert_equal Time.new(2012, 12, 4, 6, 0, 50, '-05:00'), @result.twilight(:morning, :nautical), 'Twilight was not parsed correctly'
+    assert_equal Time.new(2012, 12, 4, 18, 5, 10, '-05:00'), @result.twilight(:evening, :astronomical), 'Twilight was not parsed correctly'
+    assert_equal Time.new(2012, 12, 4, 16, 57, 43, '-05:00'), @result.twilight(:evening, :civil), 'Twilight was not parsed correctly'
+    assert_equal Time.new(2012, 12, 4, 17, 31, 59, '-05:00'), @result.twilight(:evening, :nautical), 'Twilight was not parsed correctly'
+  end
+  
+  # ---------------------------------------------------------------------------
+  # morning_twilight :type
+  # ---------------------------------------------------------------------------
+  
+  # ---------------------------------------------------------------------------
+  # evening_twilight :type
+  # ---------------------------------------------------------------------------
+  
+  # ---------------------------------------------------------------------------
+  # *_*_twilight
+  # ---------------------------------------------------------------------------
+  
+  def test_morning_astronomical_twilight_is_time
+    assert @result.morning_astronomical_twilight.is_a?(Time), 'Morning astronomical twilight should be a time'
+  end
+  
+  def test_twilight_parsed_correctly
+    assert_equal Time.new(2012, 12, 4, 5, 27, 39, '-05:00'), @result.morning_astronomical_twilight, 'Twilight was not parsed correctly'
+  end
+  
+  # ---------------------------------------------------------------------------
+  # utc_offset
+  # ---------------------------------------------------------------------------
+  
+  def test_utc_offset_is_integer
+	assert @result.utc_offset.is_a?(Integer), 'UTC offset should be an integer'
+  end
+  
+  def test_utc_offset_parsed_correctly
+    assert_equal -5, @result.utc_offset, 'UTC offset was not parsed correctly'
+  end
+  
+end

data/test/test_helper.rb

@@ -0,0 +1,5 @@
+require 'rubygems'
+require 'minitest/autorun'
+
+require 'earth_tools/configuration'
+# EarthTools::Configuration.proxy = 'http://www.proxy.com:80'

data/test/time_zone_test.rb

@@ -0,0 +1,58 @@
+# encoding: utf-8
+
+require 'test_helper'
+require 'earth_tools'
+require 'earth_tools/result/time_zone'
+require 'mock_lookup'
+
+class TimeZoneTest < MiniTest::Unit::TestCase
+
+  def setup
+    @result = EarthTools.time_zone(40.71417, -74.00639)
+  end
+  
+  def test_time_zone_method_returns_result_object
+    assert @result.is_a?(EarthTools::Result::TimeZone), 'Result should be a time zone object'
+  end
+  
+  def test_iso_time_is_time
+    assert @result.iso_time.is_a?(Time), 'ISO time should be a time object'
+  end
+  
+  def test_iso_time_parsed_correctly
+    assert_equal Time.new(2012, 6, 14, 13, 29, 6, '-05:00'), @result.iso_time, 'ISO time was not parsed correctly'
+  end
+  
+  def test_local_time_is_time
+    assert @result.local_time.is_a?(Time), 'Local time should be a time object'
+  end
+  
+  def test_local_time_parsed_correctly
+    assert_equal Time.new(2012, 6, 14, 13, 29, 6, '-05:00'), @result.local_time, 'Local time was not parsed correctly'
+  end
+  
+  def test_suffix_is_string
+    assert @result.suffix.is_a?(String), 'Suffix should be a string'
+  end
+  
+  def test_suffix_parsed_correctly
+    assert_equal 'R', @result.suffix, 'Suffix was not parsed correctly'
+  end
+  
+  def test_utc_offset_is_integer
+    assert @result.utc_offset.is_a?(Integer), 'UTC offset should be an integer'
+  end
+  
+  def test_utc_offset_parsed_correctly
+    assert_equal -5, @result.utc_offset, 'UTC offset was not parsed correctly'
+  end
+  
+  def test_utc_time_is_time
+    assert @result.utc_time.is_a?(Time), 'UTC time should be a time object'
+  end
+  
+  def test_utc_time_parsed_correctly
+    assert_equal Time.utc(2012, 6, 14, 18, 29, 6), @result.utc_time, 'UTC time was not parsed correctly'
+  end
+  
+end

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification
+name: earth_tools
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Max Kramer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-08-09 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: &26402964 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.1
+  type: :runtime
+  prerelease: false
+  version_requirements: *26402964
+- !ruby/object:Gem::Dependency
+  name: xml-simple
+  requirement: &26402628 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: *26402628
+description: Client library to query the earthtools.org web services
+email: max@maxkramer.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/earth_tools/configuration.rb
+- lib/earth_tools/exceptions.rb
+- lib/earth_tools/lookup/base.rb
+- lib/earth_tools/lookup/height.rb
+- lib/earth_tools/lookup/sunrise_sunset.rb
+- lib/earth_tools/lookup/time_zone.rb
+- lib/earth_tools/result/base.rb
+- lib/earth_tools/result/height.rb
+- lib/earth_tools/result/sunrise_sunset.rb
+- lib/earth_tools/result/time_zone.rb
+- lib/earth_tools/version.rb
+- lib/earth_tools.rb
+- test/configuration_test.rb
+- test/earth_tools_test.rb
+- test/fixtures/height_(52.4822,-1.8946).xml
+- test/fixtures/sun_(40.71417,-74.00639,4,12,99,0).xml
+- test/fixtures/timezone_(40.71417,-74.00639).xml
+- test/height_test.rb
+- test/integration/height_smoke_test.rb
+- test/integration/sunrise_sunset_smoke_test.rb
+- test/integration/time_zone_smoke_test.rb
+- test/mock_lookup.rb
+- test/sunrise_sunset_test.rb
+- test/test_helper.rb
+- test/time_zone_test.rb
+homepage: http://github.com/mckramer/earth_tools
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.7.2
+signing_key: 
+specification_version: 3
+summary: Client library to query the earthtools.org web services
+test_files: []
+has_rdoc: