arbetsformedlingen 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e3a327d58c944a64b80dc83c3eb7d76975e2aef1420850196402399e13ef37d6
-  data.tar.gz: 5c4dc5b645841519b196715a395dd27bcf9cccac7780c6efa2d928edb6afca4f
+  metadata.gz: 12c4c0e865fa8cc5a666fbc8089cb02fff2e1e95050e97ee2de84a47728e1aa3
+  data.tar.gz: 2a44cd44d1c8586067b181d3c2ff5e404cb2abb91d09c566465bb5fda09d6a1f
 SHA512:
-  metadata.gz: e3711ebeb2278561d658203eb9ea3488110c047c71cc10aa84242d8b80d014af9248d3e8c14e7cdc0d75e91d348df3121eefc2d80d7c727979ca7f7bdf6dfc5c
-  data.tar.gz: 96ad25ccd528a702bc1e0f3a7c918a236e86e74560f297dcef3966e30b5501dfc249e350adbfdb8ff5310bcc1f777298a8c9814f00a0160ff4458e983a835d72
+  metadata.gz: 887828b878412c4ebfec3130c910f1030e58f15367254298f160addbed4c6f81b4f4df48963cb2045179af5b87573e447fddd2fcd6010a42906e04de71eff1c5
+  data.tar.gz: de32a1fd18c3de44f1cddf677f20c47f79b96e01d5cc4c797256d11832e777d05ff5974713222574d7101d63ff1b856111a45fd7b029ca81b6cf91d8e86d1590

data/.rubocop.yml

@@ -0,0 +1,6 @@
+inherit_from: .ruby-style-guide.yml
+AllCops:
+  UseCache: true
+  CacheRootDirectory: tmp
+  Exclude:
+    - 'tmp/*.rb'

data/.ruby-style-guide.yml

@@ -0,0 +1,270 @@
+Rails:
+  Enabled: false
+AllCops:
+  TargetRubyVersion: 2.3
+  Exclude:
+    - "vendor/**/*"
+  UseCache: true
+Style/CollectionMethods:
+  Description: Preferred collection methods.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#map-find-select-reduce-size
+  Enabled: true
+  PreferredMethods:
+    collect: map
+    collect!: map!
+    find: detect
+    find_all: select
+    reduce: inject
+Style/RedundantFreeze:
+  Description: "Checks usages of Object#freeze on immutable objects."
+  Enabled: false
+Layout/DotPosition:
+  Description: Checks the position of the dot in multi-line method calls.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#consistent-multi-line-chains
+  Enabled: true
+  EnforcedStyle: trailing
+  SupportedStyles:
+  - leading
+  - trailing
+Naming/FileName:
+  Description: Use snake_case for source file names.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#snake-case-files
+  Enabled: false
+  Exclude: []
+Naming/MemoizedInstanceVariableName:
+  Description: Memoized method name should match memo instance variable name.
+  Enabled: false
+Naming/UncommunicativeMethodParamName:
+  Description: >-
+                Checks for method parameter names that contain capital letters,
+                end in numbers, or do not meet a minimal length.
+  Enabled: false
+Style/AsciiComments:
+  Description: This cop checks for non-ascii (non-English) characters in comments.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-nested-conditionals
+  AllowedChars:
+    - å
+    - ä
+    - ö
+  Enabled: true
+Style/GuardClause:
+  Description: Check for conditionals that can be replaced with guard clauses
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-nested-conditionals
+  Enabled: true
+  MinBodyLength: 3
+Style/IfUnlessModifier:
+  Description: Favor modifier if/unless usage when you have a single-line body.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#if-as-a-modifier
+  Enabled: false
+Style/OptionHash:
+  Description: Don't use option hashes when you can use keyword arguments.
+  Enabled: false
+Style/PercentLiteralDelimiters:
+  Description: Use `%`-literal delimiters consistently
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#percent-literal-braces
+  Enabled: false
+  PreferredDelimiters:
+    "%": "()"
+    "%i": "()"
+    "%q": "()"
+    "%Q": "()"
+    "%r": "{}"
+    "%s": "()"
+    "%w": "()"
+    "%W": "()"
+    "%x": "()"
+Naming/PredicateName:
+  Description: Check the names of predicate methods.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#bool-methods-qmark
+  Enabled: true
+  NamePrefix:
+  - is_
+  - has_
+  - have_
+  NamePrefixBlacklist:
+  - is_
+  Exclude:
+  - spec/**/*
+Style/RaiseArgs:
+  Description: Checks the arguments passed to raise/fail.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#exception-class-messages
+  Enabled: false
+  EnforcedStyle: exploded
+  SupportedStyles:
+  - compact
+  - exploded
+Style/SignalException:
+  Description: Checks for proper usage of fail and raise.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#fail-method
+  Enabled: false
+  EnforcedStyle: semantic
+  SupportedStyles:
+  - only_raise
+  - only_fail
+  - semantic
+Style/SingleLineBlockParams:
+  Description: Enforces the names of some block params.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#reduce-blocks
+  Enabled: false
+  Methods:
+  - reduce:
+    - a
+    - e
+  - inject:
+    - a
+    - e
+Style/TrivialAccessors:
+  Enabled: false
+Style/SingleLineMethods:
+  Description: Avoid single-line methods.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-single-line-methods
+  Enabled: false
+  AllowIfMethodIsEmpty: true
+Style/StringLiterals:
+  Description: Checks if uses of quotes match the configured preference.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#consistent-string-literals
+  Enabled: true
+  EnforcedStyle: single_quotes
+  SupportedStyles:
+  - single_quotes
+  - double_quotes
+Style/MixinUsage:
+  Enabled: true
+  Exclude:
+    - exe/*
+Style/StringLiteralsInInterpolation:
+  Description: Checks if uses of quotes inside expressions in interpolated strings
+    match the configured preference.
+  Enabled: true
+  EnforcedStyle: single_quotes
+  SupportedStyles:
+  - single_quotes
+  - double_quotes
+Style/TrailingCommaInArrayLiteral:
+  Description: Checks for trailing comma in parameter lists and literals.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-trailing-array-commas
+  Enabled: true
+  EnforcedStyleForMultiline: comma
+Style/TrailingCommaInHashLiteral:
+  Description: Checks for trailing comma in parameter lists and literals.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-trailing-array-commas
+  Enabled: true
+  EnforcedStyleForMultiline: comma
+Metrics/AbcSize:
+  Description: A calculated magnitude based on number of assignments, branches, and
+    conditions.
+  Enabled: false
+  Max: 15
+Metrics/ClassLength:
+  Description: Avoid classes longer than 100 lines of code.
+  Enabled: false
+  CountComments: false
+  Max: 100
+Metrics/ModuleLength:
+  CountComments: false
+  Max: 100
+  Description: Avoid modules longer than 100 lines of code.
+  Enabled: false
+Metrics/CyclomaticComplexity:
+  Description: A complexity metric that is strongly correlated to the number of test
+    cases needed to validate a method.
+  Enabled: false
+  Max: 6
+Metrics/MethodLength:
+  Description: Avoid methods longer than 10 lines of code.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#short-methods
+  Enabled: false
+  CountComments: false
+  Max: 10
+Metrics/ParameterLists:
+  Description: Avoid parameter lists longer than three or four parameters.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#too-many-params
+  Enabled: false
+  Max: 5
+  CountKeywordArgs: true
+Metrics/PerceivedComplexity:
+  Description: A complexity metric geared towards measuring complexity for a human
+    reader.
+  Enabled: false
+  Max: 7
+Metrics/LineLength:
+  Description: Maximum line length
+  Enabled: true
+  Max: 95
+  Exclude:
+  - Gemfile
+  - arbetsformedlingen.gemspec
+  - spec/**/*
+Metrics/BlockLength:
+  Enabled: true
+  Exclude:
+  - spec/**/*
+Lint/AssignmentInCondition:
+  Description: Don't use assignment in conditions.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#safe-assignment-in-condition
+  Enabled: false
+  AllowSafeAssignment: true
+Style/InlineComment:
+  Description: Avoid inline comments.
+  Enabled: false
+Naming/AccessorMethodName:
+  Description: Check the naming of accessor methods for get_/set_.
+  Enabled: false
+Style/Alias:
+  Description: Use alias_method instead of alias.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#alias-method
+  Enabled: false
+Style/Documentation:
+  Description: Document classes and non-namespace modules.
+  Enabled: false
+Style/DoubleNegation:
+  Description: Checks for uses of double negation (!!).
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-bang-bang
+  Enabled: false
+Style/EachWithObject:
+  Description: Prefer `each_with_object` over `inject` or `reduce`.
+  Enabled: false
+Style/EmptyLiteral:
+  Description: Prefer literals to Array.new/Hash.new/String.new.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#literal-array-hash
+  Enabled: false
+Style/ModuleFunction:
+  Description: Checks for usage of `extend self` in modules.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#module-function
+  Enabled: false
+Style/OneLineConditional:
+  Description: Favor the ternary operator(?:) over if/then/else/end constructs.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#ternary-operator
+  Enabled: false
+Style/PerlBackrefs:
+  Description: Avoid Perl-style regex back references.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-perl-regexp-last-matchers
+  Enabled: false
+Style/Send:
+  Description: Prefer `Object#__send__` or `Object#public_send` to `send`, as `send`
+    may overlap with existing methods.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#prefer-public-send
+  Enabled: false
+Style/SpecialGlobalVars:
+  Description: Avoid Perl-style global variables.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-cryptic-perlisms
+  Enabled: false
+Style/VariableInterpolation:
+  Description: Don't interpolate global, instance and class variables directly in
+    strings.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#curlies-interpolate
+  Enabled: false
+Style/WhenThen:
+  Description: Use when x then ... for one-line cases.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#one-line-cases
+  Enabled: false
+Lint/EachWithObjectArgument:
+  Description: Check for immutable argument given to each_with_object.
+  Enabled: true
+Lint/HandleExceptions:
+  Description: Don't suppress exception.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#dont-hide-exceptions
+  Enabled: false
+Lint/LiteralInInterpolation:
+  Description: Checks for literals used in interpolation.
+  Enabled: false

data/.travis.yml

@@ -2,6 +2,5 @@ sudo: false
 language: ruby
 rvm:
   - 2.3.0
-  - 2.4.0
   - 2.5.0
 before_install: gem install bundler -v 1.6.1

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 # Change Log
 
+# v0.6.0
+
+* Return "empty result" object when no results are found
+* Fix `workplace.contacts` - [PR #14](https://github.com/buren/arbetsformedlingen/pull/14)
+* Fix crashes when ad data doesn't contain some keys  - [PR #15](https://github.com/buren/arbetsformedlingen/pull/15), [PR #11](https://github.com/buren/arbetsformedlingen/pull/11)
+* Replace `URI#encode` with `#encode_www_form_component`
+* Add `WSOccupationClient` docs
+* Refactor `SOAPRequest` to use new `API::Reponse#xml` method
+* Add `#response` to `SoklistaPage`, `MatchningPage`, `AdResult` and `Values::Ad`
+* Proper `API::Response` class
+* Introduce `MatchningPage` `#success?` and `#response`
+
 # v0.5.0
 
 * Upgrade `dry-valdation` dependency from `~> 0.11` to `~> 0.12`

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in arbetsformedlingen.gemspec

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2017 Jacob Burenstam
+Copyright (c) 2018 Jacob Burenstam Linder
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -201,7 +201,7 @@ This gem has translated the attribute names in Arbetsförmedlingens (AF) API fro
 
 | Arbetsförmedlingen Term | Gem term           |
 |------------------------ |--------------------|
-| landområde/värdsdel | areas |
+| landområde/värdsdel | areas |
 | kommun | municipality |
 | län | counties |
 | län2 | counties2 |

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 

data/arbetsformedlingen.gemspec

@@ -1,6 +1,6 @@
-# coding: utf-8
+# frozen_string_literal: true
 
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'arbetsformedlingen/version'
 
@@ -11,7 +11,7 @@ Gem::Specification.new do |spec|
   spec.email         = ['burenstam@gmail.com']
 
   spec.summary       = 'Arbetsförmedlingen API client'
-  spec.description   = 'Arbetsförmedlingen API client (Swedish Public Employment Service)'
+  spec.description   = 'Arbetsförmedlingen API client (Swedish Public Employment Service). Post job ads, Platsannons (ads) API client and WSOccupation SOAP API client.'
   spec.homepage      = 'https://github.com/buren/arbetsformedlingen'
   spec.license       = 'MIT'
 
@@ -22,15 +22,16 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = %w[lib config]
 
-  spec.add_dependency 'httparty', '~> 0.13' # Easy HTTP requests
-  spec.add_dependency 'dry-validation', '~> 0.12'
   spec.add_dependency 'builder', '~> 3.2'
+  spec.add_dependency 'dry-validation', '~> 0.12'
+  spec.add_dependency 'httparty', '~> 0.13' # Easy HTTP requests
 
-  spec.add_development_dependency 'nokogiri', '~> 1.8'
   spec.add_development_dependency 'bundler', '~> 1.14'
+  spec.add_development_dependency 'byebug'
+  spec.add_development_dependency 'nokogiri', '~> 1.8'
   spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'rspec', '~> 3.0'
-  spec.add_development_dependency 'webmock', '~> 3.1'
+  spec.add_development_dependency 'rspec', '~> 3.8'
+  spec.add_development_dependency 'rubocop', '~> 0.59'
   spec.add_development_dependency 'vcr', '~> 3.0'
-  spec.add_development_dependency 'byebug'
+  spec.add_development_dependency 'webmock', '~> 3.1'
 end

data/bin/console

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require 'bundler/setup'
 require 'arbetsformedlingen'

data/lib/arbetsformedlingen/api/client.rb

@@ -1,6 +1,6 @@
+# frozen_string_literal: true
+
 require 'uri'
-require 'net/http'
-require 'json'
 
 require 'arbetsformedlingen/api/request'
 
@@ -14,11 +14,14 @@ require 'arbetsformedlingen/api/ledigtarbete_client'
 
 module Arbetsformedlingen
   module API
+    # Main API client
     class Client
+      # Base URL for platsannonser
       BASE_URL = 'http://api.arbetsformedlingen.se/af/v0/platsannonser/'.freeze
 
       attr_reader :request, :locale
 
+      # Initialize client
       def initialize(locale: 'sv')
         @request = Request.new(base_url: BASE_URL, locale: locale)
         @locale = locale
@@ -33,7 +36,7 @@ module Arbetsformedlingen
       end
 
       # Post ad to API (ad => annons)
-      # @return [AdResult] the result.
+      # @return [Values::CreateAdPage] the result.
       # @param [Arbetsformedlingen::Packet] Packet object.
       # @example Post ad
       #    client.ad(packet)
@@ -43,132 +46,147 @@ module Arbetsformedlingen
       end
 
       # Fetch ad from API (ad => annons)
-      # @return [AdResult] the result.
+      # @return [Values::Ad] the result.
       # @param id [String] Ad ID.
       # @example Get ad
       #    client.ad(id: id)
+      # @see Values::Ad
       def ad(id:)
         response = request.get(id)
 
-        AdResult.build(response.json)
+        AdResult.build(response)
       end
 
-      # Fetch ads from API (areas => landområde/värdsdel)
-      # @return [MatchningResult] the result.
-      # @see MatchningClient#ads
-      # @see MatchningResult#build
+      # Fetch ads from API (areas => landområde/värdsdel)
+      # @return [Values::MatchningPage] the result.
+      # @see Values::MatchningPage
       def ads(**args)
         client = MatchningClient.new(request: request)
         client.ads(**args)
       end
 
-      # Fetch areas from API (areas => landområde/värdsdel)
-      # @return [AdResult] the result.
+      # Fetch areas from API (areas => landområde/värdsdel)
+      # @return [Values::SoklistaPage] the result.
       # @example Get areas
       #    client.areas
+      # @see Values::SoklistaPage
       def areas
         response = request.get('soklista/omrade')
 
-        SoklistaResult.build(response.json, list_name: 'omrade')
+        SoklistaResult.build(response, list_name: 'omrade')
       end
 
       # Fetch counties from API (countries => land)
-      # @return [AdResult] the result.
+      # @return [Values::SoklistaPage] the result.
       # @param area_id [String] Area ID.
       # @example Get countries within area
       #    client.countries(area_id: id)
+      # @see Values::SoklistaPage
       def countries(area_id:)
         query = { omradeid: area_id }
         response = request.get('soklista/land', query: query)
 
-        SoklistaResult.build(response.json, list_name: 'land')
+        SoklistaResult.build(response, list_name: 'land')
       end
 
       # Fetch municipalities from API (municipality => kommun)
-      # @return [AdResult] the result.
+      # @return [Values::SoklistaPage] the result.
       # @param county_id [String] County ID.
       # @example Get counties
       #    client.counties
+      # @see Values::SoklistaPage
       def municipalities(county_id: nil)
         # NOTE: Due to a quirck in the API the lanid-param
         #       *must* be present though it *can* be nil
         query = { lanid: county_id }
         response = request.get('soklista/kommuner', query: query)
 
-        SoklistaResult.build(response.json, list_name: 'kommuner')
+        SoklistaResult.build(response, list_name: 'kommuner')
       end
 
       # Fetch counties from API (county => län)
-      # @return [AdResult] the result.
+      # @return [Values::SoklistaPage] the result.
       # @example Get counties
       #    client.counties
+      # @see Values::SoklistaPage
       def counties
         response = request.get('soklista/lan')
 
-        SoklistaResult.build(response.json, list_name: 'lan')
+        SoklistaResult.build(response, list_name: 'lan')
       end
 
       # Fetch counties2 from API (county2 => län2)
-      # @return [AdResult] the result.
+      # @return [Values::SoklistaPage] the result.
       # @example Get counties2
       #    client.counties2
+      # @see Values::SoklistaPage
       def counties2
         response = request.get('soklista/lan2')
 
-        SoklistaResult.build(response.json, list_name: 'lan2')
+        SoklistaResult.build(response, list_name: 'lan2')
       end
 
-      # Fetch occupational fields from API (occupational_fields => yrkesområde)
-      # @return [AdResult] the result.
+      # Fetch occupational fields from API (occupational_fields => yrkesområde)
+      # @return [Values::SoklistaPage] the result.
       # @example Get occupational fields
       #    client.occupational_field
+      # @see Values::SoklistaPage
       def occupational_fields
         response = request.get('soklista/yrkesomraden')
 
-        SoklistaResult.build(response.json, list_name: 'yrkesomraden')
+        SoklistaResult.build(response, list_name: 'yrkesomraden')
       end
 
       # Fetch occupational group from API (occupational_group => yrkesgrupp)
-      # @return [AdResult] the result.
+      # @return [Values::SoklistaPage] the result.
       # @param occupational_field_id [String] Occupational field ID.
       # @example Get all occupational group
       #    client.occupational_group
       # @example Get occupational group within occupational field
       #    client.occupational_group(occupational_field_id: id)
+      # @see Values::SoklistaPage
       def occupational_group(occupational_field_id: nil)
         # NOTE: Due to a quirck in the API the yrkesomradeid-param
         #       *must* be present though it *can* be nil
         query = { yrkesomradeid: occupational_field_id }
         response = request.get('soklista/yrkesgrupper', query: query)
 
-        SoklistaResult.build(response.json, list_name: 'yrkesgrupper')
+        SoklistaResult.build(response, list_name: 'yrkesgrupper')
       end
 
       # Fetch occupation from API (occupation => yrkesnamn)
-      # @return [AdResult] the result.
+      # @return [Values::SoklistaPage] the result.
       # @param name [String] Name of the occupation.
       # @example Get occupation
       #    client.occupation(name: 'Marknadskommunikatör')
+      # @see Values::SoklistaPage
       def occupation(name:)
-        response = request.get("soklista/yrken/#{URI.encode(name)}")
+        response = request.get("soklista/yrken/#{uri_escape(name)}")
 
-        SoklistaResult.build(response.json, list_name: 'Yrken')
+        SoklistaResult.build(response, list_name: 'Yrken')
       end
 
       # Fetch occupations from API (occupation => yrkesnamn)
-      # @return [AdResult] the result.
+      # @return [Values::SoklistaPage] the result.
       # @param occupational_group_id [String] Occupational group ID.
       # @example Get stats of available positions for all occupations
       #    client.occupations
       # @example Get stats of available positions for some occupations
       #    client.occupations(occupational_group_id: id)
+      # @see Values::SoklistaPage
       def occupations(occupational_group_id: nil)
         # NOTE: Due to a quirck in the API the yrkesgruppid-param
         #       *must* be present though it *can* be nil
         query = { yrkesgruppid: occupational_group_id }
         response = request.get('soklista/yrken', query: query)
 
-        SoklistaResult.build(response.json, list_name: 'yrken')
+        SoklistaResult.build(response, list_name: 'yrken')
+      end
+
+      private
+
+      def uri_escape(string)
+        URI.encode_www_form_component(string)
       end
     end
   end