akc_dog_breeds 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f8bcef40924a605481292245db2926d59391b425a753bc225224d48ca3090a1c
+  data.tar.gz: 41eab1b922e6cf970b78f70fa415535d0eeb6e85854353cdcfcd1baf0694b140
+SHA512:
+  metadata.gz: d6bca36c7d73c09db27acfa3ab0283d70dfc346b7f32725ff7e4650ec29d07ddd3f4bdb5bd8a7796da9df9aa40b3dd0e48d07a9236a04d8e150ab338a6a7d6b7
+  data.tar.gz: 6fb8df31a0531b087276123c398241397f63c5c3e8d3519d6c91f68a2a6e81556a2295c7ed12093d59d0a0c47819a4cc2b908e3c85068f16b516df4e20d621ca

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,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.3
+before_install: gem install bundler -v 1.16.1

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 dog_breeds.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,45 @@
+PATH
+  remote: .
+  specs:
+    dog_breeds (0.1.0)
+      nokogiri
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.2)
+    diff-lcs (1.3)
+    method_source (0.9.0)
+    mini_portile2 (2.3.0)
+    nokogiri (1.8.2)
+      mini_portile2 (~> 2.3.0)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  dog_breeds!
+  pry
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 <bethurban>
+
+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/NOTES.md

@@ -0,0 +1,8 @@
+#Dog Breeds
+
+1. User runs program, gets numbered list of dog groups.
+2. Chooses dog group using number.
+3. Gets numbered list of breeds.
+4. Chooses breed using number.
+5. Gets list of info on breed.
+6. Can return to list of groups or exit.

data/README.md

@@ -0,0 +1,41 @@
+# DogBreeds
+
+Welcome to the DogBreeds gem! This program shows the user a list of the American
+Kennel Club's groups of dog breeds. The user can see all of the breeds within a
+chosen group and then get details on the characteristics of each breed.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'dog_breeds'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install dog_breeds
+
+## Usage
+
+Run using ./bin/dog-breeds. Choose a dog breed group by entering the number of the group. Then choose
+a breed from that group by entering the breed's number. Users will then see characteristics of the
+chosen dog breed. Finally, enter 'Y' to learn about a different dog breed or 'N' to exit the program.
+
+## 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/<bethurban>/dog_breeds.
+
+## 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,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/akc_dog_breeds.gemspec

@@ -0,0 +1,41 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "dog_breeds/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "akc_dog_breeds"
+  spec.version       = DogBreeds::VERSION
+  spec.authors       = ["<bethurban>"]
+  spec.email         = ["<beth.urban@gmail.com>"]
+
+  spec.summary       = "Users can get more info on American Kennel Club dog breeds."
+  spec.description   = "Users can see which dog breeds are in each American Kennel Club groups
+  and get more details on the characteristics of each breed."
+  spec.homepage      = "https://github.com/bethurban/dog_breeds-cli-app"
+  spec.license       = "MIT"
+
+  # 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"] = "TODO: Set to 'http://mygemserver.com'"
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against " \
+  #     "public gem pushes."
+  # end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |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_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry"
+
+  spec.add_dependency "nokogiri"
+
+end

data/bin/console

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

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require_relative '../lib/dog_breeds'
+
+DogBreeds::CLI.new.call

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/dog_breeds.rb

@@ -0,0 +1,9 @@
+require 'nokogiri'
+require 'open-uri'
+require 'pry'
+
+require_relative './dog_breeds/version'
+require_relative './dog_breeds/cli'
+require_relative './dog_breeds/groups'
+require_relative './dog_breeds/breeds'
+require_relative './dog_breeds/breed_details'

data/lib/dog_breeds/breed_details.rb

@@ -0,0 +1,68 @@
+class DogBreeds::BreedDetails
+  attr_reader :fixed_url
+
+  def self.get_url(group, breed)
+    case group
+    when "1"
+      breed_list = DogBreeds::Breeds.scrape_sporting
+      dog = breed_list[breed.to_i - 1]
+      dog_url = dog.css('a')
+      url = dog_url[0]['href']
+      @fixed_url = "http://www.akc.org" + url
+    when "2"
+      breed_list = DogBreeds::Breeds.scrape_hound
+      dog = breed_list[breed.to_i - 1]
+      dog_url = dog.css('a')
+      url = dog_url[0]['href']
+      @fixed_url = "http://www.akc.org" + url
+    when "3"
+      breed_list = DogBreeds::Breeds.scrape_working
+      dog = breed_list[breed.to_i - 1]
+      dog_url = dog.css('a')
+      url = dog_url[0]['href']
+      @fixed_url = "http://www.akc.org" + url
+    when "4"
+      breed_list = DogBreeds::Breeds.scrape_terrier
+      dog = breed_list[breed.to_i - 1]
+      dog_url = dog.css('a')
+      url = dog_url[0]['href']
+      @fixed_url = "http://www.akc.org" + url
+    when "5"
+      breed_list = DogBreeds::Breeds.scrape_toy
+      dog = breed_list[breed.to_i - 1]
+      dog_url = dog.css('a')
+      url = dog_url[0]['href']
+      @fixed_url = "http://www.akc.org" + url
+    when "6"
+      breed_list = DogBreeds::Breeds.scrape_non_sporting
+      dog = breed_list[breed.to_i - 1]
+      dog_url = dog.css('a')
+      url = dog_url[0]['href']
+      @fixed_url = "http://www.akc.org" + url
+    when "7"
+      breed_list = DogBreeds::Breeds.scrape_herding
+      dog = breed_list[breed.to_i - 1]
+      dog_url = dog.css('a')
+      url = dog_url[0]['href']
+      @fixed_url = "http://www.akc.org" + url
+    end
+    details(@fixed_url)
+  end
+
+  def self.details(fixed_url)
+    doc = Nokogiri::HTML(open("#{fixed_url}"))
+
+    details = doc.css('.breed-details .breed-details__main').text
+    details.delete! "\t"
+    details.strip!
+
+    if details != ""
+      puts "\n#{doc.css('.feed-class article h1').text}"
+      puts "#{details}"
+    else
+      puts "\n#{doc.css('.feed-class article h1').text}"
+      puts "The American Kennel Club does not provide any further information on this breed at this time."
+    end
+  end
+
+end

data/lib/dog_breeds/breeds.rb

@@ -0,0 +1,131 @@
+class DogBreeds::Breeds
+
+  @@group_number = ""
+
+  def self.list
+    puts "Which group of breeds would you like to see? (1-7)"
+    @@group_number = gets.strip
+    case @@group_number
+    when "1"
+      scrape_sporting
+      @breeds.each_with_index do |breed, number|
+        puts "#{number + 1}. #{breed}"
+      end
+    when "2"
+      scrape_hound
+      @breeds.each_with_index do |breed, number|
+        puts "#{number + 1}. #{breed}"
+      end
+    when "3"
+      scrape_working
+      @breeds.each_with_index do |breed, number|
+        puts "#{number + 1}. #{breed}"
+      end
+    when "4"
+      scrape_terrier
+      @breeds.each_with_index do |breed, number|
+        puts "#{number + 1}. #{breed}"
+      end
+    when "5"
+      scrape_toy
+      @breeds.each_with_index do |breed, number|
+        puts "#{number + 1}. #{breed}"
+      end
+    when "6"
+      scrape_non_sporting
+      @breeds.each_with_index do |breed, number|
+        puts "#{number + 1}. #{breed}"
+      end
+    when "7"
+      scrape_herding
+      @breeds.each_with_index do |breed, number|
+        puts "#{number + 1}. #{breed}"
+      end
+    else
+      puts "\nInvalid entry. Please enter a valid group number."
+      DogBreeds::Groups.list
+      self.list
+    end
+  end
+
+  def self.pick_breed(group_number = "")
+    group_number = @@group_number
+    puts "\nWhich breed would you like more information on? (Enter the breed's number.)"
+    @breed_number = gets.strip
+    DogBreeds::BreedDetails.get_url(@@group_number, @breed_number)
+  end
+
+  def self.scrape_sporting
+    doc = Nokogiri::HTML(open("http://www.akc.org/dog-breeds/groups/sporting/"))
+    @breeds = []
+    @dogs = doc.css('.event-contain .scale-contents h2')
+    #@dogs instance variable gives you XML of all the dogs in the group, which is
+    #used in the BreedDetails class to scrape the chosen breed's individual URL
+    @dogs.each do |dog|
+      @breeds << dog.css('a[href]').text
+    end
+    #@breeds is an array of strings of all the breeds in the group
+    @dogs
+  end
+
+  def self.scrape_hound
+    doc = Nokogiri::HTML(open("http://www.akc.org/dog-breeds/groups/hound/"))
+    @breeds = []
+    @dogs = doc.css('.event-contain .scale-contents h2')
+    @dogs.each do |dog|
+      @breeds << dog.css('a[href]').text
+    end
+    @dogs
+  end
+
+  def self.scrape_working
+    doc = Nokogiri::HTML(open("http://www.akc.org/dog-breeds/groups/working/"))
+    @breeds = []
+    @dogs = doc.css('.event-contain .scale-contents h2')
+    @dogs.each do |dog|
+      @breeds << dog.css('a[href]').text
+    end
+    @dogs
+  end
+
+  def self.scrape_terrier
+    doc = Nokogiri::HTML(open("http://www.akc.org/dog-breeds/groups/terrier/"))
+    @breeds = []
+    @dogs = doc.css('.event-contain .scale-contents h2')
+    @dogs.each do |dog|
+      @breeds << dog.css('a[href]').text
+    end
+    @dogs
+  end
+
+  def self.scrape_toy
+    doc = Nokogiri::HTML(open("http://www.akc.org/dog-breeds/groups/toy/"))
+    @breeds = []
+    @dogs = doc.css('.event-contain .scale-contents h2')
+    @dogs.each do |dog|
+      @breeds << dog.css('a[href]').text
+    end
+    @dogs
+  end
+
+  def self.scrape_non_sporting
+    doc = Nokogiri::HTML(open("http://www.akc.org/dog-breeds/groups/non-sporting/"))
+    @breeds = []
+    @dogs = doc.css('.event-contain .scale-contents h2')
+    @dogs.each do |dog|
+      @breeds << dog.css('a[href]').text
+    end
+    @dogs
+  end
+
+  def self.scrape_herding
+    doc = Nokogiri::HTML(open("http://www.akc.org/dog-breeds/groups/herding/"))
+    @breeds = []
+    @dogs = doc.css('.event-contain .scale-contents h2')
+    @dogs.each do |dog|
+      @breeds << dog.css('a[href]').text
+    end
+    @dogs
+  end
+
+end

data/lib/dog_breeds/cli.rb

@@ -0,0 +1,43 @@
+class DogBreeds::CLI
+
+  def call
+    input = nil
+    puts "Welcome!\n\n"
+    while input != "N"
+      list_groups
+      list_breeds
+      pick_breed
+      puts ""
+      puts "Do you want to learn about another breed? (Y/N)"
+      input = gets.strip.upcase
+    end
+    goodbye
+  end
+
+  def list_groups
+    groups = DogBreeds::Groups.scrape_groups
+    puts "These are the American Kennel Club's groups of dog breeds:"
+    puts <<~DOC
+    1. #{groups[0]}
+    2. #{groups[1]}
+    3. #{groups[2]}
+    4. #{groups[3]}
+    5. #{groups[4]}
+    6. #{groups[5]}
+    7. #{groups[6]}
+
+    DOC
+  end
+
+  def list_breeds
+    DogBreeds::Breeds.list
+  end
+
+  def pick_breed
+    DogBreeds::Breeds.pick_breed
+  end
+
+  def goodbye
+    puts "\nWoof! See you next time!"
+  end
+end

data/lib/dog_breeds/groups.rb

@@ -0,0 +1,30 @@
+class DogBreeds::Groups
+
+  @@group_fixed_array = []
+
+  def self.scrape_groups
+    doc = Nokogiri::HTML(open("http://www.akc.org/dog-breeds/"))
+    groups = doc.css('.side-nav ul')[1]
+    groups_string = groups.css('li').text
+    groups_array = groups_string.split(/(?=[A-Z])/)
+    #groups_array has each group name split into separate strings, so we combine them below
+    #["Sporting ", "Group"] becomes ["Sporting Group"]
+    group_1 = groups_array[0] + groups_array[1]
+    @@group_fixed_array << group_1
+    group_2 = groups_array[2] + groups_array[3]
+    @@group_fixed_array << group_2
+    group_3 = groups_array[4] + groups_array[5]
+    @@group_fixed_array << group_3
+    group_4 = groups_array[6] + groups_array[7]
+    @@group_fixed_array << group_4
+    group_5 = groups_array[8] + groups_array[9]
+    @@group_fixed_array << group_5
+    group_6 = groups_array[10] + groups_array[11] + groups_array[12]
+    @@group_fixed_array << group_6
+    group_7 = groups_array[13] + groups_array[14]
+    @@group_fixed_array << group_7
+
+    @@group_fixed_array
+  end
+
+end

data/lib/dog_breeds/version.rb

@@ -0,0 +1,3 @@
+module DogBreeds
+  VERSION = "0.1.0"
+end

data/spec.md

@@ -0,0 +1,19 @@
+# Specifications for the CLI Assessment
+
+Specs:
+- [x] Have a CLI for interfacing with the application
+The CLI class welcomes the user and asks him to choose from a list of dog groups.
+The user is then given a list of breeds in his chosen group. He can pick which
+breed he wants more information on and is given a list of breed characteristics.
+The user can then choose to get details on another dog breed or exit the program.
+
+- [x] Pull data from an external source
+The program scrapes the dog group names, the dog breeds in each group, and the
+traits of each breed from the American Kennel Club's website: http://www.akc.org/
+No information is hard coded.
+
+- [x] Implement both list and detail views
+The user is given two list views - one master list of breed groups, then a
+list of breeds in a chosen group.
+After choosing a breed within in a group, the user gets a detail view on that
+breed - a list of traits specific to that breed.

metadata

@@ -0,0 +1,137 @@
+--- !ruby/object:Gem::Specification
+name: akc_dog_breeds
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- "<bethurban>"
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-04-05 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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: |-
+  Users can see which dog breeds are in each American Kennel Club groups
+    and get more details on the characteristics of each breed.
+email:
+- "<beth.urban@gmail.com>"
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".DS_Store"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- NOTES.md
+- README.md
+- Rakefile
+- akc_dog_breeds.gemspec
+- bin/console
+- bin/dog-breeds
+- bin/setup
+- lib/dog_breeds.rb
+- lib/dog_breeds/breed_details.rb
+- lib/dog_breeds/breeds.rb
+- lib/dog_breeds/cli.rb
+- lib/dog_breeds/groups.rb
+- lib/dog_breeds/version.rb
+- spec.md
+homepage: https://github.com/bethurban/dog_breeds-cli-app
+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: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Users can get more info on American Kennel Club dog breeds.
+test_files: []