cli-nasa 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 00751d5f51980cb51ad284eb45bcae2dfe87fbc52e5100bc9f50a091dfbadc2b
+  data.tar.gz: a2f96a5cae15b8d47bf88f4a77a9b2bb577e8f27990921fbf964f493ac4a6291
+SHA512:
+  metadata.gz: b09f2b35b84461c6005cf3b1a7ce81232d06784f46e27642f3dc92c55ac88d84dad6c4c26e6802af0b70b2e124041f2b03d1fd851739a9c306208eb2eb28c9de
+  data.tar.gz: 34abc94880c2622b4d3fad6992367f266d7e3482d22377b13b0f2ce160e321f1af93f8844d14ce03af8d9485c0e18908e918826fcdaf1bf814c2734b2f0ab4f9

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,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.1
+before_install: gem install bundler -v 2.1.4

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"
+gem "httparty"
+gem "json"

data/Gemfile.lock

@@ -0,0 +1,38 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.4.4)
+    httparty (0.18.1)
+      mime-types (~> 3.0)
+      multi_xml (>= 0.5.2)
+    json (2.3.1)
+    mime-types (3.3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2020.0512)
+    multi_xml (0.6.0)
+    rake (12.3.3)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  httparty
+  json
+  rake (~> 12.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 TODO: Write your name
+
+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,56 @@
+# CLI-NASA
+
+Welcome to the cli-nasa gem! This program is designed to allow individuals to
+search through the NASA Image and Video Library to quickly find content displayed
+by title and link URL. Users have the option to do a keyword search that returns
+a wide variety of results, or a media-specific search for only audio, image, or
+video files.
+
+Once a user has selected a search and entered terms, they will have the ability
+to view all related pieces of content as well as content-specific keywords &
+descriptions.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'cli-nasa'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install cli-nasa
+
+## Usage
+
+Once the file is running, follow the provided prompts and list of commands
+to access content and its associated data from the library. The main menu
+provides the option to search by keyword for all types of media, or to search
+for image, audio, or video content specifically.
+
+Once a search has been made, users can interact with the title, description,
+associated keyword, and a link to the content displayed on NASA.gov.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/cli-nasa. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/cli-nasa/blob/master/CODE_OF_CONDUCT.md).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Cli::Nasa project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/cli-nasa/blob/master/CODE_OF_CONDUCT.md).

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/run_me

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+require "rubygems"
+require "bundler/setup"
+require_relative "../config/environment.rb"
+Cli.run
+
+
+require "irb"
+IRB.start(__FILE__)
+return

data/cli-nasa.gemspec

@@ -0,0 +1,28 @@
+require_relative 'lib/services/version.rb'
+
+Gem::Specification.new do |spec|
+  spec.name          = "cli-nasa"
+  spec.version       = Nasa::VERSION
+  spec.authors       = ["Ray Ockenfels"]
+  spec.email         = ["ockenfelsr@gmail.com"]
+
+  spec.summary       = %q{A simple CLI for NASA's Image and Video Library}
+  spec.description   = %q{CLI interface for accessing multimedia metadata from
+                        the NASA Image and Video Library. Can run broad keyword
+                        searches as well as image, audio, and video specific
+                        searches. Displays a link to a piece of content as
+                        well as the title, keywords, and description.}
+  spec.homepage      = "https://rubygems.org/gems/cli-nasa"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "bin"
+  spec.require_paths = ["lib"]
+end

data/config/environment.rb

@@ -0,0 +1,5 @@
+require_relative "../lib/models/content.rb"
+require_relative "../lib/services/cli_nasa_api.rb"
+require_relative "../lib/services/cli.rb"
+require 'httparty'
+require 'json'

data/lib/models/content.rb

@@ -0,0 +1,28 @@
+class Content
+  attr_reader :title, :description, :keywords, :link
+
+  @@all = []
+
+#
+  def initialize(title, description, keywords, link="Link not provided")
+    @title = title
+    @description = description
+    @keywords = keywords
+    @link = link
+
+    #adds instance of Content to @@all
+    @@all << self
+  end
+
+  def self.clear_search
+    @@all.clear
+  end
+
+  def self.all
+    @@all
+  end
+
+  def self.add_content(title, description, keywords, link)
+    Content.new(title, description, keywords, link)
+  end
+end

data/lib/services/cli.rb

@@ -0,0 +1,202 @@
+class Cli
+  attr_accessor :content
+
+
+  # Method called at startup that brings up main menu
+  def self.run
+    self.main_menu
+  end
+
+  # Brings up .greeting, begins the search process, and then displays the provided results
+  def self.main_menu
+    self.greeting
+    results = self.search_menu_command()
+    self.display_content(results)
+  end
+
+  # Welcomes users and provides the list of available commands
+  def self.greeting
+    puts "\n\nWelcome to the NASA-CLI, here are your available commands: "
+    puts ">> s - a keyword search of the Nasa Image and Video Library"
+    puts ">> i - a search of the library focused for only images"
+    puts ">> a - a search of the library focused for only audio clips"
+    puts ">> v - a search of the library focused for only videos"
+    puts ">> exit - exit NASA-CLI\n"
+  end
+
+  # Prompts the user for input
+  def self.get_input
+    puts "\n\nPlease make a selection.\n\n"
+    input = gets.chomp!
+    input
+  end
+
+  # Runs the specific search requested by the user and returns results as
+  # an array of Content objects, asks the user to submit a valid command,
+  # or exits the program
+  def self.search_menu_command
+      command = self.get_input()
+
+      case command
+      when "s"
+        self.keyword_search()
+        Content.all
+      when "i"
+        self.image_search()
+        Content.all
+      when "a"
+        self.audio_search()
+        Content.all
+      when "v"
+        self.video_search()
+        Content.all
+      when "exit"
+        puts "\n\nThank you, please come again!"
+        exit
+      else
+        puts "\n\nCommand not recognized, please try again."
+        self.main_menu
+      end
+  end
+
+  # Gets search terms and creates Content objects based on the provided results
+  def self.keyword_search
+    Content.all.clear
+    puts "\n\nPlease enter your search terms.\n\n"
+    terms = gets.chomp!
+    terms = terms.split(" ").join("%20")
+
+    search_results = CliNasaAPI.basic_search(terms)
+    search_results = search_results["collection"]["items"]
+
+    search_results.each do |result|
+      attributes = result["data"][0]
+      links = result["links"][0] if result["links"] != nil
+
+      title = attributes["title"]
+      description = attributes["description"]
+      keywords = attributes["keywords"]
+      link = links["href"] if links != nil
+
+      Content.add_content(title, description, keywords, link)
+    end
+  end
+
+  # Gets search terms and creates Content objects based on the provided results
+  def self.image_search
+    Content.all.clear
+    puts "\n\nPlease enter your image search terms.\n\n"
+    terms = gets.chomp!
+    terms = terms.split(" ").join("%20")
+
+    search_results = CliNasaAPI.media_search("image", terms)
+    search_results = search_results["collection"]["items"]
+
+    search_results.each do |result|
+      attributes = result["data"][0]
+      links = result["links"][0]
+
+      title = attributes["title"]
+      description = attributes["description"]
+      keywords = attributes["keywords"]
+      link = links["href"]
+
+      Content.add_content(title, description, keywords, link)
+    end
+  end
+
+  # Gets search terms and creates Content objects based on the provided results
+  def self.audio_search
+    Content.all.clear
+    puts "\n\nPlease enter your audio search terms.\n\n"
+    terms = gets.chomp!
+    terms = terms.split(" ").join("%20")
+
+    search_results = CliNasaAPI.media_search("audio", terms)
+    search_results = search_results["collection"]["items"]
+
+    search_results.each do |result|
+      attributes = result["data"][0]
+      links = result["links"][0] if result["links"] != nil
+
+      title = attributes["title"]
+      description = attributes["description"]
+      keywords = attributes["keywords"]
+      link = links["href"] if links != nil
+
+      Content.add_content(title, description, keywords, link)
+    end
+  end
+
+  # Gets search terms and creates Content objects based on the provided results
+  def self.video_search
+    Content.all.clear
+    puts "\n\nPlease enter your video search terms.\n\n"
+    terms = gets.chomp!
+    terms = terms.split(" ").join("%20")
+
+    search_results = CliNasaAPI.media_search("video", terms)
+    search_results = search_results["collection"]["items"]
+
+    search_results.each do |result|
+      attributes = result["data"][0]
+      links = result["links"][0] if result["links"] != nil
+
+      title = attributes["title"]
+      description = attributes["description"]
+      keywords = attributes["keywords"]
+      link = links["href"] if links != nil
+
+      Content.add_content(title, description, keywords, link)
+    end
+  end
+
+  # Method for displaying a piece of content, navigating thorugh its data,
+  # and prompting the user for their next valid command
+  def self.display_content(results)
+    input = ""
+    page = 1
+
+    while input != "s"
+
+      current = results[page-1]
+      puts "\n\nPage #{page}: #{current.title}"
+      if current.link == nil
+        puts "Link: link not available"
+      else
+        puts "Link: #{current.link}"
+      end
+      puts "\n\nHere are your available commands:"
+      puts ">> k - Displays the content's keywords"
+      puts ">> d - Displays the content's description."
+      puts ">> n - Shows the next result"
+      puts ">> p - Shows the previous result"
+      puts ">> s - Start a new search."
+
+      input = self.get_input()
+      case input
+      when "k"
+        puts "\n\nKeywords : #{current.keywords}\n"
+      when "d"
+        puts "\n\nDescription : #{current.description}\n"
+      when "n"
+        if page < results.length
+          page += 1
+        else
+          puts "\n\nThere are no further results.\n"
+        end
+      when "p"
+        if page > 1
+           page -= 1
+        else
+           puts "\n\nYou're at the top of your results.\n"
+         end
+      when "s"
+        self.main_menu
+      else
+        puts "\n\nCommand not recognized, please try again.\n"
+      end
+    end
+  end
+
+end