sundial 0.0.1

data/.rvmrc

@@ -0,0 +1 @@
+rvm use 1.9.3@bobtime --create

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in sundial.gemspec
+gemspec

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/examples/driver.rb

@@ -0,0 +1,77 @@
+require './lib/sundial'
+puts
+puts
+
+@s = Sundial.new
+
+def printer(str)
+  print str, @s.send(str.strip.intern), "\n"
+end
+
+#
+#@s.address = "201 West Broad Street, Richmond, VA"
+#@s.address = "6526 Stuart Ave, Richmond, VA, 23226"
+#@s.date = (Date.today + 110.days + 1.year).jd
+
+#@s.address = "Amsterdam, Netherlands"
+@s.address = @s.external_ip
+#@s.date = Date.parse("2004-04-01").jd
+#@s.date = Date.parse("2011-12-24").jd
+
+
+#puts "lat_long", @s.lat_long
+
+printer "  latitude "
+printer ' longitude '
+printer ' longitude_west '
+#printer ' get_offset '
+printer 'get_timezone_offset '
+
+puts "Driver Block One ----------------------"
+printer "   current_julian_date "
+print   "           JULIAN_2000 ", "2451545", "\n"
+printer '                  jrd     '
+printer "  current_julian_cycle "
+printer '    solar_mean_anomaly '
+printer "    equation_of_center "
+printer "    ecliptic_longitude "
+printer "       right_ascension "
+printer "declination_of_the_sun "
+puts
+
+puts "Driver Block Two ----------------------"
+printer "                 l_sun "
+printer "                   jpp "
+printer "         sunset_jd_two "
+puts
+
+puts "Driver Block Three ----------------------"
+printer "         sidereal_time "
+printer "            hour_angle "
+printer "        hour_angle_two "
+printer "approximate_solar_noon "
+printer "         solar_transit "
+puts
+
+puts "Driver Block Four"
+printer '      wiki_set '
+printer '    sunrise_jd '
+printer "     sunset_jd "
+printer "   sunrise "
+printer "    sunset "
+printer " sunrise_f "
+printer "  sunset_f "
+printer ' length_of_day '
+printer ' asn_date '
+
+def format_datetime(dt)
+  dt.strftime("%B %e %Y %T")
+end
+
+puts "the equivalent of 9 AM on the solstice on this day would be", format_datetime(@s.nine)
+puts "the equivalent of 5 pm on the solstice on this day would be", format_datetime(@s.five)
+
+
+
+
+# Looks like the times are good, need to grab the timezone of the address being used and offset the UTC results by that much

data/lib/numeric_extensions.rb

@@ -0,0 +1,8 @@
+class Numeric
+  def degrees
+    self * Math::PI / 180
+  end
+  def radians
+    self * 180 / Math::PI
+  end
+end

data/lib/sundial/version.rb

@@ -0,0 +1,3 @@
+module Sundial
+  VERSION = "0.0.1"
+end

data/lib/sundial.rb

@@ -0,0 +1,228 @@
+require 'date'
+require 'geokit'
+require 'open-uri'
+require 'json'
+require 'active_support/time'
+
+require_relative 'numeric_extensions'
+
+class Sundial
+
+  attr_accessor :address, :date, :ip, :offset, :ll
+  
+  def initialize
+    @address = "Richmond, Virginia"
+  end
+
+  JULIAN_2000 = 2451545
+  
+  def local_time
+    DateTime.now
+  end
+  
+  def whatismyip
+    "http://www.whatismyip.org/"
+  end
+
+  def current_julian_date
+    # http://stackoverflow.com/questions/5095456/using-the-ruby-date-class-for-astronomical-data
+    @date || Date.today.jd
+  end
+
+  def external_ip
+    @ip ||= open(whatismyip).read
+    @ip
+#    '75.75.82.80'        
+  end
+
+  def lat_long
+    @ll ||= Geokit::Geocoders::MultiGeocoder.geocode(@address)
+  end
+
+  def longitude
+    lat_long.lng
+  end
+
+  def latitude
+    lat_long.lat
+  end
+
+  def longitude_west
+    -longitude
+  end
+
+
+
+  def get_offset
+    # see also http://www.hostip.info/
+    foo = open("http://www.earthtools.org/timezone-1.1/#{latitude}/#{longitude}").read
+    bar = foo.match(/<offset>(.*)<\/offset>/) if foo
+    if bar
+      @offset = bar[1].to_i
+    end
+  end
+
+  def get_timezone_offset
+    foo = open("http://www.askgeo.com/api/123016/vgdgoafgkvgdk6i9j26unjep4/timezone.json?points=#{latitude}%2C#{longitude}").read
+    bar = JSON.parse(foo)
+    if bar && bar['message'] == 'ok'
+      @offset = bar['data'].first['currentOffsetMs'].to_i / 3600000
+    end
+  end
+
+  def jrd
+    current_julian_date - JULIAN_2000
+  end
+
+  def current_julian_cycle
+    (current_julian_date - JULIAN_2000 - 0.0009 - (longitude_west / 360.0)).round
+  end
+
+
+  def solar_mean_anomaly # Mearth
+    # returns in degrees, 87.18
+    # Not sure if using approximate_solar_noon instead of current_julian_date is helpful or not
+    # Following this http://www.astro.uu.nl/~strous/AA/en/reken/zonpositie.html using current_julian_date
+#    ((357.5291 + 0.98560028 * (approximate_solar_noon - JULIAN_2000)) % 360).round(4) # this one is how wikipedia has it
+     ((357.5291 + 0.98560028 * (current_julian_date - JULIAN_2000)) % 360).round(4) # this on better for netherlands
+  end
+
+  def equation_of_center # Cearth
+    # returns in degrees 1.91
+    ((1.9148 * Math.sin(solar_mean_anomaly.degrees)) + (0.0200 * Math.sin((2 * solar_mean_anomaly).degrees)) + (0.0003 * Math.sin((3 * solar_mean_anomaly).degrees))).round(4)
+  end
+
+  def ecliptic_longitude # λsun
+    # returns in degrees 12.0321
+#    (solar_mean_anomaly + 102.9372 + 180) % 180
+    (solar_mean_anomaly + 102.9372 + equation_of_center + 180) % 360
+  end
+
+  def obliquity_of_the_equator #  ε
+    23.45
+  end
+
+  def l_sun
+    (solar_mean_anomaly + 102.9372 + 180) % 180
+  end
+
+  def sunset_jd_two
+    jpp + 0.0053 * Math.sin(solar_mean_anomaly.degrees) - 0.0069 * Math.sin((2 * l_sun).degrees)
+  end
+
+  def approximate_solar_noon # J(*)
+    (JULIAN_2000 + 0.0009 + (longitude_west / 360.0) + current_julian_cycle).round(4)
+  end
+
+  def asn_date
+    DateTime.jd(approximate_solar_noon)
+  end
+
+  def solar_transit
+    # Losing a lot of precision here :(
+    # not sure of these units, 2453097.0113
+#                              2453097.01224153
+#     (current_julian_date +    (0.0053 * Math.sin(solar_mean_anomaly.degrees)) - (0.0069 * Math.sin((2 * ecliptic_longitude).degrees))).round(4)
+     (approximate_solar_noon + (0.0053 * Math.sin(solar_mean_anomaly.degrees)) - (0.0069 * Math.sin((2 * ecliptic_longitude).degrees))).round(4)
+  end
+
+  def declination_of_the_sun # δsun
+    # returns in degrees 4.7585
+    (Math.asin(Math.sin(ecliptic_longitude.degrees) * Math.sin(23.45.degrees))).round(5).radians
+  end
+
+
+  def right_ascension # αsun
+    (ecliptic_longitude + (-2.4680 * Math.sin((2 * ecliptic_longitude).degrees)) + (0.0530 * Math.sin((4 * ecliptic_longitude).degrees)) - (0.0014 * Math.sin((6 * ecliptic_longitude).degrees))).round(4)
+  end
+
+  def sidereal_time # θ
+    (((280.1600 + 360.9856235 * (current_julian_date - JULIAN_2000)) - (longitude_west)) % 360).round(4)
+  end
+
+  def hour_angle_two
+    sidereal_time - right_ascension
+  end
+
+  def hour_angle
+    # returns output in degrees
+    top = Math.sin(-0.83.degrees) - (Math.sin(latitude.degrees) * Math.sin(declination_of_the_sun.degrees))
+    bottom = Math.cos(latitude.degrees) * Math.cos(declination_of_the_sun.degrees)
+    tb = top / bottom
+    if((tb < -1.0) || (tb > 1.0))
+      return 0 # there is no sunrise or sunset on the given date for the given lat / long.
+      # Not sure what to return here, just hope for now that it doesn't happen.
+    end
+    # acos will blow up if input not in range (-1..1)
+    (Math.acos(tb).radians).round(4)
+  end
+
+  def jpp
+    JULIAN_2000 + 0.0009 + (hour_angle + (longitude_west)) * 1 / 360.0 + 1 * current_julian_cycle
+  end
+
+  def wiki_set # ends up close to sunset_jd, which is good i think
+    JULIAN_2000 + 0.0009 + (((hour_angle  + (longitude_west)) / 360) + current_julian_cycle + 0.0053 * Math.sin(solar_mean_anomaly.degrees)) - 0.0069 * Math.sin((2 * ecliptic_longitude).degrees)
+  end
+
+  def sunset_jd
+#    puts "#{JULIAN_2000} + 0.0009 + (((#{hour_angle} + #{longitude}) / 360.0 ) + #{current_julian_cycle} + 0.0053 * Math.sin(#{solar_mean_anomaly})) - 0.0069 * Math.sin(2 * #{ecliptic_longitude})"
+#    foo = JULIAN_2000 + 0.0009 + (((hour_angle + longitude) / 360.0 ) + current_julian_cycle + 0.0053 * Math.sin(solar_mean_anomaly)) - 0.0069 * Math.sin(2 * ecliptic_longitude)
+    foo = jpp + 0.0053 * Math.sin(solar_mean_anomaly.degrees) - 0.0069 * Math.sin((2 * ecliptic_longitude).degrees)
+    foo.round(4)
+  end
+
+  def sunrise_jd
+    foo = solar_transit - (sunset_jd - solar_transit)
+    foo.round(4)
+  end
+
+  def sunset
+    foo = DateTime.jd(sunset_jd) + 12.hours
+#    foo = foo.new_offset(local_time.offset)
+    foo
+  end
+
+  def sunrise
+    foo = DateTime.jd(sunrise_jd) + 12.hours
+#    foo = foo.new_offset(local_time.offset)
+    foo
+  end
+
+  def sunrise_f
+    (sunrise + @offset.to_i.hours)
+  end
+
+  def sunset_f
+    (sunset + @offset.to_i.hours)
+  end
+
+  def length_of_day
+    (sunset - sunrise) * 24
+  end
+
+  def hour_ratio
+    length_of_day / 12.0
+  end
+
+  def nine
+    sunrise_f + (2 * hour_ratio).hours
+  end
+
+  def five
+    sunrise_f + (10 * hour_ratio).hours
+  end
+
+  def format_datetime(dt)
+    dt.strftime("%B %e %Y %T")
+  end
+
+
+
+
+
+end
+
+
+
+#Sundial.new.get_location

data/sundial.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "sundial/version"
+
+Gem::Specification.new do |s|
+  s.name        = "sundial"
+  s.version     = Sundial::VERSION
+  s.authors     = ["Bob Larrick"]
+  s.email       = ["larrick@gmail.com"]
+  s.homepage    = "https://github.com/deathbob/Sundial"
+  s.summary     = %q{Gem to calculate the sunrise and sunset at your location}
+  s.description = %q{This gem calculates the sunrise and sunset at your current location.}
+
+  s.rubyforge_project = "sundial"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # specify any dependencies here; for example:
+  # s.add_development_dependency "rspec"
+  s.add_runtime_dependency "activesupport"
+  s.add_runtime_dependency "geokit"  
+  
+end

data/test/sun_calculator_test.rb

@@ -0,0 +1,121 @@
+require 'minitest/autorun'
+
+cal = File.join(File.dirname(__FILE__), '..', 'lib', 'sundial.rb')
+
+puts File.exists? cal
+
+require_relative File.join('..', 'lib', 'sundial')
+
+class SunCalculatorTest < MiniTest::Unit::TestCase
+  def setup
+    @sc = Sundial.new
+  end
+
+  def test_local_time
+    assert @sc.local_time.to_i == DateTime.now.to_i
+  end
+  
+  def test_julian_2000
+    assert   Sundial::JULIAN_2000 == 2451545
+  end
+  
+  def test_whatismyip 
+    assert @sc.whatismyip == "http://www.whatismyip.org/"
+  end
+
+  describe Sundial do
+    before do
+      @sc = Sundial.new
+    end
+
+    describe 'current_julian_date' do
+      it 'should be today when no default is given' do
+        @sc.current_julian_date.must_equal Date.today.jd
+      end
+      it 'should be the default if default is given' do
+        cow = (Date.today - 1.days).jd
+        @sc.date = cow
+        @sc.current_julian_date.must_equal cow
+      end
+    end
+  
+    describe 'address' do
+      # Address just needs to be something that can be geocoded.
+      it 'should default to my address' do
+        @sc.address.must_equal "Richmond, Virginia"
+      end
+    
+      it 'should be whatever is given if set' do
+        cow = "71.1.2.3"
+        @sc.address = cow
+        @sc.address.must_equal cow
+      end
+    end
+  
+    describe 'lat_long' do
+      before do
+        @latlng = Geokit::LatLng.new(37.5407246, -77.4360481)
+        @foo = Geokit::GeoLoc.new({:city =>'Richmond', :state => 'VA', :lat => @latlng.lat, :lng => @latlng.lng, :country_code => "US"})
+      end
+      # How to work VCR in here?
+      # it 'should geocode the default address' do
+      #   @sc.lat_long.must_equal @foo
+      # end
+      
+      describe 'given default address geocoded correctly' do
+        before do
+          @sc.ll = @foo
+        end
+        it 'should set latitude' do
+          @sc.latitude.must_be_close_to @latlng.lat
+        end
+        it 'should set longitude' do
+          @sc.longitude.must_be_close_to @latlng.lng
+        end
+        it 'should set the longitude_west to negative latitude' do
+          @sc.longitude_west.must_equal -@sc.longitude
+        end
+        describe "Getting the offset for the lat & lng" do
+          it 'should get_offset' do
+            @sc.get_offset.must_equal -5
+            @sc.offset.must_equal -5
+          end
+          it 'should get_timezone_offset' do
+            @sc.get_timezone_offset.must_equal -4
+            @sc.offset.must_equal -4
+          end
+        end
+      end
+      
+    end
+    
+    describe 'jrd' do
+      it 'should be the current_julian_date - JULIAN_2000' do
+        @sc.jrd.must_equal @sc.current_julian_date - Sundial::JULIAN_2000
+      end
+    end
+    
+  end  
+  
+end
+
+# cloony
+
+# expected_musts = %w(must_be
+#                     must_be_close_to
+#                     must_be_empty
+#                     must_be_instance_of
+#                     must_be_kind_of
+#                     must_be_nil
+#                     must_be_same_as
+#                     must_be_silent
+#                     must_be_within_delta
+#                     must_be_within_epsilon
+#                     must_equal
+#                     must_include
+#                     must_match
+#                     must_output
+#                     must_raise
+#                     must_respond_to
+#                     must_send
+#                     must_throw)

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification
+name: sundial
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Bob Larrick
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-04-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: &70204155777920 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70204155777920
+- !ruby/object:Gem::Dependency
+  name: geokit
+  requirement: &70204155777420 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70204155777420
+description: This gem calculates the sunrise and sunset at your current location.
+email:
+- larrick@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .rvmrc
+- Gemfile
+- Rakefile
+- examples/driver.rb
+- lib/numeric_extensions.rb
+- lib/sundial.rb
+- lib/sundial/version.rb
+- sundial.gemspec
+- test/sun_calculator_test.rb
+homepage: https://github.com/deathbob/Sundial
+licenses: []
+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: sundial
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: Gem to calculate the sunrise and sunset at your location
+test_files:
+- test/sun_calculator_test.rb