usno-eclipse-lunar 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d87a23db666946564ee8d9161d56449757b5c2a9
+  data.tar.gz: 1010ce72bf1d691548254590e4ac2fbfaf64e68d
+SHA512:
+  metadata.gz: eca7da6a963daa81a1e0f50a8d27293b638e93def5868c581656366e30b9b13be34a4feb97ba73d971084804b5e93be00bdc3110ca76e52f62687ce57ab19fb1
+  data.tar.gz: 917ae79a53b748f4c2f97b0436dacc449dd63cfe10551c0493cd17d217a9b239e5ece9a350ca8479585cb8e909e74a4e9a07ca39a64e372998f4c1a96a969f76

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.travis.yml

@@ -0,0 +1,13 @@
+language: ruby
+
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+
+rvm:
+  - 2.0.0
+  - 1.9.3
+  - 1.9.2
+  - ruby-head
+
+script: bundle exec rake test

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in usno-eclipse-lunar.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Ryan T. Hosford
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,38 @@
+# USNO::Eclipse::Lunar
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'usno-eclipse-lunar'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install usno-eclipse-lunar
+
+## Usage
+
+First, `require usno/eclipse/lunar`
+
+```ruby
+# e.g.
+USNO::Eclipse::Lunar::Data.new(lat: 87, long: 30, date: Time.new(2014, 10, 7)).call.data
+
+#or
+
+USNO::Eclipse::Lunar::Data.new(city: "Gulf Shores, state: "Alabama", date: Time.new(2014, 10, 7), request_class: USNO::Eclipse::Lunar::USRequest).call.data
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+  t.pattern = 'test/**/*_test.rb'
+  t.libs.push 'test'
+end
+
+task :default => :test

data/lib/usno/eclipse/lunar.rb

@@ -0,0 +1,17 @@
+require "pay_dirt"
+
+require_relative "lunar/version"
+
+require_relative "lunar/request"
+require_relative "lunar/data"
+require_relative "lunar/states"
+require_relative "lunar/eclipses"
+require_relative "lunar/us_request"
+require_relative "lunar/worldwide_request"
+
+module USNO
+  module Eclipse
+    module Eclipse::Lunar
+    end
+  end
+end

data/lib/usno/eclipse/lunar/data.rb

@@ -0,0 +1,42 @@
+module USNO
+  module Eclipse
+    module Lunar
+      class Data < PayDirt::Base
+        def initialize(options = {})
+          options = form_options(options)
+
+          load_options(:date, options) and validate_state
+        end
+
+        def call
+          result true, @request_class.new(@request_options).call.data
+        end
+
+        private
+        def form_options(options)
+          options = {
+            request_class: USNO::Eclipse::Lunar::WorldWideRequest,
+            z_meters:      0,           # Default: sea level
+            date: Time.new(2017, 8, 21) # Default: 2017 total eclipse
+          }.merge(options)
+
+          options.merge!({
+            request_options: options.reject do |k,_|
+              k.to_s == "request_class"
+            end
+          })
+        end
+
+        def validate_state
+          @z_meters.between?(-90, 10999) or raise %q{
+            Elevation (z_meters) out of range
+          } # Documented by USNO, but won't fail
+
+          (@city && @state) || (@lat && @long) or raise %q{
+            Location required.
+          }
+        end
+      end
+    end
+  end
+end

data/lib/usno/eclipse/lunar/eclipses.rb

@@ -0,0 +1,55 @@
+module USNO
+  module Eclipse
+    module Lunar
+      module Eclipses
+        def self.by_key_or_value(kv)
+          hash.has_value? kv and return kv
+
+          hash.fetch(formatted_date(kv)) {
+            raise "No known lunar eclipse at the provided time #{kv} - hint, try USNO::Eclipse::Lunar::Eclipses.all"
+          }.to_s
+        end
+
+        def self.fetch(kv)
+          by_key_or_value(kv)
+        end
+
+        def self.hash
+          {
+            "200929"   => 12009, "200977"   => 22009, "200985"   => 32009,
+            "200986"   => 32009, "20091231" => 42009, "2010626"  => 12010,
+            "20101221" => 22010, "2011615"  => 12011, "20111210" => 22011,
+            "201264"   => 12012, "20121128" => 22012, "2013425"  => 12013,
+            "2013525"  => 22013, "20131018" => 32013, "20131019" => 32013,
+            "2014415"  => 12014, "2014108"  => 22014
+          }
+        end
+
+        def self.formatted_date(date)
+          date.kind_of?(String) ? date : date.strftime("%Y%-m%-d")
+        end
+
+        # As reminders
+        def self.all
+          %w{
+            2009 February 9 (Penumbral)
+            2009 July 7 (Penumbral)
+            2009 August 5-6 (Penumbral)
+            2009 December 31 (Partial)
+            2010 June 26 (Partial)
+            2010 December 21 (Total)
+            2011 June 15 (Total)
+            2011 December 10 (Total)
+            2012 June 4 (Partial)
+            2012 November 28 (Penumbral)
+            2013 April 25 (Partial)
+            2013 May 25 (Penumbral)
+            2013 October 18-19 (Penumbral)
+            2014 April 15 (Total)
+            2014 October 8 (Total)
+          }
+        end
+      end
+    end
+  end
+end

data/lib/usno/eclipse/lunar/request.rb

@@ -0,0 +1,34 @@
+require "uri"
+require "net/http"
+
+module USNO
+  module Eclipse
+    module Lunar
+      module  Request
+        private
+        def request_response(url = "http://aa.usno.navy.mil/cgi-bin/aa_lunecl.pl")
+          uri = URI.parse(url)
+
+          response = Net::HTTP.start(uri.host) do |http|
+            request = Net::HTTP::Post.new(uri.path)
+
+            http_headers.map { |k, v| request[k] = v }
+            request.body = request_body
+
+            http.request request
+          end
+        end
+
+        def http_headers
+          {
+            "Accept" => "text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,*/*;q=0.8",
+            "Accept-Language" => "en-US,en;q=0.5",
+            "Accept-Encoding" => "gzip,deflate,sdch",
+            "Referer" => "http://aa.usno.navy.mil/data/docs/LunarEclipse.php"
+          }
+        end
+      end
+    end
+  end
+end
+

data/lib/usno/eclipse/lunar/states.rb

@@ -0,0 +1,36 @@
+module USNO
+  module Eclipse
+    module Lunar
+      module States
+        def self.states
+          {
+            "Alabama"              => "AL", "Alaska"         => "AK", "American Samoa" => "AS",
+            "Arizona"              => "AZ", "Arkansas"       => "AR", "California"     => "CA",
+            "Colorado"             => "CO", "Connecticut"    => "CT", "Delaware"       => "DE",
+            "District of Columbia" => "DC", "Florida"        => "FL", "Georgia"        => "GA",
+            "Guam"                 => "GU", "Hawaii"         => "HI", "Idaho"          => "ID",
+            "Indiana"              => "IN", "Iowa"           => "IA", "Kansas"         => "KS",
+            "Kentucky"             => "KY", "Louisiana"      => "LA", "Maine"          => "ME",
+            "Maryland"             => "MD", "Massachusetts"  => "MA", "Michigan"       => "MI",
+            "Minnesota"            => "MN", "Mississippi"    => "MS", "Missouri"       => "MO",
+            "Montana"              => "MT", "Nebraska"       => "NE", "Nevada"         => "NV",
+            "New Hampshire"        => "NH", "New Jersey"     => "NJ", "New Mexico"     => "NM",
+            "New York"             => "NY", "North Carolina" => "NC", "North Dakota"   => "ND",
+            "N. Mariana Islands"   => "MP", "Ohio"           => "OH", "Oklahoma"       => "OK",
+            "Oregon"               => "OR", "Pennsylvania"   => "PA", "Puerto Rico"    => "PR",
+            "Rhode Island"         => "RI", "South Carolina" => "SC", "South Dakota"   => "SD",
+            "Tennessee"            => "TN", "Texas"          => "TX", "Utah"           => "UT",
+            "Vermont"              => "VT", "Virgin Islands" => "VI", "Virginia"       => "VA",
+            "Washington"           => "WA", "West Virginia"  => "WV", "Wisconsin"      => "WI",
+            "Wyoming"              => "WY", "Illinois"       => "IL"
+          }
+        end
+
+        def self.by_key_or_value(kv)
+          states.has_value? kv and return kv
+          states.fetch(kv) { raise "USNO State not recognized" }
+        end
+      end
+    end
+  end
+end

data/lib/usno/eclipse/lunar/us_request.rb

@@ -0,0 +1,39 @@
+require "uri"
+require "net/http"
+
+module USNO
+  module Eclipse
+    module Lunar
+      class USRequest < PayDirt::Base
+        include USNO::Eclipse::Lunar::Request
+
+        def initialize(options = {})
+          options = {
+          }.merge(options)
+
+          load_options(:city, :state, :date, options)
+        end
+
+        def call
+          return result(true, request_response.body)
+        end
+
+        private
+        def place
+          "st=#{USNO::Eclipse::Lunar::States.by_key_or_value(@state)}&place=#{@city}&hh1=#{@z_meters}"
+        end
+
+
+
+        def request_body
+          %W{
+            FFX=1
+            xxecl=#{USNO::Eclipse::Lunar::Eclipses.fetch(@date)}
+            #{place}
+            ZZZ=END
+          }.join("&")
+        end
+      end
+    end
+  end
+end

data/lib/usno/eclipse/lunar/version.rb

@@ -0,0 +1,7 @@
+module USNO
+  module Eclipse
+    module Lunar
+      VERSION = "0.0.1"
+    end
+  end
+end

data/lib/usno/eclipse/lunar/worldwide_request.rb

@@ -0,0 +1,73 @@
+require "uri"
+require "net/http"
+
+module USNO
+  module Eclipse
+    module Lunar
+      class WorldWideRequest < PayDirt::Base
+        include USNO::Eclipse::Lunar::Request
+
+        def initialize(options = {})
+          options = {
+            z_meters:    0,
+          }.merge(options)
+
+
+          load_options(:long, :lat, :date, options) and validate_state
+        end
+
+        def call
+          return result(true, request_response.body)
+        end
+
+        private
+        def place
+          %W{
+            place=#{ @place || @city || "None given" }
+            #{elevation}
+            #{coordinates}
+          }.join("&")
+        end
+
+        def elevation
+          "hh1=#{@z_meters}"
+        end
+
+        def coordinates
+          %W{
+            xx0=#{ sign_of(@long) }
+            xx1=#{ @long.abs }
+            xx2=#{ @long_minutes }
+            xx3=#{ @long_seconds }
+            yy1=#{ @lat.abs }
+            yy2=#{ @lat_minutes }
+            yy3=#{ @lat_seconds }
+            yy0=#{ sign_of(@lat) }
+          }.join("&")
+        end
+
+        def sign_of(int)
+          int.zero? ? int.next : int / int.abs
+        end
+
+        def request_body
+          %W{
+            FFX=2
+            #{place}
+            xxecl=#{USNO::Eclipse::Lunar::Eclipses.fetch(@date)}
+            ZZZ=END
+          }.join("&")
+        end
+
+        def validate_state
+          @lat.between?(-90, 90) or raise %q{
+            Latitude (lat) out of range
+          }
+          @long.between?(-180, 180) or raise %q{
+            Longitude (long) out of range
+          }
+        end
+      end
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,10 @@
+require 'coveralls'
+Coveralls.wear!
+
+require "minitest/autorun"
+
+# The gem
+$: << File.dirname(__FILE__) + "/../lib"
+$: << File.dirname(__FILE__)
+
+require "usno/eclipse/lunar"

data/test/unit/usno/eclipse/lunar/sun_test.rb

@@ -0,0 +1,17 @@
+#require "test_helper"
+
+#describe USNO::Transit::Sun do
+#  before do
+#    @subject = USNO::Transit::Sun
+#  end
+
+#  describe "calling for data" do
+#    it "will raise without location dependencies" do
+#      -> { @subject.new.call }.must_raise RuntimeError
+#    end
+
+#    it "wont raise with location dependencies" do
+#      @subject.new(city: "Birmingham", state: "Alabama").call.must_respond_to :data
+#    end
+#  end
+#end

data/test/unit/usno/eclipse/lunar/us_request_test.rb

@@ -0,0 +1,33 @@
+require 'test_helper'
+
+describe USNO::Eclipse::Lunar::USRequest do
+  before do
+    @subject = USNO::Eclipse::Lunar::USRequest
+    @params = {
+      city: "Birmingham",
+      state: "AL",
+      z_meters: 0,
+      date: "2014108"
+    }
+  end
+
+  describe "as a class" do
+    it "initializes properly" do
+      @subject.new(@params).must_respond_to :call
+    end
+
+    it "errors when initialized without required dependencies" do
+      -> { @subject.new(@params.reject { |k| k.to_s == 'city' }) }.must_raise RuntimeError
+      -> { @subject.new(@params.reject { |k| k.to_s == 'state' }) }.must_raise RuntimeError
+    end
+  end
+
+  describe "as an instance" do
+    it "executes successfully" do
+      result = @subject.new(@params).call
+      result.successful?.must_equal true
+      result.data.must_include("BIRMINGHAM, AL")
+      result.must_be_kind_of PayDirt::Result
+    end
+  end
+end

data/test/unit/usno/eclipse/lunar/view_test.rb

@@ -0,0 +1,16 @@
+require "test_helper"
+include Minitest::Assertions
+
+describe USNO::Eclipse::Lunar::Data do
+  before do
+    @subject = USNO::Eclipse::Lunar::Data
+    @valid_eclipses = USNO::Eclipse::Lunar::Eclipses.hash.values
+  end
+  describe "as an instance" do
+    it "instantiates for each valid eclipse" do
+      @valid_eclipses.each do |k|
+        assert_instance_of(@subject, @subject.new(lat: 0, long: 0, date: k))
+      end
+    end
+  end
+end

data/test/unit/usno/eclipse/lunar/worldwide_request_test.rb

@@ -0,0 +1,34 @@
+require 'test_helper'
+
+describe USNO::Eclipse::Lunar::WorldWideRequest do
+  before do
+    @subject = USNO::Eclipse::Lunar::WorldWideRequest
+    @params = {
+      city: "Greenwich Test",
+      z_meters: 0,
+      long:     30,
+      lat:      87,
+      date: "2014108"
+    }
+  end
+
+  describe "as a class" do
+    it "initializes properly" do
+      @subject.new(@params).must_respond_to :call
+    end
+
+    it "errors when initialized without required dependencies" do
+      -> { @subject.new(@params.reject { |k| k.to_s == 'lat' }) }.must_raise RuntimeError
+      -> { @subject.new(@params.reject { |k| k.to_s == 'long' }) }.must_raise RuntimeError
+    end
+  end
+
+  describe "as an instance" do
+    it "executes successfully" do
+      result = @subject.new(@params).call
+      result.successful?.must_equal true
+      result.data.must_include "GREENWICH TEST"
+      result.must_be_kind_of PayDirt::Result
+    end
+  end
+end

data/usno-eclipse-lunar.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'usno/eclipse/lunar/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "usno-eclipse-lunar"
+  spec.version       = USNO::Eclipse::Lunar::VERSION
+  spec.authors       = ["Ryan T. Hosford"]
+  spec.email         = ["tad.hosford@gmail.com"]
+  spec.description   = %q{Obtain the circumstances of recent and upcoming lunar eclipses for any location}
+  spec.summary       = %q{}
+  spec.homepage      = "http://ea.rthbound.com/usno"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "pay_dirt"
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "coveralls"
+  spec.add_development_dependency "minitest"
+end

metadata

@@ -0,0 +1,140 @@
+--- !ruby/object:Gem::Specification
+name: usno-eclipse-lunar
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Ryan T. Hosford
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pay_dirt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Obtain the circumstances of recent and upcoming lunar eclipses for any
+  location
+email:
+- tad.hosford@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/usno/eclipse/lunar.rb
+- lib/usno/eclipse/lunar/data.rb
+- lib/usno/eclipse/lunar/eclipses.rb
+- lib/usno/eclipse/lunar/request.rb
+- lib/usno/eclipse/lunar/states.rb
+- lib/usno/eclipse/lunar/us_request.rb
+- lib/usno/eclipse/lunar/version.rb
+- lib/usno/eclipse/lunar/worldwide_request.rb
+- test/test_helper.rb
+- test/unit/usno/eclipse/lunar/sun_test.rb
+- test/unit/usno/eclipse/lunar/us_request_test.rb
+- test/unit/usno/eclipse/lunar/view_test.rb
+- test/unit/usno/eclipse/lunar/worldwide_request_test.rb
+- usno-eclipse-lunar.gemspec
+homepage: http://ea.rthbound.com/usno
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: ''
+test_files:
+- test/test_helper.rb
+- test/unit/usno/eclipse/lunar/sun_test.rb
+- test/unit/usno/eclipse/lunar/us_request_test.rb
+- test/unit/usno/eclipse/lunar/view_test.rb
+- test/unit/usno/eclipse/lunar/worldwide_request_test.rb