acnh_villager 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e71b476143c30137d828c99001b236cbfdaa019e652c9726d35ce2eb9b9e23e8
+  data.tar.gz: 8bf451bd380a69311527ca1005a17a32a8078c5681ca9267b324b9047d20aae6
+SHA512:
+  metadata.gz: c4b7c5c24855da0d0c779ba8019807b9c7581fba70421401d740d320c6c6b622622cdd2a7f1ebbef9cee2169113ecb5b2bcd1b4b806000945141509aa0448238
+  data.tar.gz: 6a13ecf968051f4e00ff76ca1aac2ae509d31a87fbfa559e3227668a7f9dc555e39d3458fd0e135955e4f601d9d326676f9a10934b183de2c8dec9e609e3d85d

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

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.6.1
+before_install: gem install bundler -v 2.1.4

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in acnh_villager.gemspec
+gemspec
+
+gem "rake", "~> 12.0"

data/Gemfile.lock

@@ -0,0 +1,65 @@
+PATH
+  remote: .
+  specs:
+    acnh_villager (0.1.0)
+      bundler (~> 2.1.4)
+      colorize (~> 0.8.1)
+      json (~> 2.3.1)
+      rest-client (~> 2.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.3)
+    colorize (0.8.1)
+    diff-lcs (1.4.4)
+    domain_name (0.5.20190701)
+      unf (>= 0.0.5, < 1.0.0)
+    http-accept (1.7.0)
+    http-cookie (1.0.3)
+      domain_name (~> 0.5)
+    json (2.3.1)
+    method_source (0.8.2)
+    mime-types (3.3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2020.0512)
+    netrc (0.11.0)
+    pry (0.10.4)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rake (12.3.3)
+    rest-client (2.1.0)
+      http-accept (>= 1.7.0, < 2.0)
+      http-cookie (>= 1.0.2, < 2.0)
+      mime-types (>= 1.16, < 4.0)
+      netrc (~> 0.8)
+    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)
+    slop (3.6.0)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.7)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  acnh_villager!
+  pry (~> 0.10.3)
+  rake (~> 12.0)
+  rspec (~> 3.9.0)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 ellenupark
+
+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,38 @@
+# AcnhVillager
+
+View detailed information on villagers from Animal Crossing New Horizons.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'acnh_villager'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install acnh_villager
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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/ellenupark/acnh_villager.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

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

data/acnh_villager.gemspec

@@ -0,0 +1,37 @@
+require_relative 'lib/acnh_villager/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "acnh_villager"
+  spec.version       = AcnhVillager::VERSION
+  spec.authors       = ["ellenupark"]
+  spec.email         = ["ellenupark@gmail.com"]
+
+  spec.summary       = %q{Animal Crossing New Horizons villager info generator}
+  spec.description   = %q{Generates info about Animal Crossing New Horizons villagers.}
+  spec.homepage      = "https://github.com/ellenupark/acnh_villager"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  # spec.metadata["allowed_push_host"] = "https://github.com/ellenupark/acnh_villager"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/ellenupark/acnh_villager"
+  spec.metadata["changelog_uri"] = "https://github.com/ellenupark/acnh_villager"
+
+  # 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   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "rest-client", "~> 2.1.0"
+  spec.add_dependency "json", "~> 2.3.1"
+  spec.add_dependency "colorize", "~> 0.8.1"
+  spec.add_dependency "bundler", "~> 2.1.4"
+
+  spec.add_development_dependency "rspec", "~> 3.9.0"
+  spec.add_development_dependency "pry", "~> 0.10.3"
+end

data/bin/acnh_villager

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../lib/acnh_villager'
+
+AcnhVillager::CLI.new.call

data/bin/console

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

@@ -0,0 +1,11 @@
+#Environment file
+
+require 'rest-client'
+require 'json'
+require 'pry'
+require 'colorize'
+require 'bundler'
+require_relative "acnh_villager/version"
+require_relative './acnh_villager/cli'
+require_relative './acnh_villager/api'
+require_relative './acnh_villager/villager'

data/lib/acnh_villager/api.rb

@@ -0,0 +1,25 @@
+class AcnhVillager::API
+
+    def self.scrape_villagers
+        resp = RestClient.get('http://acnhapi.com/v1/villagers/')
+        villager_hash = JSON.parse(resp.body, symbolize_names:true) 
+        villager_hash.each do | k, v | 
+            AcnhVillager::Villager.new(villager_hash[k]) 
+        end
+    end
+
+    def self.scrape_villager_details(villager)
+        resp = RestClient.get(villager.url)
+        villager_hash = JSON.parse(resp.body, symbolize_names:true) 
+        villager.jp_name = villager_hash[:name][:"name-JPja"]
+        villager.personality = villager_hash[:personality]
+        villager.birthday = villager_hash[:'birthday-string']
+        villager.species = villager_hash[:species]
+        villager.gender = villager_hash[:gender]
+        villager.hobby = villager_hash[:hobby]
+        villager.catch_phrase = villager_hash[:"catch-phrase"]
+        villager.image_url = villager_hash[:image_uri]
+        villager.saying = villager_hash[:saying]
+    end
+
+end

data/lib/acnh_villager/cli.rb

@@ -0,0 +1,191 @@
+class AcnhVillager::CLI
+    @@list = []
+    @@search_list = []
+
+    def initialize
+        AcnhVillager::API.scrape_villagers
+        until @@list.length == 10
+            random_villager = AcnhVillager::Villager.all[rand(1..AcnhVillager::Villager.all.count - 1)]
+            @@list << random_villager if !@@list.include?(random_villager)
+        end
+    end
+
+    def call
+        puts "        ------------------------------------------------".colorize(:magenta)
+        puts "       |                                                |".colorize(:magenta)
+        puts "       |                 Animal Crossing                |".colorize(:magenta)
+        puts "       |                  New Horizons                  |".colorize(:magenta)
+        puts "       |                Villager Directory              |".colorize(:magenta)
+        puts "       |                                                |".colorize(:magenta)
+        puts "        ------------------------------------------------".colorize(:magenta)
+        sleep(1)
+        puts ""
+        puts "Welcome to the Animal Crossing New Horizons Villager Directory!"
+        sleep(1)
+        list_villagers
+        menu
+    end
+
+    def line
+        puts "----------------------------------------------------------------"
+    end
+
+    def self.clear_search
+        @@search_list.clear
+    end
+
+    def list_villagers
+        puts ""
+        puts "Listing Today's Featured Villagers..."
+        sleep (1)
+        puts ""
+        @@list.each.with_index(1) do | villager, i |
+            puts "#{i}. #{villager.name}"
+        end
+    end
+
+    def search_villagers
+        puts "Please type the first letter of your desired villager's name."
+        line
+        input = gets.strip.downcase
+        line
+        sleep(1)
+
+        if input == 'x'
+            puts "Could not locate villager with name that begins with 'X'."
+            search_villagers
+        elsif input[/[a-z]\z/]  == input
+            select_villager(input)
+        elsif input == 'exit'
+            goodbye
+        else
+            puts "Invalid input."
+            search_villagers
+        end
+    end
+
+    def select_villager(letter)
+        puts ""
+        search_by_letter = AcnhVillager::Villager.all.select { | villager | villager.name[0].downcase == letter }.sort_by{ | villager | villager.name }
+        search_by_letter.each.with_index(1) do | villager, i |
+            puts "#{i}. #{villager.name}"
+            @@search_list << villager
+        end
+        puts ""
+        puts "Select an above number to view villager details."
+        search_again(letter)
+    end
+
+    def search_again(letter=nil)
+        puts "Type 'back' to search again or type 'menu' to return to main menu."
+        line
+        selection = gets.strip.downcase
+        line
+        sleep(1)
+        if selection.to_i.between?(1, @@search_list.count) 
+            villager = @@search_list.find { | villager | villager.name == @@search_list[selection.to_i - 1].name }
+            display_villager_details(villager)
+            AcnhVillager::CLI.clear_search
+            sleep(1)
+            search_again
+        elsif selection == 'menu'
+            AcnhVillager::CLI.clear_search
+            sleep(1)
+            list_villagers
+            menu
+        elsif selection == 'back'
+            AcnhVillager::CLI.clear_search
+            search_villagers
+        elsif selection == 'exit'
+            goodbye
+        else
+            puts "Invalid input."
+            if letter
+                line
+                sleep(1)
+                select_villager(letter)
+            else
+                search_again
+            end
+        end
+    end
+
+    def menu
+        puts ""
+        puts "Select an above number to view villager details."
+        puts "Type 'search' to look up a specific villager or type 'exit' to quit."
+        line
+        input = gets.strip.downcase
+        line
+        sleep(1)
+        if input.to_i.between?(1, 10) 
+            villager = AcnhVillager::Villager.all.find { | villager | villager.name == @@list[input.to_i - 1].name }
+            display_villager_details(villager)
+            sleep(1)
+            restart
+        elsif input == 'search'
+            search_villagers
+            line
+            search_villagers
+        elsif input == 'exit'
+            goodbye
+        else
+            puts "Invalid input."
+            line
+            sleep(1)
+            list_villagers
+            menu
+        end
+    end
+
+    def display_villager_details(villager)
+        AcnhVillager::API.scrape_villager_details(villager)
+        puts ""
+        puts "Villager Information: ".colorize(:magenta) + "#{villager.name}:"
+        puts ""
+        puts "Japanese Name: ".colorize(:magenta) + "#{villager.jp_name}"
+        puts "Personality: ".colorize(:magenta) + "#{villager.personality}"
+        puts "Birthday: ".colorize(:magenta) + "#{villager.birthday}"
+        puts "Species: ".colorize(:magenta) + "#{villager.species}"
+        puts "Gender: ".colorize(:magenta) + "#{villager.gender}"
+        puts "Hobby: ".colorize(:magenta) + "#{villager.hobby}"
+        puts "Catch Phrase: ".colorize(:magenta) + "#{villager.catch_phrase}"
+        puts "Favorite Saying: ".colorize(:magenta) + "#{villager.saying}"
+        puts "Profile Picture: ".colorize(:magenta) + "#{villager.image_url}"
+        puts ""
+        line
+    end
+
+    def restart 
+        puts "Type 'menu' to return to main menu or type 'exit' to quit."
+        line
+        input = gets.strip.downcase
+        line
+        sleep(1)
+        case input
+        when "menu"
+            list_villagers
+            menu
+        when "exit"
+            goodbye
+        else
+           puts "Invalid input."
+           restart
+        end
+    end
+
+    def goodbye
+        puts ""
+        puts "   _      _      _ ".colorize(:magenta)
+        puts "__(.)< __(.)> __(.)=".colorize(:magenta)
+        puts "\\___)  \\___)  \\___)".colorize(:magenta)
+        puts ""
+        puts "Thanks for visiting!".colorize(:cyan)
+        puts "  _      _      _".colorize(:magenta)
+        puts ">(.)__ <(.)__ =(.)__".colorize(:magenta)
+        puts " (___/  (___/  (___/".colorize(:magenta)
+        puts ""
+        line
+        exit
+    end
+end

data/lib/acnh_villager/version.rb

@@ -0,0 +1,3 @@
+module AcnhVillager
+  VERSION = "0.1.1"
+end

data/lib/acnh_villager/villager.rb

@@ -0,0 +1,15 @@
+class AcnhVillager::Villager
+    @@all = []
+  
+    attr_accessor :url, :name, :jp_name, :personality, :birthday, :species, :gender, :hobby, :catch_phrase, :image_url, :saying
+  
+    def initialize(villager)
+        self.name = villager[:name][:'name-USen']
+        self.url = "http://acnhapi.com/v1/villagers/#{villager[:id].to_s}" 
+        @@all << self
+    end
+  
+    def self.all
+        @@all
+    end
+end

metadata

@@ -0,0 +1,147 @@
+--- !ruby/object:Gem::Specification
+name: acnh_villager
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- ellenupark
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2020-09-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.3.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.3.1
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.4
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.9.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.9.0
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.3
+description: Generates info about Animal Crossing New Horizons villagers.
+email:
+- ellenupark@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- acnh_villager.gemspec
+- bin/acnh_villager
+- bin/console
+- bin/setup
+- lib/acnh_villager.rb
+- lib/acnh_villager/api.rb
+- lib/acnh_villager/cli.rb
+- lib/acnh_villager/version.rb
+- lib/acnh_villager/villager.rb
+homepage: https://github.com/ellenupark/acnh_villager
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/ellenupark/acnh_villager
+  source_code_uri: https://github.com/ellenupark/acnh_villager
+  changelog_uri: https://github.com/ellenupark/acnh_villager
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key:
+specification_version: 4
+summary: Animal Crossing New Horizons villager info generator
+test_files: []