nasa-neo 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 599d7a51ce2552ed535efddbd37471ef9c8c8e35289def3bdfa7808044e728d6
+  data.tar.gz: 60f31be728aef30756e88df8f1b2cf34ce6550368a0fb9e806b525642da64a1e
+SHA512:
+  metadata.gz: 255b7d3a020408ecbcb3d78fb77783b54b59a645617f692a3883ad908cd6f620448d77d5fc71c122d0c264e690d680c31b801b2814a1035712f9d2f72a8457c2
+  data.tar.gz: da9e5e20d38f08d54362d437a1862376842abd413d25b214f00635b155cea223712489b51bb5681eb0fdc4830e4c66f18dfefdc23cccfcf53416eebc73fde584

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.1
+before_install: gem install bundler -v 1.17.2

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in neo.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,47 @@
+PATH
+  remote: .
+  specs:
+    nasa-neo (1.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.6.0)
+      public_suffix (>= 2.0.2, < 4.0)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.3)
+    hashdiff (0.3.8)
+    public_suffix (3.0.3)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    safe_yaml (1.0.5)
+    webmock (3.5.1)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0.1)
+  nasa-neo!
+  rake (~> 10.0)
+  rspec (~> 3.8)
+  webmock (~> 3.5.1)
+
+BUNDLED WITH
+   2.0.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 James Sutherland
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,100 @@
+# Nasa Near Earth Object API Wrapper
+
+Gives details on the closest Near Earth Object of the day.
+
+## Installation
+
+Uses `Ruby 2.6.1`
+
+`bundle`
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'nasa-neo'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install neo
+
+## Instructions
+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):
+
+```
+client = NasaNeo::CloseObj.configure
+```
+
+Set the API key (default is DEMO_KEY)
+```
+client.key = "MyKey"
+```
+
+Change the date (default 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
+
+Retrieve the name:
+
+```
+client.neo_name
+
+eg. "(2004 VB)"
+```
+
+
+Retrieve the 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}}
+```
+
+
+Retrieve the miss distance to earth:
+
+```
+client.miss_distance
+
+eg. {"astronomical"=>"0.1915058335", "lunar"=>"74.4957733154", "kilometers"=>"28648866", "miles"=>"17801580"}
+```
+
+
+Retrieve the velocity:
+
+```
+client.velocity
+
+eg. {"kilometers_per_second"=>"14.488889894", "kilometers_per_hour"=>"52160.0036184644", "miles_per_hour"=>"32410.1978039286"}
+```
+
+##### Exceptions
+
+Exceptions are returned as a hash (example of wrong date):
+```
+client.date = "123"
+```
+returns:
+```
+{:error=>["400", ""]}
+```
+If an error is returned the next method request for information will make an API call
+
+
+## Testing
+
+Uses `RSpec 3.8`
+
+Run tests:
+`bundle exec rspec`

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "nasa-neo"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/nasa-neo.rb

@@ -0,0 +1 @@
+Dir["#{File.dirname(__FILE__)}/**/*.rb"].each { |f| require(f) }

data/lib/nasa-neo/base.rb

@@ -0,0 +1,14 @@
+require_relative 'configuration'
+require_relative 'client'
+
+module NasaNeo
+  module CloseObj
+    def self.client
+      @client
+    end
+
+    def self.configure
+      @client = Client.new(Configuration.new)
+    end
+  end
+end

data/lib/nasa-neo/client.rb

@@ -0,0 +1,68 @@
+require 'open-uri'
+require 'json'
+
+module NasaNeo
+  module CloseObj
+    class Client
+
+      attr_accessor :date, :key
+
+      def initialize(config)
+        @config = config
+        @key = config.api_key
+        @date = parsed_date
+        @full_url = nil
+        @result = nil
+      end
+
+      def estimated_diameter
+        call_and_rescue { retrieve_neo["estimated_diameter"] }
+      end
+
+      def miss_distance
+        call_and_rescue { retrieve_neo["close_approach_data"][0]["miss_distance"] }
+      end
+
+      def neo_name
+        call_and_rescue { retrieve_neo["name"] }
+      end
+
+      def velocity
+        call_and_rescue { retrieve_neo["close_approach_data"][0]["relative_velocity"] }
+      end
+
+      private
+
+      def buffer_url
+        open(@full_url).read
+      end
+
+      def call_and_rescue
+        yield if block_given?
+        rescue OpenURI::HTTPError => e
+          @full_url = nil
+          { 'error': e.io.status }
+      end
+
+      def get_api_data
+        @full_url = set_full_url
+        buffer = JSON.parse(buffer_url)
+        @result = buffer
+      end
+
+      def parsed_date
+        Time.now.strftime("%Y-%m-%d")
+      end
+
+      def retrieve_neo
+        get_api_data if @full_url != set_full_url
+        @result["near_earth_objects"]["#{@date}"][0]
+      end
+
+      def set_full_url
+        "#{@config.host}?start_date=#{@date}&end_date=#{@date}&detailed=false&api_key=#{@key}"
+      end
+
+    end
+  end
+end

data/lib/nasa-neo/configuration.rb

@@ -0,0 +1,16 @@
+module NasaNeo
+  module CloseObj
+    class Configuration
+      DEFAULT_HOST = 'https://api.nasa.gov/neo/rest/v1/feed'
+      DEFAULT_API_KEY = 'DEMO_KEY'
+
+      attr_accessor :api_key, :host
+
+      def initialize
+        self.api_key = DEFAULT_API_KEY
+        self.host = DEFAULT_HOST
+      end
+
+    end
+  end
+end

data/lib/nasa-neo/version.rb

@@ -0,0 +1,3 @@
+module NasaNeo
+  VERSION = "1.0.1"
+end

data/nasa-neo.gemspec

@@ -0,0 +1,27 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "nasa-neo/version"
+
+Gem::Specification.new do |s|
+  s.name        = 'nasa-neo'
+  s.version     = '1.0.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 object using the NASA NEO API. "
+  s.authors     = ["James Sutherland"]
+  s.email       = 'jrsutherland78@googlemail.com'
+  s.homepage    = 'https://github.com/LondonJim/NASA-NEO-API-Wrapper'
+  s.license     = 'MIT'
+
+  s.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+
+  s.bindir        = 'bin'
+  s.require_paths = ['lib']
+
+  s.add_development_dependency 'bundler', '~> 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'
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: nasa-neo
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- James Sutherland
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-04-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.5.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.5.1
+description: 'Retrieve information about the closest near earth object using the NASA
+  NEO API. '
+email: jrsutherland78@googlemail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/nasa-neo.rb
+- lib/nasa-neo/base.rb
+- lib/nasa-neo/client.rb
+- lib/nasa-neo/configuration.rb
+- lib/nasa-neo/version.rb
+- nasa-neo.gemspec
+homepage: https://github.com/LondonJim/NASA-NEO-API-Wrapper
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: This gem provides a simple wrapper for https://api.nasa.gov/api.html#NeoWS
+  API
+test_files: []