sw_characters 0.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: da1b3321cd5d570d31e5965f90aa5d2359a143f49adc2af4096fd80b15bb0982
+  data.tar.gz: 5bcf61e423f10171bcd06b90e2f6dbe55373b65673ea5afa1b3abeeee7eaa1a4
+SHA512:
+  metadata.gz: 3c57fce5657a12b6c7986e4bf7c574bb5e1a1ebf4272ba046c4fcc79cb3804832284f011dfa94e70d9c0b3bc2809f1deae0dceb708b49133f9bb78a830a392dc
+  data.tar.gz: '08298cd33336159bbf616a73d53b4064059f9a1ac85e929fec6f1d2690a74e9bcbd235782d2bfda5779edbd83ad912e112051f8676d0edb438826c2e2cf1fe10'

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at 'grantsmith1256@gmail.com'. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 'grant smith'
+
+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,37 @@
+# SwCharacters
+
+## Description
+
+The Star Wars Character Database is a self-updating encyclopedia of all named characters in the Star Wars movies. It also has additional information all planets and species in the Star Wars Universe, as well as most films (currently only updated through Episode 7).
+
+## Video Demo
+
+A video walkthrough can be found <a href="https://www.youtube.com/watch?v=kkgj5NtZ_bU">here</a>
+
+
+## Installation
+
+Just download all files from the repository and simply run in the terminal: 
+
+./bin/sw_characters
+
+Then follow the onscreen instructions
+
+## Usage
+
+The program will load with 6 options.
+
+Typing 1-4 will list the selected items in a numbered format. Type the number of the option you would like, then more information about that item will appear.
+
+Typing 5 will allow you to search through the list of characters using their name. It will display a list format if there are multiple hits to your search, otherwise it will display the character info of the closest match. Please refrain from using any titles like "General" or "Emperor". The character list records their true names (or at least known names) and does not include titles.
+
+Entering exit will exit the program
+
+## License
+
+The license for the program is included in the file directory: LICENSE.txt
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/mlmccor/sw_characters.

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "sw_characters"
+
+# 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/bin/sw_characters

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+require_relative '../lib/sw_characters'
+
+cli = SwCharacters::CLI.new
+cli.run

data/lib/sw_characters.rb

@@ -0,0 +1,9 @@
+require_relative "sw_characters/version"
+require_relative './sw_characters/cli.rb'
+require_relative './sw_characters/character.rb'
+require_relative './sw_characters/api.rb'
+require_relative './sw_characters/planet.rb'
+require_relative './sw_characters/film.rb'
+require_relative './sw_characters/species.rb'
+require 'open-uri'
+require 'nokogiri'

data/lib/sw_characters/api.rb

@@ -0,0 +1,88 @@
+require 'open-uri'
+require 'nokogiri'
+require 'json'
+
+class SwCharacters::API
+
+  def self.load_characters
+    puts "Loading Characters..."
+    y = 1
+    x = 1
+    until y == SwCharacters::Character.all.length
+      data = open("https://swapi.co/api/people/?page=#{x}&format=json").read
+      my_hash = JSON.parse(data)
+      y = my_hash['count'].to_i
+      print "#{SwCharacters::Character.all.length}..."
+      people = my_hash['results']
+      people.each do |person|
+        if person['species'].length == 0
+          species_hash = {'1' => 'unknown'}
+        else
+          species_hash = SwCharacters::Species.all.select do |key, value|
+            key == person['species'].first.split('/').last
+          end
+        end
+        planet_hash = SwCharacters::Planet.all.select do |key, value|
+          key == person['homeworld'].split('/').last
+        end
+        film_ids = person['films'].map {|film_url| film_url.split('/').last}
+        film_hashes = SwCharacters::Film.all.select do |film_id, film|
+          film_ids.include?(film.film_id)
+        end
+        films = film_hashes.map {|key, value| value}
+        SwCharacters::Character.new(person['name'], planet_hash.values[0], films, species_hash.values[0], person['url'].split('/').last)
+      end
+      x += 1
+    end
+    puts "#{SwCharacters::Character.all.length} Characters Loaded"
+  end
+
+  def self.load_planets
+    print "Loading Planets..."
+    y = 1
+    x = 1
+    until y == SwCharacters::Planet.all.length
+      data = open("https://swapi.co/api/planets/?page=#{x}&format=json").read
+      my_hash = JSON.parse(data)
+      y = my_hash['count'].to_i
+      planets = my_hash['results']
+      planets.each do |planet|
+        id = planet['url'].split('/').last
+        SwCharacters::Planet.new(planet['name'], id, planet['climate'], planet['terrain'])
+      end
+      x += 1
+    end
+    puts "Planets Loaded"
+  end
+
+  def self.load_films
+    print "Loading Films..."
+      data = open("https://swapi.co/api/films/?format=json").read
+      my_hash = JSON.parse(data)
+      films = my_hash['results']
+      films.each do |film|
+        id = film['url'].split('/').last
+        SwCharacters::Film.new(film['title'],film['opening_crawl'],film['director'],film['release_date'], id)
+      end
+      puts "Films Loaded"
+  end
+
+  def self.load_species
+    print "Loading Species..."
+    y = 1
+    x = 1
+    until y == SwCharacters::Species.all.length
+      data = open("https://swapi.co/api/species/?page=#{x}&format=json").read
+      my_hash = JSON.parse(data)
+      y = my_hash['count'].to_i
+      species = my_hash['results']
+      species.each do |species|
+        id = species['url'].split('/').last
+        SwCharacters::Species.new(species['name'],species['classification'],species['language'], id)
+      end
+      x += 1
+    end
+    puts "Species loaded"
+  end
+
+end

data/lib/sw_characters/character.rb

@@ -0,0 +1,20 @@
+class SwCharacters::Character
+
+  attr_accessor :name, :homeworld, :films, :species, :character_id
+  
+  @@all = {}
+
+  def initialize(name, homeworld, films, species, character_id)
+    self.name = name
+    self.homeworld = homeworld
+    self.films = films
+    self.species = species
+    self.character_id = character_id
+    self.class.all[character_id] = self
+  end
+
+  def self.all
+    @@all
+  end
+
+end

data/lib/sw_characters/cli.rb

@@ -0,0 +1,215 @@
+require 'pry'
+
+
+class SwCharacters::CLI
+
+  def run
+    puts ""
+    puts "
+██╗    ██╗███████╗██╗      ██████╗ ██████╗ ███╗   ███╗███████╗
+██║    ██║██╔════╝██║     ██╔════╝██╔═══██╗████╗ ████║██╔════╝
+██║ █╗ ██║█████╗  ██║     ██║     ██║   ██║██╔████╔██║█████╗
+██║███╗██║██╔══╝  ██║     ██║     ██║   ██║██║╚██╔╝██║██╔══╝
+╚███╔███╔╝███████╗███████╗╚██████╗╚██████╔╝██║ ╚═╝ ██║███████╗
+ ╚══╝╚══╝ ╚══════╝╚══════╝ ╚═════╝ ╚═════╝ ╚═╝     ╚═╝╚══════╝
+
+"
+    puts "Welcome to the Star Wars Character Database!"
+    puts ""
+    SwCharacters::API.load_planets
+    SwCharacters::API.load_films
+    SwCharacters::API.load_species
+    SwCharacters::API.load_characters
+
+    self.menu
+  end
+
+  def menu
+    puts ""
+    puts "1. List all Characters"
+    puts "2. List all Planets"
+    puts "3. List all Films"
+    puts "4. List all Species"
+    puts "5. Search Characters by name"
+    puts "exit: Exits the program"
+    # run while @input != "exit"
+    input = gets.strip
+    case input
+    when '1'
+      self.list_characters
+    when '2'
+      self.list_planets
+    when '3'
+      self.list_films
+    when '4'
+      self.list_species
+    when '5'
+      self.search_characters
+    when 'exit'
+      puts "Thank you for using the Star Wars Character Database!"
+      puts "May the Force be with you!"
+    end
+  end
+
+  def return_to_menu
+    puts ""
+    puts "Type 1 to return to the main menu"
+    input = gets.chomp
+    input == '1' ? self.menu : nil
+  end
+
+
+  def list_characters
+    puts ""
+    sorted = SwCharacters::Character.all.sort_by {|id, character| id.to_i}
+    sorted.each do |character|
+      puts "#{character[0]}. #{character[1].name}"
+    end
+    puts "Select a character number or type menu for main menu"
+    input = gets.chomp
+    if SwCharacters::Character.all.keys.include?(input)
+      self.display_character(input)
+    elsif input == 'menu'
+      self.menu
+    else
+      'Invalid input'
+      self.list_characters
+    end
+  end
+
+  def display_character(input)
+    puts ""
+    puts "#{SwCharacters::Character.all[input].name}"
+    puts "Homeworld: #{SwCharacters::Character.all[input].homeworld.name}"
+    if SwCharacters::Character.all[input].species == 'unknown'
+      puts "Species: unknown"
+    else
+      puts "Species: #{SwCharacters::Character.all[input].species.name}"
+    end
+    puts "Films:"
+    puts ""
+    SwCharacters::Character.all[input].films.each {|film| puts "#{film.title}"}
+    self.return_to_menu
+  end
+
+  def list_planets
+    puts ""
+    sorted = SwCharacters::Planet.all.sort_by {|id, planet| id.to_i}
+    sorted.each do |planet|
+      puts "#{planet[0]}. #{planet[1].name}"
+    end
+    puts "Select a planet number or type menu for main menu"
+    input = gets.chomp
+    if input == 'menu'
+      self.menu
+    elsif (SwCharacters::Planet.all.keys).include?(input)
+      self.display_planet(input)
+    end
+  end
+
+  def display_planet(input)
+    puts ""
+    puts "#{SwCharacters::Planet.all[input].name}"
+    puts "Climate: #{SwCharacters::Planet.all[input].climate}"
+    puts "Terrain: #{SwCharacters::Planet.all[input].terrain}"
+    puts "Natives:"
+    SwCharacters::Character.all.each do |id, character|
+      if character.homeworld.name == SwCharacters::Planet.all[input].name
+        puts "#{character.name}"
+      end
+    end
+    self.return_to_menu
+  end
+
+  def list_films
+    puts ""
+    sorted = SwCharacters::Film.all.sort_by {|id, planet| id.to_i}
+    sorted.each do |film|
+      puts "#{film[0]}. #{film[1].title}"
+    end
+    puts "Select a film number or type menu for main menu"
+    input = gets.chomp
+    if input == 'menu'
+      self.menu
+    elsif (SwCharacters::Film.all.keys).include?(input)
+      self.display_film(input)
+    end
+  end
+
+  def display_film(input)
+    puts ""
+    puts "Title: #{SwCharacters::Film.all[input].title}"
+    puts "Director: #{SwCharacters::Film.all[input].director}"
+    puts "Release Date: #{SwCharacters::Film.all[input].release_date}"
+    puts "Opening Crawl:"
+    puts ""
+    puts "#{SwCharacters::Film.all[input].opening_crawl.strip}"
+    self.return_to_menu
+  end
+
+  def list_species
+    puts ""
+    sorted = SwCharacters::Species.all.sort_by {|id, species| id.to_i}
+    sorted.each do |species|
+      puts "#{species[0]}. #{species[1].name}"
+    end
+    puts ""
+    puts "Select a species number or type menu for main menu"
+    input = gets.chomp
+    if input == 'menu'
+      self.menu
+    elsif (SwCharacters::Species.all.keys).include?(input)
+      self.display_species(input)
+    end
+  end
+
+  def display_species(input)
+    puts ""
+    puts "Name: #{SwCharacters::Species.all[input].name}"
+    puts "Classification: #{SwCharacters::Species.all[input].classification}"
+    puts "Language: #{SwCharacters::Species.all[input].language}"
+    puts "Example Characters:"
+    puts ""
+    SwCharacters::Character.all.each do |id, character|
+      if character.species != 'unknown'
+        if character.species.name == SwCharacters::Species.all[input].name
+          puts "#{character.name}"
+        end
+      end
+    end
+    self.return_to_menu
+  end
+
+  def search_characters
+    puts ''
+    puts 'Please type the name of a character'
+    puts 'For best results, type only one part of their name and omit titles like "General"'
+    input = gets.chomp
+    results = SwCharacters::Character.all.select do |id, character|
+      character.name.include?(input)
+    end
+    if results.length == 0
+      puts ""
+      "No results, please try another search"
+      self.search_characters
+    elsif results.length == 1
+      self.display_character(results.values.first.character_id)
+    else
+      self.display_results(results)
+    end
+  end
+
+  def display_results(results)
+    puts ""
+    results.each {|index, character| puts "#{index}. #{character.name}"}
+    puts ''
+    puts "Please type the number of the entry you were searching for or type search to try again."
+    input= gets.chomp
+    if input == 'search'
+      self.search_characters
+    elsif results.keys.include?(input)
+      self.display_character(results[input].character_id)
+    end
+  end
+
+end

data/lib/sw_characters/film.rb

@@ -0,0 +1,17 @@
+class SwCharacters::Film
+  attr_accessor :title, :opening_crawl, :director, :release_date, :film_id
+  @@all = {}
+
+  def initialize(title, opening_crawl, director, release_date, id)
+    self.title = title
+    self.opening_crawl = opening_crawl
+    self.director = director
+    self.release_date = release_date
+    self.film_id = id
+    self.class.all[self.film_id] = self
+  end
+
+  def self.all
+    @@all
+  end
+end

data/lib/sw_characters/planet.rb

@@ -0,0 +1,18 @@
+class SwCharacters::Planet
+  attr_accessor :name, :planet_id, :climate, :terrain
+  @@all = {}
+
+  def initialize(name, id, climate, terrain)
+    self.name = name
+    self.planet_id = id
+    self.climate = climate
+    self.terrain = terrain
+    self.class.all[self.planet_id] = self
+  end
+
+  def self.all
+    @@all
+  end
+
+
+end

data/lib/sw_characters/species.rb

@@ -0,0 +1,16 @@
+class SwCharacters::Species
+  attr_accessor :name, :classification, :language, :species_id
+  @@all = {}
+
+  def initialize(name, classification, language, id)
+    self.name = name
+    self.classification = classification
+    self.language = language
+    self.species_id = id
+    self.class.all[self.species_id] = self
+  end
+
+  def self.all
+    @@all
+  end
+end

data/lib/sw_characters/version.rb

@@ -0,0 +1,3 @@
+module SwCharacters
+  VERSION = "0.4.0"
+end

data/sw_characters.gemspec

@@ -0,0 +1,39 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "sw_characters/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "sw_characters"
+  spec.version       = SwCharacters::VERSION
+  spec.authors       = ["Matthew McCormack"]
+  spec.email         = ["mmccormack1182@gmail.com"]
+
+  spec.summary       = "An API built encyclopedia of characters, planets, species, and films from the Star Wars Universe."
+  spec.description   = "An encyclopedia of all named characters in the Star Wars Movies, including their species, fims, and homeworlds. You can manually look through each list or search spefic characters by their name."
+  spec.homepage      = "http://www.github.com/mlmccor/sw_characters"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "https://www.rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # 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        = "exe"
+  spec.executables  = ["sw_characters"]
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+
+  spec.license = 'MIT'
+
+end

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification
+name: sw_characters
+version: !ruby/object:Gem::Version
+  version: 0.4.0
+platform: ruby
+authors:
+- Matthew McCormack
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-10-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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'
+description: An encyclopedia of all named characters in the Star Wars Movies, including
+  their species, fims, and homeworlds. You can manually look through each list or
+  search spefic characters by their name.
+email:
+- mmccormack1182@gmail.com
+executables:
+- sw_characters
+extensions: []
+extra_rdoc_files: []
+files:
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- bin/sw_characters
+- lib/sw_characters.rb
+- lib/sw_characters/api.rb
+- lib/sw_characters/character.rb
+- lib/sw_characters/cli.rb
+- lib/sw_characters/film.rb
+- lib/sw_characters/planet.rb
+- lib/sw_characters/species.rb
+- lib/sw_characters/version.rb
+- sw_characters.gemspec
+homepage: http://www.github.com/mlmccor/sw_characters
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://www.rubygems.org
+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.6
+signing_key: 
+specification_version: 4
+summary: An API built encyclopedia of characters, planets, species, and films from
+  the Star Wars Universe.
+test_files: []