arbetsformedlingen 0.5.0 → 0.6.0

data/lib/arbetsformedlingen/api/values/ad_result_values.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Arbetsformedlingen
   module API
     module Values
@@ -17,11 +19,13 @@ module Arbetsformedlingen
         :terms,
         :application,
         :workplace,
-        :requirements
+        :requirements,
+        :response
       )
       class Ad
         def to_h
           hash = super.to_h
+          hash.delete(:response) # don't return the raw response object
           hash[:terms] = hash[:terms].to_h
           hash[:application] = hash[:application].to_h
           hash[:workplace] = hash[:workplace].to_h
@@ -63,6 +67,7 @@ module Arbetsformedlingen
         end
       end
 
+      Contact = KeyStruct.new(:name, :title, :phone)
       Postal = KeyStruct.new(:code, :address, :city, :country)
       Requirements = KeyStruct.new(:own_car)
     end

data/lib/arbetsformedlingen/api/values/create_ad_page.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Arbetsformedlingen
   module API
     module Values
@@ -6,7 +8,7 @@ module Arbetsformedlingen
 
         attr_reader :code, :messages, :body, :request_body
 
-        def initialize(httparty_response, request_boby)
+        def initialize(httparty_response, _request_boby)
           @code = httparty_response.code
           @body = httparty_response.body
           @request_body = request_body

data/lib/arbetsformedlingen/api/values/matchning_result_values.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Arbetsformedlingen
   module API
     module Values
@@ -10,7 +12,8 @@ module Arbetsformedlingen
         :total_places_total,
         :total_pages,
         :data,
-        :raw_data
+        :raw_data,
+        :response
       )
       class MatchningPage
         include Enumerable
@@ -21,9 +24,14 @@ module Arbetsformedlingen
 
         def to_h
           hash = super.to_h
+          hash.delete(:response) # don't return the raw response object
           hash[:data].map!(&:to_h)
           hash
         end
+
+        def success?
+          success
+        end
       end
 
       MatchningAd = KeyStruct.new(

data/lib/arbetsformedlingen/api/values/soklista_values.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Arbetsformedlingen
   module API
     module Values
@@ -6,7 +8,8 @@ module Arbetsformedlingen
         :total_ads,
         :total_vacancies,
         :data,
-        :raw_data
+        :raw_data,
+        :response
       )
       class SoklistaPage
         include Enumerable
@@ -17,9 +20,22 @@ module Arbetsformedlingen
 
         def to_h
           hash = super.to_h
+          hash.delete(:response) # don't return the raw response object
           hash[:data].map!(&:to_h)
           hash
         end
+
+        def method_missing(method_name, *arguments, &block)
+          if response.respond_to?(method_name)
+            response.public_send(method_name, *arguments, &block)
+          else
+            super
+          end
+        end
+
+        def respond_to_missing?(method_name, include_private = false)
+          response.respond_to?(method_name) || super
+        end
       end
 
       SoklistaResult = KeyStruct.new(

data/lib/arbetsformedlingen/api/ws_occupation_client.rb

@@ -1,17 +1,26 @@
+# frozen_string_literal: true
+
 require 'arbetsformedlingen/soap_builder'
 require 'arbetsformedlingen/api/soap_request'
 
 module Arbetsformedlingen
   module API
+    # WsOccupation API client
     class WSOccupationClient
       attr_reader :request
 
+      # Service URL
       SERVICE_URL = 'https://api.arbetsformedlingen.se/af/v0/Occupation/wsoccupation.asmx'.freeze
 
+      # Initialize client
       def initialize
-        @request = request || SOAPRequest.new(SERVICE_URL)
+        @request = SOAPRequest.new(SERVICE_URL)
       end
 
+      # Returns occupation response with specified id
+      # @return [Response] the response
+      # @see Response
+      # @see Response#xml
       def occupation(id)
         soap_body = SOAPBuilder.wrap do |body|
           body.GetOccupationById(xmlns: 'urn:ams.se:wsoccupation') do |node|
@@ -22,6 +31,10 @@ module Arbetsformedlingen
         request.post(soap_body.to_xml)
       end
 
+      # Returns occupations response with specified name
+      # @return [Response] the response
+      # @see Response
+      # @see Response#xml
       def find_occupations(name)
         soap_body = SOAPBuilder.wrap do |body|
           body.FindOccupation(xmlns: 'urn:ams.se:wsoccupation') do |node|
@@ -32,6 +45,10 @@ module Arbetsformedlingen
         request.post(soap_body.to_xml)
       end
 
+      # Returns occupations response
+      # @return [Response] the response
+      # @see Response
+      # @see Response#xml
       def occupations
         soap_body = SOAPBuilder.wrap do |body|
           body.GetAllOccupations(xmlns: 'urn:ams.se:wsoccupation')
@@ -40,6 +57,10 @@ module Arbetsformedlingen
         request.post(soap_body.to_xml)
       end
 
+      # Returns occupations short response with specified id
+      # @return [Response] the response
+      # @see Response
+      # @see Response#xml
       def occupations_short
         soap_body = SOAPBuilder.wrap do |body|
           body.GetAllOccupationsShort(xmlns: 'urn:ams.se:wsoccupation')
@@ -48,6 +69,10 @@ module Arbetsformedlingen
         request.post(soap_body.to_xml)
       end
 
+      # Returns occupations detailed response with specified id
+      # @return [Response] the response
+      # @see Response
+      # @see Response#xml
       def occupations_detailed
         soap_body = SOAPBuilder.wrap do |body|
           body.GetAllOccupationsDetailed(xmlns: 'urn:ams.se:wsoccupation')

data/lib/arbetsformedlingen/codes/country_code.rb

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
+
 require 'csv'
 require 'set'
 
 module Arbetsformedlingen
   class CountryCode
     CODES = CSV.read(
-      File.expand_path('../../../../data/country-codes.csv', __FILE__)
+      File.expand_path('../../../data/country-codes.csv', __dir__)
     ).to_h.freeze
 
     COUNTRY_CODES = Set.new(CODES.values).freeze

data/lib/arbetsformedlingen/codes/drivers_license_code.rb

@@ -1,10 +1,13 @@
+# frozen_string_literal: true
+
 require 'set'
 
 module Arbetsformedlingen
   module DriversLicenseCode
     CODES = Set.new([
-      'AM', 'A1', 'A2', 'A', 'B', 'Utökad B', 'BE', 'C1', 'C1E', 'C', 'CE', 'D1', 'D1E', 'D', 'DE'
-    ]).freeze
+                      'AM', 'A1', 'A2', 'A', 'B', 'Utökad B', 'BE',
+                      'C1', 'C1E', 'C', 'CE', 'D1', 'D1E', 'D', 'DE'
+                    ]).freeze
 
     def self.codes
       CODES.to_a
@@ -30,4 +33,4 @@ module Arbetsformedlingen
         map(&:upcase)
     end
   end
-end
+end

data/lib/arbetsformedlingen/codes/experience_required_code.rb

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
+
 require 'set'
 
 module Arbetsformedlingen
   class ExperienceRequiredCode
     CODES_MAP = {
       'true' => '1',
-      'false' => '4'
+      'false' => '4',
     }.freeze
     CODES_MAP_INVERTED = CODES_MAP.invert.freeze
 

data/lib/arbetsformedlingen/codes/municipality_code.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 require 'csv'
 
 module Arbetsformedlingen
   class MunicipalityCode
     CODE_MAP = CSV.read(
-      File.expand_path('../../../../data/municipality-codes.csv', __FILE__)
+      File.expand_path('../../../data/municipality-codes.csv', __dir__)
     ).to_h.freeze
     CODES_MAP_INVERTED = CODE_MAP.invert.freeze
 

data/lib/arbetsformedlingen/codes/occupation_code.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 require 'csv'
 
 module Arbetsformedlingen
   class OccupationCode
     CODE_MAP = CSV.read(
-      File.expand_path('../../../../data/occupation-codes.csv', __FILE__)
+      File.expand_path('../../../data/occupation-codes.csv', __dir__)
     ).to_h.invert.freeze
     CODES_MAP_INVERTED = CODE_MAP.invert.freeze
 

data/lib/arbetsformedlingen/codes/salary_type_code.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'set'
 
 module Arbetsformedlingen
@@ -5,7 +7,7 @@ module Arbetsformedlingen
     CODE_MAP = {
       'fixed' => '1',
       'fixed_and_commission' => '2',
-      'commission' => '3'
+      'commission' => '3',
     }.freeze
 
     CODES = Set.new(CODE_MAP.values).freeze

data/lib/arbetsformedlingen/key_struct.rb

@@ -1,12 +1,14 @@
+# frozen_string_literal: true
+
 module Arbetsformedlingen
   class KeyStruct < Struct
     def initialize(**keyword_args)
       keyword_args.each do |key, value|
-        if members.include?(key)
-          self[key] = value
-        else
+        unless members.include?(key)
           raise ArgumentError, "Unknown key struct member: #{key}"
         end
+
+        self[key] = value
       end
     end
   end

data/lib/arbetsformedlingen/models/application_method.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 module Arbetsformedlingen
   ApplicationMethodSchema = Dry::Validation.Params do
     configure do
       config.type_specs = true
-      config.messages_file = File.expand_path('../../../../config/locales/errors.yml', __FILE__)
+      config.messages_file = File.expand_path('../../../config/locales/errors.yml', __dir__)
 
       predicates(Predicates)
     end

data/lib/arbetsformedlingen/models/company.rb

@@ -4,7 +4,7 @@ module Arbetsformedlingen
   CompanySchema = Dry::Validation.Params do
     configure do
       config.type_specs = true
-      config.messages_file = File.expand_path('../../../../config/locales/errors.yml', __FILE__)
+      config.messages_file = File.expand_path('../../../config/locales/errors.yml', __dir__)
 
       predicates(Predicates)
     end
@@ -34,7 +34,7 @@ module Arbetsformedlingen
       hash[:address][:full_address] = [
         address.fetch(:street),
         address.fetch(:zip),
-        address.fetch(:city)
+        address.fetch(:city),
       ].join(', ')
       hash[:cin_arbetsformedlingen] = cin_arbetsformedlingen(hash.fetch(:cin))
       hash

data/lib/arbetsformedlingen/models/document.rb

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
+
 require 'securerandom'
 
 module Arbetsformedlingen
   DocumentSchema = Dry::Validation.Params do
     configure do
       config.type_specs = true
-      config.messages_file = File.expand_path('../../../../config/locales/errors.yml', __FILE__)
+      config.messages_file = File.expand_path('../../../config/locales/errors.yml', __dir__)
 
       predicates(Predicates)
     end
@@ -19,7 +21,7 @@ module Arbetsformedlingen
     def initialize(hash)
       data = {
         id: SecureRandom.uuid,
-        timestamp: Time.now.utc.iso8601
+        timestamp: Time.now.utc.iso8601,
       }.merge!(hash)
 
       super(DocumentSchema.call(data))

data/lib/arbetsformedlingen/models/dry/predicates.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'time'
 
 module Arbetsformedlingen

data/lib/arbetsformedlingen/models/dry/types.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Arbetsformedlingen
   module Types
     include Dry::Types.module
@@ -5,14 +7,14 @@ module Arbetsformedlingen
     StrippedString = Types::Strict::String.constructor { |value| value.to_s.strip }
     UUIDString = Types::Strict::String.constrained(size: 36)
     Currency = Types::Strict::String.constructor do |string|
-      string.strip.upcase if string
+      string&.strip&.upcase
     end
     # Company Identification Number
     CIN = Types::Strict::String.constructor do |string|
-      string.delete(' ').delete('-') if string
+      string&.delete(' ')&.delete('-')
     end
     Zip = Types::Strict::String.constructor do |string|
-      string.delete(' ') if string
+      string&.delete(' ')
     end
     Municipality = Types::Strict::String.constructor do |string|
       MunicipalityCode.to_code(string)

data/lib/arbetsformedlingen/models/model.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Arbetsformedlingen
   class Model
     def self.from_schema(schema)

data/lib/arbetsformedlingen/models/packet.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'builder'
 require 'arbetsformedlingen/models/packet_xml_builder'
 
@@ -5,7 +7,7 @@ module Arbetsformedlingen
   PacketSchema = Dry::Validation.Params do
     configure do
       config.type_specs = true
-      config.messages_file = File.expand_path('../../../../config/locales/errors.yml', __FILE__)
+      config.messages_file = File.expand_path('../../../config/locales/errors.yml', __dir__)
 
       predicates(Predicates)
     end

data/lib/arbetsformedlingen/models/packet_xml_builder.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'builder'
 
 module Arbetsformedlingen
@@ -47,7 +49,7 @@ module Arbetsformedlingen
     end
 
     def append_job_position(payload, packet_data)
-      payload.JobPositionPosting(status: "#{'in' unless packet_data.fetch(:active)}active") do |pos|
+      payload.JobPositionPosting(status: "#{'in' unless packet_data.fetch(:active)}active") do |pos| # rubocop:disable Metrics/LineLength
         cin = packet_data[:position][:company].fetch(:cin_arbetsformedlingen)
         job_pos_id = "#{cin}-#{packet_data.fetch(:job_id)}"
         pos.JobPositionPostingId(job_pos_id)
@@ -65,7 +67,10 @@ module Arbetsformedlingen
           if description = company.fetch(:description, nil)
             jpp.HiringOrgDescription(description)
           end
-          jpp.OccupationGroup(code: packet_data.fetch(:occupation), codename: 'OccupationNameID')
+          jpp.OccupationGroup(
+            code: packet_data.fetch(:occupation),
+            codename: 'OccupationNameID'
+          )
         end
       end
     end
@@ -87,7 +92,7 @@ module Arbetsformedlingen
 
       payload.HiringOrg do |org|
         org.HiringOrgName(company.fetch(:name))
-        org.HiringOrgId(company.fetch(:cin_arbetsformedlingen), idOwner: company.fetch(:cin))
+        org.HiringOrgId(company.fetch(:cin_arbetsformedlingen), idOwner: company.fetch(:cin)) # rubocop:disable Metrics/LineLength
         append_company_contact(org, company)
       end
     end