careerjet-rb 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6ee3a2c3089cb6ca38d8d573baba736c22ef2b25
+  data.tar.gz: 03fff161949b59f47a212dc8ec4e90aff8eef853
+SHA512:
+  metadata.gz: 7a40877bc50ab5a04f824233740fede6ab3c0e7e107a2710cab67e3f8d3aa299bb4e611d1ac762bfe416e887defdee1daeb13184dbc906ce571f857d29e22cbe
+  data.tar.gz: 095a3f2b5c616bd83a562bee5c5bf4714c23ddac695de42c1e256ceab035894755b9e21c41bf485a0ab87391c3bc76d4a71d31c712d2774625ea4743f38e1ab0

data/.gitignore

@@ -0,0 +1,2 @@
+Gemfile.lock
+/pkg

data/.rspec

@@ -0,0 +1,3 @@
+--colour
+--format progress
+--backtrace

data/.travis.yml

@@ -0,0 +1,11 @@
+script: "bundle exec rake"
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+  - ree
+gemfile:
+  - Gemfile
+notifications:
+  recipients:
+    - efremov.sergey@gmail.com

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/README.md

@@ -0,0 +1,83 @@
+# Careerjet RB
+
+It's ruby wrapper for [Careerjet](http://www.careerjet.com)'s API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'careerjet-rb', :require => "careerjet"
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install careerjet-rb
+    
+## Usage
+
+```ruby
+> Careerjet.search :locale => :en_US, :keywords => 'ruby', :page => 1
+=> #<Careerjet::Mash hits=5704 jobs=[<..>] pages=286 response_time=0.0434670448303223 type="JOBS"> 
+```
+
+You will get [Hashie::Mash](https://github.com/intridea/hashie#mash) as a response,
+so you can get all data via convenient methods:
+
+```ruby
+> Careerjet.search(:locale => :en_US, :keywords => 'ruby', :page => 1).jobs.first
+#<Careerjet::Mash company="Company Name" date="Wed, 17 Apr 2013 00:00:00 GMT" description=" <..>" url="http://..."> 
+```
+
+
+### Search Params
+
+* `locale`: Locale of search, if locale not specified — using `:en_US`
+
+* `keywords`: Keywords to search in job offers.
+
+* `location`: Location to search job offers in.
+
+* `sort`: Type of sort. Can be: `relevance` (default) — most relevant first, `date` — freshest offer first and `salary` — biggest salary first.
+
+* `start_num`: Number of first offer returned in entire result space. Should be >= 1 and <= Number of hits.
+
+* `pagesize`: Number of offers returned in one call.
+
+* `page`: Number of the asked page. Should be >=1. If this value is set, the eventually given `start_num` is overrided.
+
+* `contracttype`: Character code for contract type.`p` — permanent job, `c` — contract, `t` — temporary, `i` — training, `v` — voluntary, none — all contract types.
+
+* `contractperiod`: Character code for contract work period. `f` — full time, `p` — part time, none — all work period.
+
+## Thanks
+
+This gem was inspired by [careerjet](https://github.com/kostia/careerjet) gem from [kostia](https://github.com/kostia).
+
+## License
+
+Copyright (c) 2012-2013 Sergey Efremov, Kostiantyn Kahanskyi
+
+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.
+

data/Rakefile

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

data/careerejet.gemspec

@@ -0,0 +1,22 @@
+require File.expand_path('../lib/careerjet/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name = 'careerjet-rb'
+  gem.version = Careerjet.version
+  gem.description = "Ruby wrapper for Careerjet's API"
+  gem.summary = "Ruby wrapper for Careerjet's API"
+  gem.homepage = 'https://github.com/ResumUP/careerjet-rb'
+  gem.authors = ['Sergey Efremov', 'Kostiantyn Kahanskyi']
+  gem.email = %w[efremov.sergey@gmail.com kostiantyn.kahanskyi@googlemail.com]
+  gem.license = 'MIT'
+  gem.files = `git ls-files`.split("\n")
+  gem.require_paths = %w[lib]
+  gem.add_dependency 'multi_json'
+  gem.add_dependency 'rest-client'
+  gem.add_dependency 'hashie'
+  gem.add_development_dependency 'pry'
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'webmock'
+  gem.add_development_dependency 'yajl-ruby' # To avoid warning from MultiJson
+end

data/lib/careerjet.rb

@@ -0,0 +1,14 @@
+require 'careerjet/constants'
+require 'careerjet/errors'
+require 'careerjet/client'
+require 'careerjet/mash'
+require 'careerjet/version'
+
+module Careerjet
+
+  def self.search(params)
+    results = Careerjet::Client.new(params).search
+
+    Careerjet::Mash.from_json results
+  end
+end

data/lib/careerjet/client.rb

@@ -0,0 +1,49 @@
+require 'rest_client'
+
+module Careerjet
+  class Client
+
+    attr_accessor :params
+
+    def initialize(params)
+      @params = params || {}
+
+      set_locale
+      check_params
+    end
+
+    def check_params
+      unless Careerjet::LOCALES.keys.include?(@params[:locale_code])
+        raise Careerjet::UnknownLocale, "Not supported locale '#{@params[:locale_code]}'" 
+      end
+
+      @params.each_key do |k|
+        unless Careerjet::ALLOWED_FIELDS.include? k
+          raise InvalidParam, "Unknown param key `#{k}'"
+        end
+      end
+    end
+
+    def search
+      response  = RestClient.get [Careerjet::DOMAIN, 'search'].join('/'),  params: @params
+      raise_errors response
+
+      response.body
+    end
+
+    def set_locale
+      @params[:locale_code] = @params[:locale_code] || @params[:locale] || :en_US
+      @params.delete(:locale)
+    end
+
+    def raise_errors response
+      case response.code.to_i
+      when 400..405
+        raise Careerjet::NotFoundError, "(#{response.code}): #{response.message}"
+      when 500..503
+        raise Careerjet::UnavailableError, "(#{response.code}): #{response.message}"
+      end
+    end
+
+  end
+end

data/lib/careerjet/constants.rb

@@ -0,0 +1,74 @@
+module Careerjet
+  DOMAIN = "http://public.api.careerjet.net"
+
+  ALLOWED_FIELDS = [:keywords, :location, :sort, :start_num, :pagesize, :page, 
+                    :contracttype, :contractperiod, :locale_code]
+
+  LOCALES = {
+    :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_CA => 'http://www.careerjet.ca'        ,
+    :en_CN => 'http://en.careerjet.cn'         ,
+    :en_HK => 'http://www.careerjet.hk'        ,
+    :en_IE => 'http://www.careerjet.ie'        ,
+    :en_IN => 'http://www.careerjet.co.in'     ,
+    :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_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_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://fr.careerjet.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'        ,
+  }
+
+end

data/lib/careerjet/errors.rb

@@ -0,0 +1,9 @@
+module Careerjet
+
+  class UnknownLocale < ArgumentError; end
+  class InvalidParam < ArgumentError; end
+
+  class UnavailableError < StandardError; end
+  class NotFoundError < StandardError; end
+
+end

data/lib/careerjet/mash.rb

@@ -0,0 +1,11 @@
+require 'hashie'
+require 'multi_json'
+
+module Careerjet
+  class Mash < ::Hashie::Mash
+    def self.from_json(json_string)
+      result_hash = ::MultiJson.decode(json_string)
+      new(result_hash)
+    end
+  end
+end

data/lib/careerjet/version.rb

@@ -0,0 +1,5 @@
+module Careerjet
+  def self.version
+    '0.1.0'
+  end
+end

data/spec/careerjet_spec.rb

@@ -0,0 +1,27 @@
+require 'webmock/rspec'
+require 'careerjet'
+
+describe Careerjet do
+  it "should request Careejet's search API with correct domain and given params" do
+    resp = {'hits' => 1, 'response_time' =>  0.001, 'type' => 'JOBS', 'pages' => 1}
+    stub_http_request(:get, 'http://public.api.careerjet.net/search?keywords=rails&locale_code=en_US&page=1').to_return(
+        :body => MultiJson.encode(resp))
+
+    results = Careerjet.search(:locale => :en_US, :keywords => 'rails', :page => 1)
+
+    results.hits.should eql 1
+    results.response_time.should eql 0.001
+  end
+
+  it 'should raise appropriate error on unknown locale' do
+    lambda do
+      Careerjet.search :locale => :foo_Bar
+    end.should raise_error(Careerjet::UnknownLocale)
+  end
+
+  it 'should validate given params' do
+    lambda do
+      Careerjet.search :locale => :en_US, :keywords => 'rails', :foo => 'bar'
+    end.should raise_error(Careerjet::InvalidParam)
+  end
+end

metadata

@@ -0,0 +1,172 @@
+--- !ruby/object:Gem::Specification
+name: careerjet-rb
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sergey Efremov
+- Kostiantyn Kahanskyi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  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: rest-client
+  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: hashie
+  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: 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: rake
+  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: rspec
+  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: webmock
+  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: yajl-ruby
+  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'
+description: Ruby wrapper for Careerjet's API
+email:
+- efremov.sergey@gmail.com
+- kostiantyn.kahanskyi@googlemail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- README.md
+- Rakefile
+- careerejet.gemspec
+- lib/careerjet.rb
+- lib/careerjet/client.rb
+- lib/careerjet/constants.rb
+- lib/careerjet/errors.rb
+- lib/careerjet/mash.rb
+- lib/careerjet/version.rb
+- spec/careerjet_spec.rb
+homepage: https://github.com/ResumUP/careerjet-rb
+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: Ruby wrapper for Careerjet's API
+test_files: []