pup_finder 0.5.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ec0c7c0f46bde2811e00c02face34f61dac9867d00f08a5e180ba4bd4564e058
+  data.tar.gz: dfdf4f7da9d724c48fe39dece5d9153ce052a8865deef22e54eda2f5d55dff01
+SHA512:
+  metadata.gz: f89080ee6d5cef79478a1ed746441bcfa38d54e06e77325c5263c3b7d3e35468d07571643dedf827267ee025c7a223cf9313a797730b5a904f34241728514bc4
+  data.tar.gz: c25c11361f354720a5f6b1f9f25e86d33754d5da67d06cff4e6f6505274d5c6f8e7c3c7f525741820a6fc447f45cc0a70822c9f31b657d14d54d5950af3b5d9d

data/.gitignore

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

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 <github email address>. 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,8 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in pup_finder.gemspec
+gem 'pry'
+gem 'require_all'
+gem 'nokogiri'
+gem 'rainbow'
+gemspec

data/Gemfile.lock

@@ -0,0 +1,34 @@
+PATH
+  remote: .
+  specs:
+    pup_finder (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.2)
+    method_source (0.9.2)
+    mini_portile2 (2.4.0)
+    nokogiri (1.10.3)
+      mini_portile2 (~> 2.4.0)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rainbow (3.0.0)
+    rake (10.5.0)
+    require_all (2.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  nokogiri
+  pry
+  pup_finder!
+  rainbow
+  rake (~> 10.0)
+  require_all
+
+BUNDLED WITH
+   2.0.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 <github username>
+
+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,45 @@
+# PupFinder
+
+Welcome to PupFinder! This Ruby gem provides a CLI to browse the American Kennel Club's offical list of dog breeds. The gem also allows you to view more information about a selected breed.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'pup_finder'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install pup_finder
+
+## Usage
+
+Type the below and follow the on screen prompts.
+
+``` ruby
+$ pup_finder
+```
+
+## 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/eponsonby/pup_finder. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## 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 PupFinder project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/eponsonby/pup_finder/blob/master/CODE_OF_CONDUCT.md).

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 "pup_finder"
+
+# 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/pup_finder

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require_relative '../config/environment'
+
+CLI.new.welcome

data/bin/run

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+
+require_relative './pup_finder'

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/config/environment.rb

@@ -0,0 +1,11 @@
+require 'open-uri'
+require_relative '../lib/pup_finder/breed.rb'
+require_relative '../lib/pup_finder/cli.rb'
+require_relative '../lib/pup_finder/scraper.rb'
+require_relative '../lib/pup_finder/urlgenerator.rb'
+require_relative '../lib/pup_finder/version.rb'
+
+require 'pry'
+require 'require_all'
+require 'nokogiri'
+require 'rainbow'

data/lib/pup_finder.rb

@@ -0,0 +1,2 @@
+require_relative './pup_finder/version'
+require_relative '../config/environment'

data/lib/pup_finder/breed.rb

@@ -0,0 +1,23 @@
+class Breed
+    attr_accessor :temperament, :weight, :life_expectancy, :description
+    attr_reader :breed_name, :breed_link, :breed_size
+    
+    @@all = []
+
+    def initialize(breed_name, breed_link, breed_size)
+        @breed_name = breed_name
+        @breed_link = breed_link
+        @breed_size = breed_size
+        @temperament = nil
+        @weight = nil
+        @life_expectancy = nil
+        @description = nil
+        @@all << self
+    end
+
+    def self.all
+        @@all
+    end
+end
+
+

data/lib/pup_finder/cli.rb

@@ -0,0 +1,173 @@
+class CLI
+
+    attr_reader :generated_url, :selected_size, :list
+
+    def welcome
+        puts Rainbow(" _____               ______ _           _").cyan            
+        puts Rainbow("|  __ \\\             |  ____(_)         | |").cyan     
+        puts Rainbow("| |__) |   _ _ __   | |__   _ _ __   __| | ___ _ __").cyan
+        puts Rainbow("|  ___/ | | | '_ \\\  |  __| | | '_ \\\ / _` |/ _ \\\ '__|").cyan
+        puts Rainbow("| |   | |_| | |_) | | |    | | | | | (_| |  __/ |").cyan    
+        puts Rainbow("|_|    \\\__,_| .__/  |_|    |_|_| |_|\\\__,_|\\\___|_|").cyan  
+        puts Rainbow("            | |                                  ").cyan    
+        puts Rainbow("            |_|                                  ").cyan
+        puts Rainbow("\nWelcome to PupFinder!").bright
+        
+        call
+    end
+
+    def call
+        what_size
+            if get_size != "exit"
+                please_wait
+                scrape_pages
+                get_info
+            end
+    end
+
+    def get_info
+        @list = list_breeds
+        enter_a_number
+        number_to_see = get_number(list)
+        
+        if number_to_see == "exit"
+            puts Rainbow("\n\nGoodbye!").cyan
+        else
+            breed_to_scrape = list[number_to_see - 1]
+            exists = Breed.all.select {|breed_object| breed_object.breed_name == breed_to_scrape}
+            
+            if !exists[0].weight
+                AKCScraper.make_breed(number_to_see, list)
+            end
+
+        more_info(number_to_see)
+        continue_message
+        options
+        end
+    end
+
+    def what_size
+        puts "What size pupper are you interested in?"
+        puts "You can say tiny, small, medium, large, or huge\n\n"
+    end
+
+    def get_size
+        sizes_to_select_from = ["tiny", "small", "medium", "large", "huge"]
+        input = gets.strip.downcase
+
+        if input == "tiny"
+            input = "xsmall"
+        elsif input == "huge"
+            input = "xlarge"
+        elsif input == "exit"
+            puts Rainbow("Goodbye!").cyan
+            return "exit"
+        elsif !sizes_to_select_from.include?(input)
+            puts "Please try again"
+            input = get_size
+        end
+        
+        @selected_size = input
+        return input
+    end
+
+    def please_wait
+        puts "\nPlease wait while we load the pups!\n\n"
+    end
+
+    def generate_url(input)
+        url_to_scrape = URLGenerator.new_url(input)  
+    end
+    
+    def scrape_pages
+        #this prevents the program from instantiating new breeds if they already exist
+        if @generated_url == generate_url(selected_size)
+        
+        else
+            @generated_url = generate_url(selected_size)
+            AKCScraper.get_all_pages_of_breeds(generated_url)
+        end
+    end
+
+    # Returns an array of all breed objects (with just name, size and link attributes) that match size
+    def find_all_breeds_by_size(size)
+        Breed.all.select {|breed_object| breed_object.breed_size == size}
+    end
+
+
+    # Returns a numbered list of all breeds by the selected size
+    def list_breeds
+        find_all_breeds_by_size(selected_size).map.with_index do |breed, index|
+            puts Rainbow("#{index + 1}. #{breed.breed_name}").cyan
+            breed.breed_name
+        end
+    end
+
+    def enter_a_number
+        puts "\n\nEnter a number to see more information about that pup \n\n"
+    end
+
+    def get_number(list)
+        range_to_select_from = (1..list.length).to_a
+        number_entered = gets.strip
+            if number_entered != "exit"
+                number_entered = number_entered.to_i
+                loop do
+                    if !range_to_select_from.include?(number_entered)
+                        puts "Please enter a number between #{range_to_select_from[0]} and #{range_to_select_from[-1]}"
+                        return get_number(list)
+                    else
+                        return number_entered
+                    end
+                end
+            else
+                return "exit"
+            end
+    end
+
+    def more_info(number_entered)
+        breed_to_see = @list[number_entered - 1]
+        Breed.all.each do |breed|
+            if breed.breed_name == breed_to_see
+                puts Rainbow("\nThe #{breed.breed_name}\n").bold
+                puts Rainbow("      __\n(___()'`;\n/,    /`\n\\\\'--\\\\\n\n").cyan.bright
+                puts Rainbow("Temperament: ").bold + Rainbow("#{breed.temperament}\n").cyan
+                puts Rainbow("Weight: ").bold + Rainbow("#{breed.weight}\n").cyan
+                puts Rainbow("Life Expectancy: ").bold + Rainbow("#{breed.life_expectancy}\n").cyan
+                puts Rainbow("Description: ").bold + Rainbow("#{breed.description}\n").cyan
+            end
+        end
+    end
+
+
+    def continue_message
+        puts "\nWould you like to see another pup?"
+        puts "You can enter yes, no, or menu to go back to the main menu"
+        puts "Enter exit to end this program\n\n"
+    end
+
+    def continue_gets
+        gets.strip.downcase
+    end
+
+    def options
+        case continue_gets
+            when "yes"
+                puts "\n"
+                get_info
+            when "menu"
+                puts "\n"
+                call
+            when "no"
+                puts Rainbow("\nGoodbye!").cyan
+            when "exit"
+                puts Rainbow("\nGoodbye!").cyan
+            else
+                puts "Please try again"
+                options
+        end
+    end
+
+
+end
+

data/lib/pup_finder/scraper.rb

@@ -0,0 +1,68 @@
+class AKCScraper
+
+    @@load_more_link = nil
+
+    def self.get_first_page_breeds(size_url)
+        #open first url based on user input
+        doc = Nokogiri::HTML(open(size_url))
+
+        # get all breeds on page 1
+        first_page_breeds = doc.css('.breed-card-type-grid .grid-col')
+        initial_breed_instantiation(first_page_breeds, size_url)
+    
+        # get load more link on page 1
+        @@load_more_link = doc.css(".mt2 a").attribute("href").value
+    end
+
+    def self.get_all_pages_of_breeds(size_url)
+        self.get_first_page_breeds(size_url)
+
+        while @@load_more_link do
+            # get all breeds on page #
+            next_page_doc = Nokogiri::HTML(open(@@load_more_link))
+            next_page_breeds = next_page_doc.css('.breed-card-type-grid .grid-col')
+            initial_breed_instantiation(next_page_breeds, size_url)
+            
+            # get load more link on page #
+            @@load_more_link = next_page_doc.css(".mt2 a").attribute("href")
+        end    
+    end
+    
+    def self.initial_breed_instantiation(page_of_breeds, size_url)
+        page_of_breeds.each do |breed|
+            breed_name = breed.css(".breed-type-card a h3").text
+            breed_link = breed.css(".breed-type-card a").attribute('href').value
+            breed_size = size_url.split("=")[1]
+            Breed.new(breed_name, breed_link, breed_size)
+        end
+    end
+
+    def self.make_breed(number, list)
+        breed_to_scrape = list[number - 1]
+
+        # Creates an array with just the object we want to add more data too
+        breed_object_array = Breed.all.select {|breed| breed.breed_name == breed_to_scrape}
+            
+            doc = Nokogiri::HTML(open(breed_object_array[0].breed_link))
+            # Get each li and set each attribute
+            all_lis = doc.css(".panel-flex__aside ul li.attribute-list__row")
+                all_lis.each do |li|
+                    if li.css(".attribute-list__term").text == "Temperament:" 
+                        breed_object_array[0].temperament = li.css(".attribute-list__description").text
+                    elsif li.css(".attribute-list__term").text == "Weight:" 
+                        breed_object_array[0].weight = li.css(".attribute-list__description").text
+                    elsif li.css(".attribute-list__term").text == "Life Expectancy:"
+                        breed_object_array[0].life_expectancy = li.css(".attribute-list__description").text.strip
+                    end
+                end
+        
+            # Sets the breed description
+            if doc.css(".breed-hero__footer")
+                breed_object_array[0].description = doc.css(".breed-hero__footer").text.strip
+            else
+                breed_object_array[0].description = "none available"
+            end
+    end
+
+end
+

data/lib/pup_finder/urlgenerator.rb

@@ -0,0 +1,21 @@
+class URLGenerator
+    
+    def self.new_url(selected_size)
+        base_url = "https://www.akc.org/dog-breeds/"
+        input = selected_size
+        case input
+        when "xsmall"
+            new_url = base_url << "?size=#{input}"
+        when "small"
+            new_url = base_url << "?size=#{input}"
+        when "medium"
+            new_url = base_url << "?size=#{input}"
+        when "large"
+            new_url = base_url << "?size=#{input}"
+        when "xlarge"
+            new_url = base_url << "?size=#{input}"
+        end
+        return new_url
+    end
+
+end

data/lib/pup_finder/version.rb

@@ -0,0 +1,3 @@
+module PupFinder
+  VERSION = "0.5.0"
+end

data/pup_finder.gemspec

@@ -0,0 +1,29 @@
+
+lib = File.expand_path("./lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require_relative "./lib/pup_finder/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "pup_finder"
+  spec.version       = PupFinder::VERSION
+  spec.authors       = ["Erin Ponsonby"]
+  spec.email         = ["erinponsonby@gmail.com"]
+
+  spec.summary       = %q{A gem for browsing the American Kennel Clubs offical list of dogs.}
+  spec.homepage      = "https://github.com/eponsonby/pup_finder"
+  spec.license       = "MIT"
+
+
+  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.executables = ["pup_finder"]
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+
+
+end

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification
+name: pup_finder
+version: !ruby/object:Gem::Version
+  version: 0.5.0
+platform: ruby
+authors:
+- Erin Ponsonby
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-06-26 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'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !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: 
+email:
+- erinponsonby@gmail.com
+executables:
+- pup_finder
+extensions: []
+extra_rdoc_files: []
+files:
+- ".DS_Store"
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/pup_finder
+- bin/run
+- bin/setup
+- config/environment.rb
+- lib/pup_finder.rb
+- lib/pup_finder/breed.rb
+- lib/pup_finder/cli.rb
+- lib/pup_finder/scraper.rb
+- lib/pup_finder/urlgenerator.rb
+- lib/pup_finder/version.rb
+- pup_finder.gemspec
+homepage: https://github.com/eponsonby/pup_finder
+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.4
+signing_key: 
+specification_version: 4
+summary: A gem for browsing the American Kennel Clubs offical list of dogs.
+test_files: []