hawatel_search_jobs 0.1.2 → 0.1.3

data/lib/hawatel_search_jobs/api/reed.rb

@@ -1,186 +1,186 @@
-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]
+
+          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
 end

data/lib/hawatel_search_jobs/client.rb

@@ -1,165 +1,172 @@
-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
-    # @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)
+        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
+