wfhcli 0.3.0 → 0.3.1

data/README.md

@@ -0,0 +1,53 @@
+# wfhcli
+
+wfhcli is a CLI tool to query [WFH.io](https://www.wfh.io)'s JSON API.
+
+## Usage Examples
+
+List latest jobs:
+
+```
+wfhcli jobs
+```
+
+The above results are returned paged, with 30 jobs per page.  To view additional pages:
+
+```
+wfhcli jobs --page 2
+```
+
+List categories:
+
+```
+wfhcli categories
+```
+
+List jobs by category:
+
+```
+wfhcli jobs --category 3
+```
+
+Show job details:
+
+```
+wfhcli job 994
+```
+
+List companies:
+
+```
+wfhcli companies
+```
+
+Similar to `wfhcli jobs`, you can also page through companies:
+
+```
+wfhcli companies --page 2
+```
+
+Show company details:
+
+```
+wfhcli company 536
+```

data/bin/wfhcli

@@ -9,23 +9,23 @@ class WfhCli < Thor
     super
   end
 
-  desc "categories", "List categories"
+  desc 'categories', 'List categories'
   def categories
     @wfh.list_categories
   end
 
-  desc "companies", "List companies"
+  desc 'companies', 'List companies'
   option :page
   def companies
     @wfh.list_companies(options[:page])
   end
 
-  desc "company ID", "Show company with ID"
+  desc 'company ID', 'Show company with ID'
   def company(id)
     @wfh.show_company(id)
   end
 
-  desc "jobs", "List jobs"
+  desc 'jobs', 'List jobs'
   option :category
   option :page
   def jobs
@@ -36,7 +36,7 @@ class WfhCli < Thor
     end
   end
 
-  desc "job ID", "Show job with ID"
+  desc 'job ID', 'Show job with ID'
   def job(id)
     @wfh.show_job(id)
   end

data/lib/wfhcli.rb

@@ -4,11 +4,12 @@ require 'rest-client'
 require 'thor'
 
 class WfhLib
-  TITLE_COLOUR = :magenta
-  URL = 'https://www.wfh.io/api'
+  attr_accessor :title_colour, :url
 
   def initialize
     @shell = Thor::Shell::Color.new
+    @title_colour = :magenta
+    @url = 'https://www.wfh.io/api'
   end
 
   # TODO: Make private once we are able to properly test methods which use
@@ -25,8 +26,8 @@ class WfhLib
   def generate_table(content)
     cell_widths = Array.new(content[0].size, 0)
 
-    # We do cell.to_s.size as cell could be an integer and 8.size == 8, which is
-    # not what we want.
+    # We do cell.to_s.size as cell could be an integer and 8.size == 8,
+    # which is not what we want.
     content.each do |row|
       row.each_with_index do |cell, index|
         if cell.to_s.size > cell_widths[index]
@@ -35,24 +36,24 @@ class WfhLib
       end
     end
 
-    lines = ""
+    lines = ''
 
     content.each_with_index do |row, row_index|
       if row_index == 1
-        lines << "|"
+        lines << '|'
         cell_widths.each do |c|
           # We use c + 2 to account for the spaces inside each cell
-          lines << "-" * (c + 2)
-          lines << "|"
+          lines << '-' * (c + 2)
+          lines << '|'
         end
         lines << "\n"
       end
-      lines << "|"
+      lines << '|'
       row.each_with_index do |cell, cell_index|
         formatted = cell.to_s.ljust(cell_widths[cell_index])
 
         if row_index == 0
-          lines << " #{@shell.set_color(formatted, TITLE_COLOUR)} |"
+          lines << " #{@shell.set_color(formatted, @title_colour)} |"
         else
           lines << " #{formatted} |"
         end
@@ -67,7 +68,10 @@ class WfhLib
   #       use this method.
   def get_json(uri)
     begin
-      r = RestClient.get "#{URL}#{uri}", {:accept => :json}
+      r = RestClient.get "#{@url}#{uri}", { accept: :json }
+    rescue RestClient::ResourceNotFound
+      puts "The resource #{uri} was not found"
+      exit!
     rescue => e
       puts e
       exit!
@@ -81,7 +85,7 @@ class WfhLib
 
     if categories.size > 0
       content = []
-      content[0] = ['ID', 'Name']
+      content[0] = %w{ID Name}
 
       categories.each do |category|
         content << [category['id'], category['name']]
@@ -101,7 +105,7 @@ class WfhLib
 
     if companies.size > 0
       content = []
-      content[0] = ['ID', 'Name']
+      content[0] = %w{ID Name}
 
       companies.each do |company|
         content << [company['id'], company['name']]
@@ -114,7 +118,7 @@ class WfhLib
   end
 
   def list_jobs(page=nil, category_id=nil)
-    if category_id == nil
+    if category_id.nil?
       uri = '/jobs'
       uri = uri + "?page=#{page}" if page
     else
@@ -126,7 +130,7 @@ class WfhLib
 
     if jobs.size > 0
       content = []
-      content[0] = ['ID', 'Posted', 'Category', 'Company', 'Title']
+      content[0] = %w{ID Posted Category Company Title}
 
       jobs.each do |job|
         content << [job['id'],
@@ -145,7 +149,7 @@ class WfhLib
   # TODO: Make private once we are able to properly test methods which use
   #       use this method.
   def generate_header_and_body(title, body)
-    "#{@shell.set_color(title, TITLE_COLOUR)}\n#{body}"
+    "#{@shell.set_color(title, @title_colour)}\n#{body}"
   end
 
   def show_company(company_id)
@@ -156,29 +160,34 @@ class WfhLib
     unless company['country'].nil?
       puts generate_header_and_body('Headquarters', company['country']['name'])
     end
-    unless company['twitter'].nil? or company['twitter'].empty?
+    unless company['twitter'].nil? || company['twitter'].empty?
       puts generate_header_and_body('Twitter', company['twitter'])
     end
-    unless company['showcase_url'].nil? or company['showcase_url'].empty?
+    unless company['showcase_url'].nil? || company['showcase_url'].empty?
       puts generate_header_and_body('Showcase URL', company['showcase_url'])
     end
   end
 
   def show_job(job_id)
     job = get_json("/jobs/#{job_id}")
-    if job['country'].nil? or job['country'].empty?
+    if job['country'].nil? || job['country'].empty?
       country = 'Anywhere'
     else
       country = job['country']['name']
     end
 
-    puts generate_header_and_body('Title', "#{job['title']} @ #{job['company']['name']}")
-    puts generate_header_and_body('Category', "#{job['category']['name']} (#{job['category']['id']})")
-    puts generate_header_and_body('Posted', format_date(job['created_at'], inc_time=true))
+    title = "#{job['title']} @ #{job['company']['name']} " \
+            "(#{job['company']['id']})"
+    category = "#{job['category']['name']} (#{job['category']['id']})"
+    posted = format_date(job['created_at'], true)
+
+    puts generate_header_and_body('Title', title)
+    puts generate_header_and_body('Category', category)
+    puts generate_header_and_body('Posted', posted)
     puts generate_header_and_body('Description', job['description'])
     puts generate_header_and_body('Application Info', job['application_info'])
     puts generate_header_and_body('Country', country)
-    unless job['location'].nil? or job['location'].empty?
+    unless job['location'].nil? || job['location'].empty?
       puts generate_header_and_body('Location', job['location'])
     end
   end
@@ -187,7 +196,7 @@ class WfhLib
   #       use this method.
   def truncate(str, len)
     if str.size > len
-      str[0..(len-4)] + "..."
+      str[0..(len - 4)] + '...'
     else
       str
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wfhcli
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-03 00:00:00.000000000 Z
+date: 2015-01-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -50,6 +50,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- README.md
 - lib/wfhcli.rb
 - bin/wfhcli
 homepage: https://github.com/wfhio/wfhcli