nasa-neo 1.3.1 → 1.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e27ce374fa0c996d1c8ab7f8b9c3737c9ec74fe09739131ea94182d4a29a3fb8
-  data.tar.gz: '043791aa288feee62d4950e260257dfeaaaeb48e8c9b21e110ca671b45ce6471'
+  metadata.gz: 39c3b2f4dcea89280298b2742156c13eb30d249558d7e86ab46475ec458149c4
+  data.tar.gz: 3e4211e5ecea32b7c40962d7858529287917f923f80b819c19136f704c0d4dce
 SHA512:
-  metadata.gz: 8e486bd7667154fac645622eb1ee25800c3accf76bd25d8bb2d3a0a2d7cd909c7e1969df615d7ebdd2a15a838e33844495aa41e2f291661f1f72ffc32c7be0dc
-  data.tar.gz: 6c84a545498950d3296caa425c561756ec61f60c98a9cc1a39ed5d66ec4d389ef5f59bfc9f6b9733f5971c182221c3ccea99d024e250d2155d50ca5b9c752a64
+  metadata.gz: 9b886908d2c30577bfd60365a89bf0881da783ca45c10d2974ccfeaddab6ceb10b7e797a9e40d84bf43a092a129a5b57b9fbb665514cade185e202fb6f00748e
+  data.tar.gz: 6dec97d322e25a330539b1a57006a4a4d549cd1ec8602b8bd29d679763df019b21104b9361e509ab48d8ceca0ec8fed1154275eeb88328d5303cb804b39005eb

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    nasa-neo (1.3.1)
+    nasa-neo (1.3.2)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -209,6 +209,16 @@ Returns:
 ```
 nil
 ```
+---
+Example of return if numbered information not present outside year range, eg. if selected miss distance in miles of Near Earth Object is not present (applicable to #miss_distance and #velocity with valid arguments):
+```
+client.date = "2400-01-01"
+client.miss_distance("miles")
+```
+Returns:
+```
+0.0
+```
 
 
 ### Testing

data/lib/nasa-neo/client.rb

@@ -7,6 +7,16 @@ module NasaNeo
   module CloseObj
     class Client
 
+      ESTIMATED_DIAMETER_OPTIONS = ["kilometers", "meters", "miles", "feet"]
+      MISS_DISTANCE_OPTIONS = ["astronomical", "lunar", "kilometers", "miles"]
+      VELOCITY_OPTIONS = ["kilometers_per_second", "kilometers_per_hour", "miles_per_hour"]
+
+      NEO_NAME_KEYS = ["name"]
+      HAZARDOUS_KEYS = ["is_potentially_hazardous_asteroid"]
+      ESTIMATED_DIAMETER_KEYS = ["estimated_diameter"]
+      MISS_DISTANCE_KEYS = ["close_approach_data", 0, "miss_distance"]
+      VELOCITY_KEYS = ["close_approach_data", 0, "relative_velocity"]
+
       attr_accessor :date, :key
 
       def initialize(config)
@@ -16,40 +26,37 @@ module NasaNeo
         @full_url = nil
         @result = nil
         @neo_position = 0
-        @estimated_diameter_options = ["kilometers", "meters", "miles", "feet"]
-        @miss_distance_options = ["astronomical", "lunar", "kilometers", "miles"]
-        @velocity_options = ["kilometers_per_second", "kilometers_per_hour", "miles_per_hour"]
       end
 
       def estimated_diameter(measurement = nil, min_max = nil)
-        if @estimated_diameter_options.include? measurement
+        if ESTIMATED_DIAMETER_OPTIONS.include? measurement
           if ["min", "max"].include? min_max
-            call_and_rescue { estimated_diameter_data[measurement]["estimated_diameter_#{min_max}"] }
+            call_and_rescue { retrieve_neo(ESTIMATED_DIAMETER_KEYS + ["#{measurement}", "estimated_diameter_#{min_max}"]) }
           else
-            min_max == nil ? call_and_rescue { estimated_diameter_data[measurement] }
+            min_max == nil ? call_and_rescue { retrieve_neo(ESTIMATED_DIAMETER_KEYS + ["#{measurement}"]) }
                            : error_feedback(['min_max', 'check arguments'])
           end
         else
-          measurement == nil ? call_and_rescue { estimated_diameter_data }
+          measurement == nil ? call_and_rescue { retrieve_neo(ESTIMATED_DIAMETER_KEYS) }
                              : error_feedback(['measurement', 'check arguments'])
         end
       end
 
       def hazardous?
-        call_and_rescue { hazardous_data }
+        call_and_rescue { retrieve_neo(HAZARDOUS_KEYS) }
       end
 
       def miss_distance(measurement = nil)
-        if @miss_distance_options.include? measurement
-          call_and_rescue { miss_distance_data[measurement].to_f }
+        if MISS_DISTANCE_OPTIONS.include? measurement
+          call_and_rescue { retrieve_neo(MISS_DISTANCE_KEYS + ["#{measurement}"]).to_f }
         else
-          measurement == nil ? call_and_rescue { miss_distance_data }
+          measurement == nil ? call_and_rescue { retrieve_neo(MISS_DISTANCE_KEYS) }
                              : error_feedback(['measurement', 'check arguments'])
         end
       end
 
       def neo_name
-        call_and_rescue { neo_name_data }
+        call_and_rescue { retrieve_neo(NEO_NAME_KEYS) }
       end
 
       def neo_data
@@ -62,7 +69,6 @@ module NasaNeo
         else
           @result["element_count"]
         end
-
       end
 
       def update
@@ -74,10 +80,10 @@ module NasaNeo
       end
 
       def velocity(measurement = nil)
-        if @velocity_options.include? measurement
-          call_and_rescue { velocity_data[measurement].to_f }
+        if VELOCITY_OPTIONS.include? measurement
+          call_and_rescue { retrieve_neo(VELOCITY_KEYS + ["#{measurement}"]).to_f }
         else
-          measurement == nil ? call_and_rescue { velocity_data }
+          measurement == nil ? call_and_rescue { retrieve_neo(VELOCITY_KEYS) }
                              : error_feedback(['measurement', 'check arguments'])
         end
       end
@@ -97,6 +103,7 @@ module NasaNeo
 
       def get_api_data
         @full_url = set_full_url
+        @neo_position = 0
         buffer = JSON.parse(buffer_url)
         @result = buffer
       end
@@ -105,40 +112,16 @@ module NasaNeo
         Time.now.strftime("%Y-%m-%d")
       end
 
-      def retrieve_neo
+      def retrieve_neo(keys = [])
         get_api_data if @full_url != set_full_url
-        @result.dig("near_earth_objects", "#{@date}", @neo_position)
-      end
-
-      def estimated_diameter_data
-        data = retrieve_neo
-        data == nil ? nil : data["estimated_diameter"]
+        root_keys = ["near_earth_objects", "#{@date}", @neo_position]
+        @result.dig(*root_keys + keys)
       end
 
       def error_feedback(error_info)
         { 'error': error_info }
       end
 
-      def hazardous_data
-        data = retrieve_neo
-        data == nil ? nil : data["is_potentially_hazardous_asteroid"]
-      end
-
-      def miss_distance_data
-        data = retrieve_neo
-        data == nil ? nil : data["close_approach_data"][0]["miss_distance"]
-      end
-
-      def neo_name_data
-        data = retrieve_neo
-        data == nil ? nil : data["name"]
-      end
-
-      def velocity_data
-        data = retrieve_neo
-        data == nil ? nil : data["close_approach_data"][0]["relative_velocity"]
-      end
-
       def set_full_url
         "#{@config.host}?start_date=#{@date}&end_date=#{@date}&detailed=false&api_key=#{@key}"
       end

data/lib/nasa-neo/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module NasaNeo
-  VERSION = "1.3.1".freeze
+  VERSION = "1.3.2".freeze
 end

data/nasa-neo.gemspec

@@ -4,10 +4,10 @@ require "nasa-neo/version"
 
 Gem::Specification.new do |s|
   s.name        = 'nasa-neo'
-  s.version     = '1.3.1'
+  s.version     = '1.3.2'
   s.date        = '2019-04-09'
   s.summary     = "This gem provides a simple wrapper for https://api.nasa.gov/api.html#NeoWS API"
-  s.description = "Retrieve information about the closest near earth object on any given day using the NASA NEO API. "
+  s.description = "Retrieve information about the closest near earth objects on any given day using the NASA NEO API. "
   s.authors     = ["James Sutherland"]
   s.email       = 'jrsutherland78@googlemail.com'
   s.homepage    = 'https://github.com/LondonJim/NASA-NEO-API-Wrapper'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nasa-neo
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 1.3.2
 platform: ruby
 authors:
 - James Sutherland
@@ -78,7 +78,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 3.5.1
-description: 'Retrieve information about the closest near earth object on any given
+description: 'Retrieve information about the closest near earth objects on any given
   day using the NASA NEO API. '
 email: jrsutherland78@googlemail.com
 executables: []