nasa-neo 1.3.4 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ac1e95485923a3403314caa9d76cb01d6b506bba0dc8045d76b3f5a83f5b4521
-  data.tar.gz: d46607f0ad5c3bb899c96da769f2c8d783eb85fdc6b698869883efe1282894b2
+  metadata.gz: 678cc5393770218011a9bf255c32dd0f473a369481960690c52b3b0b81caa61a
+  data.tar.gz: 19b6c4c0e4a91c07d928ac150d30b8d51eb9f0785e9fa8d12d9b0af82e7f6d60
 SHA512:
-  metadata.gz: fb1665071802ffbe98469541eec30ac541451eeceaf38173d0258ae0d2640e6140f0730c0112d5f7f28e52042936a02118766cc65f26fb8de9c310e91e407fd0
-  data.tar.gz: 30b42a91a56a46f6ded84f8a520137af4148dbbfcfe3774ab792756d30c9ad7c0c40428701300a1a2a7eb4e483ba932bf198f847a9d57d3e683886f979cb6c89
+  metadata.gz: b115799b57f72e9da828895b45df3f5791e3ea318a0357b32b9e46295d84bfa4ba47d94427309734921282a1687430158b51c8e28ecc362fc5c94a2434474171
+  data.tar.gz: d51e25603e176b084c10165fdc258615fcee0ac8ff9a69e14833a269caaf1597772a7bbf2428bb9ebb6024d4575c8c3a460d43a25765e629d14e29f169e805ec

data/Gemfile.lock

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

data/README.md

@@ -36,14 +36,13 @@ client = NasaNeo::CloseObj.configure
 
 
 #### Set the API key
-
-(only needs to be done if you want to use your own API key, default setting is DEMO_KEY)
+The default setting is DEMO_KEY. This only needs to be set if you want to use your own API key.
 ```
 client.key = "MyKey"
 ```
 
 #### 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)
+Default setting is the current day, only needs to be set if you want another day. Format: YYYY-MM-DD)
 ```
 client.date = "2019-04-10"
 ```
@@ -55,7 +54,7 @@ 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.
+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):
 ```
@@ -67,6 +66,16 @@ Please Note: If the date or key is changed the next method requesting informatio
 
 ### Retrieving Information
 
+#### Find the number of API calls remaining using current key
+```
+client.calls_remaining
+```
+Example return:
+```
+29
+```
+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
 
 ```
@@ -92,7 +101,7 @@ Example return:
 ```
 client.hazardous?
 ```
-Example return (hopefully):
+Example return:
 ```
 false
 ```
@@ -210,7 +219,7 @@ 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):
+Example of return if any information not present (would return nil for any of the methods attempting to retrieve information). It would most likely mean that it's outside the year range.
 ```
 client.date = "2400-01-01"
 client.miss_distance("miles")
@@ -219,6 +228,15 @@ Returns:
 ```
 nil
 ```
+---
+Example of return if method requesting the number of API calls left using the current key is made before any API calls are made.
+```
+client.calls_remaining
+```
+Returns:
+```
+{:error>=>"make new API call first"}
+```
 
 
 ### Testing

data/lib/nasa-neo/client.rb

@@ -17,10 +17,12 @@ module NasaNeo
       MISS_DISTANCE_KEYS = ["close_approach_data", 0, "miss_distance"]
       VELOCITY_KEYS = ["close_approach_data", 0, "relative_velocity"]
 
-      attr_accessor :date, :key
+      attr_accessor :date
+      attr_reader :key
 
       def initialize(config)
         @config = config
+        @calls_remaining = nil
         @key = config.api_key
         @date = parsed_date
         @full_url = nil
@@ -28,6 +30,16 @@ module NasaNeo
         @neo_position = 0
       end
 
+      def key=(value)
+        @calls_remaining = nil
+        @key = value
+      end
+
+      def calls_remaining
+        @calls_remaining == nil ? error_feedback("make new API call first")
+                                : @calls_remaining
+      end
+
       def estimated_diameter(measurement = nil, min_max = nil)
         retrieve_specific(ESTIMATED_DIAMETER_OPTIONS, ESTIMATED_DIAMETER_KEYS, measurement, min_max)
       end
@@ -48,6 +60,10 @@ module NasaNeo
         call_and_rescue { retrieve_neo }
       end
 
+      def neo_data_verbose
+
+      end
+
       def neo_total
         if @full_url != set_full_url
           call_and_rescue { get_api_data["element_count"]}
@@ -71,7 +87,9 @@ module NasaNeo
       private
 
       def buffer_url
-        open(@full_url).read
+        api_data = open(@full_url)
+        @calls_remaining = api_data.meta['x-ratelimit-remaining'].to_i
+        api_data.read
       end
 
       def call_and_rescue
@@ -121,7 +139,7 @@ module NasaNeo
       end
 
       def set_full_url
-        "#{@config.host}?start_date=#{@date}&end_date=#{@date}&detailed=false&api_key=#{@key}"
+        "#{@config.host}/feed?start_date=#{@date}&end_date=#{@date}&detailed=false&api_key=#{@key}"
       end
 
     end

data/lib/nasa-neo/configuration.rb

@@ -3,7 +3,7 @@
 module NasaNeo
   module CloseObj
     class Configuration
-      DEFAULT_HOST = 'https://api.nasa.gov/neo/rest/v1/feed'.freeze
+      DEFAULT_HOST = 'https://api.nasa.gov/neo/rest/v1'.freeze
       DEFAULT_API_KEY = 'DEMO_KEY'.freeze
 
       attr_accessor :api_key, :host

data/lib/nasa-neo/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module NasaNeo
-  VERSION = "1.3.4".freeze
+  VERSION = "1.4.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.3.4'
+  s.version     = '1.4.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 objects 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.3.4
+  version: 1.4.0
 platform: ruby
 authors:
 - James Sutherland