WSWSANE 1.0.0 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b21144c7ceadf658158ef04b1b438752d960dcea9b2bb3799e49bbac7c813882
-  data.tar.gz: a4aa032dabb191b691a0c5ddeaf5a1369b5143604249640568d8921098c11ffd
+  metadata.gz: 3e41f95af1f8f11132db6989cc9198477a11f37c96a02cd78f60e6c54c730416
+  data.tar.gz: abf7f5b17cb4889e3516d2c5334e2097c5d76a60abcc61c715bdef40ebcfc68e
 SHA512:
-  metadata.gz: 4a816efb694ca9c124949ad7f77df89a1672b775acd356bfdcbbd6720c5214ce4efea2f5635b681ac3656fd1910579640ae0469c4f97757b1bba5cf9385199ae
-  data.tar.gz: 83ae4b1b1c3d4cbc63d3849519cc9b8d95f254ae3bf2feb79fcd4d31091f58a60bf7949353cb303af5d7325c490acb98d127e33c8b3abec08b0cb51188a3d503
+  metadata.gz: 9141788b9e0cc3da0ba0badaf7902c73f7dcacb1e3e9f5ed75c639ea18c3fbd736b35a2c7c292bc62328013782f537bff1cb28f1e08b27a601913a3fbba1476c
+  data.tar.gz: e4af29d57ea2a0e3b9364d0f5096db571137f62735f5070fede748e5b678d17ba289726368deff0a186b0b54197f57fb77ca903454c7e756d0bf466d58ab3201

data/lib/WSWSANE.rb

@@ -1,5 +1,7 @@
 require 'net/http'
 require 'json'
+##
+# This class is a static class from which all functions are called
 class WSWSANE
   @@reference={:cis=>[
                    ["The Malevolence", 4845],
@@ -62,10 +64,58 @@ class WSWSANE
                    ["A-wing Starfighter", 9.6]
                  ]
 }
+  ##
+  # Returns the NASA NEO API response for the current day (as given by Time.now), but each object has an additional field for the closest sized ship.
+  # @param apikey [String] The Api Key given to you by api.nasa.gov.
+  # @param factions [Array] An optional array of "factions" that will be used to compare objects. By default, this will compare all NEOs with all ships.
+  # @return [Hash] 
+  #
+  # Example Usage:
+  #
+  # If you wanted to compare all objects that have their closest approach to earth today to ships from the original trilogy, you could use:
+  #   WSWSANE.getToday(apikey,["rebel_alliance","empire"])
+  #
+  # The return value is very similar to the data provided by the NASA API (it is also a JSON object).
+  #
+  # To get a list of all the comparisons, you could do:
+  #   WSWSANE.getToday(apikey)["near_earth_objects"].each do |date,objects|
+  #     objects.each do |neo|
+  #       puts neo["star_wars_ship"]
+  #     end
+  #   end
+  #
+  # If no suitable comparison for an object can be found, then the classified ship will be "None".
+  #
+  # If the api key is incorrect, or the api request otherwise fails, then an error will be raised.
   def self.getToday(apikey,factions=["cis","republic","empire","rebel_alliance","first_order","resistance"])
     date=Time.new.strftime("%Y-%m-%d")
     return self.get(apikey,date,date,factions)
   end
+  ##
+  # Returns the NASA NEO API response for the range of dates provided, but each object has an additional field for the closest sized ship.
+  # @param apikey [String] The Api Key given to you by api.nasa.gov
+  # @param startDate [String] The start date in the form "YYYY-MM-DD"
+  # @param endDate [String] The end date in the form "YYYY-MM-DD"
+  # The date parameters are inclusive, and together determine the range of days for closest approach of the NEOs that the api returns.
+  # @param factions [Array] An optional array of "factions" that will be used to compare objects. By default, this will compare all NEOs with all ships.
+  # 
+  # Example Usage:
+  #
+  # If you wanted to compare all objects that have their closest approach to earth in the first week of 2020 to ships from the prequel trilogy, you could use:
+  #   WSWSANE.get(apikey,"2020-01-01","2020-01-07",["cis","republic"])
+  #
+  # The return value is very similar to the data provided by the NASA API (it is also a JSON object).
+  #
+  # To get a list of all the comparisons, you could do:
+  #   WSWSANE.get(apikey,"2020-01-01","2020-01-07")["near_earth_objects"].each do |date,objects|
+  #     objects.each do |neo|
+  #       puts neo["star_wars_ship"]
+  #     end
+  #   end
+  #
+  # If no suitable comparison for an object can be found, then the classified ship will be "None".
+  #
+  # If the api key is incorrect, or the api request otherwise fails, then an error will be raised.
   def self.get(apikey,startDate,endDate,factions=["cis","republic","empire","rebel_alliance","first_order","resistance"])
     uri=URI("https://api.nasa.gov/neo/rest/v1/feed")
     params={:start_date=>startDate,
@@ -86,6 +136,18 @@ class WSWSANE
       raise response.body
     end
   end
+  ##
+  # Classifies an object based on the range of sizes it could be.
+  # @param minSize [Integer] The minimum size of the object in meters
+  # @param maxSize [Integer] The maximum size of the object in meters
+  # @param factions [Array] An optional array of "factions" that will be used to compare objects. By default, this will compare all NEOs with all ships.
+  #
+  # Example Usage:
+  #
+  # If you wanted to compare an object between 5 and 10 meters big to ships from the sequel trilogy, you could use:
+  #   WSWSANE.classify(5,10,["first_order","resistance"])
+  #
+  # If no suitable comparison for an object can be found, then the classified ship will be "None".
   def self.classify(minSize,maxSize,factions=["cis","republic","empire","rebel_alliance","first_order","resistance"])
     factions.map!(&:downcase)
     possibleShips=[]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: WSWSANE
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.3
 platform: ruby
 authors:
 - Marcy Brook
@@ -10,20 +10,22 @@ bindir: bin
 cert_chain: []
 date: 2020-05-04 00:00:00.000000000 Z
 dependencies: []
-description: A simple tool that uses the NASA NEOWS API to find nearby space objects
-  and determine which Star Wars ship they are most likely to be.
+description: What Star Wars Ships are Near Earth? This simple tool uses the NASA NEOWS
+  API to find nearby space objects and determine which Star Wars ship they are most
+  likely to be.
 email: 
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - lib/WSWSANE.rb
-homepage: 
+homepage: https://rubygems.org/gems/WSWSANE
 licenses:
 - Unlicense
 metadata: {}
 post_install_message: 
-rdoc_options: []
+rdoc_options:
+- yard
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement