usno-imagery 0.0.2 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e635a7a0006c8efbfecce9618349c0ecbdb94e93
-  data.tar.gz: 29a7964ba0a2e0bc21e56cff81e99f1fb7c90efb
+  metadata.gz: 3111708e4b2554709cc8b5f8478d2c5bf9e2f383
+  data.tar.gz: 9cae9895b598cda54a7f801c442e0a20e7b2198b
 SHA512:
-  metadata.gz: de467e9589318066714c15ca8993a08db1587fdf798600c692f330ce3c690d22f21e93fda8e78cc0b4308c1eee3905ad979b0d911f566d500dd843075e32ab38
-  data.tar.gz: 5c25e463903f479245d5cc50cdcbd1c647d91264d5fec5a171e99de2b725c80cbcb37427b9ab2ded7eefb42c107de1d0c398aec5ab1fb30ed6cf7dc09b44abbf
+  metadata.gz: e10fb7cc6dfc408b6118a047453bc679f38b33bb32e46b91d715bbfcb230590d29e047c91e4d413452084af7e533641535b06129a6558eeece60c986c8ce3b8c
+  data.tar.gz: 71e94813ee4bd84db37e88fb38042e23be75a0f1b29f8a143343dad1d7c46635d0f5717fc5ee3520e28dbf600f9a815f9223924ba43182a4087822878be04d03

data/README.md

@@ -18,32 +18,31 @@ Or install it yourself as:
 
 ## Usage
 
-Warning! This library will be changing a lot as I explore the nooks and crannies of USNO's imagery data services.
-
 #### USNO::Imagery::Earth
 
 The earth namespace will contain classes for viewing USNO's earth images.
-Currently there are three classes here: `Map`, `Sphere`, `Rise`, and `Set`
-
-A view of the earth projected onto a 2D plane (at any given time):
-
-    USNO::Imagery::Earth::Map.new(time: Time.now).call.data
-    #=> "http://api.usno.navy.mil/imagery/earth.png?view=full&date=11/08/2013&time=20:32"
-
-A spherical view of the earth as seen from the moon (at any given time)
 
-    USNO::Imagery::Earth::Sphere.new(time: Time.now).call.data
-    #=> "http://api.usno.navy.mil/imagery/earth.png?view=moon&date=11/08/2013&time=20:31"
+```ruby
+# For an image of the entire earth (Mercator projection) with day / night
+USNO::Imagery::Earth::Map.new(time: Time.now).call.data
+  #=> "http://api.usno.navy.mil/imagery/earth.png?view=full&date=11/17/2013&time=1:11"
 
-A current view of the earth's sunrise
+# For an image of the earth as seen from the sun
+USNO::Imagery::Earth::Sun.new(time: Time.now).call.data
+  #=> "http://api.usno.navy.mil/imagery/earth.png?view=sun&date=11/17/2013&time=1:13"
 
-    USNO::Imagery::Earth::Rise.new.call.data
-    => "http://api.usno.navy.mil/imagery/earth.png?view=rise"
+# For an image of the earth as seen from the moon
+USNO::Imagery::Earth::Moon.new(time: Time.now).call.data
+  #=> "http://api.usno.navy.mil/imagery/earth.png?view=moon&date=11/17/2013&time=1:12"
 
-A current view of the earth's sunset
+# For an image of the entire earth at sunrise
+USNO::Imagery::Earth::Rise.new.call.data
+  #=> "http://api.usno.navy.mil/imagery/earth.png?view=rise"
 
-    USNO::Imagery::Earth::Set.new.call.data
-    #=> "http://api.usno.navy.mil/imagery/earth.png?view=set"
+# For an image of the entire earth at sunset
+USNO::Imagery::Earth::Set.new.call.data
+  #=> "http://api.usno.navy.mil/imagery/earth.png?view=set"
+```
 
 ## Contributing
 

data/lib/usno/imagery.rb

@@ -1,8 +1,11 @@
 require_relative "imagery/version"
+require_relative "imagery/earth/view"
+
 require_relative "imagery/earth/map"
-require_relative "imagery/earth/sphere"
 require_relative "imagery/earth/rise"
 require_relative "imagery/earth/set"
+require_relative "imagery/earth/sun"
+require_relative "imagery/earth/moon"
 
 module USNO
   module Imagery

data/lib/usno/imagery/earth/map.rb

@@ -6,31 +6,20 @@ module USNO
       class Map < PayDirt::Base
         def initialize(options = {})
           options = {
-            time:     Time.now,
-            root_url: "http://api.usno.navy.mil/",
-            resource: self.class.name.downcase.split("::")[1..-2].join("/") + ".png"
+            view: "full",
+            usno_imagery_class: USNO::Imagery::Earth::View
           }.merge(options)
 
           # sets instance variables from key value pairs,
           # will fail if any keys given before options aren't in options
-          load_options(:time, :root_url, :resource, options)
+          load_options(:view, :usno_imagery_class, options)
         end
 
         def call
-          result(true, query_for(@root_url + @resource))
-        end
-
-        private
-        def query_for(resource)
-          "#{resource}?view=full&date=#{date}&time=#{time}"
-        end
-
-        def date
-          @time.utc.strftime("%m/%d/%Y")
-        end
-
-        def time
-          @time.utc.strftime("%k:%M").lstrip
+          result true, @usno_imagery_class.new({
+            view: @view,
+            time: @time || Time.now
+          }).call.data
         end
       end
     end

data/lib/usno/imagery/earth/moon.rb

@@ -0,0 +1,27 @@
+require 'pay_dirt'
+
+module USNO
+  module Imagery
+    module Earth
+      class Moon < PayDirt::Base
+        def initialize(options = {})
+          options = {
+            view: "moon",
+            usno_imagery_class: USNO::Imagery::Earth::View
+          }.merge(options)
+
+          # sets instance variables from key value pairs,
+          # will fail if any keys given before options aren't in options
+          load_options(:view, :usno_imagery_class, options)
+        end
+
+        def call
+          result true, @usno_imagery_class.new({
+            view: @view,
+            time: @time || Time.now
+          }).call.data
+        end
+      end
+    end
+  end
+end

data/lib/usno/imagery/earth/rise.rb

@@ -6,23 +6,20 @@ module USNO
       class Rise < PayDirt::Base
         def initialize(options = {})
           options = {
-            root_url: "http://api.usno.navy.mil/",
-            resource: self.class.name.downcase.split("::")[1..-2].join("/") + ".png",
-            view:     self.class.name.downcase.split("::")[-1]
+            view: "rise",
+            usno_imagery_class: USNO::Imagery::Earth::View
           }.merge(options)
 
           # sets instance variables from key value pairs,
           # will fail if any keys given before options aren't in options
-          load_options(:view, options)
+          load_options(:view, :usno_imagery_class, options)
         end
 
         def call
-          result(true, query_for(@root_url + @resource))
-        end
-
-        private
-        def query_for(resource)
-          "#{resource}?view=#{@view}"
+          result true, @usno_imagery_class.new({
+            view: @view,
+            time: nil
+          }).call.data
         end
       end
     end

data/lib/usno/imagery/earth/set.rb

@@ -1,9 +1,27 @@
 require 'pay_dirt'
 
+
 module USNO
   module Imagery
     module Earth
-      class Set < Rise
+      class Set < PayDirt::Base
+        def initialize(options = {})
+          options = {
+            view: "set",
+            usno_imagery_class: USNO::Imagery::Earth::View
+          }.merge(options)
+
+          # sets instance variables from key value pairs,
+          # will fail if any keys given before options aren't in options
+          load_options(:view, :usno_imagery_class, options)
+        end
+
+        def call
+          result true, @usno_imagery_class.new({
+            view: @view,
+            time: nil
+          }).call.data
+        end
       end
     end
   end

data/lib/usno/imagery/earth/sun.rb

@@ -0,0 +1,27 @@
+require 'pay_dirt'
+
+module USNO
+  module Imagery
+    module Earth
+      class Sun < PayDirt::Base
+        def initialize(options = {})
+          options = {
+            view: "sun",
+            usno_imagery_class: USNO::Imagery::Earth::View
+          }.merge(options)
+
+          # sets instance variables from key value pairs,
+          # will fail if any keys given before options aren't in options
+          load_options(:view, :usno_imagery_class, options)
+        end
+
+        def call
+          result true, @usno_imagery_class.new({
+            view: @view,
+            time: @time || Time.now
+          }).call.data
+        end
+      end
+    end
+  end
+end

data/lib/usno/imagery/earth/{sphere.rb → view.rb}

@@ -3,7 +3,7 @@ require 'pay_dirt'
 module USNO
   module Imagery
     module Earth
-      class Sphere < PayDirt::Base
+      class View < PayDirt::Base
         def initialize(options = {})
           options = {
             time:     Time.now,
@@ -13,7 +13,7 @@ module USNO
 
           # sets instance variables from key value pairs,
           # will fail if any keys given before options aren't in options
-          load_options(:time, :root_url, :resource, options)
+          load_options(:time, :root_url, :resource, :view, options) and validate_state
         end
 
         def call
@@ -22,7 +22,7 @@ module USNO
 
         private
         def query_for(resource)
-          "#{resource}?view=moon&date=#{date}&time=#{time}"
+          "#{ resource }?view=#{ @view }" + time
         end
 
         def date
@@ -30,7 +30,13 @@ module USNO
         end
 
         def time
-          @time.utc.strftime("%H:%M")
+          @time ? "&date=#{ date }&time=#{ @time.utc.strftime("%k:%M").lstrip }" : ""
+        end
+
+        def validate_state
+          ["full", "moon", "sun", "rise", "set"].include? @view or raise(
+            ":view not recognized - #{@view}"
+          )
         end
       end
     end

data/lib/usno/imagery/version.rb

@@ -1,5 +1,5 @@
 module USNO
   module Imagery
-    VERSION = "0.0.2"
+    VERSION = "0.1.0"
   end
 end

data/test/test_helper.rb

@@ -1,12 +1,18 @@
-require 'coveralls'
-Coveralls.wear!
+#require 'coveralls'
+#Coveralls.wear!
+require 'simplecov'
+SimpleCov.start
 
 require "minitest/autorun"
 
 # The gem
 $: << File.dirname(__FILE__) + "/../lib"
 $: << File.dirname(__FILE__)
-require "usno/imagery/earth/map"
-require "usno/imagery/earth/sphere"
+
+require "usno/imagery"
+require "usno/imagery/earth/view"
+require "usno/imagery/earth/sun"
+require "usno/imagery/earth/moon"
 require "usno/imagery/earth/rise"
 require "usno/imagery/earth/set"
+require "usno/imagery/earth/map"

data/test/unit/usno/imagery/earth/map_test.rb

@@ -4,7 +4,7 @@ describe USNO::Imagery::Earth::Map do
   before do
     @subject = USNO::Imagery::Earth::Map
     @params = {
-      time: Time.now,
+      view: "full"
     }
   end
 

data/test/unit/usno/imagery/earth/{sphere_test.rb → moon_test.rb}

@@ -1,10 +1,10 @@
 require 'test_helper'
 
-describe USNO::Imagery::Earth::Sphere do
+describe USNO::Imagery::Earth::Moon do
   before do
-    @subject = USNO::Imagery::Earth::Sphere
+    @subject = USNO::Imagery::Earth::Moon
     @params = {
-      time: Time.now,
+      view: "moon",
     }
   end
 

data/test/unit/usno/imagery/earth/rise_test.rb

@@ -3,17 +3,20 @@ require 'test_helper'
 describe USNO::Imagery::Earth::Rise do
   before do
     @subject = USNO::Imagery::Earth::Rise
+    @params = {
+      view: "rise"
+    }
   end
 
   describe "as a class" do
     it "initializes properly" do
-      @subject.new.must_respond_to :call
+      @subject.new(@params).must_respond_to :call
     end
   end
 
   describe "as an instance" do
     it "executes successfully" do
-      result = @subject.new.call
+      result = @subject.new(@params).call
       result.successful?.must_equal true
       result.must_be_kind_of PayDirt::Result
     end

data/test/unit/usno/imagery/earth/set_test.rb

@@ -3,17 +3,20 @@ require 'test_helper'
 describe USNO::Imagery::Earth::Set do
   before do
     @subject = USNO::Imagery::Earth::Set
+    @params = {
+      view: "set"
+    }
   end
 
   describe "as a class" do
     it "initializes properly" do
-      @subject.new.must_respond_to :call
+      @subject.new(@params).must_respond_to :call
     end
   end
 
   describe "as an instance" do
     it "executes successfully" do
-      result = @subject.new.call
+      result = @subject.new(@params).call
       result.successful?.must_equal true
       result.must_be_kind_of PayDirt::Result
     end

data/test/unit/usno/imagery/earth/sun_test.rb

@@ -0,0 +1,24 @@
+require 'test_helper'
+
+describe USNO::Imagery::Earth::Sun do
+  before do
+    @subject = USNO::Imagery::Earth::Sun
+    @params = {
+      view: "sun",
+    }
+  end
+
+  describe "as a class" do
+    it "initializes properly" do
+      @subject.new(@params).must_respond_to :call
+    end
+  end
+
+  describe "as an instance" do
+    it "executes successfully" do
+      result = @subject.new(@params).call
+      result.successful?.must_equal true
+      result.must_be_kind_of PayDirt::Result
+    end
+  end
+end

data/test/unit/usno/imagery/earth/view_test.rb

@@ -0,0 +1,29 @@
+require 'test_helper'
+
+describe USNO::Imagery::Earth::View do
+  before do
+    @subject = USNO::Imagery::Earth::View
+    @params = {
+      time: nil,
+      view: "rise",
+    }
+  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 == 'view' }) }.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.must_be_kind_of PayDirt::Result
+    end
+  end
+end

data/usno-imagery.gemspec

@@ -23,6 +23,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake"
   spec.add_development_dependency "pry"
   spec.add_development_dependency "coveralls"
+  spec.add_development_dependency "simplecov"
   spec.add_development_dependency "minitest"
   spec.add_runtime_dependency "pay_dirt"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: usno-imagery
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors:
 - Ryan T. Hosford
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-16 00:00:00.000000000 Z
+date: 2013-11-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -66,6 +66,20 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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
@@ -108,15 +122,19 @@ files:
 - Rakefile
 - lib/usno/imagery.rb
 - lib/usno/imagery/earth/map.rb
+- lib/usno/imagery/earth/moon.rb
 - lib/usno/imagery/earth/rise.rb
 - lib/usno/imagery/earth/set.rb
-- lib/usno/imagery/earth/sphere.rb
+- lib/usno/imagery/earth/sun.rb
+- lib/usno/imagery/earth/view.rb
 - lib/usno/imagery/version.rb
 - test/test_helper.rb
 - test/unit/usno/imagery/earth/map_test.rb
+- test/unit/usno/imagery/earth/moon_test.rb
 - test/unit/usno/imagery/earth/rise_test.rb
 - test/unit/usno/imagery/earth/set_test.rb
-- test/unit/usno/imagery/earth/sphere_test.rb
+- test/unit/usno/imagery/earth/sun_test.rb
+- test/unit/usno/imagery/earth/view_test.rb
 - usno-imagery.gemspec
 homepage: ''
 licenses:
@@ -145,6 +163,8 @@ summary: Consumes USNO's imagery data services
 test_files:
 - test/test_helper.rb
 - test/unit/usno/imagery/earth/map_test.rb
+- test/unit/usno/imagery/earth/moon_test.rb
 - test/unit/usno/imagery/earth/rise_test.rb
 - test/unit/usno/imagery/earth/set_test.rb
-- test/unit/usno/imagery/earth/sphere_test.rb
+- test/unit/usno/imagery/earth/sun_test.rb
+- test/unit/usno/imagery/earth/view_test.rb