Project

careerjet-api-client

0.0
No commit activity in last 3 years
No release in over 3 years
careerjet-api-clientcareerjet/careerjet-api-client-rubyHomepageDocumentationSource CodeWiki
Official Ruby interface to Careerjet's public search API
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Popularity
Downloads
16,615
Stars
2
Forks
0
Watchers
0
 Releases
Current version
3.1.2
Total releases
3
First release
2015-05-13
Latest release
2015-05-14
 Development
Primary Language
Ruby
Licenses
MIT
Average date of last 50 commits
2014-07-17
Reverse Dependencies
0

 Dependencies

Development

pry
>= 0
rake
>= 0
rspec
>= 0
webmock
>= 0
yajl-ruby
>= 0

Runtime

hashie
>= 0
multi_json
>= 0
rest-client
>= 0
 Project Readme

Careerjet API Client Ruby

This is the ruby client for Careerjet's public search API.

Installation

Add the following line to your application's Gemfile:

gem 'careerjet-api-client', :require => "careerjet/api_client"

and then execute:

$ bundle

Alternatively install it yourself:

$ gem install careerjet-api-client

Usage

> cj_api_client = Careerjet::APIClient.new(:locale=> :en_GB)
>
> cj_api_client.search(
>     :keywords   => 'ruby',
>     :location   => 'london',
>     :affid      => '213e213hd12344552',
>     :user_ip    => '11.22.33.44',
>     :user_agent => 'Mozilla/5.0 (X11; Linux x86_64; rv:31.0) Gecko/20100101 Firefox/31.0',
>     :url        => 'http://www.example.com/jobsearch?q=ruby&l=london'
> )
>
=> #<Careerjet::Mash hits=5704 jobs=[<..>] pages=286 response_time=0.0434670448303223 type="JOBS">

You will get a Hashie::Mash object as a response, so you will be able to access the the data through convenient methods:

> cj_api_client.search(
>     :keywords   => 'ruby',
>     :location   => 'london',
>     :affid      => '213e213hd12344552',
>     :user_ip    => '11.22.33.44',
>     :user_agent => 'Mozilla/5.0 (X11; Linux x86_64; rv:31.0) Gecko/20100101 Firefox/31.0',
>     :url        => 'http://www.example.com/jobsearch?q=ruby&l=london'
> ).jobs.first
>
=> #<Careerjet::Mash company="Company Name" date="Wed, 17 Apr 2013 00:00:00 GMT" description=" <..>" url="http://...">

Mandatory Search Params

  • affid : Affiliate ID provided by Careerjet. Requires to open a Careerjet partner account (http://www.careerjet.com/partners/).
  • user_ip : IP address of the end-user to whom the search results will be displayed.
  • user_agent : User agent of the end-user's browser.
  • url : URL of page that will display the search results

Search Params

Please note that each parameter is optional.

  • keywords: Keywords to match the title, content or company name of a job offer

  • location: Location of requested jobs

  • sort: Sort type. This can be: relevance (default) — sorted by decreasing relevancy, date — sorted by decreasing date and salary — sorted by decreasing salary.

  • start_num: Position of returned job postings within the entire result space. Should be >= 1 and <= Number of hits.

  • pagesize: Number of jobs returned in one call.

  • page: Page number of returned jobs within the entire result space. Should be >=1. If this value is set, it overrides start_num.

  • contracttype: Selected contract type.p — permanent job, c — contract, t — temporary, i — training, v — voluntary, none — all contract types.

  • contractperiod: Selected contract period. f — full time, p — part time, none — all contract periods.

Locale code

The locale code needs to be supplied in the contructor of the API client. It defines the default location as well as the language in which the search results are returned. Each locale corresponds to a Careerjet site.

The default is 'en_GB'.

Available locale codes are:

    :cs_CZ  => 'http://www.careerjet.cz'                  ,
    :da_DK  => 'http://www.careerjet.dk'                  ,
    :de_AT  => 'http://www.careerjet.at'                  ,
    :de_CH  => 'http://www.careerjet.ch'                  ,
    :de_DE  => 'http://www.careerjet.de'                  ,
    :en_AE  => 'http://www.careerjet.ae'                  ,
    :en_AU  => 'http://www.careerjet.com.au'              ,
    :en_BD  => 'http://www.careerjet.com.bd'              ,
    :en_CA  => 'http://www.careerjet.ca'                  ,
    :en_CN  => 'http://www.careerjet.com.cn'              ,
    :en_HK  => 'http://www.careerjet.hk'                  ,
    :en_IE  => 'http://www.careerjet.ie'                  ,
    :en_IN  => 'http://www.careerjet.co.in'               ,
    :en_KW  => 'http://www.careerjet.com.kw'              ,
    :en_MY  => 'http://www.careerjet.com.my'              ,
    :en_NZ  => 'http://www.careerjet.co.nz'               ,
    :en_OM  => 'http://www.careerjet.com.om'              ,
    :en_PH  => 'http://www.careerjet.ph'                  ,
    :en_PK  => 'http://www.careerjet.com.pk'              ,
    :en_QA  => 'http://www.careerjet.com.qa'              ,
    :en_SG  => 'http://www.careerjet.sg'                  ,
    :en_GB  => 'http://www.careerjet.co.uk'               ,
    :en_US  => 'http://www.careerjet.com'                 ,
    :en_ZA  => 'http://www.careerjet.co.za'               ,
    :en_SA  => 'http://www.careerjet-saudi-arabia.com'    ,
    :en_TW  => 'http://www.careerjet.com.tw'              ,
    :en_VN  => 'http://www.careerjet.vn'                  ,
    :es_AR  => 'http://www.opcionempleo.com.ar'           ,
    :es_BO  => 'http://www.opcionempleo.com.bo'           ,
    :es_CL  => 'http://www.opcionempleo.cl'               ,
    :es_CO  => 'http://www.opcionempleo.com.co'           ,
    :es_CR  => 'http://www.opcionempleo.co.cr'            ,
    :es_DO  => 'http://www.opcionempleo.com.do'           ,
    :es_EC  => 'http://www.opcionempleo.ec'               ,
    :es_ES  => 'http://www.opcionempleo.com'              ,
    :es_GT  => 'http://www.opcionempleo.com.gt'           ,
    :es_MX  => 'http://www.opcionempleo.com.mx'           ,
    :es_PA  => 'http://www.opcionempleo.com.pa'           ,
    :es_PE  => 'http://www.opcionempleo.com.pe'           ,
    :es_PR  => 'http://www.opcionempleo.com.pr'           ,
    :es_PY  => 'http://www.opcionempleo.com.py'           ,
    :es_UY  => 'http://www.opcionempleo.com.uy'           ,
    :es_VE  => 'http://www.opcionempleo.com.ve'           ,
    :fi_FI  => 'http://www.careerjet.fi'                  ,
    :fr_CA  => 'http://www.option-carriere.ca'            ,
    :fr_BE  => 'http://www.optioncarriere.be'             ,
    :fr_CH  => 'http://www.optioncarriere.ch'             ,
    :fr_FR  => 'http://www.optioncarriere.com'            ,
    :fr_LU  => 'http://www.optioncarriere.lu'             ,
    :fr_MA  => 'http://www.optioncarriere.ma'             ,
    :hu_HU  => 'http://www.careerjet.hu'                  ,
    :it_IT  => 'http://www.careerjet.it'                  ,
    :ja_JP  => 'http://www.careerjet.jp'                  ,
    :ko_KR  => 'http://www.careerjet.co.kr'               ,
    :nl_BE  => 'http://www.careerjet.be'                  ,
    :nl_NL  => 'http://www.careerjet.nl'                  ,
    :no_NO  => 'http://www.careerjet.no'                  ,
    :pl_PL  => 'http://www.careerjet.pl'                  ,
    :pt_PT  => 'http://www.careerjet.pt'                  ,
    :pt_BR  => 'http://www.careerjet.com.br'              ,
    :ru_RU  => 'http://www.careerjet.ru'                  ,
    :ru_UA  => 'http://www.careerjet.com.ua'              ,
    :sv_SE  => 'http://www.careerjet.se'                  ,
    :sk_SK  => 'http://www.careerjet.sk'                  ,
    :tr_TR  => 'http://www.careerjet.com.tr'              ,
    :uk_UA  => 'http://www.careerjet.ua'                  ,
    :vi_VN  => 'http://www.careerjet.com.vn'              ,
    :zh_CN  => 'http://www.careerjet.cn'                  ,

Running the API client in Sinatra

In order to circumvent a bug when running the API client within Sinatra, you need to tell tell Sinatra to skip the automatic Rack detection by doing:

set :server, 'webrick'

You can find more information on this by Googling 'sinatra httpclient'.

Thanks

This gem was inspired by the careerjet gem coded by Kostiantyn Kahanskyi and the careerjet-rb gem coded by Sergey Efremov.

Many thanks to both.

License

Copyright (c) 2012-2014 Sergey Efremov, Kostiantyn Kahanskyi

Copyright (c) 2015 Careerjet Ltd

MIT License

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.