hawatel_search_jobs 0.1.3 → 0.2.0

data/lib/hawatel_search_jobs/api/xing.rb

@@ -11,6 +11,8 @@ module HawatelSearchJobs::Api
           :company  => ''
       }
 
+      RESULT_LIMIT = 25
+
       # @see https://github.com/xing/xing_api
       # Search jobs based on specified keywords
       #
@@ -30,9 +32,13 @@ module HawatelSearchJobs::Api
       def search(args)
         args[:query] = DEFAULT.merge(args[:query]) if args[:query]
         keywords = args[:query][:keywords]
-        result = send_request({:keywords => keywords, :offset => 0, :settings => args[:settings]})
+        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
+
+        result = send_request({:keywords => keywords, :offset => 0, :settings => args[:settings], :page_size => page_size})
+
         if !result[:code]
-          set_attributes({:result => result, :page => 0, :keywords => keywords})
+          set_attributes({:result => result, :page => 0, :keywords => keywords, :page_size => page_size})
         else
           OpenStruct.new({:code => 501, :msg => 'incorrect settings'})
         end
@@ -50,8 +56,11 @@ module HawatelSearchJobs::Api
       # @return [Hash<OpenStruct>]
       def page(args)
         args[:page] = 0 if args[:page].nil?
-        result = XingApi::Job.search(args[:query_key], {:limit => 25, :offset => args[:page]*25})
-        set_attributes({:result => result, :page => args[:page], :keywords => args[:query_key]})
+        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
+
+        result = XingApi::Job.search(args[:query_key], {:limit => page_size, :offset => args[:page]*page_size})
+        set_attributes({:result => result, :page => args[:page], :keywords => args[:query_key], :page_size => page_size})
       rescue XingApi::Error => e
         {:code => e.status_code, :msg => e.text}
       end
@@ -66,7 +75,8 @@ module HawatelSearchJobs::Api
       # @return [Hash<OpenStruct>]
       def send_request(args)
         set_settings(args[:settings])
-        XingApi::Job.search(args[:keywords], {:limit => 25, :offset => 0})
+
+        XingApi::Job.search(args[:keywords], {:limit => args[:page_size], :offset => 0})
       rescue XingApi::Error => e
         {:code => e.status_code, :msg => e.text}
       end
@@ -79,7 +89,7 @@ module HawatelSearchJobs::Api
         attributes[:code]  = '200'
         attributes[:msg]   = "OK"
         attributes[:page]  = args[:page]
-        attributes[:last]  = args[:result][:jobs][:total] / 25
+        attributes[:last]  = args[:result][:jobs][:total] / args[:page_size]
         attributes[:key]   = args[:keywords]
         attributes[:jobs]  = parse_raw_data(args[:result])
         OpenStruct.new(attributes)

data/lib/hawatel_search_jobs/client.rb

@@ -1,172 +1,170 @@
-module HawatelSearchJobs
-  ##
-  # = Client for a jobs search engine
-  #
-  # @!attribute [rw] indeed
-  #   @return [Hash] settings of API
-  # @!attribute [rw] xing
-  #   @return [Hash] settings of API
-  # @!attribute [rw] reed
-  #   @return [Hash] settings of API
-  # @!attribute [rw] careerbuilder
-  #   @return [Hash] settings of API
-  # @!attribute [rw] careerjet
-  #   @return [Hash] settings of API
-  class Client
-    include HawatelSearchJobs::Api
-
-    # Values have to be the same name like module name of usesd APIs (HawatelSearchJobs::Api::[ApiName])
-    APIS = ['Indeed', 'Xing', 'Reed', 'Careerbuilder', 'CareerJet']
-
-    attr_reader :jobs_table
-
-    DEFAULT = {
-        :keywords => '',
-        :location => '',
-        :company  => '',
-    }
-
-    def initialize
-      APIS.each do |api|
-        metaclasses.send(:attr_reader, api.downcase.to_sym)
-        api_conf = HawatelSearchJobs.instance_variable_get("@"+api.downcase)
-
-        if api_conf.nil?
-          HawatelSearchJobs.configure
-          api_conf = HawatelSearchJobs.instance_variable_get("@"+api.downcase)
-        end
-
-        instance_variable_set("@#{api.downcase}", api_conf.dup)
-      end
-    end
-
-    def metaclasses
-      class << self; self; end
-    end
-
-    # Search Jobs by specific criteria
-    # @param query [Hash]
-    # @option query [String] :keywords
-    # @option query [String] :location
-    # @option query [String] :company not working in Reed API
-    # @example
-    #       HawatelSearchJobs.configure do |config|
-    #           config.indeed[:activated] = true
-    #           config.indeed[:api]       = 'api.indeed.com'
-    #           config.indeed[:version]   = '2'
-    #           config.indeed[:publisher] = 'secret-key'
-    #
-    #           config.xing[:activated]           = true
-    #           config.xing[:consumer_key]        = 'secret-key'
-    #           config.xing[:consumer_secret]     = 'secret-key'
-    #           config.xing[:oauth_token]         = 'secret-key'
-    #           config.xing[:oauth_token_secret]  = 'secret-key'
-    #
-    #           config.reed[:activated] = true
-    #           config.reed[:api]       = 'reed.co.uk/api'
-    #           config.reed[:clientid]  = 'secret-key'
-    #           config.reed[:version]   = '1.0'
-    #
-    #           config.careerbuilder[:activated]  = true
-    #           config.careerbuilder[:api]        = 'api.careerbuilder.com'
-    #           config.careerbuilder[:clientid]   = 'secret-key'
-    #           config.careerbuilder[:version]    = 'v2'
-    #
-    #           config.careerjet[:activated]   = true
-    #           config.careerjet[:api]         = 'public.api.careerjet.net'
-    #         end
-    #
-    #       client = HawatelSearchJobs::Client.new
-    #       client.search_jobs({:keywords => 'ruby'})
-    #
-    #       p client.jobs_table[:indeed]
-    #       p client.jobs_table[:xing]
-    #       p client.jobs_table[:reed]
-    #       p client.jobs_table[:careerbuilder]
-    #       p client.jobs_table[:careerjet]
-    #
-    #       client.next
-    # @return [Hash] First page of result for all providers (default maximum 25 records for each page)
-    def search_jobs(query = {})
-      query = DEFAULT.merge(query)
-
-      @jobs_table = Hash.new
-
-      APIS.each do |api|
-        api_module_name = Object.const_get('HawatelSearchJobs').const_get('Api').const_get(api)
-        api_inst_var = instance_variable_get("@"+api.downcase)
-        @jobs_table[api.downcase.to_sym] = api_module_name.search({:settings => api_inst_var, :query => query}) if api_inst_var[:activated]
-      end
-
-      @jobs_table
-    end
-
-    # Get next page of result
-    # @example
-    #   p client.next
-    #   p client.jobs_table
-    # @return [Hash] Next page of result for all providers (default maximum 25 records for each)
-    def next
-      next_result = Hash.new
-      APIS.each do |api|
-        api_module_name = Object.const_get('HawatelSearchJobs').const_get('Api').const_get(api)
-        api_inst_var = instance_variable_get("@"+api.downcase)
-        api_sym_name = api.downcase.to_sym
-
-        if api_inst_var[:activated] && next_result?(api_sym_name)
-          next_result[api_sym_name] = api_module_name.page({:settings => api_inst_var,
-                                                            :page => @jobs_table[api_sym_name].page + 1,
-                                                            :query_key => @jobs_table[api_sym_name].key})
-        end
-      end
-
-      return nil if next_result.empty?
-
-      @jobs_table = next_result
-    end
-
-
-    # Sum jobs offers from specified api or count all
-    #
-    # @param args [Hash]
-    # @option args [String] :api name
-    # @example
-    #   p client.count
-    #   p client.count('indeed')
-    #
-    # @return [Integer]
-    def count(api = nil)
-      sum = 0
-
-      if api
-        api = api.downcase
-        api_inst_var = instance_variable_get("@"+api)
-        if api_inst_var[:activated]
-          sum = @jobs_table[:"#{api}"].totalResults if @jobs_table[:"#{api}"].totalResults
-        end
-      else
-        APIS.each do |provider|
-          api_inst_var = instance_variable_get("@"+provider.downcase)
-          if api_inst_var[:activated]
-            provider = provider.downcase
-            sum += @jobs_table[:"#{provider}"].totalResults if @jobs_table[:"#{provider}"].totalResults
-          end
-        end
-      end
-      return sum
-    end
-
-    private
-    def next_result?(provider)
-      if @jobs_table[provider] && @jobs_table[provider].page && @jobs_table[provider].last &&
-          @jobs_table[provider].page < @jobs_table[provider].last
-        true
-      else
-        false
-      end
-
-    end
-
-  end
-end
-
+module HawatelSearchJobs
+  ##
+  # = Client for a jobs search engine
+  #
+  # @!attribute [rw] indeed
+  #   @return [Hash] settings of API
+  # @!attribute [rw] xing
+  #   @return [Hash] settings of API
+  # @!attribute [rw] reed
+  #   @return [Hash] settings of API
+  # @!attribute [rw] careerbuilder
+  #   @return [Hash] settings of API
+  # @!attribute [rw] careerjet
+  #   @return [Hash] settings of API
+  class Client
+    include HawatelSearchJobs::Api
+
+    # Values have to be the same name like module name of usesd APIs (HawatelSearchJobs::Api::[ApiName])
+    APIS = ['Indeed', 'Xing', 'Reed', 'Careerbuilder', 'CareerJet']
+
+    attr_reader :jobs_table
+
+    DEFAULT = {
+        :keywords => '',
+        :location => '',
+        :company  => '',
+    }
+
+    def initialize
+      APIS.each do |api|
+        metaclasses.send(:attr_reader, api.downcase.to_sym)
+        instance_variable_set("@#{api.downcase}", HawatelSearchJobs.instance_variable_get("@"+api.downcase))
+      end
+    end
+
+    def metaclasses
+      class << self; self; end
+    end
+
+    # Search Jobs by specific criteria
+    # @param query [Hash]
+    # @option query [String] :keywords
+    # @option query [String] :location not working in Xing API
+    # @option query [String] :company not working in Reed API
+    # @example
+    #       HawatelSearchJobs.configure do |config|
+    #           config.indeed[:activated] = true
+    #           config.indeed[:api]       = 'api.indeed.com'
+    #           config.indeed[:version]   = '2'
+    #           config.indeed[:publisher] = 'secret-key'
+    #           config.indeed[:page_size] = 25 # allowed range <1,25>
+    #
+    #           config.xing[:activated]           = true
+    #           config.xing[:consumer_key]        = 'secret-key'
+    #           config.xing[:consumer_secret]     = 'secret-key'
+    #           config.xing[:oauth_token]         = 'secret-key'
+    #           config.xing[:oauth_token_secret]  = 'secret-key'
+    #           config.xing[:page_size]           = 25 # allowed range <1,100>
+    #
+    #           config.reed[:activated] = true
+    #           config.reed[:api]       = 'reed.co.uk/api'
+    #           config.reed[:clientid]  = 'secret-key'
+    #           config.reed[:version]   = '1.0'
+    #           config.reed[:page_size] = 25 # allowed range <1,100>
+    #
+    #           config.careerbuilder[:activated]  = true
+    #           config.careerbuilder[:api]        = 'api.careerbuilder.com'
+    #           config.careerbuilder[:clientid]   = 'secret-key'
+    #           config.careerbuilder[:version]    = 'v2'
+    #           config.careerbuilder[:page_size]  = 25 # allowed range <1,100>
+    #
+    #           config.careerjet[:activated]   = true
+    #           config.careerjet[:api]         = 'public.api.careerjet.net'
+    #           config.careerjet[:page_size]   = 25 # allowed range <1,99>
+    #         end
+    #
+    #       client = HawatelSearchJobs::Client.new
+    #       client.search_jobs({:keywords => 'ruby'})
+    #
+    #       p client.jobs_table[:indeed]
+    #       p client.jobs_table[:xing]
+    #       p client.jobs_table[:reed]
+    #       p client.jobs_table[:careerbuilder]
+    #       p client.jobs_table[:careerjet]
+    #
+    #       client.next
+    # @return [Hash] First page of result for all providers (default maximum 25 records for each page)
+    def search_jobs(query = {})
+      query = DEFAULT.merge(query)
+
+      @jobs_table = Hash.new
+
+      APIS.each do |api|
+        api_module_name = Object.const_get('HawatelSearchJobs').const_get('Api').const_get(api)
+        api_inst_var = instance_variable_get("@"+api.downcase)
+        @jobs_table[api.downcase.to_sym] = api_module_name.search({:settings => api_inst_var, :query => query}) if api_inst_var[:activated]
+      end
+
+      @jobs_table
+    end
+
+    # Get next page of result
+    # @example
+    #   p client.next
+    #   p client.jobs_table
+    # @return [Hash] Next page of result for all providers (default maximum 25 records for each)
+    def next
+      next_result = Hash.new
+      APIS.each do |api|
+        api_module_name = Object.const_get('HawatelSearchJobs').const_get('Api').const_get(api)
+        api_inst_var = instance_variable_get("@"+api.downcase)
+        api_sym_name = api.downcase.to_sym
+
+        if api_inst_var[:activated] && next_result?(api_sym_name)
+          next_result[api_sym_name] = api_module_name.page({:settings => api_inst_var,
+                                                            :page => @jobs_table[api_sym_name].page + 1,
+                                                            :query_key => @jobs_table[api_sym_name].key})
+        end
+      end
+
+      return nil if next_result.empty?
+
+      @jobs_table = next_result
+    end
+
+
+    # Sum jobs offers from specified api or count all
+    #
+    # @param args [Hash]
+    # @option args [String] :api name
+    # @example
+    #   p client.count
+    #   p client.count('indeed')
+    #
+    # @return [Integer]
+    def count(api = nil)
+      sum = 0
+
+      if api
+        api = api.downcase
+        api_inst_var = instance_variable_get("@"+api)
+        if api_inst_var[:activated]
+          sum = @jobs_table[:"#{api}"].totalResults if @jobs_table[:"#{api}"].totalResults
+        end
+      else
+        APIS.each do |provider|
+          api_inst_var = instance_variable_get("@"+provider.downcase)
+          if api_inst_var[:activated]
+            provider = provider.downcase
+            sum += @jobs_table[:"#{provider}"].totalResults if @jobs_table[:"#{provider}"].totalResults
+          end
+        end
+      end
+      return sum
+    end
+
+    private
+    def next_result?(provider)
+      if @jobs_table[provider] && @jobs_table[provider].page && @jobs_table[provider].last &&
+          @jobs_table[provider].page < @jobs_table[provider].last
+        true
+      else
+        false
+      end
+
+    end
+
+  end
+end
+

data/lib/hawatel_search_jobs/version.rb

@@ -1,3 +1,3 @@
 module HawatelSearchJobs
-  VERSION = "0.1.3"
+  VERSION = "0.2.0"
 end

data/spec/careerbuilder_spec.rb

@@ -1,83 +1,143 @@
-require 'spec_helper'
-
-xdescribe HawatelSearchJobs::Api::Careerbuilder do
-  before(:each) do
-    HawatelSearchJobs.configure do |config|
-      config.careerbuilder[:api]      = 'api.careerbuilder.com'
-      config.careerbuilder[:version]  = 'v2'
-      config.careerbuilder[:clientid] = ''
-    end
-  end
-
-  context 'APIs returned jobs' do
-    before(:each) do
-      @query_api = {:keywords => 'ruby', :location => ''}
-      @result = HawatelSearchJobs::Api::Careerbuilder.search(
-          :settings => HawatelSearchJobs.careerbuilder,
-          :query => {
-              :keywords => @query_api[:keywords],
-              :location => @query_api[:location]
-          })
-    end
-
-    it '#search' do
-      validate_result(@result, @query_api)
-      expect(@result.page).to be >= 0
-      expect(@result.last).to be >= 0
-    end
-
-    it '#page' do
-      validate_result(@result, @query_api)
-      page_result = HawatelSearchJobs::Api::Careerbuilder.page({
-                                                                   :settings => HawatelSearchJobs.careerbuilder,
-                                                                   :query_key => @result.key,
-                                                                   :page => 1})
-      expect(page_result.key).to match(/&PageNumber=2/)
-      expect(page_result.page).to be == 1
-      expect(page_result.last).to be >= 0
-    end
-  end
-
-  context 'APIs returned empty table' do
-    before(:each) do
-      @query_api = {:keywords => 'job-not-found-zero-records', :location => 'London'}
-      @result = HawatelSearchJobs::Api::Careerbuilder.search(
-          :settings => HawatelSearchJobs.careerbuilder,
-          :query => {
-              :keywords => @query_api[:keywords],
-              :location => @query_api[:location]
-          })
-    end
-
-    it '#search' do
-      validate_result(@result, @query_api)
-      expect(@result.totalResults).to eq(0)
-      expect(@result.page).to be_nil
-      expect(@result.last).to be_nil
-      expect(@result.jobs).to be_nil
-    end
-
-    it '#page' do
-      validate_result(@result, @query_api)
-      page_result = HawatelSearchJobs::Api::Careerbuilder.page({
-                                                                   :settings => HawatelSearchJobs.careerbuilder,
-                                                                   :query_key => @result.key,
-                                                                   :page => 1})
-      expect(page_result.key).to match(/&PageNumber=2/)
-      expect(@result.totalResults).to eq(0)
-      expect(@result.page).to be_nil
-      expect(@result.last).to be_nil
-      expect(@result.jobs).to be_nil
-    end
-  end
-
-  private
-
-  def validate_result(result, query_api)
-    expect(result.code).to eq(200)
-    expect(result.msg).to eq('OK')
-    expect(result.totalResults).to be >= 0
-    expect(result.key).to match("Location=#{query_api[:location]}")
-    expect(result.key).to match("Keywords=#{query_api[:keywords]}")
-  end
+require 'spec_helper'
+require 'time'
+
+xdescribe HawatelSearchJobs::Api::Careerbuilder do
+  before(:each) do
+    HawatelSearchJobs.configure do |config|
+      config.careerbuilder[:api]      = 'api.careerbuilder.com'
+      config.careerbuilder[:version]  = 'v2'
+      config.careerbuilder[:clientid] = ''
+      config.careerbuilder[:page_size]= 100
+    end
+  end
+
+  context 'APIs returned jobs' do
+    before(:each) do
+      @query_api = {:keywords => 'ruby', :location => ''}
+      @result = HawatelSearchJobs::Api::Careerbuilder.search(
+          :settings => HawatelSearchJobs.careerbuilder,
+          :query => {
+              :keywords => @query_api[:keywords],
+              :location => @query_api[:location]
+          })
+    end
+
+    it '#search' do
+      validate_result(@result, @query_api)
+      expect(@result.page).to be >= 0
+      expect(@result.last).to be >= 0
+    end
+
+    it '#results ordered by date descending' do
+      validate_result(@result, @query_api)
+
+      last_date = nil
+      @result.jobs.each do |job|
+        if !job.date.to_s.empty?
+          if !last_date.nil?
+            expect(convert_date_to_timestamp(job.date)).to be <= last_date
+          end
+          last_date = convert_date_to_timestamp(job.date)
+        end
+      end
+    end
+
+    it '#page' do
+      validate_result(@result, @query_api)
+
+      page_result =
+          HawatelSearchJobs::Api::Careerbuilder.page({
+                                                     :settings => HawatelSearchJobs.careerbuilder,
+                                                     :query_key => @result.key,
+                                                     :page => 1})
+      expect(page_result.key).to match(/&PageNumber=2/)
+      expect(page_result.page).to be == 1
+      expect(page_result.last).to be >= 0
+    end
+
+    it '#count of jobs is the same like page_size' do
+      validate_result(@result, @query_api)
+      expect(@result.jobs.count).to eq(HawatelSearchJobs.careerbuilder[:page_size])
+    end
+
+    it '#next page does not contain last page' do
+      validate_result(@result, @query_api)
+
+      first_page =
+          HawatelSearchJobs::Api::Careerbuilder.page({
+                                                     :settings => HawatelSearchJobs.careerbuilder,
+                                                     :query_key => @result.key,
+                                                     :page => 1})
+      expect(first_page.key).to match(/&PageNumber=2/)
+      expect(first_page.page).to be == 1
+      expect(first_page.last).to be >= 0
+
+      second_page =
+          HawatelSearchJobs::Api::Careerbuilder.page({
+                                                      :settings => HawatelSearchJobs.careerbuilder,
+                                                      :query_key => @result.key,
+                                                      :page => 2})
+
+      expect(second_page.key).to match(/&PageNumber=3/)
+      expect(second_page.page).to be == 2
+      expect(second_page.last).to be >= 0
+
+      first_page.jobs.each do |first_job|
+        second_page.jobs.each do |second_job|
+          expect(first_job.url).not_to eq(second_job.url)
+        end
+      end
+
+    end
+  end
+
+  context 'APIs returned empty table' do
+    before(:each) do
+      @query_api = {:keywords => 'job-not-found-zero-records', :location => 'London'}
+      @result = HawatelSearchJobs::Api::Careerbuilder.search(
+          :settings => HawatelSearchJobs.careerbuilder,
+          :query => {
+              :keywords => @query_api[:keywords],
+              :location => @query_api[:location]
+          })
+    end
+
+    it '#search' do
+      validate_result(@result, @query_api)
+      expect(@result.totalResults).to eq(0)
+      expect(@result.page).to be_nil
+      expect(@result.last).to be_nil
+      expect(@result.jobs).to be_nil
+    end
+
+    it '#page' do
+      validate_result(@result, @query_api)
+      page_result =
+          HawatelSearchJobs::Api::Careerbuilder.page({
+                                                     :settings => HawatelSearchJobs.careerbuilder,
+                                                     :query_key => @result.key,
+                                                     :page => 1})
+      expect(page_result.key).to match(/&PageNumber=2/)
+      expect(@result.totalResults).to eq(0)
+      expect(@result.page).to be_nil
+      expect(@result.last).to be_nil
+      expect(@result.jobs).to be_nil
+    end
+  end
+
+  private
+
+  def validate_result(result, query_api)
+    expect(result.code).to eq(200)
+    expect(result.msg).to eq('OK')
+    expect(result.totalResults).to be >= 0
+    expect(result.key).to match("Location=#{query_api[:location]}")
+    expect(result.key).to match("Keywords=#{query_api[:keywords]}")
+  end
+
+  def convert_date_to_timestamp(job_date)
+    date = job_date.split('/')
+    return Time.parse("#{date[2]}-#{date[1]}-#{date[0]}").to_i
+  end
+
 end