arbetsformedlingen 0.5.0 → 0.6.0

data/lib/arbetsformedlingen/api/ledigtarbete_client.rb

@@ -1,13 +1,18 @@
+# frozen_string_literal: true
+
 require 'arbetsformedlingen/api/request'
 require 'arbetsformedlingen/api/values/create_ad_page'
 
 module Arbetsformedlingen
   module API
+    # API client for ledigtarbete
     class LedigtarbeteClient
+      # Base URL for ledigtarbete
       BASE_URL = 'http://api.arbetsformedlingen.se/ledigtarbete'.freeze
 
+      # HTTP headers
       HEADERS = {
-        'Content-type' => 'text/xml'
+        'Content-type' => 'text/xml',
       }.freeze
 
       # Post ad to API

data/lib/arbetsformedlingen/api/matchning_client.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'date'
 require 'time'
 require 'arbetsformedlingen/api/request'
@@ -5,13 +7,16 @@ require 'arbetsformedlingen/api/results/matchning_result'
 
 module Arbetsformedlingen
   module API
+    # API client for matchning
     class MatchningClient
       attr_reader :request
 
+      # Initialize client
       def initialize(request: Request.new)
         @request = request
       end
 
+      # rubocop:disable Metrics/LineLength
       # Find matching ads from API
       # @return [MatchningResult] the result.
       # @param area_id [String] Area ID.
@@ -36,6 +41,7 @@ module Arbetsformedlingen
       #    client.ads(keywrods: 'ruby', page: 3, page_size: 10)
       # @example Get ads with keyword and organsiation numer
       #    client.ads(keywrods: 'ruby', organization_number: org_no)
+      # rubocop:enable Metrics/LineLength
       def ads(
         # one of these must be present
         county_id: nil,
@@ -55,7 +61,7 @@ module Arbetsformedlingen
 
         one_of_required = [county_id, municipality_id, occupation_id, keywords]
         if one_of_required.all?(&:nil?)
-          error_message = 'One of: county_id, municipality_id, occupation_id, keywords is required'
+          error_message = 'One of: county_id, municipality_id, occupation_id, keywords is required' # rubocop:disable Metrics/LineLength
           raise ArgumentError, error_message
         end
 
@@ -77,12 +83,12 @@ module Arbetsformedlingen
           anstallningstyp: santize_employment_type_query(employment_type),
           yrkesomradeid: occupation_field_id,
           sokdatum: normalize_date_to_iso8601(published_after),
-          organisationsnummer: organization_number
+          organisationsnummer: organization_number,
         }
 
         response = request.get('matchning', query: query)
 
-        MatchningResult.build(response.json)
+        MatchningResult.build(response)
       end
 
       private
@@ -99,11 +105,11 @@ module Arbetsformedlingen
       end
 
       def santize_employment_type_query(employment_type)
-        # Sökkriterier anställningstyp.
-        # Värdena ska ligga mellan 1 och 3.
+        # Sökkriterier anställningstyp.
+        # Värdena ska ligga mellan 1 och 3.
         # 1 är XXX (EJ DOKUMENTERAT)
-        # 2 är somarjobb / feriejobb
-        # 3 är utlandsjobb
+        # 2 är somarjobb / feriejobb
+        # 3 är utlandsjobb
 
         # TODO: The question is what we do if an invalid parameter is passed
         #       should we crash?
@@ -113,15 +119,15 @@ module Arbetsformedlingen
 
       def santize_keywords_query(keywords)
         #
-        # Sökord kan separeras eller kombineras med något av följande exempel:
-        # mellanslag (” ”)
+        # Sökord kan separeras eller kombineras med något av följande exempel:
+        # mellanslag (" ")
         #
         # [Example]
         # /matchning?nyckelord="bagare""test"
         # /matchning?nyckelord="bagare"OR"test" /matchning?nyckelord="automatisk"AND"test"
 
         # Valid characters
-        # abcdefghijklmnopqrstuvwxyzåäö0123456789: ,.-"
+        # abcdefghijklmnopqrstuvwxyzåäö0123456789: ,.-"
 
         # TODO: What do we do if invalid characters are passed? Crash?
         keywords

data/lib/arbetsformedlingen/api/request.rb

@@ -1,19 +1,26 @@
+# frozen_string_literal: true
+
 require 'uri'
 require 'net/http'
 require 'json'
+require 'arbetsformedlingen/api/response'
 
 module Arbetsformedlingen
   module API
+    # API request object
     class Request
-      Response = KeyStruct.new(:code, :body, :json)
-
       attr_reader :locale, :base_url
 
+      # Initialize request
       def initialize(base_url: '', locale: 'sv')
         @base_url = base_url
         @locale = locale
       end
 
+      # Perform GEt request
+      # @param [String] url to be fetched
+      # @param [Hash] query params
+      # @return [Response] response object
       def get(url, query: {})
         uri = URI("#{base_url}#{url}?#{URI.encode_www_form(query.to_a)}")
 
@@ -25,17 +32,7 @@ module Arbetsformedlingen
 
         response = http.request(request)
 
-        Response.new(
-          code: response.code,
-          body: response.read_body,
-          json: parse_json(response.read_body)
-        )
-      end
-
-      def parse_json(string)
-        JSON.parse(string.to_s)
-      rescue JSON::ParserError => _e
-        {}
+        Response.new(response)
       end
     end
   end

data/lib/arbetsformedlingen/api/response.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+begin
+  require 'nokogiri'
+rescue LoadError
+end
+
+module Arbetsformedlingen
+  module API
+    # API response object
+    class Response
+      # Initialize response
+      def initialize(response)
+        @response = response
+        @json = nil
+      end
+
+      # True if response is 200
+      # @return [Boolean] true if response code is 200
+      def success?
+        response.code == '200'
+      end
+
+      # Response body
+      # @return [String] the response body
+      def body
+        response.read_body
+      end
+
+      # Response JSON
+      # @return [Hash] response json - empty if JSON is invalid
+      def json
+        @json ||= parse_json(body)
+      end
+
+      # Response XML
+      # @return [Nokogiri::XML::Document] response - empty is XML is invalid
+      def xml
+        @xml ||= parse_xml(body)
+      end
+
+      # Delegate missing values to response
+      def method_missing(method_name, *arguments, &block)
+        if response.respond_to?(method_name)
+          response.public_send(method_name, *arguments, &block)
+        else
+          super
+        end
+      end
+
+      # Return true if missing method can be delegated
+      def respond_to_missing?(method_name, include_private = false)
+        response.respond_to?(method_name) || super
+      end
+
+      private
+
+      attr_reader :response
+
+      def parse_json(string)
+        JSON.parse(string.to_s)
+      rescue JSON::ParserError => _e
+        {}
+      end
+
+      def parse_xml(string)
+        Nokogiri::XML(string).tap(&:remove_namespaces!)
+      end
+    end
+  end
+end

data/lib/arbetsformedlingen/api/results/ad_result.rb

@@ -1,11 +1,24 @@
+# frozen_string_literal: true
+
 require 'arbetsformedlingen/api/values/ad_result_values'
 
 module Arbetsformedlingen
   module API
     module AdResult
-      def self.build(response_data)
-        data = response_data.fetch('platsannons')
+      # Build API result object for ad result
+      # @param [API::Response] response
+      # @return [Values::Ad]
+      def self.build(response)
+        return build_empty(response) unless response.success?
+
+        build_page(response)
+      end
 
+      # private
+
+      def self.build_page(response)
+        response_data = response.json
+        data = response_data.fetch('platsannons')
         ad_data = data.fetch('annons')
 
         Values::Ad.new(
@@ -19,32 +32,37 @@ module Arbetsformedlingen
           total_vacancies: ad_data.fetch('antal_platser'),
           municipalities: ad_data.fetch('kommunnamn'),
           municipality_id: ad_data.fetch('kommunkod'),
-          total_vacancies_with_visa: ad_data.fetch('antalplatserVisa'),
+          total_vacancies_with_visa: ad_data.fetch('antalplatserVisa', nil),
           employment_type: ad_data.fetch('anstallningstyp'),
           terms: build_terms(data.fetch('villkor')),
           application: build_application(data.fetch('ansokan')),
           workplace: build_workplace(data.fetch('arbetsplats')),
-          requirements: build_requirements(data.fetch('krav'))
+          requirements: build_requirements(data.fetch('krav')),
+          response: response
         )
       end
 
+      def self.build_empty(response)
+        Values::Ad.new(response: response)
+      end
+
       def self.build_terms(data)
         Values::Terms.new(
-          duration: data.fetch('varaktighet'),
-          working_hours: data.fetch('arbetstid'),
-          working_hours_description: data.fetch('arbetstidvaraktighet'),
+          duration: data.fetch('varaktighet', nil),
+          working_hours: data.fetch('arbetstid', nil),
+          working_hours_description: data.fetch('arbetstidvaraktighet', nil),
           salary_type: data.fetch('lonetyp'),
-          salary_form: data.fetch('loneform')
+          salary_form: data.fetch('loneform', nil)
         )
       end
 
       def self.build_application(data)
         Values::Application.new(
           reference: data['referens'],
-          application_url: data.fetch('webbplats'),
+          application_url: data.fetch('webbplats', nil),
           email: data['epostadress'],
           last_application_at: data.fetch('sista_ansokningsdag', nil),
-          application_comment: data.fetch('ovrigt_om_ansokan')
+          application_comment: data.fetch('ovrigt_om_ansokan', nil)
         )
       end
 
@@ -53,11 +71,11 @@ module Arbetsformedlingen
           name: data.fetch('arbetsplatsnamn'),
           postal: build_postal(data),
           country: data.fetch('land'),
-          visit_address: data.fetch('besoksadress'),
-          logotype_url: data.fetch('logotypurl'),
-          website: data.fetch('hemsida'),
+          visit_address: data.fetch('besoksadress', nil),
+          logotype_url: data.fetch('logotypurl', nil),
+          website: data.fetch('hemsida', nil),
           contacts: (
-            data.dig('kontaktpersonlista', 'kontaktpersonlista') || []
+            data.dig('kontaktpersonlista', 'kontaktpersondata') || []
           ).map do |contact_data|
             build_workplace_contacts(contact_data)
           end
@@ -66,10 +84,10 @@ module Arbetsformedlingen
 
       def self.build_postal(data)
         Values::Postal.new(
-          code: data.fetch('postnummer'),
-          address: data.fetch('postadress'),
-          city: data.fetch('postort'),
-          country: data.fetch('postland')
+          code: data.fetch('postnummer', nil),
+          address: data.fetch('postadress', nil),
+          city: data.fetch('postort', nil),
+          country: data.fetch('postland', nil)
         )
       end
 

data/lib/arbetsformedlingen/api/results/matchning_result.rb

@@ -1,9 +1,39 @@
+# frozen_string_literal: true
+
 require 'arbetsformedlingen/api/values/matchning_result_values'
 
 module Arbetsformedlingen
   module API
     module MatchningResult
-      def self.build(response_data)
+      # Build API result object for matchning result
+      # @param [API::Response] response
+      # @return [Values::MatchningPage]
+      def self.build(response)
+        return empty_matchning_page(response) unless response.success?
+
+        build_matchning_page(response)
+      end
+
+      # private
+
+      def self.empty_matchning_page(response)
+        response_data = response.json
+
+        Values::MatchningPage.new(
+          list_name: 'annonser',
+          total_ads: 0,
+          total_ads_exact: 0,
+          total_ads_nearby: 0,
+          total_vacancies_on_page: 0,
+          total_pages: 0,
+          raw_data: response_data,
+          data: [],
+          response: response
+        )
+      end
+
+      def self.build_matchning_page(response)
+        response_data = response.json
         data = response_data.fetch('matchningslista')
 
         Values::MatchningPage.new(
@@ -14,10 +44,19 @@ module Arbetsformedlingen
           total_vacancies_on_page: data.fetch('antal_platserTotal'),
           total_pages: data.fetch('antal_sidor'),
           raw_data: response_data,
-          data: data.fetch('matchningdata').map { |ad_data| build_ad_result(ad_data) }
+          data: build_ad_results(data),
+          response: response
         )
       end
 
+      # private
+
+      def self.build_ad_results(data)
+        data.fetch('matchningdata', []).map do |ad_data|
+          build_ad_result(ad_data)
+        end
+      end
+
       def self.build_ad_result(ad_data)
         Values::MatchningAd.new(
           id: ad_data.fetch('annonsid'),
@@ -32,7 +71,7 @@ module Arbetsformedlingen
           url: ad_data.fetch('annonsurl'),
           relevance: ad_data.fetch('relevans'),
           total_vacancies: ad_data.fetch('antalplatser'),
-          total_vacancies_with_visa: ad_data.fetch('antalPlatserVisa'),
+          total_vacancies_with_visa: ad_data.fetch('antalPlatserVisa', nil),
           duration_id: ad_data.fetch('varaktighetId', nil),
           counties: ad_data.fetch('lan'),
           country_id: ad_data.fetch('lanid'),

data/lib/arbetsformedlingen/api/results/soklista_result.rb

@@ -1,9 +1,22 @@
+# frozen_string_literal: true
+
 require 'arbetsformedlingen/api/values/soklista_values'
 
 module Arbetsformedlingen
   module API
     module SoklistaResult
-      def self.build(response_data, list_name: nil)
+      # Build API result object for "soklista"
+      # @param [API::Response] response
+      # @param list_name [String] result list name
+      # @return [Values::SoklistaPage]
+      def self.build(response, list_name: nil)
+        build_page(response, list_name)
+      end
+
+      # private
+
+      def self.build_page(response, list_name)
+        response_data = response.json
         data = response_data.fetch('soklista', {})
 
         Values::SoklistaPage.new(
@@ -13,7 +26,8 @@ module Arbetsformedlingen
           raw_data: response_data,
           data: data.fetch('sokdata', []).map do |result|
             build_search_result(result)
-          end
+          end,
+          response: response
         )
       end
 

data/lib/arbetsformedlingen/api/soap_request.rb

@@ -1,5 +1,8 @@
+# frozen_string_literal: true
+
 require 'uri'
 require 'net/http'
+require 'arbetsformedlingen/api/response'
 
 begin
   require 'nokogiri'
@@ -8,11 +11,14 @@ end
 
 module Arbetsformedlingen
   module API
+    # API SOAP request
     class SOAPRequest
-      Response = KeyStruct.new(:code, :body, :xml)
+      # SOAP response
+      # Response = KeyStruct.new(:code, :body, :xml)
 
       attr_reader :locale, :uri, :url
 
+      # Initialize SOAP request
       def initialize(url, locale: nil)
         unless Object.const_defined?(:Nokogiri)
           raise(ArgumentError, "unable to require 'nokogiri' gem, please install it")
@@ -23,6 +29,9 @@ module Arbetsformedlingen
         @locale = locale
       end
 
+      # Performs a POST request
+      # @param [String] the post body
+      # @return [Response] the response
       def post(body)
         http = Net::HTTP.new(uri.host, uri.port)
         http.use_ssl = true if uri.scheme == 'https'
@@ -34,15 +43,7 @@ module Arbetsformedlingen
 
         response = http.request(request)
 
-        Response.new(
-          code: response.code,
-          body: response.read_body,
-          xml: parse_xml(response.read_body)
-        )
-      end
-
-      def parse_xml(string)
-        Nokogiri::XML(string).tap { |doc| doc.remove_namespaces! }
+        Response.new(response)
       end
     end
   end