hawatel_search_jobs 0.1.3 → 0.2.0

data/lib/hawatel_search_jobs/api.rb

@@ -1,9 +1,9 @@
-module HawatelSearchJobs
-  module Api
-    require 'hawatel_search_jobs/api/indeed'
-    require 'hawatel_search_jobs/api/reed'
-    require 'hawatel_search_jobs/api/xing'
-    require 'hawatel_search_jobs/api/careerbuilder'
-    require 'hawatel_search_jobs/api/careerjet'
-  end
-end
+module HawatelSearchJobs
+  module Api
+    require 'hawatel_search_jobs/api/indeed'
+    require 'hawatel_search_jobs/api/reed'
+    require 'hawatel_search_jobs/api/xing'
+    require 'hawatel_search_jobs/api/careerbuilder'
+    require 'hawatel_search_jobs/api/careerjet'
+  end
+end

data/lib/hawatel_search_jobs/api/careerbuilder.rb

@@ -1,170 +1,173 @@
-require 'ostruct'
-require 'active_support/core_ext/hash'
-
-module HawatelSearchJobs
-  module Api
-    ##
-    # = Carerrbuilder API
-    #
-    # @see 	http://api.careerbuilder.com/Search/jobsearch/jobsearchinfo.aspx
-    module Careerbuilder
-      class << self
-        include HawatelSearchJobs::Helpers::Base
-
-        DEFAULT = {
-            :keywords => '',
-            :location => '',
-            :company  => ''
-        }
-
-        RESULT_LIMIT = 25
-
-        # Search jobs by specific criteria
-        # @param [Hash] args
-        # @option args :settings [Hash] search criteria
-        #   - *:api* (String) - URL API (default: api.careerbuilder.com)
-        #   - *:version* (String) - a version of API (default: v2)
-        #   - *:clientid* (String) - Private Developer Key (see http://developer.careerbuilder.com)
-        # @option args :query [Hash] settings of API
-        #   - *:keywors* (String)
-        #   - *:location* (String)
-        #   - *:company* (String)
-        # @example
-        #   jobs = Careerbuilder.search({:settings => {
-        #                                   :api => 'api.careerbuilder.com',
-        #                                   :version => 'v2',
-        #                                   :clientid => 'secret-code'},
-        #                                :query => {
-        #                                   :keywords => 'ruby',
-        #                                   :location => 'London',
-        #                                   :company => ''}})
-        # @return [Hash] First page of the result (see constant RESULT_LIMIT)
-        def search(args)
-          args[:query] = DEFAULT.merge(args[:query]) if args[:query]
-
-          if args[:query_key].nil?
-            url_request = prepare_conn_string(args) + prepare_query(args)
-          else
-            url_request = args[:query_key]
-          end
-
-          response = send_request(url_request)
-          attributes = build_jobs_table(response, url_request)
-          OpenStruct.new(attributes)
-        end
-
-
-        # Get a specific page result
-        # At the beging you have to run {search} method and get :key from result and pass it to the argument :query_key
-        # @param [Hash] args
-        # @option args :settings [Hash] see {search}
-        # @option args [Integer] :page page number counted from 0
-        # @option args [String] :query_key
-        # @example
-        #   jobs = Careerbuilder.page({:settings => {
-        #                                   :api => 'api.careerbuilder.com',
-        #                                   :version => 'v2',
-        #                                   :clientid => 'secret-code'},
-        #                              :page => 5,
-        #                              :query_key => 'value from :key returned by search method'})
-        # @return [Hash] Job offers from specific page
-        def page(args)
-          page = args[:page].to_i || 0
-          if args[:query_key]
-            url_request = args[:query_key].gsub(/&PageNumber=\d+/, '') << "&PageNumber=#{page+1}"
-            args[:query_key] = url_request
-            search(args)
-          end
-        end
-
-        private
-
-        def build_jobs_table(response, url_request)
-          attributes  = Hash.new
-          attributes[:code] = response.code.to_i
-          attributes[:msg]  = response.message
-
-          attributes[:totalResults] = 0
-          attributes[:page] = nil
-          attributes[:last] = nil
-          attributes[:key]  = url_request
-          attributes[:jobs] = nil
-
-          if response.code.to_i == 200
-            xml_response = Hash.from_xml(response.body.gsub('\n', ''))
-            begin
-              if xml_response['ResponseJobSearch'] && xml_response['ResponseJobSearch']['Results']
-                attributes[:totalResults] = xml_response['ResponseJobSearch']['TotalCount'].to_i || 0
-                attributes[:page] = get_page_number(url_request) - 1
-                attributes[:last] = xml_response['ResponseJobSearch']['TotalPages'].to_i - 1
-                attributes[:key]  = url_request
-                attributes[:jobs] = parse_raw_data(xml_response)
-              end
-            rescue
-              raise "Something wrong with returned data: #{xml_response}"
-            end
-          end
-          attributes
-        end
-
-        def prepare_query(args)
-          "Keywords=#{args[:query][:keywords]}&" \
-          "Location=#{args[:query][:location]}&" \
-          "CompanyName=#{args[:query][:company]}"
-        end
-
-        def prepare_conn_string(args)
-          conn_string = "https://#{args[:settings][:api]}/#{args[:settings][:version]}/jobsearch?" \
-          "PerPage=#{RESULT_LIMIT}&DeveloperKey=#{args[:settings][:clientid]}&"
-
-          conn_string
-        end
-
-        def parse_raw_data(data)
-          jobs = Array.new
-          data['ResponseJobSearch']['Results']['JobSearchResult'].each do |offer|
-            job = Hash.new
-            job[:jobtitle] = offer['JobTitle'] if offer['JobTitle']
-
-            country = get_country_name(offer['State'], data['ResponseJobSearch']['SearchMetaData']['SearchLocations'])
-            location = country
-            location += ", #{offer['City']}" if offer['City'] && country != offer['City']
-            job[:location] = location
-            job[:company]  = offer['Company']
-
-            newdate = offer['PostedDate'].split('/')
-            job[:date]  = "#{newdate[1]}/#{newdate[0]}/#{newdate[2]}"
-
-            job[:date]     = convert_date_to_format(job[:date],'%d/%m/%y')
-            job[:url]      = offer['JobDetailsURL']
-
-            job = convert_empty_to_nil(job)
-
-            jobs << OpenStruct.new(job)
-          end
-          jobs
-        rescue
-          raise "Cannot parse raw data - #{data.inspect}"
-        end
-
-        def get_country_name(code, locations)
-          locations.each do |loc|
-            if loc[1]['StateCode'] && code && code.to_s == loc[1]['StateCode'].to_s
-              return loc[1]['City'] if loc[1]['City']
-            end
-          end
-
-          'United States'
-        rescue
-          raise "Cannot get country name (code=#{code}, locations=#{locations}"
-        end
-
-        def get_page_number(url)
-          result = url.match(/\&PageNumber=(\d+)/)
-          result ? result[1].to_i : 1
-        end
-
-      end
-    end
-  end
+require 'ostruct'
+require 'active_support/core_ext/hash'
+
+module HawatelSearchJobs
+  module Api
+    ##
+    # = Carerrbuilder API
+    #
+    # @see 	http://api.careerbuilder.com/Search/jobsearch/jobsearchinfo.aspx
+    module Careerbuilder
+      class << self
+        include HawatelSearchJobs::Helpers::Base
+
+        DEFAULT = {
+            :keywords => '',
+            :location => '',
+            :company  => ''
+        }
+
+        RESULT_LIMIT = 25
+
+        # Search jobs by specific criteria
+        # @param [Hash] args
+        # @option args :settings [Hash] search criteria
+        #   - *:api* (String) - URL API (default: api.careerbuilder.com)
+        #   - *:version* (String) - a version of API (default: v2)
+        #   - *:clientid* (String) - Private Developer Key (see http://developer.careerbuilder.com)
+        # @option args :query [Hash] settings of API
+        #   - *:keywors* (String)
+        #   - *:location* (String)
+        #   - *:company* (String)
+        # @example
+        #   jobs = Careerbuilder.search({:settings => {
+        #                                   :api => 'api.careerbuilder.com',
+        #                                   :version => 'v2',
+        #                                   :clientid => 'secret-code'},
+        #                                :query => {
+        #                                   :keywords => 'ruby',
+        #                                   :location => 'London',
+        #                                   :company => ''}})
+        # @return [Hash] First page of the result (see constant RESULT_LIMIT)
+        def search(args)
+          args[:query] = DEFAULT.merge(args[:query]) if args[:query]
+
+          if args[:query_key].nil?
+            url_request = prepare_conn_string(args) + prepare_query(args)
+          else
+            url_request = args[:query_key]
+          end
+
+          response = send_request(url_request)
+          attributes = build_jobs_table(response, url_request)
+          OpenStruct.new(attributes)
+        end
+
+
+        # Get a specific page result
+        # At the beging you have to run {search} method and get :key from result and pass it to the argument :query_key
+        # @param [Hash] args
+        # @option args :settings [Hash] see {search}
+        # @option args [Integer] :page page number counted from 0
+        # @option args [String] :query_key
+        # @example
+        #   jobs = Careerbuilder.page({:settings => {
+        #                                   :api => 'api.careerbuilder.com',
+        #                                   :version => 'v2',
+        #                                   :clientid => 'secret-code'},
+        #                              :page => 5,
+        #                              :query_key => 'value from :key returned by search method'})
+        # @return [Hash] Job offers from specific page
+        def page(args)
+          page = args[:page].to_i || 0
+          if args[:query_key]
+            url_request = args[:query_key].gsub(/&PageNumber=\d+/, '') << "&PageNumber=#{page+1}"
+            args[:query_key] = url_request
+            search(args)
+          end
+        end
+
+        private
+
+        def build_jobs_table(response, url_request)
+          attributes  = Hash.new
+          attributes[:code] = response.code.to_i
+          attributes[:msg]  = response.message
+
+          attributes[:totalResults] = 0
+          attributes[:page] = nil
+          attributes[:last] = nil
+          attributes[:key]  = url_request
+          attributes[:jobs] = nil
+
+          if response.code.to_i == 200
+            xml_response = Hash.from_xml(response.body.gsub('\n', ''))
+            begin
+              if xml_response['ResponseJobSearch'] && xml_response['ResponseJobSearch']['Results']
+                attributes[:totalResults] = xml_response['ResponseJobSearch']['TotalCount'].to_i || 0
+                attributes[:page] = get_page_number(url_request) - 1
+                attributes[:last] = xml_response['ResponseJobSearch']['TotalPages'].to_i - 1
+                attributes[:key]  = url_request
+                attributes[:jobs] = parse_raw_data(xml_response)
+              end
+            rescue
+              raise "Something wrong with returned data: #{xml_response}"
+            end
+          end
+          attributes
+        end
+
+        def prepare_query(args)
+          "Keywords=#{args[:query][:keywords]}&" \
+          "Location=#{args[:query][:location]}&" \
+          "CompanyName=#{args[:query][:company]}"
+        end
+
+        def prepare_conn_string(args)
+          page_size = args[:settings][:page_size].to_s.empty? ? RESULT_LIMIT : args[:settings][:page_size].to_i
+          page_size = RESULT_LIMIT if page_size <= 0 || page_size > 100
+
+          conn_string = "https://#{args[:settings][:api]}/#{args[:settings][:version]}/jobsearch?" \
+          "PerPage=#{page_size}&OrderBy=Date&DeveloperKey=#{args[:settings][:clientid]}&"
+
+          conn_string
+        end
+
+        def parse_raw_data(data)
+          jobs = Array.new
+          data['ResponseJobSearch']['Results']['JobSearchResult'].each do |offer|
+            job = Hash.new
+            job[:jobtitle] = offer['JobTitle'] if offer['JobTitle']
+
+            country = get_country_name(offer['State'], data['ResponseJobSearch']['SearchMetaData']['SearchLocations'])
+            location = country
+            location += ", #{offer['City']}" if offer['City'] && country != offer['City']
+            job[:location] = location
+            job[:company]  = offer['Company']
+
+            newdate = offer['PostedDate'].split('/')
+            job[:date]  = "#{newdate[1]}/#{newdate[0]}/#{newdate[2]}"
+
+            job[:date]     = convert_date_to_format(job[:date],'%d/%m/%y')
+            job[:url]      = offer['JobDetailsURL']
+
+            job = convert_empty_to_nil(job)
+
+            jobs << OpenStruct.new(job)
+          end
+          jobs
+        rescue
+          raise "Cannot parse raw data - #{data.inspect}"
+        end
+
+        def get_country_name(code, locations)
+          locations.each do |loc|
+            if loc[1]['StateCode'] && code && code.to_s == loc[1]['StateCode'].to_s
+              return loc[1]['City'] if loc[1]['City']
+            end
+          end
+
+          'United States'
+        rescue
+          raise "Cannot get country name (code=#{code}, locations=#{locations}"
+        end
+
+        def get_page_number(url)
+          result = url.match(/\&PageNumber=(\d+)/)
+          result ? result[1].to_i : 1
+        end
+
+      end
+    end
+  end
 end

data/lib/hawatel_search_jobs/api/careerjet.rb

@@ -1,126 +1,131 @@
-module HawatelSearchJobs
-  module Api
-    module CareerJet
-      class << self
-        include HawatelSearchJobs::Helpers::Base
-
-        DEFAULT = {
-            :keywords => '',
-            :location => '',
-            :company  => ''
-        }
-
-        # Search jobs based on specified keywords or location
-        #
-        # @param args [Hash]
-        # @option args :query [Hash] search criteria
-        #   - *:keywords*​ (String) - keywords for search
-        # @option args [Integer] :page page number (default value 0)
-        # @option args [String] :query_key option provided by page() method
-        #
-        # @example
-        #   search(:settings => HawatelSearchJobs.careerjet,:query => {:keywords => 'ruby'})
-        #   search(:query_key => 'http://api.../search?locale_code=US_en&sort=date&keywords=ruby', :page => 0)
-        #
-        # @return [Hash<OpenStruct>]
-        def search(args)
-          args[:query] = DEFAULT.merge(args[:query]) if args[:query]
-          args[:page]  = 0 if args[:page].nil?
-
-          if args[:query_key].to_s.empty?
-            url_request = build_url(args)
-          else
-            url_request = args[:query_key]
-          end
-
-          if url_request
-            attributes = Hash.new
-            response   = send_request(url_request)
-            result     = JSON(response.body)
-            if response.code == '200' && result['type'] == 'ERROR'
-              attributes[:code] = 501
-              attributes[:msg]  = result['error']
-              return OpenStruct.new(attributes)
-            else
-              attributes[:code] = response.code
-              attributes[:msg]  = response.message
-              return OpenStruct.new(attributes) if response.code != '200'
-            end
-            attributes[:totalResults] = result['hits']
-            attributes[:page] = args[:page]
-            attributes[:last] = result['pages'] - 1
-            attributes[:key]  = url_request
-            attributes[:jobs] = parse_raw_data(result)
-            OpenStruct.new(attributes)
-          else
-            OpenStruct.new({:code => 501, :msg => 'lack of keywords or api setting'})
-          end
-        end
-
-        # Show next page of results
-        #
-        # @param args [Hash]
-        # @option args [Integer] :page specified page number (default 0)
-        # @option args [String] :query_key full url from last query
-        #
-        # @example
-        #   page({:query_key => result.key, :page => 2}
-        #
-        # @return [Hash<OpenStrunct>]
-        def page(args)
-          args[:page] = 0 if args[:page].nil?
-          args[:query_key] = args[:query_key].gsub(/&page=.*/, '') << "&page=#{args[:page]+1}"
-          return search(args)
-        end
-
-        private
-
-        # Build query URL
-        #
-        # @param args [Hash]
-        # @option args query [Hash] - search criteria
-        #   - *:keywords* (String) - keywords for search
-        #   - *:location* (String) - specified location for search criteria (default: europe)
-        # @option settings [Hash]
-        #   - *:api* (String) - api ip or domainname
-        #
-        # @example
-        #   build_url(:query => {:keywords => 'ruby'}, :settings => {:api => 'http://api...'} }
-        #
-        # @return [String] ready to call URL
-        def build_url(args)
-          keywords = args[:query][:keywords] if !args[:query][:keywords].to_s.empty?
-          api_url  = args[:settings][:api]   if !args[:settings][:api].to_s.empty?
-          if keywords && api_url
-            !args[:query][:location].to_s.empty? ? location = args[:query][:location] : location = 'europe'
-            "http://#{api_url}/search?locale_code=US_en&pagesize=25&sort=date&keywords=#{keywords}&location=#{location}&page=1"
-          end
-        end
-
-
-        # Build jobs array with specified attributes
-        #
-        # @param result [Hash]
-        # @option result [Hash] :jobs jobs hash array return from API
-        #
-        # @return [Array<OpenStruct>]
-        def parse_raw_data(result)
-          jobs = Array.new
-          return jobs if result['jobs'].to_s.empty?
-          result['jobs'].each do |offer|
-            job = Hash.new
-            job[:jobtitle] = offer['title']
-            job[:location] = offer['locations']
-            job[:company]  = offer['company']
-            job[:date]     = convert_date_to_format(offer['date'],'%d/%m/%y')
-            job[:url]      = offer['url']
-            job = convert_empty_to_nil(job)
-            jobs << OpenStruct.new(job)
-          end
-          return jobs
-        end
-
-      end
-    end
-  end
-end
+module HawatelSearchJobs
+  module Api
+    module CareerJet
+      class << self
+        include HawatelSearchJobs::Helpers::Base
+
+        DEFAULT = {
+            :keywords => '',
+            :location => '',
+            :company  => ''
+        }
+
+        RESULT_LIMIT = 25
+
+        # Search jobs based on specified keywords or location
+        #
+        # @param args [Hash]
+        # @option args :query [Hash] search criteria
+        #   - *:keywords*​ (String) - keywords for search
+        # @option args [Integer] :page page number (default value 0)
+        # @option args [String] :query_key option provided by page() method
+        #
+        # @example
+        #   search(:settings => HawatelSearchJobs.careerjet,:query => {:keywords => 'ruby'})
+        #   search(:query_key => 'http://api.../search?locale_code=US_en&sort=date&keywords=ruby', :page => 0)
+        #
+        # @return [Hash<OpenStruct>]
+        def search(args)
+          args[:query] = DEFAULT.merge(args[:query]) if args[:query]
+          args[:page]  = 0 if args[:page].nil?
+
+          if args[:query_key].to_s.empty?
+            url_request = build_url(args)
+          else
+            url_request = args[:query_key]
+          end
+
+          if url_request
+            attributes = Hash.new
+            response   = send_request(url_request)
+            result     = JSON(response.body)
+            if response.code == '200' && result['type'] == 'ERROR'
+              attributes[:code] = 501
+              attributes[:msg]  = result['error']
+              return OpenStruct.new(attributes)
+            else
+              attributes[:code] = response.code
+              attributes[:msg]  = response.message
+              return OpenStruct.new(attributes) if response.code != '200'
+            end
+            attributes[:totalResults] = result['hits']
+            attributes[:page] = args[:page]
+            attributes[:last] = result['pages'] - 1
+            attributes[:key]  = url_request
+            attributes[:jobs] = parse_raw_data(result)
+            OpenStruct.new(attributes)
+          else
+            OpenStruct.new({:code => 501, :msg => 'lack of keywords or api setting'})
+          end
+        end
+
+        # Show next page of results
+        #
+        # @param args [Hash]
+        # @option args [Integer] :page specified page number (default 0)
+        # @option args [String] :query_key full url from last query
+        #
+        # @example
+        #   page({:query_key => result.key, :page => 2}
+        #
+        # @return [Hash<OpenStrunct>]
+        def page(args)
+          args[:page] = 0 if args[:page].nil?
+          args[:query_key] = args[:query_key].gsub(/&page=.*/, '') << "&page=#{args[:page]+1}"
+          return search(args)
+        end
+
+        private
+
+        # Build query URL
+        #
+        # @param args [Hash]
+        # @option args query [Hash] - search criteria
+        #   - *:keywords* (String) - keywords for search
+        #   - *:location* (String) - specified location for search criteria (default: europe)
+        # @option settings [Hash]
+        #   - *:api* (String) - api ip or domainname
+        #
+        # @example
+        #   build_url(:query => {:keywords => 'ruby'}, :settings => {:api => 'http://api...'} }
+        #
+        # @return [String] ready to call URL
+        def build_url(args)
+          keywords  = args[:query][:keywords] if !args[:query][:keywords].to_s.empty?
+          api_url   = args[:settings][:api]   if !args[:settings][:api].to_s.empty?
+          page_size = args[:settings][:page_size].to_s.empty? ? RESULT_LIMIT : args[:settings][:page_size].to_i
+          page_size = RESULT_LIMIT if page_size <= 0 || page_size > 99
+
+          if keywords && api_url
+            !args[:query][:location].to_s.empty? ? location = args[:query][:location] : location = 'worldwide'
+            "http://#{api_url}/search?locale_code=US_en&pagesize=#{page_size}&sort=date&keywords=#{keywords}&location=#{location}&page=1"
+          end
+        end
+
+
+        # Build jobs array with specified attributes
+        #
+        # @param result [Hash]
+        # @option result [Hash] :jobs jobs hash array return from API
+        #
+        # @return [Array<OpenStruct>]
+        def parse_raw_data(result)
+          jobs = Array.new
+          return jobs if result['jobs'].to_s.empty?
+          result['jobs'].each do |offer|
+            job = Hash.new
+            job[:jobtitle] = offer['title']
+            job[:location] = offer['locations']
+            job[:company]  = offer['company']
+            job[:date]     = convert_date_to_format(offer['date'],'%d/%m/%y')
+            job[:url]      = offer['url']
+            job = convert_empty_to_nil(job)
+            jobs << OpenStruct.new(job)
+          end
+          return jobs
+        end
+
+      end
+    end
+  end
+end