nasa-neo 1.4.0 → 1.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 678cc5393770218011a9bf255c32dd0f473a369481960690c52b3b0b81caa61a
-  data.tar.gz: 19b6c4c0e4a91c07d928ac150d30b8d51eb9f0785e9fa8d12d9b0af82e7f6d60
+  metadata.gz: e304e3dd4fd53330f9cd70ed863ef483c8b24c26ef8c62dc12241bdca5f890cf
+  data.tar.gz: c486ed0b64381d11a0afbf0cc5f5871e8dc5b01936c34e56451a74f4198a815c
 SHA512:
-  metadata.gz: b115799b57f72e9da828895b45df3f5791e3ea318a0357b32b9e46295d84bfa4ba47d94427309734921282a1687430158b51c8e28ecc362fc5c94a2434474171
-  data.tar.gz: d51e25603e176b084c10165fdc258615fcee0ac8ff9a69e14833a269caaf1597772a7bbf2428bb9ebb6024d4575c8c3a460d43a25765e629d14e29f169e805ec
+  metadata.gz: 2aa715513cd3759af993e14e3cad6574050a07566ef19182e6c269f8aaa21f1c33e770f07e11de037f676f358cf9803f510a1d3bc4d97ed01bc978fb9513dbd4
+  data.tar.gz: 7b3e99bbe0c0f837adc229a762bfff5590f308e6845d91442ae26a7a8d787a936bfe639e2e1ed4043621cb399597d5873a3270003424b90a99f6553a337e6f27

data/CHANGELOG.md

@@ -0,0 +1,14 @@
+# Changelog
+
+## [1.5.0] - 2018-04-14
+
+### Added
+
+- All information about Near Earth Objects can be returned, including all close approach data held on the object (Does require an additional API call within the gem to retrieve the verbose data). Added #neo_data_verbose method to .Client
+- Updated README.md to include suggest environment variable for API key, new usage instructions for above method
+
+## [1.4.0] - 2018-04-14
+
+### Added
+
+- Ability to see how many calls are remaining with your current API key. Added #calls_remaining method to .Client

data/Gemfile.lock

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

data/README.md

@@ -40,6 +40,10 @@ The default setting is DEMO_KEY. This only needs to be set if you want to use yo
 ```
 client.key = "MyKey"
 ```
+or suggest using an environment variable eg.
+```
+client.key = ENV["NASA_API_KEY"]
+```
 
 #### Change the date
 Default setting is the current day, only needs to be set if you want another day. Format: YYYY-MM-DD)
@@ -47,26 +51,20 @@ Default setting is the current day, only needs to be set if you want another day
 client.date = "2019-04-10"
 ```
 
-#### Update
+#### Update API data stored
 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 when methods are executed will be `nil`). Note: The intial set 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 number of API calls remaining using current key
+#### General
+
+##### Find the number of API calls remaining using current key
 ```
 client.calls_remaining
 ```
@@ -76,7 +74,7 @@ Example return:
 ```
 Note: If an API call has not been made yet then an error hash is returned (`{:error=>"make new API call first"}`) as the calls remaining data is returned in the header of the API call. If an API key is changed then again an API call will need to be made first to retrieve this information.
 
-#### Find the total Near Earth Objects recorded for the date
+##### Find the total Near Earth Objects recorded for the date
 
 ```
 client.neo_total
@@ -86,7 +84,17 @@ Example return:
 10
 ```
 
-#### Given name
+##### Select Near Earth Object
+Manually select a Near Earth Object for the date (if not a recognised number all data returned when methods are executed will be `nil`). Note: The initial set default is the first (closest).
+
+Example(selects 2nd closest Near Earth Object):
+```
+client.neo_select(2)
+```
+
+#### Current Selected Near Earth Object
+
+##### Given name
 
 ```
 client.neo_name
@@ -97,7 +105,8 @@ Example return:
 ```
 
 
-#### Potential hazardousness boolean
+##### Potential hazardousness boolean
+Based on potential future Earth impact
 ```
 client.hazardous?
 ```
@@ -106,7 +115,7 @@ Example return:
 false
 ```
 
-#### Estimated diameter
+##### Estimated diameter
 
 ```
 client.estimated_diameter
@@ -134,7 +143,7 @@ Example return:
 183.8886720703
 ```
 
-#### Miss distance to earth
+##### Miss distance to earth
 
 ```
 client.miss_distance
@@ -154,7 +163,7 @@ Example return (converts string to float):
 ```
 
 
-#### Velocity
+##### Velocity
 
 ```
 client.velocity
@@ -174,7 +183,7 @@ Example return (converts string to float)
 ```
 
 
-#### All data on closest object selected
+##### Raw data of Near Earth Object based on date
 
 ```
 client.neo_data
@@ -185,6 +194,15 @@ 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}
 ```
 
+##### All raw data held on selected Near Earth Object
+```
+client.neo_data_verbose
+```
+
+Returns all data held on the Near Earth Object. Includes all data on the dates of closest miss distances to Earth.
+
+Note: This will initially make an addition API call to retrieve this information, but like the first API call will not make additional calls unless the selected Near Earth Object is changed.
+
 ### Exceptions
 
 Exceptions are returned as a hash

data/lib/nasa-neo/client.rb

@@ -12,6 +12,7 @@ module NasaNeo
       VELOCITY_OPTIONS = ["kilometers_per_second", "kilometers_per_hour", "miles_per_hour"]
 
       NEO_NAME_KEYS = ["name"]
+      NEO_ID_KEYS = ["id"]
       HAZARDOUS_KEYS = ["is_potentially_hazardous_asteroid"]
       ESTIMATED_DIAMETER_KEYS = ["estimated_diameter"]
       MISS_DISTANCE_KEYS = ["close_approach_data", 0, "miss_distance"]
@@ -26,7 +27,10 @@ module NasaNeo
         @key = config.api_key
         @date = parsed_date
         @full_url = nil
+        @full_url_neo = nil
+        @neo_id = nil
         @result = nil
+        @result_neo = nil
         @neo_position = 0
       end
 
@@ -61,7 +65,7 @@ module NasaNeo
       end
 
       def neo_data_verbose
-
+        call_and_rescue { retrieve_neo_verbose }
       end
 
       def neo_total
@@ -86,8 +90,8 @@ module NasaNeo
 
       private
 
-      def buffer_url
-        api_data = open(@full_url)
+      def buffer_url(url)
+        api_data = open(url)
         @calls_remaining = api_data.meta['x-ratelimit-remaining'].to_i
         api_data.read
       end
@@ -96,13 +100,14 @@ module NasaNeo
         yield if block_given?
         rescue OpenURI::HTTPError => e
           @full_url = nil
+          @full_url_neo = nil
           error_feedback(e.io.status)
       end
 
       def get_api_data
         @full_url = set_full_url
         @neo_position = 0
-        buffer = JSON.parse(buffer_url)
+        buffer = JSON.parse(buffer_url(@full_url))
         @result = buffer
       end
 
@@ -116,6 +121,16 @@ module NasaNeo
         @result.dig(*root_keys + keys)
       end
 
+      def retrieve_neo_verbose
+        @neo_id = retrieve_neo(NEO_ID_KEYS)
+        if @full_url_neo != set_full_url_neo
+          @full_url_neo = set_full_url_neo
+          @result_neo = JSON.parse(buffer_url(@full_url_neo))
+        else
+          @result_neo
+        end
+      end
+
       def retrieve_specific(options, keys, measurement, min_max = nil)
         if options.include? measurement
           chained_keys = retrieve_neo(keys + ["#{measurement}"])
@@ -142,6 +157,10 @@ module NasaNeo
         "#{@config.host}/feed?start_date=#{@date}&end_date=#{@date}&detailed=false&api_key=#{@key}"
       end
 
+      def set_full_url_neo
+        "#{@config.host}/neo/#{@neo_id}?api_key=#{@key}"
+      end
+
     end
   end
 end

data/lib/nasa-neo/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module NasaNeo
-  VERSION = "1.4.0".freeze
+  VERSION = "1.5.1".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.4.0'
+  s.version     = '1.5.1'
   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 objects on any given day using the NASA NEO API. "
@@ -12,6 +12,7 @@ Gem::Specification.new do |s|
   s.email       = 'jrsutherland78@googlemail.com'
   s.homepage    = 'https://github.com/LondonJim/NASA-NEO-API-Wrapper'
   s.license     = 'MIT'
+  s.metadata    = { "changelog_uri" => "https://github.com/LondonJim/NASA-NEO-API-Wrapper/blob/master/CHANGELOG.md" }
 
   s.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nasa-neo
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.5.1
 platform: ruby
 authors:
 - James Sutherland
@@ -88,6 +88,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -104,7 +105,8 @@ files:
 homepage: https://github.com/LondonJim/NASA-NEO-API-Wrapper
 licenses:
 - MIT
-metadata: {}
+metadata:
+  changelog_uri: https://github.com/LondonJim/NASA-NEO-API-Wrapper/blob/master/CHANGELOG.md
 post_install_message: 
 rdoc_options: []
 require_paths: