indeed_scraper 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 31a4a686bc7617cd3d7cda00a6b207ae3e16e6aec5fdc606583629d5dbe37dde
+  data.tar.gz: 20d53a19f5d6732df7cdd1fe5284ff550232431b7b80fb86610e08a928c7f9c3
+SHA512:
+  metadata.gz: aaffb8511b507201d57e74f4ca0467e07701cbd07d748ba85a54e4699f991a45a845707ecca823fa34f3d8b65d97536f6ea76433d42c7f62af17d8afbadb164c
+  data.tar.gz: 464e7e9dbab6d49a26ffbc7827fcd0fb4f41a9b00e5755a7890c0ae5088ab41c52664644cb467214f05150cb9cd0551f0bf7bf7859040c828d897a3164aea9e2

data/.gitignore

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

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 'sheena.myb@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,9 @@
+source "https://rubygems.org"
+
+git_source(:github) {|indeed_scraper| "https://github.com/essbee808/indeed_scraper" }
+gem 'colorize'
+gem 'nokogiri'
+gem 'open-uri'
+
+# Specify your gem's dependencies in indeed_scraper.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 'Sheena Bonilla'
+
+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,41 @@
+# IndeedScraper
+
+Welcome to Indeed Scraper! This CLI (Command Line Interface) Gem was created to provide assistance in finding employment. Data is extracted from an external source (i.e. www.indeed.com) and displayed as the following attributes: title, company, location, hours/salary, job url, and a short description.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'indeed_scraper'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install indeed_scraper
+
+## Usage
+
+jobs = IndeedScraper::Job.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/run` 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/'essbee808'/indeed_scraper. 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 IndeedScraper project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/'essbee808'/indeed_scraper/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,15 @@
+#!/usr/bin/env ruby
+    #=> tells the shell which interpreter to use to execute the remainder of the file.
+
+require "bundler/setup"
+require "indeed/scraper"
+
+# 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/notes

@@ -0,0 +1,30 @@
+bin/
+  code that relates to running the program
+  executable files
+
+config/
+  code needed to initialize the environment
+  i.e. file requirements, connections to database, access to test suite, etc.
+  
+lib/
+  code that defines what the program does
+  "Meat"
+  classes, methods, etc.
+
+spec/ || test/
+  tests that check to see if code is behaving as desired
+
+Gemfile
+  used by Bundler to manage gem dependencies
+  
+
+
+// Gems
+Open-uri
+  access website
+  
+Nokogiri
+  used to parse XML/HTML
+
+Colorize
+  add colored text

data/bin/run

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require_relative '../lib/indeed_scraper.rb'
+
+CommandLineInterface.new.run_program
+
+

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/indeed_scraper.gemspec

@@ -0,0 +1,42 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "indeed_scraper/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "indeed_scraper"
+  spec.version       = IndeedScraper::VERSION
+  spec.authors       = ["'Sheena Bonilla'"]
+  spec.email         = ["'sheena.myb@gmail.com'"]
+  spec.files         = ["lib/indeed_scraper.rb"]
+  spec.summary       = %q{Indeed Scraper was created to provide assistance in finding employment.}
+  spec.description   = %q{Data is extracted from an external source (i.e. www.indeed.com) and displayed as the following attributes: title, location, hours/salary, job url, and a short description.}
+  spec.homepage      = "https://github.com/essbee808/indeed_scraper"
+  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"] = "https://rubygems.org/profiles/essbee808"
+
+  #   spec.metadata["homepage_uri"] = spec.homepage
+  #   spec.metadata["source_code_uri"] = "https://github.com/essbee808/indeed_scraper.git"
+  # 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   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_dependency "colorize", "0.8"
+  spec.add_dependency "nokogiri", "1.8.5"
+end

data/lib/indeed_scraper/command_line_interface.rb

@@ -0,0 +1,153 @@
+class CommandLineInterface
+  
+  BASE_PATH = "https://www.indeed.com"
+  
+  def run_program
+    greeting
+    make_jobs
+    add_other_attributes_to_job
+    display_job
+  end
+  
+  def greeting
+    puts "Hello there! Welcome to Indeed Scraper Command Line Interface.".green
+    puts "What is your name?".green
+    @user_name = user_input
+    puts " "
+    puts "Aloha, #{@input}!".green
+    puts "Enter your 5 digit zipcode:".green
+  end
+
+#User's input
+  def user_input
+    input = gets.strip #remove white space
+    @input = input
+  end
+  
+  def make_selection
+    puts " "
+    puts "Select a number from the list above for more info.".green
+    puts "Enter a number:".green
+    user_input
+
+    if @input.to_i.between?(1, 15)
+        puts " "
+        job = Job.all[@input.to_i-1]
+
+        puts " "
+        puts "TITLE: ".blue + "#{job.title}\n" if !job.title.empty?        
+        puts "COMPANY: ".blue + "#{job.company}\n" if !job.company.empty?
+        puts "HOURS/SALARY: ".blue + "#{job.type}\n" if !job.type.empty?
+        puts "LOCATION: ".blue + "#{job.location}\n\n" if !job.location.empty?
+        if !job.description.empty?
+          puts "DESCRIPTION: \n".blue
+          puts "#{job.description}\n"
+        end
+        menu_list
+    else
+        make_selection
+    end
+  end
+
+  def menu_list
+    puts " "
+    puts "What do you want to do, #{@user_name}?".green
+    puts "Enter a number:\n".green
+    puts "1. Apply"
+    puts "2. Go back"
+    puts "3. Exit\n"
+
+    user_input
+    # binding.pry
+    if @input.to_i == 1
+      job = Job.all[@input.to_i-1]
+      puts "To apply, right click on the link below then select 'Open URL'.".green
+      puts " "
+      puts BASE_PATH + job.job_url
+      menu_list
+    elsif @input.to_i == 2
+      display_job
+    elsif @input.to_i == 3
+      puts " "
+      puts "See you later, #{@user_name}! Good luck on your job search!".green
+    else
+      menu_list
+    end
+  end
+
+  def verify_zipcode
+     if /^[0-9]{5}$/.match(@input)
+      puts "Great! We found some cool jobs for #{@input}.".green
+      puts "Loading may take a few moments, so in the meantime, please enjoy this cute cat: \n\n\n".green
+      puts "                       /\\_/\\                     ".magenta.blink
+      puts "                      ( o.o )                      ".magenta.blink
+      puts "                       > ^ <                       \n\n\n\n".magenta.blink
+     else
+      puts "Hmm...that doesn't look right. Enter your 5 digit zipcode:".green
+      user_input
+      verify_zipcode
+    end
+    @input
+  end
+  
+  def make_jobs
+    user_input
+    puts " "
+    verify_zipcode
+    jobs_array = Scraper.scrape_index_page(@input)
+    Job.create_from_collection(jobs_array)  # creates an array of job objects with 4 attributes
+  end
+  
+  def add_other_attributes_to_job
+    Job.all.each do |job|
+      other_details = Scraper.scrape_job_post(BASE_PATH + job.job_url)
+      job.add_job_attributes(other_details)
+    end
+  end
+  
+  def display_job
+        Job.all.each.with_index(1) do |el, index|
+            #if index <= 4 #=> displays first 5 jobs in @@all array
+            puts "#{index}" + ". " + "#{el.title}\n\n"
+        end
+        make_selection
+  end
+
+end
+            
+#display first 5 jobs
+#prompt user to make a selection or type 'more' for more choices
+#if user selects index 0-4
+#    display details for job object
+#    ask for user input
+#    prompts: apply (display url) or go back?
+#elsif user selects 'more'
+#    pull next 5 job objects from array
+#    display as 1-5?
+#    ask for user input
+#    prompt: make a selection or type 'more' for more choices
+#else
+#    loop
+#end
+
+
+# prompt user for zipcode
+  #Great! Please enter your 5 digit zipcode:
+
+# user types zipcode
+
+# first scrape => grabs first 15 and create job objects
+#Scraper.scrape_index_page(index)
+
+# display 5 jobs at a time
+
+# user selects job from list to get more info
+
+# second scrape => display everything nicely
+  # attributes: type (part/full), description, wage...
+  
+# conditional => Still interested? Type yes or no
+
+# give options to see next 5 jobs
+
+# set variable equal to last index number?

data/lib/indeed_scraper/job.rb

@@ -0,0 +1,33 @@
+class Job
+  attr_accessor :title, :company, :description, :location, :job_url, :type
+  
+  @@all = []
+  
+  def initialize(job_hash)
+    job_hash.each {|key, value| self.send(("#{key}="), value)}
+    @@all << self
+  end
+  
+  def self.create_from_collection(jobs_array)
+    jobs_array.each do |hash|
+      new_job = self.new(hash)
+      new_job
+    end
+  end
+  
+  def add_job_attributes(other_details)
+    #iterate over attributes_hash
+      #use metaprogramming; assign job attributes and values using send method
+      other_details.each do |key, value|
+        @description = other_details[:description]
+        @type = other_details[:type]
+      end
+    @description = self.description
+    @type = self.type
+  end
+  
+  def self.all
+    @@all
+  end
+  
+end

data/lib/indeed_scraper/scraper.rb

@@ -0,0 +1,34 @@
+class Scraper
+  
+  BASE_PATH = "https://www.indeed.com"
+
+  def self.scrape_index_page(input)
+    html = open(BASE_PATH + "/l-#{input}-jobs.html") # interpolate input
+    parsed_page = Nokogiri::HTML(html)
+    all_jobs = parsed_page.css('div.jobsearch-SerpJobCard')
+
+    all_jobs.collect do |job_card|
+      job = {
+        :title => job_card.css('a').attr('title').value,
+        :company => job_card.css('span.company').text.strip, #remove white space
+        :location => job_card.css('div.location').text,
+        :job_url => job_card.css('a').attr('href').value
+      }
+      job
+    end
+  end
+    
+  def self.scrape_job_post(job_url)
+      html = open(job_url)
+      parsed_job_post = Nokogiri::HTML(html) #parse html
+      other_details = parsed_job_post.css('div.jobsearch-ViewJobLayout-jobDisplay')
+      
+      details_hash = {}
+      
+      other_details.each do |info|
+          details_hash[:description] = info.css('div.jobsearch-JobComponent-description p').text
+          details_hash[:type] = info.css('div.jobsearch-JobMetadataHeader-item').text
+      end
+      details_hash
+  end
+end

data/lib/indeed_scraper/version.rb

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

data/lib/indeed_scraper.rb

@@ -0,0 +1,13 @@
+#environment file
+#require Gems
+require 'pry'
+require 'nokogiri'
+require 'open-uri'
+require 'colorize'
+
+require_relative "indeed_scraper/version"
+require_relative "indeed_scraper/command_line_interface"
+require_relative "indeed_scraper/job"
+require_relative "indeed_scraper/scraper"
+
+#when referencing, don't need .rb

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: indeed_scraper
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- "'Sheena Bonilla'"
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-12-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !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: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.8.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.8.5
+description: 'Data is extracted from an external source (i.e. www.indeed.com) and
+  displayed as the following attributes: title, location, hours/salary, job url, and
+  a short description.'
+email:
+- "'sheena.myb@gmail.com'"
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/notes
+- bin/run
+- bin/setup
+- indeed_scraper.gemspec
+- lib/indeed_scraper.rb
+- lib/indeed_scraper/command_line_interface.rb
+- lib/indeed_scraper/job.rb
+- lib/indeed_scraper/scraper.rb
+- lib/indeed_scraper/version.rb
+homepage: https://github.com/essbee808/indeed_scraper
+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.8
+signing_key: 
+specification_version: 4
+summary: Indeed Scraper was created to provide assistance in finding employment.
+test_files: []