ba_upload 0.2.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1c3d318a7143720be35bdd9460675ffa7eeed8d8ebd592c6c120d00067e3893e
-  data.tar.gz: 67bbda23c6a00cd00e3b5e1f0310ff27833f782303f37e75e9e7a18b68783986
+  metadata.gz: cceefb5de17f2e510d450c83e0ab44a231c23f8024f3b86c1cf4e55c9e2bee32
+  data.tar.gz: 29f249da985d7e5213f1cdc8f56f0d1dfc3e352f26823731413ba66506e6672d
 SHA512:
-  metadata.gz: 5a797ecf7a9fed238ecf08706adefa033f3ebdce51e2007a9215a77faf0a6d51cce0d143d7c1a1f19b2abf020437459e67cea69207474cacf00eaf96a54831e6
-  data.tar.gz: ceb746f9650c23e19b46a14c6f1d5d3837b4e80af1c4dba5e684cf744448f60ad88cbb520bb26561775f2c584f6a34d6e4b5794c55846187d8d8ab4565144eec
+  metadata.gz: d4ba083e3d90f2d5d750127892b914dba63678a0b4423755b08c455d467cba9e28e02eb4bd5a4d900e19572f258d1befe2109a67af5c144fe10a36e8597552c2
+  data.tar.gz: c45d8070153d9aca7842ede6b4dea90098608e6b078bdf4e4370a698e837b021382ddccdfe31b4f47c0121ea76e5e8749e15a86a6f8841f9022b635c7f8d6bca

data/README.md

@@ -33,7 +33,8 @@ require 'ba_upload'
 connection = BaUpload.open_connection(file_path: 'config/Zertifikat-1XXXX.p12', passphrase: 'YOURPASSPHRASE')
 
 # Upload a xml-file
-connection.upload(file: File.open('/opt/vam-transfer/data/DSP000132700_2016-08-08_05-00-09.xml'))
+file_path = "/opt/vam-transfer/data/DSP000132700_2016-08-08_05-00-09.xml"
+connection.upload(file: file_path))
 
 # later cronjob to download all error files
 
@@ -61,7 +62,7 @@ Save to a file and just run it with the xml file as argument
 
 BA provides a often updated Position description databae ("VAM" Berufe). The Gem can help to download it:
 
-```
+```ruby
 connection.misc.each do |link|
   target = "vendor/ba/#{link.href}"
   next if File.exist?(target)
@@ -70,6 +71,205 @@ connection.misc.each do |link|
 end
 ```
 
+### Usage with multiple client certificats
+
+Since September 2022, users with multiple client certificats issued to the same email address need to provide their respective partner ID when using the API.
+For user with only one certificat issued to their email address, providing the partner ID is optional.
+
+The partner ID can be provided as an optional keyword argument to the `upload`, `error_files` and `misc` methods:
+
+```ruby
+require 'ba_upload'
+connection = BaUpload.open_connection(file_path: 'config/Zertifikat-1XXXX.p12', passphrase: 'YOURPASSPHRASE')
+
+connection.upload(file: 'your_file_path', partner_id: 'P000XXXXXX')
+connection.error_files(partner_id: 'P000XXXXXX')
+connection.misc(partner_id: 'P000XXXXXX')
+
+```
+
+## Appendix: Berufe
+
+Sooner or later, you have to provide a TitleCode = Vocation "Beruf" for each job. To fetch and process the Berufe, we create a ActiveRecord Model in our database:
+
+Here an example of a implementation at Empfehlungsbund. You can also use our [search mask](https://login.empfehlungsbund.de/arbeitsagentur) to search for occupations.
+
+We put the "help" / "validation" messages, that we found in the appropriate scopes, too, as "Ausbildungen" and "Duale Studiengänge" need different types of professions.
+
+<details>
+<summary>ActiveRecord Model for Ba::Profession</summary>
+
+```ruby 
+# migration:
+create_table :ba_professions do |t|
+ t.string "bkz"
+ t.string "typ"
+ t.string "lbkgruppe"
+ t.string "hochschulberuf"
+ t.string "kuenstler"
+ t.string "bezeichnung_nl"
+ t.string "bezeichnung_nk"
+ t.string "suchname_nl"
+ t.datetime "created_at"
+ t.datetime "updated_at"
+ t.integer "ebene"
+ t.integer "qualifikationsniveau"
+ t.datetime "deleted_on"
+end
+
+class Ba::Profession < ApplicationRecord
+  has_many :jobs
+
+  scope :undeleted, -> { where 'deleted_on is null' }
+  scope :berufe, -> { where typ: 'B' }
+  scope :ausbildungen, -> { where typ: 'A' }
+  scope :sorted, -> { order(Arel.sql('deleted_on is not null, bezeichnung_nl')) }
+  # Bei Auswahl von „Ausbildung“ (EducationType=0) sind die Berufe mit dem
+  # Qualifikationsniveau 2 zulässig. Zusätzlich sind hier alle Berufe folgender
+  # berufskundlicher Gruppen erlaubt: [...]
+  scope :reine_ausbildungen, -> {
+    where(qualifikationsniveau: 2).or(
+      where(lbkgruppe: [1150, 3110, 5130])
+    ).ausbildungen
+  }
+  # Wird ein Stellenangebot vom Typ „Duales Studium“ (EducationType=1) übermittelt, sind der
+  # Studiengang und der ggf. vorhandene Ausbildungsberuf getrennt anzugeben. Als
+  # Studiengang (Course) sind Berufe mit ausschließlich dem Qualifikationsniveau 4 zulässig.
+  # Diese Berufe entstammen alle der berufskundlichen Gruppe 3120 („A Grundständige
+  # Studienfächer/-gänge“). Der als Ausbildung (TitleCode) angegebene Beruf darf
+  # dementsprechend nicht ausschließlich das Qualifikationsniveau 4 haben.
+  scope :duale_studiengaenge, -> { ausbildungen.where ebene: 3, qualifikationsniveau: 4 }
+
+  def duales_studium?
+    ebene == 3 && qualifikationsniveau == 4 && typ == 'A'
+  end
+
+  def self.download_from_ba
+    require 'tty/prompt'
+    prompt = TTY::Prompt.new
+    link = Ba::Distributor.ba_connection.misc.last do |link|
+    link.click
+    target = "public/ba/#{link.href}"
+    response = link.click
+    File.open(target, "wb+") { |f| f.write(response.body) }
+
+    puts "Unzipping vam_beruf_kurz.xml..."
+    `unzip -o -d public/ba/ #{target} vam_beruf_kurz.xml`
+  end
+
+  def self.import(path: 'public/ba/vam_beruf_kurz.xml')
+    doc = Nokogiri::XML.parse(File.open(path))
+    berufe_vorher = Ba::Beruf.undeleted.pluck(:id)
+    doc.search('beruf').each do |beruf_doc|
+      beruf = where(id: beruf_doc['id']).first_or_initialize
+
+      beruf.bkz = beruf_doc['bkz']
+
+      beruf.typ = beruf_doc.at('typ').text == 't' ? 'B' : 'A'
+      beruf.qualifikationsniveau = beruf_doc.at('qualifikationsNiveau[niveau]')['niveau']
+      beruf_doc.search(*%w[lbkgruppe hochschulberuf ebene kuenstler bezeichnung_nl bezeichnung_nk suchname_nl]).each do |i|
+        beruf.send("#{i.name}=", i.text)
+      end
+      beruf.save
+      berufe_vorher.delete(beruf.id)
+    end
+    Ba::Beruf.where(id: berufe_vorher).update_all deleted_on: Time.zone.now if berufe_vorher.any?
+  end
+  scope :duale_studiengaenge, -> { where ebene: 3, qualifikationsniveau: 4 }
+
+  def display_name
+    prefix = if deleted_on?
+               "[!VERALTET!] "
+             end
+    if typ == 'A'
+      if ebene == 3 && qualifikationsniveau == 4
+        "#{prefix}#{bezeichnung_nk} (DUALES STUDIUM/praxisorientiert)"
+      else
+        "#{prefix}#{bezeichnung_nk} (AUSBILDUNG)"
+      end
+    else
+      "#{prefix}#{bezeichnung_nk}"
+    end
+  end
+
+  def as_json(opts = {})
+    {
+      id: id,
+      display_name: display_name
+    }
+  end
+```
+
+</details>
+
+## Appendix: How to construct a Job-Posting XML file to upload
+
+- Download the most recent JobPosting xsd from https://baxml.arbeitsagentur.de/geschuetzt/download/
+- You can visualize the xsd here: http://www.xml-tools.net/schemaviewer.html
+- Now, you can construct the file with xml-builder:
+
+<details>
+<summary>Example for constructing a feed using XmlBuilder</summary>
+
+```ruby
+    xml = Builder::XmlMarkup.new(indent: 1)
+      xml.instruct!
+      xml.tag!("HRBAXMLJobPositionPosting") do
+        xml.tag!("Header") do
+          xml.tag!("SupplierId", SUPPLIER_ID)
+          xml.tag!("Timestamp", Time.zone.now.to_s(:db).tr(" ", "T"))
+          xml.tag!("Amount", obs.count)
+          # F: Full
+          # D: Diff
+          if @only_jobs
+            xml.tag!("TypeOfLoad", "D")
+          else
+            xml.tag!("TypeOfLoad", "F")
+          end
+        end
+        xml.tag!("Data") do
+          jobs.each do |job|
+            generate_xml_for_job(xml, job)
+          end
+          
+          jobs_to_delete.each do |job|
+            xml.tag! "DeleteEntry" do
+              xml.tag! "EntryId", id
+            end
+          end
+        end
+      end
+      xml
+```
+</details>
+
+- Then, you should validate your feed:
+
+```ruby
+xsd = Nokogiri::XML::Schema(File.open("vendor/ba/HRBAXML_JobPosition_Current.xsd"))
+doc = Nokogiri::XML(xml.to_s)
+xsd.validate(doc)
+```
+
+- Then, you can put that into a file - so you will need to generate a filename **according to the spec**:
+
+<details>
+<summary>Generate a filename</summary>
+```ruby
+# for historic reasons, you could transmit a bunch of files with the same timestamp using an index/offset, but usually, just putting 0 here should be enought
+index = 0
+number_of_feeds_to_push_now = 1
+ended = index == (number_of_feeds_to_push_now - 1)
+flag = ended ? "E" : "C"
+date = Time.zone.now.strftime "%Y-%m-%d_%H-%M-%S_F#{'%03d' % (index + 1)}#{flag}"
+"DS#{SUPPLIER_ID}_#{date}.xml"
+```
+</details>
+
+- Upload the file using this Gem. You should wait a "couple of minutes" (tip: enqueue a activeJob for 10 minutes later), to fetch the resulting **error file**, and analyse that.
+
+
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/lib/ba_upload/connection.rb

@@ -14,23 +14,26 @@ module BaUpload
       @m.cert = @cert.path
     end
 
-    def upload(file: nil)
-      m.get 'https://hrbaxml.arbeitsagentur.de/in/'
+    def upload(file: nil, partner_id: nil)
+      url = base_url(partner_id) + "in/"
+      m.get url
       form = m.page.forms.first
       form.file_uploads.first.file_name = file
       form.submit
     end
 
-    def error_files
-      m.get 'https://hrbaxml.arbeitsagentur.de/'
+    def error_files(partner_id: nil)
+      url = base_url(partner_id)
+      m.get url
       links = m.page.links_with(text: /ESP|ESV/)
       links.map do |link|
         ErrorFile.new(link)
       end
     end
 
-    def misc
-      m.get 'https://hrbaxml.arbeitsagentur.de/'
+    def misc(partner_id: nil)
+      url = base_url(partner_id)
+      m.get url
       m.page.links_with(text: /sonstiges/).first.click
       m.page.links.reject { |i| i.href[/^\?|mailto:/] || i.href == '/' }
     end
@@ -38,5 +41,13 @@ module BaUpload
     def shutdown
       m.shutdown
     end
+
+    private
+
+    def base_url(partner_id)
+      url = "https://hrbaxml.arbeitsagentur.de/"
+      url += "daten/#{partner_id}/" unless partner_id.nil?
+      url
+    end
   end
 end

data/lib/ba_upload/version.rb

@@ -1,3 +1,3 @@
 module BaUpload
-  VERSION = "0.2.0"
+  VERSION = "0.4.0"
 end

data/lib/ba_upload.rb

@@ -1,6 +1,11 @@
 require "ba_upload/version"
 require "openssl"
 
+if OpenSSL::VERSION >= '3.0.0'
+  # import legacy
+  OpenSSL::Provider.load("legacy")
+end
+
 module BaUpload
   def self.export_certificate(file_path:, passphrase:)
     cert = OpenSSL::PKCS12.new(File.read(file_path), passphrase)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ba_upload
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Stefan Wienert
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-02-03 00:00:00.000000000 Z
+date: 2023-09-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mechanize
@@ -90,8 +90,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.2.33
 signing_key: 
 specification_version: 4
 summary: Upload API for Bundesagentur fuer Arbeit (hrbaxml.arbeitsagentur)