wfhcli 0.3.1 → 0.4.0

data/bin/wfhcli

@@ -11,34 +11,34 @@ class WfhCli < Thor
 
   desc 'categories', 'List categories'
   def categories
-    @wfh.list_categories
+    puts @wfh.display_categories
   end
 
   desc 'companies', 'List companies'
-  option :page
+  option :page, default: 1
   def companies
-    @wfh.list_companies(options[:page])
+    puts @wfh.display_companies(options[:page])
   end
 
   desc 'company ID', 'Show company with ID'
   def company(id)
-    @wfh.show_company(id)
+    puts @wfh.display_company(id)
   end
 
   desc 'jobs', 'List jobs'
   option :category
-  option :page
+  option :page, default: 1
   def jobs
     if options[:category]
-      @wfh.list_jobs(options[:page], options[:category])
+      puts @wfh.display_jobs(options[:page], options[:category])
     else
-      @wfh.list_jobs(options[:page])
+      puts @wfh.display_jobs(options[:page])
     end
   end
 
   desc 'job ID', 'Show job with ID'
   def job(id)
-    @wfh.show_job(id)
+    puts @wfh.display_job(id)
   end
 end
 

data/lib/wfhcli.rb

@@ -12,76 +12,22 @@ class WfhLib
     @url = 'https://www.wfh.io/api'
   end
 
-  # TODO: Make private once we are able to properly test methods which use
-  #       use this method.
-  def format_date(str, inc_time=false)
-    format = '%Y-%m-%d'
-    format = format + ' %H:%M' if inc_time == true
-    d = DateTime.parse(str)
-    d.strftime(format)
+  def categories
+    get_json('/categories')
   end
 
-  # TODO: Make private once we are able to properly test methods which use
-  #       use this method.
-  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.
-    content.each do |row|
-      row.each_with_index do |cell, index|
-        if cell.to_s.size > cell_widths[index]
-          cell_widths[index] = cell.to_s.size
-        end
-      end
-    end
-
-    lines = ''
-
-    content.each_with_index do |row, row_index|
-      if row_index == 1
-        lines << '|'
-        cell_widths.each do |c|
-          # We use c + 2 to account for the spaces inside each cell
-          lines << '-' * (c + 2)
-          lines << '|'
-        end
-        lines << "\n"
-      end
-      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)} |"
-        else
-          lines << " #{formatted} |"
-        end
-      end
-      lines << "\n"
-    end
-
-    return lines
+  def company(id)
+    get_json("/companies/#{id}")
   end
 
-  # TODO: Make private once we are able to properly test methods which use
-  #       use this method.
-  def get_json(uri)
-    begin
-      r = RestClient.get "#{@url}#{uri}", { accept: :json }
-    rescue RestClient::ResourceNotFound
-      puts "The resource #{uri} was not found"
-      exit!
-    rescue => e
-      puts e
-      exit!
-    else
-      JSON.parse(r)
-    end
+  def companies(page=1)
+    uri = "/companies?page=#{page}"
+
+    get_json(uri)
   end
 
-  def list_categories
-    categories = get_json('/categories')
+  def display_categories
+    categories = self.categories
 
     if categories.size > 0
       content = []
@@ -91,17 +37,35 @@ class WfhLib
         content << [category['id'], category['name']]
       end
 
-      puts generate_table(content)
+      generate_table(content)
     else
-      puts 'No categories found'
+      'No categories found'
     end
   end
 
-  def list_companies(page=nil)
-    uri = '/companies'
-    uri = uri + "?page=#{page}" if page
+  def display_company(company_id)
+    output = ''
+    company = self.company(company_id)
 
-    companies = get_json(uri)
+    output << generate_header_and_body('Name', company['name'])
+    output << generate_header_and_body('URL', company['url'])
+    unless company['country'].nil?
+      output << generate_header_and_body('Headquarters',
+                                         company['country']['name'])
+    end
+    unless company['twitter'].nil? || company['twitter'].empty?
+      output << generate_header_and_body('Twitter', company['twitter'])
+    end
+    unless company['showcase_url'].nil? || company['showcase_url'].empty?
+      output << generate_header_and_body('Showcase URL',
+                                         company['showcase_url'])
+    end
+
+    return output
+  end
+
+  def display_companies(page)
+    companies = self.companies(page)
 
     if companies.size > 0
       content = []
@@ -111,22 +75,43 @@ class WfhLib
         content << [company['id'], company['name']]
       end
 
-      puts generate_table(content)
+      generate_table(content)
     else
-      puts 'No companies found'
+      'No companies found'
     end
   end
 
-  def list_jobs(page=nil, category_id=nil)
-    if category_id.nil?
-      uri = '/jobs'
-      uri = uri + "?page=#{page}" if page
+  def display_job(job_id)
+    output = ''
+    job = self.job(job_id)
+
+    if job['country'].nil? || job['country'].empty?
+      country = 'Anywhere'
     else
-      uri = "/categories/#{category_id}/jobs"
-      uri = uri + "?page=#{page}" if page
+      country = job['country']['name']
+    end
+
+    title = "#{job['title']} @ #{job['company']['name']} " \
+            "(#{job['company']['id']})"
+    category = "#{job['category']['name']} (#{job['category']['id']})"
+    posted = format_date(job['created_at'], true)
+
+    output << generate_header_and_body('Title', title)
+    output << generate_header_and_body('Category', category)
+    output << generate_header_and_body('Posted', posted)
+    output << generate_header_and_body('Description', job['description'])
+    output << generate_header_and_body('Application Info',
+                                       job['application_info'])
+    output << generate_header_and_body('Country', country)
+    unless job['location'].nil? || job['location'].empty?
+      output << generate_header_and_body('Location', job['location'])
     end
 
-    jobs = get_json(uri)
+    return output
+  end
+
+  def display_jobs(page, category_id=nil)
+    jobs = self.jobs(page, category_id)
 
     if jobs.size > 0
       content = []
@@ -140,60 +125,96 @@ class WfhLib
                     truncate(job['title'], 30)]
       end
 
-      puts generate_table(content)
+      generate_table(content)
+    else
+      'No jobs found'
+    end
+  end
+
+  def job(id)
+    get_json("/jobs/#{id}")
+  end
+
+  def jobs(page=1, category_id=nil)
+    if category_id.nil?
+      uri = "/jobs?page=#{page}"
     else
-      puts 'No jobs found'
+      uri = "/categories/#{category_id}/jobs?page=#{page}"
     end
+
+    get_json(uri)
+  end
+
+  private
+
+  def format_date(str, inc_time=false)
+    format = '%Y-%m-%d'
+    format = format + ' %H:%M' if inc_time == true
+    d = DateTime.parse(str)
+    d.strftime(format)
   end
 
-  # 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}\n"
   end
 
-  def show_company(company_id)
-    company = get_json("/companies/#{company_id}")
+  def generate_table(content)
+    cell_widths = Array.new(content[0].size, 0)
 
-    puts generate_header_and_body('Name', company['name'])
-    puts generate_header_and_body('URL', company['url'])
-    unless company['country'].nil?
-      puts generate_header_and_body('Headquarters', company['country']['name'])
-    end
-    unless company['twitter'].nil? || company['twitter'].empty?
-      puts generate_header_and_body('Twitter', company['twitter'])
-    end
-    unless company['showcase_url'].nil? || company['showcase_url'].empty?
-      puts generate_header_and_body('Showcase URL', company['showcase_url'])
+    # 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]
+          cell_widths[index] = cell.to_s.size
+        end
+      end
     end
-  end
 
-  def show_job(job_id)
-    job = get_json("/jobs/#{job_id}")
-    if job['country'].nil? || job['country'].empty?
-      country = 'Anywhere'
-    else
-      country = job['country']['name']
+    lines = ''
+
+    content.each_with_index do |row, row_index|
+      if row_index == 1
+        lines << '|'
+        cell_widths.each do |c|
+          # We use c + 2 to account for the spaces inside each cell
+          lines << '-' * (c + 2)
+          lines << '|'
+        end
+        lines << "\n"
+      end
+      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)} |"
+        else
+          lines << " #{formatted} |"
+        end
+      end
+      lines << "\n"
     end
 
-    title = "#{job['title']} @ #{job['company']['name']} " \
-            "(#{job['company']['id']})"
-    category = "#{job['category']['name']} (#{job['category']['id']})"
-    posted = format_date(job['created_at'], true)
+    return lines
+  end
 
-    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? || job['location'].empty?
-      puts generate_header_and_body('Location', job['location'])
+  def get_json(uri)
+    begin
+      # TODO: add wfhcli version to user_agent string
+      r = RestClient.get("#{@url}#{uri}",
+                         { accept: :json, user_agent: 'wfhcli' })
+    rescue RestClient::ResourceNotFound
+      puts "The resource #{uri} was not found"
+      exit!
+    rescue => e
+      puts e
+      exit!
+    else
+      JSON.parse(r)
     end
   end
 
-  # TODO: Make private once we are able to properly test methods which use
-  #       use this method.
   def truncate(str, len)
     if str.size > len
       str[0..(len - 4)] + '...'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wfhcli
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,41 +9,57 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-04 00:00:00.000000000 Z
+date: 2015-01-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.7.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.7.2
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.19.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
-description: CLI tool to query WFH.io's JSON API
+        version: 0.19.1
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.11.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.11.0
+description: A CLI wrapper around the WFH.io (https://www.wfh.io) remote job board
 email: admin@wfh.io
 executables:
 - wfhcli
@@ -77,5 +93,5 @@ rubyforge_project:
 rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
-summary: WFH.io CLI tool
+summary: A CLI wrapper around the WFH.io (https://www.wfh.io) remote job board
 test_files: []