ba_upload 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cceefb5de17f2e510d450c83e0ab44a231c23f8024f3b86c1cf4e55c9e2bee32
-  data.tar.gz: 29f249da985d7e5213f1cdc8f56f0d1dfc3e352f26823731413ba66506e6672d
+  metadata.gz: a97b2695bf77d8a8693710f458561034c58ae2a43e737863f283e65301e8aa65
+  data.tar.gz: 8e3da29f1068f76f6f5320110ab68a99a0d3240e1b8d4ea589bb82771b02a676
 SHA512:
-  metadata.gz: d4ba083e3d90f2d5d750127892b914dba63678a0b4423755b08c455d467cba9e28e02eb4bd5a4d900e19572f258d1befe2109a67af5c144fe10a36e8597552c2
-  data.tar.gz: c45d8070153d9aca7842ede6b4dea90098608e6b078bdf4e4370a698e837b021382ddccdfe31b4f47c0121ea76e5e8749e15a86a6f8841f9022b635c7f8d6bca
+  metadata.gz: 53b3dcee1f488d9b4758a03d9263bc6787a7b9b74680ef999d1ba1c01eb9625c3d2ea9210a2681a3804dd8727b43c9f745374e0f94567694a4470d9214c3d88a
+  data.tar.gz: 262b6794309cf833bc0d2a6301c0a757d036a3ac917a54c2eb9cea1301c02456359fa4a886e33b028ca8a264ac64dfeaadee8e3b9c67a2f30b057645e2b1c587

data/README.md

@@ -51,11 +51,23 @@ end
 ```ruby
 #!/usr/bin/env ruby
 require 'ba_upload'
-connection = BaUpload.open_connection(file_path: 'config/Zertifikat-1XXXX.p12', passphrase: 'YOURPASSPHRASE')
+BaUpload.open_connection(file_path: 'config/Zertifikat-1XXXX.p12', passphrase: 'YOURPASSPHRASE')
 connection.upload(file: File.open(ARGV[0]))
 ```
 
-Save to a file and just run it with the xml file as argument
+Save to a file and just run it with the xml file as argument. It's important, because the file upload of BA validates the original file name.
+
+
+### Memory safety
+
+because we are using Mechanize under the hood, it's a good idea to always close sockets, (with connection.shutdown), or use the open helper:
+
+```ruby
+BaUpload.open(file_path: 'config/Zertifikat-1XXXX.p12', passphrase:) do |c|
+    c.upload(file: file_path)
+    c.error_files....
+end
+```
 
 
 ### Downloading "misc" files
@@ -71,6 +83,19 @@ connection.misc.each do |link|
 end
 ```
 
+### Downloading 'Statistiken' xlsx reports
+
+Download XLSX reports (validation errors and "Stellenübersicht") from BA; You might use another Gem, like roo, axlsx etc. to parse those files if necessary.
+
+```ruby
+connection.statistics.each do |link|
+  link.tempfile
+
+  # or:
+  link.read
+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.
@@ -255,6 +280,7 @@ xsd.validate(doc)
 
 <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
@@ -264,6 +290,7 @@ 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.

data/ba_upload.gemspec

@@ -20,6 +20,6 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "mechanize"
-  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "bundler", "~> 2.0"
   spec.add_development_dependency "rake", "~> 10.0"
 end

data/lib/ba_upload/connection.rb

@@ -1,4 +1,5 @@
 require 'ba_upload/error_file'
+require 'ba_upload/statistic_file'
 module BaUpload
   class Connection
     attr_reader :m
@@ -16,7 +17,7 @@ module BaUpload
 
     def upload(file: nil, partner_id: nil)
       url = base_url(partner_id) + "in/"
-      m.get url
+      m.get(url)
       form = m.page.forms.first
       form.file_uploads.first.file_name = file
       form.submit
@@ -24,13 +25,21 @@ module BaUpload
 
     def error_files(partner_id: nil)
       url = base_url(partner_id)
-      m.get url
+      m.get(url)
       links = m.page.links_with(text: /ESP|ESV/)
       links.map do |link|
         ErrorFile.new(link)
       end
     end
 
+    def statistics(partner_id: nil)
+      url = base_url(partner_id) + "Statistiken"
+      m.get(url)
+      m.page.links_with(text: /xlsx/).map do |link|
+        StatisticFile.new(link)
+      end
+    end
+
     def misc(partner_id: nil)
       url = base_url(partner_id)
       m.get url

data/lib/ba_upload/statistic_file.rb

@@ -0,0 +1,18 @@
+require 'ba_upload/error_file'
+module BaUpload
+  class StatisticFile < ErrorFile
+    def tempfile
+      tf = Tempfile.new(['statistic_file', '.xlsx'])
+      tf.binmode
+      tf.write(read)
+      tf.flush
+      tf.rewind
+      tf
+    end
+
+    def read
+      @mechanize_link.click.body
+    end
+  end
+end
+

data/lib/ba_upload/version.rb

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

data/lib/ba_upload.rb

@@ -1,7 +1,7 @@
 require "ba_upload/version"
 require "openssl"
 
-if OpenSSL::VERSION >= '3.0.0'
+if OpenSSL::VERSION >= '3.0.0' && defined?(OpenSSL::Provider)
   # import legacy
   OpenSSL::Provider.load("legacy")
 end
@@ -20,6 +20,13 @@ module BaUpload
     cert = BaUpload.export_certificate(file_path: file_path, passphrase: passphrase)
     BaUpload::Connection.new(cert[:key], cert[:cert], cert[:ca_cert])
   end
+
+  def self.open(file_path:, passphrase:, &block)
+    conn = BaUpload.open_connection(file_path: file_path, passphrase: passphrase)
+    block.call(conn)
+  ensure
+    conn.shutdown
+  end
 end
 
 require 'ba_upload/connection'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ba_upload
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Stefan Wienert
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-09-26 00:00:00.000000000 Z
+date: 2024-10-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mechanize
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -70,6 +70,7 @@ files:
 - lib/ba_upload.rb
 - lib/ba_upload/connection.rb
 - lib/ba_upload/error_file.rb
+- lib/ba_upload/statistic_file.rb
 - lib/ba_upload/version.rb
 homepage: https://github.com/pludoni/ba_upload
 licenses:
@@ -90,7 +91,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.33
+rubygems_version: 3.5.21
 signing_key: 
 specification_version: 4
 summary: Upload API for Bundesagentur fuer Arbeit (hrbaxml.arbeitsagentur)