arbetsformedlingen 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 12c4c0e865fa8cc5a666fbc8089cb02fff2e1e95050e97ee2de84a47728e1aa3
-  data.tar.gz: 2a44cd44d1c8586067b181d3c2ff5e404cb2abb91d09c566465bb5fda09d6a1f
+  metadata.gz: 15dfcdcd827c97239a8d14df13084de7bc96980824b7304efb5ddb4d11d640bd
+  data.tar.gz: 56eaa06682c5b5b7b31cf6f0ba21e12a657f1a92bbfa1622530fc1ba4f6fc37b
 SHA512:
-  metadata.gz: 887828b878412c4ebfec3130c910f1030e58f15367254298f160addbed4c6f81b4f4df48963cb2045179af5b87573e447fddd2fcd6010a42906e04de71eff1c5
-  data.tar.gz: de32a1fd18c3de44f1cddf677f20c47f79b96e01d5cc4c797256d11832e777d05ff5974713222574d7101d63ff1b856111a45fd7b029ca81b6cf91d8e86d1590
+  metadata.gz: 24713c7b92467e96a039bb6e68a5f91eebdc8e7ccef3288af4844998ce4f28baff1d9d2fa2b982358d1384b69da2970e0e8b66924c9ca6ef2e103ce9afc8e4f3
+  data.tar.gz: 790862d6b086c93e9a98cdcca33440a6d742bafcc13360dc1c20bf86d9b000594045f83903c52b25e34f6c114c2036d066bfa213a70786dc59749dc9da43b76a

data/.hound.yml

@@ -0,0 +1,2 @@
+rubocop:
+  config_file: .rubocop.yml

data/.travis.yml

@@ -1,6 +1,7 @@
 sudo: false
 language: ruby
+cache: bundler
 rvm:
   - 2.3.0
   - 2.5.0
-before_install: gem install bundler -v 1.6.1
+before_install: gem install bundler

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 # Change Log
 
+# v0.7.0
+
+This is a pretty big release that adds support Ontology and Taxonomy APIs and completes WSOccupation :tada:
+
+* Implement Ontology API
+* Implement Taxonomy API (84 endpoints!)
+* Implement remaining WSOccupation API endpoints
+* Add `Response#uri` method
+* Improved documentation
+
 # v0.6.0
 
 * Return "empty result" object when no results are found

data/README.md

@@ -2,36 +2,17 @@
 
 Arbetsförmedlingen API client (Swedish Public Employment Service).
 
-__Features__
-* Post job ad (a.k.a Direktöverförda annonser)
-* Platsannons API Client
-* WSOccupation SOAP API Client
-
-
 __Index__
 * [Installation](#installation)
-* [API Client](#api-client)
-* [Post job ad](#post-job-ad)
-* [WSOccupation API Client](#wsoccupation-api-client)
+* [Post job ad](#post-job-ad) (a.k.a Direktöverförda annonser)
+* [API clients for](#api-clients)
+  + [Platsannonser/Platsbanken](#api-clients)
+  * [Ontology](#ontology-api-client)
+  * [Taxonomy (SOAP)](#taxonomy-api-client)
+  * [WSOccupation (SOAP)](#wsoccupation-api-client)
 * [RDoc](http://www.rubydoc.info/gems/arbetsformedlingen/).
 
-## Installation
-
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'arbetsformedlingen'
-```
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install arbetsformedlingen
-
-## API Client
+## API Clients
 
 __Create a client:__
 
@@ -63,121 +44,21 @@ end
 
 ## Post job ad
 
+:warning: In order to post live job ads to Arbetsförmedlingen you need to contact them and go through a test procedure. You can find their own documentation and some additional notes [here](https://goo.gl/c5jtBv).
+
+You can find Arbetsförmedlingens own documentation and some additional notes [here](https://goo.gl/c5jtBv). Note that the documentation provided by Arbetsförmedlingen can be pretty hard to follow.
+
+__Validation support__
+All models used to create a job ad include validations. _A lot_ of work was put into finding all the quirks in the API and adding each validation to its corresponding model. I can't recommend using it enough.
+
 __Complete example creating a packet__
 
-:information_source: There is quite a lot of data you can/must send to the API when creating an ad.
+There's a lot of data you can/must send to the API when creating an ad. See files in `lib/arbetsformedlingen/models` for details.
 
-```ruby
-require 'date'
-require 'arbetsformedlingen'
-
-include Arbetsformedlingen # just for brevity
-
-document = Document.new(
-  customer_id: 'XXXYYYZZZ',
-  email: 'a@example.com'
-)
-
-company = Company.new(
-  name: 'ACME AB',
-  cin: 'XXYYZZXXYY',
-  description: 'A company description',
-  address: {
-    country_code: 'SE',
-    zip: '11356',
-    municipality: 'Stockholm',
-    street: 'Birger Jarlsgatan 57',
-    city: 'stockholm'
-  }
-)
-
-publication = Publication.new(
-  publish_at_date: Date.today,
-  name: 'John Doe',
-  email: 'john@example.com'
-)
-
-schedule = Schedule.new(
-  full_time: false,
-  summary: '3 days a week 8.00-17.00',
-  start_date: Date.today,
-  end_date: nil
-)
-
-salary = Salary.new(
-  currency: 'SEK',
-  type: :fixed, # :fixed, :fixed_and_commission, :commission
-  summary: 'Your salary will be...'
-)
-
-qualifications = []
-qualifications << Qualification.new(
-  summary: 'A summary', # optional, but recommended field
-  required: true,
-  experience: true,
-  drivers_license: 'B,C1',
-  car: true
-)
-
-qualifications << Qualification.new(
-  summary: 'A summary', # optional, but recommended field
-  required: false
-)
-
-application_method = ApplicationMethod.new(
-  external: true, # applications are not made through AF
-  url: 'https://example.com',
-  summary: 'Goto our website'
-)
-
-position = Position.new(
-  company: company,
-  schedule: schedule,
-  salary: salary,
-  qualifications: qualifications,
-  application_method: application_method,
-  attributes: {
-    title: 'A title',
-    purpose: 'A purpose',
-    address: {
-      country_code: 'SE',
-      zip: '11356',
-      municipality: 'Stockholm',
-      street: 'Birger Jarlsgatan 57',
-      city: 'stockholm'
-    }
-  }
-)
-
-packet = Packet.new(
-  publication: publication,
-  document: document,
-  position: position,
-  attributes: {
-    active: true,
-    job_id: 1,
-    number_to_fill: 1,
-    occupation: '4896'
-  }
-)
-
-puts "salary.valid?: #{salary.valid?}"
-puts "schedule.valid?: #{schedule.valid?}"
-puts "publication.valid?: #{publication.valid?}"
-puts "document.valid?: #{document.valid?}"
-puts "company.valid?: #{company.valid?}"
-puts "application_method.valid?: #{application_method.valid?}"
-puts "position.valid?: #{position.valid?}"
-puts "packet.valid?: #{packet.valid?}"
-
-client = API::Client.new(locale: 'sv')
-client.create_ad(packet)
-```
+[See full example](examples/post_job_ad.rb).
 
 ## WSOccupation API Client
 
-There is some support for Arbetsförmedlingen's `WSOccupation` SOAP API. See [PR#3](https://github.com/buren/arbetsformedlingen/pull/3).
-
 ```ruby
 client = Arbetsformedlingen::API::WSOccupationClient.new
 response = client.occupations
@@ -185,7 +66,35 @@ response.xml.css('Name').first.text
 # => "Landskapsarkitekter och landskapsingenjörer"
 ```
 
-[WSOccupationClient documentation](http://www.rubydoc.info/gems/arbetsformedlingen/Arbetsformedlingen/API/WSOccupationClient).
+[`WSOccupationClient` documentation](http://www.rubydoc.info/gems/arbetsformedlingen/Arbetsformedlingen/API/WSOccupationClient).
+
+:link: [Arbetsformedlingen WsOccupation API documentation](https://api.arbetsformedlingen.se/af/v0/Occupation/wsoccupation.asmx)
+
+## Ontology API Client
+
+```ruby
+client = Arbetsformedlingen::API::OntologyClient.new
+response = client.concepts(filter: 'ruby', type: 'skill')
+response.json
+# => [{"uuid"=>"035fc466-605e-5684-a106-a458929f27c6", "name"=>"Ruby", "type"=>"skill"}, ...]
+```
+
+[`OntologyClient` documentation](http://www.rubydoc.info/gems/arbetsformedlingen/Arbetsformedlingen/API/WSOccupationClient).
+
+:link: [Arbetsformedlingen Ontology API documentation](http://ontologi.arbetsformedlingen.se/ontology/v1/?url=swagger.json#/Ontology)
+
+## Taxonomy API Client
+
+```ruby
+client = Arbetsformedlingen::API::TaxonomyClient.new
+response = client.occupation_names(language_id: 502) # sv language id
+response.xml.css('OccupationName Term').first.text
+# => "1:e Fartygsingenjör/1:e Maskinist"
+```
+
+[`TaxonomyClient` documentation](http://www.rubydoc.info/gems/arbetsformedlingen/Arbetsformedlingen/API/WSOccupationClient).
+
+:link: [Arbetsformedlingen TaxonomiService API documentation](http://api.arbetsformedlingen.se/taxonomi/v0/TaxonomiService.asmx)
 
 ## Notes
 
@@ -210,6 +119,21 @@ This gem has translated the attribute names in Arbetsförmedlingens (AF) API fro
 | yrkesgrupp | occupational_group |
 | yrkesnamn | occupation |
 
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'arbetsformedlingen'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install arbetsformedlingen
 
 ## Development
 

data/bin/seed

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'arbetsformedlingen'
+require 'csv'
+
+SWEDISH_LANGUAGE_ID = 502
+
+client = Arbetsformedlingen::API::TaxonomyClient.new
+occupation_name_response = client.occupation_names(language_id: SWEDISH_LANGUAGE_ID)
+
+CSV.open(Arbetsformedlingen::OccupationCode::DATA_PATH, 'w') do |csv|
+  occupation_name_response.xml.css('OccupationName').each do |node|
+    csv << [node.css('OccupationNameID').text, node.css('Term').text]
+  end
+end

data/examples/post_job_ad.rb

@@ -0,0 +1,107 @@
+# frozen_string_literal: true
+
+require 'date'
+require 'arbetsformedlingen'
+
+AF = Arbetsformedlingen # for brevity
+
+document = AF::Document.new(
+  customer_id: 'XXXYYYZZZ',
+  email: 'a@example.com'
+)
+
+company = AF::Company.new(
+  name: 'ACME AB',
+  cin: 'XXYYZZXXYY',
+  description: 'A company description',
+  address: {
+    country_code: 'SE',
+    zip: '11356',
+    municipality: 'Stockholm',
+    street: 'Birger Jarlsgatan 57',
+    city: 'stockholm',
+  }
+)
+
+publication = AF::Publication.new(
+  publish_at: Date.today,
+  unpublish_at: Date.today + 21,
+  name: 'John Doe',
+  email: 'john@example.com'
+)
+
+schedule = AF::Schedule.new(
+  full_time: false,
+  summary: '3 days a week 8.00-17.00',
+  start_date: Date.today,
+  end_date: nil
+)
+
+salary = AF::Salary.new(
+  currency: 'SEK',
+  type: :fixed, # :fixed, :fixed_and_commission, :commission
+  summary: 'Your salary will be...'
+)
+
+qualifications = []
+qualifications << AF::Qualification.new(
+  summary: 'A summary', # optional, but recommended field
+  required: true,
+  experience: true,
+  drivers_license: 'B,C1',
+  car: true
+)
+
+qualifications << AF::Qualification.new(
+  summary: 'A summary', # optional, but recommended field
+  required: false
+)
+
+application_method = AF::ApplicationMethod.new(
+  external: true, # applications are not made through AF
+  url: 'https://example.com',
+  summary: 'Goto our website'
+)
+
+position = AF::Position.new(
+  company: company,
+  schedule: schedule,
+  salary: salary,
+  qualifications: qualifications,
+  application_method: application_method,
+  attributes: {
+    title: 'A title',
+    purpose: 'A purpose',
+    address: {
+      country_code: 'SE',
+      zip: '11356',
+      municipality: 'Stockholm',
+      street: 'Birger Jarlsgatan 57',
+      city: 'stockholm',
+    },
+  }
+)
+
+packet = AF::Packet.new(
+  publication: publication,
+  document: document,
+  position: position,
+  attributes: {
+    active: true,
+    job_id: 1,
+    number_to_fill: 1,
+    occupation: '4896',
+  }
+)
+
+puts "salary.valid?: #{salary.valid?}"
+puts "schedule.valid?: #{schedule.valid?}"
+puts "publication.valid?: #{publication.valid?}"
+puts "document.valid?: #{document.valid?}"
+puts "company.valid?: #{company.valid?}"
+puts "application_method.valid?: #{application_method.valid?}"
+puts "position.valid?: #{position.valid?}"
+puts "packet.valid?: #{packet.valid?}"
+
+client = API::AF::Client.new(locale: 'sv')
+client.create_ad(packet)

data/lib/arbetsformedlingen.rb

@@ -32,7 +32,9 @@ require 'arbetsformedlingen/models/packet'
 
 # API Client
 require 'arbetsformedlingen/api/client'
+require 'arbetsformedlingen/api/ontology_client'
 require 'arbetsformedlingen/api/ws_occupation_client'
+require 'arbetsformedlingen/api/taxonomy_client'
 
 module Arbetsformedlingen
   class << self

data/lib/arbetsformedlingen/api/base_soap_client.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require 'arbetsformedlingen/soap_builder'
+require 'arbetsformedlingen/api/soap_request'
+
+module Arbetsformedlingen
+  module API
+    # Base client for SOAP clients
+    class BaseSOAPClient
+      attr_reader :request, :namespace, :service_url
+
+      # Initialize client
+      def initialize(url, namespace)
+        @service_url = url
+        @namespace = namespace
+        @request = SOAPRequest.new(url)
+      end
+
+      # Perform client request
+      # @param [String] name of the main node
+      # @param args [Hash] optional arguments
+      # @return [Response]
+      def client_request(name, args: {})
+        soap_body = SOAPBuilder.wrap do |body| # rubocop:disable Lint/UnusedBlockArgument
+          # HACK: Work around the XMLBuilder DSL
+          ruby_statements = args.map do |key, value|
+            if value.is_a?(Array)
+              inner_ruby_statements = value.map do |(k, v)|
+                "inode.#{k}('#{v}')"
+              end
+
+              <<~RUBY_EVAL
+                node.#{key} { |inode| #{inner_ruby_statements.join(';')} }
+              RUBY_EVAL
+            else
+              "node.#{key}('#{value}')"
+            end
+          end
+
+          ruby_xml_builder_code = <<~RUBY_EVAL
+            body.#{name}(xmlns: namespace) { |node| #{ruby_statements.join(';')} }
+          RUBY_EVAL
+
+          instance_eval(ruby_xml_builder_code)
+        end
+
+        request.post(soap_body.to_xml)
+      end
+    end
+  end
+end