nasa-neo 1.0.3 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fa586fc1ff0f8f45e890578299e9e33ec94d686cd5dcd12c1f5f1bc05403d721
-  data.tar.gz: b73a1db7e23658cdc16fe75116572127cf6255e034df99cb0c2afc1a34e43fa8
+  metadata.gz: 1b00b7d123383775849d5299daaa45135b5bc4d10549395d766571084f1ee4fd
+  data.tar.gz: 3884a5fc6becc14b07b4ef1236db36f46f6233e3fca8c44ad328198fc6bf71f5
 SHA512:
-  metadata.gz: 0bff05d6559b1900a417c69a77e278c15730e3ff4bd9976cadb2c3e6fe1e866d2451a580a5497388e3cc5f3ddb973ab584c304be6fc0f4b83d845fea0b475f95
-  data.tar.gz: 836aa5a4423b640facaad31564a35e16dd790dbbdbfad88230ba13b0f5ec42f19a63ddcc929c1b362b1b602ab42288805dd611c152576384dc03acad9c556736
+  metadata.gz: 07d8facfdd037b5db0946e12f24963b864dbc2b133543311785beed414558ae133f2805cf1404042acfded74740c4d6db3f2703c81ceea85c9253389d2c0dc39
+  data.tar.gz: 1592efceec7dab63da270ae678e601ff911fc6afada30b87e613753d3ee660fc29d4c14eacea51fbb295c3b5a09650dcfe12b4ec3ed0fac18e7c728bba6d720d

data/Gemfile.lock

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

data/README.md

@@ -4,7 +4,7 @@ Gives details on the closest Near Earth Object of the day.
 
 ## Installation
 
-Uses `Ruby 2.6.1`
+Written using `Ruby 2.6.1`
 
 Add this line to your application's Gemfile:
 
@@ -20,7 +20,9 @@ Or install it yourself as:
 
     $ gem install nasa-neo
 
-## Instructions
+## Usage
+
+### 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):
@@ -29,68 +31,97 @@ Create client to make requests to the API (using demo api key):
 client = NasaNeo::CloseObj.configure
 ```
 
-Set the API key (default is DEMO_KEY)
+Set the API key (only needs to be done is you want to use your own API key, default setting is DEMO_KEY)
 ```
 client.key = "MyKey"
 ```
 
-Change the date (default is the current day)
+Change the date (only needs to be done if you want to select another data, default setting is the current day)
 ```
 client.date = "2019-04-10"
 ```
 Please Note: The first request for information results in an API call, unless the date is changed no more API calls are made as the information of the closet near earth object is stored on the first request.
 
-##### Retrieving Information
+### Retrieving Information
 
-Retrieve the name:
+##### Given name
 
 ```
 client.neo_name
-
-eg. "(2004 VB)"
 ```
+Returns:
+```
+"(2004 VB)"
+```
+
 
+##### Potential hazardousness boolean
+```
+client.hazardous?
+```
+Returns (hopefully):
+```
+false
+```
 
-Retrieve the estimated diameter:
+##### Estimated diameter
 
 ```
 client.estimated_diameter
-
-eg. {"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}}
+```
+Returns:
+```
+{"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}}
 ```
 
 
-Retrieve the miss distance to earth:
+##### Miss distance to earth
 
 ```
 client.miss_distance
-
-eg. {"astronomical"=>"0.1915058335", "lunar"=>"74.4957733154", "kilometers"=>"28648866", "miles"=>"17801580"}
+```
+Returns:
+```
+{"astronomical"=>"0.1915058335", "lunar"=>"74.4957733154", "kilometers"=>"28648866", "miles"=>"17801580"}
 ```
 
 
-Retrieve the velocity:
+##### Velocity
 
 ```
 client.velocity
+```
+Returns:
+```
+{"kilometers_per_second"=>"14.488889894", "kilometers_per_hour"=>"52160.0036184644", "miles_per_hour"=>"32410.1978039286"}
+```
 
-eg. {"kilometers_per_second"=>"14.488889894", "kilometers_per_hour"=>"52160.0036184644", "miles_per_hour"=>"32410.1978039286"}
+
+##### All data on closest object
+
+```
+client.neo_data
+```
+
+Returns:
+```
+{"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}
 ```
 
-##### Exceptions
+### Exceptions
 
 Exceptions are returned as a hash (example of wrong date):
 ```
 client.date = "123"
 ```
-returns:
+Returns:
 ```
 {:error=>["400", ""]}
 ```
 If an error is returned the next method request for information will make an API call
 
 
-## Testing
+### Testing
 
 Uses `RSpec 3.8`
 

data/lib/nasa-neo/base.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'configuration'
 require_relative 'client'
 

data/lib/nasa-neo/client.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'open-uri'
 require 'json'
 
@@ -19,6 +21,10 @@ module NasaNeo
         call_and_rescue { retrieve_neo["estimated_diameter"] }
       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"] }
       end
@@ -27,6 +33,10 @@ module NasaNeo
         call_and_rescue { retrieve_neo["name"] }
       end
 
+      def neo_data
+        call_and_rescue { retrieve_neo }
+      end
+
       def velocity
         call_and_rescue { retrieve_neo["close_approach_data"][0]["relative_velocity"] }
       end

data/lib/nasa-neo/configuration.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 module NasaNeo
   module CloseObj
     class Configuration
-      DEFAULT_HOST = 'https://api.nasa.gov/neo/rest/v1/feed'
-      DEFAULT_API_KEY = 'DEMO_KEY'
+      DEFAULT_HOST = 'https://api.nasa.gov/neo/rest/v1/feed'.freeze
+      DEFAULT_API_KEY = 'DEMO_KEY'.freeze
 
       attr_accessor :api_key, :host
 

data/lib/nasa-neo/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module NasaNeo
-  VERSION = "1.0.3"
+  VERSION = "1.1.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.0.3'
+  s.version     = '1.1.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.0.3
+  version: 1.1.0
 platform: ruby
 authors:
 - James Sutherland