nasa-neo 1.1.2 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 65e17a8c2be717f59b6c88854c112d71aab1b2cfd48b9c8e1f48aaa8e9cf8e0e
-  data.tar.gz: 1576378bea0f10f63937351b6f6c5d9100bea8dc699261962524f9f6de4b835e
+  metadata.gz: 05daf1bedded0b0e75c38f2904a5a0e2cf991d1e4dc0f1a0ed0c0da246564508
+  data.tar.gz: d1e4a20ff50b5642cb2bf62e0d0cb6ec2ec3915c84e582763d0378f3affecfd8
 SHA512:
-  metadata.gz: dc97e34b7ed99b54b1aaa703b90e8edd77cebeba771a94adbce5b834e9051e8ace5f36767439c768f86726327b21db6b2167e43a8066b62d0cfc0148a6b0c2b8
-  data.tar.gz: 043fd48d0d6e62b028042a7b6ba91ccd8815a756ebb90ffb86980b3574ddb0785597f7f2831a2baca41434c1b7ee914d2ece09d6c2b722f9468674633190b7cb
+  metadata.gz: 2381142f3cf7f95b81b56d968b4c85d61b3089d33fae7ea2d507beac8ec82d2cfda384c9d4ee4836f5af1c6728c64cf306b508a9227525339eb77c23fefdc7d7
+  data.tar.gz: 2e571042bb5248f03cfcc9fa587e819efa6304666359e23d4595a98497ba095084da700fecf9e6f0d7070f3c69c7991ccf0a1c069ef13599b0036660fa071ed7

data/Gemfile.lock

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

data/README.md

@@ -73,7 +73,24 @@ Example return:
 ```
 {"kilometers"=>{"estimated_diameter_min"=>0.1838886721, "estimated_diameter_max"=>0.411187571}, "meters"=>{"estimated_diameter_min"=>183.8886720703, "estimated_diameter_max"=>411.1875710413}, "miles"=>{"estimated_diameter_min"=>0.1142630881, "estimated_diameter_max"=>0.2555000322}, "feet"=>{"estimated_diameter_min"=>603.309310875, "estimated_diameter_max"=>1349.040630575}}
 ```
-
+---
+Current valid arguments: "kilometers", "meters", "miles", "feet"
+```
+client.estimated_diameter("meters")
+```
+Example return:
+```
+{"estimated_diameter_min"=>183.8886720703, "estimated_diameter_max"=>411.1875710413}
+```
+---
+Current valid arguments: "min", "max"
+```
+client.estimated_diameter("meters", "min")
+```
+Example return:
+```
+183.8886720703
+```
 
 #### Miss distance to earth
 
@@ -84,6 +101,15 @@ Example return:
 ```
 {"astronomical"=>"0.1915058335", "lunar"=>"74.4957733154", "kilometers"=>"28648866", "miles"=>"17801580"}
 ```
+---
+Current valid arguments: "astronomical", "lunar", "kilometers", "miles"
+```
+client.miss_distance("miles")
+```
+Example return (converts string to float):
+```
+17801580
+```
 
 
 #### Velocity
@@ -95,6 +121,15 @@ Example return:
 ```
 {"kilometers_per_second"=>"14.488889894", "kilometers_per_hour"=>"52160.0036184644", "miles_per_hour"=>"32410.1978039286"}
 ```
+---
+Current valid arguments: "kilometers_per_second", "kilometers_per_hour", "miles_per_hour"
+```
+client.velocity("miles_per_hour")
+```
+Example return (converts string to float)
+```
+32410.1978039286
+```
 
 
 #### All data on closest object
@@ -103,7 +138,7 @@ Example return:
 client.neo_data
 ```
 
-Example return:
+Example return (all raw data on closest object):
 ```
 {"links"=>{"self"=>"https://api.nasa.gov/neo/rest/v1/neo/3840869?api_key=DEMO_KEY"}, "id"=>"3840869", "neo_reference_id"=>"3840869", "name"=>"(2019 GK4)", "nasa_jpl_url"=>"http://ssd.jpl.nasa.gov/sbdb.cgi?sstr=3840869", "absolute_magnitude_h"=>23.83, "estimated_diameter"=>{"kilometers"=>{"estimated_diameter_min"=>0.0455569852, "estimated_diameter_max"=>0.1018685158}, "meters"=>{"estimated_diameter_min"=>45.5569852336, "estimated_diameter_max"=>101.8685158322}, "miles"=>{"estimated_diameter_min"=>0.0283077895, "estimated_diameter_max"=>0.0632981416}, "feet"=>{"estimated_diameter_min"=>149.4651794337, "estimated_diameter_max"=>334.214301483}}, "is_potentially_hazardous_asteroid"=>false, "close_approach_data"=>[{"close_approach_date"=>"2019-04-10", "epoch_date_close_approach"=>1554879600000, "relative_velocity"=>{"kilometers_per_second"=>"14.9701946153", "kilometers_per_hour"=>"53892.7006150984", "miles_per_hour"=>"33486.828334976"}, "miss_distance"=>{"astronomical"=>"0.089370038", "lunar"=>"34.7649421692", "kilometers"=>"13369567", "miles"=>"8307464"}, "orbiting_body"=>"Earth"}], "is_sentry_object"=>false}
 ```
@@ -120,7 +155,17 @@ Returns (on next API call method):
 ```
 {:error=>["400", "Forbidden"]}
 ```
-If an error is returned the next method request for information will make an API call
+If a status error is returned the next method request for information will make an API call
+
+---
+Example of unrecognised argument on method:
+```
+client.estimated_diameter("wrong measurement unit")
+```
+Returns:
+```
+{:error=>["measurement", "check argument"]}
+```
 
 
 ### Testing

data/lib/nasa-neo/client.rb

@@ -15,18 +15,36 @@ module NasaNeo
         @date = parsed_date
         @full_url = nil
         @result = nil
+        @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
-        call_and_rescue { retrieve_neo["estimated_diameter"] }
+      def estimated_diameter(measurement = nil, min_max = nil)
+        if @estimated_diameter_options.include? measurement
+          if ["min", "max"].include? min_max
+            call_and_rescue { estimated_diameter_data[measurement]["estimated_diameter_#{min_max}"] }
+          else
+            min_max == nil ? call_and_rescue { estimated_diameter_data[measurement] }
+                           : error_feedback(['min_max', 'check arguments'])
+          end
+        else
+          measurement == nil ? call_and_rescue { estimated_diameter_data }
+                             : error_feedback(['measurement', 'check arguments'])
+        end
       end
 
       def hazardous?
         call_and_rescue { retrieve_neo["is_potentially_hazardous_asteroid"]}
       end
 
-      def miss_distance
-        call_and_rescue { retrieve_neo["close_approach_data"][0]["miss_distance"] }
+      def miss_distance(measurement = nil)
+        if @miss_distance_options.include? measurement
+          call_and_rescue { miss_distance_data[measurement].to_f }
+        else
+          measurement == nil ? call_and_rescue { miss_distance_data }
+                             : error_feedback(['measurement', 'check arguments'])
+        end
       end
 
       def neo_name
@@ -37,8 +55,13 @@ module NasaNeo
         call_and_rescue { retrieve_neo }
       end
 
-      def velocity
-        call_and_rescue { retrieve_neo["close_approach_data"][0]["relative_velocity"] }
+      def velocity(measurement = nil)
+        if @velocity_options.include? measurement
+          call_and_rescue { velocity_data[measurement].to_f }
+        else
+          measurement == nil ? call_and_rescue { velocity_data }
+                             : error_feedback(['measurement', 'check arguments'])
+        end
       end
 
       private
@@ -51,7 +74,7 @@ module NasaNeo
         yield if block_given?
         rescue OpenURI::HTTPError => e
           @full_url = nil
-          { 'error': e.io.status }
+          error_feedback(e.io.status)
       end
 
       def get_api_data
@@ -69,6 +92,22 @@ module NasaNeo
         @result["near_earth_objects"]["#{@date}"][0]
       end
 
+      def estimated_diameter_data
+        retrieve_neo["estimated_diameter"]
+      end
+
+      def error_feedback(error_info)
+        { 'error': error_info }
+      end
+
+      def miss_distance_data
+        retrieve_neo["close_approach_data"][0]["miss_distance"]
+      end
+
+      def velocity_data
+        retrieve_neo["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.1.2".freeze
+  VERSION = "1.2.0".freeze
 end

data/nasa-neo.gemspec

@@ -4,7 +4,7 @@ require "nasa-neo/version"
 
 Gem::Specification.new do |s|
   s.name        = 'nasa-neo'
-  s.version     = '1.1.2'
+  s.version     = '1.2.0'
   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. "

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nasa-neo
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 1.2.0
 platform: ruby
 authors:
 - James Sutherland