nasa-neo 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 05daf1bedded0b0e75c38f2904a5a0e2cf991d1e4dc0f1a0ed0c0da246564508
-  data.tar.gz: d1e4a20ff50b5642cb2bf62e0d0cb6ec2ec3915c84e582763d0378f3affecfd8
+  metadata.gz: 4e8cccaef829829caefbcee2843bb441f08427449c8076fd8afa1cdbce0ab3c0
+  data.tar.gz: 54609efcbeea0aecc441b4296c9407f055c28519aef8694929670a71519b95b5
 SHA512:
-  metadata.gz: 2381142f3cf7f95b81b56d968b4c85d61b3089d33fae7ea2d507beac8ec82d2cfda384c9d4ee4836f5af1c6728c64cf306b508a9227525339eb77c23fefdc7d7
-  data.tar.gz: 2e571042bb5248f03cfcc9fa587e819efa6304666359e23d4595a98497ba095084da700fecf9e6f0d7070f3c69c7991ccf0a1c069ef13599b0036660fa071ed7
+  metadata.gz: 5befcec2be629c56d42b01f51915ca2ff3fcb4c246ccea85cec8f7479413a43c9b89bff52f66bd63652304b82626d1f5d6a0b12e375b48e2a5c2e2c892cfbdbb
+  data.tar.gz: 8205c94b409fda38978412190fc30f0d2a233ecea2a9b72189a8f88c32a7d04433229f1aa4050bd062d99b589539008f0bd0632d3cb23e86e40c2bde48c68751

data/Gemfile.lock

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

data/README.md

@@ -1,6 +1,6 @@
 # NASA Near Earth Object API Wrapper
 
-Gives details on the closest Near Earth Object of the day.
+Gives details on the closest Near Earth Objects of the day. All Near Earth Objects can now be individually selected. Currently the NEO API only holds data from 1900 to 2200, any requests for information outside these years will return nil. Data is also limited to encounters with reasonably low uncertainty.
 
 ## Installation
 
@@ -25,25 +25,58 @@ Or install it yourself as:
 ### Configuration
 A default api key of DEMO_KEY will let you make up to 30 requests per hour (50 per day), if you have your own api key (https://api.nasa.gov/index.html#apply-for-an-api-key) you can set it as detailed under instructions (developer API keys allow up to 1000 requests an hour)
 
-Create client to make requests to the API (using demo api key):
+
+#### Create client
+
+Set the API key (only needs to be done if you want to use your own API key, default setting is DEMO_KEY)
 
 ```
 client = NasaNeo::CloseObj.configure
 ```
 
-Set the API key (only needs to be done is you want to use your own API key, default setting is DEMO_KEY)
+
+#### Set the API key
+
+(only needs to be done if you want to use your own API key, default setting is DEMO_KEY)
 ```
 client.key = "MyKey"
 ```
 
-Change the date (only needs to be done if you want to select another data, default setting is the current day. Format: YYYY-MM-DD)
+#### Change the date
+(only needs to be done if you want to select another date, default setting is the current day. Format: YYYY-MM-DD)
 ```
 client.date = "2019-04-10"
 ```
-Please Note: The first request for information results in an API call, unless the date or API key is changed no more API calls are made as the information of the closet near earth object is stored on the first request.
+
+#### Update
+OPTIONAL: The Near Earth Object data for the date can be called and stored before any methods are run (otherwise the first information request method will make an API call and store the data)
+```
+client.update
+```
+
+#### Select Near Earth Object
+Manually select a Near Earth Object for the date (if not a recognised number all data returned will be `nil`). Note: The default is the first (closest). To find the total number of Near Earth Objects recorded for the date see `Find the total Near Earth Objects recorded for the date` in the next section.
+
+Example(selects 2nd closest Near Earth Object):
+```
+client.neo_select(2)
+```
+
+Please Note: If the date or key is changed the next method requesting information will make an API call. You can use `update` (as above) to store the data in anticipation of running the methods beforehand if needed but is not necessary. Only one API call is made unless there are changes to the date, API key or `update` is run again.
+
 
 ### Retrieving Information
 
+#### Find the total Near Earth Objects recorded for the date
+
+```
+client.neo_total
+```
+Example return:
+```
+10
+```
+
 #### Given name
 
 ```
@@ -132,7 +165,7 @@ Example return (converts string to float)
 ```
 
 
-#### All data on closest object
+#### All data on closest object selected
 
 ```
 client.neo_data
@@ -166,6 +199,16 @@ Returns:
 ```
 {:error=>["measurement", "check argument"]}
 ```
+---
+Example of return if information no present, eg. if selected number of Near Earth Object is not present:
+```
+client.neo_select(99)
+client.neo_name
+```
+Returns:
+```
+nil
+```
 
 
 ### Testing

data/lib/nasa-neo/client.rb

@@ -15,6 +15,7 @@ module NasaNeo
         @date = parsed_date
         @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"]
@@ -35,7 +36,7 @@ module NasaNeo
       end
 
       def hazardous?
-        call_and_rescue { retrieve_neo["is_potentially_hazardous_asteroid"]}
+        call_and_rescue { hazardous_data }
       end
 
       def miss_distance(measurement = nil)
@@ -48,13 +49,26 @@ module NasaNeo
       end
 
       def neo_name
-        call_and_rescue { retrieve_neo["name"] }
+        call_and_rescue { neo_name_data }
       end
 
       def neo_data
         call_and_rescue { retrieve_neo }
       end
 
+      def neo_total
+        call_and_rescue { get_api_data } if @full_url != set_full_url
+        @result["element_count"]
+      end
+
+      def update
+        call_and_rescue { get_api_data }
+      end
+
+      def neo_select(n)
+        @neo_position = n - 1
+      end
+
       def velocity(measurement = nil)
         if @velocity_options.include? measurement
           call_and_rescue { velocity_data[measurement].to_f }
@@ -89,23 +103,36 @@ module NasaNeo
 
       def retrieve_neo
         get_api_data if @full_url != set_full_url
-        @result["near_earth_objects"]["#{@date}"][0]
+        @result.dig("near_earth_objects", "#{@date}", @neo_position)
       end
 
       def estimated_diameter_data
-        retrieve_neo["estimated_diameter"]
+        data = retrieve_neo
+        data == nil ? nil : data["estimated_diameter"]
       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
-        retrieve_neo["close_approach_data"][0]["miss_distance"]
+        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
-        retrieve_neo["close_approach_data"][0]["relative_velocity"]
+        data = retrieve_neo
+        data == nil ? nil : data["close_approach_data"][0]["relative_velocity"]
       end
 
       def set_full_url

data/lib/nasa-neo/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module NasaNeo
-  VERSION = "1.2.0".freeze
+  VERSION = "1.3.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.2.0'
+  s.version     = '1.3.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. "
@@ -20,8 +20,8 @@ Gem::Specification.new do |s|
   s.bindir        = 'bin'
   s.require_paths = ['lib']
 
-  s.add_development_dependency 'bundler', '~> 2.0.1'
+  s.add_development_dependency 'bundler', '~> 2.0', '>= 2.0.1'
   s.add_development_dependency 'rake', '~> 10.0'
   s.add_development_dependency 'rspec', '~> 3.8'
-  s.add_development_dependency 'webmock', '~> 3.5.1'
+  s.add_development_dependency 'webmock', '~> 3.5', '>= 3.5.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nasa-neo
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - James Sutherland
@@ -15,6 +15,9 @@ dependencies:
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2.0.1
   type: :development
@@ -22,6 +25,9 @@ dependencies:
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2.0.1
 - !ruby/object:Gem::Dependency
@@ -57,6 +63,9 @@ dependencies:
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.5.1
   type: :development
@@ -64,6 +73,9 @@ dependencies:
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.5.1
 description: 'Retrieve information about the closest near earth object on any given
@@ -108,7 +120,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubyforge_project: 
+rubygems_version: 2.7.9
 signing_key: 
 specification_version: 4
 summary: This gem provides a simple wrapper for https://api.nasa.gov/api.html#NeoWS