hawatel_search_jobs 0.1.3 → 0.2.0

data/lib/hawatel_search_jobs/api/indeed.rb

@@ -1,158 +1,167 @@
-require 'ostruct'
-require 'net/http'
-require 'json'
-
-module HawatelSearchJobs
-  module Api
-    module Indeed
-      class << self
-        include HawatelSearchJobs::Helpers::Base
-
-        DEFAULT = {
-            :keywords => '',
-            :location => '',
-            :company  => ''
-        }
-
-        # Search jobs based on specified keywords or location
-        #
-        # @param args [Hash]
-        # @option args [String] :query_key full url from last query, option deliverd by page() method
-        # @option args :query [Hash] search criteria
-        #   - *:keywords* (String) keywords for search
-        #   - *:location* (String) specified location for search criteria (default all countries)
-        # @option args :settings [Hash]
-        #   - *:api* (String) hostname or ip address api server
-        #   - *:publisher* (String) authentication string
-        #
-        # @example
-        #   search(:settings => HawatelSearchJobs.indeed,:query => {:keywords => 'ruby'})
-        #   search(:query_key => 'http://api.../ads/apisearch?publisher=12323&q=ruby')
-        #
-        # @return [Hash<OpenStruct>]
-        def search(args)
-          args[:query] = DEFAULT.merge(args[:query]) if args[:query]
-          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['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['totalResults']
-            attributes[:page] = result['pageNumber']
-            #attributes[:last] = (result['totalResults'] / 25) - 1
-            attributes[:last] = paging_info(25, result['totalResults'])
-            attributes[:key]  = url_request
-            attributes[:jobs] = parse_raw_data(result)
-            OpenStruct.new(attributes)
-          else
-            OpenStruct.new({:code => 501, :msg => 'lack of api or publisher setting'})
-          end
-        end
-
-        # Show next page of results
-        #
-        # @param args [Hash]
-        # @option args [Integer] :page  page number (default 0)
-        # @option args [String] :query_key url from last query
-        #
-        # @example
-        #   page({:query_key => result.key, :page => 2}
-        #
-        # @return [Hash<OpenStruct>]
-        def page(args)
-          args[:page] = 0 if args[:page].nil?
-          if args[:query_key]
-            url = args[:query_key].gsub(/&start=.*/, '') << "&start=#{args[:page]*25}"
-            search({:query_key => url})
-          end
-        end
-
-      private
-        # Build query URL
-        #
-        # @param args [Hash]
-        # option args :query [Hash]
-        #   - *:keywords* (String) keywords for search
-        #   - *:location* (String) search jobs from specified location
-        #   - *:salary* (String) show only position above specified salary
-        #   - *:company* (String) find position from specified company
-        # @option args :settings [Hash]
-        #   - *:api* (String) hostname or ip address api server
-        #   - *:publisher* (String) authentication string
-        #
-        # @example
-        #   build_url(:query => {:keywords => 'ruby'}, :settings => {:api => 'http://api...',:publisher => '23234'}}
-        #
-        # @return [String]
-        def build_url(args)
-          api_url   = args[:settings][:api]
-          publisher = args[:settings][:publisher]
-          location  = args[:query][:location]
-          salary    = args[:query][:salary]
-          company   = args[:query][:company]
-          keywords  = args[:query][:keywords]
-
-          if !keywords.to_s.empty? && !company.to_s.empty?
-            keywords  = "company:#{company}+#{keywords}"
-          elsif keywords.to_s.empty? && !company.to_s.empty?
-            keywords  = "company:#{company}"
-          end
-          if api_url && publisher
-            "http://#{api_url}/ads/apisearch?publisher=#{publisher}&q=#{keywords}&salary=#{salary}&l=#{location}"\
-            "&v=2&format=json&limit=25&start=0"
-          end
-        end
-
-        # Build jobs array with specified attributes
-        #
-        # @param result [Hash]
-        # @option result [Hash] :results job attributes
-        #
-        # @return [Array<OpenStruct>]
-        def parse_raw_data(result)
-          jobs = Array.new
-          return jobs if result['results'].to_s.empty?
-          result['results'].each do |offer|
-            job = Hash.new
-            job[:jobtitle] = offer['jobtitle'] if offer['jobtitle']
-            job[:location] = "#{offer['country']}, #{offer['city']}"
-            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
-
-        def paging_info(limit, total_result)
-          return nil if total_result == 0
-
-          mod = total_result.to_i % limit.to_i
-          if mod == 0
-            last = (total_result.to_i / limit.to_i) - 1
-          else
-            last = (total_result.to_i / limit.to_i).to_i
-          end
-
-          last
-        end
-
-      end
-    end
-  end
+require 'ostruct'
+require 'net/http'
+require 'json'
+
+module HawatelSearchJobs
+  module Api
+    module Indeed
+      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 [String] :query_key full url from last query, option deliverd by page() method
+        # @option args :query [Hash] search criteria
+        #   - *:keywords* (String) keywords for search
+        #   - *:location* (String) specified location for search criteria (default all countries)
+        # @option args :settings [Hash]
+        #   - *:api* (String) hostname or ip address api server
+        #   - *:publisher* (String) authentication string
+        #
+        # @example
+        #   search(:settings => HawatelSearchJobs.indeed,:query => {:keywords => 'ruby'})
+        #   search(:query_key => 'http://api.../ads/apisearch?publisher=12323&q=ruby')
+        #
+        # @return [Hash<OpenStruct>]
+        def search(args)
+          args[:query] = DEFAULT.merge(args[:query]) if args[:query]
+          args[:page_size] = args[:settings][:page_size].to_s.empty? ? RESULT_LIMIT : args[:settings][:page_size].to_i
+          args[:page_size] = RESULT_LIMIT if args[:page_size] <= 0 || args[:page_size] > 25
+
+          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['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['totalResults']
+            attributes[:page] = result['pageNumber']
+            attributes[:last] = paging_info(args[:page_size], result['totalResults'])
+            attributes[:key]  = url_request
+            attributes[:jobs] = parse_raw_data(result)
+            OpenStruct.new(attributes)
+          else
+            OpenStruct.new({:code => 501, :msg => 'lack of api or publisher setting'})
+          end
+        end
+
+        # Show next page of results
+        #
+        # @param args [Hash]
+        # @option args [Integer] :page  page number (default 0)
+        # @option args [String] :query_key url from last query
+        #
+        # @example
+        #   page({:query_key => result.key, :page => 2}
+        #
+        # @return [Hash<OpenStruct>]
+        def page(args)
+          args[:page] = 0 if args[:page].nil?
+          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 > 25
+
+          if args[:query_key]
+            url = args[:query_key].gsub(/&start=.*/, '') << "&start=#{args[:page]*page_size}"
+            search({:settings => args[:settings], :query_key => url})
+          end
+        end
+
+      private
+        # Build query URL
+        #
+        # @param args [Hash]
+        # option args :query [Hash]
+        #   - *:keywords* (String) keywords for search
+        #   - *:location* (String) search jobs from specified location
+        #   - *:salary* (String) show only position above specified salary
+        #   - *:company* (String) find position from specified company
+        # @option args :settings [Hash]
+        #   - *:api* (String) hostname or ip address api server
+        #   - *:publisher* (String) authentication string
+        #
+        # @example
+        #   build_url(:query => {:keywords => 'ruby'}, :settings => {:api => 'http://api...',:publisher => '23234'}}
+        #
+        # @return [String]
+        def build_url(args)
+          api_url   = args[:settings][:api]
+          publisher = args[:settings][:publisher]
+          version   = args[:settings][:version].to_s.empty? ? '2' : args[:settings][:version]
+          location  = args[:query][:location]
+          salary    = args[:query][:salary]
+          company   = args[:query][:company]
+          keywords  = args[:query][:keywords]
+          page_size = args[:page_size]
+
+          if !keywords.to_s.empty? && !company.to_s.empty?
+            keywords  = "company:#{company}+#{keywords}"
+          elsif keywords.to_s.empty? && !company.to_s.empty?
+            keywords  = "company:#{company}"
+          end
+          if api_url && publisher
+            "http://#{api_url}/ads/apisearch?publisher=#{publisher}&q=#{keywords}&salary=#{salary}&l=#{location}"\
+            "&v=#{version}&sort=date&format=json&limit=#{page_size}&start=0"
+          end
+        end
+
+        # Build jobs array with specified attributes
+        #
+        # @param result [Hash]
+        # @option result [Hash] :results job attributes
+        #
+        # @return [Array<OpenStruct>]
+        def parse_raw_data(result)
+          jobs = Array.new
+          return jobs if result['results'].to_s.empty?
+          result['results'].each do |offer|
+            job = Hash.new
+            job[:jobtitle] = offer['jobtitle'] if offer['jobtitle']
+            job[:location] = "#{offer['country']}, #{offer['city']}"
+            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
+
+        def paging_info(limit, total_result)
+          return nil if total_result == 0
+
+          mod = total_result.to_i % limit.to_i
+          if mod == 0
+            last = (total_result.to_i / limit.to_i) - 1
+          else
+            last = (total_result.to_i / limit.to_i).to_i
+          end
+
+          last
+        end
+
+      end
+    end
+  end
 end

data/lib/hawatel_search_jobs/api/reed.rb

@@ -1,186 +1,190 @@
-require 'ostruct'
-
-module HawatelSearchJobs
-  module Api
-    ##
-    # = Reed.co.uk API
-    #
-    # @see https://www.reed.co.uk/developers/Jobseeker
-    module Reed
-      class << self
-        include HawatelSearchJobs::Helpers::Base
-
-        DEFAULT = {
-            :keywords => '',
-            :location => '',
-        }
-
-        RESULT_LIMIT = 25
-
-        # Search jobs by specific criteria
-        # @param [Hash] args
-        # @option args :settings [Hash] search criteria
-        #   - *:api* (String) - URL API (default: reed.co.uk/api)
-        #   - *:version* (String) - a version of API (default: 1.0)
-        #   - *:clientid* (String) - API Key (see https://www.reed.co.uk/developers/Jobseeker)
-        # @option args :query [Hash] settings of API
-        #   - *:keywors* (String)
-        #   - *:location* (String)
-        # @example
-        #   jobs = Reed.search({:settings => {
-        #                                   :api => 'reed.co.uk/api',
-        #                                   :version => '1.0',
-        #                                   :clientid => 'secret-code'},
-        #                                :query => {
-        #                                   :keywords => 'ruby',
-        #                                   :location => 'London'})
-        # @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 = api_request(url_request, args[:settings][:clientid])
-          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]
-            limit = result_limit(args[:query_key])
-            url_request = args[:query_key].gsub(/&resultsToSkip=\d+/, '') << "&resultsToSkip=#{page * limit}"
-            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
-            json_response = JSON.parse(response.body)
-            begin
-              if !json_response['results'].to_s.empty?
-                attributes[:totalResults] = json_response['totalResults'] || 0
-
-                page_info = paging_info(url_request, attributes[:totalResults])
-                attributes[:page] = page_info.page
-                attributes[:last] = page_info.last
-
-                attributes[:key]  = url_request
-                attributes[:jobs] = parse_raw_data(json_response)
-              end
-            rescue
-              raise "Something wrong with returned data: #{json_response}"
-            end
-          end
-          attributes
-        end
-
-        def api_request(url, clientid = nil)
-          opt = Hash.new
-
-          if clientid
-            opt = { :basic_auth => {
-                :username => clientid,
-                :password => ''
-            }}
-          end
-
-          send_request(url, opt)
-        end
-
-        def prepare_query(args)
-          "keywords=#{args[:query][:keywords]}&locationName=#{args[:query][:location]}"
-        end
-
-        def prepare_conn_string(args)
-          conn_string = "https://#{args[:settings][:api]}/#{args[:settings][:version]}/search?resultsToTake=#{RESULT_LIMIT}&"
-          conn_string
-        end
-
-        def parse_raw_data(data)
-          jobs = Array.new
-          data['results'].each do |offer|
-            job = Hash.new
-            job[:jobtitle] = offer['jobTitle'] if offer['jobTitle']
-            job[:location] = "United Kingdom, #{offer['locationName']}"
-            job[:company]  = offer['employerName']
-            job[:date]     = convert_date_to_format(offer['date'],'%d/%m/%y')
-            job[:url]      = offer['jobUrl']
-
-            job = convert_empty_to_nil(job)
-
-            jobs << OpenStruct.new(job)
-          end
-          jobs
-        rescue
-          raise "Cannot parse raw data: #{data}"
-        end
-
-        def result_limit(url)
-          result = url.match(/\resultsToTake=(\d+)/)
-          result ? result[1].to_i : RESULT_LIMIT
-        end
-
-        def result_skip(url)
-          result = url.match(/\&resultsToSkip=(\d+)/)
-          result ? result[1].to_i : 0
-        end
-
-        def paging_info(url, total_result)
-          return OpenStruct.new({:page => nil, :last => nil}) if total_result == 0
-
-          result_limit = result_limit(url)
-          result_skip = result_skip(url)
-
-          if result_skip == 0 && total_result > 0
-            page = 0
-          else
-            page = (result_skip / result_limit).to_i
-          end
-
-          mod = total_result.to_i % result_limit.to_i
-          if mod == 0
-            last = (total_result.to_i / result_limit.to_i) - 1
-          else
-            last = (total_result.to_i / result_limit.to_i).to_i
-          end
-
-          OpenStruct.new({:page => page, :last => last})
-        end
-
-      end
-    end
-  end
+require 'ostruct'
+
+module HawatelSearchJobs
+  module Api
+    ##
+    # = Reed.co.uk API
+    #
+    # @see https://www.reed.co.uk/developers/Jobseeker
+    module Reed
+      class << self
+        include HawatelSearchJobs::Helpers::Base
+
+        DEFAULT = {
+            :keywords => '',
+            :location => '',
+        }
+
+        RESULT_LIMIT = 25
+
+        # Search jobs by specific criteria
+        # @param [Hash] args
+        # @option args :settings [Hash] search criteria
+        #   - *:api* (String) - URL API (default: reed.co.uk/api)
+        #   - *:version* (String) - a version of API (default: 1.0)
+        #   - *:clientid* (String) - API Key (see https://www.reed.co.uk/developers/Jobseeker)
+        # @option args :query [Hash] settings of API
+        #   - *:keywors* (String)
+        #   - *:location* (String)
+        # @example
+        #   jobs = Reed.search({:settings => {
+        #                                   :api => 'reed.co.uk/api',
+        #                                   :version => '1.0',
+        #                                   :clientid => 'secret-code'},
+        #                                :query => {
+        #                                   :keywords => 'ruby',
+        #                                   :location => 'London'})
+        # @return [Hash] First page of the result (see constant RESULT_LIMIT)
+        def search(args)
+          args[:query] = DEFAULT.merge(args[:query]) if args[:query]
+          args[:page_size] = args[:settings][:page_size].to_s.empty? ? RESULT_LIMIT : args[:settings][:page_size].to_i
+          args[:page_size] = RESULT_LIMIT if args[:page_size] <= 0 || args[:page_size] > 100
+
+          if args[:query_key].nil?
+            url_request = prepare_conn_string(args) + prepare_query(args)
+          else
+            url_request = args[:query_key]
+          end
+
+          response = api_request(url_request, args[:settings][:clientid])
+          attributes = build_jobs_table(response, url_request, args[:page_size])
+          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
+          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
+
+          if args[:query_key]
+            #limit = result_limit(args[:query_key])
+            url_request = args[:query_key].gsub(/&resultsToSkip=\d+/, '') << "&resultsToSkip=#{page * page_size}"
+            args[:query_key] = url_request
+            search(args)
+          end
+        end
+
+        private
+
+        def build_jobs_table(response, url_request, page_size)
+          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
+            json_response = JSON.parse(response.body)
+            begin
+              if !json_response['results'].to_s.empty?
+                attributes[:totalResults] = json_response['totalResults'] || 0
+
+                page_info = paging_info(url_request, attributes[:totalResults], page_size)
+                attributes[:page] = page_info.page
+                attributes[:last] = page_info.last
+
+                attributes[:key]  = url_request
+                attributes[:jobs] = parse_raw_data(json_response)
+              end
+            rescue
+              raise "Something wrong with returned data: #{json_response}"
+            end
+          end
+          attributes
+        end
+
+        def api_request(url, clientid = nil)
+          opt = Hash.new
+
+          if clientid
+            opt = { :basic_auth => {
+                :username => clientid,
+                :password => ''
+            }}
+          end
+
+          send_request(url, opt)
+        end
+
+        def prepare_query(args)
+          "keywords=#{args[:query][:keywords]}&locationName=#{args[:query][:location]}"
+        end
+
+        def prepare_conn_string(args)
+          conn_string = "https://#{args[:settings][:api]}/#{args[:settings][:version]}/search?resultsToTake=#{args[:page_size]}&"
+          conn_string
+        end
+
+        def parse_raw_data(data)
+          jobs = Array.new
+          data['results'].each do |offer|
+            job = Hash.new
+            job[:jobtitle] = offer['jobTitle'] if offer['jobTitle']
+            job[:location] = "United Kingdom, #{offer['locationName']}"
+            job[:company]  = offer['employerName']
+            job[:date]     = convert_date_to_format(offer['date'],'%d/%m/%y')
+            job[:url]      = offer['jobUrl']
+
+            job = convert_empty_to_nil(job)
+
+            jobs << OpenStruct.new(job)
+          end
+          jobs
+        rescue
+          raise "Cannot parse raw data: #{data}"
+        end
+
+        # def result_limit(url)
+        #   result = url.match(/\resultsToTake=(\d+)/)
+        #   result ? result[1].to_i : RESULT_LIMIT
+        # end
+
+        def result_skip(url)
+          result = url.match(/\&resultsToSkip=(\d+)/)
+          result ? result[1].to_i : 0
+        end
+
+        def paging_info(url, total_result, page_size)
+          return OpenStruct.new({:page => nil, :last => nil}) if total_result == 0
+
+          result_skip = result_skip(url)
+
+          if result_skip == 0 && total_result > 0
+            page = 0
+          else
+            page = (result_skip / page_size).to_i
+          end
+
+          mod = total_result.to_i % page_size.to_i
+          if mod == 0
+            last = (total_result.to_i / page_size.to_i) - 1
+          else
+            last = (total_result.to_i / page_size.to_i).to_i
+          end
+
+          OpenStruct.new({:page => page, :last => last})
+        end
+
+      end
+    end
+  end
 end