deedveloper 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7e218414478357add1318cf7592b4c3b1b51c4ca1a7f1f7dd5e3f5ed2b15a8b9
+  data.tar.gz: 387438e708308e87279f8e88307e7c8b73366bdc5c2219e0440c39f042655bd0
+SHA512:
+  metadata.gz: 8474b37f939097256b912411f5c99d9bdbaea75de9c1db26337261deb16b7f8242915aebcabec1cb54b17897b477c8d7f3f3f5e56a574a11945c849f33ba3e8b
+  data.tar.gz: 5c5d1c324e81ff58f921cecc47afe4214f7a9708da62a2f3152f67f336c9ae6058c72ec4d42787319d68d9008bee05af7bb6b42d7b5908c92b25b194a428d8cc

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,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.1
+before_install: gem install bundler -v 2.0.1

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 andrewhwaller@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,8 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in deedveloper.gemspec
+gemspec
+
+gem 'rake'
+gem 'nokogiri'
+gem 'open_uri_redirections'

data/Gemfile.lock

@@ -0,0 +1,52 @@
+PATH
+  remote: .
+  specs:
+    deedveloper (0.1.0)
+      nokogiri
+      open_uri_redirections
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.2)
+    diff-lcs (1.3)
+    method_source (0.9.2)
+    mini_portile2 (2.4.0)
+    nokogiri (1.10.2)
+      mini_portile2 (~> 2.4.0)
+    nokogiri (1.10.2-x64-mingw32)
+      mini_portile2 (~> 2.4.0)
+    open_uri_redirections (0.2.1)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rake (12.3.2)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+
+PLATFORMS
+  ruby
+  x64-mingw32
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  deedveloper!
+  nokogiri
+  open_uri_redirections
+  pry
+  rake
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.0.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Andrew Waller
+
+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

@@ -0,0 +1,20 @@
+a command line interface that scrapes job listings for Ruby developers from Indeed and allows the user to filter the data and pull up the website link for individual jobs to learn more.
+
+user types develedeed
+
+display list of jobs
+
+    1. job 1, company, location
+    2. job 2 company, location
+    etc.
+
+Which job would you like to learn more about?
+
+jobs    
+    jobs have... 
+    title
+    company
+    salary
+    location
+    description
+    website

data/README.md

@@ -0,0 +1,39 @@
+# Deedveloper
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'deedveloper'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install deedveloper
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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/andrewhwaller/deedveloper. 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 Deedveloper project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/deedveloper/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "deedveloper"
+
+require "irb"
+IRB.start(__FILE__)

data/bin/deedveloper

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

data/bin/setup

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install

data/config/environment.rb

@@ -0,0 +1,7 @@
+require 'bundler'
+
+Bundler.require
+require 'open-uri'
+require 'pry'
+require 'rake'
+require 'open_uri_redirections'

data/deedveloper.gemspec

@@ -0,0 +1,39 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "deedveloper/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "deedveloper"
+  spec.version       = Deedveloper::VERSION
+  spec.authors       = "Andrew Waller"
+  spec.email         = "andrew@andrewhwaller.com"
+
+  spec.summary       = "Deedveloper is an Indeed.com search engine in Ruby."
+  spec.homepage      = "https://github.com/andrewhwaller/deedveloper"
+  spec.license       = "MIT"
+
+  if spec.respond_to?(:metadata)
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = "https://github.com/andrewhwaller/deedveloper"
+    spec.metadata["changelog_uri"] = "https://github.com/andrewhwaller/deedveloper"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  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", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry"
+
+  spec.add_dependency "nokogiri"
+  spec.add_dependency "open_uri_redirections"
+end

data/lib/deedveloper/controller.rb

@@ -0,0 +1,68 @@
+require_relative "./scraper"
+require_relative "./job"
+
+class Controller
+    
+    def call
+        #welcomes the user and initiates search
+        puts "","░▒▓ Welcome to DEEDVELOPER, an Indeed.com search engine in Ruby! ▓▒░"
+        puts "You need a job, son! Grab some coffee and let's get this bread...",""
+        search
+    end
+
+    def search
+        #calls first level scraper method, pulls the resulting data, and displays it for user interaction
+        scraper = Scraper.new
+        scraper.scrape_jobs
+        list_jobs
+        display_detail
+    end
+
+    def list_jobs
+        #formats first level job information and displays it for the user
+        puts "Check out these jobs:"
+        Job.all.each.with_index(1) do |job, i|
+            puts "#{i}. #{job.title} ◦ #{job.company}",
+            ""
+        end
+    end
+
+    def display_detail
+        #accepts user input, displays level two job information for selected job, and provides other options for user interaction: exit, list, and search
+        input = nil
+        while input != "exit"
+            puts 'Enter the number of a job to see more info! Type "exit" to end search, "list" to see job listings again, or "search" to begin a new search.'
+            input = gets.strip.downcase 
+            if input.to_i > Job.all.count
+                puts "There aren't that many jobs!"
+            elsif input.to_i >= 1
+                get_detail(input)
+            elsif input == "list"
+                list_jobs
+            elsif input == "exit"
+                goodbye
+            elsif input == "search"
+                puts "OK, let's search again!"
+                # clears Job.all for repopulation by search method
+                Job.all.clear
+                search
+            end
+        end
+    end
+
+    def get_detail(input)
+        #initiates further scraping and formats/displays additional job details for a user-selected job
+        Scraper.scrape_detail(input)
+        puts "","Job title: #{Job.all[input.to_i-1].title}",
+        "Company: #{Job.all[input.to_i-1].company}",
+        "Location: #{Job.all[input.to_i-1].location}",
+        "Post date: #{Job.all[input.to_i-1].when_posted}",
+        "Salary: #{Job.all[input.to_i-1].salary}",
+        "Indeed posting: #{Job.all[input.to_i-1].job_url}",""
+    end
+
+    def goodbye
+        puts "Enjoy your coffee! See you later."
+        return exit
+    end
+end

data/lib/deedveloper/job.rb

@@ -0,0 +1,20 @@
+class Job
+    attr_accessor :title, :company, :location, :when_posted, :job_url, :salary, :description
+
+    @@all = []
+
+    def initialize
+        @title = title
+        @company = company
+        @location = location
+        @when_posted = when_posted
+        @job_url = job_url
+        @salary = salary
+        @description = description
+        @@all << self
+    end
+
+    def self.all
+        @@all
+    end
+end

data/lib/deedveloper/scraper.rb

@@ -0,0 +1,64 @@
+require 'nokogiri'
+require 'open-uri'
+
+class Scraper
+    attr_accessor :doc, :detail_doc, :user_job, :user_location, :user_salary, :user_radius
+
+    def initialize
+        # performs first round of gets/scraping operations upon intialization
+        get_user_job
+        get_user_location
+        get_user_radius
+        get_user_salary
+        @doc = Nokogiri::HTML(open("http://www.indeed.com/jobs?as_and=#{user_job}&jt=all&st=&sr=&as_src=&salary=#{user_salary}&radius=#{user_radius}&l=#{user_location}&fromage=any&limit=50&sort=&psf=advsrch", :allow_redirections => :all))
+    end
+
+    def get_user_job
+        puts "What sort of job would you like to search for?"
+        @user_job = gets.strip.downcase
+    end
+
+    def get_user_location
+        puts "What location would you like to search for?"
+        @user_location = gets.strip.downcase
+    end
+
+    def get_user_salary
+        #TODO: build logic that recognizes invalid input and reprompts user; invalid or irregular input can affect search results
+        puts "What is the yearly salary or salary range that you're looking for? Examples: $65,000, 65-85k, 65k, or 65000.","(Optional: leave blank to continue.)"
+        @user_salary = gets.strip
+    end
+
+    def get_user_radius
+        puts "What is your desired search radius in miles?"
+        @user_radius = gets.strip
+    end
+
+    def scrape_jobs
+        doc.css('div.jobsearch-SerpJobCard').each do |job_card|
+            j = Job.new
+            j.title = job_card.search("a.jobtitle").text.strip
+            j.company = job_card.search("span.company").text.strip
+            j.location = job_card.search("span.location").text.strip
+            j.when_posted = job_card.search("span.date").text.strip
+            if j.location.empty?
+                j.location = job_card.search("div.location").text.strip 
+            end
+            if j.when_posted.empty?
+               j.when_posted = job_card.search("span.sponsoredGray").text.strip
+            end
+            j.job_url = "https://indeed.com" + job_card.search("div.title a").first["href"]
+        end
+    end
+
+    def self.scrape_detail(input)
+        target_job = Job.all[input.to_i-1]
+        @detail_doc = Nokogiri::HTML(open(target_job.job_url, :allow_redirections => :all))
+        # TODO: format target_job.description so that it's more readable.
+        # target_job.description = @detail_doc.search("div.jobsearch-JobComponent-description").text
+        target_job.salary = @detail_doc.search("div.jobsearch-JobMetadataHeader").text.strip
+        if target_job.salary.empty?
+            target_job.salary = "No salary info available"
+        end
+    end
+end

data/lib/deedveloper/version.rb

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

data/lib/deedveloper.rb

@@ -0,0 +1,6 @@
+require 'open-uri'
+require 'nokogiri'
+
+require_relative "./deedveloper/version"
+require_relative './deedveloper/controller'
+

metadata

@@ -0,0 +1,149 @@
+--- !ruby/object:Gem::Specification
+name: deedveloper
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Andrew Waller
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-04-11 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'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: open_uri_redirections
+  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: 
+email: andrew@andrewhwaller.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- NOTES
+- README.md
+- Rakefile
+- bin/console
+- bin/deedveloper
+- bin/setup
+- config/environment.rb
+- deedveloper.gemspec
+- lib/deedveloper.rb
+- lib/deedveloper/controller.rb
+- lib/deedveloper/job.rb
+- lib/deedveloper/scraper.rb
+- lib/deedveloper/version.rb
+homepage: https://github.com/andrewhwaller/deedveloper
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/andrewhwaller/deedveloper
+  source_code_uri: https://github.com/andrewhwaller/deedveloper
+  changelog_uri: https://github.com/andrewhwaller/deedveloper
+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.3
+signing_key: 
+specification_version: 4
+summary: Deedveloper is an Indeed.com search engine in Ruby.
+test_files: []