hawatel_search_jobs 0.1.0 → 0.1.1

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/api/xing.rb

@@ -1,121 +1,121 @@
-require 'xing_api'
-
-module HawatelSearchJobs::Api
-  module Xing
-    class << self
-      include HawatelSearchJobs::Helpers::Base
-
-      DEFAULT = {
-          :keywords => '',
-          :location => '',
-          :company  => ''
-      }
-
-      # @see https://github.com/xing/xing_api
-      # Search jobs based on specified keywords
-      #
-      # @param args [Hash]
-      # @option args :query [Hash] search criteria
-      #   - *:keywords* (String )
-      # @option args :setting [Hash] @see https://dev.xing.com/docs/authentication
-      #   - *:consumer_key* (String) - consumer key, required for authentication
-      #   - *:consumer_secret* (String) - consumer secret, required for authentication
-      #   - *:oauth_token* (String) - outh toker, required for authentication
-      #   - *:oauth_token_secret* (String) - outh token secret, required for authentication
-      #
-      # @example
-      #   search(:settings => HawatelSearchJobs.xing,:query => {:keywords => 'ruby'})
-      #
-      # @return [Hash<OpenStruct>]
-      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]})
-        if !result[:code]
-          set_attributes({:result => result, :page => 0, :keywords => keywords})
-        else
-          OpenStruct.new({:code => 501, :msg => 'incorrect settings'})
-        end
-      end
-
-      # Show next page of results
-      #
-      # @param args [Hash]
-      # @option page [Integer] page numer (default 0)
-      # @option query_key [String] keywords from last query
-      #
-      # @example
-      #   page({:query_key => result.key, :page => 2}
-      #
-      # @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]})
-      rescue XingApi::Error => e
-        {:code => e.status_code, :msg => e.text}
-      end
-
-      private
-      # Call Xing client request
-      #
-      # @param args [Hash]
-      # @option settings [Hash] authentication attributes
-      # @option keywords [String] keywords for query
-      #
-      # @return [Hash<OpenStruct>]
-      def send_request(args)
-        set_settings(args[:settings])
-        XingApi::Job.search(args[:keywords], {:limit => 25, :offset => 0})
-      rescue XingApi::Error => e
-        {:code => e.status_code, :msg => e.text}
-      end
-
-      # Build final result - set required attributes and return openstruct object
-      #
-      def set_attributes(args)
-        attributes = Hash.new
-        attributes[:totalResults] = args[:result][:jobs][:total]
-        attributes[:code]  = '200'
-        attributes[:msg]   = "OK"
-        attributes[:page]  = args[:page]
-        attributes[:last]  = args[:result][:jobs][:total] / 25
-        attributes[:key]   = args[:keywords]
-        attributes[:jobs]  = parse_raw_data(args[:result])
-        OpenStruct.new(attributes)
-      end
-
-      # Build jobs array with specified attributes
-      #
-      # @return [Array<OpenStruct>]
-      def parse_raw_data(result)
-        jobs = Array.new
-        return jobs if result['jobs'].to_s.empty?
-        result[:jobs][:items].each do |offer|
-          job = Hash.new
-          job[:jobtitle] = offer[:title]
-          job[:location] = "#{offer[:location][:country]}, #{offer[:location][:city]}"
-          job[:company]  = offer[:company][:name]
-          job[:date]     = convert_date_to_format(offer[:published_at], '%d/%m/%y')
-          job[:url]      = offer[:links][:xing]
-          job = convert_empty_to_nil(job)
-          jobs << OpenStruct.new(job)
-        end
-        return jobs
-      end
-
-      # Set settings for XingApi client
-      #
-      # @param args [Hash]
-      def set_settings(args)
-        XingApi::Client.configure do |config|
-          config.consumer_key = args[:consumer_key]
-          config.consumer_secret = args[:consumer_secret]
-          config.oauth_token = args[:oauth_token]
-          config.oauth_token_secret = args[:oauth_token_secret]
-        end
-      end
-
-    end
-  end
-end
+require 'xing_api'
+
+module HawatelSearchJobs::Api
+  module Xing
+    class << self
+      include HawatelSearchJobs::Helpers::Base
+
+      DEFAULT = {
+          :keywords => '',
+          :location => '',
+          :company  => ''
+      }
+
+      # @see https://github.com/xing/xing_api
+      # Search jobs based on specified keywords
+      #
+      # @param args [Hash]
+      # @option args :query [Hash] search criteria
+      #   - *:keywords* (String )
+      # @option args :setting [Hash] @see https://dev.xing.com/docs/authentication
+      #   - *:consumer_key* (String) - consumer key, required for authentication
+      #   - *:consumer_secret* (String) - consumer secret, required for authentication
+      #   - *:oauth_token* (String) - outh toker, required for authentication
+      #   - *:oauth_token_secret* (String) - outh token secret, required for authentication
+      #
+      # @example
+      #   search(:settings => HawatelSearchJobs.xing,:query => {:keywords => 'ruby'})
+      #
+      # @return [Hash<OpenStruct>]
+      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]})
+        if !result[:code]
+          set_attributes({:result => result, :page => 0, :keywords => keywords})
+        else
+          OpenStruct.new({:code => 501, :msg => 'incorrect settings'})
+        end
+      end
+
+      # Show next page of results
+      #
+      # @param args [Hash]
+      # @option page [Integer] page numer (default 0)
+      # @option query_key [String] keywords from last query
+      #
+      # @example
+      #   page({:query_key => result.key, :page => 2}
+      #
+      # @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]})
+      rescue XingApi::Error => e
+        {:code => e.status_code, :msg => e.text}
+      end
+
+      private
+      # Call Xing client request
+      #
+      # @param args [Hash]
+      # @option settings [Hash] authentication attributes
+      # @option keywords [String] keywords for query
+      #
+      # @return [Hash<OpenStruct>]
+      def send_request(args)
+        set_settings(args[:settings])
+        XingApi::Job.search(args[:keywords], {:limit => 25, :offset => 0})
+      rescue XingApi::Error => e
+        {:code => e.status_code, :msg => e.text}
+      end
+
+      # Build final result - set required attributes and return openstruct object
+      #
+      def set_attributes(args)
+        attributes = Hash.new
+        attributes[:totalResults] = args[:result][:jobs][:total]
+        attributes[:code]  = '200'
+        attributes[:msg]   = "OK"
+        attributes[:page]  = args[:page]
+        attributes[:last]  = args[:result][:jobs][:total] / 25
+        attributes[:key]   = args[:keywords]
+        attributes[:jobs]  = parse_raw_data(args[:result])
+        OpenStruct.new(attributes)
+      end
+
+      # Build jobs array with specified attributes
+      #
+      # @return [Array<OpenStruct>]
+      def parse_raw_data(result)
+        jobs = Array.new
+        return jobs if result['jobs'].to_s.empty?
+        result[:jobs][:items].each do |offer|
+          job = Hash.new
+          job[:jobtitle] = offer[:title]
+          job[:location] = "#{offer[:location][:country]}, #{offer[:location][:city]}"
+          job[:company]  = offer[:company][:name]
+          job[:date]     = convert_date_to_format(offer[:published_at], '%d/%m/%y')
+          job[:url]      = offer[:links][:xing]
+          job = convert_empty_to_nil(job)
+          jobs << OpenStruct.new(job)
+        end
+        return jobs
+      end
+
+      # Set settings for XingApi client
+      #
+      # @param args [Hash]
+      def set_settings(args)
+        XingApi::Client.configure do |config|
+          config.consumer_key = args[:consumer_key]
+          config.consumer_secret = args[:consumer_secret]
+          config.oauth_token = args[:oauth_token]
+          config.oauth_token_secret = args[:oauth_token_secret]
+        end
+      end
+
+    end
+  end
+end