fedtechjobber 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 764895accee6e01c5f6b7b75767b87ae1e7ae58f
+  data.tar.gz: e5cb0eb39f5a691008e8f894dfadfcba9a2b9016
+SHA512:
+  metadata.gz: 9a5d5309d3ad4a4e4a10699cf40591678b0f915dab58f03595d584f207cefdf19ae2482c4bdc198039c8e7eb8c3b9842d3d78ba792bc0715471ea4c8017e4c91
+  data.tar.gz: 0bb68b86f233c9395f546cc0819795b9a81e5cce48dfc74cd223c55fff7062a205f22f9445f8e4d3ac2754ca934acad9c9c60d4a581cc01518f82656d8e22725

data/Gemfile

@@ -0,0 +1,4 @@
+source 'http://rubygems.org'
+
+gem 'rest-client'
+gem 'ruby-gmail'

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2013 Craig Schneider - Excella Consulting, Inc.
+
+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 @@
+## Overview
+
+fedtechjobber is a simple command line Ruby program that queries the USAJobs API for open tech federal job postings and generates/emails an HTML report displaying available job data along with any available agency GitHub profiles (via USA.gov's Social Media API - http://registry.usa.gov/accounts?service_id=github). The following (optional) search criteria from USAJobs can be used (https://data.usajobs.gov/Rest):
+* Job title
+* Min salary
+* State
+* Country 
+* Min grade
+* Keywords
+
+If you want the results emailed:
+* Gmail user id
+* Gmail password
+* To address
+
+Credentials are sent via TLS to Google.
+
+Tested on Ruby 2.0.
+
+## Install and Execution
+
+Install as a Ruby gem.
+
+    $ gem install fedtechjobber
+
+Execution format:
+
+    $ fedtechjobber -t<title, use single quotes if multiple words> -m<min salary> -s<state> -c<country> -g<min grade> -k<keywords, one or more separated with comma for AND search> -o<keywords, one or more separated with comma for OR search> -u<gmail user id> -p<gmail password> -e<email to address>
+
+Example:
+
+    $ fedtechjobber -t'IT Specialist' -m60000 -c'United States' -opython,ruby,groovy,scala,java -ubob -pbobpasswd -ebob@bob.com
+
+Generates a fedtechjobber.html report in the working directory.
+
+## Work from source 
+    $ gem install bundler
+    $ bundle install
+
+## Unit test execution
+    $ rake test

data/Rakefile

@@ -0,0 +1,9 @@
+require 'ci/reporter/rake/minitest'
+require 'rake'
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'lib'
+  t.test_files = FileList['lib/*.rb']
+  t.verbose = true
+end

data/bin/fedtechjobber

@@ -0,0 +1,44 @@
+#!/usr/bin/env ruby
+# encoding: utf-8
+
+$:.unshift(File.expand_path('../lib', File.dirname(__FILE__)))
+require 'fedtechjobber'
+require 'optparse'
+require 'ostruct'
+
+# parse command line args
+@args = OpenStruct.new
+OptionParser.new do |opts|
+  opts.on('-title') do |t|
+    @args.title = t
+  end
+  opts.on('-min_salary') do |m|
+    @args.min_salary = m
+  end
+  opts.on('-state') do |s|
+    @args.state = s
+  end
+  opts.on('-country') do |c|
+    @args.country = c
+  end
+  opts.on('-grade') do |g|
+    @args.min_grade = g
+  end
+  opts.on('-keyword,keyword,keyword,keyword,keyword', Array) do |k|
+    @args.keywords = k
+  end
+  opts.on('-okeyword,keyword,keyword,keyword,keyword,keyword,keyword', Array) do |o|
+    @args.keywords_or = o
+  end
+  opts.on('-ugmail_usr') do |u|
+    @args.gmail_usr = u
+  end
+  opts.on('-pgmail_pwd') do |p|
+    @args.gmail_pwd = p
+  end
+  opts.on('-email_to_addr') do |e|
+    @args.email_to_addr = e
+  end
+end.parse!
+
+FedTechJobber.new(@args).save_and_email

data/lib/client/api.rb

@@ -0,0 +1,9 @@
+require 'rest_client'
+
+module API
+
+  def get_data(uri, params)
+    response = RestClient.get(uri, {accept: :json,params: params})
+  end
+
+end

data/lib/client/email.rb

@@ -0,0 +1,18 @@
+require 'gmail'
+
+module Email
+
+  def send_email(user, pwd, to)
+    Gmail.new(user, pwd) do |gmail|
+      gmail.deliver do
+        to to
+        subject "fedtechjobber - new jobs"
+        html_part do
+          body '<p>New job info has been sent, see attached report</p>'
+        end
+        add_file 'fedtechjobber.html'
+      end
+    end
+  end
+
+end

data/lib/data/job_data.rb

@@ -0,0 +1,6 @@
+class JobData
+
+  attr_accessor :id, :title, :agency_name, :agency_sub, :agency_display, :salary, :series_grade, :eligibility, :position, :locations, :url, :dates, :summary, :github_url
+  
+end
+

data/lib/data/request.rb

@@ -0,0 +1,97 @@
+class Request
+
+  attr_reader :params_arr
+
+  def initialize(args)
+    @jobs = []
+    @title = args.title
+    @min_salary = args.min_salary
+    @state = args.state
+    @country = args.country
+    @min_grade = args.min_grade
+    @keywords = args.keywords
+    @keywords_or = args.keywords_or
+    @gmail_usr = args.gmail_usr
+    @gmail_pwd = args.gmail_pwd
+    @email_to_addr = args.email_to_addr
+    @params_arr = Array.new
+    build_params
+
+    @usajobs_uri = 'https://data.usajobs.gov/api/jobs'
+    @usagov_uri = 'http://registry.usa.gov/accounts.json'
+    @usagov_params = {'service_id' => 'github'}
+  end
+
+  def build_params
+    params = {}
+    unless @title.nil?
+      params.merge!('Title' => @title)
+    end
+    unless @min_salary.nil?
+      params.merge!('MinSalary' => @min_salary)
+    end
+    unless @state.nil?
+      params.merge!('CountrySubDivision' => @state)
+    end
+    unless @country.nil?
+      params.merge!('Country' => @country)
+    end
+    unless @min_grade.nil?
+      params.merge!('GradeLow' => @min_grade)
+    end
+
+    build_keywords_params(params)
+  end
+
+  def build_keywords_params(params)
+    # only one of keywords or keywords_or is allowed as a param
+    if @keywords.nil? && @keywords_or.nil?
+      @params_arr << params
+    elsif !@keywords.nil?
+      keyword = ''
+      @keywords.each_with_index do |x,i|
+        i == 0 ? keyword = x : keyword << " #{x}"
+      end
+      params.merge!('Keyword' => keyword)
+      @params_arr << params
+    elsif !@keywords_or.nil?
+      @keywords_or.each do |x|
+        new_params = params.clone
+        new_params['Keyword'] = x
+        @params_arr << new_params
+      end
+    end
+  end
+
+  def get_jobs
+    usagov_response = get_data(@usagov_uri, @usagov_params)
+    jobs = []
+
+    # at the time, keyword OR searches are not supported by usajobs. so need to make multiple calls for each OR keyword.
+    # if keyword not provided or only one keyword, there will only be one entry in this array.
+    @params_arr.each do |x|
+      jobs = Response.new(get_data(@usajobs_uri, x), usagov_response).jobs
+      if @jobs.length == 0
+        @jobs << jobs
+      else
+        jobs.each do |x|
+          matches = @jobs.select {|job_data| job_data.id == x.id } 
+          if matches.length == 0
+            @jobs << x
+          end
+        end
+      end
+      @jobs.flatten!
+    end
+    
+    @jobs
+  end
+
+  def email
+    unless @gmail_usr.nil? || @gmail_pwd.nil? || @email_to_addr.nil?
+      send_email(@gmail_usr, @gmail_pwd, @email_to_addr)
+    end
+  end
+
+end
+

data/lib/data/response.rb

@@ -0,0 +1,81 @@
+require 'json'
+
+class Response
+
+  attr_reader :jobs
+
+  def initialize(usajobs_response, usagov_response)
+    @jobs = []  # array of JobData objects
+    parse_usajobs(usajobs_response)
+    @jobs.uniq!
+    parse_usagov(usagov_response)
+  end
+
+  def parse_usajobs(response)
+    response_hash = JSON.parse(response)
+
+    response_hash['JobData'].each do |x|
+      job_data = JobData.new
+      job_data.id = x['AnnouncementNumber']
+      job_data.title = x['JobTitle']
+      job_data.agency_name = x['OrganizationName']
+      job_data.agency_sub = x['AgencySubElement']
+      job_data.agency_display = x['OrganizationName']+' - '+x['AgencySubElement']
+      job_data.salary = x['SalaryMin']+' - '+x['SalaryMax']+' '+x['SalaryBasis']
+      job_data.series_grade = x['PayPlan']+'-'+x['Series']+'-'+x['Grade']
+      job_data.eligibility = x['WhoMayApplyText']
+      job_data.position = x['WorkSchedule']+' - '+x['WorkType']
+      job_data.locations = x['Locations']
+      job_data.url = x['ApplyOnlineURL']
+      job_data.dates = x['StartDate']+' - '+x['EndDate']
+      job_data.summary = x['JobSummary']
+      
+      @jobs << job_data
+    end
+
+  end
+
+  def parse_usagov(response)
+    response_hash = JSON.parse(response)
+
+    @jobs.each do |job|  # for each job in the result set
+      
+      response_hash['accounts'].each do |acct|  # for each github account, see if there's a match
+        
+        acct['agencies'].each do |agency|
+        
+          match_agency(job, acct, agency)
+          
+        end
+      end
+    end
+  end
+
+  def match_agency(job, acct, agency)
+    agency_name = job.agency_name
+    agency_sub = job.agency_sub
+    github_agency_id = agency['agency_id']
+    github_agency_name = agency['agency_name']
+    github_org_name = acct['organization']
+    github_acct = acct['account']
+
+    if 
+      github_agency_name.include?(agency_name) || 
+      github_agency_name.include?(agency_sub) || 
+      github_org_name.include?(agency_name) || 
+      github_org_name.include?(agency_sub) ||
+      agency_name.include?(github_agency_name) || 
+      agency_name.include?(github_org_name) || 
+      agency_sub.include?(github_agency_name) || 
+      agency_sub.include?(github_org_name) ||
+      agency_name.include?(github_agency_id) ||
+      agency_sub.include?(github_agency_id) ||
+      agency_name.include?(github_acct) ||
+      agency_sub.include?(github_acct)
+
+        job.github_url = acct['service_url']
+    end
+  end
+
+end
+

data/lib/display/display.rb

@@ -0,0 +1,134 @@
+module Display
+
+  # get html output to render
+  def get_display()
+  %{
+    <!doctype html>
+    <html>
+	  <head>
+    <title>FedTechJobber Jobs Report</title>
+
+		<meta name="viewport" content="width=device-width">
+
+    <style>
+      body {
+        font-family: Tahoma, Verdana, Arial, sans-serif;
+        color: #333;
+        background: #ccc;
+      }
+      article {
+        background: #eee;
+        padding: 1em;
+      }
+      @media screen and (min-width: 1020px) {
+        article {
+          width: 1000px;
+          border: 0.2em solid #aaa;
+          margin: auto;
+        }
+      }
+      @media screen and (max-width: 1019px) {
+        body {
+          margin: 0;
+          padding: 0;
+        }
+      }
+      article section {
+        margin-bottom: 2em;
+      }
+      h1 {
+        font-weight: normal;
+        border-bottom: 0.1em solid #aaa;
+        padding-bottom: 0.3em;
+        position: relative;
+      }
+      h1 aside {
+        font-size: 0.7em;
+        float: right;
+      }
+      h2 {
+        font-weight: normal;
+        font-size: 1.2em;
+        border-bottom: 0.1em solid #aaa;
+        padding-bottom: 0.2em;
+      }
+      text {
+        font-weight: normal;
+        font-size: .8em;
+        padding-bottom: 0.2em;
+      }
+      div.column {
+        display: inline-block;
+        margin-right: 3em;
+        vertical-align: top;
+      }
+      .field {
+        margin-bottom: 0.2em;
+      }
+      .field .label {
+        font-weight: bold;
+        width: 10em;
+        text-align: right;
+        display: inline-block;  
+      }
+      .field .label:after {
+        content: ":";
+      }
+      .field .val {
+        padding-left: 1em;
+      }
+      div.chart {
+        text-align: center;
+      }
+      div.left-chart {
+        text-align: left;
+      }
+    </style>
+
+	  </head>
+	
+	  <body>	
+	    <article>	
+		  <header>
+		    <h1>
+			  <b>FedTechJobber Jobs Report:</b>
+			  <aside>
+			    <%= @date.strftime('%A, %d %B %Y %T') %>
+			  </aside>
+			</h1>
+		  </header>
+		  <section id="jobs">		
+        <text><b>Search params: </b><%= @request.params_arr %></text><br><br>
+        <% @jobs.each do |job| %>
+          <h2><b><%= job.title %></b></h2>
+          <table width="100%">
+          <tr><td width="15%"><text><b>Agency:</b></text></td><td><text><%= job.agency_display %></text></td></tr>
+          <tr><td width="15%"><text><b>Salary:</b></text></td><td><text><b><%= job.salary %></b></text></td></tr>
+          <tr><td width="15%"><text><b>Series Grade:</b></text></td><td><text><%= job.series_grade %></text></td></tr>
+          <tr><td width="15%"><text><b>Eligibility:</b></text></td><td><text><%= job.eligibility %></text></td></tr>
+          <tr><td width="15%"><text><b>Position:</b></text></td><td><text><%= job.position %></text></td></tr>
+          <tr><td width="15%"><text><b>Location(s):</b></text></td><td><text><%= job.locations %></text></td></tr>
+          <tr><td width="15%"><text><b>Full details:</b></text></td><td><text><a href='<%= job.url %>'>click here</a></text></td></tr>
+          <tr><td width="15%"><text><b>Posting dates:</b></text></td><td><text><%= job.dates %></text></td></tr>
+          <tr><td width="15%"><text><b>Summary:</b></text></td><td><text><%= job.summary %></text></td></tr>
+          <tr><td width="15%"><text><b>Public GitHub profile:</b></text></td>
+            <td>
+              <text>
+              <% if job.github_url.nil? %>
+                none
+              <% else %>
+                <a href='<%= job.github_url %>'><%= job.github_url %></a>
+              <% end %>
+              </text>
+            </td>
+          </tr>
+          </table>
+          <br><br>
+        <% end %>
+		  </section>
+		  </article>
+	  </body>
+    </html>
+  }
+  end
+end

data/lib/fedtechjobber.rb

@@ -0,0 +1,38 @@
+require 'erb'
+require_relative 'client/api'
+require_relative 'client/email'
+require_relative 'data/request'
+require_relative 'data/response'
+require_relative 'data/job_data'
+require_relative 'display/display'
+
+include API
+include Email
+include Display
+
+class FedTechJobber
+  include ERB::Util
+  attr_accessor :template, :date, :request, :jobs
+
+  def initialize(args)
+    @request = Request.new(args)
+    @template = get_display
+    @date = Time.now
+    @jobs = @request.get_jobs
+    @file = 'fedtechjobber.html'
+  end
+
+  def render
+    ERB.new(@template).result(binding)
+  end
+
+  def save_and_email
+    File.open(@file, 'w+') do |f|
+      f.write(render)
+    end
+    puts 'Done saving '+@file
+    @request.email
+  end
+
+end
+

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification
+name: fedtechjobber
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Craig Schneider
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-10 00:00:00.000000000 Z
+dependencies: []
+description: "    fedtechjobber is a simple command line utility that queries the
+  USAJobs API for open tech federal job \n    postings and generates/emails an HTML
+  report displaying available job data along with any available agency \n    GitHub
+  profiles (via USA.gov's Social Media API). \n"
+email:
+- craig.schneider@excella.com
+executables:
+- fedtechjobber
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/fedtechjobber
+- lib/fedtechjobber.rb
+- lib/client/api.rb
+- lib/client/email.rb
+- lib/data/job_data.rb
+- lib/data/request.rb
+- lib/data/response.rb
+- lib/display/display.rb
+homepage: https://github.com/excellaco
+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.0.3
+signing_key: 
+specification_version: 4
+summary: A command line tool to search the USAJobs API for jobs and USA.gov for matching
+  GitHub profiles.
+test_files: []